course/rest.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Provide interface for topics AJAX course formats
  20  *
  21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  * @package course
  24  */
  25
  26 require_once('../config.php');
  27 require_once($CFG->dirroot.'/course/lib.php');
  28
  29 // Initialise ALL the incoming parameters here, up front.
  30 $courseid   = required_param('courseId', PARAM_INT);
  31 $class      = required_param('class', PARAM_ALPHA);
  32 $field      = optional_param('field', '', PARAM_ALPHA);
  33 $instanceid = optional_param('instanceId', 0, PARAM_INT);
  34 $sectionid  = optional_param('sectionId', 0, PARAM_INT);
  35 $beforeid   = optional_param('beforeId', 0, PARAM_INT);
  36 $value      = optional_param('value', 0, PARAM_INT);
  37 $column     = optional_param('column', 0, PARAM_ALPHA);
  38 $id         = optional_param('id', 0, PARAM_INT);
  39 $summary    = optional_param('summary', '', PARAM_RAW);
  40 $sequence   = optional_param('sequence', '', PARAM_SEQUENCE);
  41 $visible    = optional_param('visible', 0, PARAM_INT);
  42 $pageaction = optional_param('action', '', PARAM_ALPHA); // Used to simulate a DELETE command
  43
  44 $PAGE->set_url('/course/rest.php', array('courseId'=>$courseid,'class'=>$class));
  45
  46 //NOTE: when making any changes here please make sure it is using the same access control as course/mod.php !!
  47
  48 require_login();
  49
  50 // Authorise the user and verify some incoming data
  51 if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
  52     error_log('AJAX commands.php: Course does not exist');
  53     die;
  54 }
  55
  56 if (empty($CFG->enablecourseajax)) {
  57     error_log('Course AJAX not allowed');
  58     die;
  59 }
  60
  61 require_sesskey();
  62
  63 // OK, now let's process the parameters and do stuff
  64 // MDL-10221 the DELETE method is not allowed on some web servers, so we simulate it with the action URL param
  65 $requestmethod = $_SERVER['REQUEST_METHOD'];
  66 if ($pageaction == 'DELETE') {
  67     $requestmethod = 'DELETE';
  68 }
  69
  70 switch($requestmethod) {
  71     case 'POST':
  72
  73         switch ($class) {
  74             case 'block':
  75                 // not used any more
  76                 break;
  77
  78             case 'section':
  79                 require_login($course);
  80                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
  81
  82                 if (!$DB->record_exists('course_sections', array('course'=>$course->id, 'section'=>$id))) {
  83                     error_log('AJAX commands.php: Bad Section ID '.$id);
  84                     die;
  85                 }
  86
  87                 switch ($field) {
  88                     case 'visible':
  89                         require_capability('moodle/course:sectionvisibility', $coursecontext);
  90                         set_section_visible($course->id, $id, $value);
  91                         break;
  92
  93                     case 'move':
  94                         require_capability('moodle/course:update', $coursecontext);
  95                         move_section_to($course, $id, $value);
  96                         break;
  97                 }
  98                 rebuild_course_cache($course->id);
  99                 break;
 100
 101             case 'resource':
 102                 if (!$cm = get_coursemodule_from_id('', $id, $course->id)) {
 103                     error_log('AJAX commands.php: Bad course module ID '.$id);
 104                     die;
 105                 }
 106                 require_login($course, false, $cm);
 107                 $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 108                 switch ($field) {
 109                     case 'visible':
 110                         require_capability('moodle/course:activityvisibility', $modcontext);
 111                         set_coursemodule_visible($cm->id, $value);
 112                         break;
 113
 114                     case 'groupmode':
 115                         require_capability('moodle/course:manageactivities', $modcontext);
 116                         set_coursemodule_groupmode($cm->id, $value);
 117                         break;
 118
 119                     case 'indentleft':
 120                         require_capability('moodle/course:manageactivities', $modcontext);
 121                         if ($cm->indent > 0) {
 122                             $cm->indent--;
 123                             $DB->update_record('course_modules', $cm);
 124                         }
 125                         break;
 126
 127                     case 'indentright':
 128                         require_capability('moodle/course:manageactivities', $modcontext);
 129                         $cm->indent++;
 130                         $DB->update_record('course_modules', $cm);
 131                         break;
 132
 133                     case 'move':
 134                         require_capability('moodle/course:manageactivities', $modcontext);
 135                         if (!$section = $DB->get_record('course_sections', array('course'=>$course->id, 'section'=>$sectionid))) {
 136                             error_log('AJAX commands.php: Bad section ID '.$sectionid);
 137                             die;
 138                         }
 139
 140                         if ($beforeid > 0){
 141                             $beforemod = get_coursemodule_from_id('', $beforeid, $course->id);
 142                             $beforemod = $DB->get_record('course_modules', array('id'=>$beforeid));
 143                         } else {
 144                             $beforemod = NULL;
 145                         }
 146
 147                         if (debugging('',DEBUG_DEVELOPER)) {
 148                             error_log(serialize($beforemod));
 149                         }
 150
 151                         moveto_module($cm, $section, $beforemod);
 152                         break;
 153                 }
 154                 rebuild_course_cache($course->id);
 155                 break;
 156
 157             case 'course':
 158                 switch($field) {
 159                     case 'marker':
 160                         require_login($course);
 161                         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
 162                         require_capability('moodle/course:setcurrentsection', $coursecontext);
 163                         course_set_marker($course->id, $value);
 164                         break;
 165                 }
 166                 break;
 167         }
 168         break;
 169
 170     case 'DELETE':
 171         switch ($class) {
 172             case 'block':
 173                 // not used any more
 174                 break;
 175
 176             case 'resource':
 177                 if (!$cm = get_coursemodule_from_id('', $id, $course->id)) {
 178                     error_log('AJAX rest.php: Bad course module ID '.$id);
 179                     die;
 180                 }
 181                 require_login($course, false, $cm);
 182                 $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 183                 require_capability('moodle/course:manageactivities', $modcontext);
 184                 $modlib = "$CFG->dirroot/mod/$cm->modname/lib.php";
 185
 186                 if (file_exists($modlib)) {
 187                     include_once($modlib);
 188                 } else {
 189                     error_log("Ajax rest.php: This module is missing mod/$cm->modname/lib.php");
 190                     die;
 191                 }
 192                 $deleteinstancefunction = $cm->modname."_delete_instance";
 193
 194                 // Run the module's cleanup funtion.
 195                 if (!$deleteinstancefunction($cm->instance)) {
 196                     error_log("Ajax rest.php: Could not delete the $cm->modname $cm->name (instance)");
 197                     die;
 198                 }
 199
 200                 // remove all module files in case modules forget to do that
 201                 $fs = get_file_storage();
 202                 $fs->delete_area_files($modcontext->id);
 203
 204                 if (!delete_course_module($cm->id)) {
 205                     error_log("Ajax rest.php: Could not delete the $cm->modname $cm->name (coursemodule)");
 206                 }
 207                 // Remove the course_modules entry.
 208                 if (!delete_mod_from_section($cm->id, $cm->section)) {
 209                     error_log("Ajax rest.php: Could not delete the $cm->modname $cm->name from section");
 210                 }
 211
 212                 // Trigger a mod_deleted event with information about this module.
 213                 $eventdata = new stdClass();
 214                 $eventdata->modulename = $cm->modname;
 215                 $eventdata->cmid       = $cm->id;
 216                 $eventdata->courseid   = $course->id;
 217                 $eventdata->userid     = $USER->id;
 218                 events_trigger('mod_deleted', $eventdata);
 219
 220                 rebuild_course_cache($course->id);
 221
 222                 add_to_log($courseid, "course", "delete mod",
 223                            "view.php?id=$courseid",
 224                            "$cm->modname $cm->instance", $cm->id);
 225                 break;
 226         }
 227         break;
 228 }
 229
 230