Merge branch 'MDL-35569-m23' of git://github.com/sammarshallou/moodle into MOODLE_23_...
[moodle.git] / course / category.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Displays the top level category or all courses
19  * In editing mode, allows the admin to edit a category,
20  * and rearrange courses
21  *
22  * @package    core
23  * @subpackage course
24  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 require_once("../config.php");
29 require_once($CFG->dirroot.'/course/lib.php');
30 require_once($CFG->libdir.'/textlib.class.php');
32 $id = required_param('id', PARAM_INT); // Category id
33 $page = optional_param('page', 0, PARAM_INT); // which page to show
34 $categoryedit = optional_param('categoryedit', -1, PARAM_BOOL);
35 $hide = optional_param('hide', 0, PARAM_INT);
36 $show = optional_param('show', 0, PARAM_INT);
37 $moveup = optional_param('moveup', 0, PARAM_INT);
38 $movedown = optional_param('movedown', 0, PARAM_INT);
39 $moveto = optional_param('moveto', 0, PARAM_INT);
40 $resort = optional_param('resort', 0, PARAM_BOOL);
41 $sesskey = optional_param('sesskey', '', PARAM_RAW);
43 // MDL-27824 - This is a temporary fix until we have the proper
44 // way to check/initialize $CFG value.
45 // @todo MDL-35138 remove this temporary solution
46 if (!empty($CFG->coursesperpage)) {
47     $defaultperpage =  $CFG->coursesperpage;
48 } else {
49     $defaultperpage = 20;
50 }
51 $perpage = optional_param('perpage', $defaultperpage, PARAM_INT); // how many per page
53 if (empty($id)) {
54     print_error("unknowcategory");
55 }
57 $PAGE->set_category_by_id($id);
58 $PAGE->set_url(new moodle_url('/course/category.php', array('id' => $id)));
59 // This is sure to be the category context
60 $context = $PAGE->context;
61 // And the object has been loaded for us no need for another DB call
62 $category = $PAGE->category;
64 $canedit = can_edit_in_category($category->id);
65 if ($canedit) {
66     if ($categoryedit !== -1) {
67         $USER->editing = $categoryedit;
68     }
69     require_login();
70     $editingon = $PAGE->user_is_editing();
71 } else {
72     if ($CFG->forcelogin) {
73         require_login();
74     }
75     $editingon = false;
76 }
78 if (!$category->visible) {
79     require_capability('moodle/category:viewhiddencategories', $context);
80 }
82 $canmanage = has_capability('moodle/category:manage', $context);
83 $sesskeyprovided = !empty($sesskey) && confirm_sesskey($sesskey);
85 // Process any category actions.
86 if ($canmanage && $resort && $sesskeyprovided) {
87     // Resort the category if requested
88     if ($courses = get_courses($category->id, '', 'c.id,c.fullname,c.sortorder')) {
89         collatorlib::asort_objects_by_property($courses, 'fullname', collatorlib::SORT_NATURAL);
90         $i = 1;
91         foreach ($courses as $course) {
92             $DB->set_field('course', 'sortorder', $category->sortorder+$i, array('id'=>$course->id));
93             $i++;
94         }
95         fix_course_sortorder(); // should not be needed
96     }
97 }
99 // Process any course actions.
100 if ($editingon && $sesskeyprovided) {
102     // Move a specified course to a new category
103     if (!empty($moveto) and $data = data_submitted()) {
104         // Some courses are being moved
105         // user must have category update in both cats to perform this
106         require_capability('moodle/category:manage', $context);
107         require_capability('moodle/category:manage', get_context_instance(CONTEXT_COURSECAT, $moveto));
109         if (!$destcategory = $DB->get_record('course_categories', array('id' => $data->moveto))) {
110             print_error('cannotfindcategory', '', '', $data->moveto);
111         }
113         $courses = array();
114         foreach ($data as $key => $value) {
115             if (preg_match('/^c\d+$/', $key)) {
116                 $courseid = substr($key, 1);
117                 array_push($courses, $courseid);
119                 // check this course's category
120                 if ($movingcourse = $DB->get_record('course', array('id'=>$courseid))) {
121                     if ($movingcourse->category != $id ) {
122                         print_error('coursedoesnotbelongtocategory');
123                     }
124                 } else {
125                     print_error('cannotfindcourse');
126                 }
127             }
128         }
129         move_courses($courses, $data->moveto);
130     }
132     // Hide or show a course
133     if (!empty($hide) or !empty($show)) {
134         if (!empty($hide)) {
135             $course = $DB->get_record('course', array('id' => $hide));
136             $visible = 0;
137         } else {
138             $course = $DB->get_record('course', array('id' => $show));
139             $visible = 1;
140         }
142         if ($course) {
143             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
144             require_capability('moodle/course:visibility', $coursecontext);
145             // Set the visibility of the course. we set the old flag when user manually changes visibility of course.
146             $DB->update_record('course', array('id' => $course->id, 'visible' => $visible, 'visibleold' => $visible, 'timemodified' => time()));
147         }
148     }
151     // Move a course up or down
152     if (!empty($moveup) or !empty($movedown)) {
153         require_capability('moodle/category:manage', $context);
155         // Ensure the course order has continuous ordering
156         fix_course_sortorder();
157         $swapcourse = NULL;
159         if (!empty($moveup)) {
160             if ($movecourse = $DB->get_record('course', array('id' => $moveup))) {
161                 $swapcourse = $DB->get_record('course', array('sortorder' => $movecourse->sortorder - 1));
162             }
163         } else {
164             if ($movecourse = $DB->get_record('course', array('id' => $movedown))) {
165                 $swapcourse = $DB->get_record('course', array('sortorder' => $movecourse->sortorder + 1));
166             }
167         }
168         if ($swapcourse and $movecourse) {
169             // check course's category
170             if ($movecourse->category != $id) {
171                 print_error('coursedoesnotbelongtocategory');
172             }
173             $DB->set_field('course', 'sortorder', $swapcourse->sortorder, array('id' => $movecourse->id));
174             $DB->set_field('course', 'sortorder', $movecourse->sortorder, array('id' => $swapcourse->id));
175         }
176     }
178 } // End of editing stuff
180 // Prepare the standard URL params for this page. We'll need them later.
181 $urlparams = array('id' => $id);
182 if ($page) {
183     $urlparams['page'] = $page;
185 if ($perpage) {
186     $urlparams['perpage'] = $perpage;
189 // Begin output
190 if ($editingon && can_edit_in_category()) {
191     // Integrate into the admin tree only if the user can edit categories at the top level,
192     // otherwise the admin block does not appear to this user, and you get an error.
193     require_once($CFG->libdir . '/adminlib.php');
194     navigation_node::override_active_url(new moodle_url('/course/category.php', array('id' => $id)));
195     admin_externalpage_setup('coursemgmt', '', $urlparams, $CFG->wwwroot . '/course/category.php');
196     $PAGE->set_context($context);   // Ensure that we are actually showing blocks etc for the cat context
198     $settingsnode = $PAGE->settingsnav->find_active_node();
199     if ($settingsnode) {
200         $settingsnode->make_inactive();
201         $settingsnode->force_open();
202         $PAGE->navbar->add($settingsnode->text, $settingsnode->action);
203     }
204     echo $OUTPUT->header();
205 } else {
206     $site = get_site();
207     $PAGE->set_title("$site->shortname: $category->name");
208     $PAGE->set_heading($site->fullname);
209     $PAGE->set_button(print_course_search('', true, 'navbar'));
210     $PAGE->set_pagelayout('coursecategory');
211     echo $OUTPUT->header();
214 /// Print the category selector
215 $displaylist = array();
216 $notused = array();
217 make_categories_list($displaylist, $notused);
219 echo '<div class="categorypicker">';
220 $select = new single_select(new moodle_url('/course/category.php'), 'id', $displaylist, $category->id, null, 'switchcategory');
221 $select->set_label(get_string('categories').':');
222 echo $OUTPUT->render($select);
223 echo '</div>';
225 /// Print current category description
226 if (!$editingon && $category->description) {
227     echo $OUTPUT->box_start();
228     $options = new stdClass;
229     $options->noclean = true;
230     $options->para = false;
231     $options->overflowdiv = true;
232     if (!isset($category->descriptionformat)) {
233         $category->descriptionformat = FORMAT_MOODLE;
234     }
235     $text = file_rewrite_pluginfile_urls($category->description, 'pluginfile.php', $context->id, 'coursecat', 'description', null);
236     echo format_text($text, $category->descriptionformat, $options);
237     echo $OUTPUT->box_end();
240 if ($editingon && $canmanage) {
241     echo $OUTPUT->container_start('buttons');
243     // Print button to update this category
244     $url = new moodle_url('/course/editcategory.php', array('id' => $category->id));
245     echo $OUTPUT->single_button($url, get_string('editcategorythis'), 'get');
247     // Print button for creating new categories
248     $url = new moodle_url('/course/editcategory.php', array('parent' => $category->id));
249     echo $OUTPUT->single_button($url, get_string('addsubcategory'), 'get');
251     echo $OUTPUT->container_end();
254 // Print out all the sub-categories
255 // In order to view hidden subcategories the user must have the viewhiddencategories
256 // capability in the current category.
257 if (has_capability('moodle/category:viewhiddencategories', $context)) {
258     $categorywhere = '';
259 } else {
260     $categorywhere = 'AND cc.visible = 1';
262 // We're going to preload the context for the subcategory as we know that we
263 // need it later on for formatting.
265 $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
266 $sql = "SELECT cc.*, $ctxselect
267           FROM {course_categories} cc
268           JOIN {context} ctx ON cc.id = ctx.instanceid
269          WHERE cc.parent = :parentid AND
270                ctx.contextlevel = :contextlevel
271                $categorywhere
272       ORDER BY cc.sortorder ASC";
273 $subcategories = $DB->get_recordset_sql($sql, array('parentid' => $category->id, 'contextlevel' => CONTEXT_COURSECAT));
274 // Prepare a table to display the sub categories.
275 $table = new html_table;
276 $table->attributes = array('border' => '0', 'cellspacing' => '2', 'cellpadding' => '4', 'class' => 'generalbox boxaligncenter category_subcategories');
277 $table->head = array(new lang_string('subcategories'));
278 $table->data = array();
279 $baseurl = new moodle_url('/course/category.php');
280 foreach ($subcategories as $subcategory) {
281     // Preload the context we will need it to format the category name shortly.
282     context_helper::preload_from_record($subcategory);
283     $context = get_context_instance(CONTEXT_COURSECAT, $subcategory->id);
284     // Prepare the things we need to create a link to the subcategory
285     $attributes = $subcategory->visible ? array() : array('class' => 'dimmed');
286     $text = format_string($subcategory->name, true, array('context' => $context));
287     // Add the subcategory to the table
288     $baseurl->param('id', $subcategory->id);
289     $table->data[] = array(html_writer::link($baseurl, $text, $attributes));
292 $subcategorieswereshown = (count($table->data) > 0);
293 if ($subcategorieswereshown) {
294     echo html_writer::table($table);
297 // Print out all the courses
298 $courses = get_courses_page($category->id, 'c.sortorder ASC',
299         'c.id,c.sortorder,c.shortname,c.fullname,c.summary,c.visible',
300         $totalcount, $page*$perpage, $perpage);
301 $numcourses = count($courses);
303 if (!$courses) {
304     if (empty($subcategorieswereshown)) {
305         echo $OUTPUT->heading(get_string("nocoursesyet"));
306     }
308 } else if ($numcourses <= COURSE_MAX_SUMMARIES_PER_PAGE and !$page and !$editingon) {
309     echo $OUTPUT->box_start('courseboxes');
310     print_courses($category);
311     echo $OUTPUT->box_end();
313 } else {
314     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "/course/category.php?id=$category->id&perpage=$perpage");
316     echo '<form id="movecourses" action="category.php" method="post"><div>';
317     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
318     echo '<table border="0" cellspacing="2" cellpadding="4" class="generalbox boxaligncenter"><tr>';
319     echo '<th class="header" scope="col">'.get_string('courses').'</th>';
320     if ($editingon) {
321         echo '<th class="header" scope="col">'.get_string('edit').'</th>';
322         echo '<th class="header" scope="col">'.get_string('select').'</th>';
323     } else {
324         echo '<th class="header" scope="col">&nbsp;</th>';
325     }
326     echo '</tr>';
328     $count = 0;
329     $abletomovecourses = false;  // for now
331     // Checking if we are at the first or at the last page, to allow courses to
332     // be moved up and down beyond the paging border
333     if ($totalcount > $perpage) {
334         $atfirstpage = ($page == 0);
335         if ($perpage > 0) {
336             $atlastpage = (($page + 1) == ceil($totalcount / $perpage));
337         } else {
338             $atlastpage = true;
339         }
340     } else {
341         $atfirstpage = true;
342         $atlastpage = true;
343     }
345     $baseurl = new moodle_url('/course/category.php', $urlparams + array('sesskey' => sesskey()));
346     foreach ($courses as $acourse) {
347         $coursecontext = get_context_instance(CONTEXT_COURSE, $acourse->id);
349         $count++;
350         $up = ($count > 1 || !$atfirstpage);
351         $down = ($count < $numcourses || !$atlastpage);
353         $linkcss = $acourse->visible ? '' : ' class="dimmed" ';
354         echo '<tr>';
355         $coursename = get_course_display_name_for_list($acourse);
356         echo '<td><a '.$linkcss.' href="view.php?id='.$acourse->id.'">'. format_string($coursename) .'</a></td>';
357         if ($editingon) {
358             echo '<td>';
359             if (has_capability('moodle/course:update', $coursecontext)) {
360                 $url = new moodle_url('/course/edit.php', array('id' => $acourse->id, 'category' => $id, 'returnto' => 'category'));
361                 echo $OUTPUT->action_icon($url, new pix_icon('t/edit', get_string('settings')));
362             }
364             // role assignment link
365             if (has_capability('moodle/course:enrolreview', $coursecontext)) {
366                 $url = new moodle_url('/enrol/users.php', array('id' => $acourse->id));
367                 echo $OUTPUT->action_icon($url, new pix_icon('i/users', get_string('enrolledusers', 'enrol')));
368             }
370             if (can_delete_course($acourse->id)) {
371                 $url = new moodle_url('/course/delete.php', array('id' => $acourse->id));
372                 echo $OUTPUT->action_icon($url, new pix_icon('t/delete', get_string('delete')));
373             }
375             // MDL-8885, users with no capability to view hidden courses, should not be able to lock themselves out
376             if (has_capability('moodle/course:visibility', $coursecontext) && has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
377                 if (!empty($acourse->visible)) {
378                     $url = new moodle_url($baseurl, array('hide' => $acourse->id));
379                     echo $OUTPUT->action_icon($url, new pix_icon('t/hide', get_string('hide')));
380                 } else {
381                     $url = new moodle_url($baseurl, array('show' => $acourse->id));
382                     echo $OUTPUT->action_icon($url, new pix_icon('t/show', get_string('show')));
383                 }
384             }
386             if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
387                 $url = new moodle_url('/backup/backup.php', array('id' => $acourse->id));
388                 echo $OUTPUT->action_icon($url, new pix_icon('t/backup', get_string('backup')));
389             }
391             if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
392                 $url = new moodle_url('/backup/restorefile.php', array('contextid' => $coursecontext->id));
393                 echo $OUTPUT->action_icon($url, new pix_icon('t/restore', get_string('restore')));
394             }
396             if ($canmanage) {
397                 if ($up) {
398                     $url = new moodle_url($baseurl, array('moveup' => $acourse->id));
399                     echo $OUTPUT->action_icon($url, new pix_icon('t/up', get_string('moveup')));
400                 }
402                 if ($down) {
403                     $url = new moodle_url($baseurl, array('movedown' => $acourse->id));
404                     echo $OUTPUT->action_icon($url, new pix_icon('t/down', get_string('movedown')));
405                 }
406                 $abletomovecourses = true;
407             }
409             echo '</td>';
410             echo '<td align="center">';
411             echo '<input type="checkbox" name="c'.$acourse->id.'" />';
412             echo '</td>';
413         } else {
414             echo '<td align="right">';
415             // print enrol info
416             if ($icons = enrol_get_course_info_icons($acourse)) {
417                 foreach ($icons as $pix_icon) {
418                     echo $OUTPUT->render($pix_icon);
419                 }
420             }
421             if (!empty($acourse->summary)) {
422                 $url = new moodle_url("/course/info.php?id=$acourse->id");
423                 echo $OUTPUT->action_link($url, '<img alt="'.get_string('info').'" class="icon" src="'.$OUTPUT->pix_url('i/info') . '" />',
424                     new popup_action('click', $url, 'courseinfo'), array('title'=>get_string('summary')));
425             }
426             echo "</td>";
427         }
428         echo "</tr>";
429     }
431     if ($abletomovecourses) {
432         $movetocategories = array();
433         $notused = array();
434         make_categories_list($movetocategories, $notused, 'moodle/category:manage');
435         $movetocategories[$category->id] = get_string('moveselectedcoursesto');
436         echo '<tr><td colspan="3" align="right">';
437         echo html_writer::label(get_string('moveselectedcoursesto'), 'movetoid', false, array('class' => 'accesshide'));
438         echo html_writer::select($movetocategories, 'moveto', $category->id, null, array('id'=>'movetoid', 'class' => 'autosubmit'));
439         $PAGE->requires->yui_module('moodle-core-formautosubmit',
440             'M.core.init_formautosubmit',
441             array(array('selectid' => 'movetoid', 'nothing' => $category->id))
442         );
443         echo '<input type="hidden" name="id" value="'.$category->id.'" />';
444         echo '</td></tr>';
445     }
447     echo '</table>';
448     echo '</div></form>';
449     echo '<br />';
452 echo '<div class="buttons">';
453 if ($canmanage and $numcourses > 1) {
454     // Print button to re-sort courses by name
455     $url = new moodle_url('/course/category.php', array('id' => $category->id, 'resort' => 'name', 'sesskey' => sesskey()));
456     echo $OUTPUT->single_button($url, get_string('resortcoursesbyname'), 'get');
459 if (has_capability('moodle/course:create', $context)) {
460     // Print button to create a new course
461     $url = new moodle_url('/course/edit.php', array('category' => $category->id, 'returnto' => 'category'));
462     echo $OUTPUT->single_button($url, get_string('addnewcourse'), 'get');
465 if (!empty($CFG->enablecourserequests) && $category->id == $CFG->defaultrequestcategory) {
466     print_course_request_buttons(get_context_instance(CONTEXT_SYSTEM));
468 echo '</div>';
470 print_course_search();
472 echo $OUTPUT->footer();