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/>.
  16
  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  */
  27
  28 require_once("../config.php");
  29 require_once($CFG->dirroot.'/course/lib.php');
  30 require_once($CFG->libdir.'/textlib.class.php');
  31
  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);
  42
  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
  52
  53 if (empty($id)) {
  54     print_error("unknowcategory");
  55 }
  56
  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;
  63
  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 }
  77
  78 if (!$category->visible) {
  79     require_capability('moodle/category:viewhiddencategories', $context);
  80 }
  81
  82 $canmanage = has_capability('moodle/category:manage', $context);
  83 $sesskeyprovided = !empty($sesskey) && confirm_sesskey($sesskey);
  84
  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 }
  98
  99 // Process any course actions.
 100 if ($editingon && $sesskeyprovided) {
 101
 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', context_coursecat::instance($moveto));
 108
 109         if (!$destcategory = $DB->get_record('course_categories', array('id' => $data->moveto))) {
 110             print_error('cannotfindcategory', '', '', $data->moveto);
 111         }
 112
 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);
 118
 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     }
 131
 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         }
 141
 142         if ($course) {
 143             $coursecontext = context_course::instance($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     }
 149
 150
 151     // Move a course up or down
 152     if (!empty($moveup) or !empty($movedown)) {
 153         require_capability('moodle/category:manage', $context);
 154
 155         // Ensure the course order has continuous ordering
 156         fix_course_sortorder();
 157         $swapcourse = NULL;
 158
 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     }
 177
 178 } // End of editing stuff
 179
 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;
 184 }
 185 if ($perpage) {
 186     $urlparams['perpage'] = $perpage;
 187 }
 188
 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
 197
 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();
 212 }
 213
 214 /// Print the category selector
 215 $displaylist = array();
 216 $notused = array();
 217 make_categories_list($displaylist, $notused);
 218
 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>';
 224
 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();
 238 }
 239
 240 if ($editingon && $canmanage) {
 241     echo $OUTPUT->container_start('buttons');
 242
 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');
 246
 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');
 250
 251     echo $OUTPUT->container_end();
 252 }
 253
 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';
 261 }
 262 // We're going to preload the context for the subcategory as we know that we
 263 // need it later on for formatting.
 264
 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 = context_coursecat::instance($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));
 290 }
 291
 292 $subcategorieswereshown = (count($table->data) > 0);
 293 if ($subcategorieswereshown) {
 294     echo html_writer::table($table);
 295 }
 296
 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);
 302
 303 // We can consider that we are using pagination when the total count of courses is different than the one returned.
 304 $pagingmode = $totalcount != $numcourses;
 305
 306 if (!$courses) {
 307     // There is no course to display.
 308     if (empty($subcategorieswereshown)) {
 309         echo $OUTPUT->heading(get_string("nocoursesyet"));
 310     }
 311 } else if ($numcourses <= $CFG->courseswithsummarieslimit and !$pagingmode and !$editingon) {
 312     // We display courses with their summaries as we have not reached the limit, also we are not
 313     // in paging mode and not allowed to edit either.
 314     echo $OUTPUT->box_start('courseboxes');
 315     print_courses($category);
 316     echo $OUTPUT->box_end();
 317 } else {
 318     // The conditions above have failed, we display a basic list of courses with paging/editing options.
 319     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "/course/category.php?id=$category->id&perpage=$perpage");
 320
 321     echo '<form id="movecourses" action="category.php" method="post"><div>';
 322     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
 323     echo '<table border="0" cellspacing="2" cellpadding="4" class="generalbox boxaligncenter"><tr>';
 324     echo '<th class="header" scope="col">'.get_string('courses').'</th>';
 325     if ($editingon) {
 326         echo '<th class="header" scope="col">'.get_string('edit').'</th>';
 327         echo '<th class="header" scope="col">'.get_string('select').'</th>';
 328     } else {
 329         echo '<th class="header" scope="col">&nbsp;</th>';
 330     }
 331     echo '</tr>';
 332
 333     $count = 0;
 334     $abletomovecourses = false;  // for now
 335
 336     // Checking if we are at the first or at the last page, to allow courses to
 337     // be moved up and down beyond the paging border
 338     if ($totalcount > $perpage) {
 339         $atfirstpage = ($page == 0);
 340         if ($perpage > 0) {
 341             $atlastpage = (($page + 1) == ceil($totalcount / $perpage));
 342         } else {
 343             $atlastpage = true;
 344         }
 345     } else {
 346         $atfirstpage = true;
 347         $atlastpage = true;
 348     }
 349
 350     $baseurl = new moodle_url('/course/category.php', $urlparams + array('sesskey' => sesskey()));
 351     foreach ($courses as $acourse) {
 352         $coursecontext = context_course::instance($acourse->id);
 353
 354         $count++;
 355         $up = ($count > 1 || !$atfirstpage);
 356         $down = ($count < $numcourses || !$atlastpage);
 357
 358         $linkcss = $acourse->visible ? '' : ' class="dimmed" ';
 359         echo '<tr>';
 360         $coursename = get_course_display_name_for_list($acourse);
 361         echo '<td><a '.$linkcss.' href="view.php?id='.$acourse->id.'">'. format_string($coursename) .'</a></td>';
 362         if ($editingon) {
 363             echo '<td>';
 364             if (has_capability('moodle/course:update', $coursecontext)) {
 365                 $url = new moodle_url('/course/edit.php', array('id' => $acourse->id, 'category' => $id, 'returnto' => 'category'));
 366                 echo $OUTPUT->action_icon($url, new pix_icon('t/edit', get_string('settings')));
 367             }
 368
 369             // role assignment link
 370             if (has_capability('moodle/course:enrolreview', $coursecontext)) {
 371                 $url = new moodle_url('/enrol/users.php', array('id' => $acourse->id));
 372                 echo $OUTPUT->action_icon($url, new pix_icon('t/enrolusers', get_string('enrolledusers', 'enrol')));
 373             }
 374
 375             if (can_delete_course($acourse->id)) {
 376                 $url = new moodle_url('/course/delete.php', array('id' => $acourse->id));
 377                 echo $OUTPUT->action_icon($url, new pix_icon('t/delete', get_string('delete')));
 378             }
 379
 380             // MDL-8885, users with no capability to view hidden courses, should not be able to lock themselves out
 381             if (has_capability('moodle/course:visibility', $coursecontext) && has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
 382                 if (!empty($acourse->visible)) {
 383                     $url = new moodle_url($baseurl, array('hide' => $acourse->id));
 384                     echo $OUTPUT->action_icon($url, new pix_icon('t/hide', get_string('hide')));
 385                 } else {
 386                     $url = new moodle_url($baseurl, array('show' => $acourse->id));
 387                     echo $OUTPUT->action_icon($url, new pix_icon('t/show', get_string('show')));
 388                 }
 389             }
 390
 391             if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
 392                 $url = new moodle_url('/backup/backup.php', array('id' => $acourse->id));
 393                 echo $OUTPUT->action_icon($url, new pix_icon('t/backup', get_string('backup')));
 394             }
 395
 396             if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
 397                 $url = new moodle_url('/backup/restorefile.php', array('contextid' => $coursecontext->id));
 398                 echo $OUTPUT->action_icon($url, new pix_icon('t/restore', get_string('restore')));
 399             }
 400
 401             if ($canmanage) {
 402                 if ($up) {
 403                     $url = new moodle_url($baseurl, array('moveup' => $acourse->id));
 404                     echo $OUTPUT->action_icon($url, new pix_icon('t/up', get_string('moveup')));
 405                 }
 406
 407                 if ($down) {
 408                     $url = new moodle_url($baseurl, array('movedown' => $acourse->id));
 409                     echo $OUTPUT->action_icon($url, new pix_icon('t/down', get_string('movedown')));
 410                 }
 411                 $abletomovecourses = true;
 412             }
 413
 414             echo '</td>';
 415             echo '<td align="center">';
 416             echo '<input type="checkbox" name="c'.$acourse->id.'" />';
 417             echo '</td>';
 418         } else {
 419             echo '<td align="right">';
 420             // print enrol info
 421             if ($icons = enrol_get_course_info_icons($acourse)) {
 422                 foreach ($icons as $pix_icon) {
 423                     echo $OUTPUT->render($pix_icon);
 424                 }
 425             }
 426             if (!empty($acourse->summary)) {
 427                 $url = new moodle_url("/course/info.php?id=$acourse->id");
 428                 echo $OUTPUT->action_link($url, '<img alt="'.get_string('info').'" class="icon" src="'.$OUTPUT->pix_url('i/info') . '" />',
 429                     new popup_action('click', $url, 'courseinfo'), array('title'=>get_string('summary')));
 430             }
 431             echo "</td>";
 432         }
 433         echo "</tr>";
 434     }
 435
 436     if ($abletomovecourses) {
 437         $movetocategories = array();
 438         $notused = array();
 439         make_categories_list($movetocategories, $notused, 'moodle/category:manage');
 440         $movetocategories[$category->id] = get_string('moveselectedcoursesto');
 441         echo '<tr><td colspan="3" align="right">';
 442         echo html_writer::label(get_string('moveselectedcoursesto'), 'movetoid', false, array('class' => 'accesshide'));
 443         echo html_writer::select($movetocategories, 'moveto', $category->id, null, array('id'=>'movetoid', 'class' => 'autosubmit'));
 444         $PAGE->requires->yui_module('moodle-core-formautosubmit',
 445             'M.core.init_formautosubmit',
 446             array(array('selectid' => 'movetoid', 'nothing' => $category->id))
 447         );
 448         echo '<input type="hidden" name="id" value="'.$category->id.'" />';
 449         echo '</td></tr>';
 450     }
 451
 452     echo '</table>';
 453     echo '</div></form>';
 454     echo '<br />';
 455 }
 456
 457 echo '<div class="buttons">';
 458 if ($canmanage and $numcourses > 1) {
 459     // Print button to re-sort courses by name
 460     $url = new moodle_url('/course/category.php', array('id' => $category->id, 'resort' => 'name', 'sesskey' => sesskey()));
 461     echo $OUTPUT->single_button($url, get_string('resortcoursesbyname'), 'get');
 462 }
 463
 464 if (has_capability('moodle/course:create', $context)) {
 465     // Print button to create a new course
 466     $url = new moodle_url('/course/edit.php', array('category' => $category->id, 'returnto' => 'category'));
 467     echo $OUTPUT->single_button($url, get_string('addnewcourse'), 'get');
 468 }
 469
 470 if (!empty($CFG->enablecourserequests) && $category->id == $CFG->defaultrequestcategory) {
 471     print_course_request_buttons(context_system::instance());
 472 }
 473 echo '</div>';
 474
 475 print_course_search();
 476
 477 echo $OUTPUT->footer();