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