MDL-15310: moving capability checks out of the library + code formatting adjustments
[moodle.git] / tag / manage.php
1 <?php // $Id$
3 require_once('../config.php');
4 require_once($CFG->libdir.'/tablelib.php');
5 require_once('lib.php');
7 define('SHOW_ALL_PAGE_SIZE', 50000);
8 define('DEFAULT_PAGE_SIZE', 30);
10 $tagschecked = optional_param('tagschecked', array(), PARAM_INT);
11 $newnames    = optional_param('newname', array(), PARAM_TAG);
12 $tagtypes    = optional_param('tagtypes', array(), PARAM_ALPHA);
13 $action      = optional_param('action', '', PARAM_ALPHA);
14 $perpage     = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT);
16 require_login();
18 if (empty($CFG->usetags)) {
19     print_error('tagsaredisabled', 'tag');
20 }
22 $systemcontext   = get_context_instance(CONTEXT_SYSTEM);
23 require_capability('moodle/tag:manage', $systemcontext);
25 $navlinks = array();
26 $navlinks[] = array('name' => get_string('tags', 'tag'), 'link' => "{$CFG->wwwroot}/tag/search.php", 'type' => '');
27 $navlinks[] = array('name' => get_string('managetags', 'tag'), 'link' => '', 'type' => '');
29 $navigation = build_navigation($navlinks);
30 print_header_simple(get_string('managetags', 'tag'), '', $navigation);
32 $err_notice = '';
33 $notice = '';
35 // get all the possible tag types from db
36 $existing_tagtypes = array();
37 if ($ptypes = $DB->get_records_sql("SELECT DISTINCT(tagtype) FROM {tag}")) {
38     foreach ($ptypes as $ptype) {
39         $existing_tagtypes[$ptype->tagtype] = $ptype->tagtype;
40     }
41 }
42 $existing_tagtypes['official'] = get_string('tagtype_official', 'tag');
43 $existing_tagtypes['default'] = get_string('tagtype_default', 'tag');
45 switch($action) {
47     case 'delete':
48         if (!data_submitted() or !confirm_sesskey()) {
49             break;
50         }
51         
52         $str_tagschecked = implode(', ', tag_get_name($tagschecked));
53         tag_delete($tagschecked);
54         $notice = $str_tagschecked.' --  '.get_string('deleted','tag');
55         break;
57     case 'reset':
58         if (!data_submitted() or !confirm_sesskey()) {
59             break;
60         }
61         $str_tagschecked = implode(', ', tag_get_name($tagschecked));
62         tag_unset_flag($tagschecked);
63         $notice = $str_tagschecked .' -- '. get_string('reset', 'tag');
64         break;
66     case 'changetype':
67         if (!data_submitted() or !confirm_sesskey()) {
68             break;
69         }
71         $changed = array();
72         foreach ($tagschecked as $tag_id) {
73             if (!array_key_exists($tagtypes[$tag_id], $existing_tagtypes)) {
74                 //can not add new types here!!
75                 continue;
76             }
78             // update tag type;
79             if (tag_type_set($tag_id, $tagtypes[$tag_id])) {
80                 $changed[] = $tag_id;
81             }
82         }
84         if (!empty($changed)) {
85             $str_changed = implode(', ', tag_get_name($changed));
86             $notice = $str_changed .' --  '. get_string('typechanged','tag');
87         }
88         break;
90     case 'changename':
91         if (!data_submitted() or !confirm_sesskey()) {
92             break;
93         }
94         
95         $tags_names_changed = array();
96         foreach ($tagschecked as $tag_id) {
97             if ($newnames[$tag_id] != '') {
98                 if (! $tags_names_updated[] = tag_rename($tag_id, $newnames[$tag_id]) ) {
99                     // if tag already exists, or is not a valid tag name, etc.
100                     $err_notice .= $newnames[$tag_id]. '-- ' . get_string('namesalreadybeeingused','tag').'<br />';
101                 } else {
102                     $tags_names_changed[$tag_id] = $newnames[$tag_id];
103                 }
104             }
105         }
107         //notice to inform what tags had their names effectively updated
108         if ($tags_names_changed){
109             $notice = implode($tags_names_changed, ', ');
110             $notice .= ' -- ' . get_string('updated','tag');
111         }
112         break;
113     case 'addofficialtag':
114         $new_otags = explode(',', optional_param('otagsadd', '', PARAM_TAG));
115         $notice = '';
116         foreach ( $new_otags as $new_otag ) {
117             if ( $new_otag_id = tag_get_id($new_otag) ) {
118                 // tag exists, change the type
119                 tag_set_type($new_otag_id, 'official');
120             } else {
121                 require_capability('moodle/tag:create', get_context_instance(CONTEXT_SYSTEM));
122                 tag_add($new_otag, 'official');
123             }
124             $notice .= get_string('addedotag', 'tag', $new_otag) .' ';
125         }
126         break;
129 echo '<br/>';
131 if ($err_notice) {
132     notify($err_notice, 'red');
134 if ($notice) {
135     notify($notice, 'green');
138 // small form to add an official tag
139 print('<form class="tag-management-form" method="post" action="'.$CFG->wwwroot.'/tag/manage.php">');
140 print('<input type="hidden" name="action" value="addofficialtag">');
141 print('<div class="tag-management-form generalbox"><label class="accesshide" for="id_otagsadd">'. get_string('addotags', 'tag') .'</label>'.
142     '<input name="otagsadd" id="id_otagsadd" type="text">'.
143     '<input name="addotags" value="'. get_string('addotags', 'tag') .'" onclick="skipClientValidation = true;" id="id_addotags" type="submit">'.
144     '</div>');
145 print('</form>');
147 //setup table
149 $tablecolumns = array('id', 'name', 'fullname', 'count', 'flag', 'timemodified', 'rawname', 'tagtype', '');
150 $tableheaders = array(get_string('id', 'tag'),
151                       get_string('name', 'tag'),
152                       get_string('owner', 'tag'),
153                       get_string('count', 'tag'),
154                       get_string('flag', 'tag'),
155                       get_string('timemodified', 'tag'),
156                       get_string('newname', 'tag'),
157                       get_string('tagtype', 'tag'),
158                       get_string('select', 'tag'));
160 $table = new flexible_table('tag-management-list-'.$USER->id);
162 $baseurl = $CFG->wwwroot.'/tag/manage.php?perpage='.$perpage;
164 $table->define_columns($tablecolumns);
165 $table->define_headers($tableheaders);
166 $table->define_baseurl($baseurl);
168 $table->sortable(true, 'flag', SORT_DESC);
170 $table->set_attribute('cellspacing', '0');
171 $table->set_attribute('id', 'tag-management-list');
172 $table->set_attribute('class', 'generaltable generalbox');
174 $table->set_control_variables(array(
175 TABLE_VAR_SORT    => 'ssort',
176 TABLE_VAR_HIDE    => 'shide',
177 TABLE_VAR_SHOW    => 'sshow',
178 TABLE_VAR_IFIRST  => 'sifirst',
179 TABLE_VAR_ILAST   => 'silast',
180 TABLE_VAR_PAGE    => 'spage'
181 ));
183 $table->setup();
185 $params = array();
187 if ($table->get_sql_sort()) {
188     $sort = 'ORDER BY '. $table->get_sql_sort();
189 } else {
190     $sort = '';
193 if ($table->get_sql_where()) {
194     $where = 'WHERE '. $table->get_sql_where();
195 } else {
196     $where = '';
199 $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
200             FROM {tag_instance} ti RIGHT JOIN {tag} tg ON tg.id = ti.tagid LEFT JOIN {user} u ON tg.userid = u.id
201         '.$where.'
202         GROUP BY tg.id, tg.name, tg.rawname, tg.tagtype, u.id, tg.flag, tg.timemodified, u.firstname, u.lastname
203          '.$sort;
204 $totalcount = $DB->count_records_sql('SELECT COUNT(DISTINCT(tg.id))
205                                    FROM {tag} tg LEFT JOIN {user} u ON u.id = tg.userid '. $where, $params);
207 $table->initialbars(true); // always initial bars
208 $table->pagesize($perpage, $totalcount);
210 echo '<form class="tag-management-form" method="post" action="'.$CFG->wwwroot.'/tag/manage.php"><div>';
212 //retrieve tags from DB
213 if ($tagrecords = $DB->get_records_sql($query, $params, $table->get_page_start(),  $table->get_page_size())) {
215     $taglist = array_values($tagrecords);
217     //print_tag_cloud(array_values($DB->get_records_sql($query)), false);
218     //populate table with data
219     foreach ($taglist as $tag ){
220         $id             =   $tag->id;
221         $name           =   '<a href="'.$CFG->wwwroot.'/tag/index.php?id='.$tag->id.'">'. tag_display_name($tag) .'</a>';
222         $owner          =   '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$tag->owner.'">' . fullname($tag) . '</a>';
223         $count          =   $tag->count;
224         $flag           =   $tag->flag;
225         $timemodified   =   format_time(time() - $tag->timemodified);
226         $checkbox       =   '<input type="checkbox" name="tagschecked[]" value="'.$tag->id.'" />';
227         $text           =   '<input type="text" name="newname['.$tag->id.']" />';
228         $tagtype        =   choose_from_menu($existing_tagtypes, 'tagtypes['.$tag->id.']', $tag->tagtype, '', '', '0', true);
230         //if the tag if flagged, highlight it
231         if ($tag->flag > 0) {
232             $id = '<span class="flagged-tag">' . $id . '</span>';
233             $name = '<span class="flagged-tag">' . $name . '</span>';
234             $owner = '<span class="flagged-tag">' . $owner . '</span>';
235             $count = '<span class="flagged-tag">' . $count . '</span>';
236             $flag = '<span class="flagged-tag">' . $flag . '</span>';
237             $timemodified = '<span class="flagged-tag">' . $timemodified . '</span>';
238             $tagtype = '<span class="flagged-tag">'. $tagtype. '</span>';
239         }
241         $data = array($id, $name, $owner, $count, $flag, $timemodified, $text, $tagtype, $checkbox);
243         $table->add_data($data);
244     }
246     echo '<input type="button" onclick="checkall()" value="'.get_string('selectall').'" /> ';
247     echo '<input type="button" onclick="checknone()" value="'.get_string('deselectall').'" /> ';
248     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" /> ';
249     echo '<br/><br/>';
250     echo '<select id="menuformaction" name="action">
251                 <option value="" selected="selected">'. get_string('withselectedtags', 'tag') .'</option>
252                 <option value="reset">'. get_string('resetflag', 'tag') .'</option>
253                 <option value="delete">'. get_string('delete', 'tag') .'</option>
254                 <option value="changetype">'. get_string('changetype', 'tag') .'</option>
255                 <option value="changename">'. get_string('changename', 'tag') .'</option>
256             </select>';
258     echo '<button id="tag-management-submit" type="submit">'. get_string('ok') .'</button>';
261 $table->print_html();
262 echo '</div></form>';
264 if ($perpage == SHOW_ALL_PAGE_SIZE) {
265     echo '<div id="showall"><a href="'. $baseurl .'&amp;perpage='. DEFAULT_PAGE_SIZE .'">'. get_string('showperpage', '', DEFAULT_PAGE_SIZE) .'</a></div>';
267 } else if ($totalcount > 0 and $perpage < $totalcount) {
268     echo '<div id="showall"><a href="'. $baseurl .'&amp;perpage='. SHOW_ALL_PAGE_SIZE .'">'. get_string('showall', '', $totalcount) .'</a></div>';
271 echo '<br/>';
273 print_footer();
275 ?>