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