3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Provide interface for topics AJAX course formats
21 * @copyright 1999 Martin Dougiamas http://dougiamas.com
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 if (!defined('AJAX_SCRIPT')) {
27 define('AJAX_SCRIPT', true);
29 require_once(dirname(__FILE__
) . '/../config.php');
30 require_once($CFG->dirroot
.'/course/lib.php');
32 // Initialise ALL the incoming parameters here, up front.
33 $courseid = required_param('courseId', PARAM_INT
);
34 $class = required_param('class', PARAM_ALPHA
);
35 $field = optional_param('field', '', PARAM_ALPHA
);
36 $instanceid = optional_param('instanceId', 0, PARAM_INT
);
37 $sectionid = optional_param('sectionId', 0, PARAM_INT
);
38 $beforeid = optional_param('beforeId', 0, PARAM_INT
);
39 $value = optional_param('value', 0, PARAM_INT
);
40 $column = optional_param('column', 0, PARAM_ALPHA
);
41 $id = optional_param('id', 0, PARAM_INT
);
42 $summary = optional_param('summary', '', PARAM_RAW
);
43 $sequence = optional_param('sequence', '', PARAM_SEQUENCE
);
44 $visible = optional_param('visible', 0, PARAM_INT
);
45 $pageaction = optional_param('action', '', PARAM_ALPHA
); // Used to simulate a DELETE command
46 $title = optional_param('title', '', PARAM_TEXT
);
48 $PAGE->set_url('/course/rest.php', array('courseId'=>$courseid,'class'=>$class));
50 //NOTE: when making any changes here please make sure it is using the same access control as course/mod.php !!
52 $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST
);
53 // Check user is logged in and set contexts if we are dealing with resource
54 if (in_array($class, array('resource'))) {
55 $cm = get_coursemodule_from_id(null, $id, $course->id
, false, MUST_EXIST
);
56 require_login($course, false, $cm);
57 $modcontext = get_context_instance(CONTEXT_MODULE
, $cm->id
);
59 require_login($course);
61 $coursecontext = get_context_instance(CONTEXT_COURSE
, $course->id
);
64 echo $OUTPUT->header(); // send headers
66 // OK, now let's process the parameters and do stuff
67 // MDL-10221 the DELETE method is not allowed on some web servers, so we simulate it with the action URL param
68 $requestmethod = $_SERVER['REQUEST_METHOD'];
69 if ($pageaction == 'DELETE') {
70 $requestmethod = 'DELETE';
73 switch($requestmethod) {
79 if (!$DB->record_exists('course_sections', array('course'=>$course->id
, 'section'=>$id))) {
80 throw new moodle_exception('AJAX commands.php: Bad Section ID '.$id);
85 require_capability('moodle/course:sectionvisibility', $coursecontext);
86 $resourcestotoggle = set_section_visible($course->id
, $id, $value);
87 echo json_encode(array('resourcestotoggle' => $resourcestotoggle));
91 require_capability('moodle/course:update', $coursecontext);
92 move_section_to($course, $id, $value);
93 // See if format wants to do something about it
94 $libfile = $CFG->dirroot
.'/course/format/'.$course->format
.'/lib.php';
95 $functionname = 'callback_'.$course->format
.'_ajax_section_move';
96 if (!function_exists($functionname) && file_exists($libfile)) {
97 require_once $libfile;
99 if (function_exists($functionname)) {
100 echo json_encode($functionname($course));
104 rebuild_course_cache($course->id
);
110 require_capability('moodle/course:activityvisibility', $modcontext);
111 set_coursemodule_visible($cm->id
, $value);
115 require_capability('moodle/course:manageactivities', $modcontext);
116 set_coursemodule_groupmode($cm->id
, $value);
120 require_capability('moodle/course:manageactivities', $modcontext);
121 $cm->indent
= $value;
122 if ($cm->indent
>= 0) {
123 $DB->update_record('course_modules', $cm);
128 require_capability('moodle/course:manageactivities', $modcontext);
129 if (!$section = $DB->get_record('course_sections', array('course'=>$course->id
, 'section'=>$sectionid))) {
130 throw new moodle_exception('AJAX commands.php: Bad section ID '.$sectionid);
134 $beforemod = get_coursemodule_from_id('', $beforeid, $course->id
);
135 $beforemod = $DB->get_record('course_modules', array('id'=>$beforeid));
140 moveto_module($cm, $section, $beforemod);
143 require_capability('moodle/course:manageactivities', $modcontext);
144 $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST
);
145 $module = new stdClass();
146 $module->id
= $cm->instance
;
148 // Don't pass edit strings through multilang filters - we need the entire string
149 echo json_encode(array('instancename' => $cm->name
));
152 require_capability('moodle/course:manageactivities', $modcontext);
153 $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST
);
154 $module = new stdClass();
155 $module->id
= $cm->instance
;
157 // Escape strings as they would be by mform
158 if (!empty($CFG->formatstringstriptags
)) {
159 $module->name
= clean_param($title, PARAM_TEXT
);
161 $module->name
= clean_param($title, PARAM_CLEANHTML
);
164 if (!empty($module->name
)) {
165 $DB->update_record($cm->modname
, $module);
167 $module->name
= $cm->name
;
170 // We need to return strings after they've been through filters for multilang
171 $stringoptions = new stdClass
;
172 $stringoptions->context
= $coursecontext;
173 echo json_encode(array('instancename' => format_string($module->name
, true, $stringoptions)));
176 rebuild_course_cache($course->id
);
182 require_capability('moodle/course:setcurrentsection', $coursecontext);
183 course_set_marker($course->id
, $value);
193 require_capability('moodle/course:manageactivities', $modcontext);
194 $modlib = "$CFG->dirroot/mod/$cm->modname/lib.php";
196 if (file_exists($modlib)) {
197 include_once($modlib);
199 throw new moodle_exception("Ajax rest.php: This module is missing mod/$cm->modname/lib.php");
201 $deleteinstancefunction = $cm->modname
."_delete_instance";
203 // Run the module's cleanup funtion.
204 if (!$deleteinstancefunction($cm->instance
)) {
205 throw new moodle_exception("Ajax rest.php: Could not delete the $cm->modname $cm->name (instance)");
209 // remove all module files in case modules forget to do that
210 $fs = get_file_storage();
211 $fs->delete_area_files($modcontext->id
);
213 if (!delete_course_module($cm->id
)) {
214 throw new moodle_exception("Ajax rest.php: Could not delete the $cm->modname $cm->name (coursemodule)");
216 // Remove the course_modules entry.
217 if (!delete_mod_from_section($cm->id
, $cm->section
)) {
218 throw new moodle_exception("Ajax rest.php: Could not delete the $cm->modname $cm->name from section");
221 // Trigger a mod_deleted event with information about this module.
222 $eventdata = new stdClass();
223 $eventdata->modulename
= $cm->modname
;
224 $eventdata->cmid
= $cm->id
;
225 $eventdata->courseid
= $course->id
;
226 $eventdata->userid
= $USER->id
;
227 events_trigger('mod_deleted', $eventdata);
229 rebuild_course_cache($course->id
);
231 add_to_log($courseid, "course", "delete mod",
232 "view.php?id=$courseid",
233 "$cm->modname $cm->instance", $cm->id
);