course/index.php

   1 <?php // $Id$
   2       // For most people, just lists the course categories
   3       // Allows the admin to create, delete and rename course categories
   4
   5     require_once("../config.php");
   6     require_once("lib.php");
   7
   8     $categoryedit = optional_param('categoryedit', -1,PARAM_BOOL);
   9     $delete   = optional_param('delete',0,PARAM_INT);
  10     $hide     = optional_param('hide',0,PARAM_INT);
  11     $show     = optional_param('show',0,PARAM_INT);
  12     $sure     = optional_param('sure','',PARAM_ALPHANUM);
  13     $move     = optional_param('move',0,PARAM_INT);
  14     $moveto   = optional_param('moveto',-1,PARAM_INT);
  15     $moveup   = optional_param('moveup',0,PARAM_INT);
  16     $movedown = optional_param('movedown',0,PARAM_INT);
  17
  18     $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
  19
  20     if (!$site = get_site()) {
  21         error('Site isn\'t defined!');
  22     }
  23
  24     if ($CFG->forcelogin) {
  25         require_login();
  26     }
  27
  28     if (has_capability('moodle/category:update', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
  29         if ($categoryedit !== -1) {
  30             $USER->categoryediting = $categoryedit;
  31         }
  32         $adminediting = !empty($USER->categoryediting);
  33     } else {
  34         $adminediting = false;
  35     }
  36
  37     $stradministration = get_string('administration');
  38     $strcategories = get_string('categories');
  39     $strcategory = get_string('category');
  40     $strcourses = get_string('courses');
  41     $stredit = get_string('edit');
  42     $strdelete = get_string('delete');
  43     $straction = get_string('action');
  44
  45
  46 /// If data for a new category was submitted, then add it
  47     if ($form = data_submitted() and confirm_sesskey() and has_capability('moodle/category:create', $context)) {
  48         if (!empty($form->addcategory)) {
  49             unset($newcategory);
  50             $newcategory->name = stripslashes_safe($form->addcategory);
  51             $newcategory->sortorder = 999;
  52             if (!insert_record('course_categories', $newcategory)) {
  53                 notify("Could not insert the new category '" . format_string($newcategory->name) . "'");
  54             } else {
  55                 notify(get_string('categoryadded', '', format_string($newcategory->name)));
  56             }
  57         }
  58     }
  59
  60 /// Unless it's an editing admin, just print the regular listing of courses/categories
  61
  62     if (!$adminediting) {
  63
  64       /// Print form for creating new categories
  65
  66         $countcategories = count_records('course_categories');
  67
  68         if ($countcategories > 1 || ($countcategories == 1 && count_records('course') > 200)) {
  69             $strcourses = get_string('courses');
  70             $strcategories = get_string('categories');
  71             print_header("$site->shortname: $strcategories", $strcourses,
  72                           $strcategories, '', '', true, update_categories_button());
  73             print_heading($strcategories);
  74             print_box_start('categorybox');
  75             print_category_create_form();
  76             print_whole_category_list();
  77             print_box_end();
  78             print_course_search();
  79         } else {
  80             $strfulllistofcourses = get_string('fulllistofcourses');
  81             print_header("$site->shortname: $strfulllistofcourses", $strfulllistofcourses, $strfulllistofcourses,
  82                          '', '', true, update_categories_button());
  83             print_box_start('courseboxes');
  84             print_category_create_form();
  85             print_courses(0);
  86             print_box_end();
  87         }
  88
  89         /// I am not sure this context in the next has_capability call is correct.
  90         if (isloggedin() and !isguest() and !has_capability('moodle/course:create', get_context_instance(CONTEXT_SYSTEM, SITEID)) and $CFG->enablecourserequests) {  // Print link to request a new course
  91             print_single_button('request.php', NULL, get_string('courserequest'), 'get');
  92         }
  93         if (has_capability('moodle/course:create', get_context_instance(CONTEXT_SYSTEM, SITEID))) {       // Print link to create a new course
  94         /// Get the 1st available category
  95             $options = array('category' => get_field('course_categories', 'id', 'parent', '0'));
  96             print_single_button('edit.php', $options, get_string('addnewcourse'), 'get');
  97         }
  98         if (has_capability('moodle/site:approvecourse', get_context_instance(CONTEXT_SYSTEM, SITEID))  and !empty($CFG->enablecourserequests)) {
  99             print_single_button('pending.php',NULL, get_string('coursespending'),'get');
 100         }
 101         print_footer();
 102         exit;
 103     }
 104
 105 /// From now on is all the admin/course creator functions
 106
 107 /// Print headings
 108
 109     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
 110         require_once($CFG->libdir.'/adminlib.php');
 111         admin_externalpage_setup('coursemgmt');
 112         admin_externalpage_print_header();
 113     } else {
 114         print_header("$site->shortname: $strcategories", $strcourses,
 115                   $strcategories, '', '', true, update_categories_button());
 116     }
 117
 118     print_heading($strcategories);
 119
 120 /// Delete a category if necessary
 121
 122     if (!empty($delete) and confirm_sesskey()) {
 123
 124           // context is coursecat, if not present admins should have it set in site level
 125          $context = get_context_instance(CONTEXT_COURSECAT, $delete);
 126         if ($deletecat = get_record('course_categories', 'id', $delete) and has_capability('moodle/category:delete', $context)) {
 127             if (!empty($sure) && $sure == md5($deletecat->timemodified)) {
 128                 /// Send the children categories to live with their grandparent
 129                 if ($childcats = get_records('course_categories', 'parent', $deletecat->id)) {
 130                     foreach ($childcats as $childcat) {
 131                         if (! set_field('course_categories', 'parent', $deletecat->parent, 'id', $childcat->id)) {
 132                             error('Could not update a child category!', 'index.php');
 133                         }
 134                     }
 135                 }
 136
 137                 ///  If the grandparent is a valid (non-zero) category, then
 138                 ///  send the children courses to live with their grandparent as well
 139                 if ($deletecat->parent) {
 140                     if ($childcourses = get_records('course', 'category', $deletecat->id)) {
 141                         foreach ($childcourses as $childcourse) {
 142                             if (! set_field('course', 'category', $deletecat->parent, 'id', $childcourse->id)) {
 143                                 error('Could not update a child course!', 'index.php');
 144                             }
 145                         }
 146                     }
 147                 }
 148
 149                 /// Finally delete the category itself
 150                 if (delete_records('course_categories', 'id', $deletecat->id)) {
 151                     notify(get_string('categorydeleted', '', format_string($deletecat->name)));
 152                     // MLD-9983
 153                     events_trigger('category_deleted', $deletecat);
 154                 }
 155             }
 156             else {
 157                 $strdeletecategorycheck = get_string('deletecategorycheck','', format_string($deletecat->name));
 158                 notice_yesno($strdeletecategorycheck,
 159                              "index.php?delete=$delete&amp;sure=".md5($deletecat->timemodified)."&amp;sesskey=$USER->sesskey",
 160                              "index.php?sesskey=$USER->sesskey");
 161
 162                 print_footer();
 163                 exit();
 164             }
 165         }
 166     }
 167
 168
 169 /// Create a default category if necessary
 170     if (!$categories = get_categories()) {    /// No category yet!
 171         // Try and make one
 172         unset($tempcat);
 173         $tempcat->name = get_string('miscellaneous');
 174         if (!$tempcat->id = insert_record('course_categories', $tempcat)) {
 175             error('Serious error: Could not create a default category!');
 176         }
 177     }
 178
 179
 180 /// Move a category to a new parent if required
 181
 182     if (!empty($move) and ($moveto>=0) and confirm_sesskey()) {
 183         if ($tempcat = get_record('course_categories', 'id', $move)) {
 184             if ($tempcat->parent != $moveto) {
 185                 if (! set_field('course_categories', 'parent', $moveto, 'id', $tempcat->id)) {
 186                     notify('Could not update that category!');
 187                 }
 188             }
 189         }
 190     }
 191
 192
 193 /// Hide or show a category
 194     if ((!empty($hide) or !empty($show)) and confirm_sesskey()) {
 195         if (!empty($hide)) {
 196             $tempcat = get_record('course_categories', 'id', $hide);
 197             $visible = 0;
 198         } else {
 199             $tempcat = get_record('course_categories', 'id', $show);
 200             $visible = 1;
 201         }
 202         if ($tempcat) {
 203             if (! set_field('course_categories', 'visible', $visible, 'id', $tempcat->id)) {
 204                 notify('Could not update that category!');
 205             }
 206             if (! set_field('course', 'visible', $visible, 'category', $tempcat->id)) {
 207                 notify('Could not hide/show any courses in this category !');
 208             }
 209         }
 210     }
 211
 212
 213 /// Move a category up or down
 214
 215     if ((!empty($moveup) or !empty($movedown)) and confirm_sesskey()) {
 216
 217         $swapcategory = NULL;
 218         $movecategory = NULL;
 219
 220         if (!empty($moveup)) {
 221             if ($movecategory = get_record('course_categories', 'id', $moveup)) {
 222                 $categories = get_categories($movecategory->parent);
 223
 224                 foreach ($categories as $category) {
 225                     if ($category->id == $movecategory->id) {
 226                         break;
 227                     }
 228                     $swapcategory = $category;
 229                 }
 230             }
 231         }
 232         if (!empty($movedown)) {
 233             if ($movecategory = get_record('course_categories', 'id', $movedown)) {
 234                 $categories = get_categories($movecategory->parent);
 235
 236                 $choosenext = false;
 237                 foreach ($categories as $category) {
 238                     if ($choosenext) {
 239                         $swapcategory = $category;
 240                         break;
 241                     }
 242                     if ($category->id == $movecategory->id) {
 243                         $choosenext = true;
 244                     }
 245                 }
 246             }
 247         }
 248         if ($swapcategory and $movecategory) {        // Renumber everything for robustness
 249             $count=0;
 250             foreach ($categories as $category) {
 251                 $count++;
 252                 if ($category->id == $swapcategory->id) {
 253                     $category = $movecategory;
 254                 } else if ($category->id == $movecategory->id) {
 255                     $category = $swapcategory;
 256                 }
 257                 if (! set_field('course_categories', 'sortorder', $count, 'id', $category->id)) {
 258                     notify('Could not update that category!');
 259                 }
 260             }
 261         }
 262     }
 263
 264 /// Find the default category (the one with the lowest ID)
 265     $categories = get_categories();
 266     $default = 99999;
 267     foreach ($categories as $category) {
 268         if ($category->id < $default) {
 269             $default = $category->id;
 270         }
 271     }
 272
 273 /// Find any orphan courses that don't yet have a valid category and set to default
 274     if ($courses = get_courses(NULL,NULL,'c.id, c.category, c.sortorder, c.visible')) {
 275         foreach ($courses as $course) {
 276             if ($course->category and !isset($categories[$course->category])) {
 277                 set_field('course', 'category', $default, 'id', $course->id);
 278             }
 279         }
 280     }
 281
 282     fix_course_sortorder();
 283
 284 /// Print form for creating new categories
 285     print_category_create_form();
 286
 287 /// Print out the categories with all the knobs
 288
 289     $strcategories = get_string('categories');
 290     $strcourses = get_string('courses');
 291     $strmovecategoryto = get_string('movecategoryto');
 292     $stredit = get_string('edit');
 293
 294     $displaylist = array();
 295     $parentlist = array();
 296
 297     $displaylist[0] = get_string('top');
 298     make_categories_list($displaylist, $parentlist, '');
 299
 300     echo '<table class="generalbox editcourse boxaligncenter"><tr class="header">';
 301     echo '<th class="header" scope="col">'.$strcategories.'</th>';
 302     echo '<th class="header" scope="col">'.$strcourses.'</th>';
 303     echo '<th class="header" scope="col">'.$stredit.'</th>';
 304     echo '<th class="header" scope="col">'.$strmovecategoryto.'</th>';
 305     echo '</tr>';
 306
 307     print_category_edit(NULL, $displaylist, $parentlist);
 308
 309     echo '</table>';
 310
 311     echo '<div class="buttons">';
 312     /// Print link to create a new course
 313     if (has_capability('moodle/course:create', $context)) {
 314         unset($options);
 315         $options['category'] = $category->id;
 316         print_single_button('edit.php', $options, get_string('addnewcourse'), 'get');
 317     }
 318
 319     if (has_capability('moodle/site:approvecourse', get_context_instance(CONTEXT_SYSTEM, SITEID))  and !empty($CFG->enablecourserequests)) {
 320         print_single_button('pending.php',NULL, get_string('coursespending'), 'get');
 321     }
 322     // admin page does not allow custom buttons in the navigation bar
 323     echo '<div class="singlebutton">';
 324     echo update_categories_button();
 325     echo '</div></div>';
 326
 327     print_footer();
 328
 329
 330 function print_category_edit($category, $displaylist, $parentslist, $depth=-1, $up=false, $down=false) {
 331 /// Recursive function to print all the categories ready for editing
 332
 333     global $CFG, $USER;
 334
 335     static $str = '';
 336
 337     if (empty($str)) {
 338         $str->delete   = get_string('delete');
 339         $str->moveup   = get_string('moveup');
 340         $str->movedown = get_string('movedown');
 341         $str->edit     = get_string('editthiscategory');
 342         $str->hide     = get_string('hide');
 343         $str->show     = get_string('show');
 344     }
 345
 346     if ($category) {
 347
 348         $context  = get_context_instance(CONTEXT_COURSECAT, $category->id);
 349
 350         echo '<tr><td align="left" class="name">';
 351         for ($i=0; $i<$depth;$i++) {
 352             echo '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;';
 353         }
 354         $linkcss = $category->visible ? '' : ' class="dimmed" ';
 355         echo '<a '.$linkcss.' title="'.$str->edit.'" '.
 356              ' href="category.php?id='.$category->id.'&amp;categoryedit=on&amp;sesskey='.sesskey().'">'.
 357              format_string($category->name).'</a>';
 358         echo '</td>';
 359
 360         echo '<td class="count">'.$category->coursecount.'</td>';
 361
 362         echo '<td class="icons">';    /// Print little icons
 363
 364         if (has_capability('moodle/category:delete', $context)) {
 365             echo '<a title="'.$str->delete.'" href="index.php?delete='.$category->id.'&amp;sesskey='.sesskey().'"><img'.
 366                  ' src="'.$CFG->pixpath.'/t/delete.gif" class="iconsmall" alt="'.$str->delete.'" /></a> ';
 367         }
 368
 369         if (has_capability('moodle/category:visibility', $context)) {
 370             if (!empty($category->visible)) {
 371                 echo '<a title="'.$str->hide.'" href="index.php?hide='.$category->id.'&amp;sesskey='.sesskey().'"><img'.
 372                      ' src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" alt="'.$str->hide.'" /></a> ';
 373             } else {
 374                 echo '<a title="'.$str->show.'" href="index.php?show='.$category->id.'&amp;sesskey='.sesskey().'"><img'.
 375                      ' src="'.$CFG->pixpath.'/t/show.gif" class="iconsmall" alt="'.$str->show.'" /></a> ';
 376             }
 377         }
 378
 379         if ($up) {
 380             echo '<a title="'.$str->moveup.'" href="index.php?moveup='.$category->id.'&amp;sesskey='.sesskey().'"><img'.
 381                  ' src="'.$CFG->pixpath.'/t/up.gif" class="iconsmall" alt="'.$str->moveup.'" /></a> ';
 382         }
 383         if ($down) {
 384             echo '<a title="'.$str->movedown.'" href="index.php?movedown='.$category->id.'&amp;sesskey='.sesskey().'"><img'.
 385                  ' src="'.$CFG->pixpath.'/t/down.gif" class="iconsmall" alt="'.$str->movedown.'" /></a> ';
 386         }
 387         echo '</td>';
 388
 389         echo '<td align="left">';
 390         $tempdisplaylist = $displaylist;
 391         unset($tempdisplaylist[$category->id]);
 392         foreach ($parentslist as $key => $parents) {
 393             if (in_array($category->id, $parents)) {
 394                 unset($tempdisplaylist[$key]);
 395             }
 396         }
 397         popup_form ("index.php?move=$category->id&amp;sesskey=$USER->sesskey&amp;moveto=", $tempdisplaylist, "moveform$category->id", $category->parent, '', '', '', false);
 398         echo '</td>';
 399         echo '</tr>';
 400     } else {
 401         $category->id = '0';
 402     }
 403
 404     if ($categories = get_categories($category->id)) {   // Print all the children recursively
 405         $countcats = count($categories);
 406         $count = 0;
 407         $first = true;
 408         $last = false;
 409         foreach ($categories as $cat) {
 410             $count++;
 411             if ($count == $countcats) {
 412                 $last = true;
 413             }
 414             $up = $first ? false : true;
 415             $down = $last ? false : true;
 416             $first = false;
 417
 418             print_category_edit($cat, $displaylist, $parentslist, $depth+1, $up, $down);
 419         }
 420     }
 421 }
 422
 423 /** prints the add new category text input field and form */
 424 function print_category_create_form() {
 425
 426     $straddnewcategory = get_string('addnewcategory');
 427
 428     if (has_capability('moodle/category:create', get_context_instance(CONTEXT_SYSTEM))) {
 429         echo '<div class="addcategory">';
 430         echo '<form id="addform" action="index.php" method="post">';
 431         echo '<fieldset class="invisiblefieldset">';
 432         echo '<input type="text" size="30" alt="'.$straddnewcategory.'" name="addcategory" />';
 433         echo '<input type="submit" value="'.$straddnewcategory.'" />';
 434         echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
 435         echo '</fieldset>';
 436         echo '</form>';
 437         echo '</div>';
 438     }
 439 }
 440 ?>