MDL-55074 theme_boost: Navigation and blocks
[moodle.git] / course / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Library of useful functions
19  *
20  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
21  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  * @package core_course
23  */
25 defined('MOODLE_INTERNAL') || die;
27 require_once($CFG->libdir.'/completionlib.php');
28 require_once($CFG->libdir.'/filelib.php');
29 require_once($CFG->dirroot.'/course/format/lib.php');
31 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // Records.
32 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds.
34 /**
35  * Number of courses to display when summaries are included.
36  * @var int
37  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
38  */
39 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
41 // Max courses in log dropdown before switching to optional.
42 define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
43 // Max users in log dropdown before switching to optional.
44 define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
45 define('FRONTPAGENEWS', '0');
46 define('FRONTPAGECATEGORYNAMES', '2');
47 define('FRONTPAGECATEGORYCOMBO', '4');
48 define('FRONTPAGEENROLLEDCOURSELIST', '5');
49 define('FRONTPAGEALLCOURSELIST', '6');
50 define('FRONTPAGECOURSESEARCH', '7');
51 // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 function make_log_url($module, $url) {
59     switch ($module) {
60         case 'course':
61             if (strpos($url, 'report/') === 0) {
62                 // there is only one report type, course reports are deprecated
63                 $url = "/$url";
64                 break;
65             }
66         case 'file':
67         case 'login':
68         case 'lib':
69         case 'admin':
70         case 'category':
71         case 'mnet course':
72             if (strpos($url, '../') === 0) {
73                 $url = ltrim($url, '.');
74             } else {
75                 $url = "/course/$url";
76             }
77             break;
78         case 'calendar':
79             $url = "/calendar/$url";
80             break;
81         case 'user':
82         case 'blog':
83             $url = "/$module/$url";
84             break;
85         case 'upload':
86             $url = $url;
87             break;
88         case 'coursetags':
89             $url = '/'.$url;
90             break;
91         case 'library':
92         case '':
93             $url = '/';
94             break;
95         case 'message':
96             $url = "/message/$url";
97             break;
98         case 'notes':
99             $url = "/notes/$url";
100             break;
101         case 'tag':
102             $url = "/tag/$url";
103             break;
104         case 'role':
105             $url = '/'.$url;
106             break;
107         case 'grade':
108             $url = "/grade/$url";
109             break;
110         default:
111             $url = "/mod/$module/$url";
112             break;
113     }
115     //now let's sanitise urls - there might be some ugly nasties:-(
116     $parts = explode('?', $url);
117     $script = array_shift($parts);
118     if (strpos($script, 'http') === 0) {
119         $script = clean_param($script, PARAM_URL);
120     } else {
121         $script = clean_param($script, PARAM_PATH);
122     }
124     $query = '';
125     if ($parts) {
126         $query = implode('', $parts);
127         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
128         $parts = explode('&', $query);
129         $eq = urlencode('=');
130         foreach ($parts as $key=>$part) {
131             $part = urlencode(urldecode($part));
132             $part = str_replace($eq, '=', $part);
133             $parts[$key] = $part;
134         }
135         $query = '?'.implode('&amp;', $parts);
136     }
138     return $script.$query;
142 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
143                    $modname="", $modid=0, $modaction="", $groupid=0) {
144     global $CFG, $DB;
146     // It is assumed that $date is the GMT time of midnight for that day,
147     // and so the next 86400 seconds worth of logs are printed.
149     /// Setup for group handling.
151     // TODO: I don't understand group/context/etc. enough to be able to do
152     // something interesting with it here
153     // What is the context of a remote course?
155     /// If the group mode is separate, and this user does not have editing privileges,
156     /// then only the user's group can be viewed.
157     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
158     //    $groupid = get_current_group($course->id);
159     //}
160     /// If this course doesn't have groups, no groupid can be specified.
161     //else if (!$course->groupmode) {
162     //    $groupid = 0;
163     //}
165     $groupid = 0;
167     $joins = array();
168     $where = '';
170     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
171               FROM {mnet_log} l
172                LEFT JOIN {user} u ON l.userid = u.id
173               WHERE ";
174     $params = array();
176     $where .= "l.hostid = :hostid";
177     $params['hostid'] = $hostid;
179     // TODO: Is 1 really a magic number referring to the sitename?
180     if ($course != SITEID || $modid != 0) {
181         $where .= " AND l.course=:courseid";
182         $params['courseid'] = $course;
183     }
185     if ($modname) {
186         $where .= " AND l.module = :modname";
187         $params['modname'] = $modname;
188     }
190     if ('site_errors' === $modid) {
191         $where .= " AND ( l.action='error' OR l.action='infected' )";
192     } else if ($modid) {
193         //TODO: This assumes that modids are the same across sites... probably
194         //not true
195         $where .= " AND l.cmid = :modid";
196         $params['modid'] = $modid;
197     }
199     if ($modaction) {
200         $firstletter = substr($modaction, 0, 1);
201         if ($firstletter == '-') {
202             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
203             $params['modaction'] = '%'.substr($modaction, 1).'%';
204         } else {
205             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
206             $params['modaction'] = '%'.$modaction.'%';
207         }
208     }
210     if ($user) {
211         $where .= " AND l.userid = :user";
212         $params['user'] = $user;
213     }
215     if ($date) {
216         $enddate = $date + 86400;
217         $where .= " AND l.time > :date AND l.time < :enddate";
218         $params['date'] = $date;
219         $params['enddate'] = $enddate;
220     }
222     $result = array();
223     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
224     if(!empty($result['totalcount'])) {
225         $where .= " ORDER BY $order";
226         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
227     } else {
228         $result['logs'] = array();
229     }
230     return $result;
233 /**
234  * Checks the integrity of the course data.
235  *
236  * In summary - compares course_sections.sequence and course_modules.section.
237  *
238  * More detailed, checks that:
239  * - course_sections.sequence contains each module id not more than once in the course
240  * - for each moduleid from course_sections.sequence the field course_modules.section
241  *   refers to the same section id (this means course_sections.sequence is more
242  *   important if they are different)
243  * - ($fullcheck only) each module in the course is present in one of
244  *   course_sections.sequence
245  * - ($fullcheck only) removes non-existing course modules from section sequences
246  *
247  * If there are any mismatches, the changes are made and records are updated in DB.
248  *
249  * Course cache is NOT rebuilt if there are any errors!
250  *
251  * This function is used each time when course cache is being rebuilt with $fullcheck = false
252  * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
253  *
254  * @param int $courseid id of the course
255  * @param array $rawmods result of funciton {@link get_course_mods()} - containst
256  *     the list of enabled course modules in the course. Retrieved from DB if not specified.
257  *     Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
258  * @param array $sections records from course_sections table for this course.
259  *     Retrieved from DB if not specified
260  * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
261  *     course modules from sequences. Only to be used in site maintenance mode when we are
262  *     sure that another user is not in the middle of the process of moving/removing a module.
263  * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
264  * @return array array of messages with found problems. Empty output means everything is ok
265  */
266 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
267     global $DB;
268     $messages = array();
269     if ($sections === null) {
270         $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
271     }
272     if ($fullcheck) {
273         // Retrieve all records from course_modules regardless of module type visibility.
274         $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
275     }
276     if ($rawmods === null) {
277         $rawmods = get_course_mods($courseid);
278     }
279     if (!$fullcheck && (empty($sections) || empty($rawmods))) {
280         // If either of the arrays is empty, no modules are displayed anyway.
281         return true;
282     }
283     $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
285     // First make sure that each module id appears in section sequences only once.
286     // If it appears in several section sequences the last section wins.
287     // If it appears twice in one section sequence, the first occurence wins.
288     $modsection = array();
289     foreach ($sections as $sectionid => $section) {
290         $sections[$sectionid]->newsequence = $section->sequence;
291         if (!empty($section->sequence)) {
292             $sequence = explode(",", $section->sequence);
293             $sequenceunique = array_unique($sequence);
294             if (count($sequenceunique) != count($sequence)) {
295                 // Some course module id appears in this section sequence more than once.
296                 ksort($sequenceunique); // Preserve initial order of modules.
297                 $sequence = array_values($sequenceunique);
298                 $sections[$sectionid]->newsequence = join(',', $sequence);
299                 $messages[] = $debuggingprefix.'Sequence for course section ['.
300                         $sectionid.'] is "'.$sections[$sectionid]->sequence.'", must be "'.$sections[$sectionid]->newsequence.'"';
301             }
302             foreach ($sequence as $cmid) {
303                 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
304                     // Some course module id appears to be in more than one section's sequences.
305                     $wrongsectionid = $modsection[$cmid];
306                     $sections[$wrongsectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence. ','), ',');
307                     $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
308                             $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
309                 }
310                 $modsection[$cmid] = $sectionid;
311             }
312         }
313     }
315     // Add orphaned modules to their sections if they exist or to section 0 otherwise.
316     if ($fullcheck) {
317         foreach ($rawmods as $cmid => $mod) {
318             if (!isset($modsection[$cmid])) {
319                 // This is a module that is not mentioned in course_section.sequence at all.
320                 // Add it to the section $mod->section or to the last available section.
321                 if ($mod->section && isset($sections[$mod->section])) {
322                     $modsection[$cmid] = $mod->section;
323                 } else {
324                     $firstsection = reset($sections);
325                     $modsection[$cmid] = $firstsection->id;
326                 }
327                 $sections[$modsection[$cmid]]->newsequence = trim($sections[$modsection[$cmid]]->newsequence.','.$cmid, ',');
328                 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
329                         $modsection[$cmid].']';
330             }
331         }
332         foreach ($modsection as $cmid => $sectionid) {
333             if (!isset($rawmods[$cmid])) {
334                 // Section $sectionid refers to module id that does not exist.
335                 $sections[$sectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence.','), ',');
336                 $messages[] = $debuggingprefix.'Course module ['.$cmid.
337                         '] does not exist but is present in the sequence of section ['.$sectionid.']';
338             }
339         }
340     }
342     // Update changed sections.
343     if (!$checkonly && !empty($messages)) {
344         foreach ($sections as $sectionid => $section) {
345             if ($section->newsequence !== $section->sequence) {
346                 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence));
347             }
348         }
349     }
351     // Now make sure that all modules point to the correct sections.
352     foreach ($rawmods as $cmid => $mod) {
353         if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section) {
354             if (!$checkonly) {
355                 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
356             }
357             $messages[] = $debuggingprefix.'Course module ['.$cmid.
358                     '] points to section ['.$mod->section.'] instead of ['.$modsection[$cmid].']';
359         }
360     }
362     return $messages;
365 /**
366  * For a given course, returns an array of course activity objects
367  * Each item in the array contains he following properties:
368  */
369 function get_array_of_activities($courseid) {
370 //  cm - course module id
371 //  mod - name of the module (eg forum)
372 //  section - the number of the section (eg week or topic)
373 //  name - the name of the instance
374 //  visible - is the instance visible or not
375 //  groupingid - grouping id
376 //  extra - contains extra string to include in any link
377     global $CFG, $DB;
379     $course = $DB->get_record('course', array('id'=>$courseid));
381     if (empty($course)) {
382         throw new moodle_exception('courseidnotfound');
383     }
385     $mod = array();
387     $rawmods = get_course_mods($courseid);
388     if (empty($rawmods)) {
389         return $mod; // always return array
390     }
392     if ($sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence')) {
393         // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
394         if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
395             debugging(join('<br>', $errormessages));
396             $rawmods = get_course_mods($courseid);
397             $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence');
398         }
399         // Build array of activities.
400        foreach ($sections as $section) {
401            if (!empty($section->sequence)) {
402                $sequence = explode(",", $section->sequence);
403                foreach ($sequence as $seq) {
404                    if (empty($rawmods[$seq])) {
405                        continue;
406                    }
407                    $mod[$seq] = new stdClass();
408                    $mod[$seq]->id               = $rawmods[$seq]->instance;
409                    $mod[$seq]->cm               = $rawmods[$seq]->id;
410                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
412                     // Oh dear. Inconsistent names left here for backward compatibility.
413                    $mod[$seq]->section          = $section->section;
414                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
416                    $mod[$seq]->module           = $rawmods[$seq]->module;
417                    $mod[$seq]->added            = $rawmods[$seq]->added;
418                    $mod[$seq]->score            = $rawmods[$seq]->score;
419                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
420                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
421                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
422                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
423                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
424                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
425                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
426                    $mod[$seq]->extra            = "";
427                    $mod[$seq]->completiongradeitemnumber =
428                            $rawmods[$seq]->completiongradeitemnumber;
429                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
430                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
431                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
432                    $mod[$seq]->availability = $rawmods[$seq]->availability;
434                    $modname = $mod[$seq]->mod;
435                    $functionname = $modname."_get_coursemodule_info";
437                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
438                        continue;
439                    }
441                    include_once("$CFG->dirroot/mod/$modname/lib.php");
443                    if ($hasfunction = function_exists($functionname)) {
444                        if ($info = $functionname($rawmods[$seq])) {
445                            if (!empty($info->icon)) {
446                                $mod[$seq]->icon = $info->icon;
447                            }
448                            if (!empty($info->iconcomponent)) {
449                                $mod[$seq]->iconcomponent = $info->iconcomponent;
450                            }
451                            if (!empty($info->name)) {
452                                $mod[$seq]->name = $info->name;
453                            }
454                            if ($info instanceof cached_cm_info) {
455                                // When using cached_cm_info you can include three new fields
456                                // that aren't available for legacy code
457                                if (!empty($info->content)) {
458                                    $mod[$seq]->content = $info->content;
459                                }
460                                if (!empty($info->extraclasses)) {
461                                    $mod[$seq]->extraclasses = $info->extraclasses;
462                                }
463                                if (!empty($info->iconurl)) {
464                                    // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
465                                    $url = new moodle_url($info->iconurl);
466                                    $mod[$seq]->iconurl = $url->out(false);
467                                }
468                                if (!empty($info->onclick)) {
469                                    $mod[$seq]->onclick = $info->onclick;
470                                }
471                                if (!empty($info->customdata)) {
472                                    $mod[$seq]->customdata = $info->customdata;
473                                }
474                            } else {
475                                // When using a stdclass, the (horrible) deprecated ->extra field
476                                // is available for BC
477                                if (!empty($info->extra)) {
478                                    $mod[$seq]->extra = $info->extra;
479                                }
480                            }
481                        }
482                    }
483                    // When there is no modname_get_coursemodule_info function,
484                    // but showdescriptions is enabled, then we use the 'intro'
485                    // and 'introformat' fields in the module table
486                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
487                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
488                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
489                            // Set content from intro and introformat. Filters are disabled
490                            // because we  filter it with format_text at display time
491                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
492                                    $modvalues, $rawmods[$seq]->id, false);
494                            // To save making another query just below, put name in here
495                            $mod[$seq]->name = $modvalues->name;
496                        }
497                    }
498                    if (!isset($mod[$seq]->name)) {
499                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
500                    }
502                     // Minimise the database size by unsetting default options when they are
503                     // 'empty'. This list corresponds to code in the cm_info constructor.
504                     foreach (array('idnumber', 'groupmode', 'groupingid',
505                             'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
506                             'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
507                             'completionexpected', 'score', 'showdescription') as $property) {
508                        if (property_exists($mod[$seq], $property) &&
509                                empty($mod[$seq]->{$property})) {
510                            unset($mod[$seq]->{$property});
511                        }
512                    }
513                    // Special case: this value is usually set to null, but may be 0
514                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
515                            is_null($mod[$seq]->completiongradeitemnumber)) {
516                        unset($mod[$seq]->completiongradeitemnumber);
517                    }
518                }
519             }
520         }
521     }
522     return $mod;
525 /**
526  * Returns the localised human-readable names of all used modules
527  *
528  * @param bool $plural if true returns the plural forms of the names
529  * @return array where key is the module name (component name without 'mod_') and
530  *     the value is the human-readable string. Array sorted alphabetically by value
531  */
532 function get_module_types_names($plural = false) {
533     static $modnames = null;
534     global $DB, $CFG;
535     if ($modnames === null) {
536         $modnames = array(0 => array(), 1 => array());
537         if ($allmods = $DB->get_records("modules")) {
538             foreach ($allmods as $mod) {
539                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
540                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
541                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
542                 }
543             }
544             core_collator::asort($modnames[0]);
545             core_collator::asort($modnames[1]);
546         }
547     }
548     return $modnames[(int)$plural];
551 /**
552  * Set highlighted section. Only one section can be highlighted at the time.
553  *
554  * @param int $courseid course id
555  * @param int $marker highlight section with this number, 0 means remove higlightin
556  * @return void
557  */
558 function course_set_marker($courseid, $marker) {
559     global $DB;
560     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
561     format_base::reset_course_cache($courseid);
564 /**
565  * For a given course section, marks it visible or hidden,
566  * and does the same for every activity in that section
567  *
568  * @param int $courseid course id
569  * @param int $sectionnumber The section number to adjust
570  * @param int $visibility The new visibility
571  * @return array A list of resources which were hidden in the section
572  */
573 function set_section_visible($courseid, $sectionnumber, $visibility) {
574     global $DB;
576     $resourcestotoggle = array();
577     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
578         course_update_section($courseid, $section, array('visible' => $visibility));
580         // Determine which modules are visible for AJAX update
581         $modules = !empty($section->sequence) ? explode(',', $section->sequence) : array();
582         if (!empty($modules)) {
583             list($insql, $params) = $DB->get_in_or_equal($modules);
584             $select = 'id ' . $insql . ' AND visible = ?';
585             array_push($params, $visibility);
586             if (!$visibility) {
587                 $select .= ' AND visibleold = 1';
588             }
589             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
590         }
591     }
592     return $resourcestotoggle;
595 /**
596  * Retrieve all metadata for the requested modules
597  *
598  * @param object $course The Course
599  * @param array $modnames An array containing the list of modules and their
600  * names
601  * @param int $sectionreturn The section to return to
602  * @return array A list of stdClass objects containing metadata about each
603  * module
604  */
605 function get_module_metadata($course, $modnames, $sectionreturn = null) {
606     global $OUTPUT;
608     // get_module_metadata will be called once per section on the page and courses may show
609     // different modules to one another
610     static $modlist = array();
611     if (!isset($modlist[$course->id])) {
612         $modlist[$course->id] = array();
613     }
615     $return = array();
616     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
617     if ($sectionreturn !== null) {
618         $urlbase->param('sr', $sectionreturn);
619     }
620     foreach($modnames as $modname => $modnamestr) {
621         if (!course_allowed_module($course, $modname)) {
622             continue;
623         }
624         if (isset($modlist[$course->id][$modname])) {
625             // This module is already cached
626             $return += $modlist[$course->id][$modname];
627             continue;
628         }
629         $modlist[$course->id][$modname] = array();
631         // Create an object for a default representation of this module type in the activity chooser. It will be used
632         // if module does not implement callback get_shortcuts() and it will also be passed to the callback if it exists.
633         $defaultmodule = new stdClass();
634         $defaultmodule->title = $modnamestr;
635         $defaultmodule->name = $modname;
636         $defaultmodule->link = new moodle_url($urlbase, array('add' => $modname));
637         $defaultmodule->icon = $OUTPUT->pix_icon('icon', '', $defaultmodule->name, array('class' => 'icon'));
638         $sm = get_string_manager();
639         if ($sm->string_exists('modulename_help', $modname)) {
640             $defaultmodule->help = get_string('modulename_help', $modname);
641             if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs.
642                 $link = get_string('modulename_link', $modname);
643                 $linktext = get_string('morehelp');
644                 $defaultmodule->help .= html_writer::tag('div',
645                     $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
646             }
647         }
648         $defaultmodule->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
650         // Legacy support for callback get_types() - do not use any more, use get_shortcuts() instead!
651         $typescallbackexists = component_callback_exists($modname, 'get_types');
653         // Each module can implement callback modulename_get_shortcuts() in its lib.php and return the list
654         // of elements to be added to activity chooser.
655         $items = component_callback($modname, 'get_shortcuts', array($defaultmodule), null);
656         if ($items !== null) {
657             foreach ($items as $item) {
658                 // Add all items to the return array. All items must have different links, use them as a key in the return array.
659                 if (!isset($item->archetype)) {
660                     $item->archetype = $defaultmodule->archetype;
661                 }
662                 if (!isset($item->icon)) {
663                     $item->icon = $defaultmodule->icon;
664                 }
665                 // If plugin returned the only one item with the same link as default item - cache it as $modname,
666                 // otherwise append the link url to the module name.
667                 $item->name = (count($items) == 1 &&
668                     $item->link->out() === $defaultmodule->link->out()) ? $modname : $modname . ':' . $item->link;
670                 // If the module provides the helptext property, append it to the help text to match the look and feel
671                 // of the default course modules.
672                 if (isset($item->help) && isset($item->helplink)) {
673                     $linktext = get_string('morehelp');
674                     $item->help .= html_writer::tag('div',
675                         $OUTPUT->doc_link($item->helplink, $linktext, true), array('class' => 'helpdoclink'));
676                 }
677                 $modlist[$course->id][$modname][$item->name] = $item;
678             }
679             $return += $modlist[$course->id][$modname];
680             if ($typescallbackexists) {
681                 debugging('Both callbacks get_shortcuts() and get_types() are found in module ' . $modname .
682                     '. Callback get_types() will be completely ignored', DEBUG_DEVELOPER);
683             }
684             // If get_shortcuts() callback is defined, the default module action is not added.
685             // It is a responsibility of the callback to add it to the return value unless it is not needed.
686             continue;
687         }
689         if ($typescallbackexists) {
690             debugging('Callback get_types() is found in module ' . $modname . ', this functionality is deprecated, ' .
691                 'please use callback get_shortcuts() instead', DEBUG_DEVELOPER);
692         }
693         $types = component_callback($modname, 'get_types', array(), MOD_SUBTYPE_NO_CHILDREN);
694         if ($types !== MOD_SUBTYPE_NO_CHILDREN) {
695             // Legacy support for deprecated callback get_types(). To be removed in Moodle 3.5. TODO MDL-53697.
696             if (is_array($types) && count($types) > 0) {
697                 $grouptitle = $modnamestr;
698                 $icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
699                 foreach($types as $type) {
700                     if ($type->typestr === '--') {
701                         continue;
702                     }
703                     if (strpos($type->typestr, '--') === 0) {
704                         $grouptitle = str_replace('--', '', $type->typestr);
705                         continue;
706                     }
707                     // Set the Sub Type metadata.
708                     $subtype = new stdClass();
709                     $subtype->title = get_string('activitytypetitle', '',
710                         (object)['activity' => $grouptitle, 'type' => $type->typestr]);
711                     $subtype->type = str_replace('&amp;', '&', $type->type);
712                     $typename = preg_replace('/.*type=/', '', $subtype->type);
713                     $subtype->archetype = $type->modclass;
715                     if (!empty($type->help)) {
716                         $subtype->help = $type->help;
717                     } else if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
718                         $subtype->help = get_string('help' . $subtype->name, $modname);
719                     }
720                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $typename));
721                     $subtype->name = $modname . ':' . $subtype->link;
722                     $subtype->icon = $icon;
723                     $modlist[$course->id][$modname][$subtype->name] = $subtype;
724                 }
725                 $return += $modlist[$course->id][$modname];
726             }
727         } else {
728             // Neither get_shortcuts() nor get_types() callbacks found, use the default item for the activity chooser.
729             $modlist[$course->id][$modname][$modname] = $defaultmodule;
730             $return[$modname] = $defaultmodule;
731         }
732     }
734     core_collator::asort_objects_by_property($return, 'title');
735     return $return;
738 /**
739  * Return the course category context for the category with id $categoryid, except
740  * that if $categoryid is 0, return the system context.
741  *
742  * @param integer $categoryid a category id or 0.
743  * @return context the corresponding context
744  */
745 function get_category_or_system_context($categoryid) {
746     if ($categoryid) {
747         return context_coursecat::instance($categoryid, IGNORE_MISSING);
748     } else {
749         return context_system::instance();
750     }
753 /**
754  * Returns full course categories trees to be used in html_writer::select()
755  *
756  * Calls {@link coursecat::make_categories_list()} to build the tree and
757  * adds whitespace to denote nesting
758  *
759  * @return array array mapping coursecat id to the display name
760  */
761 function make_categories_options() {
762     global $CFG;
763     require_once($CFG->libdir. '/coursecatlib.php');
764     $cats = coursecat::make_categories_list('', 0, ' / ');
765     foreach ($cats as $key => $value) {
766         // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
767         $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
768     }
769     return $cats;
772 /**
773  * Print the buttons relating to course requests.
774  *
775  * @param object $context current page context.
776  */
777 function print_course_request_buttons($context) {
778     global $CFG, $DB, $OUTPUT;
779     if (empty($CFG->enablecourserequests)) {
780         return;
781     }
782     if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
783     /// Print a button to request a new course
784         echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
785     }
786     /// Print a button to manage pending requests
787     if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
788         $disabled = !$DB->record_exists('course_request', array());
789         echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
790     }
793 /**
794  * Does the user have permission to edit things in this category?
795  *
796  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
797  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
798  */
799 function can_edit_in_category($categoryid = 0) {
800     $context = get_category_or_system_context($categoryid);
801     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
804 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
806 function add_course_module($mod) {
807     global $DB;
809     $mod->added = time();
810     unset($mod->id);
812     $cmid = $DB->insert_record("course_modules", $mod);
813     rebuild_course_cache($mod->course, true);
814     return $cmid;
817 /**
818  * Creates missing course section(s) and rebuilds course cache
819  *
820  * @param int|stdClass $courseorid course id or course object
821  * @param int|array $sections list of relative section numbers to create
822  * @return bool if there were any sections created
823  */
824 function course_create_sections_if_missing($courseorid, $sections) {
825     global $DB;
826     if (!is_array($sections)) {
827         $sections = array($sections);
828     }
829     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
830     if (is_object($courseorid)) {
831         $courseorid = $courseorid->id;
832     }
833     $coursechanged = false;
834     foreach ($sections as $sectionnum) {
835         if (!in_array($sectionnum, $existing)) {
836             $cw = new stdClass();
837             $cw->course   = $courseorid;
838             $cw->section  = $sectionnum;
839             $cw->summary  = '';
840             $cw->summaryformat = FORMAT_HTML;
841             $cw->sequence = '';
842             $id = $DB->insert_record("course_sections", $cw);
843             $coursechanged = true;
844         }
845     }
846     if ($coursechanged) {
847         rebuild_course_cache($courseorid, true);
848     }
849     return $coursechanged;
852 /**
853  * Adds an existing module to the section
854  *
855  * Updates both tables {course_sections} and {course_modules}
856  *
857  * Note: This function does not use modinfo PROVIDED that the section you are
858  * adding the module to already exists. If the section does not exist, it will
859  * build modinfo if necessary and create the section.
860  *
861  * @param int|stdClass $courseorid course id or course object
862  * @param int $cmid id of the module already existing in course_modules table
863  * @param int $sectionnum relative number of the section (field course_sections.section)
864  *     If section does not exist it will be created
865  * @param int|stdClass $beforemod id or object with field id corresponding to the module
866  *     before which the module needs to be included. Null for inserting in the
867  *     end of the section
868  * @return int The course_sections ID where the module is inserted
869  */
870 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
871     global $DB, $COURSE;
872     if (is_object($beforemod)) {
873         $beforemod = $beforemod->id;
874     }
875     if (is_object($courseorid)) {
876         $courseid = $courseorid->id;
877     } else {
878         $courseid = $courseorid;
879     }
880     // Do not try to use modinfo here, there is no guarantee it is valid!
881     $section = $DB->get_record('course_sections',
882             array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
883     if (!$section) {
884         // This function call requires modinfo.
885         course_create_sections_if_missing($courseorid, $sectionnum);
886         $section = $DB->get_record('course_sections',
887                 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
888     }
890     $modarray = explode(",", trim($section->sequence));
891     if (empty($section->sequence)) {
892         $newsequence = "$cmid";
893     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
894         $insertarray = array($cmid, $beforemod);
895         array_splice($modarray, $key[0], 1, $insertarray);
896         $newsequence = implode(",", $modarray);
897     } else {
898         $newsequence = "$section->sequence,$cmid";
899     }
900     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
901     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
902     if (is_object($courseorid)) {
903         rebuild_course_cache($courseorid->id, true);
904     } else {
905         rebuild_course_cache($courseorid, true);
906     }
907     return $section->id;     // Return course_sections ID that was used.
910 /**
911  * Change the group mode of a course module.
912  *
913  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
914  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
915  *
916  * @param int $id course module ID.
917  * @param int $groupmode the new groupmode value.
918  * @return bool True if the $groupmode was updated.
919  */
920 function set_coursemodule_groupmode($id, $groupmode) {
921     global $DB;
922     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
923     if ($cm->groupmode != $groupmode) {
924         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
925         rebuild_course_cache($cm->course, true);
926     }
927     return ($cm->groupmode != $groupmode);
930 function set_coursemodule_idnumber($id, $idnumber) {
931     global $DB;
932     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
933     if ($cm->idnumber != $idnumber) {
934         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
935         rebuild_course_cache($cm->course, true);
936     }
937     return ($cm->idnumber != $idnumber);
940 /**
941  * Set the visibility of a module and inherent properties.
942  *
943  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
944  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
945  *
946  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
947  * has been moved to {@link set_section_visible()} which was the only place from which
948  * the parameter was used.
949  *
950  * @param int $id of the module
951  * @param int $visible state of the module
952  * @return bool false when the module was not found, true otherwise
953  */
954 function set_coursemodule_visible($id, $visible) {
955     global $DB, $CFG;
956     require_once($CFG->libdir.'/gradelib.php');
957     require_once($CFG->dirroot.'/calendar/lib.php');
959     // Trigger developer's attention when using the previously removed argument.
960     if (func_num_args() > 2) {
961         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
962             has been removed.', DEBUG_DEVELOPER);
963     }
965     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
966         return false;
967     }
969     // Create events and propagate visibility to associated grade items if the value has changed.
970     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
971     if ($cm->visible == $visible) {
972         return true;
973     }
975     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
976         return false;
977     }
978     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
979         foreach($events as $event) {
980             if ($visible) {
981                 $event = new calendar_event($event);
982                 $event->toggle_visibility(true);
983             } else {
984                 $event = new calendar_event($event);
985                 $event->toggle_visibility(false);
986             }
987         }
988     }
990     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
991     // affect visibleold to allow for an original visibility restore. See set_section_visible().
992     $cminfo = new stdClass();
993     $cminfo->id = $id;
994     $cminfo->visible = $visible;
995     $cminfo->visibleold = $visible;
996     $DB->update_record('course_modules', $cminfo);
998     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
999     // Note that this must be done after updating the row in course_modules, in case
1000     // the modules grade_item_update function needs to access $cm->visible.
1001     if (plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY) &&
1002             component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1003         $instance = $DB->get_record($modulename, array('id' => $cm->instance), '*', MUST_EXIST);
1004         component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1005     } else {
1006         $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1007         if ($grade_items) {
1008             foreach ($grade_items as $grade_item) {
1009                 $grade_item->set_hidden(!$visible);
1010             }
1011         }
1012     }
1014     rebuild_course_cache($cm->course, true);
1015     return true;
1018 /**
1019  * Changes the course module name
1020  *
1021  * @param int $id course module id
1022  * @param string $name new value for a name
1023  * @return bool whether a change was made
1024  */
1025 function set_coursemodule_name($id, $name) {
1026     global $CFG, $DB;
1027     require_once($CFG->libdir . '/gradelib.php');
1029     $cm = get_coursemodule_from_id('', $id, 0, false, MUST_EXIST);
1031     $module = new \stdClass();
1032     $module->id = $cm->instance;
1034     // Escape strings as they would be by mform.
1035     if (!empty($CFG->formatstringstriptags)) {
1036         $module->name = clean_param($name, PARAM_TEXT);
1037     } else {
1038         $module->name = clean_param($name, PARAM_CLEANHTML);
1039     }
1040     if ($module->name === $cm->name || strval($module->name) === '') {
1041         return false;
1042     }
1043     if (\core_text::strlen($module->name) > 255) {
1044         throw new \moodle_exception('maximumchars', 'moodle', '', 255);
1045     }
1047     $module->timemodified = time();
1048     $DB->update_record($cm->modname, $module);
1049     $cm->name = $module->name;
1050     \core\event\course_module_updated::create_from_cm($cm)->trigger();
1051     rebuild_course_cache($cm->course, true);
1053     // Attempt to update the grade item if relevant.
1054     $grademodule = $DB->get_record($cm->modname, array('id' => $cm->instance));
1055     $grademodule->cmidnumber = $cm->idnumber;
1056     $grademodule->modname = $cm->modname;
1057     grade_update_mod_grades($grademodule);
1059     // Update calendar events with the new name.
1060     $refresheventsfunction = $cm->modname . '_refresh_events';
1061     if (function_exists($refresheventsfunction)) {
1062         call_user_func($refresheventsfunction, $cm->course);
1063     }
1065     return true;
1068 /**
1069  * This function will handle the whole deletion process of a module. This includes calling
1070  * the modules delete_instance function, deleting files, events, grades, conditional data,
1071  * the data in the course_module and course_sections table and adding a module deletion
1072  * event to the DB.
1073  *
1074  * @param int $cmid the course module id
1075  * @since Moodle 2.5
1076  */
1077 function course_delete_module($cmid) {
1078     global $CFG, $DB;
1080     require_once($CFG->libdir.'/gradelib.php');
1081     require_once($CFG->libdir.'/questionlib.php');
1082     require_once($CFG->dirroot.'/blog/lib.php');
1083     require_once($CFG->dirroot.'/calendar/lib.php');
1085     // Get the course module.
1086     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1087         return true;
1088     }
1090     // Get the module context.
1091     $modcontext = context_module::instance($cm->id);
1093     // Get the course module name.
1094     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1096     // Get the file location of the delete_instance function for this module.
1097     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1099     // Include the file required to call the delete_instance function for this module.
1100     if (file_exists($modlib)) {
1101         require_once($modlib);
1102     } else {
1103         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1104             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1105     }
1107     $deleteinstancefunction = $modulename . '_delete_instance';
1109     // Ensure the delete_instance function exists for this module.
1110     if (!function_exists($deleteinstancefunction)) {
1111         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1112             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1113     }
1115     // Allow plugins to use this course module before we completely delete it.
1116     if ($pluginsfunction = get_plugins_with_function('pre_course_module_delete')) {
1117         foreach ($pluginsfunction as $plugintype => $plugins) {
1118             foreach ($plugins as $pluginfunction) {
1119                 $pluginfunction($cm);
1120             }
1121         }
1122     }
1124     // Delete activity context questions and question categories.
1125     question_delete_activity($cm);
1127     // Call the delete_instance function, if it returns false throw an exception.
1128     if (!$deleteinstancefunction($cm->instance)) {
1129         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1130             "Cannot delete the module $modulename (instance).");
1131     }
1133     // Remove all module files in case modules forget to do that.
1134     $fs = get_file_storage();
1135     $fs->delete_area_files($modcontext->id);
1137     // Delete events from calendar.
1138     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1139         foreach($events as $event) {
1140             $calendarevent = calendar_event::load($event->id);
1141             $calendarevent->delete();
1142         }
1143     }
1145     // Delete grade items, outcome items and grades attached to modules.
1146     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1147                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1148         foreach ($grade_items as $grade_item) {
1149             $grade_item->delete('moddelete');
1150         }
1151     }
1153     // Delete completion and availability data; it is better to do this even if the
1154     // features are not turned on, in case they were turned on previously (these will be
1155     // very quick on an empty table).
1156     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1157     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1158                                                             'course' => $cm->course,
1159                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1161     // Delete all tag instances associated with the instance of this module.
1162     core_tag_tag::delete_instances('mod_' . $modulename, null, $modcontext->id);
1163     core_tag_tag::remove_all_item_tags('core', 'course_modules', $cm->id);
1165     // Notify the competency subsystem.
1166     \core_competency\api::hook_course_module_deleted($cm);
1168     // Delete the context.
1169     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1171     // Delete the module from the course_modules table.
1172     $DB->delete_records('course_modules', array('id' => $cm->id));
1174     // Delete module from that section.
1175     if (!delete_mod_from_section($cm->id, $cm->section)) {
1176         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1177             "Cannot delete the module $modulename (instance) from section.");
1178     }
1180     // Trigger event for course module delete action.
1181     $event = \core\event\course_module_deleted::create(array(
1182         'courseid' => $cm->course,
1183         'context'  => $modcontext,
1184         'objectid' => $cm->id,
1185         'other'    => array(
1186             'modulename' => $modulename,
1187             'instanceid'   => $cm->instance,
1188         )
1189     ));
1190     $event->add_record_snapshot('course_modules', $cm);
1191     $event->trigger();
1192     rebuild_course_cache($cm->course, true);
1195 function delete_mod_from_section($modid, $sectionid) {
1196     global $DB;
1198     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1200         $modarray = explode(",", $section->sequence);
1202         if ($key = array_keys ($modarray, $modid)) {
1203             array_splice($modarray, $key[0], 1);
1204             $newsequence = implode(",", $modarray);
1205             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1206             rebuild_course_cache($section->course, true);
1207             return true;
1208         } else {
1209             return false;
1210         }
1212     }
1213     return false;
1216 /**
1217  * Moves a section within a course, from a position to another.
1218  * Be very careful: $section and $destination refer to section number,
1219  * not id!.
1220  *
1221  * @param object $course
1222  * @param int $section Section number (not id!!!)
1223  * @param int $destination
1224  * @param bool $ignorenumsections
1225  * @return boolean Result
1226  */
1227 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1228 /// Moves a whole course section up and down within the course
1229     global $USER, $DB;
1231     if (!$destination && $destination != 0) {
1232         return true;
1233     }
1235     // compartibility with course formats using field 'numsections'
1236     $courseformatoptions = course_get_format($course)->get_format_options();
1237     if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1238             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1239         return false;
1240     }
1242     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1243     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1244             'section ASC, id ASC', 'id, section')) {
1245         return false;
1246     }
1248     $movedsections = reorder_sections($sections, $section, $destination);
1250     // Update all sections. Do this in 2 steps to avoid breaking database
1251     // uniqueness constraint
1252     $transaction = $DB->start_delegated_transaction();
1253     foreach ($movedsections as $id => $position) {
1254         if ($sections[$id] !== $position) {
1255             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1256         }
1257     }
1258     foreach ($movedsections as $id => $position) {
1259         if ($sections[$id] !== $position) {
1260             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1261         }
1262     }
1264     // If we move the highlighted section itself, then just highlight the destination.
1265     // Adjust the higlighted section location if we move something over it either direction.
1266     if ($section == $course->marker) {
1267         course_set_marker($course->id, $destination);
1268     } elseif ($section > $course->marker && $course->marker >= $destination) {
1269         course_set_marker($course->id, $course->marker+1);
1270     } elseif ($section < $course->marker && $course->marker <= $destination) {
1271         course_set_marker($course->id, $course->marker-1);
1272     }
1274     $transaction->allow_commit();
1275     rebuild_course_cache($course->id, true);
1276     return true;
1279 /**
1280  * This method will delete a course section and may delete all modules inside it.
1281  *
1282  * No permissions are checked here, use {@link course_can_delete_section()} to
1283  * check if section can actually be deleted.
1284  *
1285  * @param int|stdClass $course
1286  * @param int|stdClass|section_info $section
1287  * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1288  * @return bool whether section was deleted
1289  */
1290 function course_delete_section($course, $section, $forcedeleteifnotempty = true) {
1291     global $DB;
1293     // Prepare variables.
1294     $courseid = (is_object($course)) ? $course->id : (int)$course;
1295     $sectionnum = (is_object($section)) ? $section->section : (int)$section;
1296     $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1297     if (!$section) {
1298         // No section exists, can't proceed.
1299         return false;
1300     }
1301     $format = course_get_format($course);
1302     $sectionname = $format->get_section_name($section);
1304     // Delete section.
1305     $result = $format->delete_section($section, $forcedeleteifnotempty);
1307     // Trigger an event for course section deletion.
1308     if ($result) {
1309         $context = context_course::instance($courseid);
1310         $event = \core\event\course_section_deleted::create(
1311                 array(
1312                     'objectid' => $section->id,
1313                     'courseid' => $courseid,
1314                     'context' => $context,
1315                     'other' => array(
1316                         'sectionnum' => $section->section,
1317                         'sectionname' => $sectionname,
1318                     )
1319                 )
1320             );
1321         $event->add_record_snapshot('course_sections', $section);
1322         $event->trigger();
1323     }
1324     return $result;
1327 /**
1328  * Updates the course section
1329  *
1330  * This function does not check permissions or clean values - this has to be done prior to calling it.
1331  *
1332  * @param int|stdClass $course
1333  * @param stdClass $section record from course_sections table - it will be updated with the new values
1334  * @param array|stdClass $data
1335  */
1336 function course_update_section($course, $section, $data) {
1337     global $DB;
1339     $courseid = (is_object($course)) ? $course->id : (int)$course;
1341     // Some fields can not be updated using this method.
1342     $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1343     $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible);
1344     if (array_key_exists('name', $data) && \core_text::strlen($data['name']) > 255) {
1345         throw new moodle_exception('maximumchars', 'moodle', '', 255);
1346     }
1348     // Update record in the DB and course format options.
1349     $data['id'] = $section->id;
1350     $DB->update_record('course_sections', $data);
1351     rebuild_course_cache($courseid, true);
1352     course_get_format($courseid)->update_section_format_options($data);
1354     // Update fields of the $section object.
1355     foreach ($data as $key => $value) {
1356         if (property_exists($section, $key)) {
1357             $section->$key = $value;
1358         }
1359     }
1361     // Trigger an event for course section update.
1362     $event = \core\event\course_section_updated::create(
1363         array(
1364             'objectid' => $section->id,
1365             'courseid' => $courseid,
1366             'context' => context_course::instance($courseid),
1367             'other' => array('sectionnum' => $section->section)
1368         )
1369     );
1370     $event->trigger();
1372     // If section visibility was changed, hide the modules in this section too.
1373     if ($changevisibility && !empty($section->sequence)) {
1374         $modules = explode(',', $section->sequence);
1375         foreach ($modules as $moduleid) {
1376             if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1377                 if ($data['visible']) {
1378                     // As we unhide the section, we use the previously saved visibility stored in visibleold.
1379                     set_coursemodule_visible($moduleid, $cm->visibleold);
1380                 } else {
1381                     // We hide the section, so we hide the module but we store the original state in visibleold.
1382                     set_coursemodule_visible($moduleid, 0);
1383                     $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1384                 }
1385                 \core\event\course_module_updated::create_from_cm($cm)->trigger();
1386             }
1387         }
1388     }
1391 /**
1392  * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1393  *
1394  * @param int|stdClass $course
1395  * @param int|stdClass|section_info $section
1396  * @return bool
1397  */
1398 function course_can_delete_section($course, $section) {
1399     if (is_object($section)) {
1400         $section = $section->section;
1401     }
1402     if (!$section) {
1403         // Not possible to delete 0-section.
1404         return false;
1405     }
1406     // Course format should allow to delete sections.
1407     if (!course_get_format($course)->can_delete_section($section)) {
1408         return false;
1409     }
1410     // Make sure user has capability to update course and move sections.
1411     $context = context_course::instance(is_object($course) ? $course->id : $course);
1412     if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1413         return false;
1414     }
1415     // Make sure user has capability to delete each activity in this section.
1416     $modinfo = get_fast_modinfo($course);
1417     if (!empty($modinfo->sections[$section])) {
1418         foreach ($modinfo->sections[$section] as $cmid) {
1419             if (!has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1420                 return false;
1421             }
1422         }
1423     }
1424     return true;
1427 /**
1428  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1429  * an original position number and a target position number, rebuilds the array so that the
1430  * move is made without any duplication of section positions.
1431  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1432  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1433  *
1434  * @param array $sections
1435  * @param int $origin_position
1436  * @param int $target_position
1437  * @return array
1438  */
1439 function reorder_sections($sections, $origin_position, $target_position) {
1440     if (!is_array($sections)) {
1441         return false;
1442     }
1444     // We can't move section position 0
1445     if ($origin_position < 1) {
1446         echo "We can't move section position 0";
1447         return false;
1448     }
1450     // Locate origin section in sections array
1451     if (!$origin_key = array_search($origin_position, $sections)) {
1452         echo "searched position not in sections array";
1453         return false; // searched position not in sections array
1454     }
1456     // Extract origin section
1457     $origin_section = $sections[$origin_key];
1458     unset($sections[$origin_key]);
1460     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1461     $found = false;
1462     $append_array = array();
1463     foreach ($sections as $id => $position) {
1464         if ($found) {
1465             $append_array[$id] = $position;
1466             unset($sections[$id]);
1467         }
1468         if ($position == $target_position) {
1469             if ($target_position < $origin_position) {
1470                 $append_array[$id] = $position;
1471                 unset($sections[$id]);
1472             }
1473             $found = true;
1474         }
1475     }
1477     // Append moved section
1478     $sections[$origin_key] = $origin_section;
1480     // Append rest of array (if applicable)
1481     if (!empty($append_array)) {
1482         foreach ($append_array as $id => $position) {
1483             $sections[$id] = $position;
1484         }
1485     }
1487     // Renumber positions
1488     $position = 0;
1489     foreach ($sections as $id => $p) {
1490         $sections[$id] = $position;
1491         $position++;
1492     }
1494     return $sections;
1498 /**
1499  * Move the module object $mod to the specified $section
1500  * If $beforemod exists then that is the module
1501  * before which $modid should be inserted
1502  *
1503  * @param stdClass|cm_info $mod
1504  * @param stdClass|section_info $section
1505  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1506  *     before which the module needs to be included. Null for inserting in the
1507  *     end of the section
1508  * @return int new value for module visibility (0 or 1)
1509  */
1510 function moveto_module($mod, $section, $beforemod=NULL) {
1511     global $OUTPUT, $DB;
1513     // Current module visibility state - return value of this function.
1514     $modvisible = $mod->visible;
1516     // Remove original module from original section.
1517     if (! delete_mod_from_section($mod->id, $mod->section)) {
1518         echo $OUTPUT->notification("Could not delete module from existing section");
1519     }
1521     // If moving to a hidden section then hide module.
1522     if ($mod->section != $section->id) {
1523         if (!$section->visible && $mod->visible) {
1524             // Module was visible but must become hidden after moving to hidden section.
1525             $modvisible = 0;
1526             set_coursemodule_visible($mod->id, 0);
1527             // Set visibleold to 1 so module will be visible when section is made visible.
1528             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1529         }
1530         if ($section->visible && !$mod->visible) {
1531             // Hidden module was moved to the visible section, restore the module visibility from visibleold.
1532             set_coursemodule_visible($mod->id, $mod->visibleold);
1533             $modvisible = $mod->visibleold;
1534         }
1535     }
1537     // Add the module into the new section.
1538     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
1539     return $modvisible;
1542 /**
1543  * Returns the list of all editing actions that current user can perform on the module
1544  *
1545  * @param cm_info $mod The module to produce editing buttons for
1546  * @param int $indent The current indenting (default -1 means no move left-right actions)
1547  * @param int $sr The section to link back to (used for creating the links)
1548  * @return array array of action_link or pix_icon objects
1549  */
1550 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
1551     global $COURSE, $SITE;
1553     static $str;
1555     $coursecontext = context_course::instance($mod->course);
1556     $modcontext = context_module::instance($mod->id);
1558     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1559     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1561     // No permission to edit anything.
1562     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1563         return array();
1564     }
1566     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1568     if (!isset($str)) {
1569         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1570             'editsettings', 'duplicate', 'hide', 'show'), 'moodle');
1571         $str->assign         = get_string('assignroles', 'role');
1572         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1573         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1574         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1575     }
1577     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1579     if ($sr !== null) {
1580         $baseurl->param('sr', $sr);
1581     }
1582     $actions = array();
1584     // Update.
1585     if ($hasmanageactivities) {
1586         $actions['update'] = new action_menu_link_secondary(
1587             new moodle_url($baseurl, array('update' => $mod->id)),
1588             new pix_icon('t/edit', $str->editsettings, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1589             $str->editsettings,
1590             array('class' => 'editing_update', 'data-action' => 'update')
1591         );
1592     }
1594     // Indent.
1595     if ($hasmanageactivities && $indent >= 0) {
1596         $indentlimits = new stdClass();
1597         $indentlimits->min = 0;
1598         $indentlimits->max = 16;
1599         if (right_to_left()) {   // Exchange arrows on RTL
1600             $rightarrow = 't/left';
1601             $leftarrow  = 't/right';
1602         } else {
1603             $rightarrow = 't/right';
1604             $leftarrow  = 't/left';
1605         }
1607         if ($indent >= $indentlimits->max) {
1608             $enabledclass = 'hidden';
1609         } else {
1610             $enabledclass = '';
1611         }
1612         $actions['moveright'] = new action_menu_link_secondary(
1613             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
1614             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1615             $str->moveright,
1616             array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright', 'data-keepopen' => true)
1617         );
1619         if ($indent <= $indentlimits->min) {
1620             $enabledclass = 'hidden';
1621         } else {
1622             $enabledclass = '';
1623         }
1624         $actions['moveleft'] = new action_menu_link_secondary(
1625             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
1626             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1627             $str->moveleft,
1628             array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft', 'data-keepopen' => true)
1629         );
1631     }
1633     // Hide/Show.
1634     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1635         if ($mod->visible) {
1636             $actions['hide'] = new action_menu_link_secondary(
1637                 new moodle_url($baseurl, array('hide' => $mod->id)),
1638                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1639                 $str->hide,
1640                 array('class' => 'editing_hide', 'data-action' => 'hide')
1641             );
1642         } else {
1643             $actions['show'] = new action_menu_link_secondary(
1644                 new moodle_url($baseurl, array('show' => $mod->id)),
1645                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1646                 $str->show,
1647                 array('class' => 'editing_show', 'data-action' => 'show')
1648             );
1649         }
1650     }
1652     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1653     if (has_all_capabilities($dupecaps, $coursecontext) &&
1654             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
1655         $actions['duplicate'] = new action_menu_link_secondary(
1656             new moodle_url($baseurl, array('duplicate' => $mod->id)),
1657             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1658             $str->duplicate,
1659             array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sr' => $sr)
1660         );
1661     }
1663     // Groupmode.
1664     if ($hasmanageactivities && !$mod->coursegroupmodeforce) {
1665         if (plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1666             if ($mod->effectivegroupmode == SEPARATEGROUPS) {
1667                 $nextgroupmode = VISIBLEGROUPS;
1668                 $grouptitle = $str->groupsseparate;
1669                 $actionname = 'groupsseparate';
1670                 $groupimage = 'i/groups';
1671             } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
1672                 $nextgroupmode = NOGROUPS;
1673                 $grouptitle = $str->groupsvisible;
1674                 $actionname = 'groupsvisible';
1675                 $groupimage = 'i/groupv';
1676             } else {
1677                 $nextgroupmode = SEPARATEGROUPS;
1678                 $grouptitle = $str->groupsnone;
1679                 $actionname = 'groupsnone';
1680                 $groupimage = 'i/groupn';
1681             }
1683             $actions[$actionname] = new action_menu_link_primary(
1684                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
1685                 new pix_icon($groupimage, null, 'moodle', array('class' => 'iconsmall')),
1686                 $grouptitle,
1687                 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode, 'aria-live' => 'assertive')
1688             );
1689         } else {
1690             $actions['nogroupsupport'] = new action_menu_filler();
1691         }
1692     }
1694     // Assign.
1695     if (has_capability('moodle/role:assign', $modcontext)){
1696         $actions['assign'] = new action_menu_link_secondary(
1697             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
1698             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1699             $str->assign,
1700             array('class' => 'editing_assign', 'data-action' => 'assignroles')
1701         );
1702     }
1704     // Delete.
1705     if ($hasmanageactivities) {
1706         $actions['delete'] = new action_menu_link_secondary(
1707             new moodle_url($baseurl, array('delete' => $mod->id)),
1708             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1709             $str->delete,
1710             array('class' => 'editing_delete', 'data-action' => 'delete')
1711         );
1712     }
1714     return $actions;
1717 /**
1718  * Returns the move action.
1719  *
1720  * @param cm_info $mod The module to produce a move button for
1721  * @param int $sr The section to link back to (used for creating the links)
1722  * @return The markup for the move action, or an empty string if not available.
1723  */
1724 function course_get_cm_move(cm_info $mod, $sr = null) {
1725     global $OUTPUT;
1727     static $str;
1728     static $baseurl;
1730     $modcontext = context_module::instance($mod->id);
1731     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1733     if (!isset($str)) {
1734         $str = get_strings(array('move'));
1735     }
1737     if (!isset($baseurl)) {
1738         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1740         if ($sr !== null) {
1741             $baseurl->param('sr', $sr);
1742         }
1743     }
1745     if ($hasmanageactivities) {
1746         $pixicon = 'i/dragdrop';
1748         if (!course_ajax_enabled($mod->get_course())) {
1749             // Override for course frontpage until we get drag/drop working there.
1750             $pixicon = 't/move';
1751         }
1753         return html_writer::link(
1754             new moodle_url($baseurl, array('copy' => $mod->id)),
1755             $OUTPUT->pix_icon($pixicon, $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1756             array('class' => 'editing_move', 'data-action' => 'move')
1757         );
1758     }
1759     return '';
1762 /**
1763  * given a course object with shortname & fullname, this function will
1764  * truncate the the number of chars allowed and add ... if it was too long
1765  */
1766 function course_format_name ($course,$max=100) {
1768     $context = context_course::instance($course->id);
1769     $shortname = format_string($course->shortname, true, array('context' => $context));
1770     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
1771     $str = $shortname.': '. $fullname;
1772     if (core_text::strlen($str) <= $max) {
1773         return $str;
1774     }
1775     else {
1776         return core_text::substr($str,0,$max-3).'...';
1777     }
1780 /**
1781  * Is the user allowed to add this type of module to this course?
1782  * @param object $course the course settings. Only $course->id is used.
1783  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
1784  * @return bool whether the current user is allowed to add this type of module to this course.
1785  */
1786 function course_allowed_module($course, $modname) {
1787     if (is_numeric($modname)) {
1788         throw new coding_exception('Function course_allowed_module no longer
1789                 supports numeric module ids. Please update your code to pass the module name.');
1790     }
1792     $capability = 'mod/' . $modname . ':addinstance';
1793     if (!get_capability_info($capability)) {
1794         // Debug warning that the capability does not exist, but no more than once per page.
1795         static $warned = array();
1796         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1797         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
1798             debugging('The module ' . $modname . ' does not define the standard capability ' .
1799                     $capability , DEBUG_DEVELOPER);
1800             $warned[$modname] = 1;
1801         }
1803         // If the capability does not exist, the module can always be added.
1804         return true;
1805     }
1807     $coursecontext = context_course::instance($course->id);
1808     return has_capability($capability, $coursecontext);
1811 /**
1812  * Efficiently moves many courses around while maintaining
1813  * sortorder in order.
1814  *
1815  * @param array $courseids is an array of course ids
1816  * @param int $categoryid
1817  * @return bool success
1818  */
1819 function move_courses($courseids, $categoryid) {
1820     global $DB;
1822     if (empty($courseids)) {
1823         // Nothing to do.
1824         return false;
1825     }
1827     if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
1828         return false;
1829     }
1831     $courseids = array_reverse($courseids);
1832     $newparent = context_coursecat::instance($category->id);
1833     $i = 1;
1835     list($where, $params) = $DB->get_in_or_equal($courseids);
1836     $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
1837     foreach ($dbcourses as $dbcourse) {
1838         $course = new stdClass();
1839         $course->id = $dbcourse->id;
1840         $course->category  = $category->id;
1841         $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
1842         if ($category->visible == 0) {
1843             // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
1844             // to previous state if somebody unhides the category.
1845             $course->visible = 0;
1846         }
1848         $DB->update_record('course', $course);
1850         // Update context, so it can be passed to event.
1851         $context = context_course::instance($course->id);
1852         $context->update_moved($newparent);
1854         // Trigger a course updated event.
1855         $event = \core\event\course_updated::create(array(
1856             'objectid' => $course->id,
1857             'context' => context_course::instance($course->id),
1858             'other' => array('shortname' => $dbcourse->shortname,
1859                              'fullname' => $dbcourse->fullname)
1860         ));
1861         $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
1862         $event->trigger();
1863     }
1864     fix_course_sortorder();
1865     cache_helper::purge_by_event('changesincourse');
1867     return true;
1870 /**
1871  * Returns the display name of the given section that the course prefers
1872  *
1873  * Implementation of this function is provided by course format
1874  * @see format_base::get_section_name()
1875  *
1876  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
1877  * @param int|stdClass $section Section object from database or just field course_sections.section
1878  * @return string Display name that the course format prefers, e.g. "Week 2"
1879  */
1880 function get_section_name($courseorid, $section) {
1881     return course_get_format($courseorid)->get_section_name($section);
1884 /**
1885  * Tells if current course format uses sections
1886  *
1887  * @param string $format Course format ID e.g. 'weeks' $course->format
1888  * @return bool
1889  */
1890 function course_format_uses_sections($format) {
1891     $course = new stdClass();
1892     $course->format = $format;
1893     return course_get_format($course)->uses_sections();
1896 /**
1897  * Returns the information about the ajax support in the given source format
1898  *
1899  * The returned object's property (boolean)capable indicates that
1900  * the course format supports Moodle course ajax features.
1901  *
1902  * @param string $format
1903  * @return stdClass
1904  */
1905 function course_format_ajax_support($format) {
1906     $course = new stdClass();
1907     $course->format = $format;
1908     return course_get_format($course)->supports_ajax();
1911 /**
1912  * Can the current user delete this course?
1913  * Course creators have exception,
1914  * 1 day after the creation they can sill delete the course.
1915  * @param int $courseid
1916  * @return boolean
1917  */
1918 function can_delete_course($courseid) {
1919     global $USER;
1921     $context = context_course::instance($courseid);
1923     if (has_capability('moodle/course:delete', $context)) {
1924         return true;
1925     }
1927     // hack: now try to find out if creator created this course recently (1 day)
1928     if (!has_capability('moodle/course:create', $context)) {
1929         return false;
1930     }
1932     $since = time() - 60*60*24;
1933     $course = get_course($courseid);
1935     if ($course->timecreated < $since) {
1936         return false; // Return if the course was not created in last 24 hours.
1937     }
1939     $logmanger = get_log_manager();
1940     $readers = $logmanger->get_readers('\core\log\sql_reader');
1941     $reader = reset($readers);
1943     if (empty($reader)) {
1944         return false; // No log reader found.
1945     }
1947     // A proper reader.
1948     $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
1949     $params = array('userid' => $USER->id, 'since' => $since, 'courseid' => $course->id, 'eventname' => '\core\event\course_created');
1951     return (bool)$reader->get_events_select_count($select, $params);
1954 /**
1955  * Save the Your name for 'Some role' strings.
1956  *
1957  * @param integer $courseid the id of this course.
1958  * @param array $data the data that came from the course settings form.
1959  */
1960 function save_local_role_names($courseid, $data) {
1961     global $DB;
1962     $context = context_course::instance($courseid);
1964     foreach ($data as $fieldname => $value) {
1965         if (strpos($fieldname, 'role_') !== 0) {
1966             continue;
1967         }
1968         list($ignored, $roleid) = explode('_', $fieldname);
1970         // make up our mind whether we want to delete, update or insert
1971         if (!$value) {
1972             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
1974         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
1975             $rolename->name = $value;
1976             $DB->update_record('role_names', $rolename);
1978         } else {
1979             $rolename = new stdClass;
1980             $rolename->contextid = $context->id;
1981             $rolename->roleid = $roleid;
1982             $rolename->name = $value;
1983             $DB->insert_record('role_names', $rolename);
1984         }
1985         // This will ensure the course contacts cache is purged..
1986         coursecat::role_assignment_changed($roleid, $context);
1987     }
1990 /**
1991  * Returns options to use in course overviewfiles filemanager
1992  *
1993  * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
1994  *     may be empty if course does not exist yet (course create form)
1995  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
1996  *     or null if overviewfiles are disabled
1997  */
1998 function course_overviewfiles_options($course) {
1999     global $CFG;
2000     if (empty($CFG->courseoverviewfileslimit)) {
2001         return null;
2002     }
2003     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2004     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2005         $accepted_types = '*';
2006     } else {
2007         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2008         // Make sure extensions are prefixed with dot unless they are valid typegroups
2009         foreach ($accepted_types as $i => $type) {
2010             if (substr($type, 0, 1) !== '.') {
2011                 require_once($CFG->libdir. '/filelib.php');
2012                 if (!count(file_get_typegroup('extension', $type))) {
2013                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2014                     $accepted_types[$i] = '.'. $type;
2015                     $corrected = true;
2016                 }
2017             }
2018         }
2019         if (!empty($corrected)) {
2020             set_config('courseoverviewfilesext', join(',', $accepted_types));
2021         }
2022     }
2023     $options = array(
2024         'maxfiles' => $CFG->courseoverviewfileslimit,
2025         'maxbytes' => $CFG->maxbytes,
2026         'subdirs' => 0,
2027         'accepted_types' => $accepted_types
2028     );
2029     if (!empty($course->id)) {
2030         $options['context'] = context_course::instance($course->id);
2031     } else if (is_int($course) && $course > 0) {
2032         $options['context'] = context_course::instance($course);
2033     }
2034     return $options;
2037 /**
2038  * Create a course and either return a $course object
2039  *
2040  * Please note this functions does not verify any access control,
2041  * the calling code is responsible for all validation (usually it is the form definition).
2042  *
2043  * @param array $editoroptions course description editor options
2044  * @param object $data  - all the data needed for an entry in the 'course' table
2045  * @return object new course instance
2046  */
2047 function create_course($data, $editoroptions = NULL) {
2048     global $DB, $CFG;
2050     //check the categoryid - must be given for all new courses
2051     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2053     // Check if the shortname already exists.
2054     if (!empty($data->shortname)) {
2055         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2056             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2057         }
2058     }
2060     // Check if the idnumber already exists.
2061     if (!empty($data->idnumber)) {
2062         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2063             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2064         }
2065     }
2067     if ($errorcode = course_validate_dates((array)$data)) {
2068         throw new moodle_exception($errorcode);
2069     }
2071     // Check if timecreated is given.
2072     $data->timecreated  = !empty($data->timecreated) ? $data->timecreated : time();
2073     $data->timemodified = $data->timecreated;
2075     // place at beginning of any category
2076     $data->sortorder = 0;
2078     if ($editoroptions) {
2079         // summary text is updated later, we need context to store the files first
2080         $data->summary = '';
2081         $data->summary_format = FORMAT_HTML;
2082     }
2084     if (!isset($data->visible)) {
2085         // data not from form, add missing visibility info
2086         $data->visible = $category->visible;
2087     }
2088     $data->visibleold = $data->visible;
2090     $newcourseid = $DB->insert_record('course', $data);
2091     $context = context_course::instance($newcourseid, MUST_EXIST);
2093     if ($editoroptions) {
2094         // Save the files used in the summary editor and store
2095         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2096         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2097         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2098     }
2099     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2100         // Save the course overviewfiles
2101         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2102     }
2104     // update course format options
2105     course_get_format($newcourseid)->update_course_format_options($data);
2107     $course = course_get_format($newcourseid)->get_course();
2109     fix_course_sortorder();
2110     // purge appropriate caches in case fix_course_sortorder() did not change anything
2111     cache_helper::purge_by_event('changesincourse');
2113     // new context created - better mark it as dirty
2114     $context->mark_dirty();
2116     // Trigger a course created event.
2117     $event = \core\event\course_created::create(array(
2118         'objectid' => $course->id,
2119         'context' => context_course::instance($course->id),
2120         'other' => array('shortname' => $course->shortname,
2121             'fullname' => $course->fullname)
2122     ));
2123     $event->trigger();
2125     // Setup the blocks
2126     blocks_add_default_course_blocks($course);
2128     // Create a default section.
2129     course_create_sections_if_missing($course, 0);
2131     // Save any custom role names.
2132     save_local_role_names($course->id, (array)$data);
2134     // set up enrolments
2135     enrol_course_updated(true, $course, $data);
2137     // Update course tags.
2138     if (isset($data->tags)) {
2139         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2140     }
2142     return $course;
2145 /**
2146  * Update a course.
2147  *
2148  * Please note this functions does not verify any access control,
2149  * the calling code is responsible for all validation (usually it is the form definition).
2150  *
2151  * @param object $data  - all the data needed for an entry in the 'course' table
2152  * @param array $editoroptions course description editor options
2153  * @return void
2154  */
2155 function update_course($data, $editoroptions = NULL) {
2156     global $DB, $CFG;
2158     $data->timemodified = time();
2160     // Prevent changes on front page course.
2161     if ($data->id == SITEID) {
2162         throw new moodle_exception('invalidcourse', 'error');
2163     }
2165     $oldcourse = course_get_format($data->id)->get_course();
2166     $context   = context_course::instance($oldcourse->id);
2168     if ($editoroptions) {
2169         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2170     }
2171     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2172         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2173     }
2175     // Check we don't have a duplicate shortname.
2176     if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
2177         if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname, $data->id))) {
2178             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2179         }
2180     }
2182     // Check we don't have a duplicate idnumber.
2183     if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
2184         if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber, $data->id))) {
2185             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2186         }
2187     }
2189     if ($errorcode = course_validate_dates((array)$data)) {
2190         throw new moodle_exception($errorcode);
2191     }
2193     if (!isset($data->category) or empty($data->category)) {
2194         // prevent nulls and 0 in category field
2195         unset($data->category);
2196     }
2197     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2199     if (!isset($data->visible)) {
2200         // data not from form, add missing visibility info
2201         $data->visible = $oldcourse->visible;
2202     }
2204     if ($data->visible != $oldcourse->visible) {
2205         // reset the visibleold flag when manually hiding/unhiding course
2206         $data->visibleold = $data->visible;
2207         $changesincoursecat = true;
2208     } else {
2209         if ($movecat) {
2210             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2211             if (empty($newcategory->visible)) {
2212                 // make sure when moving into hidden category the course is hidden automatically
2213                 $data->visible = 0;
2214             }
2215         }
2216     }
2218     // Update with the new data
2219     $DB->update_record('course', $data);
2220     // make sure the modinfo cache is reset
2221     rebuild_course_cache($data->id);
2223     // update course format options with full course data
2224     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2226     $course = $DB->get_record('course', array('id'=>$data->id));
2228     if ($movecat) {
2229         $newparent = context_coursecat::instance($course->category);
2230         $context->update_moved($newparent);
2231     }
2232     $fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
2233     if ($fixcoursesortorder) {
2234         fix_course_sortorder();
2235     }
2237     // purge appropriate caches in case fix_course_sortorder() did not change anything
2238     cache_helper::purge_by_event('changesincourse');
2239     if ($changesincoursecat) {
2240         cache_helper::purge_by_event('changesincoursecat');
2241     }
2243     // Test for and remove blocks which aren't appropriate anymore
2244     blocks_remove_inappropriate($course);
2246     // Save any custom role names.
2247     save_local_role_names($course->id, $data);
2249     // update enrol settings
2250     enrol_course_updated(false, $course, $data);
2252     // Update course tags.
2253     if (isset($data->tags)) {
2254         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2255     }
2257     // Trigger a course updated event.
2258     $event = \core\event\course_updated::create(array(
2259         'objectid' => $course->id,
2260         'context' => context_course::instance($course->id),
2261         'other' => array('shortname' => $course->shortname,
2262                          'fullname' => $course->fullname)
2263     ));
2265     $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
2266     $event->trigger();
2268     if ($oldcourse->format !== $course->format) {
2269         // Remove all options stored for the previous format
2270         // We assume that new course format migrated everything it needed watching trigger
2271         // 'course_updated' and in method format_XXX::update_course_format_options()
2272         $DB->delete_records('course_format_options',
2273                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2274     }
2277 /**
2278  * Average number of participants
2279  * @return integer
2280  */
2281 function average_number_of_participants() {
2282     global $DB, $SITE;
2284     //count total of enrolments for visible course (except front page)
2285     $sql = 'SELECT COUNT(*) FROM (
2286         SELECT DISTINCT ue.userid, e.courseid
2287         FROM {user_enrolments} ue, {enrol} e, {course} c
2288         WHERE ue.enrolid = e.id
2289             AND e.courseid <> :siteid
2290             AND c.id = e.courseid
2291             AND c.visible = 1) total';
2292     $params = array('siteid' => $SITE->id);
2293     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2296     //count total of visible courses (minus front page)
2297     $coursetotal = $DB->count_records('course', array('visible' => 1));
2298     $coursetotal = $coursetotal - 1 ;
2300     //average of enrolment
2301     if (empty($coursetotal)) {
2302         $participantaverage = 0;
2303     } else {
2304         $participantaverage = $enrolmenttotal / $coursetotal;
2305     }
2307     return $participantaverage;
2310 /**
2311  * Average number of course modules
2312  * @return integer
2313  */
2314 function average_number_of_courses_modules() {
2315     global $DB, $SITE;
2317     //count total of visible course module (except front page)
2318     $sql = 'SELECT COUNT(*) FROM (
2319         SELECT cm.course, cm.module
2320         FROM {course} c, {course_modules} cm
2321         WHERE c.id = cm.course
2322             AND c.id <> :siteid
2323             AND cm.visible = 1
2324             AND c.visible = 1) total';
2325     $params = array('siteid' => $SITE->id);
2326     $moduletotal = $DB->count_records_sql($sql, $params);
2329     //count total of visible courses (minus front page)
2330     $coursetotal = $DB->count_records('course', array('visible' => 1));
2331     $coursetotal = $coursetotal - 1 ;
2333     //average of course module
2334     if (empty($coursetotal)) {
2335         $coursemoduleaverage = 0;
2336     } else {
2337         $coursemoduleaverage = $moduletotal / $coursetotal;
2338     }
2340     return $coursemoduleaverage;
2343 /**
2344  * This class pertains to course requests and contains methods associated with
2345  * create, approving, and removing course requests.
2346  *
2347  * Please note we do not allow embedded images here because there is no context
2348  * to store them with proper access control.
2349  *
2350  * @copyright 2009 Sam Hemelryk
2351  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2352  * @since Moodle 2.0
2353  *
2354  * @property-read int $id
2355  * @property-read string $fullname
2356  * @property-read string $shortname
2357  * @property-read string $summary
2358  * @property-read int $summaryformat
2359  * @property-read int $summarytrust
2360  * @property-read string $reason
2361  * @property-read int $requester
2362  */
2363 class course_request {
2365     /**
2366      * This is the stdClass that stores the properties for the course request
2367      * and is externally accessed through the __get magic method
2368      * @var stdClass
2369      */
2370     protected $properties;
2372     /**
2373      * An array of options for the summary editor used by course request forms.
2374      * This is initially set by {@link summary_editor_options()}
2375      * @var array
2376      * @static
2377      */
2378     protected static $summaryeditoroptions;
2380     /**
2381      * Static function to prepare the summary editor for working with a course
2382      * request.
2383      *
2384      * @static
2385      * @param null|stdClass $data Optional, an object containing the default values
2386      *                       for the form, these may be modified when preparing the
2387      *                       editor so this should be called before creating the form
2388      * @return stdClass An object that can be used to set the default values for
2389      *                   an mforms form
2390      */
2391     public static function prepare($data=null) {
2392         if ($data === null) {
2393             $data = new stdClass;
2394         }
2395         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2396         return $data;
2397     }
2399     /**
2400      * Static function to create a new course request when passed an array of properties
2401      * for it.
2402      *
2403      * This function also handles saving any files that may have been used in the editor
2404      *
2405      * @static
2406      * @param stdClass $data
2407      * @return course_request The newly created course request
2408      */
2409     public static function create($data) {
2410         global $USER, $DB, $CFG;
2411         $data->requester = $USER->id;
2413         // Setting the default category if none set.
2414         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2415             $data->category = $CFG->defaultrequestcategory;
2416         }
2418         // Summary is a required field so copy the text over
2419         $data->summary       = $data->summary_editor['text'];
2420         $data->summaryformat = $data->summary_editor['format'];
2422         $data->id = $DB->insert_record('course_request', $data);
2424         // Create a new course_request object and return it
2425         $request = new course_request($data);
2427         // Notify the admin if required.
2428         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2430             $a = new stdClass;
2431             $a->link = "$CFG->wwwroot/course/pending.php";
2432             $a->user = fullname($USER);
2433             $subject = get_string('courserequest');
2434             $message = get_string('courserequestnotifyemail', 'admin', $a);
2435             foreach ($users as $user) {
2436                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2437             }
2438         }
2440         return $request;
2441     }
2443     /**
2444      * Returns an array of options to use with a summary editor
2445      *
2446      * @uses course_request::$summaryeditoroptions
2447      * @return array An array of options to use with the editor
2448      */
2449     public static function summary_editor_options() {
2450         global $CFG;
2451         if (self::$summaryeditoroptions === null) {
2452             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2453         }
2454         return self::$summaryeditoroptions;
2455     }
2457     /**
2458      * Loads the properties for this course request object. Id is required and if
2459      * only id is provided then we load the rest of the properties from the database
2460      *
2461      * @param stdClass|int $properties Either an object containing properties
2462      *                      or the course_request id to load
2463      */
2464     public function __construct($properties) {
2465         global $DB;
2466         if (empty($properties->id)) {
2467             if (empty($properties)) {
2468                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2469             }
2470             $id = $properties;
2471             $properties = new stdClass;
2472             $properties->id = (int)$id;
2473             unset($id);
2474         }
2475         if (empty($properties->requester)) {
2476             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2477                 print_error('unknowncourserequest');
2478             }
2479         } else {
2480             $this->properties = $properties;
2481         }
2482         $this->properties->collision = null;
2483     }
2485     /**
2486      * Returns the requested property
2487      *
2488      * @param string $key
2489      * @return mixed
2490      */
2491     public function __get($key) {
2492         return $this->properties->$key;
2493     }
2495     /**
2496      * Override this to ensure empty($request->blah) calls return a reliable answer...
2497      *
2498      * This is required because we define the __get method
2499      *
2500      * @param mixed $key
2501      * @return bool True is it not empty, false otherwise
2502      */
2503     public function __isset($key) {
2504         return (!empty($this->properties->$key));
2505     }
2507     /**
2508      * Returns the user who requested this course
2509      *
2510      * Uses a static var to cache the results and cut down the number of db queries
2511      *
2512      * @staticvar array $requesters An array of cached users
2513      * @return stdClass The user who requested the course
2514      */
2515     public function get_requester() {
2516         global $DB;
2517         static $requesters= array();
2518         if (!array_key_exists($this->properties->requester, $requesters)) {
2519             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
2520         }
2521         return $requesters[$this->properties->requester];
2522     }
2524     /**
2525      * Checks that the shortname used by the course does not conflict with any other
2526      * courses that exist
2527      *
2528      * @param string|null $shortnamemark The string to append to the requests shortname
2529      *                     should a conflict be found
2530      * @return bool true is there is a conflict, false otherwise
2531      */
2532     public function check_shortname_collision($shortnamemark = '[*]') {
2533         global $DB;
2535         if ($this->properties->collision !== null) {
2536             return $this->properties->collision;
2537         }
2539         if (empty($this->properties->shortname)) {
2540             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
2541             $this->properties->collision = false;
2542         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
2543             if (!empty($shortnamemark)) {
2544                 $this->properties->shortname .= ' '.$shortnamemark;
2545             }
2546             $this->properties->collision = true;
2547         } else {
2548             $this->properties->collision = false;
2549         }
2550         return $this->properties->collision;
2551     }
2553     /**
2554      * Returns the category where this course request should be created
2555      *
2556      * Note that we don't check here that user has a capability to view
2557      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2558      * 'moodle/course:changecategory'
2559      *
2560      * @return coursecat
2561      */
2562     public function get_category() {
2563         global $CFG;
2564         require_once($CFG->libdir.'/coursecatlib.php');
2565         // If the category is not set, if the current user does not have the rights to change the category, or if the
2566         // category does not exist, we set the default category to the course to be approved.
2567         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2568         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
2569                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
2570             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
2571         }
2572         if (!$category) {
2573             $category = coursecat::get_default();
2574         }
2575         return $category;
2576     }
2578     /**
2579      * This function approves the request turning it into a course
2580      *
2581      * This function converts the course request into a course, at the same time
2582      * transferring any files used in the summary to the new course and then removing
2583      * the course request and the files associated with it.
2584      *
2585      * @return int The id of the course that was created from this request
2586      */
2587     public function approve() {
2588         global $CFG, $DB, $USER;
2590         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
2592         $courseconfig = get_config('moodlecourse');
2594         // Transfer appropriate settings
2595         $data = clone($this->properties);
2596         unset($data->id);
2597         unset($data->reason);
2598         unset($data->requester);
2600         // Set category
2601         $category = $this->get_category();
2602         $data->category = $category->id;
2603         // Set misc settings
2604         $data->requested = 1;
2606         // Apply course default settings
2607         $data->format             = $courseconfig->format;
2608         $data->newsitems          = $courseconfig->newsitems;
2609         $data->showgrades         = $courseconfig->showgrades;
2610         $data->showreports        = $courseconfig->showreports;
2611         $data->maxbytes           = $courseconfig->maxbytes;
2612         $data->groupmode          = $courseconfig->groupmode;
2613         $data->groupmodeforce     = $courseconfig->groupmodeforce;
2614         $data->visible            = $courseconfig->visible;
2615         $data->visibleold         = $data->visible;
2616         $data->lang               = $courseconfig->lang;
2617         $data->enablecompletion   = $courseconfig->enablecompletion;
2619         $course = create_course($data);
2620         $context = context_course::instance($course->id, MUST_EXIST);
2622         // add enrol instances
2623         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
2624             if ($manual = enrol_get_plugin('manual')) {
2625                 $manual->add_default_instance($course);
2626             }
2627         }
2629         // enrol the requester as teacher if necessary
2630         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2631             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
2632         }
2634         $this->delete();
2636         $a = new stdClass();
2637         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2638         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
2639         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
2641         return $course->id;
2642     }
2644     /**
2645      * Reject a course request
2646      *
2647      * This function rejects a course request, emailing the requesting user the
2648      * provided notice and then removing the request from the database
2649      *
2650      * @param string $notice The message to display to the user
2651      */
2652     public function reject($notice) {
2653         global $USER, $DB;
2654         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
2655         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
2656         $this->delete();
2657     }
2659     /**
2660      * Deletes the course request and any associated files
2661      */
2662     public function delete() {
2663         global $DB;
2664         $DB->delete_records('course_request', array('id' => $this->properties->id));
2665     }
2667     /**
2668      * Send a message from one user to another using events_trigger
2669      *
2670      * @param object $touser
2671      * @param object $fromuser
2672      * @param string $name
2673      * @param string $subject
2674      * @param string $message
2675      */
2676     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
2677         $eventdata = new stdClass();
2678         $eventdata->component         = 'moodle';
2679         $eventdata->name              = $name;
2680         $eventdata->userfrom          = $fromuser;
2681         $eventdata->userto            = $touser;
2682         $eventdata->subject           = $subject;
2683         $eventdata->fullmessage       = $message;
2684         $eventdata->fullmessageformat = FORMAT_PLAIN;
2685         $eventdata->fullmessagehtml   = '';
2686         $eventdata->smallmessage      = '';
2687         $eventdata->notification      = 1;
2688         message_send($eventdata);
2689     }
2692 /**
2693  * Return a list of page types
2694  * @param string $pagetype current page type
2695  * @param context $parentcontext Block's parent context
2696  * @param context $currentcontext Current context of block
2697  * @return array array of page types
2698  */
2699 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
2700     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
2701         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
2702         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2703             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
2704         );
2705     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
2706         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
2707         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
2708     } else {
2709         // Otherwise consider it a page inside a course even if $currentcontext is null
2710         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2711             'course-*' => get_string('page-course-x', 'pagetype'),
2712             'course-view-*' => get_string('page-course-view-x', 'pagetype')
2713         );
2714     }
2715     return $pagetypes;
2718 /**
2719  * Determine whether course ajax should be enabled for the specified course
2720  *
2721  * @param stdClass $course The course to test against
2722  * @return boolean Whether course ajax is enabled or note
2723  */
2724 function course_ajax_enabled($course) {
2725     global $CFG, $PAGE, $SITE;
2727     // The user must be editing for AJAX to be included
2728     if (!$PAGE->user_is_editing()) {
2729         return false;
2730     }
2732     // Check that the theme suports
2733     if (!$PAGE->theme->enablecourseajax) {
2734         return false;
2735     }
2737     // Check that the course format supports ajax functionality
2738     // The site 'format' doesn't have information on course format support
2739     if ($SITE->id !== $course->id) {
2740         $courseformatajaxsupport = course_format_ajax_support($course->format);
2741         if (!$courseformatajaxsupport->capable) {
2742             return false;
2743         }
2744     }
2746     // All conditions have been met so course ajax should be enabled
2747     return true;
2750 /**
2751  * Include the relevant javascript and language strings for the resource
2752  * toolbox YUI module
2753  *
2754  * @param integer $id The ID of the course being applied to
2755  * @param array $usedmodules An array containing the names of the modules in use on the page
2756  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
2757  * @param stdClass $config An object containing configuration parameters for ajax modules including:
2758  *          * resourceurl   The URL to post changes to for resource changes
2759  *          * sectionurl    The URL to post changes to for section changes
2760  *          * pageparams    Additional parameters to pass through in the post
2761  * @return bool
2762  */
2763 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
2764     global $CFG, $PAGE, $SITE;
2766     // Ensure that ajax should be included
2767     if (!course_ajax_enabled($course)) {
2768         return false;
2769     }
2771     if (!$config) {
2772         $config = new stdClass();
2773     }
2775     // The URL to use for resource changes
2776     if (!isset($config->resourceurl)) {
2777         $config->resourceurl = '/course/rest.php';
2778     }
2780     // The URL to use for section changes
2781     if (!isset($config->sectionurl)) {
2782         $config->sectionurl = '/course/rest.php';
2783     }
2785     // Any additional parameters which need to be included on page submission
2786     if (!isset($config->pageparams)) {
2787         $config->pageparams = array();
2788     }
2790     // Include toolboxes
2791     $PAGE->requires->yui_module('moodle-course-toolboxes',
2792             'M.course.init_resource_toolbox',
2793             array(array(
2794                 'courseid' => $course->id,
2795                 'ajaxurl' => $config->resourceurl,
2796                 'config' => $config,
2797             ))
2798     );
2799     $PAGE->requires->yui_module('moodle-course-toolboxes',
2800             'M.course.init_section_toolbox',
2801             array(array(
2802                 'courseid' => $course->id,
2803                 'format' => $course->format,
2804                 'ajaxurl' => $config->sectionurl,
2805                 'config' => $config,
2806             ))
2807     );
2809     // Include course dragdrop
2810     if (course_format_uses_sections($course->format)) {
2811         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
2812             array(array(
2813                 'courseid' => $course->id,
2814                 'ajaxurl' => $config->sectionurl,
2815                 'config' => $config,
2816             )), null, true);
2818         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
2819             array(array(
2820                 'courseid' => $course->id,
2821                 'ajaxurl' => $config->resourceurl,
2822                 'config' => $config,
2823             )), null, true);
2824     }
2826     // Require various strings for the command toolbox
2827     $PAGE->requires->strings_for_js(array(
2828             'moveleft',
2829             'deletechecktype',
2830             'deletechecktypename',
2831             'edittitle',
2832             'edittitleinstructions',
2833             'show',
2834             'hide',
2835             'highlight',
2836             'highlightoff',
2837             'groupsnone',
2838             'groupsvisible',
2839             'groupsseparate',
2840             'clicktochangeinbrackets',
2841             'markthistopic',
2842             'markedthistopic',
2843             'movesection',
2844             'movecoursemodule',
2845             'movecoursesection',
2846             'movecontent',
2847             'tocontent',
2848             'emptydragdropregion',
2849             'afterresource',
2850             'aftersection',
2851             'totopofsection',
2852         ), 'moodle');
2854     // Include section-specific strings for formats which support sections.
2855     if (course_format_uses_sections($course->format)) {
2856         $PAGE->requires->strings_for_js(array(
2857                 'showfromothers',
2858                 'hidefromothers',
2859             ), 'format_' . $course->format);
2860     }
2862     // For confirming resource deletion we need the name of the module in question
2863     foreach ($usedmodules as $module => $modname) {
2864         $PAGE->requires->string_for_js('pluginname', $module);
2865     }
2867     // Load drag and drop upload AJAX.
2868     require_once($CFG->dirroot.'/course/dnduploadlib.php');
2869     dndupload_add_to_course($course, $enabledmodules);
2871     return true;
2874 /**
2875  * Returns the sorted list of available course formats, filtered by enabled if necessary
2876  *
2877  * @param bool $enabledonly return only formats that are enabled
2878  * @return array array of sorted format names
2879  */
2880 function get_sorted_course_formats($enabledonly = false) {
2881     global $CFG;
2882     $formats = core_component::get_plugin_list('format');
2884     if (!empty($CFG->format_plugins_sortorder)) {
2885         $order = explode(',', $CFG->format_plugins_sortorder);
2886         $order = array_merge(array_intersect($order, array_keys($formats)),
2887                     array_diff(array_keys($formats), $order));
2888     } else {
2889         $order = array_keys($formats);
2890     }
2891     if (!$enabledonly) {
2892         return $order;
2893     }
2894     $sortedformats = array();
2895     foreach ($order as $formatname) {
2896         if (!get_config('format_'.$formatname, 'disabled')) {
2897             $sortedformats[] = $formatname;
2898         }
2899     }
2900     return $sortedformats;
2903 /**
2904  * The URL to use for the specified course (with section)
2905  *
2906  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
2907  * @param int|stdClass $section Section object from database or just field course_sections.section
2908  *     if omitted the course view page is returned
2909  * @param array $options options for view URL. At the moment core uses:
2910  *     'navigation' (bool) if true and section has no separate page, the function returns null
2911  *     'sr' (int) used by multipage formats to specify to which section to return
2912  * @return moodle_url The url of course
2913  */
2914 function course_get_url($courseorid, $section = null, $options = array()) {
2915     return course_get_format($courseorid)->get_view_url($section, $options);
2918 /**
2919  * Create a module.
2920  *
2921  * It includes:
2922  *      - capability checks and other checks
2923  *      - create the module from the module info
2924  *
2925  * @param object $module
2926  * @return object the created module info
2927  * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
2928  */
2929 function create_module($moduleinfo) {
2930     global $DB, $CFG;
2932     require_once($CFG->dirroot . '/course/modlib.php');
2934     // Check manadatory attributs.
2935     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
2936     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
2937         $mandatoryfields[] = 'introeditor';
2938     }
2939     foreach($mandatoryfields as $mandatoryfield) {
2940         if (!isset($moduleinfo->{$mandatoryfield})) {
2941             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
2942         }
2943     }
2945     // Some additional checks (capability / existing instances).
2946     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
2947     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
2949     // Add the module.
2950     $moduleinfo->module = $module->id;
2951     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
2953     return $moduleinfo;
2956 /**
2957  * Update a module.
2958  *
2959  * It includes:
2960  *      - capability and other checks
2961  *      - update the module
2962  *
2963  * @param object $module
2964  * @return object the updated module info
2965  * @throws moodle_exception if current user is not allowed to update the module
2966  */
2967 function update_module($moduleinfo) {
2968     global $DB, $CFG;
2970     require_once($CFG->dirroot . '/course/modlib.php');
2972     // Check the course module exists.
2973     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
2975     // Check the course exists.
2976     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
2978     // Some checks (capaibility / existing instances).
2979     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
2981     // Retrieve few information needed by update_moduleinfo.
2982     $moduleinfo->modulename = $cm->modname;
2983     if (!isset($moduleinfo->scale)) {
2984         $moduleinfo->scale = 0;
2985     }
2986     $moduleinfo->type = 'mod';
2988     // Update the module.
2989     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
2991     return $moduleinfo;
2994 /**
2995  * Duplicate a module on the course for ajax.
2996  *
2997  * @see mod_duplicate_module()
2998  * @param object $course The course
2999  * @param object $cm The course module to duplicate
3000  * @param int $sr The section to link back to (used for creating the links)
3001  * @throws moodle_exception if the plugin doesn't support duplication
3002  * @return Object containing:
3003  * - fullcontent: The HTML markup for the created CM
3004  * - cmid: The CMID of the newly created CM
3005  * - redirect: Whether to trigger a redirect following this change
3006  */
3007 function mod_duplicate_activity($course, $cm, $sr = null) {
3008     global $PAGE;
3010     $newcm = duplicate_module($course, $cm);
3012     $resp = new stdClass();
3013     if ($newcm) {
3014         $courserenderer = $PAGE->get_renderer('core', 'course');
3015         $completioninfo = new completion_info($course);
3016         $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3017                 $newcm, null, array());
3019         $resp->fullcontent = $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3020         $resp->cmid = $newcm->id;
3021     } else {
3022         // Trigger a redirect.
3023         $resp->redirect = true;
3024     }
3025     return $resp;
3028 /**
3029  * Api to duplicate a module.
3030  *
3031  * @param object $course course object.
3032  * @param object $cm course module object to be duplicated.
3033  * @since Moodle 2.8
3034  *
3035  * @throws Exception
3036  * @throws coding_exception
3037  * @throws moodle_exception
3038  * @throws restore_controller_exception
3039  *
3040  * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3041  */
3042 function duplicate_module($course, $cm) {
3043     global $CFG, $DB, $USER;
3044     require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
3045     require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
3046     require_once($CFG->libdir . '/filelib.php');
3048     $a          = new stdClass();
3049     $a->modtype = get_string('modulename', $cm->modname);
3050     $a->modname = format_string($cm->name);
3052     if (!plugin_supports('mod', $cm->modname, FEATURE_BACKUP_MOODLE2)) {
3053         throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3054     }
3056     // Backup the activity.
3058     $bc = new backup_controller(backup::TYPE_1ACTIVITY, $cm->id, backup::FORMAT_MOODLE,
3059             backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id);
3061     $backupid       = $bc->get_backupid();
3062     $backupbasepath = $bc->get_plan()->get_basepath();
3064     $bc->execute_plan();
3066     $bc->destroy();
3068     // Restore the backup immediately.
3070     $rc = new restore_controller($backupid, $course->id,
3071             backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id, backup::TARGET_CURRENT_ADDING);
3073     $cmcontext = context_module::instance($cm->id);
3074     if (!$rc->execute_precheck()) {
3075         $precheckresults = $rc->get_precheck_results();
3076         if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3077             if (empty($CFG->keeptempdirectoriesonbackup)) {
3078                 fulldelete($backupbasepath);
3079             }
3080         }
3081     }
3083     $rc->execute_plan();
3085     // Now a bit hacky part follows - we try to get the cmid of the newly
3086     // restored copy of the module.
3087     $newcmid = null;
3088     $tasks = $rc->get_plan()->get_tasks();
3089     foreach ($tasks as $task) {
3090         if (is_subclass_of($task, 'restore_activity_task')) {
3091             if ($task->get_old_contextid() == $cmcontext->id) {
3092                 $newcmid = $task->get_moduleid();
3093                 break;
3094             }
3095         }
3096     }
3098     // If we know the cmid of the new course module, let us move it
3099     // right below the original one. otherwise it will stay at the
3100     // end of the section.
3101     if ($newcmid) {
3102         $info = get_fast_modinfo($course);
3103         $newcm = $info->get_cm($newcmid);
3104         $section = $DB->get_record('course_sections', array('id' => $cm->section, 'course' => $cm->course));
3105         moveto_module($newcm, $section, $cm);
3106         moveto_module($cm, $section, $newcm);
3108         // Update calendar events with the duplicated module.
3109         $refresheventsfunction = $newcm->modname . '_refresh_events';
3110         if (function_exists($refresheventsfunction)) {
3111             call_user_func($refresheventsfunction, $newcm->course);
3112         }
3114         // Trigger course module created event. We can trigger the event only if we know the newcmid.
3115         $event = \core\event\course_module_created::create_from_cm($newcm);
3116         $event->trigger();
3117     }
3118     rebuild_course_cache($cm->course);
3120     $rc->destroy();
3122     if (empty($CFG->keeptempdirectoriesonbackup)) {
3123         fulldelete($backupbasepath);
3124     }
3126     return isset($newcm) ? $newcm : null;
3129 /**
3130  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3131  * Sorts by descending order of time.
3132  *
3133  * @param stdClass $a First object
3134  * @param stdClass $b Second object
3135  * @return int 0,1,-1 representing the order
3136  */
3137 function compare_activities_by_time_desc($a, $b) {
3138     // Make sure the activities actually have a timestamp property.
3139     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3140         return 0;
3141     }
3142     // We treat instances without timestamp as if they have a timestamp of 0.
3143     if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3144         return 1;
3145     }
3146     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3147         return -1;
3148     }
3149     if ($a->timestamp == $b->timestamp) {
3150         return 0;
3151     }
3152     return ($a->timestamp > $b->timestamp) ? -1 : 1;
3155 /**
3156  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3157  * Sorts by ascending order of time.
3158  *
3159  * @param stdClass $a First object
3160  * @param stdClass $b Second object
3161  * @return int 0,1,-1 representing the order
3162  */
3163 function compare_activities_by_time_asc($a, $b) {
3164     // Make sure the activities actually have a timestamp property.
3165     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3166       return 0;
3167     }
3168     // We treat instances without timestamp as if they have a timestamp of 0.
3169     if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3170         return -1;
3171     }
3172     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3173         return 1;
3174     }
3175     if ($a->timestamp == $b->timestamp) {
3176         return 0;
3177     }
3178     return ($a->timestamp < $b->timestamp) ? -1 : 1;
3181 /**
3182  * Changes the visibility of a course.
3183  *
3184  * @param int $courseid The course to change.
3185  * @param bool $show True to make it visible, false otherwise.
3186  * @return bool
3187  */
3188 function course_change_visibility($courseid, $show = true) {
3189     $course = new stdClass;
3190     $course->id = $courseid;
3191     $course->visible = ($show) ? '1' : '0';
3192     $course->visibleold = $course->visible;
3193     update_course($course);
3194     return true;
3197 /**
3198  * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3199  *
3200  * @param stdClass|course_in_list $course
3201  * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3202  * @return bool
3203  */
3204 function course_change_sortorder_by_one($course, $up) {
3205     global $DB;
3206     $params = array($course->sortorder, $course->category);
3207     if ($up) {
3208         $select = 'sortorder < ? AND category = ?';
3209         $sort = 'sortorder DESC';
3210     } else {
3211         $select = 'sortorder > ? AND category = ?';
3212         $sort = 'sortorder ASC';
3213     }
3214     fix_course_sortorder();
3215     $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3216     if ($swapcourse) {
3217         $swapcourse = reset($swapcourse);
3218         $DB->set_field('course', 'sortorder', $swapcourse->sortorder, array('id' => $course->id));
3219         $DB->set_field('course', 'sortorder', $course->sortorder, array('id' => $swapcourse->id));
3220         // Finally reorder courses.
3221         fix_course_sortorder();
3222         cache_helper::purge_by_event('changesincourse');
3223         return true;
3224     }
3225     return false;
3228 /**
3229  * Changes the sort order of courses in a category so that the first course appears after the second.
3230  *
3231  * @param int|stdClass $courseorid The course to focus on.
3232  * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3233  * @return bool
3234  */
3235 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3236     global $DB;
3238     if (!is_object($courseorid)) {
3239         $course = get_course($courseorid);
3240     } else {
3241         $course = $courseorid;
3242     }
3244     if ((int)$moveaftercourseid === 0) {
3245         // We've moving the course to the start of the queue.
3246         $sql = 'SELECT sortorder
3247                       FROM {course}
3248                      WHERE category = :categoryid
3249                   ORDER BY sortorder';
3250         $params = array(
3251             'categoryid' => $course->category
3252         );
3253         $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE);
3255         $sql = 'UPDATE {course}
3256                    SET sortorder = sortorder + 1
3257                  WHERE category = :categoryid
3258                    AND id <> :id';
3259         $params = array(
3260             'categoryid' => $course->category,
3261             'id' => $course->id,
3262         );
3263         $DB->execute($sql, $params);
3264         $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id));
3265     } else if ($course->id === $moveaftercourseid) {
3266         // They're the same - moronic.
3267         debugging("Invalid move after course given.", DEBUG_DEVELOPER);
3268         return false;
3269     } else {
3270         // Moving this course after the given course. It could be before it could be after.
3271         $moveaftercourse = get_course($moveaftercourseid);
3272         if ($course->category !== $moveaftercourse->category) {
3273             debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER);
3274             return false;
3275         }
3276         // Increment all courses in the same category that are ordered after the moveafter course.
3277         // This makes a space for the course we're moving.
3278         $sql = 'UPDATE {course}
3279                        SET sortorder = sortorder + 1
3280                      WHERE category = :categoryid
3281                        AND sortorder > :sortorder';
3282         $params = array(
3283             'categoryid' => $moveaftercourse->category,
3284             'sortorder' => $moveaftercourse->sortorder
3285         );
3286         $DB->execute($sql, $params);
3287         $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder + 1, array('id' => $course->id));
3288     }
3289     fix_course_sortorder();
3290     cache_helper::purge_by_event('changesincourse');
3291     return true;
3294 /**
3295  * Trigger course viewed event. This API function is used when course view actions happens,
3296  * usually in course/view.php but also in external functions.
3297  *
3298  * @param stdClass  $context course context object
3299  * @param int $sectionnumber section number
3300  * @since Moodle 2.9
3301  */
3302 function course_view($context, $sectionnumber = 0) {
3304     $eventdata = array('context' => $context);
3306     if (!empty($sectionnumber)) {
3307         $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3308     }
3310     $event = \core\event\course_viewed::create($eventdata);
3311     $event->trigger();
3314 /**
3315  * Returns courses tagged with a specified tag.
3316  *
3317  * @param core_tag_tag $tag
3318  * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3319  *             are displayed on the page and the per-page limit may be bigger
3320  * @param int $fromctx context id where the link was displayed, may be used by callbacks
3321  *            to display items in the same context first
3322  * @param int $ctx context id where to search for records
3323  * @param bool $rec search in subcontexts as well
3324  * @param int $page 0-based number of page being displayed
3325  * @return \core_tag\output\tagindex
3326  */
3327 function course_get_tagged_courses($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
3328     global $CFG, $PAGE;
3329     require_once($CFG->libdir . '/coursecatlib.php');
3331     $perpage = $exclusivemode ? $CFG->coursesperpage : 5;
3332     $displayoptions = array(
3333         'limit' => $perpage,
3334         'offset' => $page * $perpage,
3335         'viewmoreurl' => null,
3336     );
3338     $courserenderer = $PAGE->get_renderer('core', 'course');
3339     $totalcount = coursecat::search_courses_count(array('tagid' => $tag->id, 'ctx' => $ctx, 'rec' => $rec));
3340     $content = $courserenderer->tagged_courses($tag->id, $exclusivemode, $ctx, $rec, $displayoptions);
3341     $totalpages = ceil($totalcount / $perpage);
3343     return new core_tag\output\tagindex($tag, 'core', 'course', $content,
3344             $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
3347 /**
3348  * Implements callback inplace_editable() allowing to edit values in-place
3349  *
3350  * @param string $itemtype
3351  * @param int $itemid
3352  * @param mixed $newvalue
3353  * @return \core\output\inplace_editable
3354  */
3355 function core_course_inplace_editable($itemtype, $itemid, $newvalue) {
3356     if ($itemtype === 'activityname') {
3357         return \core_course\output\course_module_name::update($itemid, $newvalue);
3358     }
3361 /**
3362  * Returns course modules tagged with a specified tag ready for output on tag/index.php page
3363  *
3364  * This is a callback used by the tag area core/course_modules to search for course modules
3365  * tagged with a specific tag.
3366  *
3367  * @param core_tag_tag $tag
3368  * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
3369  *             are displayed on the page and the per-page limit may be bigger
3370  * @param int $fromcontextid context id where the link was displayed, may be used by callbacks
3371  *            to display items in the same context first
3372  * @param int $contextid context id where to search for records
3373  * @param bool $recursivecontext search in subcontexts as well
3374  * @param int $page 0-based number of page being displayed
3375  * @return \core_tag\output\tagindex
3376  */
3377 function course_get_tagged_course_modules($tag, $exclusivemode = false, $fromcontextid = 0, $contextid = 0,
3378                                           $recursivecontext = 1, $page = 0) {
3379     global $OUTPUT;
3380     $perpage = $exclusivemode ? 20 : 5;
3382     // Build select query.
3383     $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
3384     $query = "SELECT cm.id AS cmid, c.id AS courseid, $ctxselect
3385                 FROM {course_modules} cm
3386                 JOIN {tag_instance} tt ON cm.id = tt.itemid
3387                 JOIN {course} c ON cm.course = c.id
3388                 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
3389                WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
3390                 AND c.id %COURSEFILTER% AND cm.id %ITEMFILTER%";
3392     $params = array('itemtype' => 'course_modules', 'tagid' => $tag->id, 'component' => 'core',
3393         'coursemodulecontextlevel' => CONTEXT_MODULE);
3394     if ($contextid) {
3395         $context = context::instance_by_id($contextid);
3396         $query .= $recursivecontext ? ' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
3397         $params['contextid'] = $context->id;
3398         $params['path'] = $context->path.'/%';
3399     }
3401     $query .= ' ORDER BY';
3402     if ($fromcontextid) {
3403         // In order-clause specify that modules from inside "fromctx" context should be returned first.
3404         $fromcontext = context::instance_by_id($fromcontextid);
3405         $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
3406         $params['fromcontextid'] = $fromcontext->id;
3407         $params['frompath'] = $fromcontext->path.'/%';
3408     }
3409     $query .= ' c.sortorder, cm.id';
3410     $totalpages = $page + 1;
3412     // Use core_tag_index_builder to build and filter the list of items.
3413     // Request one item more than we need so we know if next page exists.
3414     $builder = new core_tag_index_builder('core', 'course_modules', $query, $params, $page * $perpage, $perpage + 1);
3415     while ($item = $builder->has_item_that_needs_access_check()) {
3416         context_helper::preload_from_record($item);
3417         $courseid = $item->courseid;
3418         if (!$builder->can_access_course($courseid)) {
3419             $builder->set_accessible($item, false);
3420             continue;
3421         }
3422         $modinfo = get_fast_modinfo($builder->get_course($courseid));
3423         // Set accessibility of this item and all other items in the same course.
3424         $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
3425             if ($taggeditem->courseid == $courseid) {
3426                 $cm = $modinfo->get_cm($taggeditem->cmid);
3427                 $builder->set_accessible($taggeditem, $cm->uservisible);
3428             }
3429         });
3430     }
3432     $items = $builder->get_items();
3433     if (count($items) > $perpage) {
3434         $totalpages = $page + 2; // We don't need exact page count, just indicate that the next page exists.
3435         array_pop($items);
3436     }
3438     // Build the display contents.
3439     if ($items) {
3440         $tagfeed = new core_tag\output\tagfeed();
3441         foreach ($items as $item) {
3442             context_helper::preload_from_record($item);
3443             $course = $builder->get_course($item->courseid);
3444             $modinfo = get_fast_modinfo($course);
3445             $cm = $modinfo->get_cm($item->cmid);
3446             $courseurl = course_get_url($item->courseid, $cm->sectionnum);
3447             $cmname = $cm->get_formatted_name();
3448             if (!$exclusivemode) {
3449                 $cmname = shorten_text($cmname, 100);
3450             }
3451             $cmname = html_writer::link($cm->url?:$courseurl, $cmname);
3452             $coursename = format_string($course->fullname, true,
3453                     array('context' => context_course::instance($item->courseid)));
3454             $coursename = html_writer::link($courseurl, $coursename);
3455             $icon = html_writer::empty_tag('img', array('src' => $cm->get_icon_url()));
3456             $tagfeed->add($icon, $cmname, $coursename);
3457         }
3459         $content = $OUTPUT->render_from_template('core_tag/tagfeed',
3460                 $tagfeed->export_for_template($OUTPUT));
3462         return new core_tag\output\tagindex($tag, 'core', 'course_modules', $content,
3463                 $exclusivemode, $fromcontextid, $contextid, $recursivecontext, $page, $totalpages);
3464     }
3467 /**
3468  * Return an object with the list of navigation options in a course that are avaialable or not for the current user.
3469  * This function also handles the frontpage course.
3470  *
3471  * @param  stdClass $context context object (it can be a course context or the system context for frontpage settings)
3472  * @param  stdClass $course  the course where the settings are being rendered (only used when $context is set to frontpage)
3473  * @return stdClass          the navigation options in a course and their availability status
3474  * @since  Moodle 3.2
3475  */
3476 function course_get_user_navigation_options($context, $course = null) {
3477     global $CFG;
3479     $isloggedin = isloggedin();
3480     $isguestuser = isguestuser();
3481     $isfrontpage = $context->contextlevel == CONTEXT_SYSTEM;
3483     if ($isfrontpage) {
3484         $sitecontext = $context;
3485     } else {
3486         $sitecontext = context_system::instance();
3487     }
3489     $options = new stdClass;
3490     $options->blogs = !empty($CFG->enableblogs) &&
3491                         ($CFG->bloglevel == BLOG_GLOBAL_LEVEL ||
3492                         ($CFG->bloglevel == BLOG_SITE_LEVEL and ($isloggedin and !$isguestuser)))
3493                         && has_capability('moodle/blog:view', $sitecontext);
3495     $options->notes = !empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $context);
3497     // Frontpage settings?
3498     if ($isfrontpage) {
3499         if ($course->id == SITEID) {
3500             $options->participants = has_capability('moodle/site:viewparticipants', $sitecontext);
3501         } else {
3502             $options->participants = has_capability('moodle/course:viewparticipants', context_course::instance($course->id));
3503         }
3505         $options->badges = !empty($CFG->enablebadges) && has_capability('moodle/badges:viewbadges', $sitecontext);
3506         $options->tags = !empty($CFG->usetags) && $isloggedin;
3507         $options->search = !empty($CFG->enableglobalsearch) && has_capability('moodle/search:query', $sitecontext);
3508         $options->calendar = $isloggedin;
3509     } else {
3510         $options->participants = has_capability('moodle/course:viewparticipants', $context);
3511         $options->badges = !empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) &&
3512                             has_capability('moodle/badges:viewbadges', $context);
3513         // Add view grade report is permitted.
3514         $grades = false;
3515         if (has_capability('moodle/grade:viewall', $context)) {
3516             $grades = true;
3517         } else if (!empty($course->showgrades)) {
3518             $reports = core_component::get_plugin_list('gradereport');
3519             if (is_array($reports) && count($reports) > 0) {  // Get all installed reports.
3520                 arsort($reports);   // User is last, we want to test it first.
3521                 foreach ($reports as $plugin => $plugindir) {
3522                     if (has_capability('gradereport/'.$plugin.':view', $context)) {
3523                         // Stop when the first visible plugin is found.
3524                         $grades = true;
3525                         break;
3526                     }
3527                 }
3528             }
3529         }
3530         $options->grades = $grades;
3531     }
3533     if (\core_competency\api::is_enabled()) {
3534         $capabilities = array('moodle/competency:coursecompetencyview', 'moodle/competency:coursecompetencymanage');
3535         $options->competencies = has_any_capability($capabilities, $context);
3536     }
3537     return $options;
3540 /**
3541  * Return an object with the list of administration options in a course that are available or not for the current user.
3542  * This function also handles the frontpage settings.
3543  *
3544  * @param  stdClass $course  course object (for frontpage it should be a clone of $SITE)
3545  * @param  stdClass $context context object (course context)
3546  * @return stdClass          the administration options in a course and their availability status
3547  * @since  Moodle 3.2
3548  */
3549 function course_get_user_administration_options($course, $context) {
3550     global $CFG;
3551     $isfrontpage = $course->id == SITEID;
3553     $options = new stdClass;
3554     $options->update = has_capability('moodle/course:update', $context);
3555     $options->filters = has_capability('moodle/filter:manage', $context) &&
3556                         count(filter_get_available_in_context($context)) > 0;
3557     $options->reports = has_capability('moodle/site:viewreports', $context);
3558     $options->backup = has_capability('moodle/backup:backupcourse', $context);
3559     $options->restore = has_capability('moodle/restore:restorecourse', $context);
3560     $options->files = $course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $context);
3562     if (!$isfrontpage) {
3563         $options->tags = has_capability('moodle/course:tag', $context);
3564         $options->gradebook = has_capability('moodle/grade:manage', $context);
3565         $options->outcomes = !empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $context);
3566         $options->badges = !empty($CFG->enablebadges);
3567         $options->import = has_capability('moodle/restore:restoretargetimport', $context);
3568         $options->publish = has_capability('moodle/course:publish', $context);
3569         $options->reset = has_capability('moodle/course:reset', $context);
3570         $options->roles = has_capability('moodle/role:switchroles', $context);
3572         // Add view grade report is permitted.
3573         $grades = false;
3574         if (has_capability('moodle/grade:viewall', $context)) {
3575             $grades = true;
3576         } else if (!empty($course->showgrades)) {