MDL-19235 Basic phpdocs and copyright statements for core_tag subsystem
[moodle.git] / tag / manage.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package    core
20  * @subpackage tag
21  * @copyright  2007 Luiz Cruz <luiz.laydner@gmail.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once('../config.php');
26 require_once($CFG->libdir.'/tablelib.php');
27 require_once('lib.php');
29 define('SHOW_ALL_PAGE_SIZE', 50000);
30 define('DEFAULT_PAGE_SIZE', 30);
32 $tagschecked = optional_param('tagschecked', array(), PARAM_INT);
33 $newnames    = optional_param('newname', array(), PARAM_TAG);
34 $tagtypes    = optional_param('tagtypes', array(), PARAM_ALPHA);
35 $action      = optional_param('action', '', PARAM_ALPHA);
36 $perpage     = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT);
38 require_login();
40 if (empty($CFG->usetags)) {
41     print_error('tagsaredisabled', 'tag');
42 }
44 $systemcontext = get_context_instance(CONTEXT_SYSTEM);
45 require_capability('moodle/tag:manage', $systemcontext);
47 $params = array();
48 if ($perpage != DEFAULT_PAGE_SIZE) {
49     $params['perpage'] = $perpage;
50 }
51 $PAGE->set_url('/tag/manage.php', $params);
52 $PAGE->set_context($systemcontext);
53 $PAGE->set_blocks_editing_capability('moodle/tag:editblocks');
54 $PAGE->navbar->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
55 $PAGE->navbar->add(get_string('managetags', 'tag'));
56 $PAGE->set_title(get_string('managetags', 'tag'));
57 $PAGE->set_heading($COURSE->fullname);
58 $PAGE->set_pagelayout('standard');
59 echo $OUTPUT->header();
61 $err_notice = '';
62 $notice = '';
64 // get all the possible tag types from db
65 $existing_tagtypes = array();
66 if ($ptypes = $DB->get_records_sql("SELECT DISTINCT(tagtype) FROM {tag}")) {
67     foreach ($ptypes as $ptype) {
68         $existing_tagtypes[$ptype->tagtype] = $ptype->tagtype;
69     }
70 }
71 $existing_tagtypes['official'] = get_string('tagtype_official', 'tag');
72 $existing_tagtypes['default'] = get_string('tagtype_default', 'tag');
74 switch($action) {
76     case 'delete':
77         if (!data_submitted() or !confirm_sesskey()) {
78             break;
79         }
81         $str_tagschecked = implode(', ', tag_get_name($tagschecked));
82         tag_delete($tagschecked);
83         $notice = $str_tagschecked.' --  '.get_string('deleted','tag');
84         break;
86     case 'reset':
87         if (!data_submitted() or !confirm_sesskey()) {
88             break;
89         }
90         $str_tagschecked = implode(', ', tag_get_name($tagschecked));
91         tag_unset_flag($tagschecked);
92         $notice = $str_tagschecked .' -- '. get_string('reset', 'tag');
93         break;
95     case 'changetype':
96         if (!data_submitted() or !confirm_sesskey()) {
97             break;
98         }
100         $changed = array();
101         foreach ($tagschecked as $tag_id) {
102             if (!array_key_exists($tagtypes[$tag_id], $existing_tagtypes)) {
103                 //can not add new types here!!
104                 continue;
105             }
107             // update tag type;
108             if (tag_type_set($tag_id, $tagtypes[$tag_id])) {
109                 $changed[] = $tag_id;
110             }
111         }
113         if (!empty($changed)) {
114             $str_changed = implode(', ', tag_get_name($changed));
115             $notice = $str_changed .' --  '. get_string('typechanged','tag');
116         }
117         break;
119     case 'changename':
120         if (!data_submitted() or !confirm_sesskey()) {
121             break;
122         }
124         $tags_names_changed = array();
125         foreach ($tagschecked as $tag_id) {
126             if ($newnames[$tag_id] != '') {
127                 if (! $tags_names_updated[] = tag_rename($tag_id, $newnames[$tag_id]) ) {
128                     // if tag already exists, or is not a valid tag name, etc.
129                     $err_notice .= $newnames[$tag_id]. '-- ' . get_string('namesalreadybeeingused','tag').'<br />';
130                 } else {
131                     $tags_names_changed[$tag_id] = $newnames[$tag_id];
132                 }
133             }
134         }
136         //notice to inform what tags had their names effectively updated
137         if ($tags_names_changed){
138             $notice = implode($tags_names_changed, ', ');
139             $notice .= ' -- ' . get_string('updated','tag');
140         }
141         break;
142     case 'addofficialtag':
143         if (!data_submitted() or !confirm_sesskey()) {
144             break;
145         }
147         $new_otags = explode(',', optional_param('otagsadd', '', PARAM_TAG));
148         $notice = '';
149         foreach ( $new_otags as $new_otag ) {
150             if ( $new_otag_id = tag_get_id($new_otag) ) {
151                 // tag exists, change the type
152                 tag_type_set($new_otag_id, 'official');
153             } else {
154                 require_capability('moodle/tag:create', get_context_instance(CONTEXT_SYSTEM));
155                 tag_add($new_otag, 'official');
156             }
157             $notice .= get_string('addedotag', 'tag', $new_otag) .' ';
158         }
159         break;
162 if ($err_notice) {
163     echo $OUTPUT->notification($err_notice, 'red');
165 if ($notice) {
166     echo $OUTPUT->notification($notice, 'green');
169 // small form to add an official tag
170 print('<form class="tag-management-form" method="post" action="'.$CFG->wwwroot.'/tag/manage.php">');
171 print('<input type="hidden" name="action" value="addofficialtag" />');
172 print('<div class="tag-management-form generalbox"><label class="accesshide" for="id_otagsadd">'. get_string('addotags', 'tag') .'</label>'.
173     '<input name="otagsadd" id="id_otagsadd" type="text" />'.
174     '<input type="hidden" name="sesskey" value="'.sesskey().'">'.
175     '<input name="addotags" value="'. get_string('addotags', 'tag') .'" onclick="skipClientValidation = true;" id="id_addotags" type="submit" />'.
176     '</div>');
177 print('</form>');
179 //setup table
181 $tablecolumns = array('id', 'name', 'fullname', 'count', 'flag', 'timemodified', 'rawname', 'tagtype', '');
182 $tableheaders = array(get_string('id', 'tag'),
183                       get_string('name', 'tag'),
184                       get_string('owner', 'tag'),
185                       get_string('count', 'tag'),
186                       get_string('flag', 'tag'),
187                       get_string('timemodified', 'tag'),
188                       get_string('newname', 'tag'),
189                       get_string('tagtype', 'tag'),
190                       get_string('select', 'tag'));
192 $table = new flexible_table('tag-management-list-'.$USER->id);
194 $baseurl = $CFG->wwwroot.'/tag/manage.php?perpage='.$perpage;
196 $table->define_columns($tablecolumns);
197 $table->define_headers($tableheaders);
198 $table->define_baseurl($baseurl);
200 $table->sortable(true, 'flag', SORT_DESC);
202 $table->set_attribute('cellspacing', '0');
203 $table->set_attribute('id', 'tag-management-list');
204 $table->set_attribute('class', 'generaltable generalbox');
206 $table->set_control_variables(array(
207 TABLE_VAR_SORT    => 'ssort',
208 TABLE_VAR_HIDE    => 'shide',
209 TABLE_VAR_SHOW    => 'sshow',
210 TABLE_VAR_IFIRST  => 'sifirst',
211 TABLE_VAR_ILAST   => 'silast',
212 TABLE_VAR_PAGE    => 'spage'
213 ));
215 $table->setup();
217 $params = array();
219 if ($table->get_sql_sort()) {
220     $sort = 'ORDER BY '. $table->get_sql_sort();
221 } else {
222     $sort = '';
225 if ($table->get_sql_where()) {
226     $where = 'WHERE '. $table->get_sql_where();
227 } else {
228     $where = '';
231 $query = 'SELECT tg.id, tg.name, tg.rawname, tg.tagtype, COUNT(ti.id) AS count, u.id AS owner, tg.flag, tg.timemodified, u.firstname, u.lastname
232             FROM {tag_instance} ti RIGHT JOIN {tag} tg ON tg.id = ti.tagid LEFT JOIN {user} u ON tg.userid = u.id
233         '.$where.'
234         GROUP BY tg.id, tg.name, tg.rawname, tg.tagtype, u.id, tg.flag, tg.timemodified, u.firstname, u.lastname
235          '.$sort;
236 $totalcount = $DB->count_records_sql('SELECT COUNT(DISTINCT(tg.id))
237                                    FROM {tag} tg LEFT JOIN {user} u ON u.id = tg.userid '. $where, $params);
239 $table->initialbars(true); // always initial bars
240 $table->pagesize($perpage, $totalcount);
242 echo '<form class="tag-management-form" method="post" action="'.$CFG->wwwroot.'/tag/manage.php"><div>';
244 //retrieve tags from DB
245 if ($tagrecords = $DB->get_records_sql($query, $params, $table->get_page_start(),  $table->get_page_size())) {
247     $taglist = array_values($tagrecords);
249     //print_tag_cloud(array_values($DB->get_records_sql($query)), false);
250     //populate table with data
251     foreach ($taglist as $tag ){
252         $id             =   $tag->id;
253         $name           =   '<a href="'.$CFG->wwwroot.'/tag/index.php?id='.$tag->id.'">'. tag_display_name($tag) .'</a>';
254         $owner          =   '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$tag->owner.'">' . fullname($tag) . '</a>';
255         $count          =   $tag->count;
256         $flag           =   $tag->flag;
257         $timemodified   =   format_time(time() - $tag->timemodified);
258         $checkbox       =   '<input type="checkbox" name="tagschecked[]" value="'.$tag->id.'" />';
259         $text           =   '<input type="text" name="newname['.$tag->id.']" />';
260         $tagtype        =   html_writer::select($existing_tagtypes, 'tagtypes['.$tag->id.']', $tag->tagtype, false);
262         //if the tag if flagged, highlight it
263         if ($tag->flag > 0) {
264             $id = '<span class="flagged-tag">' . $id . '</span>';
265             $name = '<span class="flagged-tag">' . $name . '</span>';
266             $owner = '<span class="flagged-tag">' . $owner . '</span>';
267             $count = '<span class="flagged-tag">' . $count . '</span>';
268             $flag = '<span class="flagged-tag">' . $flag . '</span>';
269             $timemodified = '<span class="flagged-tag">' . $timemodified . '</span>';
270             $tagtype = '<span class="flagged-tag">'. $tagtype. '</span>';
271         }
273         $data = array($id, $name, $owner, $count, $flag, $timemodified, $text, $tagtype, $checkbox);
275         $table->add_data($data);
276     }
278     echo '<input type="button" onclick="checkall()" value="'.get_string('selectall').'" /> ';
279     echo '<input type="button" onclick="checknone()" value="'.get_string('deselectall').'" /> ';
280     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" /> ';
281     echo '<br/><br/>';
282     echo '<select id="menuformaction" name="action">
283                 <option value="" selected="selected">'. get_string('withselectedtags', 'tag') .'</option>
284                 <option value="reset">'. get_string('resetflag', 'tag') .'</option>
285                 <option value="delete">'. get_string('delete', 'tag') .'</option>
286                 <option value="changetype">'. get_string('changetype', 'tag') .'</option>
287                 <option value="changename">'. get_string('changename', 'tag') .'</option>
288             </select>';
290     echo '<button id="tag-management-submit" type="submit">'. get_string('ok') .'</button>';
293 $table->print_html();
294 echo '</div></form>';
296 if ($perpage == SHOW_ALL_PAGE_SIZE) {
297     echo '<div id="showall"><a href="'. $baseurl .'&amp;perpage='. DEFAULT_PAGE_SIZE .'">'. get_string('showperpage', '', DEFAULT_PAGE_SIZE) .'</a></div>';
299 } else if ($totalcount > 0 and $perpage < $totalcount) {
300     echo '<div id="showall"><a href="'. $baseurl .'&amp;perpage='. SHOW_ALL_PAGE_SIZE .'">'. get_string('showall', '', $totalcount) .'</a></div>';
303 echo '<br/>';
305 echo $OUTPUT->footer();