301e0a5aca76b1e83592f3255e08725b46e6e3f9
[moodle.git] / course / management.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  * Course and category management interfaces.
19  *
20  * @package    core_course
21  * @copyright  2013 Sam Hemelryk
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once('../config.php');
26 require_once($CFG->dirroot.'/lib/coursecatlib.php');
27 require_once($CFG->dirroot.'/course/lib.php');
29 $categoryid = optional_param('categoryid', null, PARAM_INT);
30 $selectedcategoryid = optional_param('selectedcategoryid', null, PARAM_INT);
31 $courseid = optional_param('courseid', null, PARAM_INT);
32 $action = optional_param('action', false, PARAM_ALPHA);
33 $page = optional_param('page', 0, PARAM_INT);
34 $perpage = optional_param('perpage', null, PARAM_INT);
35 $viewmode = optional_param('view', 'default', PARAM_ALPHA); // Can be one of default, combined, courses, or categories.
37 // Search related params.
38 $search = optional_param('search', '', PARAM_RAW); // Search words. Shortname, fullname, idnumber and summary get searched.
39 $blocklist = optional_param('blocklist', 0, PARAM_INT); // Find courses containing this block.
40 $modulelist = optional_param('modulelist', '', PARAM_PLUGIN); // Find courses containing the given modules.
42 if (!in_array($viewmode, array('default', 'combined', 'courses', 'categories'))) {
43     $viewmode = 'default';
44 }
46 $issearching = ($search !== '' || $blocklist !== 0 || $modulelist !== '');
47 if ($issearching) {
48     $viewmode = 'courses';
49 }
51 $url = new moodle_url('/course/management.php');
52 $systemcontext = $context = context_system::instance();
53 if ($courseid) {
54     $record = get_course($courseid);
55     $course = new course_in_list($record);
56     $category = coursecat::get($course->category);
57     $categoryid = $category->id;
58     $context = context_coursecat::instance($category->id);
59     $url->param('categoryid', $categoryid);
60     navigation_node::override_active_url($url);
61     $url->param('courseid', $course->id);
63 } else if ($categoryid) {
64     $courseid = null;
65     $course = null;
66     $category = coursecat::get($categoryid);
67     $context = context_coursecat::instance($category->id);
68     $url->param('categoryid', $category->id);
69     navigation_node::override_active_url($url);
71 } else {
72     $course = null;
73     $courseid = null;
74     $category = null;
75     $categoryid = null;
76     if ($viewmode === 'default') {
77         $viewmode = 'categories';
78     }
79     $context = $systemcontext;
80     navigation_node::override_active_url($url);
81 }
83 // Check if there is a selected category param, and if there is apply it.
84 if ($course === null && $selectedcategoryid !== null && $selectedcategoryid !== $categoryid) {
85     $url->param('categoryid', $selectedcategoryid);
86 }
88 if ($page !== 0) {
89     $url->param('page', $page);
90 }
91 if ($viewmode !== 'default') {
92     $url->param('view', $viewmode);
93 }
94 if ($search !== '') {
95     $url->param('search', $search);
96 }
97 if ($blocklist !== 0) {
98     $url->param('blocklist', $search);
99 }
100 if ($modulelist !== '') {
101     $url->param('modulelist', $search);
104 $title = format_string($SITE->fullname, true, array('context' => $systemcontext));
106 $PAGE->set_context($context);
107 $PAGE->set_url($url);
108 $PAGE->set_pagelayout('admin');
109 $PAGE->set_title($title);
110 $PAGE->set_heading($title);
112 // This is a system level page that operates on other contexts.
113 require_login();
115 if (!coursecat::has_capability_on_any(array('moodle/category:manage', 'moodle/course:create'))) {
116     // The user isn't able to manage any categories. Lets redirect them to the relevant course/index.php page.
117     $url = new moodle_url('/course/index.php');
118     if ($categoryid) {
119         $url->param('categoryid', $categoryid);
120     }
121     redirect($url);
124 // If the user poses any of these capabilities then they will be able to see the admin
125 // tree and the management link within it.
126 // This is the most accurate form of navigation.
127 $capabilities = array(
128     'moodle/site:config',
129     'moodle/backup:backupcourse',
130     'moodle/category:manage',
131     'moodle/course:create',
132     'moodle/site:approvecourse'
133 );
134 if ($category && !has_any_capability($capabilities, $systemcontext)) {
135     // If the user doesn't poses any of these system capabilities then we're going to mark the manage link in the settings block
136     // as active, tell the page to ignore the active path and just build what the user would expect.
137     // This will at least give the page some relevant navigation.
138     navigation_node::override_active_url(new moodle_url('/course/management.php', array('categoryid' => $category->id)));
139     $PAGE->set_category_by_id($category->id);
140     $PAGE->navbar->ignore_active(true);
141     $PAGE->navbar->add(get_string('coursemgmt', 'admin'), $PAGE->url->out_omit_querystring());
143 if (!$issearching && $category !== null) {
144     $parents = coursecat::get_many($category->get_parents());
145     $parents[] = $category;
146     foreach ($parents as $parent) {
147         $PAGE->navbar->add(
148             $parent->get_formatted_name(),
149             new moodle_url('/course/management.php', array('categoryid' => $parent->id))
150         );
151     }
152     if ($course instanceof course_in_list) {
153         // Use the list name so that it matches whats being displayed below.
154         $PAGE->navbar->add($course->get_formatted_name());
155     }
158 $notificationspass = array();
159 $notificationsfail = array();
161 if ($action !== false && confirm_sesskey()) {
162     // Actions:
163     // - resortcategories : Resort the courses in the given category.
164     // - resortcourses : Resort courses
165     // - showcourse : make a course visible.
166     // - hidecourse : make a course hidden.
167     // - movecourseup : move the selected course up one.
168     // - movecoursedown : move the selected course down.
169     // - showcategory : make a category visible.
170     // - hidecategory : make a category hidden.
171     // - movecategoryup : move category up.
172     // - movecategorydown : move category down.
173     // - deletecategory : delete the category either in full, or moving contents.
174     // - bulkaction : performs bulk actions:
175     //    - bulkmovecourses.
176     //    - bulkmovecategories.
177     //    - bulkresortcategories.
178     $redirectback = false;
179     switch ($action) {
180         case 'resortcategories' :
181             $sort = required_param('resort', PARAM_ALPHA);
182             $cattosort = coursecat::get((int)optional_param('categoryid', 0, PARAM_INT));
183             $redirectback = \core_course\management\helper::action_category_resort_subcategories($cattosort, $sort);
184             break;
185         case 'resortcourses' :
186             // They must have specified a category.
187             required_param('categoryid', PARAM_INT);
188             $sort = required_param('resort', PARAM_ALPHA);
189             \core_course\management\helper::action_category_resort_courses($category, $sort);
190             break;
191         case 'showcourse' :
192             $redirectback = \core_course\management\helper::action_course_show($course);
193             break;
194         case 'hidecourse' :
195             $redirectback = \core_course\management\helper::action_course_hide($course);
196             break;
197         case 'movecourseup' :
198             // They must have specified a category and a course.
199             required_param('categoryid', PARAM_INT);
200             required_param('courseid', PARAM_INT);
201             $redirectback = \core_course\management\helper::action_course_change_sortorder_up_one($course, $category);
202             break;
203         case 'movecoursedown' :
204             // They must have specified a category and a course.
205             required_param('categoryid', PARAM_INT);
206             required_param('courseid', PARAM_INT);
207             $redirectback = \core_course\management\helper::action_course_change_sortorder_down_one($course, $category);
208             break;
209         case 'showcategory' :
210             // They must have specified a category.
211             required_param('categoryid', PARAM_INT);
212             $redirectback = \core_course\management\helper::action_category_show($category);
213             break;
214         case 'hidecategory' :
215             // They must have specified a category.
216             required_param('categoryid', PARAM_INT);
217             $redirectback = \core_course\management\helper::action_category_hide($category);
218             break;
219         case 'movecategoryup' :
220             // They must have specified a category.
221             required_param('categoryid', PARAM_INT);
222             $redirectback = \core_course\management\helper::action_category_change_sortorder_up_one($category);
223             break;
224         case 'movecategorydown' :
225             // They must have specified a category.
226             required_param('categoryid', PARAM_INT);
227             $redirectback = \core_course\management\helper::action_category_change_sortorder_down_one($category);
228             break;
229         case 'deletecategory':
230             // They must have specified a category.
231             required_param('categoryid', PARAM_INT);
232             if (!$category->can_delete()) {
233                 throw new moodle_exception('permissiondenied', 'error', '', null, 'coursecat::can_resort');
234             }
235             require_once($CFG->dirroot.'/course/delete_category_form.php');
236             $mform = new core_course_deletecategory_form(null, $category);
237             if ($mform->is_cancelled()) {
238                 redirect($PAGE->url);
239             }
240             // Start output.
241             /* @var core_course_management_renderer|core_renderer $renderer */
242             $renderer = $PAGE->get_renderer('core_course', 'management');
243             echo $renderer->header();
244             echo $renderer->heading(get_string('deletecategory', 'moodle', $category->get_formatted_name()));
246             if ($data = $mform->get_data()) {
247                 // The form has been submit handle it.
248                 if ($data->fulldelete == 1 && $category->can_delete_full()) {
249                     $continueurl = new moodle_url('/course/management.php');
250                     if ($category->parent != '0') {
251                         $continueurl->param('categoryid', $category->parent);
252                     }
253                     $notification = get_string('coursecategorydeleted', '', $category->get_formatted_name());
254                     $deletedcourses = $category->delete_full(true);
255                     foreach ($deletedcourses as $course) {
256                         echo $renderer->notification(get_string('coursedeleted', '', $course->shortname), 'notifysuccess');
257                     }
258                     echo $renderer->notification($notification, 'notifysuccess');
259                     echo $renderer->continue_button($continueurl);
260                 } else if ($data->fulldelete == 0 && $category->can_move_content_to($data->newparent)) {
261                     $continueurl = new moodle_url('/course/management.php', array('categoryid' => $data->newparent));
262                     $category->delete_move($data->newparent, true);
263                     echo $renderer->continue_button($continueurl);
264                 } else {
265                     // Some error in parameters (user is cheating?)
266                     $mform->display();
267                 }
268             } else {
269                 // Display the form.
270                 $mform->display();
271             }
272             // Finish output and exit.
273             echo $renderer->footer();
274             exit();
275             break;
276         case 'bulkaction':
277             $bulkmovecourses = optional_param('bulkmovecourses', false, PARAM_BOOL);
278             $bulkmovecategories = optional_param('bulkmovecategories', false, PARAM_BOOL);
279             $bulkresortcategories = optional_param('bulkresortcategories', false, PARAM_BOOL);
281             if ($bulkmovecourses) {
282                 // Move courses out of the current category and into a new category.
283                 // They must have specified a category.
284                 required_param('categoryid', PARAM_INT);
285                 $movetoid = required_param('movecoursesto', PARAM_INT);
286                 $courseids = optional_param_array('bc', false, PARAM_INT);
287                 if ($courseids === false) {
288                     break;
289                 }
290                 $moveto = coursecat::get($movetoid);
291                 try {
292                     // If this fails we want to catch the exception and report it.
293                     $redirectback = \core_course\management\helper::action_category_move_courses_into($category, $moveto,
294                         $courseids);
295                 } catch (moodle_exception $ex) {
296                     $redirectback = false;
297                     $notificationsfail[] = $ex->getMessage();
298                 }
299             } else if ($bulkmovecategories) {
300                 $categoryids = optional_param_array('bcat', array(), PARAM_INT);
301                 $movetocatid = required_param('movecategoriesto', PARAM_INT);
302                 $movetocat = coursecat::get($movetocatid);
303                 $movecount = 0;
304                 foreach ($categoryids as $id) {
305                     $cattomove = coursecat::get($id);
306                     if ($id == $movetocatid) {
307                         $notificationsfail[] = get_string('movecategoryownparent', 'error', $cattomove->get_formatted_name());
308                         continue;
309                     }
310                     if (strpos($movetocat->path, $cattomove->path) === 0) {
311                         $notificationsfail[] = get_string('movecategoryparentconflict', 'error', $cattomove->get_formatted_name());
312                         continue;
313                     }
314                     if ($cattomove->parent != $movetocatid) {
315                         if ($cattomove->can_change_parent($movetocatid)) {
316                             $cattomove->change_parent($movetocatid);
317                             $movecount++;
318                         } else {
319                             $notificationsfail[] = get_string('movecategorynotpossible', 'error', $cattomove->get_formatted_name());
320                         }
321                     }
322                 }
323                 if ($movecount > 1) {
324                     $a = new stdClass;
325                     $a->count = $movecount;
326                     $a->to = $movetocat->get_formatted_name();
327                     $movesuccessstrkey = 'movecategoriessuccess';
328                     if ($movetocatid == 0) {
329                         $movesuccessstrkey = 'movecategoriestotopsuccess';
330                     }
331                     $notificationspass[] = get_string($movesuccessstrkey, 'moodle', $a);
332                 } else if ($movecount === 1) {
333                     $a = new stdClass;
334                     $a->moved = $cattomove->get_formatted_name();
335                     $a->to = $movetocat->get_formatted_name();
336                     $movesuccessstrkey = 'movecategorysuccess';
337                     if ($movetocatid == 0) {
338                         $movesuccessstrkey = 'movecategorytotopsuccess';
339                     }
340                     $notificationspass[] = get_string($movesuccessstrkey, 'moodle', $a);
341                 }
342             } else if ($bulkresortcategories) {
343                 // Bulk resort selected categories.
344                 $categoryids = optional_param_array('bcat', false, PARAM_INT);
345                 $sort = required_param('resortcategoriesby', PARAM_ALPHA);
346                 if ($categoryids === false) {
347                     break;
348                 }
349                 $categories = coursecat::get_many($categoryids);
350                 foreach ($categories as $cat) {
351                     // Don't clean up here, we'll do it once we're all done.
352                     \core_course\management\helper::action_category_resort_subcategories($cat, $sort, false);
353                 }
354                 coursecat::resort_categories_cleanup();
355                 if ($category === null && count($categoryids) === 1) {
356                     // They're bulk sorting just a single category and they've not selected a category.
357                     // Lets for convenience sake auto-select the category that has been resorted for them.
358                     redirect(new moodle_url($PAGE->url, array('categoryid' => reset($categoryids))));
359                 }
360             }
361     }
362     if ($redirectback) {
363         redirect($PAGE->url);
364     }
367 if (!is_null($perpage)) {
368     set_user_preference('coursecat_management_perpage', $perpage);
369 } else {
370     $perpage = get_user_preferences('coursecat_management_perpage', $CFG->coursesperpage);
372 if ((int)$perpage != $perpage || $perpage < 2) {
373     $perpage = $CFG->coursesperpage;
376 $categorysize = 4;
377 $coursesize = 4;
378 $detailssize = 4;
379 if ($viewmode === 'default' || $viewmode === 'combined') {
380     if (isset($courseid)) {
381         $class = 'columns-3';
382     } else {
383         $categorysize = 5;
384         $coursesize = 7;
385         $class = 'columns-2';
386     }
387 } else if ($viewmode === 'categories') {
388     $categorysize = 12;
389     $class = 'columns-1';
390 } else if ($viewmode === 'courses') {
391     if (isset($courseid)) {
392         $coursesize = 6;
393         $detailssize = 6;
394         $class = 'columns-2';
395     } else {
396         $coursesize = 12;
397         $class = 'columns-1';
398     }
400 if ($viewmode === 'default' || $viewmode === 'combined') {
401     $class .= ' viewmode-cobmined';
402 } else {
403     $class .= ' viewmode-'.$viewmode;
405 if (($viewmode === 'default' || $viewmode === 'combined' || $viewmode === 'courses') && !empty($courseid)) {
406     $class .= ' course-selected';
409 /* @var core_course_management_renderer|core_renderer $renderer */
410 $renderer = $PAGE->get_renderer('core_course', 'management');
411 $renderer->enhance_management_interface();
413 echo $renderer->header();
415 if (!$issearching) {
416     echo $renderer->management_heading(new lang_string('coursecatmanagement'), $viewmode, $categoryid);
417 } else {
418     echo $renderer->management_heading(new lang_string('searchresults'));
421 if (count($notificationspass) > 0) {
422     echo $renderer->notification(join('<br />', $notificationspass), 'notifysuccess');
424 if (count($notificationsfail) > 0) {
425     echo $renderer->notification(join('<br />', $notificationsfail));
428 // Start the management form.
429 echo $renderer->management_form_start();
431 echo $renderer->grid_start('course-category-listings', $class);
432 if ($viewmode === 'default' || $viewmode === 'combined' || $viewmode === 'categories') {
433     echo $renderer->grid_column_start($categorysize, 'category-listing');
434     echo $renderer->category_listing($category);
435     echo $renderer->grid_column_end();
437 if ($viewmode === 'default' || $viewmode === 'combined' || $viewmode === 'courses') {
438     echo $renderer->grid_column_start($coursesize, 'course-listing');
439     if (!$issearching) {
440         echo $renderer->course_listing($category, $course, $page, $perpage);
441     } else {
442         list($courses, $coursescount, $coursestotal) =
443             \core_course\management\helper::search_courses($search, $blocklist, $modulelist, $page, $perpage);
444         echo $renderer->search_listing($courses, $coursestotal, $course, $page, $perpage);
445     }
446     echo $renderer->grid_column_end();
447     if (isset($courseid)) {
448         echo $renderer->grid_column_start($detailssize, 'course-detail');
449         echo $renderer->course_detail($course);
450         echo $renderer->grid_column_end();
451     }
453 echo $renderer->grid_end();
455 // End of the management form.
456 echo $renderer->management_form_end();
457 echo $renderer->footer();