MDL-52252 Tags: Add tags to modules (Resources and Activities)
[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         course_update_section($courseid, $section, array('visible' => $visibility));
1203         // Determine which modules are visible for AJAX update
1204         $modules = !empty($section->sequence) ? explode(',', $section->sequence) : array();
1205         if (!empty($modules)) {
1206             list($insql, $params) = $DB->get_in_or_equal($modules);
1207             $select = 'id ' . $insql . ' AND visible = ?';
1208             array_push($params, $visibility);
1209             if (!$visibility) {
1210                 $select .= ' AND visibleold = 1';
1211             }
1212             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1213         }
1214     }
1215     return $resourcestotoggle;
1218 /**
1219  * Retrieve all metadata for the requested modules
1220  *
1221  * @param object $course The Course
1222  * @param array $modnames An array containing the list of modules and their
1223  * names
1224  * @param int $sectionreturn The section to return to
1225  * @return array A list of stdClass objects containing metadata about each
1226  * module
1227  */
1228 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1229     global $CFG, $OUTPUT;
1231     // get_module_metadata will be called once per section on the page and courses may show
1232     // different modules to one another
1233     static $modlist = array();
1234     if (!isset($modlist[$course->id])) {
1235         $modlist[$course->id] = array();
1236     }
1238     $return = array();
1239     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1240     if ($sectionreturn !== null) {
1241         $urlbase->param('sr', $sectionreturn);
1242     }
1243     foreach($modnames as $modname => $modnamestr) {
1244         if (!course_allowed_module($course, $modname)) {
1245             continue;
1246         }
1247         if (isset($modlist[$course->id][$modname])) {
1248             // This module is already cached
1249             $return[$modname] = $modlist[$course->id][$modname];
1250             continue;
1251         }
1253         // Include the module lib
1254         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1255         if (!file_exists($libfile)) {
1256             continue;
1257         }
1258         include_once($libfile);
1260         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1261         $gettypesfunc =  $modname.'_get_types';
1262         $types = MOD_SUBTYPE_NO_CHILDREN;
1263         if (function_exists($gettypesfunc)) {
1264             $types = $gettypesfunc();
1265         }
1266         if ($types !== MOD_SUBTYPE_NO_CHILDREN) {
1267             if (is_array($types) && count($types) > 0) {
1268                 $group = new stdClass();
1269                 $group->name = $modname;
1270                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1271                 foreach($types as $type) {
1272                     if ($type->typestr === '--') {
1273                         continue;
1274                     }
1275                     if (strpos($type->typestr, '--') === 0) {
1276                         $group->title = str_replace('--', '', $type->typestr);
1277                         continue;
1278                     }
1279                     // Set the Sub Type metadata
1280                     $subtype = new stdClass();
1281                     $subtype->title = $type->typestr;
1282                     $subtype->type = str_replace('&amp;', '&', $type->type);
1283                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1284                     $subtype->archetype = $type->modclass;
1286                     // The group archetype should match the subtype archetypes and all subtypes
1287                     // should have the same archetype
1288                     $group->archetype = $subtype->archetype;
1290                     if (!empty($type->help)) {
1291                         $subtype->help = $type->help;
1292                     } else if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1293                         $subtype->help = get_string('help' . $subtype->name, $modname);
1294                     }
1295                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1296                     $group->types[] = $subtype;
1297                 }
1298                 $modlist[$course->id][$modname] = $group;
1299             }
1300         } else {
1301             $module = new stdClass();
1302             $module->title = $modnamestr;
1303             $module->name = $modname;
1304             $module->link = new moodle_url($urlbase, array('add' => $modname));
1305             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1306             $sm = get_string_manager();
1307             if ($sm->string_exists('modulename_help', $modname)) {
1308                 $module->help = get_string('modulename_help', $modname);
1309                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1310                     $link = get_string('modulename_link', $modname);
1311                     $linktext = get_string('morehelp');
1312                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1313                 }
1314             }
1315             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1316             $modlist[$course->id][$modname] = $module;
1317         }
1318         if (isset($modlist[$course->id][$modname])) {
1319             $return[$modname] = $modlist[$course->id][$modname];
1320         } else {
1321             debugging("Invalid module metadata configuration for {$modname}");
1322         }
1323     }
1325     return $return;
1328 /**
1329  * Return the course category context for the category with id $categoryid, except
1330  * that if $categoryid is 0, return the system context.
1331  *
1332  * @param integer $categoryid a category id or 0.
1333  * @return context the corresponding context
1334  */
1335 function get_category_or_system_context($categoryid) {
1336     if ($categoryid) {
1337         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1338     } else {
1339         return context_system::instance();
1340     }
1343 /**
1344  * Returns full course categories trees to be used in html_writer::select()
1345  *
1346  * Calls {@link coursecat::make_categories_list()} to build the tree and
1347  * adds whitespace to denote nesting
1348  *
1349  * @return array array mapping coursecat id to the display name
1350  */
1351 function make_categories_options() {
1352     global $CFG;
1353     require_once($CFG->libdir. '/coursecatlib.php');
1354     $cats = coursecat::make_categories_list('', 0, ' / ');
1355     foreach ($cats as $key => $value) {
1356         // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1357         $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
1358     }
1359     return $cats;
1362 /**
1363  * Print the buttons relating to course requests.
1364  *
1365  * @param object $context current page context.
1366  */
1367 function print_course_request_buttons($context) {
1368     global $CFG, $DB, $OUTPUT;
1369     if (empty($CFG->enablecourserequests)) {
1370         return;
1371     }
1372     if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
1373     /// Print a button to request a new course
1374         echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
1375     }
1376     /// Print a button to manage pending requests
1377     if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
1378         $disabled = !$DB->record_exists('course_request', array());
1379         echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
1380     }
1383 /**
1384  * Does the user have permission to edit things in this category?
1385  *
1386  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1387  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1388  */
1389 function can_edit_in_category($categoryid = 0) {
1390     $context = get_category_or_system_context($categoryid);
1391     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1394 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1396 function add_course_module($mod) {
1397     global $DB;
1399     $mod->added = time();
1400     unset($mod->id);
1402     $cmid = $DB->insert_record("course_modules", $mod);
1403     rebuild_course_cache($mod->course, true);
1404     return $cmid;
1407 /**
1408  * Creates missing course section(s) and rebuilds course cache
1409  *
1410  * @param int|stdClass $courseorid course id or course object
1411  * @param int|array $sections list of relative section numbers to create
1412  * @return bool if there were any sections created
1413  */
1414 function course_create_sections_if_missing($courseorid, $sections) {
1415     global $DB;
1416     if (!is_array($sections)) {
1417         $sections = array($sections);
1418     }
1419     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1420     if (is_object($courseorid)) {
1421         $courseorid = $courseorid->id;
1422     }
1423     $coursechanged = false;
1424     foreach ($sections as $sectionnum) {
1425         if (!in_array($sectionnum, $existing)) {
1426             $cw = new stdClass();
1427             $cw->course   = $courseorid;
1428             $cw->section  = $sectionnum;
1429             $cw->summary  = '';
1430             $cw->summaryformat = FORMAT_HTML;
1431             $cw->sequence = '';
1432             $id = $DB->insert_record("course_sections", $cw);
1433             $coursechanged = true;
1434         }
1435     }
1436     if ($coursechanged) {
1437         rebuild_course_cache($courseorid, true);
1438     }
1439     return $coursechanged;
1442 /**
1443  * Adds an existing module to the section
1444  *
1445  * Updates both tables {course_sections} and {course_modules}
1446  *
1447  * Note: This function does not use modinfo PROVIDED that the section you are
1448  * adding the module to already exists. If the section does not exist, it will
1449  * build modinfo if necessary and create the section.
1450  *
1451  * @param int|stdClass $courseorid course id or course object
1452  * @param int $cmid id of the module already existing in course_modules table
1453  * @param int $sectionnum relative number of the section (field course_sections.section)
1454  *     If section does not exist it will be created
1455  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1456  *     before which the module needs to be included. Null for inserting in the
1457  *     end of the section
1458  * @return int The course_sections ID where the module is inserted
1459  */
1460 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1461     global $DB, $COURSE;
1462     if (is_object($beforemod)) {
1463         $beforemod = $beforemod->id;
1464     }
1465     if (is_object($courseorid)) {
1466         $courseid = $courseorid->id;
1467     } else {
1468         $courseid = $courseorid;
1469     }
1470     // Do not try to use modinfo here, there is no guarantee it is valid!
1471     $section = $DB->get_record('course_sections',
1472             array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
1473     if (!$section) {
1474         // This function call requires modinfo.
1475         course_create_sections_if_missing($courseorid, $sectionnum);
1476         $section = $DB->get_record('course_sections',
1477                 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
1478     }
1480     $modarray = explode(",", trim($section->sequence));
1481     if (empty($section->sequence)) {
1482         $newsequence = "$cmid";
1483     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1484         $insertarray = array($cmid, $beforemod);
1485         array_splice($modarray, $key[0], 1, $insertarray);
1486         $newsequence = implode(",", $modarray);
1487     } else {
1488         $newsequence = "$section->sequence,$cmid";
1489     }
1490     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
1491     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
1492     if (is_object($courseorid)) {
1493         rebuild_course_cache($courseorid->id, true);
1494     } else {
1495         rebuild_course_cache($courseorid, true);
1496     }
1497     return $section->id;     // Return course_sections ID that was used.
1500 /**
1501  * Change the group mode of a course module.
1502  *
1503  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1504  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1505  *
1506  * @param int $id course module ID.
1507  * @param int $groupmode the new groupmode value.
1508  * @return bool True if the $groupmode was updated.
1509  */
1510 function set_coursemodule_groupmode($id, $groupmode) {
1511     global $DB;
1512     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1513     if ($cm->groupmode != $groupmode) {
1514         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1515         rebuild_course_cache($cm->course, true);
1516     }
1517     return ($cm->groupmode != $groupmode);
1520 function set_coursemodule_idnumber($id, $idnumber) {
1521     global $DB;
1522     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1523     if ($cm->idnumber != $idnumber) {
1524         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1525         rebuild_course_cache($cm->course, true);
1526     }
1527     return ($cm->idnumber != $idnumber);
1530 /**
1531  * Set the visibility of a module and inherent properties.
1532  *
1533  * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1534  * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1535  *
1536  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1537  * has been moved to {@link set_section_visible()} which was the only place from which
1538  * the parameter was used.
1539  *
1540  * @param int $id of the module
1541  * @param int $visible state of the module
1542  * @return bool false when the module was not found, true otherwise
1543  */
1544 function set_coursemodule_visible($id, $visible) {
1545     global $DB, $CFG;
1546     require_once($CFG->libdir.'/gradelib.php');
1547     require_once($CFG->dirroot.'/calendar/lib.php');
1549     // Trigger developer's attention when using the previously removed argument.
1550     if (func_num_args() > 2) {
1551         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1552             has been removed.', DEBUG_DEVELOPER);
1553     }
1555     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1556         return false;
1557     }
1559     // Create events and propagate visibility to associated grade items if the value has changed.
1560     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1561     if ($cm->visible == $visible) {
1562         return true;
1563     }
1565     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
1566         return false;
1567     }
1568     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
1569         foreach($events as $event) {
1570             if ($visible) {
1571                 $event = new calendar_event($event);
1572                 $event->toggle_visibility(true);
1573             } else {
1574                 $event = new calendar_event($event);
1575                 $event->toggle_visibility(false);
1576             }
1577         }
1578     }
1580     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1581     // affect visibleold to allow for an original visibility restore. See set_section_visible().
1582     $cminfo = new stdClass();
1583     $cminfo->id = $id;
1584     $cminfo->visible = $visible;
1585     $cminfo->visibleold = $visible;
1586     $DB->update_record('course_modules', $cminfo);
1588     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1589     // Note that this must be done after updating the row in course_modules, in case
1590     // the modules grade_item_update function needs to access $cm->visible.
1591     if (plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY) &&
1592             component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1593         $instance = $DB->get_record($modulename, array('id' => $cm->instance), '*', MUST_EXIST);
1594         component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1595     } else {
1596         $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1597         if ($grade_items) {
1598             foreach ($grade_items as $grade_item) {
1599                 $grade_item->set_hidden(!$visible);
1600             }
1601         }
1602     }
1604     rebuild_course_cache($cm->course, true);
1605     return true;
1608 /**
1609  * This function will handle the whole deletion process of a module. This includes calling
1610  * the modules delete_instance function, deleting files, events, grades, conditional data,
1611  * the data in the course_module and course_sections table and adding a module deletion
1612  * event to the DB.
1613  *
1614  * @param int $cmid the course module id
1615  * @since Moodle 2.5
1616  */
1617 function course_delete_module($cmid) {
1618     global $CFG, $DB;
1620     require_once($CFG->libdir.'/gradelib.php');
1621     require_once($CFG->libdir.'/questionlib.php');
1622     require_once($CFG->dirroot.'/blog/lib.php');
1623     require_once($CFG->dirroot.'/calendar/lib.php');
1625     // Get the course module.
1626     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1627         return true;
1628     }
1630     // Get the module context.
1631     $modcontext = context_module::instance($cm->id);
1633     // Get the course module name.
1634     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1636     // Get the file location of the delete_instance function for this module.
1637     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1639     // Include the file required to call the delete_instance function for this module.
1640     if (file_exists($modlib)) {
1641         require_once($modlib);
1642     } else {
1643         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1644             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1645     }
1647     $deleteinstancefunction = $modulename . '_delete_instance';
1649     // Ensure the delete_instance function exists for this module.
1650     if (!function_exists($deleteinstancefunction)) {
1651         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1652             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1653     }
1655     // Delete activity context questions and question categories.
1656     question_delete_activity($cm);
1658     // Call the delete_instance function, if it returns false throw an exception.
1659     if (!$deleteinstancefunction($cm->instance)) {
1660         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1661             "Cannot delete the module $modulename (instance).");
1662     }
1664     // Remove all module files in case modules forget to do that.
1665     $fs = get_file_storage();
1666     $fs->delete_area_files($modcontext->id);
1668     // Delete events from calendar.
1669     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1670         foreach($events as $event) {
1671             $calendarevent = calendar_event::load($event->id);
1672             $calendarevent->delete();
1673         }
1674     }
1676     // Delete grade items, outcome items and grades attached to modules.
1677     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1678                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1679         foreach ($grade_items as $grade_item) {
1680             $grade_item->delete('moddelete');
1681         }
1682     }
1684     // Delete completion and availability data; it is better to do this even if the
1685     // features are not turned on, in case they were turned on previously (these will be
1686     // very quick on an empty table).
1687     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1688     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1689                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1691     // Delete all tag instances associated with the instance of this module.
1692     core_tag_tag::delete_instances('mod_' . $modulename, null, $modcontext->id);
1693     core_tag_tag::remove_all_item_tags('core', 'course_modules', $cm->id);
1695     // Delete the context.
1696     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1698     // Delete the module from the course_modules table.
1699     $DB->delete_records('course_modules', array('id' => $cm->id));
1701     // Delete module from that section.
1702     if (!delete_mod_from_section($cm->id, $cm->section)) {
1703         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1704             "Cannot delete the module $modulename (instance) from section.");
1705     }
1707     // Trigger event for course module delete action.
1708     $event = \core\event\course_module_deleted::create(array(
1709         'courseid' => $cm->course,
1710         'context'  => $modcontext,
1711         'objectid' => $cm->id,
1712         'other'    => array(
1713             'modulename' => $modulename,
1714             'instanceid'   => $cm->instance,
1715         )
1716     ));
1717     $event->add_record_snapshot('course_modules', $cm);
1718     $event->trigger();
1719     rebuild_course_cache($cm->course, true);
1722 function delete_mod_from_section($modid, $sectionid) {
1723     global $DB;
1725     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1727         $modarray = explode(",", $section->sequence);
1729         if ($key = array_keys ($modarray, $modid)) {
1730             array_splice($modarray, $key[0], 1);
1731             $newsequence = implode(",", $modarray);
1732             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1733             rebuild_course_cache($section->course, true);
1734             return true;
1735         } else {
1736             return false;
1737         }
1739     }
1740     return false;
1743 /**
1744  * Moves a section within a course, from a position to another.
1745  * Be very careful: $section and $destination refer to section number,
1746  * not id!.
1747  *
1748  * @param object $course
1749  * @param int $section Section number (not id!!!)
1750  * @param int $destination
1751  * @param bool $ignorenumsections
1752  * @return boolean Result
1753  */
1754 function move_section_to($course, $section, $destination, $ignorenumsections = false) {
1755 /// Moves a whole course section up and down within the course
1756     global $USER, $DB;
1758     if (!$destination && $destination != 0) {
1759         return true;
1760     }
1762     // compartibility with course formats using field 'numsections'
1763     $courseformatoptions = course_get_format($course)->get_format_options();
1764     if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
1765             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1766         return false;
1767     }
1769     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1770     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1771             'section ASC, id ASC', 'id, section')) {
1772         return false;
1773     }
1775     $movedsections = reorder_sections($sections, $section, $destination);
1777     // Update all sections. Do this in 2 steps to avoid breaking database
1778     // uniqueness constraint
1779     $transaction = $DB->start_delegated_transaction();
1780     foreach ($movedsections as $id => $position) {
1781         if ($sections[$id] !== $position) {
1782             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1783         }
1784     }
1785     foreach ($movedsections as $id => $position) {
1786         if ($sections[$id] !== $position) {
1787             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1788         }
1789     }
1791     // If we move the highlighted section itself, then just highlight the destination.
1792     // Adjust the higlighted section location if we move something over it either direction.
1793     if ($section == $course->marker) {
1794         course_set_marker($course->id, $destination);
1795     } elseif ($section > $course->marker && $course->marker >= $destination) {
1796         course_set_marker($course->id, $course->marker+1);
1797     } elseif ($section < $course->marker && $course->marker <= $destination) {
1798         course_set_marker($course->id, $course->marker-1);
1799     }
1801     $transaction->allow_commit();
1802     rebuild_course_cache($course->id, true);
1803     return true;
1806 /**
1807  * This method will delete a course section and may delete all modules inside it.
1808  *
1809  * No permissions are checked here, use {@link course_can_delete_section()} to
1810  * check if section can actually be deleted.
1811  *
1812  * @param int|stdClass $course
1813  * @param int|stdClass|section_info $section
1814  * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1815  * @return bool whether section was deleted
1816  */
1817 function course_delete_section($course, $section, $forcedeleteifnotempty = true) {
1818     global $DB;
1820     // Prepare variables.
1821     $courseid = (is_object($course)) ? $course->id : (int)$course;
1822     $sectionnum = (is_object($section)) ? $section->section : (int)$section;
1823     $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1824     if (!$section) {
1825         // No section exists, can't proceed.
1826         return false;
1827     }
1828     $format = course_get_format($course);
1829     $sectionname = $format->get_section_name($section);
1831     // Delete section.
1832     $result = $format->delete_section($section, $forcedeleteifnotempty);
1834     // Trigger an event for course section deletion.
1835     if ($result) {
1836         $context = context_course::instance($courseid);
1837         $event = \core\event\course_section_deleted::create(
1838                 array(
1839                     'objectid' => $section->id,
1840                     'courseid' => $courseid,
1841                     'context' => $context,
1842                     'other' => array(
1843                         'sectionnum' => $section->section,
1844                         'sectionname' => $sectionname,
1845                     )
1846                 )
1847             );
1848         $event->add_record_snapshot('course_sections', $section);
1849         $event->trigger();
1850     }
1851     return $result;
1854 /**
1855  * Updates the course section
1856  *
1857  * This function does not check permissions or clean values - this has to be done prior to calling it.
1858  *
1859  * @param int|stdClass $course
1860  * @param stdClass $section record from course_sections table - it will be updated with the new values
1861  * @param array|stdClass $data
1862  */
1863 function course_update_section($course, $section, $data) {
1864     global $DB;
1866     $courseid = (is_object($course)) ? $course->id : (int)$course;
1868     // Some fields can not be updated using this method.
1869     $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1870     $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible);
1871     if (array_key_exists('name', $data) && \core_text::strlen($data['name']) > 255) {
1872         throw new moodle_exception('maximumchars', 'moodle', '', 255);
1873     }
1875     // Update record in the DB and course format options.
1876     $data['id'] = $section->id;
1877     $DB->update_record('course_sections', $data);
1878     rebuild_course_cache($courseid, true);
1879     course_get_format($courseid)->update_section_format_options($data);
1881     // Update fields of the $section object.
1882     foreach ($data as $key => $value) {
1883         if (property_exists($section, $key)) {
1884             $section->$key = $value;
1885         }
1886     }
1888     // Trigger an event for course section update.
1889     $event = \core\event\course_section_updated::create(
1890         array(
1891             'objectid' => $section->id,
1892             'courseid' => $courseid,
1893             'context' => context_course::instance($courseid),
1894             'other' => array('sectionnum' => $section->section)
1895         )
1896     );
1897     $event->trigger();
1899     // If section visibility was changed, hide the modules in this section too.
1900     if ($changevisibility && !empty($section->sequence)) {
1901         $modules = explode(',', $section->sequence);
1902         foreach ($modules as $moduleid) {
1903             if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1904                 if ($data['visible']) {
1905                     // As we unhide the section, we use the previously saved visibility stored in visibleold.
1906                     set_coursemodule_visible($moduleid, $cm->visibleold);
1907                 } else {
1908                     // We hide the section, so we hide the module but we store the original state in visibleold.
1909                     set_coursemodule_visible($moduleid, 0);
1910                     $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1911                 }
1912                 \core\event\course_module_updated::create_from_cm($cm)->trigger();
1913             }
1914         }
1915     }
1918 /**
1919  * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1920  *
1921  * @param int|stdClass $course
1922  * @param int|stdClass|section_info $section
1923  * @return bool
1924  */
1925 function course_can_delete_section($course, $section) {
1926     if (is_object($section)) {
1927         $section = $section->section;
1928     }
1929     if (!$section) {
1930         // Not possible to delete 0-section.
1931         return false;
1932     }
1933     // Course format should allow to delete sections.
1934     if (!course_get_format($course)->can_delete_section($section)) {
1935         return false;
1936     }
1937     // Make sure user has capability to update course and move sections.
1938     $context = context_course::instance(is_object($course) ? $course->id : $course);
1939     if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1940         return false;
1941     }
1942     // Make sure user has capability to delete each activity in this section.
1943     $modinfo = get_fast_modinfo($course);
1944     if (!empty($modinfo->sections[$section])) {
1945         foreach ($modinfo->sections[$section] as $cmid) {
1946             if (!has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1947                 return false;
1948             }
1949         }
1950     }
1951     return true;
1954 /**
1955  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1956  * an original position number and a target position number, rebuilds the array so that the
1957  * move is made without any duplication of section positions.
1958  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1959  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1960  *
1961  * @param array $sections
1962  * @param int $origin_position
1963  * @param int $target_position
1964  * @return array
1965  */
1966 function reorder_sections($sections, $origin_position, $target_position) {
1967     if (!is_array($sections)) {
1968         return false;
1969     }
1971     // We can't move section position 0
1972     if ($origin_position < 1) {
1973         echo "We can't move section position 0";
1974         return false;
1975     }
1977     // Locate origin section in sections array
1978     if (!$origin_key = array_search($origin_position, $sections)) {
1979         echo "searched position not in sections array";
1980         return false; // searched position not in sections array
1981     }
1983     // Extract origin section
1984     $origin_section = $sections[$origin_key];
1985     unset($sections[$origin_key]);
1987     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1988     $found = false;
1989     $append_array = array();
1990     foreach ($sections as $id => $position) {
1991         if ($found) {
1992             $append_array[$id] = $position;
1993             unset($sections[$id]);
1994         }
1995         if ($position == $target_position) {
1996             if ($target_position < $origin_position) {
1997                 $append_array[$id] = $position;
1998                 unset($sections[$id]);
1999             }
2000             $found = true;
2001         }
2002     }
2004     // Append moved section
2005     $sections[$origin_key] = $origin_section;
2007     // Append rest of array (if applicable)
2008     if (!empty($append_array)) {
2009         foreach ($append_array as $id => $position) {
2010             $sections[$id] = $position;
2011         }
2012     }
2014     // Renumber positions
2015     $position = 0;
2016     foreach ($sections as $id => $p) {
2017         $sections[$id] = $position;
2018         $position++;
2019     }
2021     return $sections;
2025 /**
2026  * Move the module object $mod to the specified $section
2027  * If $beforemod exists then that is the module
2028  * before which $modid should be inserted
2029  *
2030  * @param stdClass|cm_info $mod
2031  * @param stdClass|section_info $section
2032  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2033  *     before which the module needs to be included. Null for inserting in the
2034  *     end of the section
2035  * @return int new value for module visibility (0 or 1)
2036  */
2037 function moveto_module($mod, $section, $beforemod=NULL) {
2038     global $OUTPUT, $DB;
2040     // Current module visibility state - return value of this function.
2041     $modvisible = $mod->visible;
2043     // Remove original module from original section.
2044     if (! delete_mod_from_section($mod->id, $mod->section)) {
2045         echo $OUTPUT->notification("Could not delete module from existing section");
2046     }
2048     // If moving to a hidden section then hide module.
2049     if ($mod->section != $section->id) {
2050         if (!$section->visible && $mod->visible) {
2051             // Module was visible but must become hidden after moving to hidden section.
2052             $modvisible = 0;
2053             set_coursemodule_visible($mod->id, 0);
2054             // Set visibleold to 1 so module will be visible when section is made visible.
2055             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
2056         }
2057         if ($section->visible && !$mod->visible) {
2058             // Hidden module was moved to the visible section, restore the module visibility from visibleold.
2059             set_coursemodule_visible($mod->id, $mod->visibleold);
2060             $modvisible = $mod->visibleold;
2061         }
2062     }
2064     // Add the module into the new section.
2065     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
2066     return $modvisible;
2069 /**
2070  * Returns the list of all editing actions that current user can perform on the module
2071  *
2072  * @param cm_info $mod The module to produce editing buttons for
2073  * @param int $indent The current indenting (default -1 means no move left-right actions)
2074  * @param int $sr The section to link back to (used for creating the links)
2075  * @return array array of action_link or pix_icon objects
2076  */
2077 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2078     global $COURSE, $SITE;
2080     static $str;
2082     $coursecontext = context_course::instance($mod->course);
2083     $modcontext = context_module::instance($mod->id);
2085     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2086     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2088     // No permission to edit anything.
2089     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2090         return array();
2091     }
2093     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2095     if (!isset($str)) {
2096         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2097             'editsettings', 'duplicate', 'hide', 'show'), 'moodle');
2098         $str->assign         = get_string('assignroles', 'role');
2099         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2100         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2101         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2102     }
2104     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2106     if ($sr !== null) {
2107         $baseurl->param('sr', $sr);
2108     }
2109     $actions = array();
2111     // Update.
2112     if ($hasmanageactivities) {
2113         $actions['update'] = new action_menu_link_secondary(
2114             new moodle_url($baseurl, array('update' => $mod->id)),
2115             new pix_icon('t/edit', $str->editsettings, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2116             $str->editsettings,
2117             array('class' => 'editing_update', 'data-action' => 'update')
2118         );
2119     }
2121     // Indent.
2122     if ($hasmanageactivities && $indent >= 0) {
2123         $indentlimits = new stdClass();
2124         $indentlimits->min = 0;
2125         $indentlimits->max = 16;
2126         if (right_to_left()) {   // Exchange arrows on RTL
2127             $rightarrow = 't/left';
2128             $leftarrow  = 't/right';
2129         } else {
2130             $rightarrow = 't/right';
2131             $leftarrow  = 't/left';
2132         }
2134         if ($indent >= $indentlimits->max) {
2135             $enabledclass = 'hidden';
2136         } else {
2137             $enabledclass = '';
2138         }
2139         $actions['moveright'] = new action_menu_link_secondary(
2140             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2141             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2142             $str->moveright,
2143             array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright', 'data-keepopen' => true)
2144         );
2146         if ($indent <= $indentlimits->min) {
2147             $enabledclass = 'hidden';
2148         } else {
2149             $enabledclass = '';
2150         }
2151         $actions['moveleft'] = new action_menu_link_secondary(
2152             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
2153             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2154             $str->moveleft,
2155             array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft', 'data-keepopen' => true)
2156         );
2158     }
2160     // Hide/Show.
2161     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2162         if ($mod->visible) {
2163             $actions['hide'] = new action_menu_link_secondary(
2164                 new moodle_url($baseurl, array('hide' => $mod->id)),
2165                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2166                 $str->hide,
2167                 array('class' => 'editing_hide', 'data-action' => 'hide')
2168             );
2169         } else {
2170             $actions['show'] = new action_menu_link_secondary(
2171                 new moodle_url($baseurl, array('show' => $mod->id)),
2172                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2173                 $str->show,
2174                 array('class' => 'editing_show', 'data-action' => 'show')
2175             );
2176         }
2177     }
2179     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2180     if (has_all_capabilities($dupecaps, $coursecontext) &&
2181             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
2182         $actions['duplicate'] = new action_menu_link_secondary(
2183             new moodle_url($baseurl, array('duplicate' => $mod->id)),
2184             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2185             $str->duplicate,
2186             array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sr' => $sr)
2187         );
2188     }
2190     // Groupmode.
2191     if ($hasmanageactivities && !$mod->coursegroupmodeforce) {
2192         if (plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2193             if ($mod->effectivegroupmode == SEPARATEGROUPS) {
2194                 $nextgroupmode = VISIBLEGROUPS;
2195                 $grouptitle = $str->groupsseparate;
2196                 $actionname = 'groupsseparate';
2197                 $groupimage = 'i/groups';
2198             } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
2199                 $nextgroupmode = NOGROUPS;
2200                 $grouptitle = $str->groupsvisible;
2201                 $actionname = 'groupsvisible';
2202                 $groupimage = 'i/groupv';
2203             } else {
2204                 $nextgroupmode = SEPARATEGROUPS;
2205                 $grouptitle = $str->groupsnone;
2206                 $actionname = 'groupsnone';
2207                 $groupimage = 'i/groupn';
2208             }
2210             $actions[$actionname] = new action_menu_link_primary(
2211                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
2212                 new pix_icon($groupimage, null, 'moodle', array('class' => 'iconsmall')),
2213                 $grouptitle,
2214                 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode, 'aria-live' => 'assertive')
2215             );
2216         } else {
2217             $actions['nogroupsupport'] = new action_menu_filler();
2218         }
2219     }
2221     // Assign.
2222     if (has_capability('moodle/role:assign', $modcontext)){
2223         $actions['assign'] = new action_menu_link_secondary(
2224             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2225             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2226             $str->assign,
2227             array('class' => 'editing_assign', 'data-action' => 'assignroles')
2228         );
2229     }
2231     // Delete.
2232     if ($hasmanageactivities) {
2233         $actions['delete'] = new action_menu_link_secondary(
2234             new moodle_url($baseurl, array('delete' => $mod->id)),
2235             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2236             $str->delete,
2237             array('class' => 'editing_delete', 'data-action' => 'delete')
2238         );
2239     }
2241     return $actions;
2244 /**
2245  * Returns the rename action.
2246  *
2247  * @param cm_info $mod The module to produce editing buttons for
2248  * @param int $sr The section to link back to (used for creating the links)
2249  * @return The markup for the rename action, or an empty string if not available.
2250  */
2251 function course_get_cm_rename_action(cm_info $mod, $sr = null) {
2252     global $COURSE, $OUTPUT;
2254     static $str;
2255     static $baseurl;
2257     $modcontext = context_module::instance($mod->id);
2258     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2260     if (!isset($str)) {
2261         $str = get_strings(array('edittitle'));
2262     }
2264     if (!isset($baseurl)) {
2265         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2266     }
2268     if ($sr !== null) {
2269         $baseurl->param('sr', $sr);
2270     }
2272     // AJAX edit title.
2273     if ($mod->has_view() && $hasmanageactivities && course_ajax_enabled($COURSE) &&
2274                 (($mod->course == $COURSE->id) || ($mod->course == SITEID))) {
2275         // we will not display link if we are on some other-course page (where we should not see this module anyway)
2276         return html_writer::span(
2277             html_writer::link(
2278                 new moodle_url($baseurl, array('update' => $mod->id)),
2279                 $OUTPUT->pix_icon('t/editstring', '', 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2280                 array(
2281                     'class' => 'editing_title',
2282                     'data-action' => 'edittitle',
2283                     'title' => $str->edittitle,
2284                 )
2285             )
2286         );
2287     }
2288     return '';
2291 /**
2292  * Returns the move action.
2293  *
2294  * @param cm_info $mod The module to produce a move button for
2295  * @param int $sr The section to link back to (used for creating the links)
2296  * @return The markup for the move action, or an empty string if not available.
2297  */
2298 function course_get_cm_move(cm_info $mod, $sr = null) {
2299     global $OUTPUT;
2301     static $str;
2302     static $baseurl;
2304     $modcontext = context_module::instance($mod->id);
2305     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2307     if (!isset($str)) {
2308         $str = get_strings(array('move'));
2309     }
2311     if (!isset($baseurl)) {
2312         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2314         if ($sr !== null) {
2315             $baseurl->param('sr', $sr);
2316         }
2317     }
2319     if ($hasmanageactivities) {
2320         $pixicon = 'i/dragdrop';
2322         if (!course_ajax_enabled($mod->get_course())) {
2323             // Override for course frontpage until we get drag/drop working there.
2324             $pixicon = 't/move';
2325         }
2327         return html_writer::link(
2328             new moodle_url($baseurl, array('copy' => $mod->id)),
2329             $OUTPUT->pix_icon($pixicon, $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2330             array('class' => 'editing_move', 'data-action' => 'move')
2331         );
2332     }
2333     return '';
2336 /**
2337  * given a course object with shortname & fullname, this function will
2338  * truncate the the number of chars allowed and add ... if it was too long
2339  */
2340 function course_format_name ($course,$max=100) {
2342     $context = context_course::instance($course->id);
2343     $shortname = format_string($course->shortname, true, array('context' => $context));
2344     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2345     $str = $shortname.': '. $fullname;
2346     if (core_text::strlen($str) <= $max) {
2347         return $str;
2348     }
2349     else {
2350         return core_text::substr($str,0,$max-3).'...';
2351     }
2354 /**
2355  * Is the user allowed to add this type of module to this course?
2356  * @param object $course the course settings. Only $course->id is used.
2357  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2358  * @return bool whether the current user is allowed to add this type of module to this course.
2359  */
2360 function course_allowed_module($course, $modname) {
2361     if (is_numeric($modname)) {
2362         throw new coding_exception('Function course_allowed_module no longer
2363                 supports numeric module ids. Please update your code to pass the module name.');
2364     }
2366     $capability = 'mod/' . $modname . ':addinstance';
2367     if (!get_capability_info($capability)) {
2368         // Debug warning that the capability does not exist, but no more than once per page.
2369         static $warned = array();
2370         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2371         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2372             debugging('The module ' . $modname . ' does not define the standard capability ' .
2373                     $capability , DEBUG_DEVELOPER);
2374             $warned[$modname] = 1;
2375         }
2377         // If the capability does not exist, the module can always be added.
2378         return true;
2379     }
2381     $coursecontext = context_course::instance($course->id);
2382     return has_capability($capability, $coursecontext);
2385 /**
2386  * Efficiently moves many courses around while maintaining
2387  * sortorder in order.
2388  *
2389  * @param array $courseids is an array of course ids
2390  * @param int $categoryid
2391  * @return bool success
2392  */
2393 function move_courses($courseids, $categoryid) {
2394     global $DB;
2396     if (empty($courseids)) {
2397         // Nothing to do.
2398         return false;
2399     }
2401     if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2402         return false;
2403     }
2405     $courseids = array_reverse($courseids);
2406     $newparent = context_coursecat::instance($category->id);
2407     $i = 1;
2409     list($where, $params) = $DB->get_in_or_equal($courseids);
2410     $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
2411     foreach ($dbcourses as $dbcourse) {
2412         $course = new stdClass();
2413         $course->id = $dbcourse->id;
2414         $course->category  = $category->id;
2415         $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2416         if ($category->visible == 0) {
2417             // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2418             // to previous state if somebody unhides the category.
2419             $course->visible = 0;
2420         }
2422         $DB->update_record('course', $course);
2424         // Update context, so it can be passed to event.
2425         $context = context_course::instance($course->id);
2426         $context->update_moved($newparent);
2428         // Trigger a course updated event.
2429         $event = \core\event\course_updated::create(array(
2430             'objectid' => $course->id,
2431             'context' => context_course::instance($course->id),
2432             'other' => array('shortname' => $dbcourse->shortname,
2433                              'fullname' => $dbcourse->fullname)
2434         ));
2435         $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2436         $event->trigger();
2437     }
2438     fix_course_sortorder();
2439     cache_helper::purge_by_event('changesincourse');
2441     return true;
2444 /**
2445  * Returns the display name of the given section that the course prefers
2446  *
2447  * Implementation of this function is provided by course format
2448  * @see format_base::get_section_name()
2449  *
2450  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2451  * @param int|stdClass $section Section object from database or just field course_sections.section
2452  * @return string Display name that the course format prefers, e.g. "Week 2"
2453  */
2454 function get_section_name($courseorid, $section) {
2455     return course_get_format($courseorid)->get_section_name($section);
2458 /**
2459  * Tells if current course format uses sections
2460  *
2461  * @param string $format Course format ID e.g. 'weeks' $course->format
2462  * @return bool
2463  */
2464 function course_format_uses_sections($format) {
2465     $course = new stdClass();
2466     $course->format = $format;
2467     return course_get_format($course)->uses_sections();
2470 /**
2471  * Returns the information about the ajax support in the given source format
2472  *
2473  * The returned object's property (boolean)capable indicates that
2474  * the course format supports Moodle course ajax features.
2475  *
2476  * @param string $format
2477  * @return stdClass
2478  */
2479 function course_format_ajax_support($format) {
2480     $course = new stdClass();
2481     $course->format = $format;
2482     return course_get_format($course)->supports_ajax();
2485 /**
2486  * Can the current user delete this course?
2487  * Course creators have exception,
2488  * 1 day after the creation they can sill delete the course.
2489  * @param int $courseid
2490  * @return boolean
2491  */
2492 function can_delete_course($courseid) {
2493     global $USER;
2495     $context = context_course::instance($courseid);
2497     if (has_capability('moodle/course:delete', $context)) {
2498         return true;
2499     }
2501     // hack: now try to find out if creator created this course recently (1 day)
2502     if (!has_capability('moodle/course:create', $context)) {
2503         return false;
2504     }
2506     $since = time() - 60*60*24;
2507     $course = get_course($courseid);
2509     if ($course->timecreated < $since) {
2510         return false; // Return if the course was not created in last 24 hours.
2511     }
2513     $logmanger = get_log_manager();
2514     $readers = $logmanger->get_readers('\core\log\sql_reader');
2515     $reader = reset($readers);
2517     if (empty($reader)) {
2518         return false; // No log reader found.
2519     }
2521     // A proper reader.
2522     $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2523     $params = array('userid' => $USER->id, 'since' => $since, 'courseid' => $course->id, 'eventname' => '\core\event\course_created');
2525     return (bool)$reader->get_events_select_count($select, $params);
2528 /**
2529  * Save the Your name for 'Some role' strings.
2530  *
2531  * @param integer $courseid the id of this course.
2532  * @param array $data the data that came from the course settings form.
2533  */
2534 function save_local_role_names($courseid, $data) {
2535     global $DB;
2536     $context = context_course::instance($courseid);
2538     foreach ($data as $fieldname => $value) {
2539         if (strpos($fieldname, 'role_') !== 0) {
2540             continue;
2541         }
2542         list($ignored, $roleid) = explode('_', $fieldname);
2544         // make up our mind whether we want to delete, update or insert
2545         if (!$value) {
2546             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2548         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2549             $rolename->name = $value;
2550             $DB->update_record('role_names', $rolename);
2552         } else {
2553             $rolename = new stdClass;
2554             $rolename->contextid = $context->id;
2555             $rolename->roleid = $roleid;
2556             $rolename->name = $value;
2557             $DB->insert_record('role_names', $rolename);
2558         }
2559         // This will ensure the course contacts cache is purged..
2560         coursecat::role_assignment_changed($roleid, $context);
2561     }
2564 /**
2565  * Returns options to use in course overviewfiles filemanager
2566  *
2567  * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2568  *     may be empty if course does not exist yet (course create form)
2569  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2570  *     or null if overviewfiles are disabled
2571  */
2572 function course_overviewfiles_options($course) {
2573     global $CFG;
2574     if (empty($CFG->courseoverviewfileslimit)) {
2575         return null;
2576     }
2577     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2578     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2579         $accepted_types = '*';
2580     } else {
2581         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2582         // Make sure extensions are prefixed with dot unless they are valid typegroups
2583         foreach ($accepted_types as $i => $type) {
2584             if (substr($type, 0, 1) !== '.') {
2585                 require_once($CFG->libdir. '/filelib.php');
2586                 if (!count(file_get_typegroup('extension', $type))) {
2587                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2588                     $accepted_types[$i] = '.'. $type;
2589                     $corrected = true;
2590                 }
2591             }
2592         }
2593         if (!empty($corrected)) {
2594             set_config('courseoverviewfilesext', join(',', $accepted_types));
2595         }
2596     }
2597     $options = array(
2598         'maxfiles' => $CFG->courseoverviewfileslimit,
2599         'maxbytes' => $CFG->maxbytes,
2600         'subdirs' => 0,
2601         'accepted_types' => $accepted_types
2602     );
2603     if (!empty($course->id)) {
2604         $options['context'] = context_course::instance($course->id);
2605     } else if (is_int($course) && $course > 0) {
2606         $options['context'] = context_course::instance($course);
2607     }
2608     return $options;
2611 /**
2612  * Create a course and either return a $course object
2613  *
2614  * Please note this functions does not verify any access control,
2615  * the calling code is responsible for all validation (usually it is the form definition).
2616  *
2617  * @param array $editoroptions course description editor options
2618  * @param object $data  - all the data needed for an entry in the 'course' table
2619  * @return object new course instance
2620  */
2621 function create_course($data, $editoroptions = NULL) {
2622     global $DB, $CFG;
2624     //check the categoryid - must be given for all new courses
2625     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2627     // Check if the shortname already exists.
2628     if (!empty($data->shortname)) {
2629         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2630             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2631         }
2632     }
2634     // Check if the idnumber already exists.
2635     if (!empty($data->idnumber)) {
2636         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2637             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2638         }
2639     }
2641     // Check if timecreated is given.
2642     $data->timecreated  = !empty($data->timecreated) ? $data->timecreated : time();
2643     $data->timemodified = $data->timecreated;
2645     // place at beginning of any category
2646     $data->sortorder = 0;
2648     if ($editoroptions) {
2649         // summary text is updated later, we need context to store the files first
2650         $data->summary = '';
2651         $data->summary_format = FORMAT_HTML;
2652     }
2654     if (!isset($data->visible)) {
2655         // data not from form, add missing visibility info
2656         $data->visible = $category->visible;
2657     }
2658     $data->visibleold = $data->visible;
2660     $newcourseid = $DB->insert_record('course', $data);
2661     $context = context_course::instance($newcourseid, MUST_EXIST);
2663     if ($editoroptions) {
2664         // Save the files used in the summary editor and store
2665         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2666         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2667         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2668     }
2669     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2670         // Save the course overviewfiles
2671         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2672     }
2674     // update course format options
2675     course_get_format($newcourseid)->update_course_format_options($data);
2677     $course = course_get_format($newcourseid)->get_course();
2679     fix_course_sortorder();
2680     // purge appropriate caches in case fix_course_sortorder() did not change anything
2681     cache_helper::purge_by_event('changesincourse');
2683     // new context created - better mark it as dirty
2684     $context->mark_dirty();
2686     // Trigger a course created event.
2687     $event = \core\event\course_created::create(array(
2688         'objectid' => $course->id,
2689         'context' => context_course::instance($course->id),
2690         'other' => array('shortname' => $course->shortname,
2691             'fullname' => $course->fullname)
2692     ));
2693     $event->trigger();
2695     // Setup the blocks
2696     blocks_add_default_course_blocks($course);
2698     // Create a default section.
2699     course_create_sections_if_missing($course, 0);
2701     // Save any custom role names.
2702     save_local_role_names($course->id, (array)$data);
2704     // set up enrolments
2705     enrol_course_updated(true, $course, $data);
2707     // Update course tags.
2708     if (isset($data->tags)) {
2709         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2710     }
2712     return $course;
2715 /**
2716  * Update a course.
2717  *
2718  * Please note this functions does not verify any access control,
2719  * the calling code is responsible for all validation (usually it is the form definition).
2720  *
2721  * @param object $data  - all the data needed for an entry in the 'course' table
2722  * @param array $editoroptions course description editor options
2723  * @return void
2724  */
2725 function update_course($data, $editoroptions = NULL) {
2726     global $DB, $CFG;
2728     $data->timemodified = time();
2730     $oldcourse = course_get_format($data->id)->get_course();
2731     $context   = context_course::instance($oldcourse->id);
2733     if ($editoroptions) {
2734         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2735     }
2736     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2737         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2738     }
2740     // Check we don't have a duplicate shortname.
2741     if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
2742         if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname, $data->id))) {
2743             throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2744         }
2745     }
2747     // Check we don't have a duplicate idnumber.
2748     if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
2749         if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber, $data->id))) {
2750             throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2751         }
2752     }
2754     if (!isset($data->category) or empty($data->category)) {
2755         // prevent nulls and 0 in category field
2756         unset($data->category);
2757     }
2758     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2760     if (!isset($data->visible)) {
2761         // data not from form, add missing visibility info
2762         $data->visible = $oldcourse->visible;
2763     }
2765     if ($data->visible != $oldcourse->visible) {
2766         // reset the visibleold flag when manually hiding/unhiding course
2767         $data->visibleold = $data->visible;
2768         $changesincoursecat = true;
2769     } else {
2770         if ($movecat) {
2771             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2772             if (empty($newcategory->visible)) {
2773                 // make sure when moving into hidden category the course is hidden automatically
2774                 $data->visible = 0;
2775             }
2776         }
2777     }
2779     // Update with the new data
2780     $DB->update_record('course', $data);
2781     // make sure the modinfo cache is reset
2782     rebuild_course_cache($data->id);
2784     // update course format options with full course data
2785     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2787     $course = $DB->get_record('course', array('id'=>$data->id));
2789     if ($movecat) {
2790         $newparent = context_coursecat::instance($course->category);
2791         $context->update_moved($newparent);
2792     }
2793     $fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
2794     if ($fixcoursesortorder) {
2795         fix_course_sortorder();
2796     }
2798     // purge appropriate caches in case fix_course_sortorder() did not change anything
2799     cache_helper::purge_by_event('changesincourse');
2800     if ($changesincoursecat) {
2801         cache_helper::purge_by_event('changesincoursecat');
2802     }
2804     // Test for and remove blocks which aren't appropriate anymore
2805     blocks_remove_inappropriate($course);
2807     // Save any custom role names.
2808     save_local_role_names($course->id, $data);
2810     // update enrol settings
2811     enrol_course_updated(false, $course, $data);
2813     // Update course tags.
2814     if (isset($data->tags)) {
2815         core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
2816     }
2818     // Trigger a course updated event.
2819     $event = \core\event\course_updated::create(array(
2820         'objectid' => $course->id,
2821         'context' => context_course::instance($course->id),
2822         'other' => array('shortname' => $course->shortname,
2823                          'fullname' => $course->fullname)
2824     ));
2826     $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
2827     $event->trigger();
2829     if ($oldcourse->format !== $course->format) {
2830         // Remove all options stored for the previous format
2831         // We assume that new course format migrated everything it needed watching trigger
2832         // 'course_updated' and in method format_XXX::update_course_format_options()
2833         $DB->delete_records('course_format_options',
2834                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2835     }
2838 /**
2839  * Average number of participants
2840  * @return integer
2841  */
2842 function average_number_of_participants() {
2843     global $DB, $SITE;
2845     //count total of enrolments for visible course (except front page)
2846     $sql = 'SELECT COUNT(*) FROM (
2847         SELECT DISTINCT ue.userid, e.courseid
2848         FROM {user_enrolments} ue, {enrol} e, {course} c
2849         WHERE ue.enrolid = e.id
2850             AND e.courseid <> :siteid
2851             AND c.id = e.courseid
2852             AND c.visible = 1) total';
2853     $params = array('siteid' => $SITE->id);
2854     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2857     //count total of visible courses (minus front page)
2858     $coursetotal = $DB->count_records('course', array('visible' => 1));
2859     $coursetotal = $coursetotal - 1 ;
2861     //average of enrolment
2862     if (empty($coursetotal)) {
2863         $participantaverage = 0;
2864     } else {
2865         $participantaverage = $enrolmenttotal / $coursetotal;
2866     }
2868     return $participantaverage;
2871 /**
2872  * Average number of course modules
2873  * @return integer
2874  */
2875 function average_number_of_courses_modules() {
2876     global $DB, $SITE;
2878     //count total of visible course module (except front page)
2879     $sql = 'SELECT COUNT(*) FROM (
2880         SELECT cm.course, cm.module
2881         FROM {course} c, {course_modules} cm
2882         WHERE c.id = cm.course
2883             AND c.id <> :siteid
2884             AND cm.visible = 1
2885             AND c.visible = 1) total';
2886     $params = array('siteid' => $SITE->id);
2887     $moduletotal = $DB->count_records_sql($sql, $params);
2890     //count total of visible courses (minus front page)
2891     $coursetotal = $DB->count_records('course', array('visible' => 1));
2892     $coursetotal = $coursetotal - 1 ;
2894     //average of course module
2895     if (empty($coursetotal)) {
2896         $coursemoduleaverage = 0;
2897     } else {
2898         $coursemoduleaverage = $moduletotal / $coursetotal;
2899     }
2901     return $coursemoduleaverage;
2904 /**
2905  * This class pertains to course requests and contains methods associated with
2906  * create, approving, and removing course requests.
2907  *
2908  * Please note we do not allow embedded images here because there is no context
2909  * to store them with proper access control.
2910  *
2911  * @copyright 2009 Sam Hemelryk
2912  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2913  * @since Moodle 2.0
2914  *
2915  * @property-read int $id
2916  * @property-read string $fullname
2917  * @property-read string $shortname
2918  * @property-read string $summary
2919  * @property-read int $summaryformat
2920  * @property-read int $summarytrust
2921  * @property-read string $reason
2922  * @property-read int $requester
2923  */
2924 class course_request {
2926     /**
2927      * This is the stdClass that stores the properties for the course request
2928      * and is externally accessed through the __get magic method
2929      * @var stdClass
2930      */
2931     protected $properties;
2933     /**
2934      * An array of options for the summary editor used by course request forms.
2935      * This is initially set by {@link summary_editor_options()}
2936      * @var array
2937      * @static
2938      */
2939     protected static $summaryeditoroptions;
2941     /**
2942      * Static function to prepare the summary editor for working with a course
2943      * request.
2944      *
2945      * @static
2946      * @param null|stdClass $data Optional, an object containing the default values
2947      *                       for the form, these may be modified when preparing the
2948      *                       editor so this should be called before creating the form
2949      * @return stdClass An object that can be used to set the default values for
2950      *                   an mforms form
2951      */
2952     public static function prepare($data=null) {
2953         if ($data === null) {
2954             $data = new stdClass;
2955         }
2956         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2957         return $data;
2958     }
2960     /**
2961      * Static function to create a new course request when passed an array of properties
2962      * for it.
2963      *
2964      * This function also handles saving any files that may have been used in the editor
2965      *
2966      * @static
2967      * @param stdClass $data
2968      * @return course_request The newly created course request
2969      */
2970     public static function create($data) {
2971         global $USER, $DB, $CFG;
2972         $data->requester = $USER->id;
2974         // Setting the default category if none set.
2975         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2976             $data->category = $CFG->defaultrequestcategory;
2977         }
2979         // Summary is a required field so copy the text over
2980         $data->summary       = $data->summary_editor['text'];
2981         $data->summaryformat = $data->summary_editor['format'];
2983         $data->id = $DB->insert_record('course_request', $data);
2985         // Create a new course_request object and return it
2986         $request = new course_request($data);
2988         // Notify the admin if required.
2989         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2991             $a = new stdClass;
2992             $a->link = "$CFG->wwwroot/course/pending.php";
2993             $a->user = fullname($USER);
2994             $subject = get_string('courserequest');
2995             $message = get_string('courserequestnotifyemail', 'admin', $a);
2996             foreach ($users as $user) {
2997                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2998             }
2999         }
3001         return $request;
3002     }
3004     /**
3005      * Returns an array of options to use with a summary editor
3006      *
3007      * @uses course_request::$summaryeditoroptions
3008      * @return array An array of options to use with the editor
3009      */
3010     public static function summary_editor_options() {
3011         global $CFG;
3012         if (self::$summaryeditoroptions === null) {
3013             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
3014         }
3015         return self::$summaryeditoroptions;
3016     }
3018     /**
3019      * Loads the properties for this course request object. Id is required and if
3020      * only id is provided then we load the rest of the properties from the database
3021      *
3022      * @param stdClass|int $properties Either an object containing properties
3023      *                      or the course_request id to load
3024      */
3025     public function __construct($properties) {
3026         global $DB;
3027         if (empty($properties->id)) {
3028             if (empty($properties)) {
3029                 throw new coding_exception('You must provide a course request id when creating a course_request object');
3030             }
3031             $id = $properties;
3032             $properties = new stdClass;
3033             $properties->id = (int)$id;
3034             unset($id);
3035         }
3036         if (empty($properties->requester)) {
3037             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3038                 print_error('unknowncourserequest');
3039             }
3040         } else {
3041             $this->properties = $properties;
3042         }
3043         $this->properties->collision = null;
3044     }
3046     /**
3047      * Returns the requested property
3048      *
3049      * @param string $key
3050      * @return mixed
3051      */
3052     public function __get($key) {
3053         return $this->properties->$key;
3054     }
3056     /**
3057      * Override this to ensure empty($request->blah) calls return a reliable answer...
3058      *
3059      * This is required because we define the __get method
3060      *
3061      * @param mixed $key
3062      * @return bool True is it not empty, false otherwise
3063      */
3064     public function __isset($key) {
3065         return (!empty($this->properties->$key));
3066     }
3068     /**
3069      * Returns the user who requested this course
3070      *
3071      * Uses a static var to cache the results and cut down the number of db queries
3072      *
3073      * @staticvar array $requesters An array of cached users
3074      * @return stdClass The user who requested the course
3075      */
3076     public function get_requester() {
3077         global $DB;
3078         static $requesters= array();
3079         if (!array_key_exists($this->properties->requester, $requesters)) {
3080             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3081         }
3082         return $requesters[$this->properties->requester];
3083     }
3085     /**
3086      * Checks that the shortname used by the course does not conflict with any other
3087      * courses that exist
3088      *
3089      * @param string|null $shortnamemark The string to append to the requests shortname
3090      *                     should a conflict be found
3091      * @return bool true is there is a conflict, false otherwise
3092      */
3093     public function check_shortname_collision($shortnamemark = '[*]') {
3094         global $DB;
3096         if ($this->properties->collision !== null) {
3097             return $this->properties->collision;
3098         }
3100         if (empty($this->properties->shortname)) {
3101             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3102             $this->properties->collision = false;
3103         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3104             if (!empty($shortnamemark)) {
3105                 $this->properties->shortname .= ' '.$shortnamemark;
3106             }
3107             $this->properties->collision = true;
3108         } else {
3109             $this->properties->collision = false;
3110         }
3111         return $this->properties->collision;
3112     }
3114     /**
3115      * Returns the category where this course request should be created
3116      *
3117      * Note that we don't check here that user has a capability to view
3118      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
3119      * 'moodle/course:changecategory'
3120      *
3121      * @return coursecat
3122      */
3123     public function get_category() {
3124         global $CFG;
3125         require_once($CFG->libdir.'/coursecatlib.php');
3126         // If the category is not set, if the current user does not have the rights to change the category, or if the
3127         // category does not exist, we set the default category to the course to be approved.
3128         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3129         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
3130                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
3131             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
3132         }
3133         if (!$category) {
3134             $category = coursecat::get_default();
3135         }
3136         return $category;
3137     }
3139     /**
3140      * This function approves the request turning it into a course
3141      *
3142      * This function converts the course request into a course, at the same time
3143      * transferring any files used in the summary to the new course and then removing
3144      * the course request and the files associated with it.
3145      *
3146      * @return int The id of the course that was created from this request
3147      */
3148     public function approve() {
3149         global $CFG, $DB, $USER;
3151         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3153         $courseconfig = get_config('moodlecourse');
3155         // Transfer appropriate settings
3156         $data = clone($this->properties);
3157         unset($data->id);
3158         unset($data->reason);
3159         unset($data->requester);
3161         // Set category
3162         $category = $this->get_category();
3163         $data->category = $category->id;
3164         // Set misc settings
3165         $data->requested = 1;
3167         // Apply course default settings
3168         $data->format             = $courseconfig->format;
3169         $data->newsitems          = $courseconfig->newsitems;
3170         $data->showgrades         = $courseconfig->showgrades;
3171         $data->showreports        = $courseconfig->showreports;
3172         $data->maxbytes           = $courseconfig->maxbytes;
3173         $data->groupmode          = $courseconfig->groupmode;
3174         $data->groupmodeforce     = $courseconfig->groupmodeforce;
3175         $data->visible            = $courseconfig->visible;
3176         $data->visibleold         = $data->visible;
3177         $data->lang               = $courseconfig->lang;
3179         $course = create_course($data);
3180         $context = context_course::instance($course->id, MUST_EXIST);
3182         // add enrol instances
3183         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3184             if ($manual = enrol_get_plugin('manual')) {
3185                 $manual->add_default_instance($course);
3186             }
3187         }
3189         // enrol the requester as teacher if necessary
3190         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3191             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3192         }
3194         $this->delete();
3196         $a = new stdClass();
3197         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3198         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3199         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3201         return $course->id;
3202     }
3204     /**
3205      * Reject a course request
3206      *
3207      * This function rejects a course request, emailing the requesting user the
3208      * provided notice and then removing the request from the database
3209      *
3210      * @param string $notice The message to display to the user
3211      */
3212     public function reject($notice) {
3213         global $USER, $DB;
3214         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
3215         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3216         $this->delete();
3217     }
3219     /**
3220      * Deletes the course request and any associated files
3221      */
3222     public function delete() {
3223         global $DB;
3224         $DB->delete_records('course_request', array('id' => $this->properties->id));
3225     }
3227     /**
3228      * Send a message from one user to another using events_trigger
3229      *
3230      * @param object $touser
3231      * @param object $fromuser
3232      * @param string $name
3233      * @param string $subject
3234      * @param string $message
3235      */
3236     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
3237         $eventdata = new stdClass();
3238         $eventdata->component         = 'moodle';
3239         $eventdata->name              = $name;
3240         $eventdata->userfrom          = $fromuser;
3241         $eventdata->userto            = $touser;
3242         $eventdata->subject           = $subject;
3243         $eventdata->fullmessage       = $message;
3244         $eventdata->fullmessageformat = FORMAT_PLAIN;
3245         $eventdata->fullmessagehtml   = '';
3246         $eventdata->smallmessage      = '';
3247         $eventdata->notification      = 1;
3248         message_send($eventdata);
3249     }
3252 /**
3253  * Return a list of page types
3254  * @param string $pagetype current page type
3255  * @param context $parentcontext Block's parent context
3256  * @param context $currentcontext Current context of block
3257  * @return array array of page types
3258  */
3259 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3260     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
3261         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3262         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3263             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3264         );
3265     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
3266         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3267         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3268     } else {
3269         // Otherwise consider it a page inside a course even if $currentcontext is null
3270         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3271             'course-*' => get_string('page-course-x', 'pagetype'),
3272             'course-view-*' => get_string('page-course-view-x', 'pagetype')
3273         );
3274     }
3275     return $pagetypes;
3278 /**
3279  * Determine whether course ajax should be enabled for the specified course
3280  *
3281  * @param stdClass $course The course to test against
3282  * @return boolean Whether course ajax is enabled or note
3283  */
3284 function course_ajax_enabled($course) {
3285     global $CFG, $PAGE, $SITE;
3287     // The user must be editing for AJAX to be included
3288     if (!$PAGE->user_is_editing()) {
3289         return false;
3290     }
3292     // Check that the theme suports
3293     if (!$PAGE->theme->enablecourseajax) {
3294         return false;
3295     }
3297     // Check that the course format supports ajax functionality
3298     // The site 'format' doesn't have information on course format support
3299     if ($SITE->id !== $course->id) {
3300         $courseformatajaxsupport = course_format_ajax_support($course->format);
3301         if (!$courseformatajaxsupport->capable) {
3302             return false;
3303         }
3304     }
3306     // All conditions have been met so course ajax should be enabled
3307     return true;
3310 /**
3311  * Include the relevant javascript and language strings for the resource
3312  * toolbox YUI module
3313  *
3314  * @param integer $id The ID of the course being applied to
3315  * @param array $usedmodules An array containing the names of the modules in use on the page
3316  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3317  * @param stdClass $config An object containing configuration parameters for ajax modules including:
3318  *          * resourceurl   The URL to post changes to for resource changes
3319  *          * sectionurl    The URL to post changes to for section changes
3320  *          * pageparams    Additional parameters to pass through in the post
3321  * @return bool
3322  */
3323 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3324     global $CFG, $PAGE, $SITE;
3326     // Ensure that ajax should be included
3327     if (!course_ajax_enabled($course)) {
3328         return false;
3329     }
3331     if (!$config) {
3332         $config = new stdClass();
3333     }
3335     // The URL to use for resource changes
3336     if (!isset($config->resourceurl)) {
3337         $config->resourceurl = '/course/rest.php';
3338     }
3340     // The URL to use for section changes
3341     if (!isset($config->sectionurl)) {
3342         $config->sectionurl = '/course/rest.php';
3343     }
3345     // Any additional parameters which need to be included on page submission
3346     if (!isset($config->pageparams)) {
3347         $config->pageparams = array();
3348     }
3350     // Include toolboxes
3351     $PAGE->requires->yui_module('moodle-course-toolboxes',
3352             'M.course.init_resource_toolbox',
3353             array(array(
3354                 'courseid' => $course->id,
3355                 'ajaxurl' => $config->resourceurl,
3356                 'config' => $config,
3357             ))
3358     );
3359     $PAGE->requires->yui_module('moodle-course-toolboxes',
3360             'M.course.init_section_toolbox',
3361             array(array(
3362                 'courseid' => $course->id,
3363                 'format' => $course->format,
3364                 'ajaxurl' => $config->sectionurl,
3365                 'config' => $config,
3366             ))
3367     );
3369     // Include course dragdrop
3370     if (course_format_uses_sections($course->format)) {
3371         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3372             array(array(
3373                 'courseid' => $course->id,
3374                 'ajaxurl' => $config->sectionurl,
3375                 'config' => $config,
3376             )), null, true);
3378         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3379             array(array(
3380                 'courseid' => $course->id,
3381                 'ajaxurl' => $config->resourceurl,
3382                 'config' => $config,
3383             )), null, true);
3384     }
3386     // Require various strings for the command toolbox
3387     $PAGE->requires->strings_for_js(array(
3388             'moveleft',
3389             'deletechecktype',
3390             'deletechecktypename',
3391             'edittitle',
3392             'edittitleinstructions',
3393             'show',
3394             'hide',
3395             'highlight',
3396             'highlightoff',
3397             'groupsnone',
3398             'groupsvisible',
3399             'groupsseparate',
3400             'clicktochangeinbrackets',
3401             'markthistopic',
3402             'markedthistopic',
3403             'movesection',
3404             'movecoursemodule',
3405             'movecoursesection',
3406             'movecontent',
3407             'tocontent',
3408             'emptydragdropregion',
3409             'afterresource',
3410             'aftersection',
3411             'totopofsection',
3412         ), 'moodle');
3414     // Include section-specific strings for formats which support sections.
3415     if (course_format_uses_sections($course->format)) {
3416         $PAGE->requires->strings_for_js(array(
3417                 'showfromothers',
3418                 'hidefromothers',
3419             ), 'format_' . $course->format);
3420     }
3422     // For confirming resource deletion we need the name of the module in question
3423     foreach ($usedmodules as $module => $modname) {
3424         $PAGE->requires->string_for_js('pluginname', $module);
3425     }
3427     // Load drag and drop upload AJAX.
3428     require_once($CFG->dirroot.'/course/dnduploadlib.php');
3429     dndupload_add_to_course($course, $enabledmodules);
3431     return true;
3434 /**
3435  * Returns the sorted list of available course formats, filtered by enabled if necessary
3436  *
3437  * @param bool $enabledonly return only formats that are enabled
3438  * @return array array of sorted format names
3439  */
3440 function get_sorted_course_formats($enabledonly = false) {
3441     global $CFG;
3442     $formats = core_component::get_plugin_list('format');
3444     if (!empty($CFG->format_plugins_sortorder)) {
3445         $order = explode(',', $CFG->format_plugins_sortorder);
3446         $order = array_merge(array_intersect($order, array_keys($formats)),
3447                     array_diff(array_keys($formats), $order));
3448     } else {
3449         $order = array_keys($formats);
3450     }
3451     if (!$enabledonly) {
3452         return $order;
3453     }
3454     $sortedformats = array();
3455     foreach ($order as $formatname) {
3456         if (!get_config('format_'.$formatname, 'disabled')) {
3457             $sortedformats[] = $formatname;
3458         }
3459     }
3460     return $sortedformats;
3463 /**
3464  * The URL to use for the specified course (with section)
3465  *
3466  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3467  * @param int|stdClass $section Section object from database or just field course_sections.section
3468  *     if omitted the course view page is returned
3469  * @param array $options options for view URL. At the moment core uses:
3470  *     'navigation' (bool) if true and section has no separate page, the function returns null
3471  *     'sr' (int) used by multipage formats to specify to which section to return
3472  * @return moodle_url The url of course
3473  */
3474 function course_get_url($courseorid, $section = null, $options = array()) {
3475     return course_get_format($courseorid)->get_view_url($section, $options);
3478 /**
3479  * Create a module.
3480  *
3481  * It includes:
3482  *      - capability checks and other checks
3483  *      - create the module from the module info
3484  *
3485  * @param object $module
3486  * @return object the created module info
3487  * @throws moodle_exception if user is not allowed to perform the action or module is not allowed in this course
3488  */
3489 function create_module($moduleinfo) {
3490     global $DB, $CFG;
3492     require_once($CFG->dirroot . '/course/modlib.php');
3494     // Check manadatory attributs.
3495     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3496     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3497         $mandatoryfields[] = 'introeditor';
3498     }
3499     foreach($mandatoryfields as $mandatoryfield) {
3500         if (!isset($moduleinfo->{$mandatoryfield})) {
3501             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3502         }
3503     }
3505     // Some additional checks (capability / existing instances).
3506     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3507     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3509     // Add the module.
3510     $moduleinfo->module = $module->id;
3511     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3513     return $moduleinfo;
3516 /**
3517  * Update a module.
3518  *
3519  * It includes:
3520  *      - capability and other checks
3521  *      - update the module
3522  *
3523  * @param object $module
3524  * @return object the updated module info
3525  * @throws moodle_exception if current user is not allowed to update the module
3526  */
3527 function update_module($moduleinfo) {
3528     global $DB, $CFG;
3530     require_once($CFG->dirroot . '/course/modlib.php');
3532     // Check the course module exists.
3533     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3535     // Check the course exists.
3536     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3538     // Some checks (capaibility / existing instances).
3539     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3541     // Retrieve few information needed by update_moduleinfo.
3542     $moduleinfo->modulename = $cm->modname;
3543     if (!isset($moduleinfo->scale)) {
3544         $moduleinfo->scale = 0;
3545     }
3546     $moduleinfo->type = 'mod';
3548     // Update the module.
3549     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3551     return $moduleinfo;
3554 /**
3555  * Duplicate a module on the course for ajax.
3556  *
3557  * @see mod_duplicate_module()
3558  * @param object $course The course
3559  * @param object $cm The course module to duplicate
3560  * @param int $sr The section to link back to (used for creating the links)
3561  * @throws moodle_exception if the plugin doesn't support duplication
3562  * @return Object containing:
3563  * - fullcontent: The HTML markup for the created CM
3564  * - cmid: The CMID of the newly created CM
3565  * - redirect: Whether to trigger a redirect following this change
3566  */
3567 function mod_duplicate_activity($course, $cm, $sr = null) {
3568     global $PAGE;
3570     $newcm = duplicate_module($course, $cm);
3572     $resp = new stdClass();
3573     if ($newcm) {
3574         $courserenderer = $PAGE->get_renderer('core', 'course');
3575         $completioninfo = new completion_info($course);
3576         $modulehtml = $courserenderer->course_section_cm($course, $completioninfo,
3577                 $newcm, null, array());
3579         $resp->fullcontent = $courserenderer->course_section_cm_list_item($course, $completioninfo, $newcm, $sr);
3580         $resp->cmid = $newcm->id;
3581     } else {
3582         // Trigger a redirect.
3583         $resp->redirect = true;
3584     }
3585     return $resp;