c9e124088133e84319d0fcc074c92c00ef31dcc1
[moodle.git] / course / modlib.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/>.
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  */
28 defined('MOODLE_INTERNAL') || die;
30 use \core_grades\component_gradeitems;
32 require_once($CFG->dirroot.'/course/lib.php');
34 /**
35  * Add course module.
36  *
37  * The function does not check user capabilities.
38  * The function creates course module, module instance, add the module to the correct section.
39  * It also trigger common action that need to be done after adding/updating a module.
40  *
41  * @param object $moduleinfo the moudle data
42  * @param object $course the course of the module
43  * @param object $mform this is required by an existing hack to deal with files during MODULENAME_add_instance()
44  * @return object the updated module info
45  */
46 function add_moduleinfo($moduleinfo, $course, $mform = null) {
47     global $DB, $CFG;
49     // Attempt to include module library before we make any changes to DB.
50     include_modulelib($moduleinfo->modulename);
52     $moduleinfo->course = $course->id;
53     $moduleinfo = set_moduleinfo_defaults($moduleinfo);
55     if (!empty($course->groupmodeforce) or !isset($moduleinfo->groupmode)) {
56         $moduleinfo->groupmode = 0; // Do not set groupmode.
57     }
59     // First add course_module record because we need the context.
60     $newcm = new stdClass();
61     $newcm->course           = $course->id;
62     $newcm->module           = $moduleinfo->module;
63     $newcm->instance         = 0; // Not known yet, will be updated later (this is similar to restore code).
64     $newcm->visible          = $moduleinfo->visible;
65     $newcm->visibleold       = $moduleinfo->visible;
66     $newcm->visibleoncoursepage = $moduleinfo->visibleoncoursepage;
67     if (isset($moduleinfo->cmidnumber)) {
68         $newcm->idnumber         = $moduleinfo->cmidnumber;
69     }
70     $newcm->groupmode        = $moduleinfo->groupmode;
71     $newcm->groupingid       = $moduleinfo->groupingid;
72     $completion = new completion_info($course);
73     if ($completion->is_enabled()) {
74         $newcm->completion                = $moduleinfo->completion;
75         if ($moduleinfo->completiongradeitemnumber === '') {
76             $newcm->completiongradeitemnumber = null;
77         } else {
78             $newcm->completiongradeitemnumber = $moduleinfo->completiongradeitemnumber;
79         }
80         $newcm->completionview            = $moduleinfo->completionview;
81         $newcm->completionexpected        = $moduleinfo->completionexpected;
82     }
83     if(!empty($CFG->enableavailability)) {
84         // This code is used both when submitting the form, which uses a long
85         // name to avoid clashes, and by unit test code which uses the real
86         // name in the table.
87         $newcm->availability = null;
88         if (property_exists($moduleinfo, 'availabilityconditionsjson')) {
89             if ($moduleinfo->availabilityconditionsjson !== '') {
90                 $newcm->availability = $moduleinfo->availabilityconditionsjson;
91             }
92         } else if (property_exists($moduleinfo, 'availability')) {
93             $newcm->availability = $moduleinfo->availability;
94         }
95         // If there is any availability data, verify it.
96         if ($newcm->availability) {
97             $tree = new \core_availability\tree(json_decode($newcm->availability));
98             // Save time and database space by setting null if the only data
99             // is an empty tree.
100             if ($tree->is_empty()) {
101                 $newcm->availability = null;
102             }
103         }
104     }
105     if (isset($moduleinfo->showdescription)) {
106         $newcm->showdescription = $moduleinfo->showdescription;
107     } else {
108         $newcm->showdescription = 0;
109     }
111     // From this point we make database changes, so start transaction.
112     $transaction = $DB->start_delegated_transaction();
114     if (!$moduleinfo->coursemodule = add_course_module($newcm)) {
115         print_error('cannotaddcoursemodule');
116     }
118     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true) &&
119             isset($moduleinfo->introeditor)) {
120         $introeditor = $moduleinfo->introeditor;
121         unset($moduleinfo->introeditor);
122         $moduleinfo->intro       = $introeditor['text'];
123         $moduleinfo->introformat = $introeditor['format'];
124     }
126     $addinstancefunction    = $moduleinfo->modulename."_add_instance";
127     try {
128         $returnfromfunc = $addinstancefunction($moduleinfo, $mform);
129     } catch (moodle_exception $e) {
130         $returnfromfunc = $e;
131     }
132     if (!$returnfromfunc or !is_number($returnfromfunc)) {
133         // Undo everything we can. This is not necessary for databases which
134         // support transactions, but improves consistency for other databases.
135         context_helper::delete_instance(CONTEXT_MODULE, $moduleinfo->coursemodule);
136         $DB->delete_records('course_modules', array('id'=>$moduleinfo->coursemodule));
138         if ($returnfromfunc instanceof moodle_exception) {
139             throw $returnfromfunc;
140         } else if (!is_number($returnfromfunc)) {
141             print_error('invalidfunction', '', course_get_url($course, $moduleinfo->section));
142         } else {
143             print_error('cannotaddnewmodule', '', course_get_url($course, $moduleinfo->section), $moduleinfo->modulename);
144         }
145     }
147     $moduleinfo->instance = $returnfromfunc;
149     $DB->set_field('course_modules', 'instance', $returnfromfunc, array('id'=>$moduleinfo->coursemodule));
151     // Update embedded links and save files.
152     $modcontext = context_module::instance($moduleinfo->coursemodule);
153     if (!empty($introeditor)) {
154         // This will respect a module that has set a value for intro in it's modname_add_instance() function.
155         $introeditor['text'] = $moduleinfo->intro;
157         $moduleinfo->intro = file_save_draft_area_files($introeditor['itemid'], $modcontext->id,
158                                                       'mod_'.$moduleinfo->modulename, 'intro', 0,
159                                                       array('subdirs'=>true), $introeditor['text']);
160         $DB->set_field($moduleinfo->modulename, 'intro', $moduleinfo->intro, array('id'=>$moduleinfo->instance));
161     }
163     // Add module tags.
164     if (core_tag_tag::is_enabled('core', 'course_modules') && isset($moduleinfo->tags)) {
165         core_tag_tag::set_item_tags('core', 'course_modules', $moduleinfo->coursemodule, $modcontext, $moduleinfo->tags);
166     }
168     // Course_modules and course_sections each contain a reference to each other.
169     // So we have to update one of them twice.
170     $sectionid = course_add_cm_to_section($course, $moduleinfo->coursemodule, $moduleinfo->section);
172     // Trigger event based on the action we did.
173     // Api create_from_cm expects modname and id property, and we don't want to modify $moduleinfo since we are returning it.
174     $eventdata = clone $moduleinfo;
175     $eventdata->modname = $eventdata->modulename;
176     $eventdata->id = $eventdata->coursemodule;
177     $event = \core\event\course_module_created::create_from_cm($eventdata, $modcontext);
178     $event->trigger();
180     $moduleinfo = edit_module_post_actions($moduleinfo, $course);
181     $transaction->allow_commit();
183     return $moduleinfo;
186 /**
187  * Hook for plugins to take action when a module is created or updated.
188  *
189  * @param stdClass $moduleinfo the module info
190  * @param stdClass $course the course of the module
191  *
192  * @return stdClass moduleinfo updated by plugins.
193  */
194 function plugin_extend_coursemodule_edit_post_actions($moduleinfo, $course) {
195     $callbacks = get_plugins_with_function('coursemodule_edit_post_actions', 'lib.php');
196     foreach ($callbacks as $type => $plugins) {
197         foreach ($plugins as $plugin => $pluginfunction) {
198             $moduleinfo = $pluginfunction($moduleinfo, $course);
199         }
200     }
201     return $moduleinfo;
204 /**
205  * Common create/update module module actions that need to be processed as soon as a module is created/updaded.
206  * For example:create grade parent category, add outcomes, rebuild caches, regrade, save plagiarism settings...
207  * Please note this api does not trigger events as of MOODLE 2.6. Please trigger events before calling this api.
208  *
209  * @param object $moduleinfo the module info
210  * @param object $course the course of the module
211  *
212  * @return object moduleinfo update with grading management info
213  */
214 function edit_module_post_actions($moduleinfo, $course) {
215     global $CFG;
216     require_once($CFG->libdir.'/gradelib.php');
218     $modcontext = context_module::instance($moduleinfo->coursemodule);
219     $hasgrades = plugin_supports('mod', $moduleinfo->modulename, FEATURE_GRADE_HAS_GRADE, false);
220     $hasoutcomes = plugin_supports('mod', $moduleinfo->modulename, FEATURE_GRADE_OUTCOMES, true);
222     $items = grade_item::fetch_all([
223         'itemtype' => 'mod',
224         'itemmodule' => $moduleinfo->modulename,
225         'iteminstance' => $moduleinfo->instance,
226         'courseid' => $course->id,
227     ]);
229     // Create parent category if requested and move to correct parent category.
230     $component = "mod_{$moduleinfo->modulename}";
231     if ($items) {
232         foreach ($items as $item) {
233             $update = false;
235             // Sync idnumber with grade_item.
236             // Note: This only happens for itemnumber 0 at this time.
237             if ($item->itemnumber == 0 && ($item->idnumber != $moduleinfo->cmidnumber)) {
238                 $item->idnumber = $moduleinfo->cmidnumber;
239                 $update = true;
240             }
242             // Determine the grade category.
243             $gradecatfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $item->itemnumber, 'gradecat');
244             if (property_exists($moduleinfo, $gradecatfieldname)) {
245                 $gradecat = $moduleinfo->$gradecatfieldname;
246                 if ($gradecat == -1) {
247                     $gradecategory = new grade_category();
248                     $gradecategory->courseid = $course->id;
249                     $gradecategory->fullname = $moduleinfo->name;
250                     $gradecategory->insert();
252                     $parent = $item->get_parent_category();
253                     $gradecategory->set_parent($parent->id);
254                     $gradecat = $gradecategory->id;
255                 }
257                 $oldgradecat = null;
258                 if ($parent = $item->get_parent_category()) {
259                     $oldgradecat = $parent->id;
260                 }
261                 if ($oldgradecat != $gradecat) {
262                     $item->set_parent($gradecat);
263                     $update = true;
264                 }
265             }
267             // Determine the gradepass.
268             $gradepassfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $item->itemnumber, 'gradepass');
269             if (isset($moduleinfo->{$gradepassfieldname})) {
270                 $gradepass = $moduleinfo->{$gradepassfieldname};
271                 if (null !== $gradepass && $gradepass != $item->gradepass) {
272                     $item->gradepass = $gradepass;
273                     $update = true;
274                 }
275             }
277             if ($update) {
278                 $item->update();
279             }
280         }
281     }
283     require_once($CFG->libdir.'/grade/grade_outcome.php');
284     // Add outcomes if requested.
285     if ($hasoutcomes && $outcomes = grade_outcome::fetch_all_available($course->id)) {
286         // Outcome grade_item.itemnumber start at 1000, there is nothing above outcomes.
287         $max_itemnumber = 999;
288         if ($items) {
289             foreach($items as $item) {
290                 if ($item->itemnumber > $max_itemnumber) {
291                     $max_itemnumber = $item->itemnumber;
292                 }
293             }
294         }
296         foreach($outcomes as $outcome) {
297             $elname = 'outcome_'.$outcome->id;
299             if (property_exists($moduleinfo, $elname) and $moduleinfo->$elname) {
300                 // Check if this is a new outcome grade item.
301                 if ($items) {
302                     $outcomeexists = false;
303                     foreach($items as $item) {
304                         if ($item->outcomeid == $outcome->id) {
305                             $outcomeexists = true;
306                             break;
307                         }
308                     }
309                     if ($outcomeexists) {
310                         continue;
311                     }
312                 }
314                 $max_itemnumber++;
316                 $outcomeitem = new grade_item();
317                 $outcomeitem->courseid     = $course->id;
318                 $outcomeitem->itemtype     = 'mod';
319                 $outcomeitem->itemmodule   = $moduleinfo->modulename;
320                 $outcomeitem->iteminstance = $moduleinfo->instance;
321                 $outcomeitem->itemnumber   = $max_itemnumber;
322                 $outcomeitem->itemname     = $outcome->fullname;
323                 $outcomeitem->outcomeid    = $outcome->id;
324                 $outcomeitem->gradetype    = GRADE_TYPE_SCALE;
325                 $outcomeitem->scaleid      = $outcome->scaleid;
326                 $outcomeitem->insert();
328                 if ($items) {
329                     // Move the new outcome into the same category and immediately after the first grade item.
330                     $item = reset($items);
331                     $outcomeitem->set_parent($item->categoryid);
332                     $outcomeitem->move_after_sortorder($item->sortorder);
333                 } else if (isset($moduleinfo->gradecat)) {
334                     $outcomeitem->set_parent($moduleinfo->gradecat);
335                 }
336             }
337         }
338     }
340     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_ADVANCED_GRADING, false)
341             and has_capability('moodle/grade:managegradingforms', $modcontext)) {
342         require_once($CFG->dirroot.'/grade/grading/lib.php');
343         $gradingman = get_grading_manager($modcontext, 'mod_'.$moduleinfo->modulename);
344         $showgradingmanagement = false;
345         foreach ($gradingman->get_available_areas() as $areaname => $aretitle) {
346             $formfield = 'advancedgradingmethod_'.$areaname;
347             if (isset($moduleinfo->{$formfield})) {
348                 $gradingman->set_area($areaname);
349                 $methodchanged = $gradingman->set_active_method($moduleinfo->{$formfield});
350                 if (empty($moduleinfo->{$formfield})) {
351                     // Going back to the simple direct grading is not a reason to open the management screen.
352                     $methodchanged = false;
353                 }
354                 $showgradingmanagement = $showgradingmanagement || $methodchanged;
355             }
356         }
357         // Update grading management information.
358         $moduleinfo->gradingman = $gradingman;
359         $moduleinfo->showgradingmanagement = $showgradingmanagement;
360     }
362     rebuild_course_cache($course->id, true);
363     if ($hasgrades) {
364         grade_regrade_final_grades($course->id);
365     }
366     require_once($CFG->libdir.'/plagiarismlib.php');
367     plagiarism_save_form_elements($moduleinfo);
369     // Allow plugins to extend the course module form.
370     $moduleinfo = plugin_extend_coursemodule_edit_post_actions($moduleinfo, $course);
372     return $moduleinfo;
375 /**
376  * Set module info default values for the unset module attributs.
377  *
378  * @param object $moduleinfo the current known data of the module
379  * @return object the completed module info
380  */
381 function set_moduleinfo_defaults($moduleinfo) {
383     if (empty($moduleinfo->coursemodule)) {
384         // Add.
385         $cm = null;
386         $moduleinfo->instance     = '';
387         $moduleinfo->coursemodule = '';
388     } else {
389         // Update.
390         $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
391         $moduleinfo->instance     = $cm->instance;
392         $moduleinfo->coursemodule = $cm->id;
393     }
394     // For safety.
395     $moduleinfo->modulename = clean_param($moduleinfo->modulename, PARAM_PLUGIN);
397     if (!isset($moduleinfo->groupingid)) {
398         $moduleinfo->groupingid = 0;
399     }
401     if (!isset($moduleinfo->name)) { // Label.
402         $moduleinfo->name = $moduleinfo->modulename;
403     }
405     if (!isset($moduleinfo->completion)) {
406         $moduleinfo->completion = COMPLETION_DISABLED;
407     }
408     if (!isset($moduleinfo->completionview)) {
409         $moduleinfo->completionview = COMPLETION_VIEW_NOT_REQUIRED;
410     }
411     if (!isset($moduleinfo->completionexpected)) {
412         $moduleinfo->completionexpected = 0;
413     }
415     // Convert the 'use grade' checkbox into a grade-item number: 0 if checked, null if not.
416     if (isset($moduleinfo->completionusegrade) && $moduleinfo->completionusegrade) {
417         $moduleinfo->completiongradeitemnumber = 0;
418     } else if (!isset($moduleinfo->completiongradeitemnumber)) {
419         $moduleinfo->completiongradeitemnumber = null;
420     }
422     if (!isset($moduleinfo->conditiongradegroup)) {
423         $moduleinfo->conditiongradegroup = array();
424     }
425     if (!isset($moduleinfo->conditionfieldgroup)) {
426         $moduleinfo->conditionfieldgroup = array();
427     }
428     if (!isset($moduleinfo->visibleoncoursepage)) {
429         $moduleinfo->visibleoncoursepage = 1;
430     }
432     return $moduleinfo;
435 /**
436  * Check that the user can add a module. Also returns some information like the module, context and course section info.
437  * The fucntion create the course section if it doesn't exist.
438  *
439  * @param object $course the course of the module
440  * @param object $modulename the module name
441  * @param object $section the section of the module
442  * @return array list containing module, context, course section.
443  * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
444  */
445 function can_add_moduleinfo($course, $modulename, $section) {
446     global $DB;
448     $module = $DB->get_record('modules', array('name'=>$modulename), '*', MUST_EXIST);
450     $context = context_course::instance($course->id);
451     require_capability('moodle/course:manageactivities', $context);
453     course_create_sections_if_missing($course, $section);
454     $cw = get_fast_modinfo($course)->get_section_info($section);
456     if (!course_allowed_module($course, $module->name)) {
457         print_error('moduledisable');
458     }
460     return array($module, $context, $cw);
463 /**
464  * Check if user is allowed to update module info and returns related item/data to the module.
465  *
466  * @param object $cm course module
467  * @return array - list of course module, context, module, moduleinfo, and course section.
468  * @throws moodle_exception if user is not allowed to perform the action
469  */
470 function can_update_moduleinfo($cm) {
471     global $DB;
473     // Check the $USER has the right capability.
474     $context = context_module::instance($cm->id);
475     require_capability('moodle/course:manageactivities', $context);
477     // Check module exists.
478     $module = $DB->get_record('modules', array('id'=>$cm->module), '*', MUST_EXIST);
480     // Check the moduleinfo exists.
481     $data = $DB->get_record($module->name, array('id'=>$cm->instance), '*', MUST_EXIST);
483     // Check the course section exists.
484     $cw = $DB->get_record('course_sections', array('id'=>$cm->section), '*', MUST_EXIST);
486     return array($cm, $context, $module, $data, $cw);
490 /**
491  * Update the module info.
492  * This function doesn't check the user capabilities. It updates the course module and the module instance.
493  * Then execute common action to create/update module process (trigger event, rebuild cache, save plagiarism settings...).
494  *
495  * @param object $cm course module
496  * @param object $moduleinfo module info
497  * @param object $course course of the module
498  * @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.
499  * @return array list of course module and module info.
500  */
501 function update_moduleinfo($cm, $moduleinfo, $course, $mform = null) {
502     global $DB, $CFG;
504     $data = new stdClass();
505     if ($mform) {
506         $data = $mform->get_data();
507     }
509     // Attempt to include module library before we make any changes to DB.
510     include_modulelib($moduleinfo->modulename);
512     $moduleinfo->course = $course->id;
513     $moduleinfo = set_moduleinfo_defaults($moduleinfo);
515     if (!empty($course->groupmodeforce) or !isset($moduleinfo->groupmode)) {
516         $moduleinfo->groupmode = $cm->groupmode; // Keep original.
517     }
519     // Update course module first.
520     $cm->groupmode = $moduleinfo->groupmode;
521     if (isset($moduleinfo->groupingid)) {
522         $cm->groupingid = $moduleinfo->groupingid;
523     }
525     $completion = new completion_info($course);
526     if ($completion->is_enabled()) {
527         // Completion settings that would affect users who have already completed
528         // the activity may be locked; if so, these should not be updated.
529         if (!empty($moduleinfo->completionunlocked)) {
530             $cm->completion = $moduleinfo->completion;
531             if ($moduleinfo->completiongradeitemnumber === '') {
532                 $cm->completiongradeitemnumber = null;
533             } else {
534                 $cm->completiongradeitemnumber = $moduleinfo->completiongradeitemnumber;
535             }
536             $cm->completionview = $moduleinfo->completionview;
537         }
538         // The expected date does not affect users who have completed the activity,
539         // so it is safe to update it regardless of the lock status.
540         $cm->completionexpected = $moduleinfo->completionexpected;
541     }
542     if (!empty($CFG->enableavailability)) {
543         // This code is used both when submitting the form, which uses a long
544         // name to avoid clashes, and by unit test code which uses the real
545         // name in the table.
546         if (property_exists($moduleinfo, 'availabilityconditionsjson')) {
547             if ($moduleinfo->availabilityconditionsjson !== '') {
548                 $cm->availability = $moduleinfo->availabilityconditionsjson;
549             } else {
550                 $cm->availability = null;
551             }
552         } else if (property_exists($moduleinfo, 'availability')) {
553             $cm->availability = $moduleinfo->availability;
554         }
555         // If there is any availability data, verify it.
556         if ($cm->availability) {
557             $tree = new \core_availability\tree(json_decode($cm->availability));
558             // Save time and database space by setting null if the only data
559             // is an empty tree.
560             if ($tree->is_empty()) {
561                 $cm->availability = null;
562             }
563         }
564     }
565     if (isset($moduleinfo->showdescription)) {
566         $cm->showdescription = $moduleinfo->showdescription;
567     } else {
568         $cm->showdescription = 0;
569     }
571     $DB->update_record('course_modules', $cm);
573     $modcontext = context_module::instance($moduleinfo->coursemodule);
575     // Update embedded links and save files.
576     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
577         $moduleinfo->intro = file_save_draft_area_files($moduleinfo->introeditor['itemid'], $modcontext->id,
578                                                       'mod_'.$moduleinfo->modulename, 'intro', 0,
579                                                       array('subdirs'=>true), $moduleinfo->introeditor['text']);
580         $moduleinfo->introformat = $moduleinfo->introeditor['format'];
581         unset($moduleinfo->introeditor);
582     }
583     // Get the a copy of the grade_item before it is modified incase we need to scale the grades.
584     $oldgradeitem = null;
585     $newgradeitem = null;
586     if (!empty($data->grade_rescalegrades) && $data->grade_rescalegrades == 'yes') {
587         // Fetch the grade item before it is updated.
588         $oldgradeitem = grade_item::fetch(array('itemtype' => 'mod',
589                                                 'itemmodule' => $moduleinfo->modulename,
590                                                 'iteminstance' => $moduleinfo->instance,
591                                                 'itemnumber' => 0,
592                                                 'courseid' => $moduleinfo->course));
593     }
595     $updateinstancefunction = $moduleinfo->modulename."_update_instance";
596     if (!$updateinstancefunction($moduleinfo, $mform)) {
597         print_error('cannotupdatemod', '', course_get_url($course, $cm->section), $moduleinfo->modulename);
598     }
600     // This needs to happen AFTER the grademin/grademax have already been updated.
601     if (!empty($data->grade_rescalegrades) && $data->grade_rescalegrades == 'yes') {
602         // Get the grade_item after the update call the activity to scale the grades.
603         $newgradeitem = grade_item::fetch(array('itemtype' => 'mod',
604                                                 'itemmodule' => $moduleinfo->modulename,
605                                                 'iteminstance' => $moduleinfo->instance,
606                                                 'itemnumber' => 0,
607                                                 'courseid' => $moduleinfo->course));
608         if ($newgradeitem && $oldgradeitem->gradetype == GRADE_TYPE_VALUE && $newgradeitem->gradetype == GRADE_TYPE_VALUE) {
609             $params = array(
610                 $course,
611                 $cm,
612                 $oldgradeitem->grademin,
613                 $oldgradeitem->grademax,
614                 $newgradeitem->grademin,
615                 $newgradeitem->grademax
616             );
617             if (!component_callback('mod_' . $moduleinfo->modulename, 'rescale_activity_grades', $params)) {
618                 print_error('cannotreprocessgrades', '', course_get_url($course, $cm->section), $moduleinfo->modulename);
619             }
620         }
621     }
623     // Make sure visibility is set correctly (in particular in calendar).
624     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
625         set_coursemodule_visible($moduleinfo->coursemodule, $moduleinfo->visible, $moduleinfo->visibleoncoursepage);
626     }
628     if (isset($moduleinfo->cmidnumber)) { // Label.
629         // Set cm idnumber - uniqueness is already verified by form validation.
630         set_coursemodule_idnumber($moduleinfo->coursemodule, $moduleinfo->cmidnumber);
631     }
633     // Update module tags.
634     if (core_tag_tag::is_enabled('core', 'course_modules') && isset($moduleinfo->tags)) {
635         core_tag_tag::set_item_tags('core', 'course_modules', $moduleinfo->coursemodule, $modcontext, $moduleinfo->tags);
636     }
638     // Now that module is fully updated, also update completion data if required.
639     // (this will wipe all user completion data and recalculate it)
640     if ($completion->is_enabled() && !empty($moduleinfo->completionunlocked)) {
641         $completion->reset_all_state($cm);
642     }
643     $cm->name = $moduleinfo->name;
644     \core\event\course_module_updated::create_from_cm($cm, $modcontext)->trigger();
646     $moduleinfo = edit_module_post_actions($moduleinfo, $course);
648     return array($cm, $moduleinfo);
651 /**
652  * Include once the module lib file.
653  *
654  * @param string $modulename module name of the lib to include
655  * @throws moodle_exception if lib.php file for the module does not exist
656  */
657 function include_modulelib($modulename) {
658     global $CFG;
659     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
660     if (file_exists($modlib)) {
661         include_once($modlib);
662     } else {
663         throw new moodle_exception('modulemissingcode', '', '', $modlib);
664     }
667 /**
668  * Get module information data required for updating the module.
669  *
670  * @param  stdClass $cm     course module object
671  * @param  stdClass $course course object
672  * @return array required data for updating a module
673  * @since  Moodle 3.2
674  */
675 function get_moduleinfo_data($cm, $course) {
676     global $CFG;
678     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
680     $data->coursemodule       = $cm->id;
681     $data->section            = $cw->section;  // The section number itself - relative!!! (section column in course_sections)
682     $data->visible            = $cm->visible; //??  $cw->visible ? $cm->visible : 0; // section hiding overrides
683     $data->visibleoncoursepage = $cm->visibleoncoursepage;
684     $data->cmidnumber         = $cm->idnumber;          // The cm IDnumber
685     $data->groupmode          = groups_get_activity_groupmode($cm); // locked later if forced
686     $data->groupingid         = $cm->groupingid;
687     $data->course             = $course->id;
688     $data->module             = $module->id;
689     $data->modulename         = $module->name;
690     $data->instance           = $cm->instance;
691     $data->completion         = $cm->completion;
692     $data->completionview     = $cm->completionview;
693     $data->completionexpected = $cm->completionexpected;
694     $data->completionusegrade = is_null($cm->completiongradeitemnumber) ? 0 : 1;
695     $data->completiongradeitemnumber = $cm->completiongradeitemnumber;
696     $data->showdescription    = $cm->showdescription;
697     $data->tags               = core_tag_tag::get_item_tags_array('core', 'course_modules', $cm->id);
698     if (!empty($CFG->enableavailability)) {
699         $data->availabilityconditionsjson = $cm->availability;
700     }
702     if (plugin_supports('mod', $data->modulename, FEATURE_MOD_INTRO, true)) {
703         $draftid_editor = file_get_submitted_draft_itemid('introeditor');
704         $currentintro = file_prepare_draft_area($draftid_editor, $context->id, 'mod_'.$data->modulename, 'intro', 0, array('subdirs'=>true), $data->intro);
705         $data->introeditor = array('text'=>$currentintro, 'format'=>$data->introformat, 'itemid'=>$draftid_editor);
706     }
708     if (plugin_supports('mod', $data->modulename, FEATURE_ADVANCED_GRADING, false)
709             and has_capability('moodle/grade:managegradingforms', $context)) {
710         require_once($CFG->dirroot.'/grade/grading/lib.php');
711         $gradingman = get_grading_manager($context, 'mod_'.$data->modulename);
712         $data->_advancedgradingdata['methods'] = $gradingman->get_available_methods();
713         $areas = $gradingman->get_available_areas();
715         foreach ($areas as $areaname => $areatitle) {
716             $gradingman->set_area($areaname);
717             $method = $gradingman->get_active_method();
718             $data->_advancedgradingdata['areas'][$areaname] = array(
719                 'title'  => $areatitle,
720                 'method' => $method,
721             );
722             $formfield = 'advancedgradingmethod_'.$areaname;
723             $data->{$formfield} = $method;
724         }
725     }
727     $component = "mod_{$data->modulename}";
728     $items = grade_item::fetch_all([
729         'itemtype' => 'mod',
730         'itemmodule' => $data->modulename,
731         'iteminstance' => $data->instance,
732         'courseid' => $course->id,
733     ]);
735     if ($items) {
736         // Add existing outcomes.
737         foreach ($items as $item) {
738             if (!empty($item->outcomeid)) {
739                 $data->{'outcome_' . $item->outcomeid} = 1;
740             } else if (isset($item->gradepass)) {
741                 $gradepassfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $item->itemnumber, 'gradepass');
742                 $data->{$gradepassfieldname} = format_float($item->gradepass, $item->get_decimals());
743             }
745         }
747         // set category if present
748         $gradecat = [];
749         foreach ($items as $item) {
750             if (!isset($gradecat[$item->itemnumber])) {
751                 $gradecat[$item->itemnumber] = $item->categoryid;
752             }
753             if ($gradecat[$item->itemnumber] != $item->categoryid) {
754                 // Mixed categories.
755                 $gradecat[$item->itemnumber] = false;
756             }
757         }
758         foreach ($gradecat as $itemnumber => $cat) {
759             if ($cat !== false) {
760                 $gradecatfieldname = component_gradeitems::get_field_name_for_itemnumber($component, $itemnumber, 'gradecat');
761                 // Do not set if mixed categories present.
762                 $data->{$gradecatfieldname} = $cat;
763             }
764         }
765     }
766     return array($cm, $context, $module, $data, $cw);
769 /**
770  * Prepare the standard module information for a new module instance.
771  *
772  * @param  stdClass $course  course object
773  * @param  string $modulename  module name
774  * @param  int $section section number
775  * @return array module information about other required data
776  * @since  Moodle 3.2
777  */
778 function prepare_new_moduleinfo_data($course, $modulename, $section) {
779     global $CFG;
781     list($module, $context, $cw) = can_add_moduleinfo($course, $modulename, $section);
783     $cm = null;
785     $data = new stdClass();
786     $data->section          = $section;  // The section number itself - relative!!! (section column in course_sections)
787     $data->visible          = $cw->visible;
788     $data->course           = $course->id;
789     $data->module           = $module->id;
790     $data->modulename       = $module->name;
791     $data->groupmode        = $course->groupmode;
792     $data->groupingid       = $course->defaultgroupingid;
793     $data->id               = '';
794     $data->instance         = '';
795     $data->coursemodule     = '';
797     // Apply completion defaults.
798     $defaults = \core_completion\manager::get_default_completion($course, $module);
799     foreach ($defaults as $key => $value) {
800         $data->$key = $value;
801     }
803     if (plugin_supports('mod', $data->modulename, FEATURE_MOD_INTRO, true)) {
804         $draftid_editor = file_get_submitted_draft_itemid('introeditor');
805         file_prepare_draft_area($draftid_editor, null, null, null, null, array('subdirs'=>true));
806         $data->introeditor = array('text'=>'', 'format'=>FORMAT_HTML, 'itemid'=>$draftid_editor); // TODO: add better default
807     }
809     if (plugin_supports('mod', $data->modulename, FEATURE_ADVANCED_GRADING, false)
810             and has_capability('moodle/grade:managegradingforms', $context)) {
811         require_once($CFG->dirroot.'/grade/grading/lib.php');
813         $data->_advancedgradingdata['methods'] = grading_manager::available_methods();
814         $areas = grading_manager::available_areas('mod_'.$module->name);
816         foreach ($areas as $areaname => $areatitle) {
817             $data->_advancedgradingdata['areas'][$areaname] = array(
818                 'title'  => $areatitle,
819                 'method' => '',
820             );
821             $formfield = 'advancedgradingmethod_'.$areaname;
822             $data->{$formfield} = '';
823         }
824     }
826     return array($module, $context, $cw, $cm, $data);