21c448135736208b32b8ed092a276957dbacae90
[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 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
234                    $modname="", $modid=0, $modaction="", $groupid=0) {
235     global $DB, $SESSION, $USER;
236     // It is assumed that $date is the GMT time of midnight for that day,
237     // and so the next 86400 seconds worth of logs are printed.
239     /// Setup for group handling.
241     /// If the group mode is separate, and this user does not have editing privileges,
242     /// then only the user's group can be viewed.
243     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
244         if (isset($SESSION->currentgroup[$course->id])) {
245             $groupid =  $SESSION->currentgroup[$course->id];
246         } else {
247             $groupid = groups_get_all_groups($course->id, $USER->id);
248             if (is_array($groupid)) {
249                 $groupid = array_shift(array_keys($groupid));
250                 $SESSION->currentgroup[$course->id] = $groupid;
251             } else {
252                 $groupid = 0;
253             }
254         }
255     }
256     /// If this course doesn't have groups, no groupid can be specified.
257     else if (!$course->groupmode) {
258         $groupid = 0;
259     }
261     $joins = array();
262     $params = array();
264     if ($course->id != SITEID || $modid != 0) {
265         $joins[] = "l.course = :courseid";
266         $params['courseid'] = $course->id;
267     }
269     if ($modname) {
270         $joins[] = "l.module = :modname";
271         $params['modname'] = $modname;
272     }
274     if ('site_errors' === $modid) {
275         $joins[] = "( l.action='error' OR l.action='infected' )";
276     } else if ($modid) {
277         $joins[] = "l.cmid = :modid";
278         $params['modid'] = $modid;
279     }
281     if ($modaction) {
282         $firstletter = substr($modaction, 0, 1);
283         if ($firstletter == '-') {
284             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
285             $params['modaction'] = '%'.substr($modaction, 1).'%';
286         } else {
287             $joins[] = $DB->sql_like('l.action', ':modaction', false);
288             $params['modaction'] = '%'.$modaction.'%';
289         }
290     }
293     /// Getting all members of a group.
294     if ($groupid and !$user) {
295         if ($gusers = groups_get_members($groupid)) {
296             $gusers = array_keys($gusers);
297             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
298         } else {
299             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
300         }
301     }
302     else if ($user) {
303         $joins[] = "l.userid = :userid";
304         $params['userid'] = $user;
305     }
307     if ($date) {
308         $enddate = $date + 86400;
309         $joins[] = "l.time > :date AND l.time < :enddate";
310         $params['date'] = $date;
311         $params['enddate'] = $enddate;
312     }
314     $selector = implode(' AND ', $joins);
316     $totalcount = 0;  // Initialise
317     $result = array();
318     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
319     $result['totalcount'] = $totalcount;
320     return $result;
324 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
325                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
327     global $CFG, $DB, $OUTPUT;
329     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
330                        $modname, $modid, $modaction, $groupid)) {
331         echo $OUTPUT->notification("No logs found!");
332         echo $OUTPUT->footer();
333         exit;
334     }
336     $courses = array();
338     if ($course->id == SITEID) {
339         $courses[0] = '';
340         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
341             foreach ($ccc as $cc) {
342                 $courses[$cc->id] = $cc->shortname;
343             }
344         }
345     } else {
346         $courses[$course->id] = $course->shortname;
347     }
349     $totalcount = $logs['totalcount'];
350     $count=0;
351     $ldcache = array();
352     $tt = getdate(time());
353     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
355     $strftimedatetime = get_string("strftimedatetime");
357     echo "<div class=\"info\">\n";
358     print_string("displayingrecords", "", $totalcount);
359     echo "</div>\n";
361     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
363     $table = new html_table();
364     $table->classes = array('logtable','generaltable');
365     $table->align = array('right', 'left', 'left');
366     $table->head = array(
367         get_string('time'),
368         get_string('ip_address'),
369         get_string('fullnameuser'),
370         get_string('action'),
371         get_string('info')
372     );
373     $table->data = array();
375     if ($course->id == SITEID) {
376         array_unshift($table->align, 'left');
377         array_unshift($table->head, get_string('course'));
378     }
380     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
381     if (empty($logs['logs'])) {
382         $logs['logs'] = array();
383     }
385     foreach ($logs['logs'] as $log) {
387         if (isset($ldcache[$log->module][$log->action])) {
388             $ld = $ldcache[$log->module][$log->action];
389         } else {
390             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
391             $ldcache[$log->module][$log->action] = $ld;
392         }
393         if ($ld && is_numeric($log->info)) {
394             // ugly hack to make sure fullname is shown correctly
395             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
396                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
397             } else {
398                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
399             }
400         }
402         //Filter log->info
403         $log->info = format_string($log->info);
405         // If $log->url has been trimmed short by the db size restriction
406         // code in add_to_log, keep a note so we don't add a link to a broken url
407         $brokenurl=(core_text::strlen($log->url)==100 && core_text::substr($log->url,97)=='...');
409         $row = array();
410         if ($course->id == SITEID) {
411             if (empty($log->course)) {
412                 $row[] = get_string('site');
413             } else {
414                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
415             }
416         }
418         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
420         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
421         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
423         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id))));
425         $displayaction="$log->module $log->action";
426         if ($brokenurl) {
427             $row[] = $displayaction;
428         } else {
429             $link = make_log_url($log->module,$log->url);
430             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
431         }
432         $row[] = $log->info;
433         $table->data[] = $row;
434     }
436     echo html_writer::table($table);
437     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
441 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
442                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
444     global $CFG, $DB, $OUTPUT;
446     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
447                        $modname, $modid, $modaction, $groupid)) {
448         echo $OUTPUT->notification("No logs found!");
449         echo $OUTPUT->footer();
450         exit;
451     }
453     if ($course->id == SITEID) {
454         $courses[0] = '';
455         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
456             foreach ($ccc as $cc) {
457                 $courses[$cc->id] = $cc->shortname;
458             }
459         }
460     }
462     $totalcount = $logs['totalcount'];
463     $count=0;
464     $ldcache = array();
465     $tt = getdate(time());
466     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
468     $strftimedatetime = get_string("strftimedatetime");
470     echo "<div class=\"info\">\n";
471     print_string("displayingrecords", "", $totalcount);
472     echo "</div>\n";
474     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
476     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
477     echo "<tr>";
478     if ($course->id == SITEID) {
479         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
480     }
481     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
482     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
483     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
484     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
485     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
486     echo "</tr>\n";
488     if (empty($logs['logs'])) {
489         echo "</table>\n";
490         return;
491     }
493     $row = 1;
494     foreach ($logs['logs'] as $log) {
496         $log->info = $log->coursename;
497         $row = ($row + 1) % 2;
499         if (isset($ldcache[$log->module][$log->action])) {
500             $ld = $ldcache[$log->module][$log->action];
501         } else {
502             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
503             $ldcache[$log->module][$log->action] = $ld;
504         }
505         if (0 && $ld && !empty($log->info)) {
506             // ugly hack to make sure fullname is shown correctly
507             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
508                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
509             } else {
510                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
511             }
512         }
514         //Filter log->info
515         $log->info = format_string($log->info);
517         echo '<tr class="r'.$row.'">';
518         if ($course->id == SITEID) {
519             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
520             echo "<td class=\"r$row c0\" >\n";
521             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
522             echo "</td>\n";
523         }
524         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
525              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
526         echo "<td class=\"r$row c2\" >\n";
527         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
528         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
529         echo "</td>\n";
530         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
531         echo "<td class=\"r$row c3\" >\n";
532         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
533         echo "</td>\n";
534         echo "<td class=\"r$row c4\">\n";
535         echo $log->action .': '.$log->module;
536         echo "</td>\n";
537         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
538         echo "</tr>\n";
539     }
540     echo "</table>\n";
542     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
546 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
547                         $modid, $modaction, $groupid) {
548     global $DB, $CFG;
550     require_once($CFG->libdir . '/csvlib.class.php');
552     $csvexporter = new csv_export_writer('tab');
554     $header = array();
555     $header[] = get_string('course');
556     $header[] = get_string('time');
557     $header[] = get_string('ip_address');
558     $header[] = get_string('fullnameuser');
559     $header[] = get_string('action');
560     $header[] = get_string('info');
562     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
563                        $modname, $modid, $modaction, $groupid)) {
564         return false;
565     }
567     $courses = array();
569     if ($course->id == SITEID) {
570         $courses[0] = '';
571         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
572             foreach ($ccc as $cc) {
573                 $courses[$cc->id] = $cc->shortname;
574             }
575         }
576     } else {
577         $courses[$course->id] = $course->shortname;
578     }
580     $count=0;
581     $ldcache = array();
582     $tt = getdate(time());
583     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
585     $strftimedatetime = get_string("strftimedatetime");
587     $csvexporter->set_filename('logs', '.txt');
588     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
589     $csvexporter->add_data($title);
590     $csvexporter->add_data($header);
592     if (empty($logs['logs'])) {
593         return true;
594     }
596     foreach ($logs['logs'] as $log) {
597         if (isset($ldcache[$log->module][$log->action])) {
598             $ld = $ldcache[$log->module][$log->action];
599         } else {
600             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
601             $ldcache[$log->module][$log->action] = $ld;
602         }
603         if ($ld && is_numeric($log->info)) {
604             // ugly hack to make sure fullname is shown correctly
605             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
606                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
607             } else {
608                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
609             }
610         }
612         //Filter log->info
613         $log->info = format_string($log->info);
614         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
616         $coursecontext = context_course::instance($course->id);
617         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
618         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
619         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
620         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
621         $csvexporter->add_data($row);
622     }
623     $csvexporter->download_file();
624     return true;
628 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
629                         $modid, $modaction, $groupid) {
631     global $CFG, $DB;
633     require_once("$CFG->libdir/excellib.class.php");
635     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
636                        $modname, $modid, $modaction, $groupid)) {
637         return false;
638     }
640     $courses = array();
642     if ($course->id == SITEID) {
643         $courses[0] = '';
644         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
645             foreach ($ccc as $cc) {
646                 $courses[$cc->id] = $cc->shortname;
647             }
648         }
649     } else {
650         $courses[$course->id] = $course->shortname;
651     }
653     $count=0;
654     $ldcache = array();
655     $tt = getdate(time());
656     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
658     $strftimedatetime = get_string("strftimedatetime");
660     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
661     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
662     $filename .= '.xls';
664     $workbook = new MoodleExcelWorkbook('-');
665     $workbook->send($filename);
667     $worksheet = array();
668     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
669                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
671     // Creating worksheets
672     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
673         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
674         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
675         $worksheet[$wsnumber]->set_column(1, 1, 30);
676         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
677                                     userdate(time(), $strftimedatetime));
678         $col = 0;
679         foreach ($headers as $item) {
680             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
681             $col++;
682         }
683     }
685     if (empty($logs['logs'])) {
686         $workbook->close();
687         return true;
688     }
690     $formatDate =& $workbook->add_format();
691     $formatDate->set_num_format(get_string('log_excel_date_format'));
693     $row = FIRSTUSEDEXCELROW;
694     $wsnumber = 1;
695     $myxls =& $worksheet[$wsnumber];
696     foreach ($logs['logs'] as $log) {
697         if (isset($ldcache[$log->module][$log->action])) {
698             $ld = $ldcache[$log->module][$log->action];
699         } else {
700             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
701             $ldcache[$log->module][$log->action] = $ld;
702         }
703         if ($ld && is_numeric($log->info)) {
704             // ugly hack to make sure fullname is shown correctly
705             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
706                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
707             } else {
708                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
709             }
710         }
712         // Filter log->info
713         $log->info = format_string($log->info);
714         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
716         if ($nroPages>1) {
717             if ($row > EXCELROWS) {
718                 $wsnumber++;
719                 $myxls =& $worksheet[$wsnumber];
720                 $row = FIRSTUSEDEXCELROW;
721             }
722         }
724         $coursecontext = context_course::instance($course->id);
726         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
727         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
728         $myxls->write($row, 2, $log->ip, '');
729         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
730         $myxls->write($row, 3, $fullname, '');
731         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
732         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
733         $myxls->write($row, 5, $log->info, '');
735         $row++;
736     }
738     $workbook->close();
739     return true;
742 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
743                         $modid, $modaction, $groupid) {
745     global $CFG, $DB;
747     require_once("$CFG->libdir/odslib.class.php");
749     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
750                        $modname, $modid, $modaction, $groupid)) {
751         return false;
752     }
754     $courses = array();
756     if ($course->id == SITEID) {
757         $courses[0] = '';
758         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
759             foreach ($ccc as $cc) {
760                 $courses[$cc->id] = $cc->shortname;
761             }
762         }
763     } else {
764         $courses[$course->id] = $course->shortname;
765     }
767     $count=0;
768     $ldcache = array();
769     $tt = getdate(time());
770     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
772     $strftimedatetime = get_string("strftimedatetime");
774     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
775     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
776     $filename .= '.ods';
778     $workbook = new MoodleODSWorkbook('-');
779     $workbook->send($filename);
781     $worksheet = array();
782     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
783                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
785     // Creating worksheets
786     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
787         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
788         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
789         $worksheet[$wsnumber]->set_column(1, 1, 30);
790         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
791                                     userdate(time(), $strftimedatetime));
792         $col = 0;
793         foreach ($headers as $item) {
794             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
795             $col++;
796         }
797     }
799     if (empty($logs['logs'])) {
800         $workbook->close();
801         return true;
802     }
804     $formatDate =& $workbook->add_format();
805     $formatDate->set_num_format(get_string('log_excel_date_format'));
807     $row = FIRSTUSEDEXCELROW;
808     $wsnumber = 1;
809     $myxls =& $worksheet[$wsnumber];
810     foreach ($logs['logs'] as $log) {
811         if (isset($ldcache[$log->module][$log->action])) {
812             $ld = $ldcache[$log->module][$log->action];
813         } else {
814             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
815             $ldcache[$log->module][$log->action] = $ld;
816         }
817         if ($ld && is_numeric($log->info)) {
818             // ugly hack to make sure fullname is shown correctly
819             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
820                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
821             } else {
822                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
823             }
824         }
826         // Filter log->info
827         $log->info = format_string($log->info);
828         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
830         if ($nroPages>1) {
831             if ($row > EXCELROWS) {
832                 $wsnumber++;
833                 $myxls =& $worksheet[$wsnumber];
834                 $row = FIRSTUSEDEXCELROW;
835             }
836         }
838         $coursecontext = context_course::instance($course->id);
840         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
841         $myxls->write_date($row, 1, $log->time);
842         $myxls->write_string($row, 2, $log->ip);
843         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
844         $myxls->write_string($row, 3, $fullname);
845         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
846         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
847         $myxls->write_string($row, 5, $log->info);
849         $row++;
850     }
852     $workbook->close();
853     return true;
856 /**
857  * Checks the integrity of the course data.
858  *
859  * In summary - compares course_sections.sequence and course_modules.section.
860  *
861  * More detailed, checks that:
862  * - course_sections.sequence contains each module id not more than once in the course
863  * - for each moduleid from course_sections.sequence the field course_modules.section
864  *   refers to the same section id (this means course_sections.sequence is more
865  *   important if they are different)
866  * - ($fullcheck only) each module in the course is present in one of
867  *   course_sections.sequence
868  * - ($fullcheck only) removes non-existing course modules from section sequences
869  *
870  * If there are any mismatches, the changes are made and records are updated in DB.
871  *
872  * Course cache is NOT rebuilt if there are any errors!
873  *
874  * This function is used each time when course cache is being rebuilt with $fullcheck = false
875  * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
876  *
877  * @param int $courseid id of the course
878  * @param array $rawmods result of funciton {@link get_course_mods()} - containst
879  *     the list of enabled course modules in the course. Retrieved from DB if not specified.
880  *     Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
881  * @param array $sections records from course_sections table for this course.
882  *     Retrieved from DB if not specified
883  * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
884  *     course modules from sequences. Only to be used in site maintenance mode when we are
885  *     sure that another user is not in the middle of the process of moving/removing a module.
886  * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
887  * @return array array of messages with found problems. Empty output means everything is ok
888  */
889 function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
890     global $DB;
891     $messages = array();
892     if ($sections === null) {
893         $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
894     }
895     if ($fullcheck) {
896         // Retrieve all records from course_modules regardless of module type visibility.
897         $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
898     }
899     if ($rawmods === null) {
900         $rawmods = get_course_mods($courseid);
901     }
902     if (!$fullcheck && (empty($sections) || empty($rawmods))) {
903         // If either of the arrays is empty, no modules are displayed anyway.
904         return true;
905     }
906     $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
908     // First make sure that each module id appears in section sequences only once.
909     // If it appears in several section sequences the last section wins.
910     // If it appears twice in one section sequence, the first occurence wins.
911     $modsection = array();
912     foreach ($sections as $sectionid => $section) {
913         $sections[$sectionid]->newsequence = $section->sequence;
914         if (!empty($section->sequence)) {
915             $sequence = explode(",", $section->sequence);
916             $sequenceunique = array_unique($sequence);
917             if (count($sequenceunique) != count($sequence)) {
918                 // Some course module id appears in this section sequence more than once.
919                 ksort($sequenceunique); // Preserve initial order of modules.
920                 $sequence = array_values($sequenceunique);
921                 $sections[$sectionid]->newsequence = join(',', $sequence);
922                 $messages[] = $debuggingprefix.'Sequence for course section ['.
923                         $sectionid.'] is "'.$sections[$sectionid]->sequence.'", must be "'.$sections[$sectionid]->newsequence.'"';
924             }
925             foreach ($sequence as $cmid) {
926                 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
927                     // Some course module id appears to be in more than one section's sequences.
928                     $wrongsectionid = $modsection[$cmid];
929                     $sections[$wrongsectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence. ','), ',');
930                     $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
931                             $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
932                 }
933                 $modsection[$cmid] = $sectionid;
934             }
935         }
936     }
938     // Add orphaned modules to their sections if they exist or to section 0 otherwise.
939     if ($fullcheck) {
940         foreach ($rawmods as $cmid => $mod) {
941             if (!isset($modsection[$cmid])) {
942                 // This is a module that is not mentioned in course_section.sequence at all.
943                 // Add it to the section $mod->section or to the last available section.
944                 if ($mod->section && isset($sections[$mod->section])) {
945                     $modsection[$cmid] = $mod->section;
946                 } else {
947                     $firstsection = reset($sections);
948                     $modsection[$cmid] = $firstsection->id;
949                 }
950                 $sections[$modsection[$cmid]]->newsequence = trim($sections[$modsection[$cmid]]->newsequence.','.$cmid, ',');
951                 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
952                         $modsection[$cmid].']';
953             }
954         }
955         foreach ($modsection as $cmid => $sectionid) {
956             if (!isset($rawmods[$cmid])) {
957                 // Section $sectionid refers to module id that does not exist.
958                 $sections[$sectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence.','), ',');
959                 $messages[] = $debuggingprefix.'Course module ['.$cmid.
960                         '] does not exist but is present in the sequence of section ['.$sectionid.']';
961             }
962         }
963     }
965     // Update changed sections.
966     if (!$checkonly && !empty($messages)) {
967         foreach ($sections as $sectionid => $section) {
968             if ($section->newsequence !== $section->sequence) {
969                 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence));
970             }
971         }
972     }
974     // Now make sure that all modules point to the correct sections.
975     foreach ($rawmods as $cmid => $mod) {
976         if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section) {
977             if (!$checkonly) {
978                 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
979             }
980             $messages[] = $debuggingprefix.'Course module ['.$cmid.
981                     '] points to section ['.$mod->section.'] instead of ['.$modsection[$cmid].']';
982         }
983     }
985     return $messages;
988 /**
989  * For a given course, returns an array of course activity objects
990  * Each item in the array contains he following properties:
991  */
992 function get_array_of_activities($courseid) {
993 //  cm - course module id
994 //  mod - name of the module (eg forum)
995 //  section - the number of the section (eg week or topic)
996 //  name - the name of the instance
997 //  visible - is the instance visible or not
998 //  groupingid - grouping id
999 //  extra - contains extra string to include in any link
1000     global $CFG, $DB;
1002     $course = $DB->get_record('course', array('id'=>$courseid));
1004     if (empty($course)) {
1005         throw new moodle_exception('courseidnotfound');
1006     }
1008     $mod = array();
1010     $rawmods = get_course_mods($courseid);
1011     if (empty($rawmods)) {
1012         return $mod; // always return array
1013     }
1015     if ($sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence')) {
1016         // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
1017         if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
1018             debugging(join('<br>', $errormessages));
1019             $rawmods = get_course_mods($courseid);
1020             $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence');
1021         }
1022         // Build array of activities.
1023        foreach ($sections as $section) {
1024            if (!empty($section->sequence)) {
1025                $sequence = explode(",", $section->sequence);
1026                foreach ($sequence as $seq) {
1027                    if (empty($rawmods[$seq])) {
1028                        continue;
1029                    }
1030                    $mod[$seq] = new stdClass();
1031                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1032                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1033                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1035                     // Oh dear. Inconsistent names left here for backward compatibility.
1036                    $mod[$seq]->section          = $section->section;
1037                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1039                    $mod[$seq]->module           = $rawmods[$seq]->module;
1040                    $mod[$seq]->added            = $rawmods[$seq]->added;
1041                    $mod[$seq]->score            = $rawmods[$seq]->score;
1042                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1043                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1044                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1045                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1046                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1047                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1048                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1049                    $mod[$seq]->extra            = "";
1050                    $mod[$seq]->completiongradeitemnumber =
1051                            $rawmods[$seq]->completiongradeitemnumber;
1052                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1053                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1054                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1055                    $mod[$seq]->availability = $rawmods[$seq]->availability;
1057                    $modname = $mod[$seq]->mod;
1058                    $functionname = $modname."_get_coursemodule_info";
1060                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1061                        continue;
1062                    }
1064                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1066                    if ($hasfunction = function_exists($functionname)) {
1067                        if ($info = $functionname($rawmods[$seq])) {
1068                            if (!empty($info->icon)) {
1069                                $mod[$seq]->icon = $info->icon;
1070                            }
1071                            if (!empty($info->iconcomponent)) {
1072                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1073                            }
1074                            if (!empty($info->name)) {
1075                                $mod[$seq]->name = $info->name;
1076                            }
1077                            if ($info instanceof cached_cm_info) {
1078                                // When using cached_cm_info you can include three new fields
1079                                // that aren't available for legacy code
1080                                if (!empty($info->content)) {
1081                                    $mod[$seq]->content = $info->content;
1082                                }
1083                                if (!empty($info->extraclasses)) {
1084                                    $mod[$seq]->extraclasses = $info->extraclasses;
1085                                }
1086                                if (!empty($info->iconurl)) {
1087                                    // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
1088                                    $url = new moodle_url($info->iconurl);
1089                                    $mod[$seq]->iconurl = $url->out(false);
1090                                }
1091                                if (!empty($info->onclick)) {
1092                                    $mod[$seq]->onclick = $info->onclick;
1093                                }
1094                                if (!empty($info->customdata)) {
1095                                    $mod[$seq]->customdata = $info->customdata;
1096                                }
1097                            } else {
1098                                // When using a stdclass, the (horrible) deprecated ->extra field
1099                                // is available for BC
1100                                if (!empty($info->extra)) {
1101                                    $mod[$seq]->extra = $info->extra;
1102                                }
1103                            }
1104                        }
1105                    }
1106                    // When there is no modname_get_coursemodule_info function,
1107                    // but showdescriptions is enabled, then we use the 'intro'
1108                    // and 'introformat' fields in the module table
1109                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1110                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1111                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1112                            // Set content from intro and introformat. Filters are disabled
1113                            // because we  filter it with format_text at display time
1114                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1115                                    $modvalues, $rawmods[$seq]->id, false);
1117                            // To save making another query just below, put name in here
1118                            $mod[$seq]->name = $modvalues->name;
1119                        }
1120                    }
1121                    if (!isset($mod[$seq]->name)) {
1122                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1123                    }
1125                     // Minimise the database size by unsetting default options when they are
1126                     // 'empty'. This list corresponds to code in the cm_info constructor.
1127                     foreach (array('idnumber', 'groupmode', 'groupingid',
1128                             'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1129                             'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
1130                             'completionexpected', 'score', 'showdescription') as $property) {
1131                        if (property_exists($mod[$seq], $property) &&
1132                                empty($mod[$seq]->{$property})) {
1133                            unset($mod[$seq]->{$property});
1134                        }
1135                    }
1136                    // Special case: this value is usually set to null, but may be 0
1137                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1138                            is_null($mod[$seq]->completiongradeitemnumber)) {
1139                        unset($mod[$seq]->completiongradeitemnumber);
1140                    }
1141                }
1142             }
1143         }
1144     }
1145     return $mod;
1148 /**
1149  * Returns the localised human-readable names of all used modules
1150  *
1151  * @param bool $plural if true returns the plural forms of the names
1152  * @return array where key is the module name (component name without 'mod_') and
1153  *     the value is the human-readable string. Array sorted alphabetically by value
1154  */
1155 function get_module_types_names($plural = false) {
1156     static $modnames = null;
1157     global $DB, $CFG;
1158     if ($modnames === null) {
1159         $modnames = array(0 => array(), 1 => array());
1160         if ($allmods = $DB->get_records("modules")) {
1161             foreach ($allmods as $mod) {
1162                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1163                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1164                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1165                 }
1166             }
1167             core_collator::asort($modnames[0]);
1168             core_collator::asort($modnames[1]);
1169         }
1170     }
1171     return $modnames[(int)$plural];
1174 /**
1175  * Set highlighted section. Only one section can be highlighted at the time.
1176  *
1177  * @param int $courseid course id
1178  * @param int $marker highlight section with this number, 0 means remove higlightin
1179  * @return void
1180  */
1181 function course_set_marker($courseid, $marker) {
1182     global $DB;
1183     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1184     format_base::reset_course_cache($courseid);
1187 /**
1188  * For a given course section, marks it visible or hidden,
1189  * and does the same for every activity in that section
1190  *
1191  * @param int $courseid course id
1192  * @param int $sectionnumber The section number to adjust
1193  * @param int $visibility The new visibility
1194  * @return array A list of resources which were hidden in the section
1195  */
1196 function set_section_visible($courseid, $sectionnumber, $visibility) {
1197     global $DB;
1199     $resourcestotoggle = array();
1200     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1201         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1203         $event = \core\event\course_section_updated::create(array(
1204             'context' => context_course::instance($courseid),
1205             'objectid' => $section->id,
1206             'other' => array(
1207                 'sectionnum' => $sectionnumber
1208             )
1209         ));
1210         $event->add_record_snapshot('course_sections', $section);
1211         $event->trigger();
1213         if (!empty($section->sequence)) {
1214             $modules = explode(",", $section->sequence);
1215             foreach ($modules as $moduleid) {
1216                 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1217                     if ($visibility) {
1218                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1219                         set_coursemodule_visible($moduleid, $cm->visibleold);
1220                     } else {
1221                         // We hide the section, so we hide the module but we store the original state in visibleold.
1222                         set_coursemodule_visible($moduleid, 0);
1223                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1224                     }
1225                     \core\event\course_module_updated::create_from_cm($cm)->trigger();
1226                 }
1227             }
1228         }
1229         rebuild_course_cache($courseid, true);
1231         // Determine which modules are visible for AJAX update
1232         if (!empty($modules)) {
1233             list($insql, $params) = $DB->get_in_or_equal($modules);
1234             $select = 'id ' . $insql . ' AND visible = ?';
1235             array_push($params, $visibility);
1236             if (!$visibility) {
1237                 $select .= ' AND visibleold = 1';
1238             }
1239             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1240         }
1241     }
1242     return $resourcestotoggle;
1245 /**
1246  * Retrieve all metadata for the requested modules
1247  *
1248  * @param object $course The Course
1249  * @param array $modnames An array containing the list of modules and their
1250  * names
1251  * @param int $sectionreturn The section to return to
1252  * @return array A list of stdClass objects containing metadata about each
1253  * module
1254  */
1255 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1256     global $CFG, $OUTPUT;
1258     // get_module_metadata will be called once per section on the page and courses may show
1259     // different modules to one another
1260     static $modlist = array();
1261     if (!isset($modlist[$course->id])) {
1262         $modlist[$course->id] = array();
1263     }
1265     $return = array();
1266     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1267     if ($sectionreturn !== null) {
1268         $urlbase->param('sr', $sectionreturn);
1269     }
1270     foreach($modnames as $modname => $modnamestr) {
1271         if (!course_allowed_module($course, $modname)) {
1272             continue;
1273         }
1274         if (isset($modlist[$course->id][$modname])) {
1275             // This module is already cached
1276             $return[$modname] = $modlist[$course->id][$modname];
1277             continue;
1278         }
1280         // Include the module lib
1281         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1282         if (!file_exists($libfile)) {
1283             continue;
1284         }
1285         include_once($libfile);
1287         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1288         $gettypesfunc =  $modname.'_get_types';
1289         $types = MOD_SUBTYPE_NO_CHILDREN;
1290         if (function_exists($gettypesfunc)) {
1291             $types = $gettypesfunc();
1292         }
1293         if ($types !== MOD_SUBTYPE_NO_CHILDREN) {
1294             if (is_array($types) && count($types) > 0) {
1295                 $group = new stdClass();
1296                 $group->name = $modname;
1297                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1298                 foreach($types as $type) {
1299                     if ($type->typestr === '--') {
1300                         continue;
1301                     }
1302                     if (strpos($type->typestr, '--') === 0) {
1303                         $group->title = str_replace('--', '', $type->typestr);
1304                         continue;
1305                     }
1306                     // Set the Sub Type metadata
1307                     $subtype = new stdClass();
1308                     $subtype->title = $type->typestr;
1309                     $subtype->type = str_replace('&amp;', '&', $type->type);
1310                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1311                     $subtype->archetype = $type->modclass;
1313                     // The group archetype should match the subtype archetypes and all subtypes
1314                     // should have the same archetype
1315                     $group->archetype = $subtype->archetype;
1317                     if (!empty($type->help)) {
1318                         $subtype->help = $type->help;
1319                     } else if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1320                         $subtype->help = get_string('help' . $subtype->name, $modname);
1321                     }
1322                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1323                     $group->types[] = $subtype;
1324                 }
1325                 $modlist[$course->id][$modname] = $group;
1326             }
1327         } else {
1328             $module = new stdClass();
1329             $module->title = $modnamestr;
1330             $module->name = $modname;
1331             $module->link = new moodle_url($urlbase, array('add' => $modname));
1332             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1333             $sm = get_string_manager();
1334             if ($sm->string_exists('modulename_help', $modname)) {
1335                 $module->help = get_string('modulename_help', $modname);
1336                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1337                     $link = get_string('modulename_link', $modname);
1338                     $linktext = get_string('morehelp');
1339                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1340                 }
1341             }
1342             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1343             $modlist[$course->id][$modname] = $module;
1344         }
1345         if (isset($modlist[$course->id][$modname])) {
1346             $return[$modname] = $modlist[$course->id][$modname];
1347         } else {
1348             debugging("Invalid module metadata configuration for {$modname}");
1349         }
1350     }
1352     return $return;
1355 /**
1356  * Return the course category context for the category with id $categoryid, except
1357  * that if $categoryid is 0, return the system context.
1358  *
1359  * @param integer $categoryid a category id or 0.
1360  * @return context the corresponding context
1361  */
1362 function get_category_or_system_context($categoryid) {
1363     if ($categoryid) {
1364         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1365     } else {
1366         return context_system::instance();
1367     }
1370 /**
1371  * Returns full course categories trees to be used in html_writer::select()
1372  *
1373  * Calls {@link coursecat::make_categories_list()} to build the tree and
1374  * adds whitespace to denote nesting
1375  *
1376  * @return array array mapping coursecat id to the display name
1377  */
1378 function make_categories_options() {
1379     global $CFG;
1380     require_once($CFG->libdir. '/coursecatlib.php');
1381     $cats = coursecat::make_categories_list('', 0, ' / ');
1382     foreach ($cats as $key => $value) {
1383         // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1384         $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
1385     }
1386     return $cats;
1389 /**
1390  * Print the buttons relating to course requests.
1391  *
1392  * @param object $context current page context.
1393  */
1394 function print_course_request_buttons($context) {
1395     global $CFG, $DB, $OUTPUT;
1396     if (empty($CFG->enablecourserequests)) {
1397         return;
1398     }
1399     if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
1400     /// Print a button to request a new course
1401         echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
1402     }
1403     /// Print a button to manage pending requests
1404     if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
1405         $disabled = !$DB->record_exists('course_request', array());
1406         echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
1407     }
1410 /**
1411  * Does the user have permission to edit things in this category?
1412  *
1413  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1414  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1415  */
1416 function can_edit_in_category($categoryid = 0) {
1417     $context = get_category_or_system_context($categoryid);
1418     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1421 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1423 function add_course_module($mod) {
1424     global $DB;
1426     $mod->added = time();
1427     unset($mod->id);
1429     $cmid = $DB->insert_record("course_modules", $mod);
1430     rebuild_course_cache($mod->course, true);
1431     return $cmid;
1434 /**
1435  * Creates missing course section(s) and rebuilds course cache
1436  *
1437  * @param int|stdClass $courseorid course id or course object
1438  * @param int|array $sections list of relative section numbers to create
1439  * @return bool if there were any sections created
1440  */
1441 function course_create_sections_if_missing($courseorid, $sections) {
1442     global $DB;
1443     if (!is_array($sections)) {
1444         $sections = array($sections);
1445     }
1446     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1447     if (is_object($courseorid)) {
1448         $courseorid = $courseorid->id;
1449     }
1450     $coursechanged = false;
1451     foreach ($sections as $sectionnum) {
1452         if (!in_array($sectionnum, $existing)) {
1453             $cw = new stdClass();
1454             $cw->course   = $courseorid;
1455             $cw->section  = $sectionnum;
1456             $cw->summary  = '';
1457             $cw->summaryformat = FORMAT_HTML;
1458             $cw->sequence = '';
1459             $id = $DB->insert_record("course_sections", $cw);
1460             $coursechanged = true;
1461         }
1462     }
1463     if ($coursechanged) {
1464         rebuild_course_cache($courseorid, true);
1465     }
1466     return $coursechanged;
1469 /**
1470  * Adds an existing module to the section
1471  *
1472  * Updates both tables {course_sections} and {course_modules}
1473  *
1474  * Note: This function does not use modinfo PROVIDED that the section you are
1475  * adding the module to already exists. If the section does not exist, it will
1476  * build modinfo if necessary and create the section.
1477  *
1478  * @param int|stdClass $courseorid course id or course object
1479  * @param int $cmid id of the module already existing in course_modules table
1480  * @param int $sectionnum relative number of the section (field course_sections.section)
1481  *     If section does not exist it will be created
1482  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1483  *     before which the module needs to be included. Null for inserting in the
1484  *     end of the section
1485  * @return int The course_sections ID where the module is inserted
1486  */
1487 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1488     global $DB, $COURSE;
1489     if (is_object($beforemod)) {
1490         $beforemod = $beforemod->id;
1491     }
1492     if (is_object($courseorid)) {
1493         $courseid = $courseorid->id;
1494     } else {
1495         $courseid = $courseorid;
1496     }
1497     // Do not try to use modinfo here, there is no guarantee it is valid!
1498     $section = $DB->get_record('course_sections',
1499             array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
1500     if (!$section) {
1501         // This function call requires modinfo.
1502         course_create_sections_if_missing($courseorid, $sectionnum);
1503         $section = $DB->get_record('course_sections',
1504                 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
1505     }
1507     $modarray = explode(",", trim($section->sequence));
1508     if (empty($section->sequence)) {
1509         $newsequence = "$cmid";
1510     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1511         $insertarray = array($cmid, $beforemod);
1512         array_splice($modarray, $key[0], 1, $insertarray);
1513         $newsequence = implode(",", $modarray);
1514     } else {
1515         $newsequence = "$section->sequence,$cmid";
1516     }
1517     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
1518     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
1519     if (is_object($courseorid)) {
1520         rebuild_course_cache($courseorid->id, true);
1521     } else {
1522         rebuild_course_cache($courseorid, true);
1523     }
1524     return $section->id;     // Return course_sections ID that was used.
1527 /**
1528  * Change the group mode of a course module.
1529  *
1530  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1531  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1532  *
1533  * @param int $id course module ID.
1534  * @param int $groupmode the new groupmode value.
1535  * @return bool True if the $groupmode was updated.
1536  */
1537 function set_coursemodule_groupmode($id, $groupmode) {
1538     global $DB;
1539     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1540     if ($cm->groupmode != $groupmode) {
1541         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1542         rebuild_course_cache($cm->course, true);
1543     }
1544     return ($cm->groupmode != $groupmode);
1547 function set_coursemodule_idnumber($id, $idnumber) {
1548     global $DB;
1549     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1550     if ($cm->idnumber != $idnumber) {
1551         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1552         rebuild_course_cache($cm->course, true);
1553     }
1554     return ($cm->idnumber != $idnumber);
1557 /**
1558  * Set the visibility of a module and inherent properties.
1559  *
1560  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1561  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1562  *
1563  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1564  * has been moved to {@link set_section_visible()} which was the only place from which
1565  * the parameter was used.
1566  *
1567  * @param int $id of the module
1568  * @param int $visible state of the module
1569  * @return bool false when the module was not found, true otherwise
1570  */
1571 function set_coursemodule_visible($id, $visible) {
1572     global $DB, $CFG;
1573     require_once($CFG->libdir.'/gradelib.php');
1574     require_once($CFG->dirroot.'/calendar/lib.php');
1576     // Trigger developer's attention when using the previously removed argument.
1577     if (func_num_args() > 2) {
1578         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1579             has been removed.', DEBUG_DEVELOPER);
1580     }
1582     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1583         return false;
1584     }
1586     // Create events and propagate visibility to associated grade items if the value has changed.
1587     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1588     if ($cm->visible == $visible) {
1589         return true;
1590     }
1592     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
1593         return false;
1594     }
1595     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
1596         foreach($events as $event) {
1597             if ($visible) {
1598                 $event = new calendar_event($event);
1599                 $event->toggle_visibility(true);
1600             } else {
1601                 $event = new calendar_event($event);
1602                 $event->toggle_visibility(false);
1603             }
1604         }
1605     }
1607     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1608     // affect visibleold to allow for an original visibility restore. See set_section_visible().
1609     $cminfo = new stdClass();
1610     $cminfo->id = $id;
1611     $cminfo->visible = $visible;
1612     $cminfo->visibleold = $visible;
1613     $DB->update_record('course_modules', $cminfo);
1615     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1616     // Note that this must be done after updating the row in course_modules, in case
1617     // the modules grade_item_update function needs to access $cm->visible.
1618     if (plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY) &&
1619             component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1620         $instance = $DB->get_record($modulename, array('id' => $cm->instance), '*', MUST_EXIST);
1621         component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1622     } else {
1623         $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1624         if ($grade_items) {
1625             foreach ($grade_items as $grade_item) {
1626                 $grade_item->set_hidden(!$visible);
1627             }
1628         }
1629     }
1631     rebuild_course_cache($cm->course, true);
1632     return true;
1635 /**
1636  * This function will handle the whole deletion process of a module. This includes calling
1637  * the modules delete_instance function, deleting files, events, grades, conditional data,
1638  * the data in the course_module and course_sections table and adding a module deletion
1639  * event to the DB.
1640  *
1641  * @param int $cmid the course module id
1642  * @since Moodle 2.5
1643  */
1644 function course_delete_module($cmid) {
1645     global $CFG, $DB;
1647     require_once($CFG->libdir.'/gradelib.php');
1648     require_once($CFG->libdir.'/questionlib.php');
1649     require_once($CFG->dirroot.'/blog/lib.php');
1650     require_once($CFG->dirroot.'/calendar/lib.php');
1651     require_once($CFG->dirroot.'/tag/lib.php');
1653     // Get the course module.
1654     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1655         return true;
1656     }
1658     // Get the module context.
1659     $modcontext = context_module::instance($cm->id);
1661     // Get the course module name.
1662     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1664     // Get the file location of the delete_instance function for this module.
1665     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1667     // Include the file required to call the delete_instance function for this module.
1668     if (file_exists($modlib)) {
1669         require_once($modlib);
1670     } else {
1671         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1672             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1673     }
1675     $deleteinstancefunction = $modulename . '_delete_instance';
1677     // Ensure the delete_instance function exists for this module.
1678     if (!function_exists($deleteinstancefunction)) {
1679         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1680             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1681     }
1683     // Delete activity context questions and question categories.
1684     question_delete_activity($cm);
1686     // Call the delete_instance function, if it returns false throw an exception.
1687     if (!$deleteinstancefunction($cm->instance)) {
1688         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1689             "Cannot delete the module $modulename (instance).");
1690     }
1692     // Remove all module files in case modules forget to do that.
1693     $fs = get_file_storage();
1694     $fs->delete_area_files($modcontext->id);
1696     // Delete events from calendar.
1697     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1698         foreach($events as $event) {
1699             $calendarevent = calendar_event::load($event->id);
1700             $calendarevent->delete();
1701         }
1702     }
1704     // Delete grade items, outcome items and grades attached to modules.
1705     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1706                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1707         foreach ($grade_items as $grade_item) {
1708             $grade_item->delete('moddelete');
1709         }
1710     }
1712     // Delete completion and availability data; it is better to do this even if the
1713     // features are not turned on, in case they were turned on previously (these will be
1714     // very quick on an empty table).
1715     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1716     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1717                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1719     // Delete all tag instances associated with the instance of this module.
1720     tag_delete_instances('mod_' . $modulename, $modcontext->id);
1722     // Delete the context.
1723     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1725     // Delete the module from the course_modules table.
1726     $DB->delete_records('course_modules', array('id' => $cm->id));
1728     // Delete module from that section.
1729     if (!delete_mod_from_section($cm->id, $cm->section)) {
1730         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1731             "Cannot delete the module $modulename (instance) from section.");
1732     }
1734     // Trigger event for course module delete action.
1735     $event = \core\event\course_module_deleted::create(array(
1736         'courseid' => $cm->course,
1737         'context'  => $modcontext,
1738         'objectid' => $cm->id,
1739         'other'    => array(
1740             'modulename' => $modulename,
1741             'instanceid'   => $cm->instance,
1742         )
1743     ));
1744     $event->add_record_snapshot('course_modules', $cm);
1745     $event->trigger();
1746     rebuild_course_cache($cm->course, true);
1749 function delete_mod_from_section($modid, $sectionid) {
1750     global $DB;
1752     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1754         $modarray = explode(",", $section->sequence);
1756         if ($key = array_keys ($modarray, $modid)) {
1757             array_splice($modarray, $key[0], 1);
1758             $newsequence = implode(",", $modarray);
1759             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1760             rebuild_course_cache($section->course, true);
1761             return true;
1762         } else {
1763             return false;
1764         }
1766     }
1767     return false;
1770 /**
1771  * Moves a section within a course, from a position to another.
1772  * Be very careful: $section and $destination refer to section number,
1773  * not id!.
1774  *
1775  * @param object $course
1776  * @param int $section Section number (not id!!!)
1777  * @param int $destination
1778  * @param bool $ignorenumsections
1779  * @return boolean Result
1780  */
1781 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1782 /// Moves a whole course section up and down within the course
1783     global $USER, $DB;
1785     if (!$destination && $destination != 0) {
1786         return true;
1787     }
1789     // compartibility with course formats using field 'numsections'
1790     $courseformatoptions = course_get_format($course)->get_format_options();
1791     if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1792             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1793         return false;
1794     }
1796     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1797     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1798             'section ASC, id ASC', 'id, section')) {
1799         return false;
1800     }
1802     $movedsections = reorder_sections($sections, $section, $destination);
1804     // Update all sections. Do this in 2 steps to avoid breaking database
1805     // uniqueness constraint
1806     $transaction = $DB->start_delegated_transaction();
1807     foreach ($movedsections as $id => $position) {
1808         if ($sections[$id] !== $position) {
1809             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1810         }
1811     }
1812     foreach ($movedsections as $id => $position) {
1813         if ($sections[$id] !== $position) {
1814             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1815         }
1816     }
1818     // If we move the highlighted section itself, then just highlight the destination.
1819     // Adjust the higlighted section location if we move something over it either direction.
1820     if ($section == $course->marker) {
1821         course_set_marker($course->id, $destination);
1822     } elseif ($section > $course->marker && $course->marker >= $destination) {
1823         course_set_marker($course->id, $course->marker+1);
1824     } elseif ($section < $course->marker && $course->marker <= $destination) {
1825         course_set_marker($course->id, $course->marker-1);
1826     }
1828     $transaction->allow_commit();
1829     rebuild_course_cache($course->id, true);
1830     return true;
1833 /**
1834  * This method will delete a course section and may delete all modules inside it.
1835  *
1836  * No permissions are checked here, use {@link course_can_delete_section()} to
1837  * check if section can actually be deleted.
1838  *
1839  * @param int|stdClass $course
1840  * @param int|stdClass|section_info $section
1841  * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1842  * @return bool whether section was deleted
1843  */
1844 function course_delete_section($course, $section, $forcedeleteifnotempty = true) {
1845     global $DB;
1847     // Prepare variables.
1848     $courseid = (is_object($course)) ? $course->id : (int)$course;
1849     $sectionnum = (is_object($section)) ? $section->section : (int)$section;
1850     $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1851     if (!$section) {
1852         // No section exists, can't proceed.
1853         return false;
1854     }
1855     $format = course_get_format($course);
1856     $sectionname = $format->get_section_name($section);
1858     // Delete section.
1859     $result = $format->delete_section($section, $forcedeleteifnotempty);
1861     // Trigger an event for course section deletion.
1862     if ($result) {
1863         $context = context_course::instance($courseid);
1864         $event = \core\event\course_section_deleted::create(
1865                 array(
1866                     'objectid' => $section->id,
1867                     'courseid' => $courseid,
1868                     'context' => $context,
1869                     'other' => array(
1870                         'sectionnum' => $section->section,
1871                         'sectionname' => $sectionname,
1872                     )
1873                 )
1874             );
1875         $event->add_record_snapshot('course_sections', $section);
1876         $event->trigger();
1877     }
1878     return $result;
1881 /**
1882  * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1883  *
1884  * @param int|stdClass $course
1885  * @param int|stdClass|section_info $section
1886  * @return bool
1887  */
1888 function course_can_delete_section($course, $section) {
1889     if (is_object($section)) {
1890         $section = $section->section;
1891     }
1892     if (!$section) {
1893         // Not possible to delete 0-section.
1894         return false;
1895     }
1896     // Course format should allow to delete sections.
1897     if (!course_get_format($course)->can_delete_section($section)) {
1898         return false;
1899     }
1900     // Make sure user has capability to update course and move sections.
1901     $context = context_course::instance(is_object($course) ? $course->id : $course);
1902     if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1903         return false;
1904     }
1905     // Make sure user has capability to delete each activity in this section.
1906     $modinfo = get_fast_modinfo($course);
1907     if (!empty($modinfo->sections[$section])) {
1908         foreach ($modinfo->sections[$section] as $cmid) {
1909             if (!has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1910                 return false;
1911             }
1912         }
1913     }
1914     return true;
1917 /**
1918  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1919  * an original position number and a target position number, rebuilds the array so that the
1920  * move is made without any duplication of section positions.
1921  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1922  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1923  *
1924  * @param array $sections
1925  * @param int $origin_position
1926  * @param int $target_position
1927  * @return array
1928  */
1929 function reorder_sections($sections, $origin_position, $target_position) {
1930     if (!is_array($sections)) {
1931         return false;
1932     }
1934     // We can't move section position 0
1935     if ($origin_position < 1) {
1936         echo "We can't move section position 0";
1937         return false;
1938     }
1940     // Locate origin section in sections array
1941     if (!$origin_key = array_search($origin_position, $sections)) {
1942         echo "searched position not in sections array";
1943         return false; // searched position not in sections array
1944     }
1946     // Extract origin section
1947     $origin_section = $sections[$origin_key];
1948     unset($sections[$origin_key]);
1950     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1951     $found = false;
1952     $append_array = array();
1953     foreach ($sections as $id => $position) {
1954         if ($found) {
1955             $append_array[$id] = $position;
1956             unset($sections[$id]);
1957         }
1958         if ($position == $target_position) {
1959             if ($target_position < $origin_position) {
1960                 $append_array[$id] = $position;
1961                 unset($sections[$id]);
1962             }
1963             $found = true;
1964         }
1965     }
1967     // Append moved section
1968     $sections[$origin_key] = $origin_section;
1970     // Append rest of array (if applicable)
1971     if (!empty($append_array)) {
1972         foreach ($append_array as $id => $position) {
1973             $sections[$id] = $position;
1974         }
1975     }
1977     // Renumber positions
1978     $position = 0;
1979     foreach ($sections as $id => $p) {
1980         $sections[$id] = $position;
1981         $position++;
1982     }
1984     return $sections;
1988 /**
1989  * Move the module object $mod to the specified $section
1990  * If $beforemod exists then that is the module
1991  * before which $modid should be inserted
1992  *
1993  * @param stdClass|cm_info $mod
1994  * @param stdClass|section_info $section
1995  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1996  *     before which the module needs to be included. Null for inserting in the
1997  *     end of the section
1998  * @return int new value for module visibility (0 or 1)
1999  */
2000 function moveto_module($mod, $section, $beforemod=NULL) {
2001     global $OUTPUT, $DB;
2003     // Current module visibility state - return value of this function.
2004     $modvisible = $mod->visible;
2006     // Remove original module from original section.
2007     if (! delete_mod_from_section($mod->id, $mod->section)) {
2008         echo $OUTPUT->notification("Could not delete module from existing section");
2009     }
2011     // If moving to a hidden section then hide module.
2012     if ($mod->section != $section->id) {
2013         if (!$section->visible && $mod->visible) {
2014             // Module was visible but must become hidden after moving to hidden section.
2015             $modvisible = 0;
2016             set_coursemodule_visible($mod->id, 0);
2017             // Set visibleold to 1 so module will be visible when section is made visible.
2018             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
2019         }
2020         if ($section->visible && !$mod->visible) {
2021             // Hidden module was moved to the visible section, restore the module visibility from visibleold.
2022             set_coursemodule_visible($mod->id, $mod->visibleold);
2023             $modvisible = $mod->visibleold;
2024         }
2025     }
2027     // Add the module into the new section.
2028     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
2029     return $modvisible;
2032 /**
2033  * Returns the list of all editing actions that current user can perform on the module
2034  *
2035  * @param cm_info $mod The module to produce editing buttons for
2036  * @param int $indent The current indenting (default -1 means no move left-right actions)
2037  * @param int $sr The section to link back to (used for creating the links)
2038  * @return array array of action_link or pix_icon objects
2039  */
2040 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2041     global $COURSE, $SITE;
2043     static $str;
2045     $coursecontext = context_course::instance($mod->course);
2046     $modcontext = context_module::instance($mod->id);
2048     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2049     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2051     // No permission to edit anything.
2052     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2053         return array();
2054     }
2056     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2058     if (!isset($str)) {
2059         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2060             'editsettings', 'duplicate', 'hide', 'show'), 'moodle');
2061         $str->assign         = get_string('assignroles', 'role');
2062         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2063         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2064         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2065     }
2067     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2069     if ($sr !== null) {
2070         $baseurl->param('sr', $sr);
2071     }
2072     $actions = array();
2074     // Update.
2075     if ($hasmanageactivities) {
2076         $actions['update'] = new action_menu_link_secondary(
2077             new moodle_url($baseurl, array('update' => $mod->id)),
2078             new pix_icon('t/edit', $str->editsettings, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2079             $str->editsettings,
2080             array('class' => 'editing_update', 'data-action' => 'update')
2081         );
2082     }
2084     // Indent.
2085     if ($hasmanageactivities && $indent >= 0) {
2086         $indentlimits = new stdClass();
2087         $indentlimits->min = 0;
2088         $indentlimits->max = 16;
2089         if (right_to_left()) {   // Exchange arrows on RTL
2090             $rightarrow = 't/left';
2091             $leftarrow  = 't/right';
2092         } else {
2093             $rightarrow = 't/right';
2094             $leftarrow  = 't/left';
2095         }
2097         if ($indent >= $indentlimits->max) {
2098             $enabledclass = 'hidden';
2099         } else {
2100             $enabledclass = '';
2101         }
2102         $actions['moveright'] = new action_menu_link_secondary(
2103             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2104             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2105             $str->moveright,
2106             array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright', 'data-keepopen' => true)
2107         );
2109         if ($indent <= $indentlimits->min) {
2110             $enabledclass = 'hidden';
2111         } else {
2112             $enabledclass = '';
2113         }
2114         $actions['moveleft'] = new action_menu_link_secondary(
2115             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
2116             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2117             $str->moveleft,
2118             array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft', 'data-keepopen' => true)
2119         );
2121     }
2123     // Hide/Show.
2124     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2125         if ($mod->visible) {
2126             $actions['hide'] = new action_menu_link_secondary(
2127                 new moodle_url($baseurl, array('hide' => $mod->id)),
2128                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2129                 $str->hide,
2130                 array('class' => 'editing_hide', 'data-action' => 'hide')
2131             );
2132         } else {
2133             $actions['show'] = new action_menu_link_secondary(
2134                 new moodle_url($baseurl, array('show' => $mod->id)),
2135                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2136                 $str->show,
2137                 array('class' => 'editing_show', 'data-action' => 'show')
2138             );
2139         }
2140     }
2142     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2143     if (has_all_capabilities($dupecaps, $coursecontext) &&
2144             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
2145         $actions['duplicate'] = new action_menu_link_secondary(
2146             new moodle_url($baseurl, array('duplicate' => $mod->id)),
2147             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2148             $str->duplicate,
2149             array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sr' => $sr)
2150         );
2151     }
2153     // Groupmode.
2154     if ($hasmanageactivities && !$mod->coursegroupmodeforce) {
2155         if (plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2156             if ($mod->effectivegroupmode == SEPARATEGROUPS) {
2157                 $nextgroupmode = VISIBLEGROUPS;
2158                 $grouptitle = $str->groupsseparate;
2159                 $actionname = 'groupsseparate';
2160                 $groupimage = 'i/groups';
2161             } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
2162                 $nextgroupmode = NOGROUPS;
2163                 $grouptitle = $str->groupsvisible;
2164                 $actionname = 'groupsvisible';
2165                 $groupimage = 'i/groupv';
2166             } else {
2167                 $nextgroupmode = SEPARATEGROUPS;
2168                 $grouptitle = $str->groupsnone;
2169                 $actionname = 'groupsnone';
2170                 $groupimage = 'i/groupn';
2171             }
2173             $actions[$actionname] = new action_menu_link_primary(
2174                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
2175                 new pix_icon($groupimage, null, 'moodle', array('class' => 'iconsmall')),
2176                 $grouptitle,
2177                 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode, 'aria-live' => 'assertive')
2178             );
2179         } else {
2180             $actions['nogroupsupport'] = new action_menu_filler();
2181         }
2182     }
2184     // Assign.
2185     if (has_capability('moodle/role:assign', $modcontext)){
2186         $actions['assign'] = new action_menu_link_secondary(
2187             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2188             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2189             $str->assign,
2190             array('class' => 'editing_assign', 'data-action' => 'assignroles')
2191         );
2192     }
2194     // Delete.
2195     if ($hasmanageactivities) {
2196         $actions['delete'] = new action_menu_link_secondary(
2197             new moodle_url($baseurl, array('delete' => $mod->id)),
2198             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2199             $str->delete,
2200             array('class' => 'editing_delete', 'data-action' => 'delete')
2201         );
2202     }
2204     return $actions;
2207 /**
2208  * Returns the rename action.
2209  *
2210  * @param cm_info $mod The module to produce editing buttons for
2211  * @param int $sr The section to link back to (used for creating the links)
2212  * @return The markup for the rename action, or an empty string if not available.
2213  */
2214 function course_get_cm_rename_action(cm_info $mod, $sr = null) {
2215     global $COURSE, $OUTPUT;
2217     static $str;
2218     static $baseurl;
2220     $modcontext = context_module::instance($mod->id);
2221     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2223     if (!isset($str)) {
2224         $str = get_strings(array('edittitle'));
2225     }
2227     if (!isset($baseurl)) {
2228         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2229     }
2231     if ($sr !== null) {
2232         $baseurl->param('sr', $sr);
2233     }
2235     // AJAX edit title.
2236     if ($mod->has_view() && $hasmanageactivities && course_ajax_enabled($COURSE) &&
2237                 (($mod->course == $COURSE->id) || ($mod->course == SITEID))) {
2238         // we will not display link if we are on some other-course page (where we should not see this module anyway)
2239         return html_writer::span(
2240             html_writer::link(
2241                 new moodle_url($baseurl, array('update' => $mod->id)),
2242                 $OUTPUT->pix_icon('t/editstring', '', 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2243                 array(
2244                     'class' => 'editing_title',
2245                     'data-action' => 'edittitle',
2246                     'title' => $str->edittitle,
2247                 )
2248             )
2249         );
2250     }
2251     return '';
2254 /**
2255  * Returns the move action.
2256  *
2257  * @param cm_info $mod The module to produce a move button for
2258  * @param int $sr The section to link back to (used for creating the links)
2259  * @return The markup for the move action, or an empty string if not available.
2260  */
2261 function course_get_cm_move(cm_info $mod, $sr = null) {
2262     global $OUTPUT;
2264     static $str;
2265     static $baseurl;
2267     $modcontext = context_module::instance($mod->id);
2268     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2270     if (!isset($str)) {
2271         $str = get_strings(array('move'));
2272     }
2274     if (!isset($baseurl)) {
2275         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2277         if ($sr !== null) {
2278             $baseurl->param('sr', $sr);
2279         }
2280     }
2282     if ($hasmanageactivities) {
2283         $pixicon = 'i/dragdrop';
2285         if (!course_ajax_enabled($mod->get_course())) {
2286             // Override for course frontpage until we get drag/drop working there.
2287             $pixicon = 't/move';
2288         }
2290         return html_writer::link(
2291             new moodle_url($baseurl, array('copy' => $mod->id)),
2292             $OUTPUT->pix_icon($pixicon, $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2293             array('class' => 'editing_move', 'data-action' => 'move')
2294         );
2295     }
2296     return '';
2299 /**
2300  * given a course object with shortname & fullname, this function will
2301  * truncate the the number of chars allowed and add ... if it was too long
2302  */
2303 function course_format_name ($course,$max=100) {
2305     $context = context_course::instance($course->id);
2306     $shortname = format_string($course->shortname, true, array('context' => $context));
2307     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2308     $str = $shortname.': '. $fullname;
2309     if (core_text::strlen($str) <= $max) {
2310         return $str;
2311     }
2312     else {
2313         return core_text::substr($str,0,$max-3).'...';
2314     }
2317 /**
2318  * Is the user allowed to add this type of module to this course?
2319  * @param object $course the course settings. Only $course->id is used.
2320  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2321  * @return bool whether the current user is allowed to add this type of module to this course.
2322  */
2323 function course_allowed_module($course, $modname) {
2324     if (is_numeric($modname)) {
2325         throw new coding_exception('Function course_allowed_module no longer
2326                 supports numeric module ids. Please update your code to pass the module name.');
2327     }
2329     $capability = 'mod/' . $modname . ':addinstance';
2330     if (!get_capability_info($capability)) {
2331         // Debug warning that the capability does not exist, but no more than once per page.
2332         static $warned = array();
2333         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2334         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2335             debugging('The module ' . $modname . ' does not define the standard capability ' .
2336                     $capability , DEBUG_DEVELOPER);
2337             $warned[$modname] = 1;
2338         }
2340         // If the capability does not exist, the module can always be added.
2341         return true;
2342     }
2344     $coursecontext = context_course::instance($course->id);
2345     return has_capability($capability, $coursecontext);
2348 /**
2349  * Efficiently moves many courses around while maintaining
2350  * sortorder in order.
2351  *
2352  * @param array $courseids is an array of course ids
2353  * @param int $categoryid
2354  * @return bool success
2355  */
2356 function move_courses($courseids, $categoryid) {
2357     global $DB;
2359     if (empty($courseids)) {
2360         // Nothing to do.
2361         return false;
2362     }
2364     if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2365         return false;
2366     }
2368     $courseids = array_reverse($courseids);
2369     $newparent = context_coursecat::instance($category->id);
2370     $i = 1;
2372     list($where, $params) = $DB->get_in_or_equal($courseids);
2373     $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2374     foreach ($dbcourses as $dbcourse) {
2375         $course = new stdClass();
2376         $course->id = $dbcourse->id;
2377         $course->category  = $category->id;
2378         $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2379         if ($category->visible == 0) {
2380             // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2381             // to previous state if somebody unhides the category.
2382             $course->visible = 0;
2383         }
2385         $DB->update_record('course', $course);
2387         // Update context, so it can be passed to event.
2388         $context = context_course::instance($course->id);
2389         $context->update_moved($newparent);
2391         // Trigger a course updated event.
2392         $event = \core\event\course_updated::create(array(
2393             'objectid' => $course->id,
2394             'context' => context_course::instance($course->id),
2395             'other' => array('shortname' => $dbcourse->shortname,
2396                              'fullname' => $dbcourse->fullname)
2397         ));
2398         $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2399         $event->trigger();
2400     }
2401     fix_course_sortorder();
2402     cache_helper::purge_by_event('changesincourse');
2404     return true;
2407 /**
2408  * Returns the display name of the given section that the course prefers
2409  *
2410  * Implementation of this function is provided by course format
2411  * @see format_base::get_section_name()
2412  *
2413  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2414  * @param int|stdClass $section Section object from database or just field course_sections.section
2415  * @return string Display name that the course format prefers, e.g. "Week 2"
2416  */
2417 function get_section_name($courseorid, $section) {
2418     return course_get_format($courseorid)->get_section_name($section);
2421 /**
2422  * Tells if current course format uses sections
2423  *
2424  * @param string $format Course format ID e.g. 'weeks' $course->format
2425  * @return bool
2426  */
2427 function course_format_uses_sections($format) {
2428     $course = new stdClass();
2429     $course->format = $format;
2430     return course_get_format($course)->uses_sections();
2433 /**
2434  * Returns the information about the ajax support in the given source format
2435  *
2436  * The returned object's property (boolean)capable indicates that
2437  * the course format supports Moodle course ajax features.
2438  *
2439  * @param string $format
2440  * @return stdClass
2441  */
2442 function course_format_ajax_support($format) {
2443     $course = new stdClass();
2444     $course->format = $format;
2445     return course_get_format($course)->supports_ajax();
2448 /**
2449  * Can the current user delete this course?
2450  * Course creators have exception,
2451  * 1 day after the creation they can sill delete the course.
2452  * @param int $courseid
2453  * @return boolean
2454  */
2455 function can_delete_course($courseid) {
2456     global $USER;
2458     $context = context_course::instance($courseid);
2460     if (has_capability('moodle/course:delete', $context)) {
2461         return true;
2462     }
2464     // hack: now try to find out if creator created this course recently (1 day)
2465     if (!has_capability('moodle/course:create', $context)) {
2466         return false;
2467     }
2469     $since = time() - 60*60*24;
2470     $course = get_course($courseid);
2472     if ($course->timecreated < $since) {
2473         return false; // Return if the course was not created in last 24 hours.
2474     }
2476     $logmanger = get_log_manager();
2477     $readers = $logmanger->get_readers('\core\log\sql_reader');
2478     $reader = reset($readers);
2480     if (empty($reader)) {
2481         return false; // No log reader found.
2482     }
2484     // A proper reader.
2485     $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2486     $params = array('userid' => $USER->id, 'since' => $since, 'courseid' => $course->id, 'eventname' => '\core\event\course_created');
2488     return (bool)$reader->get_events_select_count($select, $params);
2491 /**
2492  * Save the Your name for 'Some role' strings.
2493  *
2494  * @param integer $courseid the id of this course.
2495  * @param array $data the data that came from the course settings form.
2496  */
2497 function save_local_role_names($courseid, $data) {
2498     global $DB;
2499     $context = context_course::instance($courseid);
2501     foreach ($data as $fieldname => $value) {
2502         if (strpos($fieldname, 'role_') !== 0) {
2503             continue;
2504         }
2505         list($ignored, $roleid) = explode('_', $fieldname);
2507         // make up our mind whether we want to delete, update or insert
2508         if (!$value) {
2509             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2511         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2512             $rolename->name = $value;
2513             $DB->update_record('role_names', $rolename);
2515         } else {
2516             $rolename = new stdClass;
2517             $rolename->contextid = $context->id;
2518             $rolename->roleid = $roleid;
2519             $rolename->name = $value;
2520             $DB->insert_record('role_names', $rolename);
2521         }
2522         // This will ensure the course contacts cache is purged..
2523         coursecat::role_assignment_changed($roleid, $context);
2524     }
2527 /**
2528  * Returns options to use in course overviewfiles filemanager
2529  *
2530  * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2531  *     may be empty if course does not exist yet (course create form)
2532  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2533  *     or null if overviewfiles are disabled
2534  */
2535 function course_overviewfiles_options($course) {
2536     global $CFG;
2537     if (empty($CFG->courseoverviewfileslimit)) {
2538         return null;
2539     }
2540     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2541     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2542         $accepted_types = '*';
2543     } else {
2544         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2545         // Make sure extensions are prefixed with dot unless they are valid typegroups
2546         foreach ($accepted_types as $i => $type) {
2547             if (substr($type, 0, 1) !== '.') {
2548                 require_once($CFG->libdir. '/filelib.php');
2549                 if (!count(file_get_typegroup('extension', $type))) {
2550                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2551                     $accepted_types[$i] = '.'. $type;
2552                     $corrected = true;
2553                 }
2554             }
2555         }
2556         if (!empty($corrected)) {
2557             set_config('courseoverviewfilesext', join(',', $accepted_types));
2558         }
2559     }
2560     $options = array(
2561         'maxfiles' => $CFG->courseoverviewfileslimit,
2562         'maxbytes' => $CFG->maxbytes,
2563         'subdirs' => 0,
2564         'accepted_types' => $accepted_types
2565     );
2566     if (!empty($course->id)) {
2567         $options['context'] = context_course::instance($course->id);
2568     } else if (is_int($course) && $course > 0) {
2569         $options['context'] = context_course::instance($course);
2570     }
2571     return $options;
2574 /**
2575  * Create a course and either return a $course object
2576  *
2577  * Please note this functions does not verify any access control,
2578  * the calling code is responsible for all validation (usually it is the form definition).
2579  *
2580  * @param array $editoroptions course description editor options
2581  * @param object $data  - all the data needed for an entry in the 'course' table
2582  * @return object new course instance
2583  */
2584 function create_course($data, $editoroptions = NULL) {
2585     global $DB, $CFG;
2586     require_once($CFG->dirroot.'/tag/lib.php');
2588     //check the categoryid - must be given for all new courses
2589     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2591     // Check if the shortname already exists.
2592     if (!empty($data->shortname)) {
2593         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2594             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2595         }
2596     }
2598     // Check if the idnumber already exists.
2599     if (!empty($data->idnumber)) {
2600         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2601             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2602         }
2603     }
2605     // Check if timecreated is given.
2606     $data->timecreated  = !empty($data->timecreated) ? $data->timecreated : time();
2607     $data->timemodified = $data->timecreated;
2609     // place at beginning of any category
2610     $data->sortorder = 0;
2612     if ($editoroptions) {
2613         // summary text is updated later, we need context to store the files first
2614         $data->summary = '';
2615         $data->summary_format = FORMAT_HTML;
2616     }
2618     if (!isset($data->visible)) {
2619         // data not from form, add missing visibility info
2620         $data->visible = $category->visible;
2621     }
2622     $data->visibleold = $data->visible;
2624     $newcourseid = $DB->insert_record('course', $data);
2625     $context = context_course::instance($newcourseid, MUST_EXIST);
2627     if ($editoroptions) {
2628         // Save the files used in the summary editor and store
2629         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2630         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2631         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2632     }
2633     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2634         // Save the course overviewfiles
2635         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2636     }
2638     // update course format options
2639     course_get_format($newcourseid)->update_course_format_options($data);
2641     $course = course_get_format($newcourseid)->get_course();
2643     fix_course_sortorder();
2644     // purge appropriate caches in case fix_course_sortorder() did not change anything
2645     cache_helper::purge_by_event('changesincourse');
2647     // new context created - better mark it as dirty
2648     $context->mark_dirty();
2650     // Trigger a course created event.
2651     $event = \core\event\course_created::create(array(
2652         'objectid' => $course->id,
2653         'context' => context_course::instance($course->id),
2654         'other' => array('shortname' => $course->shortname,
2655             'fullname' => $course->fullname)
2656     ));
2657     $event->trigger();
2659     // Setup the blocks
2660     blocks_add_default_course_blocks($course);
2662     // Create a default section.
2663     course_create_sections_if_missing($course, 0);
2665     // Save any custom role names.
2666     save_local_role_names($course->id, (array)$data);
2668     // set up enrolments
2669     enrol_course_updated(true, $course, $data);
2671     // Update course tags.
2672     if ($CFG->usetags && isset($data->tags)) {
2673         tag_set('course', $course->id, $data->tags, 'core', context_course::instance($course->id)->id);
2674     }
2676     return $course;
2679 /**
2680  * Update a course.
2681  *
2682  * Please note this functions does not verify any access control,
2683  * the calling code is responsible for all validation (usually it is the form definition).
2684  *
2685  * @param object $data  - all the data needed for an entry in the 'course' table
2686  * @param array $editoroptions course description editor options
2687  * @return void
2688  */
2689 function update_course($data, $editoroptions = NULL) {
2690     global $DB, $CFG;
2691     require_once($CFG->dirroot.'/tag/lib.php');
2693     $data->timemodified = time();
2695     $oldcourse = course_get_format($data->id)->get_course();
2696     $context   = context_course::instance($oldcourse->id);
2698     if ($editoroptions) {
2699         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2700     }
2701     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2702         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2703     }
2705     // Check we don't have a duplicate shortname.
2706     if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
2707         if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname, $data->id))) {
2708             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2709         }
2710     }
2712     // Check we don't have a duplicate idnumber.
2713     if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
2714         if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber, $data->id))) {
2715             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2716         }
2717     }
2719     if (!isset($data->category) or empty($data->category)) {
2720         // prevent nulls and 0 in category field
2721         unset($data->category);
2722     }
2723     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2725     if (!isset($data->visible)) {
2726         // data not from form, add missing visibility info
2727         $data->visible = $oldcourse->visible;
2728     }
2730     if ($data->visible != $oldcourse->visible) {
2731         // reset the visibleold flag when manually hiding/unhiding course
2732         $data->visibleold = $data->visible;
2733         $changesincoursecat = true;
2734     } else {
2735         if ($movecat) {
2736             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2737             if (empty($newcategory->visible)) {
2738                 // make sure when moving into hidden category the course is hidden automatically
2739                 $data->visible = 0;
2740             }
2741         }
2742     }
2744     // Update with the new data
2745     $DB->update_record('course', $data);
2746     // make sure the modinfo cache is reset
2747     rebuild_course_cache($data->id);
2749     // update course format options with full course data
2750     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2752     $course = $DB->get_record('course', array('id'=>$data->id));
2754     if ($movecat) {
2755         $newparent = context_coursecat::instance($course->category);
2756         $context->update_moved($newparent);
2757     }
2758     $fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
2759     if ($fixcoursesortorder) {
2760         fix_course_sortorder();
2761     }
2763     // purge appropriate caches in case fix_course_sortorder() did not change anything
2764     cache_helper::purge_by_event('changesincourse');
2765     if ($changesincoursecat) {
2766         cache_helper::purge_by_event('changesincoursecat');
2767     }
2769     // Test for and remove blocks which aren't appropriate anymore
2770     blocks_remove_inappropriate($course);
2772     // Save any custom role names.
2773     save_local_role_names($course->id, $data);
2775     // update enrol settings
2776     enrol_course_updated(false, $course, $data);
2778     // Update course tags.
2779     if ($CFG->usetags && isset($data->tags)) {
2780         tag_set('course', $course->id, $data->tags, 'core', context_course::instance($course->id)->id);
2781     }
2783     // Trigger a course updated event.
2784     $event = \core\event\course_updated::create(array(
2785         'objectid' => $course->id,
2786         'context' => context_course::instance($course->id),
2787         'other' => array('shortname' => $course->shortname,
2788                          'fullname' => $course->fullname)
2789     ));
2791     $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
2792     $event->trigger();
2794     if ($oldcourse->format !== $course->format) {
2795         // Remove all options stored for the previous format
2796         // We assume that new course format migrated everything it needed watching trigger
2797         // 'course_updated' and in method format_XXX::update_course_format_options()
2798         $DB->delete_records('course_format_options',
2799                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2800     }
2803 /**
2804  * Average number of participants
2805  * @return integer
2806  */
2807 function average_number_of_participants() {
2808     global $DB, $SITE;
2810     //count total of enrolments for visible course (except front page)
2811     $sql = 'SELECT COUNT(*) FROM (
2812         SELECT DISTINCT ue.userid, e.courseid
2813         FROM {user_enrolments} ue, {enrol} e, {course} c
2814         WHERE ue.enrolid = e.id
2815             AND e.courseid <> :siteid
2816             AND c.id = e.courseid
2817             AND c.visible = 1) total';
2818     $params = array('siteid' => $SITE->id);
2819     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2822     //count total of visible courses (minus front page)
2823     $coursetotal = $DB->count_records('course', array('visible' => 1));
2824     $coursetotal = $coursetotal - 1 ;
2826     //average of enrolment
2827     if (empty($coursetotal)) {
2828         $participantaverage = 0;
2829     } else {
2830         $participantaverage = $enrolmenttotal / $coursetotal;
2831     }
2833     return $participantaverage;
2836 /**
2837  * Average number of course modules
2838  * @return integer
2839  */
2840 function average_number_of_courses_modules() {
2841     global $DB, $SITE;
2843     //count total of visible course module (except front page)
2844     $sql = 'SELECT COUNT(*) FROM (
2845         SELECT cm.course, cm.module
2846         FROM {course} c, {course_modules} cm
2847         WHERE c.id = cm.course
2848             AND c.id <> :siteid
2849             AND cm.visible = 1
2850             AND c.visible = 1) total';
2851     $params = array('siteid' => $SITE->id);
2852     $moduletotal = $DB->count_records_sql($sql, $params);
2855     //count total of visible courses (minus front page)
2856     $coursetotal = $DB->count_records('course', array('visible' => 1));
2857     $coursetotal = $coursetotal - 1 ;
2859     //average of course module
2860     if (empty($coursetotal)) {
2861         $coursemoduleaverage = 0;
2862     } else {
2863         $coursemoduleaverage = $moduletotal / $coursetotal;
2864     }
2866     return $coursemoduleaverage;
2869 /**
2870  * This class pertains to course requests and contains methods associated with
2871  * create, approving, and removing course requests.
2872  *
2873  * Please note we do not allow embedded images here because there is no context
2874  * to store them with proper access control.
2875  *
2876  * @copyright 2009 Sam Hemelryk
2877  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2878  * @since Moodle 2.0
2879  *
2880  * @property-read int $id
2881  * @property-read string $fullname
2882  * @property-read string $shortname
2883  * @property-read string $summary
2884  * @property-read int $summaryformat
2885  * @property-read int $summarytrust
2886  * @property-read string $reason
2887  * @property-read int $requester
2888  */
2889 class course_request {
2891     /**
2892      * This is the stdClass that stores the properties for the course request
2893      * and is externally accessed through the __get magic method
2894      * @var stdClass
2895      */
2896     protected $properties;
2898     /**
2899      * An array of options for the summary editor used by course request forms.
2900      * This is initially set by {@link summary_editor_options()}
2901      * @var array
2902      * @static
2903      */
2904     protected static $summaryeditoroptions;
2906     /**
2907      * Static function to prepare the summary editor for working with a course
2908      * request.
2909      *
2910      * @static
2911      * @param null|stdClass $data Optional, an object containing the default values
2912      *                       for the form, these may be modified when preparing the
2913      *                       editor so this should be called before creating the form
2914      * @return stdClass An object that can be used to set the default values for
2915      *                   an mforms form
2916      */
2917     public static function prepare($data=null) {
2918         if ($data === null) {
2919             $data = new stdClass;
2920         }
2921         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2922         return $data;
2923     }
2925     /**
2926      * Static function to create a new course request when passed an array of properties
2927      * for it.
2928      *
2929      * This function also handles saving any files that may have been used in the editor
2930      *
2931      * @static
2932      * @param stdClass $data
2933      * @return course_request The newly created course request
2934      */
2935     public static function create($data) {
2936         global $USER, $DB, $CFG;
2937         $data->requester = $USER->id;
2939         // Setting the default category if none set.
2940         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2941             $data->category = $CFG->defaultrequestcategory;
2942         }
2944         // Summary is a required field so copy the text over
2945         $data->summary       = $data->summary_editor['text'];
2946         $data->summaryformat = $data->summary_editor['format'];
2948         $data->id = $DB->insert_record('course_request', $data);
2950         // Create a new course_request object and return it
2951         $request = new course_request($data);
2953         // Notify the admin if required.
2954         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2956             $a = new stdClass;
2957             $a->link = "$CFG->wwwroot/course/pending.php";
2958             $a->user = fullname($USER);
2959             $subject = get_string('courserequest');
2960             $message = get_string('courserequestnotifyemail', 'admin', $a);
2961             foreach ($users as $user) {
2962                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2963             }
2964         }
2966         return $request;
2967     }
2969     /**
2970      * Returns an array of options to use with a summary editor
2971      *
2972      * @uses course_request::$summaryeditoroptions
2973      * @return array An array of options to use with the editor
2974      */
2975     public static function summary_editor_options() {
2976         global $CFG;
2977         if (self::$summaryeditoroptions === null) {
2978             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2979         }
2980         return self::$summaryeditoroptions;
2981     }
2983     /**
2984      * Loads the properties for this course request object. Id is required and if
2985      * only id is provided then we load the rest of the properties from the database
2986      *
2987      * @param stdClass|int $properties Either an object containing properties
2988      *                      or the course_request id to load
2989      */
2990     public function __construct($properties) {
2991         global $DB;
2992         if (empty($properties->id)) {
2993             if (empty($properties)) {
2994                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2995             }
2996             $id = $properties;
2997             $properties = new stdClass;
2998             $properties->id = (int)$id;
2999             unset($id);
3000         }
3001         if (empty($properties->requester)) {
3002             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3003                 print_error('unknowncourserequest');
3004             }
3005         } else {
3006             $this->properties = $properties;
3007         }
3008         $this->properties->collision = null;
3009     }
3011     /**
3012      * Returns the requested property
3013      *
3014      * @param string $key
3015      * @return mixed
3016      */
3017     public function __get($key) {
3018         return $this->properties->$key;
3019     }
3021     /**
3022      * Override this to ensure empty($request->blah) calls return a reliable answer...
3023      *
3024      * This is required because we define the __get method
3025      *
3026      * @param mixed $key
3027      * @return bool True is it not empty, false otherwise
3028      */
3029     public function __isset($key) {
3030         return (!empty($this->properties->$key));
3031     }
3033     /**
3034      * Returns the user who requested this course
3035      *
3036      * Uses a static var to cache the results and cut down the number of db queries
3037      *
3038      * @staticvar array $requesters An array of cached users
3039      * @return stdClass The user who requested the course
3040      */
3041     public function get_requester() {
3042         global $DB;
3043         static $requesters= array();
3044         if (!array_key_exists($this->properties->requester, $requesters)) {
3045             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3046         }
3047         return $requesters[$this->properties->requester];
3048     }
3050     /**
3051      * Checks that the shortname used by the course does not conflict with any other
3052      * courses that exist
3053      *
3054      * @param string|null $shortnamemark The string to append to the requests shortname
3055      *                     should a conflict be found
3056      * @return bool true is there is a conflict, false otherwise
3057      */
3058     public function check_shortname_collision($shortnamemark = '[*]') {
3059         global $DB;
3061         if ($this->properties->collision !== null) {
3062             return $this->properties->collision;
3063         }
3065         if (empty($this->properties->shortname)) {
3066             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3067             $this->properties->collision = false;
3068         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3069             if (!empty($shortnamemark)) {
3070                 $this->properties->shortname .= ' '.$shortnamemark;
3071             }
3072             $this->properties->collision = true;
3073         } else {
3074             $this->properties->collision = false;
3075         }
3076         return $this->properties->collision;
3077     }
3079     /**
3080      * Returns the category where this course request should be created
3081      *
3082      * Note that we don't check here that user has a capability to view
3083      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
3084      * 'moodle/course:changecategory'
3085      *
3086      * @return coursecat
3087      */
3088     public function get_category() {
3089         global $CFG;
3090         require_once($CFG->libdir.'/coursecatlib.php');
3091         // If the category is not set, if the current user does not have the rights to change the category, or if the
3092         // category does not exist, we set the default category to the course to be approved.
3093         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3094         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
3095                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
3096             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
3097         }
3098         if (!$category) {
3099             $category = coursecat::get_default();
3100         }
3101         return $category;
3102     }
3104     /**
3105      * This function approves the request turning it into a course
3106      *
3107      * This function converts the course request into a course, at the same time
3108      * transferring any files used in the summary to the new course and then removing
3109      * the course request and the files associated with it.
3110      *
3111      * @return int The id of the course that was created from this request
3112      */
3113     public function approve() {
3114         global $CFG, $DB, $USER;
3116         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3118         $courseconfig = get_config('moodlecourse');
3120         // Transfer appropriate settings
3121         $data = clone($this->properties);
3122         unset($data->id);
3123         unset($data->reason);
3124         unset($data->requester);
3126         // Set category
3127         $category = $this->get_category();
3128         $data->category = $category->id;
3129         // Set misc settings
3130         $data->requested = 1;
3132         // Apply course default settings
3133         $data->format             = $courseconfig->format;
3134         $data->newsitems          = $courseconfig->newsitems;
3135         $data->showgrades         = $courseconfig->showgrades;
3136         $data->showreports        = $courseconfig->showreports;
3137         $data->maxbytes           = $courseconfig->maxbytes;
3138         $data->groupmode          = $courseconfig->groupmode;
3139         $data->groupmodeforce     = $courseconfig->groupmodeforce;
3140         $data->visible            = $courseconfig->visible;
3141         $data->visibleold         = $data->visible;
3142         $data->lang               = $courseconfig->lang;
3144         $course = create_course($data);
3145         $context = context_course::instance($course->id, MUST_EXIST);
3147         // add enrol instances
3148         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3149             if ($manual = enrol_get_plugin('manual')) {
3150                 $manual->add_default_instance($course);
3151             }
3152         }
3154         // enrol the requester as teacher if necessary
3155         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3156             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3157         }
3159         $this->delete();
3161         $a = new stdClass();
3162         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3163         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3164         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3166         return $course->id;
3167     }
3169     /**
3170      * Reject a course request
3171      *
3172      * This function rejects a course request, emailing the requesting user the
3173      * provided notice and then removing the request from the database
3174      *
3175      * @param string $notice The message to display to the user
3176      */
3177     public function reject($notice) {
3178         global $USER, $DB;
3179         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
3180         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3181         $this->delete();
3182     }
3184     /**
3185      * Deletes the course request and any associated files
3186      */
3187     public function delete() {
3188         global $DB;
3189         $DB->delete_records('course_request', array('id' => $this->properties->id));
3190     }
3192     /**
3193      * Send a message from one user to another using events_trigger
3194      *
3195      * @param object $touser
3196      * @param object $fromuser
3197      * @param string $name
3198      * @param string $subject
3199      * @param string $message
3200      */
3201     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
3202         $eventdata = new stdClass();
3203         $eventdata->component         = 'moodle';
3204         $eventdata->name              = $name;
3205         $eventdata->userfrom          = $fromuser;
3206         $eventdata->userto            = $touser;
3207         $eventdata->subject           = $subject;
3208         $eventdata->fullmessage       = $message;
3209         $eventdata->fullmessageformat = FORMAT_PLAIN;
3210         $eventdata->fullmessagehtml   = '';
3211         $eventdata->smallmessage      = '';
3212         $eventdata->notification      = 1;
3213         message_send($eventdata);
3214     }
3217 /**
3218  * Return a list of page types
3219  * @param string $pagetype current page type
3220  * @param context $parentcontext Block's parent context
3221  * @param context $currentcontext Current context of block
3222  * @return array array of page types
3223  */
3224 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3225     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
3226         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3227         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3228             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3229         );
3230     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
3231         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3232         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3233     } else {
3234         // Otherwise consider it a page inside a course even if $currentcontext is null
3235         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3236             'course-*' => get_string('page-course-x', 'pagetype'),
3237             'course-view-*' => get_string('page-course-view-x', 'pagetype')
3238         );
3239     }
3240     return $pagetypes;
3243 /**
3244  * Determine whether course ajax should be enabled for the specified course
3245  *
3246  * @param stdClass $course The course to test against
3247  * @return boolean Whether course ajax is enabled or note
3248  */
3249 function course_ajax_enabled($course) {
3250     global $CFG, $PAGE, $SITE;
3252     // The user must be editing for AJAX to be included
3253     if (!$PAGE->user_is_editing()) {
3254         return false;
3255     }
3257     // Check that the theme suports
3258     if (!$PAGE->theme->enablecourseajax) {
3259         return false;
3260     }
3262     // Check that the course format supports ajax functionality
3263     // The site 'format' doesn't have information on course format support
3264     if ($SITE->id !== $course->id) {
3265         $courseformatajaxsupport = course_format_ajax_support($course->format);
3266         if (!$courseformatajaxsupport->capable) {
3267             return false;
3268         }
3269     }
3271     // All conditions have been met so course ajax should be enabled
3272     return true;
3275 /**
3276  * Include the relevant javascript and language strings for the resource
3277  * toolbox YUI module
3278  *
3279  * @param integer $id The ID of the course being applied to
3280  * @param array $usedmodules An array containing the names of the modules in use on the page
3281  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3282  * @param stdClass $config An object containing configuration parameters for ajax modules including:
3283  *          * resourceurl   The URL to post changes to for resource changes
3284  *          * sectionurl    The URL to post changes to for section changes
3285  *          * pageparams    Additional parameters to pass through in the post
3286  * @return bool
3287  */
3288 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3289     global $CFG, $PAGE, $SITE;
3291     // Ensure that ajax should be included
3292     if (!course_ajax_enabled($course)) {
3293         return false;
3294     }
3296     if (!$config) {
3297         $config = new stdClass();
3298     }
3300     // The URL to use for resource changes
3301     if (!isset($config->resourceurl)) {
3302         $config->resourceurl = '/course/rest.php';
3303     }
3305     // The URL to use for section changes
3306     if (!isset($config->sectionurl)) {
3307         $config->sectionurl = '/course/rest.php';
3308     }
3310     // Any additional parameters which need to be included on page submission
3311     if (!isset($config->pageparams)) {
3312         $config->pageparams = array();
3313     }
3315     // Include toolboxes
3316     $PAGE->requires->yui_module('moodle-course-toolboxes',
3317             'M.course.init_resource_toolbox',
3318             array(array(
3319                 'courseid' => $course->id,
3320                 'ajaxurl' => $config->resourceurl,
3321                 'config' => $config,
3322             ))
3323     );
3324     $PAGE->requires->yui_module('moodle-course-toolboxes',
3325             'M.course.init_section_toolbox',
3326             array(array(
3327                 'courseid' => $course->id,
3328                 'format' => $course->format,
3329                 'ajaxurl' => $config->sectionurl,
3330                 'config' => $config,
3331             ))
3332     );
3334     // Include course dragdrop
3335     if (course_format_uses_sections($course->format)) {
3336         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3337             array(array(
3338                 'courseid' => $course->id,
3339                 'ajaxurl' => $config->sectionurl,
3340                 'config' => $config,
3341             )), null, true);
3343         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3344             array(array(
3345                 'courseid' => $course->id,
3346                 'ajaxurl' => $config->resourceurl,
3347                 'config' => $config,
3348             )), null, true);
3349     }
3351     // Require various strings for the command toolbox
3352     $PAGE->requires->strings_for_js(array(
3353             'moveleft',
3354             'deletechecktype',
3355             'deletechecktypename',
3356             'edittitle',
3357             'edittitleinstructions',
3358             'show',
3359             'hide',
3360             'highlight',
3361             'highlightoff',
3362             'groupsnone',
3363             'groupsvisible',
3364             'groupsseparate',
3365             'clicktochangeinbrackets',
3366             'markthistopic',
3367             'markedthistopic',
3368             'movesection',
3369             'movecoursemodule',
3370             'movecoursesection',
3371             'movecontent',
3372             'tocontent',
3373             'emptydragdropregion',
3374             'afterresource',
3375             'aftersection',
3376             'totopofsection',
3377         ), 'moodle');
3379     // Include section-specific strings for formats which support sections.
3380     if (course_format_uses_sections($course->format)) {
3381         $PAGE->requires->strings_for_js(array(
3382                 'showfromothers',
3383                 'hidefromothers',
3384             ), 'format_' . $course->format);
3385     }
3387     // For confirming resource deletion we need the name of the module in question
3388     foreach ($usedmodules as $module => $modname) {
3389         $PAGE->requires->string_for_js('pluginname', $module);
3390     }
3392     // Load drag and drop upload AJAX.
3393     require_once($CFG->dirroot.'/course/dnduploadlib.php');
3394     dndupload_add_to_course($course, $enabledmodules);
3396     return true;
3399 /**
3400  * Returns the sorted list of available course formats, filtered by enabled if necessary
3401  *
3402  * @param bool $enabledonly return only formats that are enabled
3403  * @return array array of sorted format names
3404  */
3405 function get_sorted_course_formats($enabledonly = false) {
3406     global $CFG;
3407     $formats = core_component::get_plugin_list('format');
3409     if (!empty($CFG->format_plugins_sortorder)) {
3410         $order = explode(',', $CFG->format_plugins_sortorder);
3411         $order = array_merge(array_intersect($order, array_keys($formats)),
3412                     array_diff(array_keys($formats), $order));
3413     } else {
3414         $order = array_keys($formats);
3415     }
3416     if (!$enabledonly) {
3417         return $order;
3418     }
3419     $sortedformats = array();
3420     foreach ($order as $formatname) {
3421         if (!get_config('format_'.$formatname, 'disabled')) {
3422             $sortedformats[] = $formatname;
3423         }
3424     }
3425     return $sortedformats;
3428 /**
3429  * The URL to use for the specified course (with section)
3430  *
3431  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3432  * @param int|stdClass $section Section object from database or just field course_sections.section
3433  *     if omitted the course view page is returned
3434  * @param array $options options for view URL. At the moment core uses:
3435  *     'navigation' (bool) if true and section has no separate page, the function returns null
3436  *     'sr' (int) used by multipage formats to specify to which section to return
3437  * @return moodle_url The url of course
3438  */
3439 function course_get_url($courseorid, $section = null, $options = array()) {
3440     return course_get_format($courseorid)->get_view_url($section, $options);
3443 /**
3444  * Create a module.
3445  *
3446  * It includes:
3447  *      - capability checks and other checks
3448  *      - create the module from the module info
3449  *
3450  * @param object $module
3451  * @return object the created module info
3452  * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3453  */
3454 function create_module($moduleinfo) {
3455     global $DB, $CFG;
3457     require_once($CFG->dirroot . '/course/modlib.php');
3459     // Check manadatory attributs.
3460     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3461     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3462         $mandatoryfields[] = 'introeditor';
3463     }
3464     foreach($mandatoryfields as $mandatoryfield) {
3465         if (!isset($moduleinfo->{$mandatoryfield})) {
3466             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3467         }
3468     }
3470     // Some additional checks (capability / existing instances).
3471     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3472     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3474     // Add the module.
3475     $moduleinfo->module = $module->id;
3476     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3478     return $moduleinfo;
3481 /**
3482  * Update a module.
3483  *
3484  * It includes:
3485  *      - capability and other checks
3486  *      - update the module
3487  *
3488  * @param object $module
3489  * @return object the updated module info
3490  * @throws moodle_exception if current user is not allowed to update the module
3491  */
3492 function update_module($moduleinfo) {
3493     global $DB, $CFG;
3495     require_once($CFG->dirroot . '/course/modlib.php');
3497     // Check the course module exists.
3498     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3500     // Check the course exists.
3501     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3503     // Some checks (capaibility / existing instances).
3504     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3506     // Retrieve few information needed by update_moduleinfo.
3507     $moduleinfo->modulename = $cm->modname;
3508     if (!isset($moduleinfo->scale)) {
3509         $moduleinfo->scale = 0;
3510     }
3511     $moduleinfo->type = 'mod';
3513     // Update the module.
3514     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3516     return $moduleinfo;
3519 /**
3520  * Duplicate a module on the course for ajax.
3521  *
3522  * @see mod_duplicate_module()
3523  * @param object $course The course
3524  * @param object $cm The course module to duplicate
3525  * @param int $sr The section to link back to (used for creating the links)
3526  * @throws moodle_exception if the plugin doesn't support duplication
3527  * @return Object containing:
3528  * - fullcontent: The HTML markup for the created CM
3529  * - cmid: The CMID of the newly created CM
3530  * - redirect: Whether to trigger a redirect following this change
3531  */
3532 function mod_duplicate_activity($course, $cm, $sr = null) {
3533     global $PAGE;
3535     $newcm = duplicate_module($course, $cm);
3537     $resp = new stdClass();
3538     if ($newcm) {
3539         $courserenderer = $PAGE->get_renderer('core', 'course');
3540         $completioninfo = new completion_info($course);
3541         $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3542                 $newcm, null, array());
3544         $resp->fullcontent = $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3545         $resp->cmid = $newcm->id;
3546     } else {
3547         // Trigger a redirect.
3548         $resp->redirect = true;
3549     }
3550     return $resp;
3553 /**
3554  * Api to duplicate a module.
3555  *
3556  * @param object $course course object.
3557  * @param object $cm course module object to be duplicated.
3558  * @since Moodle 2.8
3559  *
3560  * @throws Exception
3561  * @throws coding_exception
3562  * @throws moodle_exception
3563  * @throws restore_controller_exception
3564  *
3565  * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3566  */
3567 function duplicate_module($course, $cm) {
3568     global $CFG, $DB, $USER;
3569     require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
3570     require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
3571     require_once($CFG->libdir . '/filelib.php');
3573     $a          = new stdClass();
3574     $a->modtype = get_string('modulename', $cm->modname);
3575     $a->modname = format_string($cm->name);
3577     if (!plugin_supports('mod', $cm->modname, FEATURE_BACKUP_MOODLE2)) {
3578         throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3579     }
3581     // Backup the activity.
3583     $bc = new backup_controller(backup::TYPE_1ACTIVITY, $cm->id, backup::FORMAT_MOODLE,
3584             backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id);
3586     $backupid       = $bc->get_backupid();
3587     $backupbasepath = $bc->get_plan()->get_basepath();
3589     $bc->execute_plan();
3591     $bc->destroy();
3593     // Restore the backup immediately.
3595     $rc = new restore_controller($backupid, $course->id,
3596             backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id, backup::TARGET_CURRENT_ADDING);
3598     $cmcontext = context_module::instance($cm->id);
3599     if (!$rc->execute_precheck()) {
3600         $precheckresults = $rc->get_precheck_results();
3601         if (is_array($precheckresults) && !empty($precheckresults['errors'])) {
3602             if (empty($CFG->keeptempdirectoriesonbackup)) {
3603                 fulldelete($backupbasepath);
3604             }
3605         }
3606     }
3608     $rc->execute_plan();
3610     // Now a bit hacky part follows - we try to get the cmid of the newly
3611     // restored copy of the module.
3612     $newcmid = null;
3613     $tasks = $rc->get_plan()->get_tasks();
3614     foreach ($tasks as $task) {
3615         if (is_subclass_of($task, 'restore_activity_task')) {
3616             if ($task->get_old_contextid() == $cmcontext->id) {
3617                 $newcmid = $task->get_moduleid();
3618                 break;
3619             }
3620         }
3621     }
3623     // If we know the cmid of the new course module, let us move it
3624     // right below the original one. otherwise it will stay at the
3625     // end of the section.
3626     if ($newcmid) {
3627         $info = get_fast_modinfo($course);
3628         $newcm = $info->get_cm($newcmid);
3629         $section = $DB->get_record('course_sections', array('id' => $cm->section, 'course' => $cm->course));
3630         moveto_module($newcm, $section, $cm);
3631         moveto_module($cm, $section, $newcm);
3633         // Trigger course module created event. We can trigger the event only if we know the newcmid.
3634         $event = \core\event\course_module_created::create_from_cm($newcm);
3635         $event->trigger();
3636     }
3637     rebuild_course_cache($cm->course);
3639     $rc->destroy();
3641     if (empty($CFG->keeptempdirectoriesonbackup)) {
3642         fulldelete($backupbasepath);
3643     }
3645     return isset($newcm) ? $newcm : null;
3648 /**
3649  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3650  * Sorts by descending order of time.
3651  *
3652  * @param stdClass $a First object
3653  * @param stdClass $b Second object
3654  * @return int 0,1,-1 representing the order
3655  */
3656 function compare_activities_by_time_desc($a, $b) {
3657     // Make sure the activities actually have a timestamp property.
3658     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3659         return 0;
3660     }
3661     // We treat instances without timestamp as if they have a timestamp of 0.
3662     if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3663         return 1;
3664     }
3665     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3666         return -1;
3667     }
3668     if ($a->timestamp == $b->timestamp) {
3669         return 0;
3670     }
3671     return ($a->timestamp > $b->timestamp) ? -1 : 1;
3674 /**
3675  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3676  * Sorts by ascending order of time.
3677  *
3678  * @param stdClass $a First object
3679  * @param stdClass $b Second object
3680  * @return int 0,1,-1 representing the order
3681  */
3682 function compare_activities_by_time_asc($a, $b) {
3683     // Make sure the activities actually have a timestamp property.
3684     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3685       return 0;
3686     }
3687     // We treat instances without timestamp as if they have a timestamp of 0.
3688     if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3689         return -1;
3690     }
3691     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3692         return 1;
3693     }
3694     if ($a->timestamp == $b->timestamp) {
3695         return 0;
3696     }
3697     return ($a->timestamp < $b->timestamp) ? -1 : 1;
3700 /**
3701  * Changes the visibility of a course.
3702  *
3703  * @param int $courseid The course to change.
3704  * @param bool $show True to make it visible, false otherwise.
3705  * @return bool
3706  */
3707 function course_change_visibility($courseid, $show = true) {
3708     $course = new stdClass;
3709     $course->id = $courseid;
3710     $course->visible = ($show) ? '1' : '0';
3711     $course->visibleold = $course->visible;
3712     update_course($course);
3713     return true;
3716 /**
3717  * Changes the course sortorder by one, moving it up or down one in respect to sort order.
3718  *
3719  * @param stdClass|course_in_list $course
3720  * @param bool $up If set to true the course will be moved up one. Otherwise down one.
3721  * @return bool
3722  */
3723 function course_change_sortorder_by_one($course, $up) {
3724     global $DB;
3725     $params = array($course->sortorder, $course->category);
3726     if ($up) {
3727         $select = 'sortorder < ? AND category = ?';
3728         $sort = 'sortorder DESC';
3729     } else {
3730         $select = 'sortorder > ? AND category = ?';
3731         $sort = 'sortorder ASC';
3732     }
3733     fix_course_sortorder();
3734     $swapcourse = $DB->get_records_select('course', $select, $params, $sort, '*', 0, 1);
3735     if ($swapcourse) {
3736         $swapcourse = reset($swapcourse);
3737         $DB->set_field('course', 'sortorder', $swapcourse->sortorder, array('id' => $course->id));
3738         $DB->set_field('course', 'sortorder', $course->sortorder, array('id' => $swapcourse->id));
3739         // Finally reorder courses.
3740         fix_course_sortorder();
3741         cache_helper::purge_by_event('changesincourse');
3742         return true;
3743     }
3744     return false;
3747 /**
3748  * Changes the sort order of courses in a category so that the first course appears after the second.
3749  *
3750  * @param int|stdClass $courseorid The course to focus on.
3751  * @param int $moveaftercourseid The course to shifter after or 0 if you want it to be the first course in the category.
3752  * @return bool
3753  */
3754 function course_change_sortorder_after_course($courseorid, $moveaftercourseid) {
3755     global $DB;
3757     if (!is_object($courseorid)) {
3758         $course = get_course($courseorid);
3759     } else {
3760         $course = $courseorid;
3761     }
3763     if ((int)$moveaftercourseid === 0) {
3764         // We've moving the course to the start of the queue.
3765         $sql = 'SELECT sortorder
3766                       FROM {course}
3767                      WHERE category = :categoryid
3768                   ORDER BY sortorder';
3769         $params = array(
3770             'categoryid' => $course->category
3771         );
3772         $sortorder = $DB->get_field_sql($sql, $params, IGNORE_MULTIPLE);
3774         $sql = 'UPDATE {course}
3775                    SET sortorder = sortorder + 1
3776                  WHERE category = :categoryid
3777                    AND id <> :id';
3778         $params = array(
3779             'categoryid' => $course->category,
3780             'id' => $course->id,
3781         );
3782         $DB->execute($sql, $params);
3783         $DB->set_field('course', 'sortorder', $sortorder, array('id' => $course->id));
3784     } else if ($course->id === $moveaftercourseid) {
3785         // They're the same - moronic.
3786         debugging("Invalid move after course given.", DEBUG_DEVELOPER);
3787         return false;
3788     } else {
3789         // Moving this course after the given course. It could be before it could be after.
3790         $moveaftercourse = get_course($moveaftercourseid);
3791         if ($course->category !== $moveaftercourse->category) {
3792             debugging("Cannot re-order courses. The given courses do not belong to the same category.", DEBUG_DEVELOPER);
3793             return false;
3794         }
3795         // Increment all courses in the same category that are ordered after the moveafter course.
3796         // This makes a space for the course we're moving.
3797         $sql = 'UPDATE {course}
3798                        SET sortorder = sortorder + 1
3799                      WHERE category = :categoryid
3800                        AND sortorder > :sortorder';
3801         $params = array(
3802             'categoryid' => $moveaftercourse->category,
3803             'sortorder' => $moveaftercourse->sortorder
3804         );
3805         $DB->execute($sql, $params);
3806         $DB->set_field('course', 'sortorder', $moveaftercourse->sortorder + 1, array('id' => $course->id));
3807     }
3808     fix_course_sortorder();
3809     cache_helper::purge_by_event('changesincourse');
3810     return true;
3813 /**
3814  * Trigger course viewed event. This API function is used when course view actions happens,
3815  * usually in course/view.php but also in external functions.
3816  *
3817  * @param stdClass  $context course context object
3818  * @param int $sectionnumber section number
3819  * @since Moodle 2.9
3820  */
3821 function course_view($context, $sectionnumber = 0) {
3823     $eventdata = array('context' => $context);
3825     if (!empty($sectionnumber)) {
3826         $eventdata['other']['coursesectionnumber'] = $sectionnumber;
3827     }
3829     $event = \core\event\course_viewed::create($eventdata);
3830     $event->trigger();