MDL-50851 course: use new tag API
[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');
1652     // Get the course module.
1653     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1654         return true;
1655     }
1657     // Get the module context.
1658     $modcontext = context_module::instance($cm->id);
1660     // Get the course module name.
1661     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1663     // Get the file location of the delete_instance function for this module.
1664     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1666     // Include the file required to call the delete_instance function for this module.
1667     if (file_exists($modlib)) {
1668         require_once($modlib);
1669     } else {
1670         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1671             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1672     }
1674     $deleteinstancefunction = $modulename . '_delete_instance';
1676     // Ensure the delete_instance function exists for this module.
1677     if (!function_exists($deleteinstancefunction)) {
1678         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1679             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1680     }
1682     // Delete activity context questions and question categories.
1683     question_delete_activity($cm);
1685     // Call the delete_instance function, if it returns false throw an exception.
1686     if (!$deleteinstancefunction($cm->instance)) {
1687         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1688             "Cannot delete the module $modulename (instance).");
1689     }
1691     // Remove all module files in case modules forget to do that.
1692     $fs = get_file_storage();
1693     $fs->delete_area_files($modcontext->id);
1695     // Delete events from calendar.
1696     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1697         foreach($events as $event) {
1698             $calendarevent = calendar_event::load($event->id);
1699             $calendarevent->delete();
1700         }
1701     }
1703     // Delete grade items, outcome items and grades attached to modules.
1704     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1705                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1706         foreach ($grade_items as $grade_item) {
1707             $grade_item->delete('moddelete');
1708         }
1709     }
1711     // Delete completion and availability data; it is better to do this even if the
1712     // features are not turned on, in case they were turned on previously (these will be
1713     // very quick on an empty table).
1714     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1715     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1716                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1718     // Delete all tag instances associated with the instance of this module.
1719     core_tag_tag::delete_instances('mod_' . $modulename, null, $modcontext->id);
1721     // Delete the context.
1722     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1724     // Delete the module from the course_modules table.
1725     $DB->delete_records('course_modules', array('id' => $cm->id));
1727     // Delete module from that section.
1728     if (!delete_mod_from_section($cm->id, $cm->section)) {
1729         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1730             "Cannot delete the module $modulename (instance) from section.");
1731     }
1733     // Trigger event for course module delete action.
1734     $event = \core\event\course_module_deleted::create(array(
1735         'courseid' => $cm->course,
1736         'context'  => $modcontext,
1737         'objectid' => $cm->id,
1738         'other'    => array(
1739             'modulename' => $modulename,
1740             'instanceid'   => $cm->instance,
1741         )
1742     ));
1743     $event->add_record_snapshot('course_modules', $cm);
1744     $event->trigger();
1745     rebuild_course_cache($cm->course, true);
1748 function delete_mod_from_section($modid, $sectionid) {
1749     global $DB;
1751     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1753         $modarray = explode(",", $section->sequence);
1755         if ($key = array_keys ($modarray, $modid)) {
1756             array_splice($modarray, $key[0], 1);
1757             $newsequence = implode(",", $modarray);
1758             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1759             rebuild_course_cache($section->course, true);
1760             return true;
1761         } else {
1762             return false;
1763         }
1765     }
1766     return false;
1769 /**
1770  * Moves a section within a course, from a position to another.
1771  * Be very careful: $section and $destination refer to section number,
1772  * not id!.
1773  *
1774  * @param object $course
1775  * @param int $section Section number (not id!!!)
1776  * @param int $destination
1777  * @param bool $ignorenumsections
1778  * @return boolean Result
1779  */
1780 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1781 /// Moves a whole course section up and down within the course
1782     global $USER, $DB;
1784     if (!$destination && $destination != 0) {
1785         return true;
1786     }
1788     // compartibility with course formats using field 'numsections'
1789     $courseformatoptions = course_get_format($course)->get_format_options();
1790     if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1791             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1792         return false;
1793     }
1795     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1796     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1797             'section ASC, id ASC', 'id, section')) {
1798         return false;
1799     }
1801     $movedsections = reorder_sections($sections, $section, $destination);
1803     // Update all sections. Do this in 2 steps to avoid breaking database
1804     // uniqueness constraint
1805     $transaction = $DB->start_delegated_transaction();
1806     foreach ($movedsections as $id => $position) {
1807         if ($sections[$id] !== $position) {
1808             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1809         }
1810     }
1811     foreach ($movedsections as $id => $position) {
1812         if ($sections[$id] !== $position) {
1813             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1814         }
1815     }
1817     // If we move the highlighted section itself, then just highlight the destination.
1818     // Adjust the higlighted section location if we move something over it either direction.
1819     if ($section == $course->marker) {
1820         course_set_marker($course->id, $destination);
1821     } elseif ($section > $course->marker && $course->marker >= $destination) {
1822         course_set_marker($course->id, $course->marker+1);
1823     } elseif ($section < $course->marker && $course->marker <= $destination) {
1824         course_set_marker($course->id, $course->marker-1);
1825     }
1827     $transaction->allow_commit();
1828     rebuild_course_cache($course->id, true);
1829     return true;
1832 /**
1833  * This method will delete a course section and may delete all modules inside it.
1834  *
1835  * No permissions are checked here, use {@link course_can_delete_section()} to
1836  * check if section can actually be deleted.
1837  *
1838  * @param int|stdClass $course
1839  * @param int|stdClass|section_info $section
1840  * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1841  * @return bool whether section was deleted
1842  */
1843 function course_delete_section($course, $section, $forcedeleteifnotempty = true) {
1844     global $DB;
1846     // Prepare variables.
1847     $courseid = (is_object($course)) ? $course->id : (int)$course;
1848     $sectionnum = (is_object($section)) ? $section->section : (int)$section;
1849     $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1850     if (!$section) {
1851         // No section exists, can't proceed.
1852         return false;
1853     }
1854     $format = course_get_format($course);
1855     $sectionname = $format->get_section_name($section);
1857     // Delete section.
1858     $result = $format->delete_section($section, $forcedeleteifnotempty);
1860     // Trigger an event for course section deletion.
1861     if ($result) {
1862         $context = context_course::instance($courseid);
1863         $event = \core\event\course_section_deleted::create(
1864                 array(
1865                     'objectid' => $section->id,
1866                     'courseid' => $courseid,
1867                     'context' => $context,
1868                     'other' => array(
1869                         'sectionnum' => $section->section,
1870                         'sectionname' => $sectionname,
1871                     )
1872                 )
1873             );
1874         $event->add_record_snapshot('course_sections', $section);
1875         $event->trigger();
1876     }
1877     return $result;
1880 /**
1881  * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1882  *
1883  * @param int|stdClass $course
1884  * @param int|stdClass|section_info $section
1885  * @return bool
1886  */
1887 function course_can_delete_section($course, $section) {
1888     if (is_object($section)) {
1889         $section = $section->section;
1890     }
1891     if (!$section) {
1892         // Not possible to delete 0-section.
1893         return false;
1894     }
1895     // Course format should allow to delete sections.
1896     if (!course_get_format($course)->can_delete_section($section)) {
1897         return false;
1898     }
1899     // Make sure user has capability to update course and move sections.
1900     $context = context_course::instance(is_object($course) ? $course->id : $course);
1901     if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1902         return false;
1903     }
1904     // Make sure user has capability to delete each activity in this section.
1905     $modinfo = get_fast_modinfo($course);
1906     if (!empty($modinfo->sections[$section])) {
1907         foreach ($modinfo->sections[$section] as $cmid) {
1908             if (!has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1909                 return false;
1910             }
1911         }
1912     }
1913     return true;
1916 /**
1917  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1918  * an original position number and a target position number, rebuilds the array so that the
1919  * move is made without any duplication of section positions.
1920  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1921  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1922  *
1923  * @param array $sections
1924  * @param int $origin_position
1925  * @param int $target_position
1926  * @return array
1927  */
1928 function reorder_sections($sections, $origin_position, $target_position) {
1929     if (!is_array($sections)) {
1930         return false;
1931     }
1933     // We can't move section position 0
1934     if ($origin_position < 1) {
1935         echo "We can't move section position 0";
1936         return false;
1937     }
1939     // Locate origin section in sections array
1940     if (!$origin_key = array_search($origin_position, $sections)) {
1941         echo "searched position not in sections array";
1942         return false; // searched position not in sections array
1943     }
1945     // Extract origin section
1946     $origin_section = $sections[$origin_key];
1947     unset($sections[$origin_key]);
1949     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1950     $found = false;
1951     $append_array = array();
1952     foreach ($sections as $id => $position) {
1953         if ($found) {
1954             $append_array[$id] = $position;
1955             unset($sections[$id]);
1956         }
1957         if ($position == $target_position) {
1958             if ($target_position < $origin_position) {
1959                 $append_array[$id] = $position;
1960                 unset($sections[$id]);
1961             }
1962             $found = true;
1963         }
1964     }
1966     // Append moved section
1967     $sections[$origin_key] = $origin_section;
1969     // Append rest of array (if applicable)
1970     if (!empty($append_array)) {
1971         foreach ($append_array as $id => $position) {
1972             $sections[$id] = $position;
1973         }
1974     }
1976     // Renumber positions
1977     $position = 0;
1978     foreach ($sections as $id => $p) {
1979         $sections[$id] = $position;
1980         $position++;
1981     }
1983     return $sections;
1987 /**
1988  * Move the module object $mod to the specified $section
1989  * If $beforemod exists then that is the module
1990  * before which $modid should be inserted
1991  *
1992  * @param stdClass|cm_info $mod
1993  * @param stdClass|section_info $section
1994  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1995  *     before which the module needs to be included. Null for inserting in the
1996  *     end of the section
1997  * @return int new value for module visibility (0 or 1)
1998  */
1999 function moveto_module($mod, $section, $beforemod=NULL) {
2000     global $OUTPUT, $DB;
2002     // Current module visibility state - return value of this function.
2003     $modvisible = $mod->visible;
2005     // Remove original module from original section.
2006     if (! delete_mod_from_section($mod->id, $mod->section)) {
2007         echo $OUTPUT->notification("Could not delete module from existing section");
2008     }
2010     // If moving to a hidden section then hide module.
2011     if ($mod->section != $section->id) {
2012         if (!$section->visible && $mod->visible) {
2013             // Module was visible but must become hidden after moving to hidden section.
2014             $modvisible = 0;
2015             set_coursemodule_visible($mod->id, 0);
2016             // Set visibleold to 1 so module will be visible when section is made visible.
2017             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
2018         }
2019         if ($section->visible && !$mod->visible) {
2020             // Hidden module was moved to the visible section, restore the module visibility from visibleold.
2021             set_coursemodule_visible($mod->id, $mod->visibleold);
2022             $modvisible = $mod->visibleold;
2023         }
2024     }
2026     // Add the module into the new section.
2027     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
2028     return $modvisible;
2031 /**
2032  * Returns the list of all editing actions that current user can perform on the module
2033  *
2034  * @param cm_info $mod The module to produce editing buttons for
2035  * @param int $indent The current indenting (default -1 means no move left-right actions)
2036  * @param int $sr The section to link back to (used for creating the links)
2037  * @return array array of action_link or pix_icon objects
2038  */
2039 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2040     global $COURSE, $SITE;
2042     static $str;
2044     $coursecontext = context_course::instance($mod->course);
2045     $modcontext = context_module::instance($mod->id);
2047     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2048     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2050     // No permission to edit anything.
2051     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2052         return array();
2053     }
2055     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2057     if (!isset($str)) {
2058         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2059             'editsettings', 'duplicate', 'hide', 'show'), 'moodle');
2060         $str->assign         = get_string('assignroles', 'role');
2061         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2062         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2063         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2064     }
2066     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2068     if ($sr !== null) {
2069         $baseurl->param('sr', $sr);
2070     }
2071     $actions = array();
2073     // Update.
2074     if ($hasmanageactivities) {
2075         $actions['update'] = new action_menu_link_secondary(
2076             new moodle_url($baseurl, array('update' => $mod->id)),
2077             new pix_icon('t/edit', $str->editsettings, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2078             $str->editsettings,
2079             array('class' => 'editing_update', 'data-action' => 'update')
2080         );
2081     }
2083     // Indent.
2084     if ($hasmanageactivities && $indent >= 0) {
2085         $indentlimits = new stdClass();
2086         $indentlimits->min = 0;
2087         $indentlimits->max = 16;
2088         if (right_to_left()) {   // Exchange arrows on RTL
2089             $rightarrow = 't/left';
2090             $leftarrow  = 't/right';
2091         } else {
2092             $rightarrow = 't/right';
2093             $leftarrow  = 't/left';
2094         }
2096         if ($indent >= $indentlimits->max) {
2097             $enabledclass = 'hidden';
2098         } else {
2099             $enabledclass = '';
2100         }
2101         $actions['moveright'] = new action_menu_link_secondary(
2102             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2103             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2104             $str->moveright,
2105             array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright', 'data-keepopen' => true)
2106         );
2108         if ($indent <= $indentlimits->min) {
2109             $enabledclass = 'hidden';
2110         } else {
2111             $enabledclass = '';
2112         }
2113         $actions['moveleft'] = new action_menu_link_secondary(
2114             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
2115             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2116             $str->moveleft,
2117             array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft', 'data-keepopen' => true)
2118         );
2120     }
2122     // Hide/Show.
2123     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2124         if ($mod->visible) {
2125             $actions['hide'] = new action_menu_link_secondary(
2126                 new moodle_url($baseurl, array('hide' => $mod->id)),
2127                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2128                 $str->hide,
2129                 array('class' => 'editing_hide', 'data-action' => 'hide')
2130             );
2131         } else {
2132             $actions['show'] = new action_menu_link_secondary(
2133                 new moodle_url($baseurl, array('show' => $mod->id)),
2134                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2135                 $str->show,
2136                 array('class' => 'editing_show', 'data-action' => 'show')
2137             );
2138         }
2139     }
2141     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2142     if (has_all_capabilities($dupecaps, $coursecontext) &&
2143             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
2144         $actions['duplicate'] = new action_menu_link_secondary(
2145             new moodle_url($baseurl, array('duplicate' => $mod->id)),
2146             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2147             $str->duplicate,
2148             array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sr' => $sr)
2149         );
2150     }
2152     // Groupmode.
2153     if ($hasmanageactivities && !$mod->coursegroupmodeforce) {
2154         if (plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2155             if ($mod->effectivegroupmode == SEPARATEGROUPS) {
2156                 $nextgroupmode = VISIBLEGROUPS;
2157                 $grouptitle = $str->groupsseparate;
2158                 $actionname = 'groupsseparate';
2159                 $groupimage = 'i/groups';
2160             } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
2161                 $nextgroupmode = NOGROUPS;
2162                 $grouptitle = $str->groupsvisible;
2163                 $actionname = 'groupsvisible';
2164                 $groupimage = 'i/groupv';
2165             } else {
2166                 $nextgroupmode = SEPARATEGROUPS;
2167                 $grouptitle = $str->groupsnone;
2168                 $actionname = 'groupsnone';
2169                 $groupimage = 'i/groupn';
2170             }
2172             $actions[$actionname] = new action_menu_link_primary(
2173                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
2174                 new pix_icon($groupimage, null, 'moodle', array('class' => 'iconsmall')),
2175                 $grouptitle,
2176                 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode, 'aria-live' => 'assertive')
2177             );
2178         } else {
2179             $actions['nogroupsupport'] = new action_menu_filler();
2180         }
2181     }
2183     // Assign.
2184     if (has_capability('moodle/role:assign', $modcontext)){
2185         $actions['assign'] = new action_menu_link_secondary(
2186             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2187             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2188             $str->assign,
2189             array('class' => 'editing_assign', 'data-action' => 'assignroles')
2190         );
2191     }
2193     // Delete.
2194     if ($hasmanageactivities) {
2195         $actions['delete'] = new action_menu_link_secondary(
2196             new moodle_url($baseurl, array('delete' => $mod->id)),
2197             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2198             $str->delete,
2199             array('class' => 'editing_delete', 'data-action' => 'delete')
2200         );
2201     }
2203     return $actions;
2206 /**
2207  * Returns the rename action.
2208  *
2209  * @param cm_info $mod The module to produce editing buttons for
2210  * @param int $sr The section to link back to (used for creating the links)
2211  * @return The markup for the rename action, or an empty string if not available.
2212  */
2213 function course_get_cm_rename_action(cm_info $mod, $sr = null) {
2214     global $COURSE, $OUTPUT;
2216     static $str;
2217     static $baseurl;
2219     $modcontext = context_module::instance($mod->id);
2220     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2222     if (!isset($str)) {
2223         $str = get_strings(array('edittitle'));
2224     }
2226     if (!isset($baseurl)) {
2227         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2228     }
2230     if ($sr !== null) {
2231         $baseurl->param('sr', $sr);
2232     }
2234     // AJAX edit title.
2235     if ($mod->has_view() && $hasmanageactivities && course_ajax_enabled($COURSE) &&
2236                 (($mod->course == $COURSE->id) || ($mod->course == SITEID))) {
2237         // we will not display link if we are on some other-course page (where we should not see this module anyway)
2238         return html_writer::span(
2239             html_writer::link(
2240                 new moodle_url($baseurl, array('update' => $mod->id)),
2241                 $OUTPUT->pix_icon('t/editstring', '', 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2242                 array(
2243                     'class' => 'editing_title',
2244                     'data-action' => 'edittitle',
2245                     'title' => $str->edittitle,
2246                 )
2247             )
2248         );
2249     }
2250     return '';
2253 /**
2254  * Returns the move action.
2255  *
2256  * @param cm_info $mod The module to produce a move button for
2257  * @param int $sr The section to link back to (used for creating the links)
2258  * @return The markup for the move action, or an empty string if not available.
2259  */
2260 function course_get_cm_move(cm_info $mod, $sr = null) {
2261     global $OUTPUT;
2263     static $str;
2264     static $baseurl;
2266     $modcontext = context_module::instance($mod->id);
2267     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2269     if (!isset($str)) {
2270         $str = get_strings(array('move'));
2271     }
2273     if (!isset($baseurl)) {
2274         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2276         if ($sr !== null) {
2277             $baseurl->param('sr', $sr);
2278         }
2279     }
2281     if ($hasmanageactivities) {
2282         $pixicon = 'i/dragdrop';
2284         if (!course_ajax_enabled($mod->get_course())) {
2285             // Override for course frontpage until we get drag/drop working there.
2286             $pixicon = 't/move';
2287         }
2289         return html_writer::link(
2290             new moodle_url($baseurl, array('copy' => $mod->id)),
2291             $OUTPUT->pix_icon($pixicon, $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2292             array('class' => 'editing_move', 'data-action' => 'move')
2293         );
2294     }
2295     return '';
2298 /**
2299  * given a course object with shortname & fullname, this function will
2300  * truncate the the number of chars allowed and add ... if it was too long
2301  */
2302 function course_format_name ($course,$max=100) {
2304     $context = context_course::instance($course->id);
2305     $shortname = format_string($course->shortname, true, array('context' => $context));
2306     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2307     $str = $shortname.': '. $fullname;
2308     if (core_text::strlen($str) <= $max) {
2309         return $str;
2310     }
2311     else {
2312         return core_text::substr($str,0,$max-3).'...';
2313     }
2316 /**
2317  * Is the user allowed to add this type of module to this course?
2318  * @param object $course the course settings. Only $course->id is used.
2319  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2320  * @return bool whether the current user is allowed to add this type of module to this course.
2321  */
2322 function course_allowed_module($course, $modname) {
2323     if (is_numeric($modname)) {
2324         throw new coding_exception('Function course_allowed_module no longer
2325                 supports numeric module ids. Please update your code to pass the module name.');
2326     }
2328     $capability = 'mod/' . $modname . ':addinstance';
2329     if (!get_capability_info($capability)) {
2330         // Debug warning that the capability does not exist, but no more than once per page.
2331         static $warned = array();
2332         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2333         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2334             debugging('The module ' . $modname . ' does not define the standard capability ' .
2335                     $capability , DEBUG_DEVELOPER);
2336             $warned[$modname] = 1;
2337         }
2339         // If the capability does not exist, the module can always be added.
2340         return true;
2341     }
2343     $coursecontext = context_course::instance($course->id);
2344     return has_capability($capability, $coursecontext);
2347 /**
2348  * Efficiently moves many courses around while maintaining
2349  * sortorder in order.
2350  *
2351  * @param array $courseids is an array of course ids
2352  * @param int $categoryid
2353  * @return bool success
2354  */
2355 function move_courses($courseids, $categoryid) {
2356     global $DB;
2358     if (empty($courseids)) {
2359         // Nothing to do.
2360         return false;
2361     }
2363     if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2364         return false;
2365     }
2367     $courseids = array_reverse($courseids);
2368     $newparent = context_coursecat::instance($category->id);
2369     $i = 1;
2371     list($where, $params) = $DB->get_in_or_equal($courseids);
2372     $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2373     foreach ($dbcourses as $dbcourse) {
2374         $course = new stdClass();
2375         $course->id = $dbcourse->id;
2376         $course->category  = $category->id;
2377         $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2378         if ($category->visible == 0) {
2379             // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2380             // to previous state if somebody unhides the category.
2381             $course->visible = 0;
2382         }
2384         $DB->update_record('course', $course);
2386         // Update context, so it can be passed to event.
2387         $context = context_course::instance($course->id);
2388         $context->update_moved($newparent);
2390         // Trigger a course updated event.
2391         $event = \core\event\course_updated::create(array(
2392             'objectid' => $course->id,
2393             'context' => context_course::instance($course->id),
2394             'other' => array('shortname' => $dbcourse->shortname,
2395                              'fullname' => $dbcourse->fullname)
2396         ));
2397         $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2398         $event->trigger();
2399     }
2400     fix_course_sortorder();
2401     cache_helper::purge_by_event('changesincourse');
2403     return true;
2406 /**
2407  * Returns the display name of the given section that the course prefers
2408  *
2409  * Implementation of this function is provided by course format
2410  * @see format_base::get_section_name()
2411  *
2412  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2413  * @param int|stdClass $section Section object from database or just field course_sections.section
2414  * @return string Display name that the course format prefers, e.g. "Week 2"
2415  */
2416 function get_section_name($courseorid, $section) {
2417     return course_get_format($courseorid)->get_section_name($section);
2420 /**
2421  * Tells if current course format uses sections
2422  *
2423  * @param string $format Course format ID e.g. 'weeks' $course->format
2424  * @return bool
2425  */
2426 function course_format_uses_sections($format) {
2427     $course = new stdClass();
2428     $course->format = $format;
2429     return course_get_format($course)->uses_sections();
2432 /**
2433  * Returns the information about the ajax support in the given source format
2434  *
2435  * The returned object's property (boolean)capable indicates that
2436  * the course format supports Moodle course ajax features.
2437  *
2438  * @param string $format
2439  * @return stdClass
2440  */
2441 function course_format_ajax_support($format) {
2442     $course = new stdClass();
2443     $course->format = $format;
2444     return course_get_format($course)->supports_ajax();
2447 /**
2448  * Can the current user delete this course?
2449  * Course creators have exception,
2450  * 1 day after the creation they can sill delete the course.
2451  * @param int $courseid
2452  * @return boolean
2453  */
2454 function can_delete_course($courseid) {
2455     global $USER;
2457     $context = context_course::instance($courseid);
2459     if (has_capability('moodle/course:delete', $context)) {
2460         return true;
2461     }
2463     // hack: now try to find out if creator created this course recently (1 day)
2464     if (!has_capability('moodle/course:create', $context)) {
2465         return false;
2466     }
2468     $since = time() - 60*60*24;
2469     $course = get_course($courseid);
2471     if ($course->timecreated < $since) {
2472         return false; // Return if the course was not created in last 24 hours.
2473     }
2475     $logmanger = get_log_manager();
2476     $readers = $logmanger->get_readers('\core\log\sql_reader');
2477     $reader = reset($readers);
2479     if (empty($reader)) {
2480         return false; // No log reader found.
2481     }
2483     // A proper reader.
2484     $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2485     $params = array('userid' => $USER->id, 'since' => $since, 'courseid' => $course->id, 'eventname' => '\core\event\course_created');
2487     return (bool)$reader->get_events_select_count($select, $params);
2490 /**
2491  * Save the Your name for 'Some role' strings.
2492  *
2493  * @param integer $courseid the id of this course.
2494  * @param array $data the data that came from the course settings form.
2495  */
2496 function save_local_role_names($courseid, $data) {
2497     global $DB;
2498     $context = context_course::instance($courseid);
2500     foreach ($data as $fieldname => $value) {
2501         if (strpos($fieldname, 'role_') !== 0) {
2502             continue;
2503         }
2504         list($ignored, $roleid) = explode('_', $fieldname);
2506         // make up our mind whether we want to delete, update or insert
2507         if (!$value) {
2508             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2510         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2511             $rolename->name = $value;
2512             $DB->update_record('role_names', $rolename);
2514         } else {
2515             $rolename = new stdClass;
2516             $rolename->contextid = $context->id;
2517             $rolename->roleid = $roleid;
2518             $rolename->name = $value;
2519             $DB->insert_record('role_names', $rolename);
2520         }
2521         // This will ensure the course contacts cache is purged..
2522         coursecat::role_assignment_changed($roleid, $context);
2523     }
2526 /**
2527  * Returns options to use in course overviewfiles filemanager
2528  *
2529  * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2530  *     may be empty if course does not exist yet (course create form)
2531  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2532  *     or null if overviewfiles are disabled
2533  */
2534 function course_overviewfiles_options($course) {
2535     global $CFG;
2536     if (empty($CFG->courseoverviewfileslimit)) {
2537         return null;
2538     }
2539     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2540     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2541         $accepted_types = '*';
2542     } else {
2543         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2544         // Make sure extensions are prefixed with dot unless they are valid typegroups
2545         foreach ($accepted_types as $i => $type) {
2546             if (substr($type, 0, 1) !== '.') {
2547                 require_once($CFG->libdir. '/filelib.php');
2548                 if (!count(file_get_typegroup('extension', $type))) {
2549                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2550                     $accepted_types[$i] = '.'. $type;
2551                     $corrected = true;
2552                 }
2553             }
2554         }
2555         if (!empty($corrected)) {
2556             set_config('courseoverviewfilesext', join(',', $accepted_types));
2557         }
2558     }
2559     $options = array(
2560         'maxfiles' => $CFG->courseoverviewfileslimit,
2561         'maxbytes' => $CFG->maxbytes,
2562         'subdirs' => 0,
2563         'accepted_types' => $accepted_types
2564     );
2565     if (!empty($course->id)) {
2566         $options['context'] = context_course::instance($course->id);
2567     } else if (is_int($course) && $course > 0) {
2568         $options['context'] = context_course::instance($course);
2569     }
2570     return $options;
2573 /**
2574  * Create a course and either return a $course object
2575  *
2576  * Please note this functions does not verify any access control,
2577  * the calling code is responsible for all validation (usually it is the form definition).
2578  *
2579  * @param array $editoroptions course description editor options
2580  * @param object $data  - all the data needed for an entry in the 'course' table
2581  * @return object new course instance
2582  */
2583 function create_course($data, $editoroptions = NULL) {
2584     global $DB, $CFG;
2586     //check the categoryid - must be given for all new courses
2587     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2589     // Check if the shortname already exists.
2590     if (!empty($data->shortname)) {
2591         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2592             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2593         }
2594     }
2596     // Check if the idnumber already exists.
2597     if (!empty($data->idnumber)) {
2598         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2599             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2600         }
2601     }
2603     // Check if timecreated is given.
2604     $data->timecreated  = !empty($data->timecreated) ? $data->timecreated : time();
2605     $data->timemodified = $data->timecreated;
2607     // place at beginning of any category
2608     $data->sortorder = 0;
2610     if ($editoroptions) {
2611         // summary text is updated later, we need context to store the files first
2612         $data->summary = '';
2613         $data->summary_format = FORMAT_HTML;
2614     }
2616     if (!isset($data->visible)) {
2617         // data not from form, add missing visibility info
2618         $data->visible = $category->visible;
2619     }
2620     $data->visibleold = $data->visible;
2622     $newcourseid = $DB->insert_record('course', $data);
2623     $context = context_course::instance($newcourseid, MUST_EXIST);
2625     if ($editoroptions) {
2626         // Save the files used in the summary editor and store
2627         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2628         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2629         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2630     }
2631     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2632         // Save the course overviewfiles
2633         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2634     }
2636     // update course format options
2637     course_get_format($newcourseid)->update_course_format_options($data);
2639     $course = course_get_format($newcourseid)->get_course();
2641     fix_course_sortorder();
2642     // purge appropriate caches in case fix_course_sortorder() did not change anything
2643     cache_helper::purge_by_event('changesincourse');
2645     // new context created - better mark it as dirty
2646     $context->mark_dirty();
2648     // Trigger a course created event.
2649     $event = \core\event\course_created::create(array(
2650         'objectid' => $course->id,
2651         'context' => context_course::instance($course->id),
2652         'other' => array('shortname' => $course->shortname,
2653             'fullname' => $course->fullname)
2654     ));
2655     $event->trigger();
2657     // Setup the blocks
2658     blocks_add_default_course_blocks($course);
2660     // Create a default section.
2661     course_create_sections_if_missing($course, 0);
2663     // Save any custom role names.
2664     save_local_role_names($course->id, (array)$data);
2666     // set up enrolments
2667     enrol_course_updated(true, $course, $data);
2669     // Update course tags.
2670     if (isset($data->tags)) {
2671         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2672     }
2674     return $course;
2677 /**
2678  * Update a course.
2679  *
2680  * Please note this functions does not verify any access control,
2681  * the calling code is responsible for all validation (usually it is the form definition).
2682  *
2683  * @param object $data  - all the data needed for an entry in the 'course' table
2684  * @param array $editoroptions course description editor options
2685  * @return void
2686  */
2687 function update_course($data, $editoroptions = NULL) {
2688     global $DB, $CFG;
2690     $data->timemodified = time();
2692     $oldcourse = course_get_format($data->id)->get_course();
2693     $context   = context_course::instance($oldcourse->id);
2695     if ($editoroptions) {
2696         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2697     }
2698     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2699         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2700     }
2702     // Check we don't have a duplicate shortname.
2703     if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
2704         if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname, $data->id))) {
2705             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2706         }
2707     }
2709     // Check we don't have a duplicate idnumber.
2710     if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
2711         if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber, $data->id))) {
2712             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2713         }
2714     }
2716     if (!isset($data->category) or empty($data->category)) {
2717         // prevent nulls and 0 in category field
2718         unset($data->category);
2719     }
2720     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2722     if (!isset($data->visible)) {
2723         // data not from form, add missing visibility info
2724         $data->visible = $oldcourse->visible;
2725     }
2727     if ($data->visible != $oldcourse->visible) {
2728         // reset the visibleold flag when manually hiding/unhiding course
2729         $data->visibleold = $data->visible;
2730         $changesincoursecat = true;
2731     } else {
2732         if ($movecat) {
2733             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2734             if (empty($newcategory->visible)) {
2735                 // make sure when moving into hidden category the course is hidden automatically
2736                 $data->visible = 0;
2737             }
2738         }
2739     }
2741     // Update with the new data
2742     $DB->update_record('course', $data);
2743     // make sure the modinfo cache is reset
2744     rebuild_course_cache($data->id);
2746     // update course format options with full course data
2747     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2749     $course = $DB->get_record('course', array('id'=>$data->id));
2751     if ($movecat) {
2752         $newparent = context_coursecat::instance($course->category);
2753         $context->update_moved($newparent);
2754     }
2755     $fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
2756     if ($fixcoursesortorder) {
2757         fix_course_sortorder();
2758     }
2760     // purge appropriate caches in case fix_course_sortorder() did not change anything
2761     cache_helper::purge_by_event('changesincourse');
2762     if ($changesincoursecat) {
2763         cache_helper::purge_by_event('changesincoursecat');
2764     }
2766     // Test for and remove blocks which aren't appropriate anymore
2767     blocks_remove_inappropriate($course);
2769     // Save any custom role names.
2770     save_local_role_names($course->id, $data);
2772     // update enrol settings
2773     enrol_course_updated(false, $course, $data);
2775     // Update course tags.
2776     if (isset($data->tags)) {
2777         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2778     }
2780     // Trigger a course updated event.
2781     $event = \core\event\course_updated::create(array(
2782         'objectid' => $course->id,
2783         'context' => context_course::instance($course->id),
2784         'other' => array('shortname' => $course->shortname,
2785                          'fullname' => $course->fullname)
2786     ));
2788     $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
2789     $event->trigger();
2791     if ($oldcourse->format !== $course->format) {
2792         // Remove all options stored for the previous format
2793         // We assume that new course format migrated everything it needed watching trigger
2794         // 'course_updated' and in method format_XXX::update_course_format_options()
2795         $DB->delete_records('course_format_options',
2796                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2797     }
2800 /**
2801  * Average number of participants
2802  * @return integer
2803  */
2804 function average_number_of_participants() {
2805     global $DB, $SITE;
2807     //count total of enrolments for visible course (except front page)
2808     $sql = 'SELECT COUNT(*) FROM (
2809         SELECT DISTINCT ue.userid, e.courseid
2810         FROM {user_enrolments} ue, {enrol} e, {course} c
2811         WHERE ue.enrolid = e.id
2812             AND e.courseid <> :siteid
2813             AND c.id = e.courseid
2814             AND c.visible = 1) total';
2815     $params = array('siteid' => $SITE->id);
2816     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2819     //count total of visible courses (minus front page)
2820     $coursetotal = $DB->count_records('course', array('visible' => 1));
2821     $coursetotal = $coursetotal - 1 ;
2823     //average of enrolment
2824     if (empty($coursetotal)) {
2825         $participantaverage = 0;
2826     } else {
2827         $participantaverage = $enrolmenttotal / $coursetotal;
2828     }
2830     return $participantaverage;
2833 /**
2834  * Average number of course modules
2835  * @return integer
2836  */
2837 function average_number_of_courses_modules() {
2838     global $DB, $SITE;
2840     //count total of visible course module (except front page)
2841     $sql = 'SELECT COUNT(*) FROM (
2842         SELECT cm.course, cm.module
2843         FROM {course} c, {course_modules} cm
2844         WHERE c.id = cm.course
2845             AND c.id <> :siteid
2846             AND cm.visible = 1
2847             AND c.visible = 1) total';
2848     $params = array('siteid' => $SITE->id);
2849     $moduletotal = $DB->count_records_sql($sql, $params);
2852     //count total of visible courses (minus front page)
2853     $coursetotal = $DB->count_records('course', array('visible' => 1));
2854     $coursetotal = $coursetotal - 1 ;
2856     //average of course module
2857     if (empty($coursetotal)) {
2858         $coursemoduleaverage = 0;
2859     } else {
2860         $coursemoduleaverage = $moduletotal / $coursetotal;
2861     }
2863     return $coursemoduleaverage;
2866 /**
2867  * This class pertains to course requests and contains methods associated with
2868  * create, approving, and removing course requests.
2869  *
2870  * Please note we do not allow embedded images here because there is no context
2871  * to store them with proper access control.
2872  *
2873  * @copyright 2009 Sam Hemelryk
2874  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2875  * @since Moodle 2.0
2876  *
2877  * @property-read int $id
2878  * @property-read string $fullname
2879  * @property-read string $shortname
2880  * @property-read string $summary
2881  * @property-read int $summaryformat
2882  * @property-read int $summarytrust
2883  * @property-read string $reason
2884  * @property-read int $requester
2885  */
2886 class course_request {
2888     /**
2889      * This is the stdClass that stores the properties for the course request
2890      * and is externally accessed through the __get magic method
2891      * @var stdClass
2892      */
2893     protected $properties;
2895     /**
2896      * An array of options for the summary editor used by course request forms.
2897      * This is initially set by {@link summary_editor_options()}
2898      * @var array
2899      * @static
2900      */
2901     protected static $summaryeditoroptions;
2903     /**
2904      * Static function to prepare the summary editor for working with a course
2905      * request.
2906      *
2907      * @static
2908      * @param null|stdClass $data Optional, an object containing the default values
2909      *                       for the form, these may be modified when preparing the
2910      *                       editor so this should be called before creating the form
2911      * @return stdClass An object that can be used to set the default values for
2912      *                   an mforms form
2913      */
2914     public static function prepare($data=null) {
2915         if ($data === null) {
2916             $data = new stdClass;
2917         }
2918         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2919         return $data;
2920     }
2922     /**
2923      * Static function to create a new course request when passed an array of properties
2924      * for it.
2925      *
2926      * This function also handles saving any files that may have been used in the editor
2927      *
2928      * @static
2929      * @param stdClass $data
2930      * @return course_request The newly created course request
2931      */
2932     public static function create($data) {
2933         global $USER, $DB, $CFG;
2934         $data->requester = $USER->id;
2936         // Setting the default category if none set.
2937         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2938             $data->category = $CFG->defaultrequestcategory;
2939         }
2941         // Summary is a required field so copy the text over
2942         $data->summary       = $data->summary_editor['text'];
2943         $data->summaryformat = $data->summary_editor['format'];
2945         $data->id = $DB->insert_record('course_request', $data);
2947         // Create a new course_request object and return it
2948         $request = new course_request($data);
2950         // Notify the admin if required.
2951         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2953             $a = new stdClass;
2954             $a->link = "$CFG->wwwroot/course/pending.php";
2955             $a->user = fullname($USER);
2956             $subject = get_string('courserequest');
2957             $message = get_string('courserequestnotifyemail', 'admin', $a);
2958             foreach ($users as $user) {
2959                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2960             }
2961         }
2963         return $request;
2964     }
2966     /**
2967      * Returns an array of options to use with a summary editor
2968      *
2969      * @uses course_request::$summaryeditoroptions
2970      * @return array An array of options to use with the editor
2971      */
2972     public static function summary_editor_options() {
2973         global $CFG;
2974         if (self::$summaryeditoroptions === null) {
2975             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2976         }
2977         return self::$summaryeditoroptions;
2978     }
2980     /**
2981      * Loads the properties for this course request object. Id is required and if
2982      * only id is provided then we load the rest of the properties from the database
2983      *
2984      * @param stdClass|int $properties Either an object containing properties
2985      *                      or the course_request id to load
2986      */
2987     public function __construct($properties) {
2988         global $DB;
2989         if (empty($properties->id)) {
2990             if (empty($properties)) {
2991                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2992             }
2993             $id = $properties;
2994             $properties = new stdClass;
2995             $properties->id = (int)$id;
2996             unset($id);
2997         }
2998         if (empty($properties->requester)) {
2999             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3000                 print_error('unknowncourserequest');
3001             }
3002         } else {
3003             $this->properties = $properties;
3004         }
3005         $this->properties->collision = null;
3006     }
3008     /**
3009      * Returns the requested property
3010      *
3011      * @param string $key
3012      * @return mixed
3013      */
3014     public function __get($key) {
3015         return $this->properties->$key;
3016     }
3018     /**
3019      * Override this to ensure empty($request->blah) calls return a reliable answer...
3020      *
3021      * This is required because we define the __get method
3022      *
3023      * @param mixed $key
3024      * @return bool True is it not empty, false otherwise
3025      */
3026     public function __isset($key) {
3027         return (!empty($this->properties->$key));
3028     }
3030     /**
3031      * Returns the user who requested this course
3032      *
3033      * Uses a static var to cache the results and cut down the number of db queries
3034      *
3035      * @staticvar array $requesters An array of cached users
3036      * @return stdClass The user who requested the course
3037      */
3038     public function get_requester() {
3039         global $DB;
3040         static $requesters= array();
3041         if (!array_key_exists($this->properties->requester, $requesters)) {
3042             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3043         }
3044         return $requesters[$this->properties->requester];
3045     }
3047     /**
3048      * Checks that the shortname used by the course does not conflict with any other
3049      * courses that exist
3050      *
3051      * @param string|null $shortnamemark The string to append to the requests shortname
3052      *                     should a conflict be found
3053      * @return bool true is there is a conflict, false otherwise
3054      */
3055     public function check_shortname_collision($shortnamemark = '[*]') {
3056         global $DB;
3058         if ($this->properties->collision !== null) {
3059             return $this->properties->collision;
3060         }
3062         if (empty($this->properties->shortname)) {
3063             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3064             $this->properties->collision = false;
3065         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3066             if (!empty($shortnamemark)) {
3067                 $this->properties->shortname .= ' '.$shortnamemark;
3068             }
3069             $this->properties->collision = true;
3070         } else {
3071             $this->properties->collision = false;
3072         }
3073         return $this->properties->collision;
3074     }
3076     /**
3077      * Returns the category where this course request should be created
3078      *
3079      * Note that we don't check here that user has a capability to view
3080      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
3081      * 'moodle/course:changecategory'
3082      *
3083      * @return coursecat
3084      */
3085     public function get_category() {
3086         global $CFG;
3087         require_once($CFG->libdir.'/coursecatlib.php');
3088         // If the category is not set, if the current user does not have the rights to change the category, or if the
3089         // category does not exist, we set the default category to the course to be approved.
3090         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3091         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
3092                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
3093             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
3094         }
3095         if (!$category) {
3096             $category = coursecat::get_default();
3097         }
3098         return $category;
3099     }
3101     /**
3102      * This function approves the request turning it into a course
3103      *
3104      * This function converts the course request into a course, at the same time
3105      * transferring any files used in the summary to the new course and then removing
3106      * the course request and the files associated with it.
3107      *
3108      * @return int The id of the course that was created from this request
3109      */
3110     public function approve() {
3111         global $CFG, $DB, $USER;
3113         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3115         $courseconfig = get_config('moodlecourse');
3117         // Transfer appropriate settings
3118         $data = clone($this->properties);
3119         unset($data->id);
3120         unset($data->reason);
3121         unset($data->requester);
3123         // Set category
3124         $category = $this->get_category();
3125         $data->category = $category->id;
3126         // Set misc settings
3127         $data->requested = 1;
3129         // Apply course default settings
3130         $data->format             = $courseconfig->format;
3131         $data->newsitems          = $courseconfig->newsitems;
3132         $data->showgrades         = $courseconfig->showgrades;
3133         $data->showreports        = $courseconfig->showreports;
3134         $data->maxbytes           = $courseconfig->maxbytes;
3135         $data->groupmode          = $courseconfig->groupmode;
3136         $data->groupmodeforce     = $courseconfig->groupmodeforce;
3137         $data->visible            = $courseconfig->visible;
3138         $data->visibleold         = $data->visible;
3139         $data->lang               = $courseconfig->lang;
3141         $course = create_course($data);
3142         $context = context_course::instance($course->id, MUST_EXIST);
3144         // add enrol instances
3145         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3146             if ($manual = enrol_get_plugin('manual')) {
3147                 $manual->add_default_instance($course);
3148             }
3149         }
3151         // enrol the requester as teacher if necessary
3152         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3153             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3154         }
3156         $this->delete();
3158         $a = new stdClass();
3159         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3160         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3161         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3163         return $course->id;
3164     }
3166     /**
3167      * Reject a course request
3168      *
3169      * This function rejects a course request, emailing the requesting user the
3170      * provided notice and then removing the request from the database
3171      *
3172      * @param string $notice The message to display to the user
3173      */
3174     public function reject($notice) {
3175         global $USER, $DB;
3176         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
3177         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3178         $this->delete();
3179     }
3181     /**
3182      * Deletes the course request and any associated files
3183      */
3184     public function delete() {
3185         global $DB;
3186         $DB->delete_records('course_request', array('id' => $this->properties->id));
3187     }
3189     /**
3190      * Send a message from one user to another using events_trigger
3191      *
3192      * @param object $touser
3193      * @param object $fromuser
3194      * @param string $name
3195      * @param string $subject
3196      * @param string $message
3197      */
3198     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
3199         $eventdata = new stdClass();
3200         $eventdata->component         = 'moodle';
3201         $eventdata->name              = $name;
3202         $eventdata->userfrom          = $fromuser;
3203         $eventdata->userto            = $touser;
3204         $eventdata->subject           = $subject;
3205         $eventdata->fullmessage       = $message;
3206         $eventdata->fullmessageformat = FORMAT_PLAIN;
3207         $eventdata->fullmessagehtml   = '';
3208         $eventdata->smallmessage      = '';
3209         $eventdata->notification      = 1;
3210         message_send($eventdata);
3211     }
3214 /**
3215  * Return a list of page types
3216  * @param string $pagetype current page type
3217  * @param context $parentcontext Block's parent context
3218  * @param context $currentcontext Current context of block
3219  * @return array array of page types
3220  */
3221 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3222     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
3223         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3224         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3225             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3226         );
3227     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
3228         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3229         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3230     } else {
3231         // Otherwise consider it a page inside a course even if $currentcontext is null
3232         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3233             'course-*' => get_string('page-course-x', 'pagetype'),
3234             'course-view-*' => get_string('page-course-view-x', 'pagetype')
3235         );
3236     }
3237     return $pagetypes;
3240 /**
3241  * Determine whether course ajax should be enabled for the specified course
3242  *
3243  * @param stdClass $course The course to test against
3244  * @return boolean Whether course ajax is enabled or note
3245  */
3246 function course_ajax_enabled($course) {
3247     global $CFG, $PAGE, $SITE;
3249     // The user must be editing for AJAX to be included
3250     if (!$PAGE->user_is_editing()) {
3251         return false;
3252     }
3254     // Check that the theme suports
3255     if (!$PAGE->theme->enablecourseajax) {
3256         return false;
3257     }
3259     // Check that the course format supports ajax functionality
3260     // The site 'format' doesn't have information on course format support
3261     if ($SITE->id !== $course->id) {
3262         $courseformatajaxsupport = course_format_ajax_support($course->format);
3263         if (!$courseformatajaxsupport->capable) {
3264             return false;
3265         }
3266     }
3268     // All conditions have been met so course ajax should be enabled
3269     return true;
3272 /**
3273  * Include the relevant javascript and language strings for the resource
3274  * toolbox YUI module
3275  *
3276  * @param integer $id The ID of the course being applied to
3277  * @param array $usedmodules An array containing the names of the modules in use on the page
3278  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3279  * @param stdClass $config An object containing configuration parameters for ajax modules including:
3280  *          * resourceurl   The URL to post changes to for resource changes
3281  *          * sectionurl    The URL to post changes to for section changes
3282  *          * pageparams    Additional parameters to pass through in the post
3283  * @return bool
3284  */
3285 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3286     global $CFG, $PAGE, $SITE;
3288     // Ensure that ajax should be included
3289     if (!course_ajax_enabled($course)) {
3290         return false;
3291     }
3293     if (!$config) {
3294         $config = new stdClass();
3295     }
3297     // The URL to use for resource changes
3298     if (!isset($config->resourceurl)) {
3299         $config->resourceurl = '/course/rest.php';
3300     }
3302     // The URL to use for section changes
3303     if (!isset($config->sectionurl)) {
3304         $config->sectionurl = '/course/rest.php';
3305     }
3307     // Any additional parameters which need to be included on page submission
3308     if (!isset($config->pageparams)) {
3309         $config->pageparams = array();
3310     }
3312     // Include toolboxes
3313     $PAGE->requires->yui_module('moodle-course-toolboxes',
3314             'M.course.init_resource_toolbox',
3315             array(array(
3316                 'courseid' => $course->id,
3317                 'ajaxurl' => $config->resourceurl,
3318                 'config' => $config,
3319             ))
3320     );
3321     $PAGE->requires->yui_module('moodle-course-toolboxes',
3322             'M.course.init_section_toolbox',
3323             array(array(
3324                 'courseid' => $course->id,
3325                 'format' => $course->format,
3326                 'ajaxurl' => $config->sectionurl,
3327                 'config' => $config,
3328             ))
3329     );
3331     // Include course dragdrop
3332     if (course_format_uses_sections($course->format)) {
3333         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3334             array(array(
3335                 'courseid' => $course->id,
3336                 'ajaxurl' => $config->sectionurl,
3337                 'config' => $config,
3338             )), null, true);
3340         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3341             array(array(
3342                 'courseid' => $course->id,
3343                 'ajaxurl' => $config->resourceurl,
3344                 'config' => $config,
3345             )), null, true);
3346     }
3348     // Require various strings for the command toolbox
3349     $PAGE->requires->strings_for_js(array(
3350             'moveleft',
3351             'deletechecktype',
3352             'deletechecktypename',
3353             'edittitle',
3354             'edittitleinstructions',
3355             'show',
3356             'hide',
3357             'highlight',
3358             'highlightoff',
3359             'groupsnone',
3360             'groupsvisible',
3361             'groupsseparate',
3362             'clicktochangeinbrackets',
3363             'markthistopic',
3364             'markedthistopic',
3365             'movesection',
3366             'movecoursemodule',
3367             'movecoursesection',
3368             'movecontent',
3369             'tocontent',
3370             'emptydragdropregion',
3371             'afterresource',
3372             'aftersection',
3373             'totopofsection',
3374         ), 'moodle');
3376     // Include section-specific strings for formats which support sections.
3377     if (course_format_uses_sections($course->format)) {
3378         $PAGE->requires->strings_for_js(array(
3379                 'showfromothers',
3380                 'hidefromothers',
3381             ), 'format_' . $course->format);
3382     }
3384     // For confirming resource deletion we need the name of the module in question
3385     foreach ($usedmodules as $module => $modname) {
3386         $PAGE->requires->string_for_js('pluginname', $module);
3387     }
3389     // Load drag and drop upload AJAX.
3390     require_once($CFG->dirroot.'/course/dnduploadlib.php');
3391     dndupload_add_to_course($course, $enabledmodules);
3393     return true;
3396 /**
3397  * Returns the sorted list of available course formats, filtered by enabled if necessary
3398  *
3399  * @param bool $enabledonly return only formats that are enabled
3400  * @return array array of sorted format names
3401  */
3402 function get_sorted_course_formats($enabledonly = false) {
3403     global $CFG;
3404     $formats = core_component::get_plugin_list('format');
3406     if (!empty($CFG->format_plugins_sortorder)) {
3407         $order = explode(',', $CFG->format_plugins_sortorder);
3408         $order = array_merge(array_intersect($order, array_keys($formats)),
3409                     array_diff(array_keys($formats), $order));
3410     } else {
3411         $order = array_keys($formats);
3412     }
3413     if (!$enabledonly) {
3414         return $order;
3415     }
3416     $sortedformats = array();
3417     foreach ($order as $formatname) {
3418         if (!get_config('format_'.$formatname, 'disabled')) {
3419             $sortedformats[] = $formatname;
3420         }
3421     }
3422     return $sortedformats;
3425 /**
3426  * The URL to use for the specified course (with section)
3427  *
3428  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3429  * @param int|stdClass $section Section object from database or just field course_sections.section
3430  *     if omitted the course view page is returned
3431  * @param array $options options for view URL. At the moment core uses:
3432  *     'navigation' (bool) if true and section has no separate page, the function returns null
3433  *     'sr' (int) used by multipage formats to specify to which section to return
3434  * @return moodle_url The url of course
3435  */
3436 function course_get_url($courseorid, $section = null, $options = array()) {
3437     return course_get_format($courseorid)->get_view_url($section, $options);
3440 /**
3441  * Create a module.
3442  *
3443  * It includes:
3444  *      - capability checks and other checks
3445  *      - create the module from the module info
3446  *
3447  * @param object $module
3448  * @return object the created module info
3449  * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3450  */
3451 function create_module($moduleinfo) {
3452     global $DB, $CFG;
3454     require_once($CFG->dirroot . '/course/modlib.php');
3456     // Check manadatory attributs.
3457     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3458     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3459         $mandatoryfields[] = 'introeditor';
3460     }
3461     foreach($mandatoryfields as $mandatoryfield) {
3462         if (!isset($moduleinfo->{$mandatoryfield})) {
3463             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3464         }
3465     }
3467     // Some additional checks (capability / existing instances).
3468     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3469     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3471     // Add the module.
3472     $moduleinfo->module = $module->id;
3473     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3475     return $moduleinfo;
3478 /**
3479  * Update a module.
3480  *
3481  * It includes:
3482  *      - capability and other checks
3483  *      - update the module
3484  *
3485  * @param object $module
3486  * @return object the updated module info
3487  * @throws moodle_exception if current user is not allowed to update the module
3488  */
3489 function update_module($moduleinfo) {
3490     global $DB, $CFG;
3492     require_once($CFG->dirroot . '/course/modlib.php');
3494     // Check the course module exists.
3495     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3497     // Check the course exists.
3498     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3500     // Some checks (capaibility / existing instances).
3501     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3503     // Retrieve few information needed by update_moduleinfo.
3504     $moduleinfo->modulename = $cm->modname;
3505     if (!isset($moduleinfo->scale)) {
3506         $moduleinfo->scale = 0;
3507     }
3508     $moduleinfo->type = 'mod';
3510     // Update the module.
3511     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3513     return $moduleinfo;
3516 /**
3517  * Duplicate a module on the course for ajax.
3518  *
3519  * @see mod_duplicate_module()
3520  * @param object $course The course
3521  * @param object $cm The course module to duplicate
3522  * @param int $sr The section to link back to (used for creating the links)
3523  * @throws moodle_exception if the plugin doesn't support duplication
3524  * @return Object containing:
3525  * - fullcontent: The HTML markup for the created CM
3526  * - cmid: The CMID of the newly created CM
3527  * - redirect: Whether to trigger a redirect following this change
3528  */
3529 function mod_duplicate_activity($course, $cm, $sr = null) {
3530     global $PAGE;
3532     $newcm = duplicate_module($course, $cm);
3534     $resp = new stdClass();
3535     if ($newcm) {
3536         $courserenderer = $PAGE->get_renderer('core', 'course');
3537         $completioninfo = new completion_info($course);
3538         $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3539                 $newcm, null, array());
3541         $resp->fullcontent = $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3542         $resp->cmid = $newcm->id;
3543     } else {
3544         // Trigger a redirect.
3545         $resp->redirect = true;
3546     }
3547     return $resp;
3550 /**
3551  * Api to duplicate a module.
3552  *
3553  * @param object $course course object.
3554  * @param object $cm course module object to be duplicated.
3555  * @since Moodle 2.8
3556  *
3557  * @throws Exception
3558  * @throws coding_exception
3559  * @throws moodle_exception
3560  * @throws restore_controller_exception
3561  *
3562  * @return cm_info|null cminfo object if we sucessfully duplicated the mod and found the new cm.
3563  */
3564 function duplicate_module($course, $cm) {
3565     global $CFG, $DB, $USER;
3566     require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
3567     require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');
3568     require_once($CFG->libdir . '/filelib.php');
3570     $a          = new stdClass();
3571     $a->modtype = get_string('modulename', $cm->modname);
3572     $a->modname = format_string($cm->name);
3574     if (!plugin_supports('mod', $cm->modname, FEATURE_BACKUP_MOODLE2)) {
3575         throw new moodle_exception('duplicatenosupport', 'error', '', $a);
3576     }
3578     // Backup the activity.
3580     $bc = new backup_controller(backup::TYPE_1ACTIVITY, $cm->id, backup::FORMAT_MOODLE,
3581             backup::INTERACTIVE_NO, backup::MODE_IMPORT, $USER->id);
3583     $backupid       = $bc->get_backupid();
3584     $backupbasepath = $bc->get_plan()->get_basepath();
3586     $bc->execute_plan();
3588