on-demand release 2.6beta+
[moodle.git] / course / modlib.php
CommitLineData
80fe0c19
JM
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 * Library of functions specific to course/modedit.php and course API functions.
19 * The course API function calling them are course/lib.php:create_module() and update_module().
20 * This file has been created has an alternative solution to a full refactor of course/modedit.php
21 * in order to create the course API functions.
22 *
23 * @copyright 2013 Jerome Mouneyrac
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 * @package core_course
26 */
27
28defined('MOODLE_INTERNAL') || die;
29
30require_once($CFG->dirroot.'/course/lib.php');
31
32/**
33 * Add course module.
34 *
35 * The function does not check user capabilities.
36 * The function creates course module, module instance, add the module to the correct section.
37 * It also trigger common action that need to be done after adding/updating a module.
38 *
39 * @param object $moduleinfo the moudle data
40 * @param object $course the course of the module
41 * @param object $mform this is required by an existing hack to deal with files during MODULENAME_add_instance()
42 * @return object the updated module info
43 */
44function add_moduleinfo($moduleinfo, $course, $mform = null) {
45 global $DB, $CFG;
46
47 $moduleinfo->course = $course->id;
48 $moduleinfo = set_moduleinfo_defaults($moduleinfo);
49
50 if (!empty($course->groupmodeforce) or !isset($moduleinfo->groupmode)) {
51 $moduleinfo->groupmode = 0; // Do not set groupmode.
52 }
53
54 if (!course_allowed_module($course, $moduleinfo->modulename)) {
55 print_error('moduledisable', '', '', $moduleinfo->modulename);
56 }
57
8f2913b9 58 // First add course_module record because we need the context.
80fe0c19
JM
59 $newcm = new stdClass();
60 $newcm->course = $course->id;
61 $newcm->module = $moduleinfo->module;
62 $newcm->instance = 0; // Not known yet, will be updated later (this is similar to restore code).
63 $newcm->visible = $moduleinfo->visible;
7c69ab5d 64 $newcm->visibleold = $moduleinfo->visible;
80fe0c19
JM
65 $newcm->groupmode = $moduleinfo->groupmode;
66 $newcm->groupingid = $moduleinfo->groupingid;
67 $newcm->groupmembersonly = $moduleinfo->groupmembersonly;
68 $completion = new completion_info($course);
69 if ($completion->is_enabled()) {
70 $newcm->completion = $moduleinfo->completion;
71 $newcm->completiongradeitemnumber = $moduleinfo->completiongradeitemnumber;
72 $newcm->completionview = $moduleinfo->completionview;
73 $newcm->completionexpected = $moduleinfo->completionexpected;
74 }
75 if(!empty($CFG->enableavailability)) {
76 $newcm->availablefrom = $moduleinfo->availablefrom;
77 $newcm->availableuntil = $moduleinfo->availableuntil;
78 $newcm->showavailability = $moduleinfo->showavailability;
79 }
80 if (isset($moduleinfo->showdescription)) {
81 $newcm->showdescription = $moduleinfo->showdescription;
82 } else {
83 $newcm->showdescription = 0;
84 }
85
86 if (!$moduleinfo->coursemodule = add_course_module($newcm)) {
87 print_error('cannotaddcoursemodule');
88 }
89
90 if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
91 $introeditor = $moduleinfo->introeditor;
92 unset($moduleinfo->introeditor);
93 $moduleinfo->intro = $introeditor['text'];
94 $moduleinfo->introformat = $introeditor['format'];
95 }
96
97 $addinstancefunction = $moduleinfo->modulename."_add_instance";
98 $returnfromfunc = $addinstancefunction($moduleinfo, $mform);
99 if (!$returnfromfunc or !is_number($returnfromfunc)) {
100 // Undo everything we can.
101 $modcontext = context_module::instance($moduleinfo->coursemodule);
c592eea2 102 context_helper::delete_instance(CONTEXT_MODULE, $moduleinfo->coursemodule);
80fe0c19
JM
103 $DB->delete_records('course_modules', array('id'=>$moduleinfo->coursemodule));
104
105 if (!is_number($returnfromfunc)) {
106 print_error('invalidfunction', '', course_get_url($course, $cw->section));
107 } else {
108 print_error('cannotaddnewmodule', '', course_get_url($course, $cw->section), $moduleinfo->modulename);
109 }
110 }
111
112 $moduleinfo->instance = $returnfromfunc;
113
114 $DB->set_field('course_modules', 'instance', $returnfromfunc, array('id'=>$moduleinfo->coursemodule));
115
116 // Update embedded links and save files.
117 $modcontext = context_module::instance($moduleinfo->coursemodule);
118 if (!empty($introeditor)) {
119 $moduleinfo->intro = file_save_draft_area_files($introeditor['itemid'], $modcontext->id,
120 'mod_'.$moduleinfo->modulename, 'intro', 0,
121 array('subdirs'=>true), $introeditor['text']);
122 $DB->set_field($moduleinfo->modulename, 'intro', $moduleinfo->intro, array('id'=>$moduleinfo->instance));
123 }
124
125 // Course_modules and course_sections each contain a reference to each other.
126 // So we have to update one of them twice.
127 $sectionid = course_add_cm_to_section($course, $moduleinfo->coursemodule, $moduleinfo->section);
128
129 // Make sure visibility is set correctly (in particular in calendar).
130 // Note: allow them to set it even without moodle/course:activityvisibility.
131 set_coursemodule_visible($moduleinfo->coursemodule, $moduleinfo->visible);
132
133 if (isset($moduleinfo->cmidnumber)) { // Label.
134 // Set cm idnumber - uniqueness is already verified by form validation.
135 set_coursemodule_idnumber($moduleinfo->coursemodule, $moduleinfo->cmidnumber);
136 }
137
138 // Set up conditions.
139 if ($CFG->enableavailability) {
140 condition_info::update_cm_from_form((object)array('id'=>$moduleinfo->coursemodule), $moduleinfo, false);
141 }
142
63deb5c3
AA
143 // Trigger event based on the action we did.
144 $event = \core\event\course_module_created::create(array(
145 'courseid' => $course->id,
146 'context' => $modcontext,
147 'objectid' => $moduleinfo->coursemodule,
148 'other' => array(
149 'modulename' => $moduleinfo->modulename,
150 'name' => $moduleinfo->name,
151 'instanceid' => $moduleinfo->instance
152 )
153 ));
154 $event->trigger();
80fe0c19 155
80fe0c19
JM
156 add_to_log($course->id, $moduleinfo->modulename, "add",
157 "view.php?id=$moduleinfo->coursemodule",
158 "$moduleinfo->instance", $moduleinfo->coursemodule);
159
63deb5c3 160 $moduleinfo = edit_module_post_actions($moduleinfo, $course);
80fe0c19
JM
161
162 return $moduleinfo;
163}
164
165
166/**
167 * Common create/update module module actions that need to be processed as soon as a module is created/updaded.
63deb5c3
AA
168 * For example:create grade parent category, add outcomes, rebuild caches, regrade, save plagiarism settings...
169 * Please note this api does not trigger events as of MOODLE 2.6. Please trigger events before calling this api.
80fe0c19
JM
170 *
171 * @param object $moduleinfo the module info
172 * @param object $course the course of the module
80fe0c19 173 *
63deb5c3 174 * @return object moduleinfo update with grading management info
80fe0c19 175 */
63deb5c3
AA
176function edit_module_post_actions($moduleinfo, $course) {
177 global $CFG;
80fe0c19
JM
178
179 $modcontext = context_module::instance($moduleinfo->coursemodule);
180
80fe0c19
JM
181 // Sync idnumber with grade_item.
182 if ($grade_item = grade_item::fetch(array('itemtype'=>'mod', 'itemmodule'=>$moduleinfo->modulename,
183 'iteminstance'=>$moduleinfo->instance, 'itemnumber'=>0, 'courseid'=>$course->id))) {
184 if ($grade_item->idnumber != $moduleinfo->cmidnumber) {
185 $grade_item->idnumber = $moduleinfo->cmidnumber;
186 $grade_item->update();
187 }
188 }
189
190 $items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$moduleinfo->modulename,
191 'iteminstance'=>$moduleinfo->instance, 'courseid'=>$course->id));
192
193 // Create parent category if requested and move to correct parent category.
194 if ($items and isset($moduleinfo->gradecat)) {
195 if ($moduleinfo->gradecat == -1) {
196 $grade_category = new grade_category();
197 $grade_category->courseid = $course->id;
198 $grade_category->fullname = $moduleinfo->name;
199 $grade_category->insert();
200 if ($grade_item) {
201 $parent = $grade_item->get_parent_category();
202 $grade_category->set_parent($parent->id);
203 }
204 $moduleinfo->gradecat = $grade_category->id;
205 }
206 foreach ($items as $itemid=>$unused) {
207 $items[$itemid]->set_parent($moduleinfo->gradecat);
208 if ($itemid == $grade_item->id) {
209 // Use updated grade_item.
210 $grade_item = $items[$itemid];
211 }
212 }
213 }
214
215 // Add outcomes if requested.
216 if ($outcomes = grade_outcome::fetch_all_available($course->id)) {
217 $grade_items = array();
218
219 // Outcome grade_item.itemnumber start at 1000, there is nothing above outcomes.
220 $max_itemnumber = 999;
221 if ($items) {
222 foreach($items as $item) {
223 if ($item->itemnumber > $max_itemnumber) {
224 $max_itemnumber = $item->itemnumber;
225 }
226 }
227 }
228
229 foreach($outcomes as $outcome) {
230 $elname = 'outcome_'.$outcome->id;
231
232 if (property_exists($moduleinfo, $elname) and $moduleinfo->$elname) {
233 // So we have a request for new outcome grade item?
234 if ($items) {
3b2a6bf5 235 $outcomeexists = false;
80fe0c19
JM
236 foreach($items as $item) {
237 if ($item->outcomeid == $outcome->id) {
3b2a6bf5
DW
238 $outcomeexists = true;
239 break;
80fe0c19
JM
240 }
241 }
3b2a6bf5
DW
242 if ($outcomeexists) {
243 continue;
244 }
80fe0c19
JM
245 }
246
247 $max_itemnumber++;
248
249 $outcome_item = new grade_item();
250 $outcome_item->courseid = $course->id;
251 $outcome_item->itemtype = 'mod';
252 $outcome_item->itemmodule = $moduleinfo->modulename;
253 $outcome_item->iteminstance = $moduleinfo->instance;
254 $outcome_item->itemnumber = $max_itemnumber;
255 $outcome_item->itemname = $outcome->fullname;
256 $outcome_item->outcomeid = $outcome->id;
257 $outcome_item->gradetype = GRADE_TYPE_SCALE;
258 $outcome_item->scaleid = $outcome->scaleid;
259 $outcome_item->insert();
260
261 // Move the new outcome into correct category and fix sortorder if needed.
262 if ($grade_item) {
263 $outcome_item->set_parent($grade_item->categoryid);
264 $outcome_item->move_after_sortorder($grade_item->sortorder);
265
266 } else if (isset($moduleinfo->gradecat)) {
267 $outcome_item->set_parent($moduleinfo->gradecat);
268 }
269 }
270 }
271 }
272
273 if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_ADVANCED_GRADING, false)
274 and has_capability('moodle/grade:managegradingforms', $modcontext)) {
275 require_once($CFG->dirroot.'/grade/grading/lib.php');
276 $gradingman = get_grading_manager($modcontext, 'mod_'.$moduleinfo->modulename);
277 $showgradingmanagement = false;
278 foreach ($gradingman->get_available_areas() as $areaname => $aretitle) {
279 $formfield = 'advancedgradingmethod_'.$areaname;
280 if (isset($moduleinfo->{$formfield})) {
281 $gradingman->set_area($areaname);
282 $methodchanged = $gradingman->set_active_method($moduleinfo->{$formfield});
283 if (empty($moduleinfo->{$formfield})) {
284 // Going back to the simple direct grading is not a reason to open the management screen.
285 $methodchanged = false;
286 }
287 $showgradingmanagement = $showgradingmanagement || $methodchanged;
288 }
289 }
290 // Update grading management information.
291 $moduleinfo->gradingman = $gradingman;
292 $moduleinfo->showgradingmanagement = $showgradingmanagement;
293 }
294
295 rebuild_course_cache($course->id);
296 grade_regrade_final_grades($course->id);
297 require_once($CFG->libdir.'/plagiarismlib.php');
8f2913b9 298 plagiarism_save_form_elements($moduleinfo);
80fe0c19
JM
299
300 return $moduleinfo;
301}
302
303
304/**
305 * Set module info default values for the unset module attributs.
306 *
307 * @param object $moduleinfo the current known data of the module
308 * @return object the completed module info
309 */
310function set_moduleinfo_defaults($moduleinfo) {
311 global $DB;
312
313 if (empty($moduleinfo->coursemodule)) {
314 // Add.
315 $cm = null;
316 $moduleinfo->instance = '';
317 $moduleinfo->coursemodule = '';
318 } else {
319 // Update.
320 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
321 $moduleinfo->instance = $cm->instance;
322 $moduleinfo->coursemodule = $cm->id;
323 }
8f2913b9
DW
324 // For safety.
325 $moduleinfo->modulename = clean_param($moduleinfo->modulename, PARAM_PLUGIN);
80fe0c19
JM
326
327 if (!isset($moduleinfo->groupingid)) {
328 $moduleinfo->groupingid = 0;
329 }
330
331 if (!isset($moduleinfo->groupmembersonly)) {
332 $moduleinfo->groupmembersonly = 0;
333 }
334
335 if (!isset($moduleinfo->name)) { // Label.
336 $moduleinfo->name = $moduleinfo->modulename;
337 }
338
339 if (!isset($moduleinfo->completion)) {
340 $moduleinfo->completion = COMPLETION_DISABLED;
341 }
342 if (!isset($moduleinfo->completionview)) {
343 $moduleinfo->completionview = COMPLETION_VIEW_NOT_REQUIRED;
344 }
345
346 // Convert the 'use grade' checkbox into a grade-item number: 0 if checked, null if not.
347 if (isset($moduleinfo->completionusegrade) && $moduleinfo->completionusegrade) {
348 $moduleinfo->completiongradeitemnumber = 0;
349 } else {
350 $moduleinfo->completiongradeitemnumber = null;
351 }
352
353 return $moduleinfo;
354}
355
356/**
357 * Check that the user can add a module. Also returns some information like the module, context and course section info.
358 * The fucntion create the course section if it doesn't exist.
359 *
360 * @param object $course the course of the module
361 * @param object $modulename the module name
362 * @param object $section the section of the module
363 * @return array list containing module, context, course section.
364 */
365function can_add_moduleinfo($course, $modulename, $section) {
366 global $DB;
367
368 $module = $DB->get_record('modules', array('name'=>$modulename), '*', MUST_EXIST);
369
370 $context = context_course::instance($course->id);
371 require_capability('moodle/course:manageactivities', $context);
372
373 course_create_sections_if_missing($course, $section);
374 $cw = get_fast_modinfo($course)->get_section_info($section);
375
376 if (!course_allowed_module($course, $module->name)) {
377 print_error('moduledisable');
378 }
379
380 return array($module, $context, $cw);
381}
382
383/**
384 * Check if user is allowed to update module info and returns related item/data to the module.
385 *
386 * @param object $cm course module
387 * @return array - list of course module, context, module, moduleinfo, and course section.
388 */
389function can_update_moduleinfo($cm) {
390 global $DB;
391
392 // Check the $USER has the right capability.
393 $context = context_module::instance($cm->id);
394 require_capability('moodle/course:manageactivities', $context);
395
396 // Check module exists.
397 $module = $DB->get_record('modules', array('id'=>$cm->module), '*', MUST_EXIST);
398
399 // Check the moduleinfo exists.
400 $data = $DB->get_record($module->name, array('id'=>$cm->instance), '*', MUST_EXIST);
401
402 // Check the course section exists.
403 $cw = $DB->get_record('course_sections', array('id'=>$cm->section), '*', MUST_EXIST);
404
405 return array($cm, $context, $module, $data, $cw);
406}
407
408
409/**
410 * Update the module info.
411 * This function doesn't check the user capabilities. It updates the course module and the module instance.
412 * Then execute common action to create/update module process (trigger event, rebuild cache, save plagiarism settings...).
413 *
414 * @param object $cm course module
415 * @param object $moduleinfo module info
416 * @param object $course course of the module
417 * @param object $mform - the mform is required by some specific module in the function MODULE_update_instance(). This is due to a hack in this function.
418 * @return array list of course module and module info.
419 */
420function update_moduleinfo($cm, $moduleinfo, $course, $mform = null) {
421 global $DB, $CFG;
422
423 $moduleinfo->course = $course->id;
424 $moduleinfo = set_moduleinfo_defaults($moduleinfo);
425
426 if (!empty($course->groupmodeforce) or !isset($moduleinfo->groupmode)) {
427 $moduleinfo->groupmode = $cm->groupmode; // Keep original.
428 }
429
430 // Update course module first.
431 $cm->groupmode = $moduleinfo->groupmode;
432 if (isset($moduleinfo->groupingid)) {
433 $cm->groupingid = $moduleinfo->groupingid;
434 }
435 if (isset($moduleinfo->groupmembersonly)) {
436 $cm->groupmembersonly = $moduleinfo->groupmembersonly;
437 }
438
439 $completion = new completion_info($course);
a9f5fc15 440 if ($completion->is_enabled() && !empty($moduleinfo->completionunlocked)) {
80fe0c19
JM
441 // Update completion settings.
442 $cm->completion = $moduleinfo->completion;
443 $cm->completiongradeitemnumber = $moduleinfo->completiongradeitemnumber;
444 $cm->completionview = $moduleinfo->completionview;
445 $cm->completionexpected = $moduleinfo->completionexpected;
446 }
447 if (!empty($CFG->enableavailability)) {
448 $cm->availablefrom = $moduleinfo->availablefrom;
449 $cm->availableuntil = $moduleinfo->availableuntil;
450 $cm->showavailability = $moduleinfo->showavailability;
451 condition_info::update_cm_from_form($cm,$moduleinfo,true);
452 }
453 if (isset($moduleinfo->showdescription)) {
454 $cm->showdescription = $moduleinfo->showdescription;
455 } else {
456 $cm->showdescription = 0;
457 }
458
8f2913b9 459 $DB->update_record('course_modules', $cm);
80fe0c19 460
8f2913b9 461 $modcontext = context_module::instance($moduleinfo->coursemodule);
80fe0c19 462
8f2913b9
DW
463 // Update embedded links and save files.
464 if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
465 $moduleinfo->intro = file_save_draft_area_files($moduleinfo->introeditor['itemid'], $modcontext->id,
466 'mod_'.$moduleinfo->modulename, 'intro', 0,
467 array('subdirs'=>true), $moduleinfo->introeditor['text']);
468 $moduleinfo->introformat = $moduleinfo->introeditor['format'];
469 unset($moduleinfo->introeditor);
470 }
471 $updateinstancefunction = $moduleinfo->modulename."_update_instance";
472 if (!$updateinstancefunction($moduleinfo, $mform)) {
473 print_error('cannotupdatemod', '', course_get_url($course, $cw->section), $moduleinfo->modulename);
474 }
80fe0c19 475
8f2913b9
DW
476 // Make sure visibility is set correctly (in particular in calendar).
477 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
478 set_coursemodule_visible($moduleinfo->coursemodule, $moduleinfo->visible);
479 }
80fe0c19 480
8f2913b9
DW
481 if (isset($moduleinfo->cmidnumber)) { // Label.
482 // Set cm idnumber - uniqueness is already verified by form validation.
483 set_coursemodule_idnumber($moduleinfo->coursemodule, $moduleinfo->cmidnumber);
484 }
80fe0c19 485
8f2913b9
DW
486 // Now that module is fully updated, also update completion data if required.
487 // (this will wipe all user completion data and recalculate it)
488 if ($completion->is_enabled() && !empty($moduleinfo->completionunlocked)) {
489 $completion->reset_all_state($cm);
490 }
80fe0c19 491
63deb5c3
AA
492 // Trigger event based on the action we did.
493 $event = \core\event\course_module_updated::create(array(
494 'courseid' => $course->id,
495 'context' => $modcontext,
496 'objectid' => $moduleinfo->coursemodule,
497 'other' => array(
498 'modulename' => $moduleinfo->modulename,
499 'name' => $moduleinfo->name,
500 'instanceid' => $moduleinfo->instance
501 )
502 ));
503 $event->trigger();
504
8f2913b9
DW
505 add_to_log($course->id, $moduleinfo->modulename, "update",
506 "view.php?id=$moduleinfo->coursemodule",
507 "$moduleinfo->instance", $moduleinfo->coursemodule);
80fe0c19 508
63deb5c3 509 $moduleinfo = edit_module_post_actions($moduleinfo, $course);
80fe0c19 510
8f2913b9 511 return array($cm, $moduleinfo);
80fe0c19
JM
512}
513
514/**
515 * Include once the module lib file.
516 *
517 * @param string $modulename module name of the lib to include
518 */
519function include_modulelib($modulename) {
520 global $CFG;
521 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
522 if (file_exists($modlib)) {
523 include_once($modlib);
524 } else {
525 throw new moodle_exception('modulemissingcode', '', '', $modlib);
526 }
527}
528