f06364980c4bd265b938bbf150da353c8135b4f7
[moodle.git] / course / lib.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 useful functions
19  *
20  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
21  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  * @package core_course
23  */
25 defined('MOODLE_INTERNAL') || die;
27 require_once($CFG->libdir.'/completionlib.php');
28 require_once($CFG->libdir.'/filelib.php');
29 require_once($CFG->dirroot.'/course/format/lib.php');
31 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // Records.
32 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds.
34 /**
35  * Number of courses to display when summaries are included.
36  * @var int
37  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
38  */
39 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
41 // Max courses in log dropdown before switching to optional.
42 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
43 // Max users in log dropdown before switching to optional.
44 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
45 define('FRONTPAGENEWS', '0');
46 define('FRONTPAGECATEGORYNAMES', '2');
47 define('FRONTPAGECATEGORYCOMBO', '4');
48 define('FRONTPAGEENROLLEDCOURSELIST', '5');
49 define('FRONTPAGEALLCOURSELIST', '6');
50 define('FRONTPAGECOURSESEARCH', '7');
51 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 define('COURSE_TIMELINE_ALL', 'all');
59 define('COURSE_TIMELINE_PAST', 'past');
60 define('COURSE_TIMELINE_INPROGRESS', 'inprogress');
61 define('COURSE_TIMELINE_FUTURE', 'future');
62 define('COURSE_FAVOURITES', 'favourites');
63 define('COURSE_DB_QUERY_LIMIT', 1000);
65 function make_log_url($module, $url) {
66     switch ($module) {
67         case 'course':
68             if (strpos($url, 'report/') === 0) {
69                 // there is only one report type, course reports are deprecated
70                 $url = "/$url";
71                 break;
72             }
73         case 'file':
74         case 'login':
75         case 'lib':
76         case 'admin':
77         case 'category':
78         case 'mnet course':
79             if (strpos($url, '../') === 0) {
80                 $url = ltrim($url, '.');
81             } else {
82                 $url = "/course/$url";
83             }
84             break;
85         case 'calendar':
86             $url = "/calendar/$url";
87             break;
88         case 'user':
89         case 'blog':
90             $url = "/$module/$url";
91             break;
92         case 'upload':
93             $url = $url;
94             break;
95         case 'coursetags':
96             $url = '/'.$url;
97             break;
98         case 'library':
99         case '':
100             $url = '/';
101             break;
102         case 'message':
103             $url = "/message/$url";
104             break;
105         case 'notes':
106             $url = "/notes/$url";
107             break;
108         case 'tag':
109             $url = "/tag/$url";
110             break;
111         case 'role':
112             $url = '/'.$url;
113             break;
114         case 'grade':
115             $url = "/grade/$url";
116             break;
117         default:
118             $url = "/mod/$module/$url";
119             break;
120     }
122     //now let's sanitise urls - there might be some ugly nasties:-(
123     $parts = explode('?', $url);
124     $script = array_shift($parts);
125     if (strpos($script, 'http') === 0) {
126         $script = clean_param($script, PARAM_URL);
127     } else {
128         $script = clean_param($script, PARAM_PATH);
129     }
131     $query = '';
132     if ($parts) {
133         $query = implode('', $parts);
134         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
135         $parts = explode('&', $query);
136         $eq = urlencode('=');
137         foreach ($parts as $key=>$part) {
138             $part = urlencode(urldecode($part));
139             $part = str_replace($eq, '=', $part);
140             $parts[$key] = $part;
141         }
142         $query = '?'.implode('&amp;', $parts);
143     }
145     return $script.$query;
149 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
150                    $modname="", $modid=0, $modaction="", $groupid=0) {
151     global $CFG, $DB;
153     // It is assumed that $date is the GMT time of midnight for that day,
154     // and so the next 86400 seconds worth of logs are printed.
156     /// Setup for group handling.
158     // TODO: I don't understand group/context/etc. enough to be able to do
159     // something interesting with it here
160     // What is the context of a remote course?
162     /// If the group mode is separate, and this user does not have editing privileges,
163     /// then only the user's group can be viewed.
164     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
165     //    $groupid = get_current_group($course->id);
166     //}
167     /// If this course doesn't have groups, no groupid can be specified.
168     //else if (!$course->groupmode) {
169     //    $groupid = 0;
170     //}
172     $groupid = 0;
174     $joins = array();
175     $where = '';
177     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
178               FROM {mnet_log} l
179                LEFT JOIN {user} u ON l.userid = u.id
180               WHERE ";
181     $params = array();
183     $where .= "l.hostid = :hostid";
184     $params['hostid'] = $hostid;
186     // TODO: Is 1 really a magic number referring to the sitename?
187     if ($course != SITEID || $modid != 0) {
188         $where .= " AND l.course=:courseid";
189         $params['courseid'] = $course;
190     }
192     if ($modname) {
193         $where .= " AND l.module = :modname";
194         $params['modname'] = $modname;
195     }
197     if ('site_errors' === $modid) {
198         $where .= " AND ( l.action='error' OR l.action='infected' )";
199     } else if ($modid) {
200         //TODO: This assumes that modids are the same across sites... probably
201         //not true
202         $where .= " AND l.cmid = :modid";
203         $params['modid'] = $modid;
204     }
206     if ($modaction) {
207         $firstletter = substr($modaction, 0, 1);
208         if ($firstletter == '-') {
209             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
210             $params['modaction'] = '%'.substr($modaction, 1).'%';
211         } else {
212             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
213             $params['modaction'] = '%'.$modaction.'%';
214         }
215     }
217     if ($user) {
218         $where .= " AND l.userid = :user";
219         $params['user'] = $user;
220     }
222     if ($date) {
223         $enddate = $date + 86400;
224         $where .= " AND l.time > :date AND l.time < :enddate";
225         $params['date'] = $date;
226         $params['enddate'] = $enddate;
227     }
229     $result = array();
230     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
231     if(!empty($result['totalcount'])) {
232         $where .= " ORDER BY $order";
233         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
234     } else {
235         $result['logs'] = array();
236     }
237     return $result;
240 /**
241  * Checks the integrity of the course data.
242  *
243  * In summary - compares course_sections.sequence and course_modules.section.
244  *
245  * More detailed, checks that:
246  * - course_sections.sequence contains each module id not more than once in the course
247  * - for each moduleid from course_sections.sequence the field course_modules.section
248  *   refers to the same section id (this means course_sections.sequence is more
249  *   important if they are different)
250  * - ($fullcheck only) each module in the course is present in one of
251  *   course_sections.sequence
252  * - ($fullcheck only) removes non-existing course modules from section sequences
253  *
254  * If there are any mismatches, the changes are made and records are updated in DB.
255  *
256  * Course cache is NOT rebuilt if there are any errors!
257  *
258  * This function is used each time when course cache is being rebuilt with $fullcheck = false
259  * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
260  *
261  * @param int $courseid id of the course
262  * @param array $rawmods result of funciton {@link get_course_mods()} - containst
263  *     the list of enabled course modules in the course. Retrieved from DB if not specified.
264  *     Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
265  * @param array $sections records from course_sections table for this course.
266  *     Retrieved from DB if not specified
267  * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
268  *     course modules from sequences. Only to be used in site maintenance mode when we are
269  *     sure that another user is not in the middle of the process of moving/removing a module.
270  * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
271  * @return array array of messages with found problems. Empty output means everything is ok
272  */
273 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
274     global $DB;
275     $messages = array();
276     if ($sections === null) {
277         $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
278     }
279     if ($fullcheck) {
280         // Retrieve all records from course_modules regardless of module type visibility.
281         $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
282     }
283     if ($rawmods === null) {
284         $rawmods = get_course_mods($courseid);
285     }
286     if (!$fullcheck && (empty($sections) || empty($rawmods))) {
287         // If either of the arrays is empty, no modules are displayed anyway.
288         return true;
289     }
290     $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
292     // First make sure that each module id appears in section sequences only once.
293     // If it appears in several section sequences the last section wins.
294     // If it appears twice in one section sequence, the first occurence wins.
295     $modsection = array();
296     foreach ($sections as $sectionid => $section) {
297         $sections[$sectionid]->newsequence = $section->sequence;
298         if (!empty($section->sequence)) {
299             $sequence = explode(",", $section->sequence);
300             $sequenceunique = array_unique($sequence);
301             if (count($sequenceunique) != count($sequence)) {
302                 // Some course module id appears in this section sequence more than once.
303                 ksort($sequenceunique); // Preserve initial order of modules.
304                 $sequence = array_values($sequenceunique);
305                 $sections[$sectionid]->newsequence = join(',', $sequence);
306                 $messages[] = $debuggingprefix.'Sequence for course section ['.
307                         $sectionid.'] is "'.$sections[$sectionid]->sequence.'", must be "'.$sections[$sectionid]->newsequence.'"';
308             }
309             foreach ($sequence as $cmid) {
310                 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
311                     // Some course module id appears to be in more than one section's sequences.
312                     $wrongsectionid = $modsection[$cmid];
313                     $sections[$wrongsectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence. ','), ',');
314                     $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
315                             $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
316                 }
317                 $modsection[$cmid] = $sectionid;
318             }
319         }
320     }
322     // Add orphaned modules to their sections if they exist or to section 0 otherwise.
323     if ($fullcheck) {
324         foreach ($rawmods as $cmid => $mod) {
325             if (!isset($modsection[$cmid])) {
326                 // This is a module that is not mentioned in course_section.sequence at all.
327                 // Add it to the section $mod->section or to the last available section.
328                 if ($mod->section && isset($sections[$mod->section])) {
329                     $modsection[$cmid] = $mod->section;
330                 } else {
331                     $firstsection = reset($sections);
332                     $modsection[$cmid] = $firstsection->id;
333                 }
334                 $sections[$modsection[$cmid]]->newsequence = trim($sections[$modsection[$cmid]]->newsequence.','.$cmid, ',');
335                 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
336                         $modsection[$cmid].']';
337             }
338         }
339         foreach ($modsection as $cmid => $sectionid) {
340             if (!isset($rawmods[$cmid])) {
341                 // Section $sectionid refers to module id that does not exist.
342                 $sections[$sectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence.','), ',');
343                 $messages[] = $debuggingprefix.'Course module ['.$cmid.
344                         '] does not exist but is present in the sequence of section ['.$sectionid.']';
345             }
346         }
347     }
349     // Update changed sections.
350     if (!$checkonly && !empty($messages)) {
351         foreach ($sections as $sectionid => $section) {
352             if ($section->newsequence !== $section->sequence) {
353                 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence));
354             }
355         }
356     }
358     // Now make sure that all modules point to the correct sections.
359     foreach ($rawmods as $cmid => $mod) {
360         if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section) {
361             if (!$checkonly) {
362                 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
363             }
364             $messages[] = $debuggingprefix.'Course module ['.$cmid.
365                     '] points to section ['.$mod->section.'] instead of ['.$modsection[$cmid].']';
366         }
367     }
369     return $messages;
372 /**
373  * For a given course, returns an array of course activity objects
374  * Each item in the array contains he following properties:
375  */
376 function get_array_of_activities($courseid) {
377 //  cm - course module id
378 //  mod - name of the module (eg forum)
379 //  section - the number of the section (eg week or topic)
380 //  name - the name of the instance
381 //  visible - is the instance visible or not
382 //  groupingid - grouping id
383 //  extra - contains extra string to include in any link
384     global $CFG, $DB;
386     $course = $DB->get_record('course', array('id'=>$courseid));
388     if (empty($course)) {
389         throw new moodle_exception('courseidnotfound');
390     }
392     $mod = array();
394     $rawmods = get_course_mods($courseid);
395     if (empty($rawmods)) {
396         return $mod; // always return array
397     }
398     $courseformat = course_get_format($course);
400     if ($sections = $DB->get_records('course_sections', array('course' => $courseid),
401             'section ASC', 'id,section,sequence,visible')) {
402         // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
403         if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
404             debugging(join('<br>', $errormessages));
405             $rawmods = get_course_mods($courseid);
406             $sections = $DB->get_records('course_sections', array('course' => $courseid),
407                 'section ASC', 'id,section,sequence,visible');
408         }
409         // Build array of activities.
410        foreach ($sections as $section) {
411            if (!empty($section->sequence)) {
412                $sequence = explode(",", $section->sequence);
413                foreach ($sequence as $seq) {
414                    if (empty($rawmods[$seq])) {
415                        continue;
416                    }
417                    // Adjust visibleoncoursepage, value in DB may not respect format availability.
418                    $rawmods[$seq]->visibleoncoursepage = (!$rawmods[$seq]->visible
419                            || $rawmods[$seq]->visibleoncoursepage
420                            || empty($CFG->allowstealth)
421                            || !$courseformat->allow_stealth_module_visibility($rawmods[$seq], $section)) ? 1 : 0;
423                    // Create an object that will be cached.
424                    $mod[$seq] = new stdClass();
425                    $mod[$seq]->id               = $rawmods[$seq]->instance;
426                    $mod[$seq]->cm               = $rawmods[$seq]->id;
427                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
429                     // Oh dear. Inconsistent names left here for backward compatibility.
430                    $mod[$seq]->section          = $section->section;
431                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
433                    $mod[$seq]->module           = $rawmods[$seq]->module;
434                    $mod[$seq]->added            = $rawmods[$seq]->added;
435                    $mod[$seq]->score            = $rawmods[$seq]->score;
436                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
437                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
438                    $mod[$seq]->visibleoncoursepage = $rawmods[$seq]->visibleoncoursepage;
439                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
440                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
441                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
442                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
443                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
444                    $mod[$seq]->extra            = "";
445                    $mod[$seq]->completiongradeitemnumber =
446                            $rawmods[$seq]->completiongradeitemnumber;
447                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
448                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
449                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
450                    $mod[$seq]->availability = $rawmods[$seq]->availability;
451                    $mod[$seq]->deletioninprogress = $rawmods[$seq]->deletioninprogress;
453                    $modname = $mod[$seq]->mod;
454                    $functionname = $modname."_get_coursemodule_info";
456                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
457                        continue;
458                    }
460                    include_once("$CFG->dirroot/mod/$modname/lib.php");
462                    if ($hasfunction = function_exists($functionname)) {
463                        if ($info = $functionname($rawmods[$seq])) {
464                            if (!empty($info->icon)) {
465                                $mod[$seq]->icon = $info->icon;
466                            }
467                            if (!empty($info->iconcomponent)) {
468                                $mod[$seq]->iconcomponent = $info->iconcomponent;
469                            }
470                            if (!empty($info->name)) {
471                                $mod[$seq]->name = $info->name;
472                            }
473                            if ($info instanceof cached_cm_info) {
474                                // When using cached_cm_info you can include three new fields
475                                // that aren't available for legacy code
476                                if (!empty($info->content)) {
477                                    $mod[$seq]->content = $info->content;
478                                }
479                                if (!empty($info->extraclasses)) {
480                                    $mod[$seq]->extraclasses = $info->extraclasses;
481                                }
482                                if (!empty($info->iconurl)) {
483                                    // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
484                                    $url = new moodle_url($info->iconurl);
485                                    $mod[$seq]->iconurl = $url->out(false);
486                                }
487                                if (!empty($info->onclick)) {
488                                    $mod[$seq]->onclick = $info->onclick;
489                                }
490                                if (!empty($info->customdata)) {
491                                    $mod[$seq]->customdata = $info->customdata;
492                                }
493                            } else {
494                                // When using a stdclass, the (horrible) deprecated ->extra field
495                                // is available for BC
496                                if (!empty($info->extra)) {
497                                    $mod[$seq]->extra = $info->extra;
498                                }
499                            }
500                        }
501                    }
502                    // When there is no modname_get_coursemodule_info function,
503                    // but showdescriptions is enabled, then we use the 'intro'
504                    // and 'introformat' fields in the module table
505                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
506                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
507                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
508                            // Set content from intro and introformat. Filters are disabled
509                            // because we  filter it with format_text at display time
510                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
511                                    $modvalues, $rawmods[$seq]->id, false);
513                            // To save making another query just below, put name in here
514                            $mod[$seq]->name = $modvalues->name;
515                        }
516                    }
517                    if (!isset($mod[$seq]->name)) {
518                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
519                    }
521                     // Minimise the database size by unsetting default options when they are
522                     // 'empty'. This list corresponds to code in the cm_info constructor.
523                     foreach (array('idnumber', 'groupmode', 'groupingid',
524                             'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
525                             'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
526                             'completionexpected', 'score', 'showdescription', 'deletioninprogress') as $property) {
527                        if (property_exists($mod[$seq], $property) &&
528                                empty($mod[$seq]->{$property})) {
529                            unset($mod[$seq]->{$property});
530                        }
531                    }
532                    // Special case: this value is usually set to null, but may be 0
533                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
534                            is_null($mod[$seq]->completiongradeitemnumber)) {
535                        unset($mod[$seq]->completiongradeitemnumber);
536                    }
537                }
538             }
539         }
540     }
541     return $mod;
544 /**
545  * Returns the localised human-readable names of all used modules
546  *
547  * @param bool $plural if true returns the plural forms of the names
548  * @return array where key is the module name (component name without 'mod_') and
549  *     the value is the human-readable string. Array sorted alphabetically by value
550  */
551 function get_module_types_names($plural = false) {
552     static $modnames = null;
553     global $DB, $CFG;
554     if ($modnames === null) {
555         $modnames = array(0 => array(), 1 => array());
556         if ($allmods = $DB->get_records("modules")) {
557             foreach ($allmods as $mod) {
558                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
559                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
560                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
561                 }
562             }
563             core_collator::asort($modnames[0]);
564             core_collator::asort($modnames[1]);
565         }
566     }
567     return $modnames[(int)$plural];
570 /**
571  * Set highlighted section. Only one section can be highlighted at the time.
572  *
573  * @param int $courseid course id
574  * @param int $marker highlight section with this number, 0 means remove higlightin
575  * @return void
576  */
577 function course_set_marker($courseid, $marker) {
578     global $DB, $COURSE;
579     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
580     if ($COURSE && $COURSE->id == $courseid) {
581         $COURSE->marker = $marker;
582     }
583     if (class_exists('format_base')) {
584         format_base::reset_course_cache($courseid);
585     }
586     course_modinfo::clear_instance_cache($courseid);
589 /**
590  * For a given course section, marks it visible or hidden,
591  * and does the same for every activity in that section
592  *
593  * @param int $courseid course id
594  * @param int $sectionnumber The section number to adjust
595  * @param int $visibility The new visibility
596  * @return array A list of resources which were hidden in the section
597  */
598 function set_section_visible($courseid, $sectionnumber, $visibility) {
599     global $DB;
601     $resourcestotoggle = array();
602     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
603         course_update_section($courseid, $section, array('visible' => $visibility));
605         // Determine which modules are visible for AJAX update
606         $modules = !empty($section->sequence) ? explode(',', $section->sequence) : array();
607         if (!empty($modules)) {
608             list($insql, $params) = $DB->get_in_or_equal($modules);
609             $select = 'id ' . $insql . ' AND visible = ?';
610             array_push($params, $visibility);
611             if (!$visibility) {
612                 $select .= ' AND visibleold = 1';
613             }
614             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
615         }
616     }
617     return $resourcestotoggle;
620 /**
621  * Retrieve all metadata for the requested modules
622  *
623  * @param object $course The Course
624  * @param array $modnames An array containing the list of modules and their
625  * names
626  * @param int $sectionreturn The section to return to
627  * @return array A list of stdClass objects containing metadata about each
628  * module
629  */
630 function get_module_metadata($course, $modnames, $sectionreturn = null) {
631     global $OUTPUT;
633     // get_module_metadata will be called once per section on the page and courses may show
634     // different modules to one another
635     static $modlist = array();
636     if (!isset($modlist[$course->id])) {
637         $modlist[$course->id] = array();
638     }
640     $return = array();
641     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
642     if ($sectionreturn !== null) {
643         $urlbase->param('sr', $sectionreturn);
644     }
645     foreach($modnames as $modname => $modnamestr) {
646         if (!course_allowed_module($course, $modname)) {
647             continue;
648         }
649         if (isset($modlist[$course->id][$modname])) {
650             // This module is already cached
651             $return += $modlist[$course->id][$modname];
652             continue;
653         }
654         $modlist[$course->id][$modname] = array();
656         // Create an object for a default representation of this module type in the activity chooser. It will be used
657         // if module does not implement callback get_shortcuts() and it will also be passed to the callback if it exists.
658         $defaultmodule = new stdClass();
659         $defaultmodule->title = $modnamestr;
660         $defaultmodule->name = $modname;
661         $defaultmodule->link = new moodle_url($urlbase, array('add' => $modname));
662         $defaultmodule->icon = $OUTPUT->pix_icon('icon', '', $defaultmodule->name, array('class' => 'icon'));
663         $sm = get_string_manager();
664         if ($sm->string_exists('modulename_help', $modname)) {
665             $defaultmodule->help = get_string('modulename_help', $modname);
666             if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs.
667                 $link = get_string('modulename_link', $modname);
668                 $linktext = get_string('morehelp');
669                 $defaultmodule->help .= html_writer::tag('div',
670                     $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
671             }
672         }
673         $defaultmodule->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
675         // Each module can implement callback modulename_get_shortcuts() in its lib.php and return the list
676         // of elements to be added to activity chooser.
677         $items = component_callback($modname, 'get_shortcuts', array($defaultmodule), null);
678         if ($items !== null) {
679             foreach ($items as $item) {
680                 // Add all items to the return array. All items must have different links, use them as a key in the return array.
681                 if (!isset($item->archetype)) {
682                     $item->archetype = $defaultmodule->archetype;
683                 }
684                 if (!isset($item->icon)) {
685                     $item->icon = $defaultmodule->icon;
686                 }
687                 // If plugin returned the only one item with the same link as default item - cache it as $modname,
688                 // otherwise append the link url to the module name.
689                 $item->name = (count($items) == 1 &&
690                     $item->link->out() === $defaultmodule->link->out()) ? $modname : $modname . ':' . $item->link;
692                 // If the module provides the helptext property, append it to the help text to match the look and feel
693                 // of the default course modules.
694                 if (isset($item->help) && isset($item->helplink)) {
695                     $linktext = get_string('morehelp');
696                     $item->help .= html_writer::tag('div',
697                         $OUTPUT->doc_link($item->helplink, $linktext, true), array('class' => 'helpdoclink'));
698                 }
699                 $modlist[$course->id][$modname][$item->name] = $item;
700             }
701             $return += $modlist[$course->id][$modname];
702             // If get_shortcuts() callback is defined, the default module action is not added.
703             // It is a responsibility of the callback to add it to the return value unless it is not needed.
704             continue;
705         }
707         // The callback get_shortcuts() was not found, use the default item for the activity chooser.
708         $modlist[$course->id][$modname][$modname] = $defaultmodule;
709         $return[$modname] = $defaultmodule;
710     }
712     core_collator::asort_objects_by_property($return, 'title');
713     return $return;
716 /**
717  * Return the course category context for the category with id $categoryid, except
718  * that if $categoryid is 0, return the system context.
719  *
720  * @param integer $categoryid a category id or 0.
721  * @return context the corresponding context
722  */
723 function get_category_or_system_context($categoryid) {
724     if ($categoryid) {
725         return context_coursecat::instance($categoryid, IGNORE_MISSING);
726     } else {
727         return context_system::instance();
728     }
731 /**
732  * Returns full course categories trees to be used in html_writer::select()
733  *
734  * Calls {@link core_course_category::make_categories_list()} to build the tree and
735  * adds whitespace to denote nesting
736  *
737  * @return array array mapping course category id to the display name
738  */
739 function make_categories_options() {
740     $cats = core_course_category::make_categories_list('', 0, ' / ');
741     foreach ($cats as $key => $value) {
742         // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
743         $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
744     }
745     return $cats;
748 /**
749  * Print the buttons relating to course requests.
750  *
751  * @param object $context current page context.
752  */
753 function print_course_request_buttons($context) {
754     global $CFG, $DB, $OUTPUT;
755     if (empty($CFG->enablecourserequests)) {
756         return;
757     }
758     if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
759     /// Print a button to request a new course
760         echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
761     }
762     /// Print a button to manage pending requests
763     if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
764         $disabled = !$DB->record_exists('course_request', array());
765         echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
766     }
769 /**
770  * Does the user have permission to edit things in this category?
771  *
772  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
773  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
774  */
775 function can_edit_in_category($categoryid = 0) {
776     $context = get_category_or_system_context($categoryid);
777     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
780 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
782 function add_course_module($mod) {
783     global $DB;
785     $mod->added = time();
786     unset($mod->id);
788     $cmid = $DB->insert_record("course_modules", $mod);
789     rebuild_course_cache($mod->course, true);
790     return $cmid;
793 /**
794  * Creates a course section and adds it to the specified position
795  *
796  * @param int|stdClass $courseorid course id or course object
797  * @param int $position position to add to, 0 means to the end. If position is greater than
798  *        number of existing secitons, the section is added to the end. This will become sectionnum of the
799  *        new section. All existing sections at this or bigger position will be shifted down.
800  * @param bool $skipcheck the check has already been made and we know that the section with this position does not exist
801  * @return stdClass created section object
802  */
803 function course_create_section($courseorid, $position = 0, $skipcheck = false) {
804     global $DB;
805     $courseid = is_object($courseorid) ? $courseorid->id : $courseorid;
807     // Find the last sectionnum among existing sections.
808     if ($skipcheck) {
809         $lastsection = $position - 1;
810     } else {
811         $lastsection = (int)$DB->get_field_sql('SELECT max(section) from {course_sections} WHERE course = ?', [$courseid]);
812     }
814     // First add section to the end.
815     $cw = new stdClass();
816     $cw->course   = $courseid;
817     $cw->section  = $lastsection + 1;
818     $cw->summary  = '';
819     $cw->summaryformat = FORMAT_HTML;
820     $cw->sequence = '';
821     $cw->name = null;
822     $cw->visible = 1;
823     $cw->availability = null;
824     $cw->timemodified = time();
825     $cw->id = $DB->insert_record("course_sections", $cw);
827     // Now move it to the specified position.
828     if ($position > 0 && $position <= $lastsection) {
829         $course = is_object($courseorid) ? $courseorid : get_course($courseorid);
830         move_section_to($course, $cw->section, $position, true);
831         $cw->section = $position;
832     }
834     core\event\course_section_created::create_from_section($cw)->trigger();
836     rebuild_course_cache($courseid, true);
837     return $cw;
840 /**
841  * Creates missing course section(s) and rebuilds course cache
842  *
843  * @param int|stdClass $courseorid course id or course object
844  * @param int|array $sections list of relative section numbers to create
845  * @return bool if there were any sections created
846  */
847 function course_create_sections_if_missing($courseorid, $sections) {
848     if (!is_array($sections)) {
849         $sections = array($sections);
850     }
851     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
852     if ($newsections = array_diff($sections, $existing)) {
853         foreach ($newsections as $sectionnum) {
854             course_create_section($courseorid, $sectionnum, true);
855         }
856         return true;
857     }
858     return false;
861 /**
862  * Adds an existing module to the section
863  *
864  * Updates both tables {course_sections} and {course_modules}
865  *
866  * Note: This function does not use modinfo PROVIDED that the section you are
867  * adding the module to already exists. If the section does not exist, it will
868  * build modinfo if necessary and create the section.
869  *
870  * @param int|stdClass $courseorid course id or course object
871  * @param int $cmid id of the module already existing in course_modules table
872  * @param int $sectionnum relative number of the section (field course_sections.section)
873  *     If section does not exist it will be created
874  * @param int|stdClass $beforemod id or object with field id corresponding to the module
875  *     before which the module needs to be included. Null for inserting in the
876  *     end of the section
877  * @return int The course_sections ID where the module is inserted
878  */
879 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
880     global $DB, $COURSE;
881     if (is_object($beforemod)) {
882         $beforemod = $beforemod->id;
883     }
884     if (is_object($courseorid)) {
885         $courseid = $courseorid->id;
886     } else {
887         $courseid = $courseorid;
888     }
889     // Do not try to use modinfo here, there is no guarantee it is valid!
890     $section = $DB->get_record('course_sections',
891             array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
892     if (!$section) {
893         // This function call requires modinfo.
894         course_create_sections_if_missing($courseorid, $sectionnum);
895         $section = $DB->get_record('course_sections',
896                 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
897     }
899     $modarray = explode(",", trim($section->sequence));
900     if (empty($section->sequence)) {
901         $newsequence = "$cmid";
902     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
903         $insertarray = array($cmid, $beforemod);
904         array_splice($modarray, $key[0], 1, $insertarray);
905         $newsequence = implode(",", $modarray);
906     } else {
907         $newsequence = "$section->sequence,$cmid";
908     }
909     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
910     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
911     if (is_object($courseorid)) {
912         rebuild_course_cache($courseorid->id, true);
913     } else {
914         rebuild_course_cache($courseorid, true);
915     }
916     return $section->id;     // Return course_sections ID that was used.
919 /**
920  * Change the group mode of a course module.
921  *
922  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
923  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
924  *
925  * @param int $id course module ID.
926  * @param int $groupmode the new groupmode value.
927  * @return bool True if the $groupmode was updated.
928  */
929 function set_coursemodule_groupmode($id, $groupmode) {
930     global $DB;
931     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
932     if ($cm->groupmode != $groupmode) {
933         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
934         rebuild_course_cache($cm->course, true);
935     }
936     return ($cm->groupmode != $groupmode);
939 function set_coursemodule_idnumber($id, $idnumber) {
940     global $DB;
941     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
942     if ($cm->idnumber != $idnumber) {
943         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
944         rebuild_course_cache($cm->course, true);
945     }
946     return ($cm->idnumber != $idnumber);
949 /**
950  * Set the visibility of a module and inherent properties.
951  *
952  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
953  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
954  *
955  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
956  * has been moved to {@link set_section_visible()} which was the only place from which
957  * the parameter was used.
958  *
959  * @param int $id of the module
960  * @param int $visible state of the module
961  * @param int $visibleoncoursepage state of the module on the course page
962  * @return bool false when the module was not found, true otherwise
963  */
964 function set_coursemodule_visible($id, $visible, $visibleoncoursepage = 1) {
965     global $DB, $CFG;
966     require_once($CFG->libdir.'/gradelib.php');
967     require_once($CFG->dirroot.'/calendar/lib.php');
969     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
970         return false;
971     }
973     // Create events and propagate visibility to associated grade items if the value has changed.
974     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
975     if ($cm->visible == $visible && $cm->visibleoncoursepage == $visibleoncoursepage) {
976         return true;
977     }
979     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
980         return false;
981     }
982     if (($cm->visible != $visible) &&
983             ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename)))) {
984         foreach($events as $event) {
985             if ($visible) {
986                 $event = new calendar_event($event);
987                 $event->toggle_visibility(true);
988             } else {
989                 $event = new calendar_event($event);
990                 $event->toggle_visibility(false);
991             }
992         }
993     }
995     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
996     // affect visibleold to allow for an original visibility restore. See set_section_visible().
997     $cminfo = new stdClass();
998     $cminfo->id = $id;
999     $cminfo->visible = $visible;
1000     $cminfo->visibleoncoursepage = $visibleoncoursepage;
1001     $cminfo->visibleold = $visible;
1002     $DB->update_record('course_modules', $cminfo);
1004     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1005     // Note that this must be done after updating the row in course_modules, in case
1006     // the modules grade_item_update function needs to access $cm->visible.
1007     if ($cm->visible != $visible &&
1008             plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY) &&
1009             component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1010         $instance = $DB->get_record($modulename, array('id' => $cm->instance), '*', MUST_EXIST);
1011         component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1012     } else if ($cm->visible != $visible) {
1013         $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1014         if ($grade_items) {
1015             foreach ($grade_items as $grade_item) {
1016                 $grade_item->set_hidden(!$visible);
1017             }
1018         }
1019     }
1021     rebuild_course_cache($cm->course, true);
1022     return true;
1025 /**
1026  * Changes the course module name
1027  *
1028  * @param int $id course module id
1029  * @param string $name new value for a name
1030  * @return bool whether a change was made
1031  */
1032 function set_coursemodule_name($id, $name) {
1033     global $CFG, $DB;
1034     require_once($CFG->libdir . '/gradelib.php');
1036     $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST);
1038     $module = new \stdClass();
1039     $module->id = $cm->instance;
1041     // Escape strings as they would be by mform.
1042     if (!empty($CFG->formatstringstriptags)) {
1043         $module->name = clean_param($name, PARAM_TEXT);
1044     } else {
1045         $module->name = clean_param($name, PARAM_CLEANHTML);
1046     }
1047     if ($module->name === $cm->name || strval($module->name) === '') {
1048         return false;
1049     }
1050     if (\core_text::strlen($module->name) > 255) {
1051         throw new \moodle_exception('maximumchars', 'moodle', '', 255);
1052     }
1054     $module->timemodified = time();
1055     $DB->update_record($cm->modname, $module);
1056     $cm->name = $module->name;
1057     \core\event\course_module_updated::create_from_cm($cm)->trigger();
1058     rebuild_course_cache($cm->course, true);
1060     // Attempt to update the grade item if relevant.
1061     $grademodule = $DB->get_record($cm->modname, array('id' => $cm->instance));
1062     $grademodule->cmidnumber = $cm->idnumber;
1063     $grademodule->modname = $cm->modname;
1064     grade_update_mod_grades($grademodule);
1066     // Update calendar events with the new name.
1067     course_module_update_calendar_events($cm->modname, $grademodule, $cm);
1069     return true;
1072 /**
1073  * This function will handle the whole deletion process of a module. This includes calling
1074  * the modules delete_instance function, deleting files, events, grades, conditional data,
1075  * the data in the course_module and course_sections table and adding a module deletion
1076  * event to the DB.
1077  *
1078  * @param int $cmid the course module id
1079  * @param bool $async whether or not to try to delete the module using an adhoc task. Async also depends on a plugin hook.
1080  * @throws moodle_exception
1081  * @since Moodle 2.5
1082  */
1083 function course_delete_module($cmid, $async = false) {
1084     // Check the 'course_module_background_deletion_recommended' hook first.
1085     // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1086     // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1087     // It's up to plugins to handle things like whether or not they are enabled.
1088     if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1089         foreach ($pluginsfunction as $plugintype => $plugins) {
1090             foreach ($plugins as $pluginfunction) {
1091                 if ($pluginfunction()) {
1092                     return course_module_flag_for_async_deletion($cmid);
1093                 }
1094             }
1095         }
1096     }
1098     global $CFG, $DB;
1100     require_once($CFG->libdir.'/gradelib.php');
1101     require_once($CFG->libdir.'/questionlib.php');
1102     require_once($CFG->dirroot.'/blog/lib.php');
1103     require_once($CFG->dirroot.'/calendar/lib.php');
1105     // Get the course module.
1106     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1107         return true;
1108     }
1110     // Get the module context.
1111     $modcontext = context_module::instance($cm->id);
1113     // Get the course module name.
1114     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1116     // Get the file location of the delete_instance function for this module.
1117     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1119     // Include the file required to call the delete_instance function for this module.
1120     if (file_exists($modlib)) {
1121         require_once($modlib);
1122     } else {
1123         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1124             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1125     }
1127     $deleteinstancefunction = $modulename . '_delete_instance';
1129     // Ensure the delete_instance function exists for this module.
1130     if (!function_exists($deleteinstancefunction)) {
1131         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1132             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1133     }
1135     // Allow plugins to use this course module before we completely delete it.
1136     if ($pluginsfunction = get_plugins_with_function('pre_course_module_delete')) {
1137         foreach ($pluginsfunction as $plugintype => $plugins) {
1138             foreach ($plugins as $pluginfunction) {
1139                 $pluginfunction($cm);
1140             }
1141         }
1142     }
1144     // Delete activity context questions and question categories.
1145     question_delete_activity($cm);
1147     // Call the delete_instance function, if it returns false throw an exception.
1148     if (!$deleteinstancefunction($cm->instance)) {
1149         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1150             "Cannot delete the module $modulename (instance).");
1151     }
1153     // Remove all module files in case modules forget to do that.
1154     $fs = get_file_storage();
1155     $fs->delete_area_files($modcontext->id);
1157     // Delete events from calendar.
1158     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1159         $coursecontext = context_course::instance($cm->course);
1160         foreach($events as $event) {
1161             $event->context = $coursecontext;
1162             $calendarevent = calendar_event::load($event);
1163             $calendarevent->delete();
1164         }
1165     }
1167     // Delete grade items, outcome items and grades attached to modules.
1168     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1169                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1170         foreach ($grade_items as $grade_item) {
1171             $grade_item->delete('moddelete');
1172         }
1173     }
1175     // Delete associated blogs and blog tag instances.
1176     blog_remove_associations_for_module($modcontext->id);
1178     // Delete completion and availability data; it is better to do this even if the
1179     // features are not turned on, in case they were turned on previously (these will be
1180     // very quick on an empty table).
1181     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1182     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1183                                                             'course' => $cm->course,
1184                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1186     // Delete all tag instances associated with the instance of this module.
1187     core_tag_tag::delete_instances('mod_' . $modulename, null, $modcontext->id);
1188     core_tag_tag::remove_all_item_tags('core', 'course_modules', $cm->id);
1190     // Notify the competency subsystem.
1191     \core_competency\api::hook_course_module_deleted($cm);
1193     // Delete the context.
1194     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1196     // Delete the module from the course_modules table.
1197     $DB->delete_records('course_modules', array('id' => $cm->id));
1199     // Delete module from that section.
1200     if (!delete_mod_from_section($cm->id, $cm->section)) {
1201         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1202             "Cannot delete the module $modulename (instance) from section.");
1203     }
1205     // Trigger event for course module delete action.
1206     $event = \core\event\course_module_deleted::create(array(
1207         'courseid' => $cm->course,
1208         'context'  => $modcontext,
1209         'objectid' => $cm->id,
1210         'other'    => array(
1211             'modulename' => $modulename,
1212             'instanceid'   => $cm->instance,
1213         )
1214     ));
1215     $event->add_record_snapshot('course_modules', $cm);
1216     $event->trigger();
1217     rebuild_course_cache($cm->course, true);
1220 /**
1221  * Schedule a course module for deletion in the background using an adhoc task.
1222  *
1223  * This method should not be called directly. Instead, please use course_delete_module($cmid, true), to denote async deletion.
1224  * The real deletion of the module is handled by the task, which calls 'course_delete_module($cmid)'.
1225  *
1226  * @param int $cmid the course module id.
1227  * @return bool whether the module was successfully scheduled for deletion.
1228  * @throws \moodle_exception
1229  */
1230 function course_module_flag_for_async_deletion($cmid) {
1231     global $CFG, $DB, $USER;
1232     require_once($CFG->libdir.'/gradelib.php');
1233     require_once($CFG->libdir.'/questionlib.php');
1234     require_once($CFG->dirroot.'/blog/lib.php');
1235     require_once($CFG->dirroot.'/calendar/lib.php');
1237     // Get the course module.
1238     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1239         return true;
1240     }
1242     // We need to be reasonably certain the deletion is going to succeed before we background the process.
1243     // Make the necessary delete_instance checks, etc. before proceeding further. Throw exceptions if required.
1245     // Get the course module name.
1246     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1248     // Get the file location of the delete_instance function for this module.
1249     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1251     // Include the file required to call the delete_instance function for this module.
1252     if (file_exists($modlib)) {
1253         require_once($modlib);
1254     } else {
1255         throw new \moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1256             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1257     }
1259     $deleteinstancefunction = $modulename . '_delete_instance';
1261     // Ensure the delete_instance function exists for this module.
1262     if (!function_exists($deleteinstancefunction)) {
1263         throw new \moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1264             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1265     }
1267     // We are going to defer the deletion as we can't be sure how long the module's pre_delete code will run for.
1268     $cm->deletioninprogress = '1';
1269     $DB->update_record('course_modules', $cm);
1271     // Create an adhoc task for the deletion of the course module. The task takes an array of course modules for removal.
1272     $removaltask = new \core_course\task\course_delete_modules();
1273     $removaltask->set_custom_data(array(
1274         'cms' => array($cm),
1275         'userid' => $USER->id,
1276         'realuserid' => \core\session\manager::get_realuser()->id
1277     ));
1279     // Queue the task for the next run.
1280     \core\task\manager::queue_adhoc_task($removaltask);
1282     // Reset the course cache to hide the module.
1283     rebuild_course_cache($cm->course, true);
1286 /**
1287  * Checks whether the given course has any course modules scheduled for adhoc deletion.
1288  *
1289  * @param int $courseid the id of the course.
1290  * @return bool true if the course contains any modules pending deletion, false otherwise.
1291  */
1292 function course_modules_pending_deletion($courseid) {
1293     if (empty($courseid)) {
1294         return false;
1295     }
1296     $modinfo = get_fast_modinfo($courseid);
1297     foreach ($modinfo->get_cms() as $module) {
1298         if ($module->deletioninprogress == '1') {
1299             return true;
1300         }
1301     }
1302     return false;
1305 /**
1306  * Checks whether the course module, as defined by modulename and instanceid, is scheduled for deletion within the given course.
1307  *
1308  * @param int $courseid the course id.
1309  * @param string $modulename the module name. E.g. 'assign', 'book', etc.
1310  * @param int $instanceid the module instance id.
1311  * @return bool true if the course module is pending deletion, false otherwise.
1312  */
1313 function course_module_instance_pending_deletion($courseid, $modulename, $instanceid) {
1314     if (empty($courseid) || empty($modulename) || empty($instanceid)) {
1315         return false;
1316     }
1317     $modinfo = get_fast_modinfo($courseid);
1318     $instances = $modinfo->get_instances_of($modulename);
1319     return isset($instances[$instanceid]) && $instances[$instanceid]->deletioninprogress;
1322 function delete_mod_from_section($modid, $sectionid) {
1323     global $DB;
1325     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1327         $modarray = explode(",", $section->sequence);
1329         if ($key = array_keys ($modarray, $modid)) {
1330             array_splice($modarray, $key[0], 1);
1331             $newsequence = implode(",", $modarray);
1332             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1333             rebuild_course_cache($section->course, true);
1334             return true;
1335         } else {
1336             return false;
1337         }
1339     }
1340     return false;
1343 /**
1344  * This function updates the calendar events from the information stored in the module table and the course
1345  * module table.
1346  *
1347  * @param  string $modulename Module name
1348  * @param  stdClass $instance Module object. Either the $instance or the $cm must be supplied.
1349  * @param  stdClass $cm Course module object. Either the $instance or the $cm must be supplied.
1350  * @return bool Returns true if calendar events are updated.
1351  * @since  Moodle 3.3.4
1352  */
1353 function course_module_update_calendar_events($modulename, $instance = null, $cm = null) {
1354     global $DB;
1356     if (isset($instance) || isset($cm)) {
1358         if (!isset($instance)) {
1359             $instance = $DB->get_record($modulename, array('id' => $cm->instance), '*', MUST_EXIST);
1360         }
1361         if (!isset($cm)) {
1362             $cm = get_coursemodule_from_instance($modulename, $instance->id, $instance->course);
1363         }
1364         if (!empty($cm)) {
1365             course_module_calendar_event_update_process($instance, $cm);
1366         }
1367         return true;
1368     }
1369     return false;
1372 /**
1373  * Update all instances through out the site or in a course.
1374  *
1375  * @param  string  $modulename Module type to update.
1376  * @param  integer $courseid   Course id to update events. 0 for the whole site.
1377  * @return bool Returns True if the update was successful.
1378  * @since  Moodle 3.3.4
1379  */
1380 function course_module_bulk_update_calendar_events($modulename, $courseid = 0) {
1381     global $DB;
1383     $instances = null;
1384     if ($courseid) {
1385         if (!$instances = $DB->get_records($modulename, array('course' => $courseid))) {
1386             return false;
1387         }
1388     } else {
1389         if (!$instances = $DB->get_records($modulename)) {
1390             return false;
1391         }
1392     }
1394     foreach ($instances as $instance) {
1395         if ($cm = get_coursemodule_from_instance($modulename, $instance->id, $instance->course)) {
1396             course_module_calendar_event_update_process($instance, $cm);
1397         }
1398     }
1399     return true;
1402 /**
1403  * Calendar events for a module instance are updated.
1404  *
1405  * @param  stdClass $instance Module instance object.
1406  * @param  stdClass $cm Course Module object.
1407  * @since  Moodle 3.3.4
1408  */
1409 function course_module_calendar_event_update_process($instance, $cm) {
1410     // We need to call *_refresh_events() first because some modules delete 'old' events at the end of the code which
1411     // will remove the completion events.
1412     $refresheventsfunction = $cm->modname . '_refresh_events';
1413     if (function_exists($refresheventsfunction)) {
1414         call_user_func($refresheventsfunction, $cm->course, $instance, $cm);
1415     }
1416     $completionexpected = (!empty($cm->completionexpected)) ? $cm->completionexpected : null;
1417     \core_completion\api::update_completion_date_event($cm->id, $cm->modname, $instance, $completionexpected);
1420 /**
1421  * Moves a section within a course, from a position to another.
1422  * Be very careful: $section and $destination refer to section number,
1423  * not id!.
1424  *
1425  * @param object $course
1426  * @param int $section Section number (not id!!!)
1427  * @param int $destination
1428  * @param bool $ignorenumsections
1429  * @return boolean Result
1430  */
1431 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1432 /// Moves a whole course section up and down within the course
1433     global $USER, $DB;
1435     if (!$destination && $destination != 0) {
1436         return true;
1437     }
1439     // compartibility with course formats using field 'numsections'
1440     $courseformatoptions = course_get_format($course)->get_format_options();
1441     if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1442             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1443         return false;
1444     }
1446     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1447     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1448             'section ASC, id ASC', 'id, section')) {
1449         return false;
1450     }
1452     $movedsections = reorder_sections($sections, $section, $destination);
1454     // Update all sections. Do this in 2 steps to avoid breaking database
1455     // uniqueness constraint
1456     $transaction = $DB->start_delegated_transaction();
1457     foreach ($movedsections as $id => $position) {
1458         if ($sections[$id] !== $position) {
1459             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1460         }
1461     }
1462     foreach ($movedsections as $id => $position) {
1463         if ($sections[$id] !== $position) {
1464             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1465         }
1466     }
1468     // If we move the highlighted section itself, then just highlight the destination.
1469     // Adjust the higlighted section location if we move something over it either direction.
1470     if ($section == $course->marker) {
1471         course_set_marker($course->id, $destination);
1472     } elseif ($section > $course->marker && $course->marker >= $destination) {
1473         course_set_marker($course->id, $course->marker+1);
1474     } elseif ($section < $course->marker && $course->marker <= $destination) {
1475         course_set_marker($course->id, $course->marker-1);
1476     }
1478     $transaction->allow_commit();
1479     rebuild_course_cache($course->id, true);
1480     return true;
1483 /**
1484  * This method will delete a course section and may delete all modules inside it.
1485  *
1486  * No permissions are checked here, use {@link course_can_delete_section()} to
1487  * check if section can actually be deleted.
1488  *
1489  * @param int|stdClass $course
1490  * @param int|stdClass|section_info $section
1491  * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1492  * @param bool $async whether or not to try to delete the section using an adhoc task. Async also depends on a plugin hook.
1493  * @return bool whether section was deleted
1494  */
1495 function course_delete_section($course, $section, $forcedeleteifnotempty = true, $async = false) {
1496     global $DB;
1498     // Prepare variables.
1499     $courseid = (is_object($course)) ? $course->id : (int)$course;
1500     $sectionnum = (is_object($section)) ? $section->section : (int)$section;
1501     $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1502     if (!$section) {
1503         // No section exists, can't proceed.
1504         return false;
1505     }
1507     // Check the 'course_module_background_deletion_recommended' hook first.
1508     // Only use asynchronous deletion if at least one plugin returns true and if async deletion has been requested.
1509     // Both are checked because plugins should not be allowed to dictate the deletion behaviour, only support/decline it.
1510     // It's up to plugins to handle things like whether or not they are enabled.
1511     if ($async && $pluginsfunction = get_plugins_with_function('course_module_background_deletion_recommended')) {
1512         foreach ($pluginsfunction as $plugintype => $plugins) {
1513             foreach ($plugins as $pluginfunction) {
1514                 if ($pluginfunction()) {
1515                     return course_delete_section_async($section, $forcedeleteifnotempty);
1516                 }
1517             }
1518         }
1519     }
1521     $format = course_get_format($course);
1522     $sectionname = $format->get_section_name($section);
1524     // Delete section.
1525     $result = $format->delete_section($section, $forcedeleteifnotempty);
1527     // Trigger an event for course section deletion.
1528     if ($result) {
1529         $context = context_course::instance($courseid);
1530         $event = \core\event\course_section_deleted::create(
1531             array(
1532                 'objectid' => $section->id,
1533                 'courseid' => $courseid,
1534                 'context' => $context,
1535                 'other' => array(
1536                     'sectionnum' => $section->section,
1537                     'sectionname' => $sectionname,
1538                 )
1539             )
1540         );
1541         $event->add_record_snapshot('course_sections', $section);
1542         $event->trigger();
1543     }
1544     return $result;
1547 /**
1548  * Course section deletion, using an adhoc task for deletion of the modules it contains.
1549  * 1. Schedule all modules within the section for adhoc removal.
1550  * 2. Move all modules to course section 0.
1551  * 3. Delete the resulting empty section.
1552  *
1553  * @param \stdClass $section the section to schedule for deletion.
1554  * @param bool $forcedeleteifnotempty whether to force section deletion if it contains modules.
1555  * @return bool true if the section was scheduled for deletion, false otherwise.
1556  */
1557 function course_delete_section_async($section, $forcedeleteifnotempty = true) {
1558     global $DB, $USER;
1560     // Objects only, and only valid ones.
1561     if (!is_object($section) || empty($section->id)) {
1562         return false;
1563     }
1565     // Does the object currently exist in the DB for removal (check for stale objects).
1566     $section = $DB->get_record('course_sections', array('id' => $section->id));
1567     if (!$section || !$section->section) {
1568         // No section exists, or the section is 0. Can't proceed.
1569         return false;
1570     }
1572     // Check whether the section can be removed.
1573     if (!$forcedeleteifnotempty && (!empty($section->sequence) || !empty($section->summary))) {
1574         return false;
1575     }
1577     $format = course_get_format($section->course);
1578     $sectionname = $format->get_section_name($section);
1580     // Flag those modules having no existing deletion flag. Some modules may have been scheduled for deletion manually, and we don't
1581     // want to create additional adhoc deletion tasks for these. Moving them to section 0 will suffice.
1582     $affectedmods = $DB->get_records_select('course_modules', 'course = ? AND section = ? AND deletioninprogress <> ?',
1583                                             [$section->course, $section->id, 1], '', 'id');
1584     $DB->set_field('course_modules', 'deletioninprogress', '1', ['course' => $section->course, 'section' => $section->id]);
1586     // Move all modules to section 0.
1587     $modules = $DB->get_records('course_modules', ['section' => $section->id], '');
1588     $sectionzero = $DB->get_record('course_sections', ['course' => $section->course, 'section' => '0']);
1589     foreach ($modules as $mod) {
1590         moveto_module($mod, $sectionzero);
1591     }
1593     // Create and queue an adhoc task for the deletion of the modules.
1594     $removaltask = new \core_course\task\course_delete_modules();
1595     $data = array(
1596         'cms' => $affectedmods,
1597         'userid' => $USER->id,
1598         'realuserid' => \core\session\manager::get_realuser()->id
1599     );
1600     $removaltask->set_custom_data($data);
1601     \core\task\manager::queue_adhoc_task($removaltask);
1603     // Delete the now empty section, passing in only the section number, which forces the function to fetch a new object.
1604     // The refresh is needed because the section->sequence is now stale.
1605     $result = $format->delete_section($section->section, $forcedeleteifnotempty);
1607     // Trigger an event for course section deletion.
1608     if ($result) {
1609         $context = \context_course::instance($section->course);
1610         $event = \core\event\course_section_deleted::create(
1611             array(
1612                 'objectid' => $section->id,
1613                 'courseid' => $section->course,
1614                 'context' => $context,
1615                 'other' => array(
1616                     'sectionnum' => $section->section,
1617                     'sectionname' => $sectionname,
1618                 )
1619             )
1620         );
1621         $event->add_record_snapshot('course_sections', $section);
1622         $event->trigger();
1623     }
1624     rebuild_course_cache($section->course, true);
1626     return $result;
1629 /**
1630  * Updates the course section
1631  *
1632  * This function does not check permissions or clean values - this has to be done prior to calling it.
1633  *
1634  * @param int|stdClass $course
1635  * @param stdClass $section record from course_sections table - it will be updated with the new values
1636  * @param array|stdClass $data
1637  */
1638 function course_update_section($course, $section, $data) {
1639     global $DB;
1641     $courseid = (is_object($course)) ? $course->id : (int)$course;
1643     // Some fields can not be updated using this method.
1644     $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1645     $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible);
1646     if (array_key_exists('name', $data) && \core_text::strlen($data['name']) > 255) {
1647         throw new moodle_exception('maximumchars', 'moodle', '', 255);
1648     }
1650     // Update record in the DB and course format options.
1651     $data['id'] = $section->id;
1652     $data['timemodified'] = time();
1653     $DB->update_record('course_sections', $data);
1654     rebuild_course_cache($courseid, true);
1655     course_get_format($courseid)->update_section_format_options($data);
1657     // Update fields of the $section object.
1658     foreach ($data as $key => $value) {
1659         if (property_exists($section, $key)) {
1660             $section->$key = $value;
1661         }
1662     }
1664     // Trigger an event for course section update.
1665     $event = \core\event\course_section_updated::create(
1666         array(
1667             'objectid' => $section->id,
1668             'courseid' => $courseid,
1669             'context' => context_course::instance($courseid),
1670             'other' => array('sectionnum' => $section->section)
1671         )
1672     );
1673     $event->trigger();
1675     // If section visibility was changed, hide the modules in this section too.
1676     if ($changevisibility && !empty($section->sequence)) {
1677         $modules = explode(',', $section->sequence);
1678         foreach ($modules as $moduleid) {
1679             if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1680                 if ($data['visible']) {
1681                     // As we unhide the section, we use the previously saved visibility stored in visibleold.
1682                     set_coursemodule_visible($moduleid, $cm->visibleold, $cm->visibleoncoursepage);
1683                 } else {
1684                     // We hide the section, so we hide the module but we store the original state in visibleold.
1685                     set_coursemodule_visible($moduleid, 0, $cm->visibleoncoursepage);
1686                     $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1687                 }
1688                 \core\event\course_module_updated::create_from_cm($cm)->trigger();
1689             }
1690         }
1691     }
1694 /**
1695  * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1696  *
1697  * @param int|stdClass $course
1698  * @param int|stdClass|section_info $section
1699  * @return bool
1700  */
1701 function course_can_delete_section($course, $section) {
1702     if (is_object($section)) {
1703         $section = $section->section;
1704     }
1705     if (!$section) {
1706         // Not possible to delete 0-section.
1707         return false;
1708     }
1709     // Course format should allow to delete sections.
1710     if (!course_get_format($course)->can_delete_section($section)) {
1711         return false;
1712     }
1713     // Make sure user has capability to update course and move sections.
1714     $context = context_course::instance(is_object($course) ? $course->id : $course);
1715     if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1716         return false;
1717     }
1718     // Make sure user has capability to delete each activity in this section.
1719     $modinfo = get_fast_modinfo($course);
1720     if (!empty($modinfo->sections[$section])) {
1721         foreach ($modinfo->sections[$section] as $cmid) {
1722             if (!has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1723                 return false;
1724             }
1725         }
1726     }
1727     return true;
1730 /**
1731  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1732  * an original position number and a target position number, rebuilds the array so that the
1733  * move is made without any duplication of section positions.
1734  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1735  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1736  *
1737  * @param array $sections
1738  * @param int $origin_position
1739  * @param int $target_position
1740  * @return array
1741  */
1742 function reorder_sections($sections, $origin_position, $target_position) {
1743     if (!is_array($sections)) {
1744         return false;
1745     }
1747     // We can't move section position 0
1748     if ($origin_position < 1) {
1749         echo "We can't move section position 0";
1750         return false;
1751     }
1753     // Locate origin section in sections array
1754     if (!$origin_key = array_search($origin_position, $sections)) {
1755         echo "searched position not in sections array";
1756         return false; // searched position not in sections array
1757     }
1759     // Extract origin section
1760     $origin_section = $sections[$origin_key];
1761     unset($sections[$origin_key]);
1763     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1764     $found = false;
1765     $append_array = array();
1766     foreach ($sections as $id => $position) {
1767         if ($found) {
1768             $append_array[$id] = $position;
1769             unset($sections[$id]);
1770         }
1771         if ($position == $target_position) {
1772             if ($target_position < $origin_position) {
1773                 $append_array[$id] = $position;
1774                 unset($sections[$id]);
1775             }
1776             $found = true;
1777         }
1778     }
1780     // Append moved section
1781     $sections[$origin_key] = $origin_section;
1783     // Append rest of array (if applicable)
1784     if (!empty($append_array)) {
1785         foreach ($append_array as $id => $position) {
1786             $sections[$id] = $position;
1787         }
1788     }
1790     // Renumber positions
1791     $position = 0;
1792     foreach ($sections as $id => $p) {
1793         $sections[$id] = $position;
1794         $position++;
1795     }
1797     return $sections;
1801 /**
1802  * Move the module object $mod to the specified $section
1803  * If $beforemod exists then that is the module
1804  * before which $modid should be inserted
1805  *
1806  * @param stdClass|cm_info $mod
1807  * @param stdClass|section_info $section
1808  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1809  *     before which the module needs to be included. Null for inserting in the
1810  *     end of the section
1811  * @return int new value for module visibility (0 or 1)
1812  */
1813 function moveto_module($mod, $section, $beforemod=NULL) {
1814     global $OUTPUT, $DB;
1816     // Current module visibility state - return value of this function.
1817     $modvisible = $mod->visible;
1819     // Remove original module from original section.
1820     if (! delete_mod_from_section($mod->id, $mod->section)) {
1821         echo $OUTPUT->notification("Could not delete module from existing section");
1822     }
1824     // If moving to a hidden section then hide module.
1825     if ($mod->section != $section->id) {
1826         if (!$section->visible && $mod->visible) {
1827             // Module was visible but must become hidden after moving to hidden section.
1828             $modvisible = 0;
1829             set_coursemodule_visible($mod->id, 0);
1830             // Set visibleold to 1 so module will be visible when section is made visible.
1831             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1832         }
1833         if ($section->visible && !$mod->visible) {
1834             // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1835             set_coursemodule_visible($mod->id, $mod->visibleold);
1836             $modvisible = $mod->visibleold;
1837         }
1838     }
1840     // Add the module into the new section.
1841     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
1842     return $modvisible;
1845 /**
1846  * Returns the list of all editing actions that current user can perform on the module
1847  *
1848  * @param cm_info $mod The module to produce editing buttons for
1849  * @param int $indent The current indenting (default -1 means no move left-right actions)
1850  * @param int $sr The section to link back to (used for creating the links)
1851  * @return array array of action_link or pix_icon objects
1852  */
1853 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
1854     global $COURSE, $SITE, $CFG;
1856     static $str;
1858     $coursecontext = context_course::instance($mod->course);
1859     $modcontext = context_module::instance($mod->id);
1860     $courseformat = course_get_format($mod->get_course());
1862     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1863     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1865     // No permission to edit anything.
1866     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1867         return array();
1868     }
1870     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1872     if (!isset($str)) {
1873         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1874             'editsettings', 'duplicate', 'modhide', 'makeavailable', 'makeunavailable', 'modshow'), 'moodle');
1875         $str->assign         = get_string('assignroles', 'role');
1876         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1877         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1878         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1879     }
1881     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1883     if ($sr !== null) {
1884         $baseurl->param('sr', $sr);
1885     }
1886     $actions = array();
1888     // Update.
1889     if ($hasmanageactivities) {
1890         $actions['update'] = new action_menu_link_secondary(
1891             new moodle_url($baseurl, array('update' => $mod->id)),
1892             new pix_icon('t/edit', $str->editsettings, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1893             $str->editsettings,
1894             array('class' => 'editing_update', 'data-action' => 'update')
1895         );
1896     }
1898     // Indent.
1899     if ($hasmanageactivities && $indent >= 0) {
1900         $indentlimits = new stdClass();
1901         $indentlimits->min = 0;
1902         $indentlimits->max = 16;
1903         if (right_to_left()) {   // Exchange arrows on RTL
1904             $rightarrow = 't/left';
1905             $leftarrow  = 't/right';
1906         } else {
1907             $rightarrow = 't/right';
1908             $leftarrow  = 't/left';
1909         }
1911         if ($indent >= $indentlimits->max) {
1912             $enabledclass = 'hidden';
1913         } else {
1914             $enabledclass = '';
1915         }
1916         $actions['moveright'] = new action_menu_link_secondary(
1917             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
1918             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1919             $str->moveright,
1920             array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright',
1921                 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1922         );
1924         if ($indent <= $indentlimits->min) {
1925             $enabledclass = 'hidden';
1926         } else {
1927             $enabledclass = '';
1928         }
1929         $actions['moveleft'] = new action_menu_link_secondary(
1930             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
1931             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1932             $str->moveleft,
1933             array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft',
1934                 'data-keepopen' => true, 'data-sectionreturn' => $sr)
1935         );
1937     }
1939     // Hide/Show/Available/Unavailable.
1940     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1941         $allowstealth = !empty($CFG->allowstealth) && $courseformat->allow_stealth_module_visibility($mod, $mod->get_section_info());
1943         $sectionvisible = $mod->get_section_info()->visible;
1944         // The module on the course page may be in one of the following states:
1945         // - Available and displayed on the course page ($displayedoncoursepage);
1946         // - Not available and not displayed on the course page ($unavailable);
1947         // - Available but not displayed on the course page ($stealth) - this can also be a visible activity in a hidden section.
1948         $displayedoncoursepage = $mod->visible && $mod->visibleoncoursepage && $sectionvisible;
1949         $unavailable = !$mod->visible;
1950         $stealth = $mod->visible && (!$mod->visibleoncoursepage || !$sectionvisible);
1951         if ($displayedoncoursepage) {
1952             $actions['hide'] = new action_menu_link_secondary(
1953                 new moodle_url($baseurl, array('hide' => $mod->id)),
1954                 new pix_icon('t/hide', $str->modhide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1955                 $str->modhide,
1956                 array('class' => 'editing_hide', 'data-action' => 'hide')
1957             );
1958         } else if (!$displayedoncoursepage && $sectionvisible) {
1959             // Offer to "show" only if the section is visible.
1960             $actions['show'] = new action_menu_link_secondary(
1961                 new moodle_url($baseurl, array('show' => $mod->id)),
1962                 new pix_icon('t/show', $str->modshow, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1963                 $str->modshow,
1964                 array('class' => 'editing_show', 'data-action' => 'show')
1965             );
1966         }
1968         if ($stealth) {
1969             // When making the "stealth" module unavailable we perform the same action as hiding the visible module.
1970             $actions['hide'] = new action_menu_link_secondary(
1971                 new moodle_url($baseurl, array('hide' => $mod->id)),
1972                 new pix_icon('t/unblock', $str->makeunavailable, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1973                 $str->makeunavailable,
1974                 array('class' => 'editing_makeunavailable', 'data-action' => 'hide', 'data-sectionreturn' => $sr)
1975             );
1976         } else if ($unavailable && (!$sectionvisible || $allowstealth) && $mod->has_view()) {
1977             // Allow to make visually hidden module available in gradebook and other reports by making it a "stealth" module.
1978             // When the section is hidden it is an equivalent of "showing" the module.
1979             // Activities without the link (i.e. labels) can not be made available but hidden on course page.
1980             $action = $sectionvisible ? 'stealth' : 'show';
1981             $actions[$action] = new action_menu_link_secondary(
1982                 new moodle_url($baseurl, array($action => $mod->id)),
1983                 new pix_icon('t/block', $str->makeavailable, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1984                 $str->makeavailable,
1985                 array('class' => 'editing_makeavailable', 'data-action' => $action, 'data-sectionreturn' => $sr)
1986             );
1987         }
1988     }
1990     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1991     if (has_all_capabilities($dupecaps, $coursecontext) &&
1992             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2) &&
1993             course_allowed_module($mod->get_course(), $mod->modname)) {
1994         $actions['duplicate'] = new action_menu_link_secondary(
1995             new moodle_url($baseurl, array('duplicate' => $mod->id)),
1996             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1997             $str->duplicate,
1998             array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sectionreturn' => $sr)
1999         );
2000     }
2002     // Groupmode.
2003     if ($hasmanageactivities && !$mod->coursegroupmodeforce) {
2004         if (plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2005             if ($mod->effectivegroupmode == SEPARATEGROUPS) {
2006                 $nextgroupmode = VISIBLEGROUPS;
2007                 $grouptitle = $str->groupsseparate;
2008                 $actionname = 'groupsseparate';
2009                 $nextactionname = 'groupsvisible';
2010                 $groupimage = 'i/groups';
2011             } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
2012                 $nextgroupmode = NOGROUPS;
2013                 $grouptitle = $str->groupsvisible;
2014                 $actionname = 'groupsvisible';
2015                 $nextactionname = 'groupsnone';
2016                 $groupimage = 'i/groupv';
2017             } else {
2018                 $nextgroupmode = SEPARATEGROUPS;
2019                 $grouptitle = $str->groupsnone;
2020                 $actionname = 'groupsnone';
2021                 $nextactionname = 'groupsseparate';
2022                 $groupimage = 'i/groupn';
2023             }
2025             $actions[$actionname] = new action_menu_link_primary(
2026                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
2027                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
2028                 $grouptitle,
2029                 array('class' => 'editing_'. $actionname, 'data-action' => $nextactionname,
2030                     'aria-live' => 'assertive', 'data-sectionreturn' => $sr)
2031             );
2032         } else {
2033             $actions['nogroupsupport'] = new action_menu_filler();
2034         }
2035     }
2037     // Assign.
2038     if (has_capability('moodle/role:assign', $modcontext)){
2039         $actions['assign'] = new action_menu_link_secondary(
2040             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2041             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2042             $str->assign,
2043             array('class' => 'editing_assign', 'data-action' => 'assignroles', 'data-sectionreturn' => $sr)
2044         );
2045     }
2047     // Delete.
2048     if ($hasmanageactivities) {
2049         $actions['delete'] = new action_menu_link_secondary(
2050             new moodle_url($baseurl, array('delete' => $mod->id)),
2051             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2052             $str->delete,
2053             array('class' => 'editing_delete', 'data-action' => 'delete', 'data-sectionreturn' => $sr)
2054         );
2055     }
2057     return $actions;
2060 /**
2061  * Returns the move action.
2062  *
2063  * @param cm_info $mod The module to produce a move button for
2064  * @param int $sr The section to link back to (used for creating the links)
2065  * @return The markup for the move action, or an empty string if not available.
2066  */
2067 function course_get_cm_move(cm_info $mod, $sr = null) {
2068     global $OUTPUT;
2070     static $str;
2071     static $baseurl;
2073     $modcontext = context_module::instance($mod->id);
2074     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2076     if (!isset($str)) {
2077         $str = get_strings(array('move'));
2078     }
2080     if (!isset($baseurl)) {
2081         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2083         if ($sr !== null) {
2084             $baseurl->param('sr', $sr);
2085         }
2086     }
2088     if ($hasmanageactivities) {
2089         $pixicon = 'i/dragdrop';
2091         if (!course_ajax_enabled($mod->get_course())) {
2092             // Override for course frontpage until we get drag/drop working there.
2093             $pixicon = 't/move';
2094         }
2096         return html_writer::link(
2097             new moodle_url($baseurl, array('copy' => $mod->id)),
2098             $OUTPUT->pix_icon($pixicon, $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2099             array('class' => 'editing_move', 'data-action' => 'move', 'data-sectionreturn' => $sr)
2100         );
2101     }
2102     return '';
2105 /**
2106  * given a course object with shortname & fullname, this function will
2107  * truncate the the number of chars allowed and add ... if it was too long
2108  */
2109 function course_format_name ($course,$max=100) {
2111     $context = context_course::instance($course->id);
2112     $shortname = format_string($course->shortname, true, array('context' => $context));
2113     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2114     $str = $shortname.': '. $fullname;
2115     if (core_text::strlen($str) <= $max) {
2116         return $str;
2117     }
2118     else {
2119         return core_text::substr($str,0,$max-3).'...';
2120     }
2123 /**
2124  * Is the user allowed to add this type of module to this course?
2125  * @param object $course the course settings. Only $course->id is used.
2126  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2127  * @return bool whether the current user is allowed to add this type of module to this course.
2128  */
2129 function course_allowed_module($course, $modname) {
2130     if (is_numeric($modname)) {
2131         throw new coding_exception('Function course_allowed_module no longer
2132                 supports numeric module ids. Please update your code to pass the module name.');
2133     }
2135     $capability = 'mod/' . $modname . ':addinstance';
2136     if (!get_capability_info($capability)) {
2137         // Debug warning that the capability does not exist, but no more than once per page.
2138         static $warned = array();
2139         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2140         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2141             debugging('The module ' . $modname . ' does not define the standard capability ' .
2142                     $capability , DEBUG_DEVELOPER);
2143             $warned[$modname] = 1;
2144         }
2146         // If the capability does not exist, the module can always be added.
2147         return true;
2148     }
2150     $coursecontext = context_course::instance($course->id);
2151     return has_capability($capability, $coursecontext);
2154 /**
2155  * Efficiently moves many courses around while maintaining
2156  * sortorder in order.
2157  *
2158  * @param array $courseids is an array of course ids
2159  * @param int $categoryid
2160  * @return bool success
2161  */
2162 function move_courses($courseids, $categoryid) {
2163     global $DB;
2165     if (empty($courseids)) {
2166         // Nothing to do.
2167         return false;
2168     }
2170     if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2171         return false;
2172     }
2174     $courseids = array_reverse($courseids);
2175     $newparent = context_coursecat::instance($category->id);
2176     $i = 1;
2178     list($where, $params) = $DB->get_in_or_equal($courseids);
2179     $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2180     foreach ($dbcourses as $dbcourse) {
2181         $course = new stdClass();
2182         $course->id = $dbcourse->id;
2183         $course->category  = $category->id;
2184         $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2185         if ($category->visible == 0) {
2186             // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2187             // to previous state if somebody unhides the category.
2188             $course->visible = 0;
2189         }
2191         $DB->update_record('course', $course);
2193         // Update context, so it can be passed to event.
2194         $context = context_course::instance($course->id);
2195         $context->update_moved($newparent);
2197         // Trigger a course updated event.
2198         $event = \core\event\course_updated::create(array(
2199             'objectid' => $course->id,
2200             'context' => context_course::instance($course->id),
2201             'other' => array('shortname' => $dbcourse->shortname,
2202                              'fullname' => $dbcourse->fullname)
2203         ));
2204         $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2205         $event->trigger();
2206     }
2207     fix_course_sortorder();
2208     cache_helper::purge_by_event('changesincourse');
2210     return true;
2213 /**
2214  * Returns the display name of the given section that the course prefers
2215  *
2216  * Implementation of this function is provided by course format
2217  * @see format_base::get_section_name()
2218  *
2219  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2220  * @param int|stdClass $section Section object from database or just field course_sections.section
2221  * @return string Display name that the course format prefers, e.g. "Week 2"
2222  */
2223 function get_section_name($courseorid, $section) {
2224     return course_get_format($courseorid)->get_section_name($section);
2227 /**
2228  * Tells if current course format uses sections
2229  *
2230  * @param string $format Course format ID e.g. 'weeks' $course->format
2231  * @return bool
2232  */
2233 function course_format_uses_sections($format) {
2234     $course = new stdClass();
2235     $course->format = $format;
2236     return course_get_format($course)->uses_sections();
2239 /**
2240  * Returns the information about the ajax support in the given source format
2241  *
2242  * The returned object's property (boolean)capable indicates that
2243  * the course format supports Moodle course ajax features.
2244  *
2245  * @param string $format
2246  * @return stdClass
2247  */
2248 function course_format_ajax_support($format) {
2249     $course = new stdClass();
2250     $course->format = $format;
2251     return course_get_format($course)->supports_ajax();
2254 /**
2255  * Can the current user delete this course?
2256  * Course creators have exception,
2257  * 1 day after the creation they can sill delete the course.
2258  * @param int $courseid
2259  * @return boolean
2260  */
2261 function can_delete_course($courseid) {
2262     global $USER;
2264     $context = context_course::instance($courseid);
2266     if (has_capability('moodle/course:delete', $context)) {
2267         return true;
2268     }
2270     // hack: now try to find out if creator created this course recently (1 day)
2271     if (!has_capability('moodle/course:create', $context)) {
2272         return false;
2273     }
2275     $since = time() - 60*60*24;
2276     $course = get_course($courseid);
2278     if ($course->timecreated < $since) {
2279         return false; // Return if the course was not created in last 24 hours.
2280     }
2282     $logmanger = get_log_manager();
2283     $readers = $logmanger->get_readers('\core\log\sql_reader');
2284     $reader = reset($readers);
2286     if (empty($reader)) {
2287         return false; // No log reader found.
2288     }
2290     // A proper reader.
2291     $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2292     $params = array('userid' => $USER->id, 'since' => $since, 'courseid' => $course->id, 'eventname' => '\core\event\course_created');
2294     return (bool)$reader->get_events_select_count($select, $params);
2297 /**
2298  * Save the Your name for 'Some role' strings.
2299  *
2300  * @param integer $courseid the id of this course.
2301  * @param array $data the data that came from the course settings form.
2302  */
2303 function save_local_role_names($courseid, $data) {
2304     global $DB;
2305     $context = context_course::instance($courseid);
2307     foreach ($data as $fieldname => $value) {
2308         if (strpos($fieldname, 'role_') !== 0) {
2309             continue;
2310         }
2311         list($ignored, $roleid) = explode('_', $fieldname);
2313         // make up our mind whether we want to delete, update or insert
2314         if (!$value) {
2315             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2317         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2318             $rolename->name = $value;
2319             $DB->update_record('role_names', $rolename);
2321         } else {
2322             $rolename = new stdClass;
2323             $rolename->contextid = $context->id;
2324             $rolename->roleid = $roleid;
2325             $rolename->name = $value;
2326             $DB->insert_record('role_names', $rolename);
2327         }
2328         // This will ensure the course contacts cache is purged..
2329         core_course_category::role_assignment_changed($roleid, $context);
2330     }
2333 /**
2334  * Returns options to use in course overviewfiles filemanager
2335  *
2336  * @param null|stdClass|core_course_list_element|int $course either object that has 'id' property or just the course id;
2337  *     may be empty if course does not exist yet (course create form)
2338  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2339  *     or null if overviewfiles are disabled
2340  */
2341 function course_overviewfiles_options($course) {
2342     global $CFG;
2343     if (empty($CFG->courseoverviewfileslimit)) {
2344         return null;
2345     }
2346     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2347     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2348         $accepted_types = '*';
2349     } else {
2350         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2351         // Make sure extensions are prefixed with dot unless they are valid typegroups
2352         foreach ($accepted_types as $i => $type) {
2353             if (substr($type, 0, 1) !== '.') {
2354                 require_once($CFG->libdir. '/filelib.php');
2355                 if (!count(file_get_typegroup('extension', $type))) {
2356                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2357                     $accepted_types[$i] = '.'. $type;
2358                     $corrected = true;
2359                 }
2360             }
2361         }
2362         if (!empty($corrected)) {
2363             set_config('courseoverviewfilesext', join(',', $accepted_types));
2364         }
2365     }
2366     $options = array(
2367         'maxfiles' => $CFG->courseoverviewfileslimit,
2368         'maxbytes' => $CFG->maxbytes,
2369         'subdirs' => 0,
2370         'accepted_types' => $accepted_types
2371     );
2372     if (!empty($course->id)) {
2373         $options['context'] = context_course::instance($course->id);
2374     } else if (is_int($course) && $course > 0) {
2375         $options['context'] = context_course::instance($course);
2376     }
2377     return $options;
2380 /**
2381  * Create a course and either return a $course object
2382  *
2383  * Please note this functions does not verify any access control,
2384  * the calling code is responsible for all validation (usually it is the form definition).
2385  *
2386  * @param array $editoroptions course description editor options
2387  * @param object $data  - all the data needed for an entry in the 'course' table
2388  * @return object new course instance
2389  */
2390 function create_course($data, $editoroptions = NULL) {
2391     global $DB, $CFG;
2393     //check the categoryid - must be given for all new courses
2394     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2396     // Check if the shortname already exists.
2397     if (!empty($data->shortname)) {
2398         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2399             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2400         }
2401     }
2403     // Check if the idnumber already exists.
2404     if (!empty($data->idnumber)) {
2405         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2406             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2407         }
2408     }
2410     if ($errorcode = course_validate_dates((array)$data)) {
2411         throw new moodle_exception($errorcode);
2412     }
2414     // Check if timecreated is given.
2415     $data->timecreated  = !empty($data->timecreated) ? $data->timecreated : time();
2416     $data->timemodified = $data->timecreated;
2418     // place at beginning of any category
2419     $data->sortorder = 0;
2421     if ($editoroptions) {
2422         // summary text is updated later, we need context to store the files first
2423         $data->summary = '';
2424         $data->summary_format = FORMAT_HTML;
2425     }
2427     if (!isset($data->visible)) {
2428         // data not from form, add missing visibility info
2429         $data->visible = $category->visible;
2430     }
2431     $data->visibleold = $data->visible;
2433     $newcourseid = $DB->insert_record('course', $data);
2434     $context = context_course::instance($newcourseid, MUST_EXIST);
2436     if ($editoroptions) {
2437         // Save the files used in the summary editor and store
2438         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2439         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2440         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2441     }
2442     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2443         // Save the course overviewfiles
2444         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2445     }
2447     // update course format options
2448     course_get_format($newcourseid)->update_course_format_options($data);
2450     $course = course_get_format($newcourseid)->get_course();
2452     fix_course_sortorder();
2453     // purge appropriate caches in case fix_course_sortorder() did not change anything
2454     cache_helper::purge_by_event('changesincourse');
2456     // Trigger a course created event.
2457     $event = \core\event\course_created::create(array(
2458         'objectid' => $course->id,
2459         'context' => context_course::instance($course->id),
2460         'other' => array('shortname' => $course->shortname,
2461             'fullname' => $course->fullname)
2462     ));
2464     $event->trigger();
2466     // Setup the blocks
2467     blocks_add_default_course_blocks($course);
2469     // Create default section and initial sections if specified (unless they've already been created earlier).
2470     // We do not want to call course_create_sections_if_missing() because to avoid creating course cache.
2471     $numsections = isset($data->numsections) ? $data->numsections : 0;
2472     $existingsections = $DB->get_fieldset_sql('SELECT section from {course_sections} WHERE course = ?', [$newcourseid]);
2473     $newsections = array_diff(range(0, $numsections), $existingsections);
2474     foreach ($newsections as $sectionnum) {
2475         course_create_section($newcourseid, $sectionnum, true);
2476     }
2478     // Save any custom role names.
2479     save_local_role_names($course->id, (array)$data);
2481     // set up enrolments
2482     enrol_course_updated(true, $course, $data);
2484     // Update course tags.
2485     if (isset($data->tags)) {
2486         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2487     }
2489     return $course;
2492 /**
2493  * Update a course.
2494  *
2495  * Please note this functions does not verify any access control,
2496  * the calling code is responsible for all validation (usually it is the form definition).
2497  *
2498  * @param object $data  - all the data needed for an entry in the 'course' table
2499  * @param array $editoroptions course description editor options
2500  * @return void
2501  */
2502 function update_course($data, $editoroptions = NULL) {
2503     global $DB, $CFG;
2505     $data->timemodified = time();
2507     // Prevent changes on front page course.
2508     if ($data->id == SITEID) {
2509         throw new moodle_exception('invalidcourse', 'error');
2510     }
2512     $oldcourse = course_get_format($data->id)->get_course();
2513     $context   = context_course::instance($oldcourse->id);
2515     if ($editoroptions) {
2516         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2517     }
2518     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2519         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2520     }
2522     // Check we don't have a duplicate shortname.
2523     if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
2524         if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname, $data->id))) {
2525             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2526         }
2527     }
2529     // Check we don't have a duplicate idnumber.
2530     if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
2531         if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber, $data->id))) {
2532             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2533         }
2534     }
2536     if ($errorcode = course_validate_dates((array)$data)) {
2537         throw new moodle_exception($errorcode);
2538     }
2540     if (!isset($data->category) or empty($data->category)) {
2541         // prevent nulls and 0 in category field
2542         unset($data->category);
2543     }
2544     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2546     if (!isset($data->visible)) {
2547         // data not from form, add missing visibility info
2548         $data->visible = $oldcourse->visible;
2549     }
2551     if ($data->visible != $oldcourse->visible) {
2552         // reset the visibleold flag when manually hiding/unhiding course
2553         $data->visibleold = $data->visible;
2554         $changesincoursecat = true;
2555     } else {
2556         if ($movecat) {
2557             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2558             if (empty($newcategory->visible)) {
2559                 // make sure when moving into hidden category the course is hidden automatically
2560                 $data->visible = 0;
2561             }
2562         }
2563     }
2565     // Set newsitems to 0 if format does not support announcements.
2566     if (isset($data->format)) {
2567         $newcourseformat = course_get_format((object)['format' => $data->format]);
2568         if (!$newcourseformat->supports_news()) {
2569             $data->newsitems = 0;
2570         }
2571     }
2573     // Update with the new data
2574     $DB->update_record('course', $data);
2575     // make sure the modinfo cache is reset
2576     rebuild_course_cache($data->id);
2578     // update course format options with full course data
2579     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2581     $course = $DB->get_record('course', array('id'=>$data->id));
2583     if ($movecat) {
2584         $newparent = context_coursecat::instance($course->category);
2585         $context->update_moved($newparent);
2586     }
2587     $fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
2588     if ($fixcoursesortorder) {
2589         fix_course_sortorder();
2590     }
2592     // purge appropriate caches in case fix_course_sortorder() did not change anything
2593     cache_helper::purge_by_event('changesincourse');
2594     if ($changesincoursecat) {
2595         cache_helper::purge_by_event('changesincoursecat');
2596     }
2598     // Test for and remove blocks which aren't appropriate anymore
2599     blocks_remove_inappropriate($course);
2601     // Save any custom role names.
2602     save_local_role_names($course->id, $data);
2604     // update enrol settings
2605     enrol_course_updated(false, $course, $data);
2607     // Update course tags.
2608     if (isset($data->tags)) {
2609         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2610     }
2612     // Trigger a course updated event.
2613     $event = \core\event\course_updated::create(array(
2614         'objectid' => $course->id,
2615         'context' => context_course::instance($course->id),
2616         'other' => array('shortname' => $course->shortname,
2617                          'fullname' => $course->fullname)
2618     ));
2620     $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
2621     $event->trigger();
2623     if ($oldcourse->format !== $course->format) {
2624         // Remove all options stored for the previous format
2625         // We assume that new course format migrated everything it needed watching trigger
2626         // 'course_updated' and in method format_XXX::update_course_format_options()
2627         $DB->delete_records('course_format_options',
2628                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2629     }
2632 /**
2633  * Average number of participants
2634  * @return integer
2635  */
2636 function average_number_of_participants() {
2637     global $DB, $SITE;
2639     //count total of enrolments for visible course (except front page)
2640     $sql = 'SELECT COUNT(*) FROM (
2641         SELECT DISTINCT ue.userid, e.courseid
2642         FROM {user_enrolments} ue, {enrol} e, {course} c
2643         WHERE ue.enrolid = e.id
2644             AND e.courseid <> :siteid
2645             AND c.id = e.courseid
2646             AND c.visible = 1) total';
2647     $params = array('siteid' => $SITE->id);
2648     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2651     //count total of visible courses (minus front page)
2652     $coursetotal = $DB->count_records('course', array('visible' => 1));
2653     $coursetotal = $coursetotal - 1 ;
2655     //average of enrolment
2656     if (empty($coursetotal)) {
2657         $participantaverage = 0;
2658     } else {
2659         $participantaverage = $enrolmenttotal / $coursetotal;
2660     }
2662     return $participantaverage;
2665 /**
2666  * Average number of course modules
2667  * @return integer
2668  */
2669 function average_number_of_courses_modules() {
2670     global $DB, $SITE;
2672     //count total of visible course module (except front page)
2673     $sql = 'SELECT COUNT(*) FROM (
2674         SELECT cm.course, cm.module
2675         FROM {course} c, {course_modules} cm
2676         WHERE c.id = cm.course
2677             AND c.id <> :siteid
2678             AND cm.visible = 1
2679             AND c.visible = 1) total';
2680     $params = array('siteid' => $SITE->id);
2681     $moduletotal = $DB->count_records_sql($sql, $params);
2684     //count total of visible courses (minus front page)
2685     $coursetotal = $DB->count_records('course', array('visible' => 1));
2686     $coursetotal = $coursetotal - 1 ;
2688     //average of course module
2689     if (empty($coursetotal)) {
2690         $coursemoduleaverage = 0;
2691     } else {
2692         $coursemoduleaverage = $moduletotal / $coursetotal;
2693     }
2695     return $coursemoduleaverage;
2698 /**
2699  * This class pertains to course requests and contains methods associated with
2700  * create, approving, and removing course requests.
2701  *
2702  * Please note we do not allow embedded images here because there is no context
2703  * to store them with proper access control.
2704  *
2705  * @copyright 2009 Sam Hemelryk
2706  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2707  * @since Moodle 2.0
2708  *
2709  * @property-read int $id
2710  * @property-read string $fullname
2711  * @property-read string $shortname
2712  * @property-read string $summary
2713  * @property-read int $summaryformat
2714  * @property-read int $summarytrust
2715  * @property-read string $reason
2716  * @property-read int $requester
2717  */
2718 class course_request {
2720     /**
2721      * This is the stdClass that stores the properties for the course request
2722      * and is externally accessed through the __get magic method
2723      * @var stdClass
2724      */
2725     protected $properties;
2727     /**
2728      * An array of options for the summary editor used by course request forms.
2729      * This is initially set by {@link summary_editor_options()}
2730      * @var array
2731      * @static
2732      */
2733     protected static $summaryeditoroptions;
2735     /**
2736      * Static function to prepare the summary editor for working with a course
2737      * request.
2738      *
2739      * @static
2740      * @param null|stdClass $data Optional, an object containing the default values
2741      *                       for the form, these may be modified when preparing the
2742      *                       editor so this should be called before creating the form
2743      * @return stdClass An object that can be used to set the default values for
2744      *                   an mforms form
2745      */
2746     public static function prepare($data=null) {
2747         if ($data === null) {
2748             $data = new stdClass;
2749         }
2750         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2751         return $data;
2752     }
2754     /**
2755      * Static function to create a new course request when passed an array of properties
2756      * for it.
2757      *
2758      * This function also handles saving any files that may have been used in the editor
2759      *
2760      * @static
2761      * @param stdClass $data
2762      * @return course_request The newly created course request
2763      */
2764     public static function create($data) {
2765         global $USER, $DB, $CFG;
2766         $data->requester = $USER->id;
2768         // Setting the default category if none set.
2769         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2770             $data->category = $CFG->defaultrequestcategory;
2771         }
2773         // Summary is a required field so copy the text over
2774         $data->summary       = $data->summary_editor['text'];
2775         $data->summaryformat = $data->summary_editor['format'];
2777         $data->id = $DB->insert_record('course_request', $data);
2779         // Create a new course_request object and return it
2780         $request = new course_request($data);
2782         // Notify the admin if required.
2783         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2785             $a = new stdClass;
2786             $a->link = "$CFG->wwwroot/course/pending.php";
2787             $a->user = fullname($USER);
2788             $subject = get_string('courserequest');
2789             $message = get_string('courserequestnotifyemail', 'admin', $a);
2790             foreach ($users as $user) {
2791                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2792             }
2793         }
2795         return $request;
2796     }
2798     /**
2799      * Returns an array of options to use with a summary editor
2800      *
2801      * @uses course_request::$summaryeditoroptions
2802      * @return array An array of options to use with the editor
2803      */
2804     public static function summary_editor_options() {
2805         global $CFG;
2806         if (self::$summaryeditoroptions === null) {
2807             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2808         }
2809         return self::$summaryeditoroptions;
2810     }
2812     /**
2813      * Loads the properties for this course request object. Id is required and if
2814      * only id is provided then we load the rest of the properties from the database
2815      *
2816      * @param stdClass|int $properties Either an object containing properties
2817      *                      or the course_request id to load
2818      */
2819     public function __construct($properties) {
2820         global $DB;
2821         if (empty($properties->id)) {
2822             if (empty($properties)) {
2823                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2824             }
2825             $id = $properties;
2826             $properties = new stdClass;
2827             $properties->id = (int)$id;
2828             unset($id);
2829         }
2830         if (empty($properties->requester)) {
2831             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2832                 print_error('unknowncourserequest');
2833             }
2834         } else {
2835             $this->properties = $properties;
2836         }
2837         $this->properties->collision = null;
2838     }
2840     /**
2841      * Returns the requested property
2842      *
2843      * @param string $key
2844      * @return mixed
2845      */
2846     public function __get($key) {
2847         return $this->properties->$key;
2848     }
2850     /**
2851      * Override this to ensure empty($request->blah) calls return a reliable answer...
2852      *
2853      * This is required because we define the __get method
2854      *
2855      * @param mixed $key
2856      * @return bool True is it not empty, false otherwise
2857      */
2858     public function __isset($key) {
2859         return (!empty($this->properties->$key));
2860     }
2862     /**
2863      * Returns the user who requested this course
2864      *
2865      * Uses a static var to cache the results and cut down the number of db queries
2866      *
2867      * @staticvar array $requesters An array of cached users
2868      * @return stdClass The user who requested the course
2869      */
2870     public function get_requester() {
2871         global $DB;
2872         static $requesters= array();
2873         if (!array_key_exists($this->properties->requester, $requesters)) {
2874             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
2875         }
2876         return $requesters[$this->properties->requester];
2877     }
2879     /**
2880      * Checks that the shortname used by the course does not conflict with any other
2881      * courses that exist
2882      *
2883      * @param string|null $shortnamemark The string to append to the requests shortname
2884      *                     should a conflict be found
2885      * @return bool true is there is a conflict, false otherwise
2886      */
2887     public function check_shortname_collision($shortnamemark = '[*]') {
2888         global $DB;
2890         if ($this->properties->collision !== null) {
2891             return $this->properties->collision;
2892         }
2894         if (empty($this->properties->shortname)) {
2895             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
2896             $this->properties->collision = false;
2897         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
2898             if (!empty($shortnamemark)) {
2899                 $this->properties->shortname .= ' '.$shortnamemark;
2900             }
2901             $this->properties->collision = true;
2902         } else {
2903             $this->properties->collision = false;
2904         }
2905         return $this->properties->collision;
2906     }
2908     /**
2909      * Returns the category where this course request should be created
2910      *
2911      * Note that we don't check here that user has a capability to view
2912      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2913      * 'moodle/course:changecategory'
2914      *
2915      * @return core_course_category
2916      */
2917     public function get_category() {
2918         global $CFG;
2919         // If the category is not set, if the current user does not have the rights to change the category, or if the
2920         // category does not exist, we set the default category to the course to be approved.
2921         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2922         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
2923                 (!$category = core_course_category::get($this->properties->category, IGNORE_MISSING, true))) {
2924             $category = core_course_category::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
2925         }
2926         if (!$category) {
2927             $category = core_course_category::get_default();
2928         }
2929         return $category;
2930     }
2932     /**
2933      * This function approves the request turning it into a course
2934      *
2935      * This function converts the course request into a course, at the same time
2936      * transferring any files used in the summary to the new course and then removing
2937      * the course request and the files associated with it.
2938      *
2939      * @return int The id of the course that was created from this request
2940      */
2941     public function approve() {
2942         global $CFG, $DB, $USER;
2944         require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
2946         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
2948         $courseconfig = get_config('moodlecourse');
2950         // Transfer appropriate settings
2951         $data = clone($this->properties);
2952         unset($data->id);
2953         unset($data->reason);
2954         unset($data->requester);
2956         // Set category
2957         $category = $this->get_category();
2958         $data->category = $category->id;
2959         // Set misc settings
2960         $data->requested = 1;
2962         // Apply course default settings
2963         $data->format             = $courseconfig->format;
2964         $data->newsitems          = $courseconfig->newsitems;
2965         $data->showgrades         = $courseconfig->showgrades;
2966         $data->showreports        = $courseconfig->showreports;
2967         $data->maxbytes           = $courseconfig->maxbytes;
2968         $data->groupmode          = $courseconfig->groupmode;
2969         $data->groupmodeforce     = $courseconfig->groupmodeforce;
2970         $data->visible            = $courseconfig->visible;
2971         $data->visibleold         = $data->visible;
2972         $data->lang               = $courseconfig->lang;
2973         $data->enablecompletion   = $courseconfig->enablecompletion;
2974         $data->numsections        = $courseconfig->numsections;
2975         $data->startdate          = usergetmidnight(time());
2976         if ($courseconfig->courseenddateenabled) {
2977             $data->enddate        = usergetmidnight(time()) + $courseconfig->courseduration;
2978         }
2980         list($data->fullname, $data->shortname) = restore_dbops::calculate_course_names(0, $data->fullname, $data->shortname);
2982         $course = create_course($data);
2983         $context = context_course::instance($course->id, MUST_EXIST);
2985         // add enrol instances
2986         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
2987             if ($manual = enrol_get_plugin('manual')) {
2988                 $manual->add_default_instance($course);
2989             }
2990         }
2992         // enrol the requester as teacher if necessary
2993         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2994             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
2995         }
2997         $this->delete();
2999         $a = new stdClass();
3000         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3001         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3002         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a), $course->id);
3004         return $course->id;
3005     }
3007     /**
3008      * Reject a course request
3009      *
3010      * This function rejects a course request, emailing the requesting user the
3011      * provided notice and then removing the request from the database
3012      *
3013      * @param string $notice The message to display to the user
3014      */
3015     public function reject($notice) {
3016         global $USER, $DB;
3017         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
3018         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3019         $this->delete();
3020     }
3022     /**
3023      * Deletes the course request and any associated files
3024      */
3025     public function delete() {
3026         global $DB;
3027         $DB->delete_records('course_request', array('id' => $this->properties->id));
3028     }
3030     /**
3031      * Send a message from one user to another using events_trigger
3032      *
3033      * @param object $touser
3034      * @param object $fromuser
3035      * @param string $name
3036      * @param string $subject
3037      * @param string $message
3038      * @param int|null $courseid
3039      */
3040     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message, $courseid = null) {
3041         $eventdata = new \core\message\message();
3042         $eventdata->courseid          = empty($courseid) ? SITEID : $courseid;
3043         $eventdata->component         = 'moodle';
3044         $eventdata->name              = $name;
3045         $eventdata->userfrom          = $fromuser;
3046         $eventdata->userto            = $touser;
3047         $eventdata->subject           = $subject;
3048         $eventdata->fullmessage       = $message;
3049         $eventdata->fullmessageformat = FORMAT_PLAIN;
3050         $eventdata->fullmessagehtml   = '';
3051         $eventdata->smallmessage      = '';
3052         $eventdata->notification      = 1;
3053         message_send($eventdata);
3054     }
3057 /**
3058  * Return a list of page types
3059  * @param string $pagetype current page type
3060  * @param context $parentcontext Block's parent context
3061  * @param context $currentcontext Current context of block
3062  * @return array array of page types
3063  */
3064 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3065     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
3066         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3067         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3068             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3069         );
3070     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
3071         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3072         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3073     } else {
3074         // Otherwise consider it a page inside a course even if $currentcontext is null
3075         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3076             'course-*' => get_string('page-course-x', 'pagetype'),
3077             'course-view-*' => get_string('page-course-view-x', 'pagetype')
3078         );
3079     }
3080     return $pagetypes;
3083 /**
3084  * Determine whether course ajax should be enabled for the specified course
3085  *
3086  * @param stdClass $course The course to test against
3087  * @return boolean Whether course ajax is enabled or note
3088  */
3089 function course_ajax_enabled($course) {
3090     global $CFG, $PAGE, $SITE;
3092     // The user must be editing for AJAX to be included
3093     if (!$PAGE->user_is_editing()) {
3094         return false;
3095     }
3097     // Check that the theme suports
3098     if (!$PAGE->theme->enablecourseajax) {
3099         return false;
3100     }
3102     // Check that the course format supports ajax functionality
3103     // The site 'format' doesn't have information on course format support
3104     if ($SITE->id !== $course->id) {
3105         $courseformatajaxsupport = course_format_ajax_support($course->format);
3106         if (!$courseformatajaxsupport->capable) {
3107             return false;
3108         }
3109     }
3111     // All conditions have been met so course ajax should be enabled
3112     return true;
3115 /**
3116  * Include the relevant javascript and language strings for the resource
3117  * toolbox YUI module
3118  *
3119  * @param integer $id The ID of the course being applied to
3120  * @param array $usedmodules An array containing the names of the modules in use on the page
3121  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3122  * @param stdClass $config An object containing configuration parameters for ajax modules including:
3123  *          * resourceurl   The URL to post changes to for resource changes
3124  *          * sectionurl    The URL to post changes to for section changes
3125  *          * pageparams    Additional parameters to pass through in the post
3126  * @return bool
3127  */
3128 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3129     global $CFG, $PAGE, $SITE;
3131     // Ensure that ajax should be included
3132     if (!course_ajax_enabled($course)) {
3133         return false;
3134     }
3136     if (!$config) {
3137         $config = new stdClass();
3138     }
3140     // The URL to use for resource changes
3141     if (!isset($config->resourceurl)) {
3142         $config->resourceurl = '/course/rest.php';
3143     }
3145     // The URL to use for section changes
3146     if (!isset($config->sectionurl)) {
3147         $config->sectionurl = '/course/rest.php';
3148     }
3150     // Any additional parameters which need to be included on page submission
3151     if (!isset($config->pageparams)) {
3152         $config->pageparams = array();
3153     }
3155     // Include course dragdrop
3156     if (course_format_uses_sections($course->format)) {
3157         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3158             array(array(
3159                 'courseid' => $course->id,
3160                 'ajaxurl' => $config->sectionurl,
3161                 'config' => $config,
3162             )), null, true);
3164         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3165             array(array(
3166                 'courseid' => $course->id,
3167                 'ajaxurl' => $config->resourceurl,
3168                 'config' => $config,
3169             )), null, true);
3170     }
3172     // Require various strings for the command toolbox
3173     $PAGE->requires->strings_for_js(array(
3174             'moveleft',
3175             'deletechecktype',
3176             'deletechecktypename',
3177             'edittitle',
3178             'edittitleinstructions',
3179             'show',
3180             'hide',
3181             'highlight',
3182             'highlightoff',
3183             'groupsnone',
3184             'groupsvisible',
3185             'groupsseparate',
3186             'clicktochangeinbrackets',
3187             'markthistopic',
3188             'markedthistopic',
3189             'movesection',
3190             'movecoursemodule',
3191             'movecoursesection',
3192             'movecontent',
3193             'tocontent',
3194             'emptydragdropregion',
3195             'afterresource',
3196             'aftersection',
3197             'totopofsection',
3198         ), 'moodle');
3200     // Include section-specific strings for formats which support sections.
3201     if (course_format_uses_sections($course->format)) {
3202         $PAGE->requires->strings_for_js(array(
3203                 'showfromothers',
3204                 'hidefromothers',
3205             ), 'format_' . $course->format);
3206     }
3208     // For confirming resource deletion we need the name of the module in question
3209     foreach ($usedmodules as $module => $modname) {
3210         $PAGE->requires->string_for_js('pluginname', $module);
3211     }
3213     // Load drag and drop upload AJAX.
3214     require_once($CFG->dirroot.'/course/dnduploadlib.php');
3215     dndupload_add_to_course($course, $enabledmodules);
3217     $PAGE->requires->js_call_amd('core_course/actions', 'initCoursePage', array($course->format));
3219     return true;
3222 /**
3223  * Returns the sorted list of available course formats, filtered by enabled if necessary
3224  *
3225  * @param bool $enabledonly return only formats that are enabled
3226  * @return array array of sorted format names
3227  */
3228 function get_sorted_course_formats($enabledonly = false) {
3229     global $CFG;
3230     $formats = core_component::get_plugin_list('format');
3232     if (!empty($CFG->format_plugins_sortorder)) {
3233         $order = explode(',', $CFG->format_plugins_sortorder);
3234         $order = array_merge(array_intersect($order, array_keys($formats)),
3235                     array_diff(array_keys($formats), $order));
3236     } else {
3237         $order = array_keys($formats);
3238     }
3239     if (!$enabledonly) {
3240         return $order;
3241     }
3242     $sortedformats = array();
3243     foreach ($order as $formatname) {
3244         if (!get_config('format_'.$formatname, 'disabled')) {
3245             $sortedformats[] = $formatname;
3246         }
3247     }
3248     return $sortedformats;
3251 /**
3252  * The URL to use for the specified course (with section)
3253  *
3254  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3255  * @param int|stdClass $section Section object from database or just field course_sections.section
3256  *     if omitted the course view page is returned
3257  * @param array $options options for view URL. At the moment core uses:
3258  *     'navigation' (bool) if true and section has no separate page, the function returns null
3259  *     'sr' (int) used by multipage formats to specify to which section to return
3260  * @return moodle_url The url of course
3261  */
3262 function course_get_url($courseorid, $section = null, $options = array()) {
3263     return course_get_format($courseorid)->get_view_url($section, $options);
3266 /**
3267  * Create a module.
3268  *
3269  * It includes:
3270  *      - capability checks and other checks
3271  *      - create the module from the module info
3272  *
3273  * @param object $module
3274  * @return object the created module info
3275  * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3276  */
3277 function create_module($moduleinfo) {
3278     global $DB, $CFG;
3280     require_once($CFG->dirroot . '/course/modlib.php');
3282     // Check manadatory attributs.
3283     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3284     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3285         $mandatoryfields[] = 'introeditor';
3286     }
3287     foreach($mandatoryfields as $mandatoryfield) {
3288         if (!isset($moduleinfo->{$mandatoryfield})) {
3289             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3290         }
3291     }
3293     // Some additional checks (capability / existing instances).
3294     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3295     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3297     // Add the module.
3298     $moduleinfo->module = $module->id;
3299     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3301     return $moduleinfo;
3304 /**
3305  * Update a module.
3306  *
3307  * It includes:
3308  *      - capability and other checks
3309  *      - update the module
3310  *
3311  * @param object $module
3312  * @return object the updated module info
3313  * @throws moodle_exception if current user is not allowed to update the module
3314  */
3315 function update_module($moduleinfo) {
3316     global $DB, $CFG;
3318     require_once($CFG->dirroot . '/course/modlib.php');
3320     // Check the course module exists.
3321     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3323     // Check the course exists.
3324     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3326     // Some checks (capaibility / existing instances).
3327     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3329     // Retrieve few information needed by update_moduleinfo.
3330     $moduleinfo->modulename = $cm->modname;
3331     if (!isset($moduleinfo->scale)) {
3332         $moduleinfo->scale = 0;
3333     }
3334     $moduleinfo->type = 'mod';
3336     // Update the module.
3337     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3339     return $moduleinfo;
3342 /**
3343  * Duplicate a module on the course for ajax.
3344  *
3345  * @see mod_duplicate_module()
3346  * @param object $course The course
3347  * @param object $cm The course module to duplicate
3348  * @param int $sr The section to link back to (used for creating the links)
3349  * @throws moodle_exception if the plugin doesn't support duplication
3350  * @return Object containing:
3351  * - fullcontent: The HTML markup for the created CM
3352  * - cmid: The CMID of the newly created CM
3353  * - redirect: Whether to trigger a redirect following this change
3354  */
3355 function mod_duplicate_activity($course, $cm, $sr = null) {
3356     global $PAGE;
3358     $newcm = duplicate_module($course, $cm);
3360     $resp = new stdClass();
3361     if ($newcm) {
3362         $courserenderer = $PAGE->get_renderer('core', 'course');
3363         $completioninfo = new completion_info($course);
3364         $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3365                 $newcm, null, array());
3367         $resp->fullcontent = $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3368         $resp->cmid = $newcm->id;
3369     } else {
3370         // Trigger a redirect.
3371         $resp->redirect = true;
3372     }
3373     return $resp;
3376 /**
3377  * Api to duplicate a module.
3378  *
3379  * @param object $course course object.
3380  * @param object $cm course module object to be duplicated.
3381  * @since Moodle 2.8
3382  *
3383  * @throws Exception
3384  * @throws coding_exception
3385  * @throws moodle_exception
3386  * @throws restore_controller_exception
3387  *
3388  * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3389  */
3390 function duplicate_module($course, $cm) {
3391     global $CFG, $DB, $USER;
3392     require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
3393     require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
3394     require_once($CFG->libdir . '/filelib.php');
3396     $a          = new stdClass();
3397     $a->modtype = get_string('modulename', $cm->modname);
3398     $a->modname = format_string($cm->name);
3400     if (!plugin_supports('mod', $cm->modname, FEATURE_BACKUP_MOODLE2)) {
3401         throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3402     }
3404     // Backup the activity.
3406     $bc = new backup_controller(backup::TYPE_1ACTIVITY, $cm->id, backup::FORMAT_MOODLE,
3407             backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id);
3409     $backupid       = $bc->get_backupid();
3410     $backupbasepath = $bc->get_plan()->get_basepath();
3412     $bc->execute_plan();
3414     $bc->destroy();
3416     // Restore the backup immediately.
3418     $rc = new restore_controller($backupid, $course->id,
3419             backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id, backup::TARGET_CURRENT_ADDING);
3421     $cmcontext = context_module::instance($cm->id);
3422     if (!$rc->execute_precheck()) {
3423         $precheckresults = $rc->get_precheck_results();
3424         if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3425             if (empty($CFG->keeptempdirectoriesonbackup)) {
3426                 fulldelete($backupbasepath);
3427             }
3428         }
3429     }
3431     $rc->execute_plan();
3433     // Now a bit hacky part follows - we try to get the cmid of the newly
3434     // restored copy of the module.
3435     $newcmid = null;
3436     $tasks = $rc->get_plan()->get_tasks();
3437     foreach ($tasks as $task) {
3438         if (is_subclass_of($task, 'restore_activity_task')) {
3439             if ($task->get_old_contextid() == $cmcontext->id) {
3440                 $newcmid = $task->get_moduleid();
3441                 break;
3442             }
3443         }
3444     }
3446     $rc->destroy();
3448     if (empty($CFG->keeptempdirectoriesonbackup)) {
3449         fulldelete($backupbasepath);
3450     }
3452     // If we know the cmid of the new course module, let us move it
3453     // right below the original one. otherwise it will stay at the
3454     // end of the section.
3455     if ($newcmid) {
3456         // Proceed with activity renaming before everything else. We don't use APIs here to avoid
3457         // triggering a lot of create/update duplicated events.
3458         $newcm = get_coursemodule_from_id($cm->modname, $newcmid, $cm->course);
3459         // Add ' (copy)' to duplicates. Note we don't cleanup or validate lengths here. It comes
3460         // from original name that was valid, so the copy should be too.
3461         $newname = get_string('duplicatedmodule', 'moodle', $newcm->name);
3462         $DB->set_field($cm->modname, 'name', $newname, ['id' => $newcm->instance]);
3464         $section = $DB->get_record('course_sections', array('id' => $cm->section, 'course' => $cm->course));
3465         $modarray = explode(",", trim($section->sequence));
3466         $cmindex = array_search($cm->id, $modarray);
3467         if ($cmindex !== false && $cmindex < count($modarray) - 1) {
3468             moveto_module($newcm, $section, $modarray[$cmindex + 1]);
3469         }
3471         // Update calendar events with the duplicated module.
3472         // The following line is to be removed in MDL-58906.
3473         course_module_update_calendar_events($newcm->modname, null, $newcm);
3475         // Trigger course module created event. We can trigger the event only if we know the newcmid.
3476         $newcm = get_fast_modinfo($cm->course)->get_cm($newcmid);
3477         $event = \core\event\course_module_created::create_from_cm($newcm);
3478         $event->trigger();
3479     }
3481     return isset($newcm) ? $newcm : null;
3484 /**
3485  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3486  * Sorts by descending order of time.
3487  *
3488  * @param stdClass $a First object
3489  * @param stdClass $b Second object
3490  * @return int 0,1,-1 representing the order
3491  */
3492 function compare_activities_by_time_desc($a, $b) {
3493     // Make sure the activities actually have a timestamp property.
3494     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3495         return 0;
3496     }
3497     // We treat instances without timestamp as if they have a timestamp of 0.
3498     if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3499         return 1;
3500     }
3501     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3502         return -1;
3503     }
3504     if ($a->timestamp == $b->timestamp) {
3505         return 0;
3506     }
3507     return ($a->timestamp > $b->timestamp) ? -1 : 1;
3510 /**
3511  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3512  * Sorts by ascending order of time.
3513  *
3514  * @param stdClass $a First object
3515  * @param stdClass $b Second object
3516  * @return int 0,1,-1 representing the order
3517  */
3518 function compare_activities_by_time_asc($a, $b) {
3519     // Make sure the activities actually have a timestamp property.
3520     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3521       return 0;
3522     }
3523     // We treat instances without timestamp as if they have a timestamp of 0.
3524     if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3525         return -1;
3526     }
3527     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3528         return 1;
3529     }
3530     if ($a->timestamp == $b->timestamp) {
3531         return 0;
3532     }
3533     return ($a->timestamp < $b->timestamp) ? -1 : 1;
3536 /**
3537  * Changes the visibility of a course.
3538  *
3539  * @param int $courseid The course to change.
3540  * @param bool $show True to make it visible, false otherwise.
3541  * @return bool
3542  */
3543 function course_change_visibility($courseid, $show = true) {
3544     $course = new stdClass;
3545     $course->id = $courseid;
3546     $course->visible = ($show) ? '1' : '0';
3547     $course->visibleold = $course->visible;
3548     update_course($course);
3549     return true;
3552 /**
3553  * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3554  *
3555  * @param stdClass|core_course_list_element $course
3556  * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3557  * @return bool
3558  */
3559 function course_change_sortorder_by_one($course, $up) {
3560     global $DB;
3561     $params = array($course->sortorder, $course->category);
3562     if ($up) {
3563         $select = 'sortorder < ? AND category = ?';
3564         $sort = 'sortorder DESC';
3565     } else {
3566         $select = 'sortorder > ? AND category = ?';
3567         $sort = 'sortorder ASC';
3568     }
3569     fix_course_sortorder();
3570     $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3571     if ($swapcourse) {
3572         $swapcourse = reset($swapcourse);
3573         $DB->set_field('course', 'sortorder', $swapcourse->sortorder, array('id' => $course->id));
3574         $DB->set_field('course', 'sortorder', $course->sortorder, array('id' => $swapcourse->id));
3575         // Finally reorder courses.
3576         fix_course_sortorder();
3577         cache_helper::purge_by_event('changesincourse');
3578         return true;
3579     }
3580     return false;
3583 /**
3584  * Changes the sort order of courses in a category so that the first course appears after the second.
3585  *
3586  * @param int|stdClass $courseorid The course to focus on.
3587  * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3588  * @return bool
3589  */
3590 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3591     global $DB;
3593     if (!is_object($courseorid)) {
3594         $course = get_course($courseorid);
3595     } else {
3596         $course = $courseorid;
3597     }
3599     if ((int)$moveaftercourseid === 0) {
3600         // We've moving the course to the start of the queue.
3601         $sql = 'SELECT sortorder
3602                       FROM {course}
3603                      WHERE category = :categoryid
3604                   ORDER BY sortorder';
3605         $params = array(
3606             'categoryid' => $course->category
3607         );
3608         $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE);
3610         $sql = 'UPDATE {course}
3611                    SET sortorder = sortorder + 1
3612                  WHERE category = :categoryid
3613                    AND id <> :id';
3614         $params = array(
3615             'categoryid' => $course->category,
3616             'id' => $course->id,
3617         );
3618         $DB->execute($sql, $params);
3619         $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id));
3620     } else if ($course->id === $moveaftercourseid) {
3621         // They're the same - moronic.
3622         debugging("Invalid move after course given.", DEBUG_DEVELOPER);
3623         return false;
3624     } else {
3625         // Moving this course after the given course. It could be before it could be after.
3626         $moveaftercourse = get_course($moveaftercourseid);
3627         if ($course->category !== $moveaftercourse->category) {
3628             debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER);
3629             return false;
3630         }
3631         // Increment all courses in the same category that are ordered after the moveafter course.
3632         // This makes a space for the course we're moving.
3633         $sql = 'UPDATE {course}
3634                        SET sortorder = sortorder + 1
3635                      WHERE category = :categoryid
3636                        AND sortorder > :sortorder';
3637         $params = array(
3638             'categoryid' => $moveaftercourse->category,
3639             'sortorder' => $moveaftercourse->sortorder
3640         );
3641         $DB->execute($sql, $params);
3642         $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder + 1, array('id' => $course->id));
3643     }
3644     fix_course_sortorder();
3645     cache_helper::purge_by_event('changesincourse');
3646     return true;
3649 /**
3650  * Trigger course viewed event. This API function is used when course view actions happens,
3651  * usually in course/view.php but also in external functions.
3652  *
3653  * @param stdClass  $context course context object
3654  * @param int $sectionnumber section number
3655  * @since Moodle 2.9
3656  */
3657 function course_view($context, $sectionnumber = 0) {
3659     $eventdata = array('context' => $context);
3661     if (!empty($sectionnumber)) {
3662         $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3663     }
3665     $event = \core\event\course_viewed::create($eventdata);
3666     $event->trigger();
3669 /**
3670  * Returns courses tagged with a specified tag.
3671  *
3672  * @param core_tag_tag $tag
3673  * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3674  *             are displayed on the page and the per-page limit may be bigger
3675  * @param int $fromctx context id where the link was displayed, may be used by callbacks
3676  *            to display items in the same context first
3677  * @param int $ctx context id where to search for records
3678  * @param bool $rec search in subcontexts as well
3679  * @param int $page 0-based number of page being displayed
3680  * @return \core_tag\output\tagindex
3681  */
3682 function course_get_tagged_courses($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
3683     global $CFG, $PAGE;
3685     $perpage = $exclusivemode ? $CFG->coursesperpage : 5;
3686     $displayoptions = array(
3687         'limit' => $perpage,
3688         'offset' => $page * $perpage,
3689         'viewmoreurl' => null,
3690     );
3692     $courserenderer = $PAGE->get_renderer('core', 'course');
3693     $totalcount = core_course_category::search_courses_count(array('tagid' => $tag->id, 'ctx' => $ctx, 'rec' => $rec));
3694     $content = $courserenderer->tagged_courses($tag->id, $exclusivemode, $ctx, $rec, $displayoptions);
3695     $totalpages = ceil($totalcount / $perpage);
3697     return new core_tag\output\tagindex($tag, 'core', 'course', $content,
3698             $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
3701 /**
3702  * Implements callback inplace_editable() allowing to edit values in-place
3703  *
3704  * @param string $itemtype
3705  * @param int $itemid
3706  * @param mixed $newvalue
3707  * @return \core\output\inplace_editable
3708  */
3709 function core_course_inplace_editable($itemtype, $itemid, $newvalue) {
3710     if ($itemtype === 'activityname') {
3711         return \core_course\output\course_module_name::update($itemid, $newvalue);
3712     }
3715 /**
3716  * This function calculates the minimum and maximum cutoff values for the timestart of
3717  * the given event.
3718  *
3719  * It will return an array with two values, the first being the minimum cutoff value and
3720  * the second being the maximum cutoff value. Either or both values can be null, which
3721  * indicates there is no minimum or maximum, respectively.
3722  *
3723  * If a cutoff is required then the function must return an array containing the cutoff
3724  * timestamp and error string to display to the user if the cutoff value is violated.
3725  *
3726  * A minimum and maximum cutoff return value will look like:
3727  * [
3728  *     [1505704373, 'The date must be after this date'],
3729  *     [1506741172, 'The date must be before this date']
3730  * ]
3731  *
3732  * @param calendar_event $event The calendar event to get the time range for
3733  * @param stdClass $course The course object to get the range from
3734  * @return array Returns an array with min and max date.
3735  */
3736 function core_course_core_calendar_get_valid_event_timestart_range(\calendar_event $event, $course) {
3737     $mindate = null;
3738     $maxdate = null;
3740     if ($course->startdate) {
3741         $mindate = [
3742             $course->startdate,
3743             get_string('errorbeforecoursestart', 'calendar')
3744         ];
3745     }
3747     return [$mindate, $maxdate];
3750 /**
3751  * Returns course modules tagged with a specified tag ready for output on tag/index.php page
3752  *
3753  * This is a callback used by the tag area core/course_modules to search for course modules
3754  * tagged with a specific tag.
3755  *
3756  * @param core_tag_tag $tag
3757  * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3758  *             are displayed on the page and the per-page limit may be bigger
3759  * @param int $fromcontextid context id where the link was displayed, may be used by callbacks
3760  *            to display items in the same context first
3761  * @param int $contextid context id where to search for records
3762  * @param bool $recursivecontext search in subcontexts as well
3763  * @param int $page 0-based number of page being displayed
3764  * @return \core_tag\output\tagindex
3765  */
3766 function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0,
3767                                           $recursivecontext = 1, $page = 0) {
3768     global $OUTPUT;
3769     $perpage = $exclusivemode ? 20 : 5;
3771     // Build select query.
3772     $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
3773     $query = "SELECT cm.id AS cmid, c.id AS courseid, $ctxselect
3774                 FROM {course_modules} cm
3775                 JOIN {tag_instance} tt ON cm.id = tt.itemid
3776                 JOIN {course} c ON cm.course = c.id
3777                 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
3778                WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
3779                 AND cm.deletioninprogress = 0
3780                 AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%";
3782     $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id, 'component' => 'core',
3783         'coursemodulecontextlevel' => CONTEXT_MODULE);
3784     if ($contextid) {
3785         $context = context::instance_by_id($contextid);
3786         $query .= $recursivecontext ? ' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
3787         $params['contextid'] = $context->id;
3788         $params['path'] = $context->path.'/%';
3789     }
3791     $query .= ' ORDER BY';
3792     if ($fromcontextid) {
3793         // In order-clause specify that modules from inside "fromctx" context should be returned first.
3794         $fromcontext = context::instance_by_id($fromcontextid);
3795         $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
3796         $params['fromcontextid'] = $fromcontext->id;
3797         $params['frompath'] = $fromcontext->path.'/%';
3798     }
3799     $query .= ' c.sortorder, cm.id';
3800     $totalpages = $page + 1;
3802     // Use core_tag_index_builder to build and filter the list of items.
3803     // Request one item more than we need so we know if next page exists.
3804     $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage + 1);
3805     while ($item = $builder->has_item_that_needs_access_check()) {
3806         context_helper::preload_from_record($item);
3807         $courseid = $item->courseid;
3808         if (!$builder->can_access_course($courseid)) {
3809             $builder->set_accessible($item, false);
3810             continue;
3811         }
3812         $modinfo = get_fast_modinfo($builder->get_course($courseid));
3813         // Set accessibility of this item and all other items in the same course.
3814         $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
3815             if ($taggeditem->courseid == $courseid) {
3816                 $cm = $modinfo->get_cm($taggeditem->cmid);
3817                 $builder->set_accessible($taggeditem, $cm->uservisible);
3818             }
3819         });
3820     }
3822     $items = $builder->get_items();
3823     if (count($items) > $perpage) {
3824         $totalpages = $page + 2; // We don't need exact page count, just indicate that the next page exists.
3825         array_pop($items);
3826     }
3828     // Build the display contents.
3829     if ($items) {
3830         $tagfeed = new core_tag\output\tagfeed();
3831         foreach ($items as $item) {
3832             context_helper::preload_from_record($item);
3833             $course = $builder->get_course($item->courseid);
3834             $modinfo = get_fast_modinfo($course);
3835             $cm = $modinfo->get_cm($item->cmid);
3836             $courseurl = course_get_url($item->courseid, $cm->sectionnum);
3837             $cmname = $cm->get_formatted_name();
3838             if (!$exclusivemode) {
3839                 $cmname = shorten_text($cmname, 100);
3840             }
3841             $cmname = html_writer::link($cm->url?:$courseurl, $cmname);
3842             $coursename = format_string($course->fullname, true,
3843                     array('context' => context_course::instance($item->courseid)));
3844             $coursename = html_writer::link($courseurl, $coursename);
3845             $icon = html_writer::empty_tag('img', array('src' => $cm->get_icon_url()));
3846             $tagfeed->add($icon, $cmname, $coursename);
3847         }
3849         $content = $OUTPUT->render_from_template('core_tag/tagfeed',
3850                 $tagfeed->export_for_template($OUTPUT));
3852         return new core_tag\output\tagindex($tag, 'core', 'course_modules', $content,
3853                 $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages);
3854     }
3857 /**
3858  * Return an object with the list of navigation options in a course that are avaialable or not for the current user.
3859  * This function also handles the frontpage course.
3860  *
3861  * @param  stdClass $context context object (it can be a course context or the system context for frontpage settings)
3862  * @param  stdClass $course  the course where the settings are being rendered
3863  * @return stdClass          the navigation options in a course and their availability status
3864  * @since  Moodle 3.2
3865  */
3866 function course_get_user_navigation_options($context, $course = null) {
3867     global $CFG;
3869     $isloggedin = isloggedin();
3870     $isguestuser = isguestuser();
3871     $isfrontpage = $context->contextlevel == CONTEXT_SYSTEM;
3873     if ($isfrontpage) {
3874         $sitecontext = $context;
3875     } else {
3876         $sitecontext = context_system::instance();
3877     }
3879     // Sets defaults for all options.
3880     $options = (object) [
3881         'badges' => false,
3882         'blogs' => false,
3883         'calendar' => false,
3884         'competencies' => false,
3885         'grades' => false,
3886         'notes' => false,
3887         'participants' => false,
3888         'search' => false,
3889         'tags' => false,
3890     ];
3892     $options->blogs = !empty($CFG->enableblogs) &&
3893                         ($CFG->bloglevel == BLOG_GLOBAL_LEVEL ||
3894                         ($CFG->bloglevel == BLOG_SITE_LEVEL and ($isloggedin and !$isguestuser)))
3895                         && has_capability('moodle/blog:view', $sitecontext);
3897     $options->notes = !empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $context);
3899     // Frontpage settings?
3900     if ($isfrontpage) {
3901         // We are on the front page, so make sure we use the proper capability (site:viewparticipants).
3902         $options->participants = course_can_view_participants($sitecontext);
3903         $options->badges = !empty($CFG->enablebadges) && has_capability('moodle/badges:viewbadges', $sitecontext);
3904         $options->tags = !empty($CFG->usetags) && $isloggedin;
3905         $options->search = !empty($CFG->enableglobalsearch) && has_capability('moodle/search:query', $sitecontext);
3906         $options->calendar = $isloggedin;
3907     } else {
3908         // We are in a course, so make sure we use the proper capability (course:viewparticipants).
3909         $options->participants = course_can_view_participants($context);
3910         $options->badges = !empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) &&
3911                             has_capability('moodle/badges:viewbadges', $context);
3912         // Add view grade report is permitted.
3913         $grades = false;
3915         if (has_capability('moodle/grade:viewall', $context)) {
3916             $grades = true;
3917         } else if (!empty($course->showgrades)) {
3918             $reports = core_component::get_plugin_list('gradereport');
3919             if (is_array($reports) && count($reports) > 0) {  // Get all installed reports.
3920                 arsort($reports);   // User is last, we want to test it first.
3921                 foreach ($reports as $plugin => $plugindir) {
3922                     if (has_capability('gradereport/'.$plugin.':view', $context)) {
3923                         // Stop when the first visible plugin is found.
3924                         $grades = true;
3925                         break;
3926                     }
3927                 }
3928             }
3929         }
3930         $options->grades = $grades;
3931     }
3933     if (\core_competency\api::is_enabled()) {
3934         $capabilities = array('moodle/competency:coursecompetencyview', 'moodle/competency:coursecompetencymanage');
3935         $options->competencies = has_any_capability($capabilities, $context);
3936     }
3937     return $options;
3940 /**
3941  * Return an object with the list of administration options in a course that are available or not for the current user.
3942  * This function also handles the frontpage settings.
3943  *
3944  * @param  stdClass $course  course object (for frontpage it should be a clone of $SITE)
3945  * @param  stdClass $context context object (course context)
3946  * @return stdClass          the administration options in a course and their availability status
3947  * @since  Moodle 3.2
3948  */
3949 function course_get_user_administration_options($course, $context) {
3950     global $CFG;
3951     $isfrontpage = $course->id == SITEID;
3952     $completionenabled = $CFG->enablecompletion && $course->enablecompletion;
3953     $hascompletiontabs = count(core_completion\manager::get_available_completion_tabs($course, $context)) > 0;
3955     $options = new stdClass;
3956     $options->update = has_capability('moodle/course:update', $context);
3957     $options->editcompletion = $CFG->enablecompletion &&
3958                                $course->enablecompletion &&
3959                                ($options->update || $hascompletiontabs);
3960     $options->filters = has_capability('moodle/filter:manage', $context) &&
3961                         count(filter_get_available_in_context($context)) > 0;
3962     $options->reports = has_capability('moodle/site:viewreports', $context);
3963     $options->backup = has_capability('moodle/backup:backupcourse', $context);
3964     $options->restore = has_capability('moodle/restore:restorecourse', $context);
3965     $options->files = ($course->legacyfiles == 2 && has_capability('moodle/course:managefiles', $context));
3967     if (!$isfrontpage) {
3968         $options->tags = has_capability('moodle/course:tag', $context);
3969         $options->gradebook = has_capability('moodle/grade:manage', $context);
3970         $options->outcomes = !empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $context);
3971         $options->badges = !empty($CFG->enablebadges);
3972         $options->import = has_capability('moodle/restore:restoretargetimport', $context);
3973         $options->publish = has_capability('moodle/course:publish', $context);
3974         $options->reset = has_capability('moodle/course:reset', $context);
3975         $options->roles = has_capability('moodle/role:switchroles', $context);
3976     } else {
3977         // Set default options to false.
3978         $listofoptions = array('tags', 'gradebook', 'outcomes', 'badges', 'import', 'publish', 'reset', 'roles', 'grades');
3980         foreach ($listofoptions as $option) {
3981             $options->$option = false;
3982         }
3983     }
3985     return $options;
3988 /**
3989  * Validates course start and end dates.
3990  *
3991  * Checks that the end course date is not greater than the start course date.
3992  *
3993  * $coursedata['startdate'] or $coursedata['enddate'] may not be set, it depends on the form and user input.
3994  *
3995  * @param array $coursedata May contain startdate and enddate timestamps, depends on the user input.
3996  * @return mixed False if everything alright, error codes otherwise.
3997  */
3998 function course_validate_dates($coursedata) {
4000     // If both start and end dates are set end date should be later than the start date.
4001     if (!empty($coursedata['startdate']) && !empty($coursedata['enddate']) &&
4002             ($coursedata['enddate'] < $coursedata['startdate'])) {
4003         return 'enddatebeforestartdate';
4004     }
4006     // If start date is not set end date can not be set.
4007     if (empty($coursedata['startdate']) && !empty($coursedata['enddate'])) {
4008         return 'nostartdatenoenddate';
4009     }
4011     return false;
4014 /**
4015  * Check for course updates in the given context level instances (only modules supported right Now)
4016  *
4017  * @param  stdClass $course  course object
4018  * @param  array $tocheck    instances to check for updates
4019  * @param  array $filter check only for updates in these areas
4020  * @return array list of warnings and instances with updates information
4021  * @since  Moodle 3.2
4022  */
4023 function course_check_updates($course, $tocheck, $filter = array()) {
4024     global $CFG, $DB;
4026     $instances = array();
4027     $warnings = array();
4028     $modulescallbacksupport = array();
4029     $modinfo = get_fast_modinfo($course);
4031     $supportedplugins = get_plugin_list_with_function('mod', 'check_updates_since');
4033     // Check instances.
4034     foreach ($tocheck as $instance) {
4035         if ($instance['contextlevel'] == 'module') {
4036             // Check module visibility.
4037             try {
4038                 $cm = $modinfo->get_cm($instance['id']);
4039             } catch (Exception $e) {
4040                 $warnings[] = array(
4041                     'item' => 'module',
4042                     'itemid' => $instance['id'],
4043                     'warningcode' => 'cmidnotincourse',
4044                     'message' => 'This module id does not belong to this course.'
4045                 );
4046                 continue;
4047             }
4049             if (!$cm->uservisible) {
4050                 $warnings[] = array(
4051                     'item' => 'module',
4052                     'itemid' => $instance['id'],
4053                     'warningcode' => 'nonuservisible',
4054                     'message' => 'You don\'t have access to this module.'
4055                 );
4056                 continue;
4057             }
4058             if (empty($supportedplugins['mod_' . $cm->modname])) {
4059                 $warnings[] = array(
4060                     'item' => 'module',
4061                     'itemid' => $instance['id'],
4062                     'warningcode' => 'missingcallback',
4063                     'message' => 'This module does not implement the check_updates_since callback: ' . $instance['contextlevel'],
4064                 );
4065                 continue;
4066             }
4067             // Retrieve the module instance.
4068             $instances[] = array(
4069                 'contextlevel' => $instance['contextlevel'],
4070                 'id' => $instance['id'],
4071                 'updates' => call_user_func($cm->modname . '_check_updates_since', $cm, $instance['since'], $filter)
4072             );
4074         } else {
4075             $warnings[] = array(
4076                 'item' => 'contextlevel',
4077                 'itemid' => $instance['id'],
4078                 'warningcode' => 'contextlevelnotsupported',
4079                 'message' => 'Context level not yet supported ' . $instance['contextlevel'],
4080             );
4081         }
4082     }
4083     return array($instances, $warnings);
4086 /**
4087  * This function classifies a course as past, in progress or future.
4088  *
4089  * This function may incur a DB hit to calculate course completion.
4090  * @param stdClass $course Course record
4091  * @param stdClass $user User record (optional - defaults to $USER).
4092  * @param completion_info $completioninfo Completion record for the user (optional - will be fetched if required).
4093  * @return string (one of COURSE_TIMELINE_FUTURE, COURSE_TIMELINE_INPROGRESS or COURSE_TIMELINE_PAST)
4094  */
4095 function course_classify_for_timeline($course, $user = null, $completioninfo = null) {
4096     global $USER;
4098     if ($user == null) {
4099         $user = $USER;
4100     }
4102     $today = time();
4103     // End date past.
4104     if (!empty($course->enddate) && (course_classify_end_date($course) < $today)) {
4105         return COURSE_TIMELINE_PAST;
4106     }
4108     if ($completioninfo == null) {
4109         $completioninfo = new completion_info($course);
4110     }
4112     // Course was completed.
4113     if ($completioninfo->is_enabled() && $completioninfo->is_course_complete($user->id)) {
4114         return COURSE_TIMELINE_PAST;
4115     }
4117     // Start date not reached.
4118     if (!empty($course->startdate) && (course_classify_start_date($course) > $today)) {
4119         return COURSE_TIMELINE_FUTURE;
4120     }
4122     // Everything else is in progress.
4123     return COURSE_TIMELINE_INPROGRESS;
4126 /**
4127  * This function calculates the end date to use for display classification purposes,
4128  * incorporating the grace period, if any.
4129  *
4130  * @param stdClass $course The course record.
4131  * @return int The new enddate.
4132  */
4133 function course_classify_end_date($course) {
4134     global $CFG;
4135     $coursegraceperiodafter = (empty($CFG->coursegraceperiodafter)) ? 0 : $CFG->coursegraceperiodafter;
4136     $enddate = (new \DateTimeImmutable())->setTimestamp($course->enddate)->modify("+{$coursegraceperiodafter} days");
4137     return $enddate->getTimestamp();
4140 /**
4141  * This function calculates the start date to use for display classification purposes,
4142  * incorporating the grace period, if any.
4143  *
4144  * @param stdClass $course The course record.
4145  * @return int The new startdate.
4146  */
4147 function course_classify_start_date($course) {
4148     global $CFG;
4149     $coursegraceperiodbefore = (empty($CFG->coursegraceperiodbefore)) ? 0 : $CFG->coursegraceperiodbefore;
4150     $startdate = (new \DateTimeImmutable())->setTimestamp($course->startdate)->modify("-{$coursegraceperiodbefore} days");
4151     return $startdate->getTimestamp();
4154 /**
4155  * Group a list of courses into either past, future, or in progress.
4156  *
4157  * The return value will be an array indexed by the COURSE_TIMELINE_* constants
4158  * with each value being an array of courses in that group.
4159  * E.g.
4160  * [
4161  *      COURSE_TIMELINE_PAST => [... list of past courses ...],
4162  *      COURSE_TIMELINE_FUTURE => [],
4163  *      COURSE_TIMELINE_INPROGRESS => []
4164  * ]
4165  *
4166  * @param array $courses List of courses to be grouped.
4167  * @return array
4168  */
4169 function course_classify_courses_for_timeline(array $courses) {
4170     return array_reduce($courses, function($carry, $course) {
4171         $classification = course_classify_for_timeline($course);
4172         array_push($carry[$classification], $course);
4174         return $carry;
4175     }, [
4176         COURSE_TIMELINE_PAST => [],
4177         COURSE_TIMELINE_FUTURE => [],
4178         COURSE_TIMELINE_INPROGRESS => []
4179     ]);
4182 /**
4183  * Get the list of enrolled courses for the current user.
4184  *
4185  * This function returns a Generator. The courses will be loaded from the database
4186  * in chunks rather than a single query.
4187  *
4188  * @param int $limit Restrict result set to this amount
4189  * @param int $offset Skip this number of records from the start of the result set
4190  * @param string|null $sort SQL string for sorting
4191  * @param string|null $fields SQL string for fields to be returned
4192  * @param int $dbquerylimit The number of records to load per DB request
4193  * @return Generator
4194  */
4195 function course_get_enrolled_courses_for_logged_in_user(
4196     int $limit = 0,
4197     int $offset = 0,
4198     string $sort = null,
4199     string $fields = null,
4200     int $dbquerylimit = COURSE_DB_QUERY_LIMIT
4201 ) : Generator {
4203     $haslimit = !empty($limit);
4204     $recordsloaded = 0;
4205     $querylimit = (!$haslimit || $limit > $dbquerylimit) ? $dbquerylimit : $limit;
4207     while ($courses = enrol_get_my_courses($fields, $sort, $querylimit, [], false, $offset)) {
4208         yield from $courses;
4210         $recordsloaded += $querylimit;
4212         if (count($courses) < $querylimit) {
4213             break;
4214         }
4215         if ($haslimit && $recordsloaded >= $limit) {
4216             break;
4217         }
4219         $offset += $querylimit;
4220     }
4223 /**
4224  * Search the given $courses for any that match the given $classification up to the specified
4225  * $limit.
4226  *
4227  * This function will return the subset of cou