Merge branch 'MDL-41125-master' of git://github.com/FMCorz/moodle
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->dirroot.'/course/format/lib.php');
33 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
34 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
36 /**
37  * Number of courses to display when summaries are included.
38  * @var int
39  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
40  */
41 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
43 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
44 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
45 define('FRONTPAGENEWS',           '0');
46 define('FRONTPAGECOURSELIST',     '1');         // Not used. TODO MDL-38832 remove
47 define('FRONTPAGECATEGORYNAMES',  '2');
48 define('FRONTPAGETOPICONLY',      '3');         // Not used. TODO MDL-38832 remove
49 define('FRONTPAGECATEGORYCOMBO',  '4');
50 define('FRONTPAGEENROLLEDCOURSELIST', '5');
51 define('FRONTPAGEALLCOURSELIST',  '6');
52 define('FRONTPAGECOURSESEARCH',   '7');
53 define('FRONTPAGECOURSELIMIT',    200);         // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage. TODO MDL-38832 remove
54 define('EXCELROWS', 65535);
55 define('FIRSTUSEDEXCELROW', 3);
57 define('MOD_CLASS_ACTIVITY', 0);
58 define('MOD_CLASS_RESOURCE', 1);
60 function make_log_url($module, $url) {
61     switch ($module) {
62         case 'course':
63             if (strpos($url, 'report/') === 0) {
64                 // there is only one report type, course reports are deprecated
65                 $url = "/$url";
66                 break;
67             }
68         case 'file':
69         case 'login':
70         case 'lib':
71         case 'admin':
72         case 'calendar':
73         case 'category':
74         case 'mnet course':
75             if (strpos($url, '../') === 0) {
76                 $url = ltrim($url, '.');
77             } else {
78                 $url = "/course/$url";
79             }
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  * For a given course, returns an array of course activity objects
858  * Each item in the array contains he following properties:
859  */
860 function get_array_of_activities($courseid) {
861 //  cm - course module id
862 //  mod - name of the module (eg forum)
863 //  section - the number of the section (eg week or topic)
864 //  name - the name of the instance
865 //  visible - is the instance visible or not
866 //  groupingid - grouping id
867 //  groupmembersonly - is this instance visible to group members only
868 //  extra - contains extra string to include in any link
869     global $CFG, $DB;
870     if(!empty($CFG->enableavailability)) {
871         require_once($CFG->libdir.'/conditionlib.php');
872     }
874     $course = $DB->get_record('course', array('id'=>$courseid));
876     if (empty($course)) {
877         throw new moodle_exception('courseidnotfound');
878     }
880     $mod = array();
882     $rawmods = get_course_mods($courseid);
883     if (empty($rawmods)) {
884         return $mod; // always return array
885     }
887     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
888        foreach ($sections as $section) {
889            if (!empty($section->sequence)) {
890                $sequence = explode(",", $section->sequence);
891                foreach ($sequence as $seq) {
892                    if (empty($rawmods[$seq])) {
893                        continue;
894                    }
895                    $mod[$seq] = new stdClass();
896                    $mod[$seq]->id               = $rawmods[$seq]->instance;
897                    $mod[$seq]->cm               = $rawmods[$seq]->id;
898                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
900                     // Oh dear. Inconsistent names left here for backward compatibility.
901                    $mod[$seq]->section          = $section->section;
902                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
904                    $mod[$seq]->module           = $rawmods[$seq]->module;
905                    $mod[$seq]->added            = $rawmods[$seq]->added;
906                    $mod[$seq]->score            = $rawmods[$seq]->score;
907                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
908                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
909                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
910                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
911                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
912                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
913                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
914                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
915                    $mod[$seq]->extra            = "";
916                    $mod[$seq]->completiongradeitemnumber =
917                            $rawmods[$seq]->completiongradeitemnumber;
918                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
919                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
920                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
921                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
922                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
923                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
924                    if (!empty($CFG->enableavailability)) {
925                        condition_info::fill_availability_conditions($rawmods[$seq]);
926                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
927                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
928                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
929                    }
931                    $modname = $mod[$seq]->mod;
932                    $functionname = $modname."_get_coursemodule_info";
934                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
935                        continue;
936                    }
938                    include_once("$CFG->dirroot/mod/$modname/lib.php");
940                    if ($hasfunction = function_exists($functionname)) {
941                        if ($info = $functionname($rawmods[$seq])) {
942                            if (!empty($info->icon)) {
943                                $mod[$seq]->icon = $info->icon;
944                            }
945                            if (!empty($info->iconcomponent)) {
946                                $mod[$seq]->iconcomponent = $info->iconcomponent;
947                            }
948                            if (!empty($info->name)) {
949                                $mod[$seq]->name = $info->name;
950                            }
951                            if ($info instanceof cached_cm_info) {
952                                // When using cached_cm_info you can include three new fields
953                                // that aren't available for legacy code
954                                if (!empty($info->content)) {
955                                    $mod[$seq]->content = $info->content;
956                                }
957                                if (!empty($info->extraclasses)) {
958                                    $mod[$seq]->extraclasses = $info->extraclasses;
959                                }
960                                if (!empty($info->iconurl)) {
961                                    $mod[$seq]->iconurl = $info->iconurl;
962                                }
963                                if (!empty($info->onclick)) {
964                                    $mod[$seq]->onclick = $info->onclick;
965                                }
966                                if (!empty($info->customdata)) {
967                                    $mod[$seq]->customdata = $info->customdata;
968                                }
969                            } else {
970                                // When using a stdclass, the (horrible) deprecated ->extra field
971                                // is available for BC
972                                if (!empty($info->extra)) {
973                                    $mod[$seq]->extra = $info->extra;
974                                }
975                            }
976                        }
977                    }
978                    // When there is no modname_get_coursemodule_info function,
979                    // but showdescriptions is enabled, then we use the 'intro'
980                    // and 'introformat' fields in the module table
981                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
982                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
983                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
984                            // Set content from intro and introformat. Filters are disabled
985                            // because we  filter it with format_text at display time
986                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
987                                    $modvalues, $rawmods[$seq]->id, false);
989                            // To save making another query just below, put name in here
990                            $mod[$seq]->name = $modvalues->name;
991                        }
992                    }
993                    if (!isset($mod[$seq]->name)) {
994                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
995                    }
997                    // Minimise the database size by unsetting default options when they are
998                    // 'empty'. This list corresponds to code in the cm_info constructor.
999                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1000                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1001                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1002                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1003                            'completionview', 'completionexpected', 'score', 'showdescription')
1004                            as $property) {
1005                        if (property_exists($mod[$seq], $property) &&
1006                                empty($mod[$seq]->{$property})) {
1007                            unset($mod[$seq]->{$property});
1008                        }
1009                    }
1010                    // Special case: this value is usually set to null, but may be 0
1011                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1012                            is_null($mod[$seq]->completiongradeitemnumber)) {
1013                        unset($mod[$seq]->completiongradeitemnumber);
1014                    }
1015                }
1016             }
1017         }
1018     }
1019     return $mod;
1022 /**
1023  * Returns the localised human-readable names of all used modules
1024  *
1025  * @param bool $plural if true returns the plural forms of the names
1026  * @return array where key is the module name (component name without 'mod_') and
1027  *     the value is the human-readable string. Array sorted alphabetically by value
1028  */
1029 function get_module_types_names($plural = false) {
1030     static $modnames = null;
1031     global $DB, $CFG;
1032     if ($modnames === null) {
1033         $modnames = array(0 => array(), 1 => array());
1034         if ($allmods = $DB->get_records("modules")) {
1035             foreach ($allmods as $mod) {
1036                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1037                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1038                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1039                 }
1040             }
1041             core_collator::asort($modnames[0]);
1042             core_collator::asort($modnames[1]);
1043         }
1044     }
1045     return $modnames[(int)$plural];
1048 /**
1049  * Set highlighted section. Only one section can be highlighted at the time.
1050  *
1051  * @param int $courseid course id
1052  * @param int $marker highlight section with this number, 0 means remove higlightin
1053  * @return void
1054  */
1055 function course_set_marker($courseid, $marker) {
1056     global $DB;
1057     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1058     format_base::reset_course_cache($courseid);
1061 /**
1062  * For a given course section, marks it visible or hidden,
1063  * and does the same for every activity in that section
1064  *
1065  * @param int $courseid course id
1066  * @param int $sectionnumber The section number to adjust
1067  * @param int $visibility The new visibility
1068  * @return array A list of resources which were hidden in the section
1069  */
1070 function set_section_visible($courseid, $sectionnumber, $visibility) {
1071     global $DB;
1073     $resourcestotoggle = array();
1074     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1075         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1076         if (!empty($section->sequence)) {
1077             $modules = explode(",", $section->sequence);
1078             foreach ($modules as $moduleid) {
1079                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1080                     if ($visibility) {
1081                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1082                         set_coursemodule_visible($moduleid, $cm->visibleold);
1083                     } else {
1084                         // We hide the section, so we hide the module but we store the original state in visibleold.
1085                         set_coursemodule_visible($moduleid, 0);
1086                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1087                     }
1088                 }
1089             }
1090         }
1091         rebuild_course_cache($courseid, true);
1093         // Determine which modules are visible for AJAX update
1094         if (!empty($modules)) {
1095             list($insql, $params) = $DB->get_in_or_equal($modules);
1096             $select = 'id ' . $insql . ' AND visible = ?';
1097             array_push($params, $visibility);
1098             if (!$visibility) {
1099                 $select .= ' AND visibleold = 1';
1100             }
1101             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1102         }
1103     }
1104     return $resourcestotoggle;
1107 /**
1108  * Retrieve all metadata for the requested modules
1109  *
1110  * @param object $course The Course
1111  * @param array $modnames An array containing the list of modules and their
1112  * names
1113  * @param int $sectionreturn The section to return to
1114  * @return array A list of stdClass objects containing metadata about each
1115  * module
1116  */
1117 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1118     global $CFG, $OUTPUT;
1120     // get_module_metadata will be called once per section on the page and courses may show
1121     // different modules to one another
1122     static $modlist = array();
1123     if (!isset($modlist[$course->id])) {
1124         $modlist[$course->id] = array();
1125     }
1127     $return = array();
1128     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1129     if ($sectionreturn !== null) {
1130         $urlbase->param('sr', $sectionreturn);
1131     }
1132     foreach($modnames as $modname => $modnamestr) {
1133         if (!course_allowed_module($course, $modname)) {
1134             continue;
1135         }
1136         if (isset($modlist[$course->id][$modname])) {
1137             // This module is already cached
1138             $return[$modname] = $modlist[$course->id][$modname];
1139             continue;
1140         }
1142         // Include the module lib
1143         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1144         if (!file_exists($libfile)) {
1145             continue;
1146         }
1147         include_once($libfile);
1149         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1150         $gettypesfunc =  $modname.'_get_types';
1151         if (function_exists($gettypesfunc)) {
1152             $types = $gettypesfunc();
1153             if (is_array($types) && count($types) > 0) {
1154                 $group = new stdClass();
1155                 $group->name = $modname;
1156                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1157                 foreach($types as $type) {
1158                     if ($type->typestr === '--') {
1159                         continue;
1160                     }
1161                     if (strpos($type->typestr, '--') === 0) {
1162                         $group->title = str_replace('--', '', $type->typestr);
1163                         continue;
1164                     }
1165                     // Set the Sub Type metadata
1166                     $subtype = new stdClass();
1167                     $subtype->title = $type->typestr;
1168                     $subtype->type = str_replace('&amp;', '&', $type->type);
1169                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1170                     $subtype->archetype = $type->modclass;
1172                     // The group archetype should match the subtype archetypes and all subtypes
1173                     // should have the same archetype
1174                     $group->archetype = $subtype->archetype;
1176                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1177                         $subtype->help = get_string('help' . $subtype->name, $modname);
1178                     }
1179                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1180                     $group->types[] = $subtype;
1181                 }
1182                 $modlist[$course->id][$modname] = $group;
1183             }
1184         } else {
1185             $module = new stdClass();
1186             $module->title = $modnamestr;
1187             $module->name = $modname;
1188             $module->link = new moodle_url($urlbase, array('add' => $modname));
1189             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1190             $sm = get_string_manager();
1191             if ($sm->string_exists('modulename_help', $modname)) {
1192                 $module->help = get_string('modulename_help', $modname);
1193                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1194                     $link = get_string('modulename_link', $modname);
1195                     $linktext = get_string('morehelp');
1196                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1197                 }
1198             }
1199             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1200             $modlist[$course->id][$modname] = $module;
1201         }
1202         if (isset($modlist[$course->id][$modname])) {
1203             $return[$modname] = $modlist[$course->id][$modname];
1204         } else {
1205             debugging("Invalid module metadata configuration for {$modname}");
1206         }
1207     }
1209     return $return;
1212 /**
1213  * Return the course category context for the category with id $categoryid, except
1214  * that if $categoryid is 0, return the system context.
1215  *
1216  * @param integer $categoryid a category id or 0.
1217  * @return object the corresponding context
1218  */
1219 function get_category_or_system_context($categoryid) {
1220     if ($categoryid) {
1221         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1222     } else {
1223         return context_system::instance();
1224     }
1227 /**
1228  * Returns full course categories trees to be used in html_writer::select()
1229  *
1230  * Calls {@link coursecat::make_categories_list()} to build the tree and
1231  * adds whitespace to denote nesting
1232  *
1233  * @return array array mapping coursecat id to the display name
1234  */
1235 function make_categories_options() {
1236     global $CFG;
1237     require_once($CFG->libdir. '/coursecatlib.php');
1238     $cats = coursecat::make_categories_list('', 0, ' / ');
1239     foreach ($cats as $key => $value) {
1240         // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1241         $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
1242     }
1243     return $cats;
1246 /**
1247  * Print the buttons relating to course requests.
1248  *
1249  * @param object $context current page context.
1250  */
1251 function print_course_request_buttons($context) {
1252     global $CFG, $DB, $OUTPUT;
1253     if (empty($CFG->enablecourserequests)) {
1254         return;
1255     }
1256     if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
1257     /// Print a button to request a new course
1258         echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
1259     }
1260     /// Print a button to manage pending requests
1261     if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
1262         $disabled = !$DB->record_exists('course_request', array());
1263         echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
1264     }
1267 /**
1268  * Does the user have permission to edit things in this category?
1269  *
1270  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1271  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1272  */
1273 function can_edit_in_category($categoryid = 0) {
1274     $context = get_category_or_system_context($categoryid);
1275     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1278 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1280 function add_course_module($mod) {
1281     global $DB;
1283     $mod->added = time();
1284     unset($mod->id);
1286     $cmid = $DB->insert_record("course_modules", $mod);
1287     rebuild_course_cache($mod->course, true);
1288     return $cmid;
1291 /**
1292  * Creates missing course section(s) and rebuilds course cache
1293  *
1294  * @param int|stdClass $courseorid course id or course object
1295  * @param int|array $sections list of relative section numbers to create
1296  * @return bool if there were any sections created
1297  */
1298 function course_create_sections_if_missing($courseorid, $sections) {
1299     global $DB;
1300     if (!is_array($sections)) {
1301         $sections = array($sections);
1302     }
1303     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1304     if (is_object($courseorid)) {
1305         $courseorid = $courseorid->id;
1306     }
1307     $coursechanged = false;
1308     foreach ($sections as $sectionnum) {
1309         if (!in_array($sectionnum, $existing)) {
1310             $cw = new stdClass();
1311             $cw->course   = $courseorid;
1312             $cw->section  = $sectionnum;
1313             $cw->summary  = '';
1314             $cw->summaryformat = FORMAT_HTML;
1315             $cw->sequence = '';
1316             $id = $DB->insert_record("course_sections", $cw);
1317             $coursechanged = true;
1318         }
1319     }
1320     if ($coursechanged) {
1321         rebuild_course_cache($courseorid, true);
1322     }
1323     return $coursechanged;
1326 /**
1327  * Adds an existing module to the section
1328  *
1329  * Updates both tables {course_sections} and {course_modules}
1330  *
1331  * Note: This function does not use modinfo PROVIDED that the section you are
1332  * adding the module to already exists. If the section does not exist, it will
1333  * build modinfo if necessary and create the section.
1334  *
1335  * @param int|stdClass $courseorid course id or course object
1336  * @param int $cmid id of the module already existing in course_modules table
1337  * @param int $sectionnum relative number of the section (field course_sections.section)
1338  *     If section does not exist it will be created
1339  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1340  *     before which the module needs to be included. Null for inserting in the
1341  *     end of the section
1342  * @return int The course_sections ID where the module is inserted
1343  */
1344 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1345     global $DB, $COURSE;
1346     if (is_object($beforemod)) {
1347         $beforemod = $beforemod->id;
1348     }
1349     if (is_object($courseorid)) {
1350         $courseid = $courseorid->id;
1351     } else {
1352         $courseid = $courseorid;
1353     }
1354     // Do not try to use modinfo here, there is no guarantee it is valid!
1355     $section = $DB->get_record('course_sections',
1356             array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
1357     if (!$section) {
1358         // This function call requires modinfo.
1359         course_create_sections_if_missing($courseorid, $sectionnum);
1360         $section = $DB->get_record('course_sections',
1361                 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
1362     }
1364     $modarray = explode(",", trim($section->sequence));
1365     if (empty($section->sequence)) {
1366         $newsequence = "$cmid";
1367     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1368         $insertarray = array($cmid, $beforemod);
1369         array_splice($modarray, $key[0], 1, $insertarray);
1370         $newsequence = implode(",", $modarray);
1371     } else {
1372         $newsequence = "$section->sequence,$cmid";
1373     }
1374     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
1375     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
1376     if (is_object($courseorid)) {
1377         rebuild_course_cache($courseorid->id, true);
1378     } else {
1379         rebuild_course_cache($courseorid, true);
1380     }
1381     return $section->id;     // Return course_sections ID that was used.
1384 function set_coursemodule_groupmode($id, $groupmode) {
1385     global $DB;
1386     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1387     if ($cm->groupmode != $groupmode) {
1388         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1389         rebuild_course_cache($cm->course, true);
1390     }
1391     return ($cm->groupmode != $groupmode);
1394 function set_coursemodule_idnumber($id, $idnumber) {
1395     global $DB;
1396     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1397     if ($cm->idnumber != $idnumber) {
1398         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1399         rebuild_course_cache($cm->course, true);
1400     }
1401     return ($cm->idnumber != $idnumber);
1404 /**
1405  * Set the visibility of a module and inherent properties.
1406  *
1407  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1408  * has been moved to {@link set_section_visible()} which was the only place from which
1409  * the parameter was used.
1410  *
1411  * @param int $id of the module
1412  * @param int $visible state of the module
1413  * @return bool false when the module was not found, true otherwise
1414  */
1415 function set_coursemodule_visible($id, $visible) {
1416     global $DB, $CFG;
1417     require_once($CFG->libdir.'/gradelib.php');
1418     require_once($CFG->dirroot.'/calendar/lib.php');
1420     // Trigger developer's attention when using the previously removed argument.
1421     if (func_num_args() > 2) {
1422         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1423             has been removed.', DEBUG_DEVELOPER);
1424     }
1426     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1427         return false;
1428     }
1430     // Create events and propagate visibility to associated grade items if the value has changed.
1431     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1432     if ($cm->visible == $visible) {
1433         return true;
1434     }
1436     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
1437         return false;
1438     }
1439     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
1440         foreach($events as $event) {
1441             if ($visible) {
1442                 $event = new calendar_event($event);
1443                 $event->toggle_visibility(true);
1444             } else {
1445                 $event = new calendar_event($event);
1446                 $event->toggle_visibility(false);
1447             }
1448         }
1449     }
1451     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1452     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1453     if ($grade_items) {
1454         foreach ($grade_items as $grade_item) {
1455             $grade_item->set_hidden(!$visible);
1456         }
1457     }
1459     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1460     // affect visibleold to allow for an original visibility restore. See set_section_visible().
1461     $cminfo = new stdClass();
1462     $cminfo->id = $id;
1463     $cminfo->visible = $visible;
1464     $cminfo->visibleold = $visible;
1465     $DB->update_record('course_modules', $cminfo);
1467     rebuild_course_cache($cm->course, true);
1468     return true;
1471 /**
1472  * This function will handles the whole deletion process of a module. This includes calling
1473  * the modules delete_instance function, deleting files, events, grades, conditional data,
1474  * the data in the course_module and course_sections table and adding a module deletion
1475  * event to the DB.
1476  *
1477  * @param int $cmid the course module id
1478  * @since 2.5
1479  */
1480 function course_delete_module($cmid) {
1481     global $CFG, $DB, $USER;
1483     require_once($CFG->libdir.'/gradelib.php');
1484     require_once($CFG->dirroot.'/blog/lib.php');
1485     require_once($CFG->dirroot.'/calendar/lib.php');
1487     // Get the course module.
1488     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1489         return true;
1490     }
1492     // Get the module context.
1493     $modcontext = context_module::instance($cm->id);
1495     // Get the course module name.
1496     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1498     // Get the file location of the delete_instance function for this module.
1499     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1501     // Include the file required to call the delete_instance function for this module.
1502     if (file_exists($modlib)) {
1503         require_once($modlib);
1504     } else {
1505         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1506             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1507     }
1509     $deleteinstancefunction = $modulename . '_delete_instance';
1511     // Ensure the delete_instance function exists for this module.
1512     if (!function_exists($deleteinstancefunction)) {
1513         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1514             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1515     }
1517     // Call the delete_instance function, if it returns false throw an exception.
1518     if (!$deleteinstancefunction($cm->instance)) {
1519         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1520             "Cannot delete the module $modulename (instance).");
1521     }
1523     // Remove all module files in case modules forget to do that.
1524     $fs = get_file_storage();
1525     $fs->delete_area_files($modcontext->id);
1527     // Delete events from calendar.
1528     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1529         foreach($events as $event) {
1530             $calendarevent = calendar_event::load($event->id);
1531             $calendarevent->delete();
1532         }
1533     }
1535     // Delete grade items, outcome items and grades attached to modules.
1536     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1537                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1538         foreach ($grade_items as $grade_item) {
1539             $grade_item->delete('moddelete');
1540         }
1541     }
1543     // Delete completion and availability data; it is better to do this even if the
1544     // features are not turned on, in case they were turned on previously (these will be
1545     // very quick on an empty table).
1546     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1547     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
1548     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
1549     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1550                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1552     // Delete the context.
1553     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1555     // Delete the module from the course_modules table.
1556     $DB->delete_records('course_modules', array('id' => $cm->id));
1558     // Delete module from that section.
1559     if (!delete_mod_from_section($cm->id, $cm->section)) {
1560         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1561             "Cannot delete the module $modulename (instance) from section.");
1562     }
1564     // Trigger a mod_deleted event with information about this module.
1565     $eventdata = new stdClass();
1566     $eventdata->modulename = $modulename;
1567     $eventdata->cmid       = $cm->id;
1568     $eventdata->courseid   = $cm->course;
1569     $eventdata->userid     = $USER->id;
1570     events_trigger('mod_deleted', $eventdata);
1572     add_to_log($cm->course, 'course', "delete mod",
1573                "view.php?id=$cm->course",
1574                "$modulename $cm->instance", $cm->id);
1576     rebuild_course_cache($cm->course, true);
1579 function delete_mod_from_section($modid, $sectionid) {
1580     global $DB;
1582     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1584         $modarray = explode(",", $section->sequence);
1586         if ($key = array_keys ($modarray, $modid)) {
1587             array_splice($modarray, $key[0], 1);
1588             $newsequence = implode(",", $modarray);
1589             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1590             rebuild_course_cache($section->course, true);
1591             return true;
1592         } else {
1593             return false;
1594         }
1596     }
1597     return false;
1600 /**
1601  * Moves a section within a course, from a position to another.
1602  * Be very careful: $section and $destination refer to section number,
1603  * not id!.
1604  *
1605  * @param object $course
1606  * @param int $section Section number (not id!!!)
1607  * @param int $destination
1608  * @return boolean Result
1609  */
1610 function move_section_to($course, $section, $destination) {
1611 /// Moves a whole course section up and down within the course
1612     global $USER, $DB;
1614     if (!$destination && $destination != 0) {
1615         return true;
1616     }
1618     // compartibility with course formats using field 'numsections'
1619     $courseformatoptions = course_get_format($course)->get_format_options();
1620     if ((array_key_exists('numsections', $courseformatoptions) &&
1621             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1622         return false;
1623     }
1625     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1626     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1627             'section ASC, id ASC', 'id, section')) {
1628         return false;
1629     }
1631     $movedsections = reorder_sections($sections, $section, $destination);
1633     // Update all sections. Do this in 2 steps to avoid breaking database
1634     // uniqueness constraint
1635     $transaction = $DB->start_delegated_transaction();
1636     foreach ($movedsections as $id => $position) {
1637         if ($sections[$id] !== $position) {
1638             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1639         }
1640     }
1641     foreach ($movedsections as $id => $position) {
1642         if ($sections[$id] !== $position) {
1643             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1644         }
1645     }
1647     // If we move the highlighted section itself, then just highlight the destination.
1648     // Adjust the higlighted section location if we move something over it either direction.
1649     if ($section == $course->marker) {
1650         course_set_marker($course->id, $destination);
1651     } elseif ($section > $course->marker && $course->marker >= $destination) {
1652         course_set_marker($course->id, $course->marker+1);
1653     } elseif ($section < $course->marker && $course->marker <= $destination) {
1654         course_set_marker($course->id, $course->marker-1);
1655     }
1657     $transaction->allow_commit();
1658     rebuild_course_cache($course->id, true);
1659     return true;
1662 /**
1663  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1664  * an original position number and a target position number, rebuilds the array so that the
1665  * move is made without any duplication of section positions.
1666  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1667  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1668  *
1669  * @param array $sections
1670  * @param int $origin_position
1671  * @param int $target_position
1672  * @return array
1673  */
1674 function reorder_sections($sections, $origin_position, $target_position) {
1675     if (!is_array($sections)) {
1676         return false;
1677     }
1679     // We can't move section position 0
1680     if ($origin_position < 1) {
1681         echo "We can't move section position 0";
1682         return false;
1683     }
1685     // Locate origin section in sections array
1686     if (!$origin_key = array_search($origin_position, $sections)) {
1687         echo "searched position not in sections array";
1688         return false; // searched position not in sections array
1689     }
1691     // Extract origin section
1692     $origin_section = $sections[$origin_key];
1693     unset($sections[$origin_key]);
1695     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1696     $found = false;
1697     $append_array = array();
1698     foreach ($sections as $id => $position) {
1699         if ($found) {
1700             $append_array[$id] = $position;
1701             unset($sections[$id]);
1702         }
1703         if ($position == $target_position) {
1704             if ($target_position < $origin_position) {
1705                 $append_array[$id] = $position;
1706                 unset($sections[$id]);
1707             }
1708             $found = true;
1709         }
1710     }
1712     // Append moved section
1713     $sections[$origin_key] = $origin_section;
1715     // Append rest of array (if applicable)
1716     if (!empty($append_array)) {
1717         foreach ($append_array as $id => $position) {
1718             $sections[$id] = $position;
1719         }
1720     }
1722     // Renumber positions
1723     $position = 0;
1724     foreach ($sections as $id => $p) {
1725         $sections[$id] = $position;
1726         $position++;
1727     }
1729     return $sections;
1733 /**
1734  * Move the module object $mod to the specified $section
1735  * If $beforemod exists then that is the module
1736  * before which $modid should be inserted
1737  * All parameters are objects
1738  */
1739 function moveto_module($mod, $section, $beforemod=NULL) {
1740     global $OUTPUT, $DB;
1742 /// Remove original module from original section
1743     if (! delete_mod_from_section($mod->id, $mod->section)) {
1744         echo $OUTPUT->notification("Could not delete module from existing section");
1745     }
1747     // if moving to a hidden section then hide module
1748     if ($mod->section != $section->id) {
1749         if (!$section->visible && $mod->visible) {
1750             // Set this in the object because it is sent as a response to ajax calls.
1751             $mod->visible = 0;
1752             set_coursemodule_visible($mod->id, 0);
1753             // Set visibleold to 1 so module will be visible when section is made visible.
1754             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1755         }
1756         if ($section->visible && !$mod->visible) {
1757             set_coursemodule_visible($mod->id, $mod->visibleold);
1758             // Set this in the object because it is sent as a response to ajax calls.
1759             $mod->visible = $mod->visibleold;
1760         }
1761     }
1763 /// Add the module into the new section
1764     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
1765     return true;
1768 /**
1769  * Returns the list of all editing actions that current user can perform on the module
1770  *
1771  * @param cm_info $mod The module to produce editing buttons for
1772  * @param int $indent The current indenting (default -1 means no move left-right actions)
1773  * @param int $sr The section to link back to (used for creating the links)
1774  * @return array array of action_link or pix_icon objects
1775  */
1776 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
1777     global $COURSE, $SITE;
1779     static $str;
1781     $coursecontext = context_course::instance($mod->course);
1782     $modcontext = context_module::instance($mod->id);
1784     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1785     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1787     // No permission to edit anything.
1788     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1789         return array();
1790     }
1792     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1794     if (!isset($str)) {
1795         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1796             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
1797         $str->assign         = get_string('assignroles', 'role');
1798         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1799         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1800         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1801         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
1802         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
1803         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
1804     }
1806     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1808     if ($sr !== null) {
1809         $baseurl->param('sr', $sr);
1810     }
1811     $actions = array();
1813     // AJAX edit title.
1814     if ($mod->has_view() && $hasmanageactivities &&
1815                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
1816                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
1817         // we will not display link if we are on some other-course page (where we should not see this module anyway)
1818         $actions['title'] = new action_menu_link_secondary(
1819             new moodle_url($baseurl, array('update' => $mod->id)),
1820             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
1821             $str->edittitle,
1822             array('class' => 'editing_title', 'data-action' => 'edittitle')
1823         );
1824     }
1826     // Indent.
1827     if ($hasmanageactivities) {
1828         if (right_to_left()) {   // Exchange arrows on RTL
1829             $rightarrow = 't/left';
1830             $leftarrow  = 't/right';
1831         } else {
1832             $rightarrow = 't/right';
1833             $leftarrow  = 't/left';
1834         }
1836         $hiddenclass = 'hidden';
1837         if ($indent > 0) {
1838             $hiddenclass = '';
1839         }
1840         $actions['moveleft'] = new action_menu_link_secondary(
1841             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
1842             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1843             $str->moveleft,
1844             array('class' => 'editing_moveleft ' . $hiddenclass, 'data-action' => 'moveleft')
1845         );
1846         $hiddenclass = 'hidden';
1847         if ($indent >= 0) {
1848             $hiddenclass = '';
1849         }
1850         $actions['moveright'] = new action_menu_link_secondary(
1851             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
1852             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1853             $str->moveright,
1854             array('class' => 'editing_moveright ' . $hiddenclass, 'data-action' => 'moveright')
1855         );
1856     }
1858     // Move.
1859     if ($hasmanageactivities) {
1860         $actions['move'] = new action_menu_link_primary(
1861             new moodle_url($baseurl, array('copy' => $mod->id)),
1862             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1863             $str->move,
1864             array('class' => 'editing_move status', 'data-action' => 'move')
1865         );
1866     }
1868     // Update.
1869     if ($hasmanageactivities) {
1870         $actions['update'] = new action_menu_link_secondary(
1871             new moodle_url($baseurl, array('update' => $mod->id)),
1872             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1873             $str->update,
1874             array('class' => 'editing_update', 'data-action' => 'update')
1875         );
1876     }
1878     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1879     // Note that restoring on front page is never allowed.
1880     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
1881             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
1882         $actions['duplicate'] = new action_menu_link_secondary(
1883             new moodle_url($baseurl, array('duplicate' => $mod->id)),
1884             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1885             $str->duplicate,
1886             array('class' => 'editing_duplicate', 'data-action' => 'duplicate')
1887         );
1888     }
1890     // Delete.
1891     if ($hasmanageactivities) {
1892         $actions['delete'] = new action_menu_link_secondary(
1893             new moodle_url($baseurl, array('delete' => $mod->id)),
1894             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1895             $str->delete,
1896             array('class' => 'editing_delete', 'data-action' => 'delete')
1897         );
1898     }
1900     // Hide/Show.
1901     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1902         if ($mod->visible) {
1903             $actions['hide'] = new action_menu_link_primary(
1904                 new moodle_url($baseurl, array('hide' => $mod->id)),
1905                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1906                 $str->hide,
1907                 array('class' => 'editing_hide', 'data-action' => 'hide')
1908             );
1909         } else {
1910             $actions['show'] = new action_menu_link_primary(
1911                 new moodle_url($baseurl, array('show' => $mod->id)),
1912                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1913                 $str->show,
1914                 array('class' => 'editing_show', 'data-action' => 'show')
1915             );
1916         }
1917     }
1919     // Groupmode.
1920     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1921         if ($mod->coursegroupmodeforce) {
1922             $modgroupmode = $mod->coursegroupmode;
1923         } else {
1924             $modgroupmode = $mod->groupmode;
1925         }
1926         if ($modgroupmode == SEPARATEGROUPS) {
1927             $nextgroupmode = VISIBLEGROUPS;
1928             $grouptitle = $str->groupsseparate;
1929             $forcedgrouptitle = $str->forcedgroupsseparate;
1930             $actionname = 'groupsseparate';
1931             $groupimage = 't/groups';
1932         } else if ($modgroupmode == VISIBLEGROUPS) {
1933             $nextgroupmode = NOGROUPS;
1934             $grouptitle = $str->groupsvisible;
1935             $forcedgrouptitle = $str->forcedgroupsvisible;
1936             $actionname = 'groupsvisible';
1937             $groupimage = 't/groupv';
1938         } else {
1939             $nextgroupmode = SEPARATEGROUPS;
1940             $grouptitle = $str->groupsnone;
1941             $forcedgrouptitle = $str->forcedgroupsnone;
1942             $actionname = 'groupsnone';
1943             $groupimage = 't/groupn';
1944         }
1945         if (!$mod->coursegroupmodeforce) {
1946             $actions[$actionname] = new action_menu_link_primary(
1947                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
1948                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1949                 $grouptitle,
1950                 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode)
1951             );
1952         } else {
1953             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('class' => 'iconsmall'));
1954         }
1955     }
1957     // Assign.
1958     if (has_capability('moodle/role:assign', $modcontext)){
1959         $actions['assign'] = new action_menu_link_secondary(
1960             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
1961             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1962             $str->assign,
1963             array('class' => 'editing_assign', 'data-action' => 'assignroles')
1964         );
1965     }
1967     return $actions;
1970 /**
1971  * given a course object with shortname & fullname, this function will
1972  * truncate the the number of chars allowed and add ... if it was too long
1973  */
1974 function course_format_name ($course,$max=100) {
1976     $context = context_course::instance($course->id);
1977     $shortname = format_string($course->shortname, true, array('context' => $context));
1978     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
1979     $str = $shortname.': '. $fullname;
1980     if (core_text::strlen($str) <= $max) {
1981         return $str;
1982     }
1983     else {
1984         return core_text::substr($str,0,$max-3).'...';
1985     }
1988 /**
1989  * Is the user allowed to add this type of module to this course?
1990  * @param object $course the course settings. Only $course->id is used.
1991  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
1992  * @return bool whether the current user is allowed to add this type of module to this course.
1993  */
1994 function course_allowed_module($course, $modname) {
1995     if (is_numeric($modname)) {
1996         throw new coding_exception('Function course_allowed_module no longer
1997                 supports numeric module ids. Please update your code to pass the module name.');
1998     }
2000     $capability = 'mod/' . $modname . ':addinstance';
2001     if (!get_capability_info($capability)) {
2002         // Debug warning that the capability does not exist, but no more than once per page.
2003         static $warned = array();
2004         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2005         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2006             debugging('The module ' . $modname . ' does not define the standard capability ' .
2007                     $capability , DEBUG_DEVELOPER);
2008             $warned[$modname] = 1;
2009         }
2011         // If the capability does not exist, the module can always be added.
2012         return true;
2013     }
2015     $coursecontext = context_course::instance($course->id);
2016     return has_capability($capability, $coursecontext);
2019 /**
2020  * Efficiently moves many courses around while maintaining
2021  * sortorder in order.
2022  *
2023  * @param array $courseids is an array of course ids
2024  * @param int $categoryid
2025  * @return bool success
2026  */
2027 function move_courses($courseids, $categoryid) {
2028     global $DB;
2030     if (empty($courseids)) {
2031         // Nothing to do.
2032         return;
2033     }
2035     if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
2036         return false;
2037     }
2039     $courseids = array_reverse($courseids);
2040     $newparent = context_coursecat::instance($category->id);
2041     $i = 1;
2043     foreach ($courseids as $courseid) {
2044         if ($dbcourse = $DB->get_record('course', array('id' => $courseid))) {
2045             $course = new stdClass();
2046             $course->id = $courseid;
2047             $course->category  = $category->id;
2048             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2049             if ($category->visible == 0) {
2050                 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2051                 // to previous state if somebody unhides the category.
2052                 $course->visible = 0;
2053             }
2055             $DB->update_record('course', $course);
2057             // Store the context.
2058             $context = context_course::instance($course->id);
2060             // Update the course object we are passing to the event.
2061             $dbcourse->category = $course->category;
2062             $dbcourse->sortorder = $course->sortorder;
2064             // Trigger a course updated event.
2065             $event = \core\event\course_updated::create(array(
2066                 'objectid' => $course->id,
2067                 'context' => $context,
2068                 'other' => array('shortname' => $dbcourse->shortname,
2069                                  'fullname' => $dbcourse->fullname)
2070             ));
2071             $event->add_record_snapshot('course', $dbcourse);
2072             $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2073             $event->trigger();
2075             $context->update_moved($newparent);
2076         }
2077     }
2078     fix_course_sortorder();
2079     cache_helper::purge_by_event('changesincourse');
2081     return true;
2084 /**
2085  * Returns the display name of the given section that the course prefers
2086  *
2087  * Implementation of this function is provided by course format
2088  * @see format_base::get_section_name()
2089  *
2090  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2091  * @param int|stdClass $section Section object from database or just field course_sections.section
2092  * @return string Display name that the course format prefers, e.g. "Week 2"
2093  */
2094 function get_section_name($courseorid, $section) {
2095     return course_get_format($courseorid)->get_section_name($section);
2098 /**
2099  * Tells if current course format uses sections
2100  *
2101  * @param string $format Course format ID e.g. 'weeks' $course->format
2102  * @return bool
2103  */
2104 function course_format_uses_sections($format) {
2105     $course = new stdClass();
2106     $course->format = $format;
2107     return course_get_format($course)->uses_sections();
2110 /**
2111  * Returns the information about the ajax support in the given source format
2112  *
2113  * The returned object's property (boolean)capable indicates that
2114  * the course format supports Moodle course ajax features.
2115  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
2116  *
2117  * @param string $format
2118  * @return stdClass
2119  */
2120 function course_format_ajax_support($format) {
2121     $course = new stdClass();
2122     $course->format = $format;
2123     return course_get_format($course)->supports_ajax();
2126 /**
2127  * Can the current user delete this course?
2128  * Course creators have exception,
2129  * 1 day after the creation they can sill delete the course.
2130  * @param int $courseid
2131  * @return boolean
2132  */
2133 function can_delete_course($courseid) {
2134     global $USER, $DB;
2136     $context = context_course::instance($courseid);
2138     if (has_capability('moodle/course:delete', $context)) {
2139         return true;
2140     }
2142     // hack: now try to find out if creator created this course recently (1 day)
2143     if (!has_capability('moodle/course:create', $context)) {
2144         return false;
2145     }
2147     $since = time() - 60*60*24;
2149     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
2150     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
2152     return $DB->record_exists_select('log', $select, $params);
2155 /**
2156  * Save the Your name for 'Some role' strings.
2157  *
2158  * @param integer $courseid the id of this course.
2159  * @param array $data the data that came from the course settings form.
2160  */
2161 function save_local_role_names($courseid, $data) {
2162     global $DB;
2163     $context = context_course::instance($courseid);
2165     foreach ($data as $fieldname => $value) {
2166         if (strpos($fieldname, 'role_') !== 0) {
2167             continue;
2168         }
2169         list($ignored, $roleid) = explode('_', $fieldname);
2171         // make up our mind whether we want to delete, update or insert
2172         if (!$value) {
2173             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2175         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2176             $rolename->name = $value;
2177             $DB->update_record('role_names', $rolename);
2179         } else {
2180             $rolename = new stdClass;
2181             $rolename->contextid = $context->id;
2182             $rolename->roleid = $roleid;
2183             $rolename->name = $value;
2184             $DB->insert_record('role_names', $rolename);
2185         }
2186     }
2189 /**
2190  * Returns options to use in course overviewfiles filemanager
2191  *
2192  * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2193  *     may be empty if course does not exist yet (course create form)
2194  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2195  *     or null if overviewfiles are disabled
2196  */
2197 function course_overviewfiles_options($course) {
2198     global $CFG;
2199     if (empty($CFG->courseoverviewfileslimit)) {
2200         return null;
2201     }
2202     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2203     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2204         $accepted_types = '*';
2205     } else {
2206         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2207         // Make sure extensions are prefixed with dot unless they are valid typegroups
2208         foreach ($accepted_types as $i => $type) {
2209             if (substr($type, 0, 1) !== '.') {
2210                 require_once($CFG->libdir. '/filelib.php');
2211                 if (!count(file_get_typegroup('extension', $type))) {
2212                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2213                     $accepted_types[$i] = '.'. $type;
2214                     $corrected = true;
2215                 }
2216             }
2217         }
2218         if (!empty($corrected)) {
2219             set_config('courseoverviewfilesext', join(',', $accepted_types));
2220         }
2221     }
2222     $options = array(
2223         'maxfiles' => $CFG->courseoverviewfileslimit,
2224         'maxbytes' => $CFG->maxbytes,
2225         'subdirs' => 0,
2226         'accepted_types' => $accepted_types
2227     );
2228     if (!empty($course->id)) {
2229         $options['context'] = context_course::instance($course->id);
2230     } else if (is_int($course) && $course > 0) {
2231         $options['context'] = context_course::instance($course);
2232     }
2233     return $options;
2236 /**
2237  * Create a course and either return a $course object
2238  *
2239  * Please note this functions does not verify any access control,
2240  * the calling code is responsible for all validation (usually it is the form definition).
2241  *
2242  * @param array $editoroptions course description editor options
2243  * @param object $data  - all the data needed for an entry in the 'course' table
2244  * @return object new course instance
2245  */
2246 function create_course($data, $editoroptions = NULL) {
2247     global $DB;
2249     //check the categoryid - must be given for all new courses
2250     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2252     //check if the shortname already exist
2253     if (!empty($data->shortname)) {
2254         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2255             throw new moodle_exception('shortnametaken');
2256         }
2257     }
2259     //check if the id number already exist
2260     if (!empty($data->idnumber)) {
2261         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2262             throw new moodle_exception('idnumbertaken');
2263         }
2264     }
2266     $data->timecreated  = time();
2267     $data->timemodified = $data->timecreated;
2269     // place at beginning of any category
2270     $data->sortorder = 0;
2272     if ($editoroptions) {
2273         // summary text is updated later, we need context to store the files first
2274         $data->summary = '';
2275         $data->summary_format = FORMAT_HTML;
2276     }
2278     if (!isset($data->visible)) {
2279         // data not from form, add missing visibility info
2280         $data->visible = $category->visible;
2281     }
2282     $data->visibleold = $data->visible;
2284     $newcourseid = $DB->insert_record('course', $data);
2285     $context = context_course::instance($newcourseid, MUST_EXIST);
2287     if ($editoroptions) {
2288         // Save the files used in the summary editor and store
2289         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2290         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2291         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2292     }
2293     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2294         // Save the course overviewfiles
2295         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2296     }
2298     // update course format options
2299     course_get_format($newcourseid)->update_course_format_options($data);
2301     $course = course_get_format($newcourseid)->get_course();
2303     // Setup the blocks
2304     blocks_add_default_course_blocks($course);
2306     // Create a default section.
2307     course_create_sections_if_missing($course, 0);
2309     fix_course_sortorder();
2310     // purge appropriate caches in case fix_course_sortorder() did not change anything
2311     cache_helper::purge_by_event('changesincourse');
2313     // new context created - better mark it as dirty
2314     $context->mark_dirty();
2316     // Save any custom role names.
2317     save_local_role_names($course->id, (array)$data);
2319     // set up enrolments
2320     enrol_course_updated(true, $course, $data);
2322     // Trigger a course created event.
2323     $event = \core\event\course_created::create(array(
2324         'objectid' => $course->id,
2325         'context' => context_course::instance($course->id),
2326         'other' => array('shortname' => $course->shortname,
2327                          'fullname' => $course->fullname)
2328     ));
2329     $event->add_record_snapshot('course', $course);
2330     $event->trigger();
2332     return $course;
2335 /**
2336  * Update a course.
2337  *
2338  * Please note this functions does not verify any access control,
2339  * the calling code is responsible for all validation (usually it is the form definition).
2340  *
2341  * @param object $data  - all the data needed for an entry in the 'course' table
2342  * @param array $editoroptions course description editor options
2343  * @return void
2344  */
2345 function update_course($data, $editoroptions = NULL) {
2346     global $DB;
2348     $data->timemodified = time();
2350     $oldcourse = course_get_format($data->id)->get_course();
2351     $context   = context_course::instance($oldcourse->id);
2353     if ($editoroptions) {
2354         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2355     }
2356     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2357         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2358     }
2360     if (!isset($data->category) or empty($data->category)) {
2361         // prevent nulls and 0 in category field
2362         unset($data->category);
2363     }
2364     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2366     if (!isset($data->visible)) {
2367         // data not from form, add missing visibility info
2368         $data->visible = $oldcourse->visible;
2369     }
2371     if ($data->visible != $oldcourse->visible) {
2372         // reset the visibleold flag when manually hiding/unhiding course
2373         $data->visibleold = $data->visible;
2374         $changesincoursecat = true;
2375     } else {
2376         if ($movecat) {
2377             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2378             if (empty($newcategory->visible)) {
2379                 // make sure when moving into hidden category the course is hidden automatically
2380                 $data->visible = 0;
2381             }
2382         }
2383     }
2385     // Update with the new data
2386     $DB->update_record('course', $data);
2387     // make sure the modinfo cache is reset
2388     rebuild_course_cache($data->id);
2390     // update course format options with full course data
2391     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2393     $course = $DB->get_record('course', array('id'=>$data->id));
2395     if ($movecat) {
2396         $newparent = context_coursecat::instance($course->category);
2397         $context->update_moved($newparent);
2398     }
2400     fix_course_sortorder();
2401     // purge appropriate caches in case fix_course_sortorder() did not change anything
2402     cache_helper::purge_by_event('changesincourse');
2403     if ($changesincoursecat) {
2404         cache_helper::purge_by_event('changesincoursecat');
2405     }
2407     // Test for and remove blocks which aren't appropriate anymore
2408     blocks_remove_inappropriate($course);
2410     // Save any custom role names.
2411     save_local_role_names($course->id, $data);
2413     // update enrol settings
2414     enrol_course_updated(false, $course, $data);
2416     // Trigger a course updated event.
2417     $event = \core\event\course_updated::create(array(
2418         'objectid' => $course->id,
2419         'context' => $context,
2420         'other' => array('shortname' => $course->shortname,
2421                          'fullname' => $course->fullname)
2422     ));
2423     $event->add_record_snapshot('course', $course);
2424     $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
2425     $event->trigger();
2427     if ($oldcourse->format !== $course->format) {
2428         // Remove all options stored for the previous format
2429         // We assume that new course format migrated everything it needed watching trigger
2430         // 'course_updated' and in method format_XXX::update_course_format_options()
2431         $DB->delete_records('course_format_options',
2432                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2433     }
2436 /**
2437  * Average number of participants
2438  * @return integer
2439  */
2440 function average_number_of_participants() {
2441     global $DB, $SITE;
2443     //count total of enrolments for visible course (except front page)
2444     $sql = 'SELECT COUNT(*) FROM (
2445         SELECT DISTINCT ue.userid, e.courseid
2446         FROM {user_enrolments} ue, {enrol} e, {course} c
2447         WHERE ue.enrolid = e.id
2448             AND e.courseid <> :siteid
2449             AND c.id = e.courseid
2450             AND c.visible = 1) total';
2451     $params = array('siteid' => $SITE->id);
2452     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2455     //count total of visible courses (minus front page)
2456     $coursetotal = $DB->count_records('course', array('visible' => 1));
2457     $coursetotal = $coursetotal - 1 ;
2459     //average of enrolment
2460     if (empty($coursetotal)) {
2461         $participantaverage = 0;
2462     } else {
2463         $participantaverage = $enrolmenttotal / $coursetotal;
2464     }
2466     return $participantaverage;
2469 /**
2470  * Average number of course modules
2471  * @return integer
2472  */
2473 function average_number_of_courses_modules() {
2474     global $DB, $SITE;
2476     //count total of visible course module (except front page)
2477     $sql = 'SELECT COUNT(*) FROM (
2478         SELECT cm.course, cm.module
2479         FROM {course} c, {course_modules} cm
2480         WHERE c.id = cm.course
2481             AND c.id <> :siteid
2482             AND cm.visible = 1
2483             AND c.visible = 1) total';
2484     $params = array('siteid' => $SITE->id);
2485     $moduletotal = $DB->count_records_sql($sql, $params);
2488     //count total of visible courses (minus front page)
2489     $coursetotal = $DB->count_records('course', array('visible' => 1));
2490     $coursetotal = $coursetotal - 1 ;
2492     //average of course module
2493     if (empty($coursetotal)) {
2494         $coursemoduleaverage = 0;
2495     } else {
2496         $coursemoduleaverage = $moduletotal / $coursetotal;
2497     }
2499     return $coursemoduleaverage;
2502 /**
2503  * This class pertains to course requests and contains methods associated with
2504  * create, approving, and removing course requests.
2505  *
2506  * Please note we do not allow embedded images here because there is no context
2507  * to store them with proper access control.
2508  *
2509  * @copyright 2009 Sam Hemelryk
2510  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2511  * @since Moodle 2.0
2512  *
2513  * @property-read int $id
2514  * @property-read string $fullname
2515  * @property-read string $shortname
2516  * @property-read string $summary
2517  * @property-read int $summaryformat
2518  * @property-read int $summarytrust
2519  * @property-read string $reason
2520  * @property-read int $requester
2521  */
2522 class course_request {
2524     /**
2525      * This is the stdClass that stores the properties for the course request
2526      * and is externally accessed through the __get magic method
2527      * @var stdClass
2528      */
2529     protected $properties;
2531     /**
2532      * An array of options for the summary editor used by course request forms.
2533      * This is initially set by {@link summary_editor_options()}
2534      * @var array
2535      * @static
2536      */
2537     protected static $summaryeditoroptions;
2539     /**
2540      * Static function to prepare the summary editor for working with a course
2541      * request.
2542      *
2543      * @static
2544      * @param null|stdClass $data Optional, an object containing the default values
2545      *                       for the form, these may be modified when preparing the
2546      *                       editor so this should be called before creating the form
2547      * @return stdClass An object that can be used to set the default values for
2548      *                   an mforms form
2549      */
2550     public static function prepare($data=null) {
2551         if ($data === null) {
2552             $data = new stdClass;
2553         }
2554         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2555         return $data;
2556     }
2558     /**
2559      * Static function to create a new course request when passed an array of properties
2560      * for it.
2561      *
2562      * This function also handles saving any files that may have been used in the editor
2563      *
2564      * @static
2565      * @param stdClass $data
2566      * @return course_request The newly created course request
2567      */
2568     public static function create($data) {
2569         global $USER, $DB, $CFG;
2570         $data->requester = $USER->id;
2572         // Setting the default category if none set.
2573         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2574             $data->category = $CFG->defaultrequestcategory;
2575         }
2577         // Summary is a required field so copy the text over
2578         $data->summary       = $data->summary_editor['text'];
2579         $data->summaryformat = $data->summary_editor['format'];
2581         $data->id = $DB->insert_record('course_request', $data);
2583         // Create a new course_request object and return it
2584         $request = new course_request($data);
2586         // Notify the admin if required.
2587         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2589             $a = new stdClass;
2590             $a->link = "$CFG->wwwroot/course/pending.php";
2591             $a->user = fullname($USER);
2592             $subject = get_string('courserequest');
2593             $message = get_string('courserequestnotifyemail', 'admin', $a);
2594             foreach ($users as $user) {
2595                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2596             }
2597         }
2599         return $request;
2600     }
2602     /**
2603      * Returns an array of options to use with a summary editor
2604      *
2605      * @uses course_request::$summaryeditoroptions
2606      * @return array An array of options to use with the editor
2607      */
2608     public static function summary_editor_options() {
2609         global $CFG;
2610         if (self::$summaryeditoroptions === null) {
2611             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2612         }
2613         return self::$summaryeditoroptions;
2614     }
2616     /**
2617      * Loads the properties for this course request object. Id is required and if
2618      * only id is provided then we load the rest of the properties from the database
2619      *
2620      * @param stdClass|int $properties Either an object containing properties
2621      *                      or the course_request id to load
2622      */
2623     public function __construct($properties) {
2624         global $DB;
2625         if (empty($properties->id)) {
2626             if (empty($properties)) {
2627                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2628             }
2629             $id = $properties;
2630             $properties = new stdClass;
2631             $properties->id = (int)$id;
2632             unset($id);
2633         }
2634         if (empty($properties->requester)) {
2635             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2636                 print_error('unknowncourserequest');
2637             }
2638         } else {
2639             $this->properties = $properties;
2640         }
2641         $this->properties->collision = null;
2642     }
2644     /**
2645      * Returns the requested property
2646      *
2647      * @param string $key
2648      * @return mixed
2649      */
2650     public function __get($key) {
2651         return $this->properties->$key;
2652     }
2654     /**
2655      * Override this to ensure empty($request->blah) calls return a reliable answer...
2656      *
2657      * This is required because we define the __get method
2658      *
2659      * @param mixed $key
2660      * @return bool True is it not empty, false otherwise
2661      */
2662     public function __isset($key) {
2663         return (!empty($this->properties->$key));
2664     }
2666     /**
2667      * Returns the user who requested this course
2668      *
2669      * Uses a static var to cache the results and cut down the number of db queries
2670      *
2671      * @staticvar array $requesters An array of cached users
2672      * @return stdClass The user who requested the course
2673      */
2674     public function get_requester() {
2675         global $DB;
2676         static $requesters= array();
2677         if (!array_key_exists($this->properties->requester, $requesters)) {
2678             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
2679         }
2680         return $requesters[$this->properties->requester];
2681     }
2683     /**
2684      * Checks that the shortname used by the course does not conflict with any other
2685      * courses that exist
2686      *
2687      * @param string|null $shortnamemark The string to append to the requests shortname
2688      *                     should a conflict be found
2689      * @return bool true is there is a conflict, false otherwise
2690      */
2691     public function check_shortname_collision($shortnamemark = '[*]') {
2692         global $DB;
2694         if ($this->properties->collision !== null) {
2695             return $this->properties->collision;
2696         }
2698         if (empty($this->properties->shortname)) {
2699             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
2700             $this->properties->collision = false;
2701         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
2702             if (!empty($shortnamemark)) {
2703                 $this->properties->shortname .= ' '.$shortnamemark;
2704             }
2705             $this->properties->collision = true;
2706         } else {
2707             $this->properties->collision = false;
2708         }
2709         return $this->properties->collision;
2710     }
2712     /**
2713      * Returns the category where this course request should be created
2714      *
2715      * Note that we don't check here that user has a capability to view
2716      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2717      * 'moodle/course:changecategory'
2718      *
2719      * @return coursecat
2720      */
2721     public function get_category() {
2722         global $CFG;
2723         require_once($CFG->libdir.'/coursecatlib.php');
2724         // If the category is not set, if the current user does not have the rights to change the category, or if the
2725         // category does not exist, we set the default category to the course to be approved.
2726         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2727         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
2728                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
2729             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
2730         }
2731         if (!$category) {
2732             $category = coursecat::get_default();
2733         }
2734         return $category;
2735     }
2737     /**
2738      * This function approves the request turning it into a course
2739      *
2740      * This function converts the course request into a course, at the same time
2741      * transferring any files used in the summary to the new course and then removing
2742      * the course request and the files associated with it.
2743      *
2744      * @return int The id of the course that was created from this request
2745      */
2746     public function approve() {
2747         global $CFG, $DB, $USER;
2749         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
2751         $courseconfig = get_config('moodlecourse');
2753         // Transfer appropriate settings
2754         $data = clone($this->properties);
2755         unset($data->id);
2756         unset($data->reason);
2757         unset($data->requester);
2759         // Set category
2760         $category = $this->get_category();
2761         $data->category = $category->id;
2762         // Set misc settings
2763         $data->requested = 1;
2765         // Apply course default settings
2766         $data->format             = $courseconfig->format;
2767         $data->newsitems          = $courseconfig->newsitems;
2768         $data->showgrades         = $courseconfig->showgrades;
2769         $data->showreports        = $courseconfig->showreports;
2770         $data->maxbytes           = $courseconfig->maxbytes;
2771         $data->groupmode          = $courseconfig->groupmode;
2772         $data->groupmodeforce     = $courseconfig->groupmodeforce;
2773         $data->visible            = $courseconfig->visible;
2774         $data->visibleold         = $data->visible;
2775         $data->lang               = $courseconfig->lang;
2777         $course = create_course($data);
2778         $context = context_course::instance($course->id, MUST_EXIST);
2780         // add enrol instances
2781         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
2782             if ($manual = enrol_get_plugin('manual')) {
2783                 $manual->add_default_instance($course);
2784             }
2785         }
2787         // enrol the requester as teacher if necessary
2788         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2789             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
2790         }
2792         $this->delete();
2794         $a = new stdClass();
2795         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2796         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
2797         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
2799         return $course->id;
2800     }
2802     /**
2803      * Reject a course request
2804      *
2805      * This function rejects a course request, emailing the requesting user the
2806      * provided notice and then removing the request from the database
2807      *
2808      * @param string $notice The message to display to the user
2809      */
2810     public function reject($notice) {
2811         global $USER, $DB;
2812         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
2813         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
2814         $this->delete();
2815     }
2817     /**
2818      * Deletes the course request and any associated files
2819      */
2820     public function delete() {
2821         global $DB;
2822         $DB->delete_records('course_request', array('id' => $this->properties->id));
2823     }
2825     /**
2826      * Send a message from one user to another using events_trigger
2827      *
2828      * @param object $touser
2829      * @param object $fromuser
2830      * @param string $name
2831      * @param string $subject
2832      * @param string $message
2833      */
2834     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
2835         $eventdata = new stdClass();
2836         $eventdata->component         = 'moodle';
2837         $eventdata->name              = $name;
2838         $eventdata->userfrom          = $fromuser;
2839         $eventdata->userto            = $touser;
2840         $eventdata->subject           = $subject;
2841         $eventdata->fullmessage       = $message;
2842         $eventdata->fullmessageformat = FORMAT_PLAIN;
2843         $eventdata->fullmessagehtml   = '';
2844         $eventdata->smallmessage      = '';
2845         $eventdata->notification      = 1;
2846         message_send($eventdata);
2847     }
2850 /**
2851  * Return a list of page types
2852  * @param string $pagetype current page type
2853  * @param context $parentcontext Block's parent context
2854  * @param context $currentcontext Current context of block
2855  * @return array array of page types
2856  */
2857 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
2858     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
2859         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
2860         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2861             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
2862         );
2863     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
2864         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
2865         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
2866     } else {
2867         // Otherwise consider it a page inside a course even if $currentcontext is null
2868         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2869             'course-*' => get_string('page-course-x', 'pagetype'),
2870             'course-view-*' => get_string('page-course-view-x', 'pagetype')
2871         );
2872     }
2873     return $pagetypes;
2876 /**
2877  * Determine whether course ajax should be enabled for the specified course
2878  *
2879  * @param stdClass $course The course to test against
2880  * @return boolean Whether course ajax is enabled or note
2881  */
2882 function course_ajax_enabled($course) {
2883     global $CFG, $PAGE, $SITE;
2885     // Ajax must be enabled globally
2886     if (!$CFG->enableajax) {
2887         return false;
2888     }
2890     // The user must be editing for AJAX to be included
2891     if (!$PAGE->user_is_editing()) {
2892         return false;
2893     }
2895     // Check that the theme suports
2896     if (!$PAGE->theme->enablecourseajax) {
2897         return false;
2898     }
2900     // Check that the course format supports ajax functionality
2901     // The site 'format' doesn't have information on course format support
2902     if ($SITE->id !== $course->id) {
2903         $courseformatajaxsupport = course_format_ajax_support($course->format);
2904         if (!$courseformatajaxsupport->capable) {
2905             return false;
2906         }
2907     }
2909     // All conditions have been met so course ajax should be enabled
2910     return true;
2913 /**
2914  * Include the relevant javascript and language strings for the resource
2915  * toolbox YUI module
2916  *
2917  * @param integer $id The ID of the course being applied to
2918  * @param array $usedmodules An array containing the names of the modules in use on the page
2919  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
2920  * @param stdClass $config An object containing configuration parameters for ajax modules including:
2921  *          * resourceurl   The URL to post changes to for resource changes
2922  *          * sectionurl    The URL to post changes to for section changes
2923  *          * pageparams    Additional parameters to pass through in the post
2924  * @return bool
2925  */
2926 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
2927     global $CFG, $PAGE, $SITE;
2929     // Ensure that ajax should be included
2930     if (!course_ajax_enabled($course)) {
2931         return false;
2932     }
2934     if (!$config) {
2935         $config = new stdClass();
2936     }
2938     // The URL to use for resource changes
2939     if (!isset($config->resourceurl)) {
2940         $config->resourceurl = '/course/rest.php';
2941     }
2943     // The URL to use for section changes
2944     if (!isset($config->sectionurl)) {
2945         $config->sectionurl = '/course/rest.php';
2946     }
2948     // Any additional parameters which need to be included on page submission
2949     if (!isset($config->pageparams)) {
2950         $config->pageparams = array();
2951     }
2953     // Include toolboxes
2954     $PAGE->requires->yui_module('moodle-course-toolboxes',
2955             'M.course.init_resource_toolbox',
2956             array(array(
2957                 'courseid' => $course->id,
2958                 'ajaxurl' => $config->resourceurl,
2959                 'config' => $config,
2960             ))
2961     );
2962     $PAGE->requires->yui_module('moodle-course-toolboxes',
2963             'M.course.init_section_toolbox',
2964             array(array(
2965                 'courseid' => $course->id,
2966                 'format' => $course->format,
2967                 'ajaxurl' => $config->sectionurl,
2968                 'config' => $config,
2969             ))
2970     );
2972     // Include course dragdrop
2973     if ($course->id != $SITE->id) {
2974         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
2975             array(array(
2976                 'courseid' => $course->id,
2977                 'ajaxurl' => $config->sectionurl,
2978                 'config' => $config,
2979             )), null, true);
2981         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
2982             array(array(
2983                 'courseid' => $course->id,
2984                 'ajaxurl' => $config->resourceurl,
2985                 'config' => $config,
2986             )), null, true);
2987     }
2989     // Require various strings for the command toolbox
2990     $PAGE->requires->strings_for_js(array(
2991             'moveleft',
2992             'deletechecktype',
2993             'deletechecktypename',
2994             'edittitle',
2995             'edittitleinstructions',
2996             'show',
2997             'hide',
2998             'groupsnone',
2999             'groupsvisible',
3000             'groupsseparate',
3001             'clicktochangeinbrackets',
3002             'markthistopic',
3003             'markedthistopic',
3004             'move',
3005             'movesection',
3006             'movecontent',
3007             'tocontent',
3008             'emptydragdropregion'
3009         ), 'moodle');
3011     // Include format-specific strings
3012     if ($course->id != $SITE->id) {
3013         $PAGE->requires->strings_for_js(array(
3014                 'showfromothers',
3015                 'hidefromothers',
3016             ), 'format_' . $course->format);
3017     }
3019     // For confirming resource deletion we need the name of the module in question
3020     foreach ($usedmodules as $module => $modname) {
3021         $PAGE->requires->string_for_js('pluginname', $module);
3022     }
3024     // Load drag and drop upload AJAX.
3025     require_once($CFG->dirroot.'/course/dnduploadlib.php');
3026     dndupload_add_to_course($course, $enabledmodules);
3028     return true;
3031 /**
3032  * Returns the sorted list of available course formats, filtered by enabled if necessary
3033  *
3034  * @param bool $enabledonly return only formats that are enabled
3035  * @return array array of sorted format names
3036  */
3037 function get_sorted_course_formats($enabledonly = false) {
3038     global $CFG;
3039     $formats = core_component::get_plugin_list('format');
3041     if (!empty($CFG->format_plugins_sortorder)) {
3042         $order = explode(',', $CFG->format_plugins_sortorder);
3043         $order = array_merge(array_intersect($order, array_keys($formats)),
3044                     array_diff(array_keys($formats), $order));
3045     } else {
3046         $order = array_keys($formats);
3047     }
3048     if (!$enabledonly) {
3049         return $order;
3050     }
3051     $sortedformats = array();
3052     foreach ($order as $formatname) {
3053         if (!get_config('format_'.$formatname, 'disabled')) {
3054             $sortedformats[] = $formatname;
3055         }
3056     }
3057     return $sortedformats;
3060 /**
3061  * The URL to use for the specified course (with section)
3062  *
3063  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3064  * @param int|stdClass $section Section object from database or just field course_sections.section
3065  *     if omitted the course view page is returned
3066  * @param array $options options for view URL. At the moment core uses:
3067  *     'navigation' (bool) if true and section has no separate page, the function returns null
3068  *     'sr' (int) used by multipage formats to specify to which section to return
3069  * @return moodle_url The url of course
3070  */
3071 function course_get_url($courseorid, $section = null, $options = array()) {
3072     return course_get_format($courseorid)->get_view_url($section, $options);
3075 /**
3076  * Create a module.
3077  *
3078  * It includes:
3079  *      - capability checks and other checks
3080  *      - create the module from the module info
3081  *
3082  * @param object $module
3083  * @return object the created module info
3084  */
3085 function create_module($moduleinfo) {
3086     global $DB, $CFG;
3088     require_once($CFG->dirroot . '/course/modlib.php');
3090     // Check manadatory attributs.
3091     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3092     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3093         $mandatoryfields[] = 'introeditor';
3094     }
3095     foreach($mandatoryfields as $mandatoryfield) {
3096         if (!isset($moduleinfo->{$mandatoryfield})) {
3097             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3098         }
3099     }
3101     // Some additional checks (capability / existing instances).
3102     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3103     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3105     // Load module library.
3106     include_modulelib($module->name);
3108     // Add the module.
3109     $moduleinfo->module = $module->id;
3110     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3112     return $moduleinfo;
3115 /**
3116  * Update a module.
3117  *
3118  * It includes:
3119  *      - capability and other checks
3120  *      - update the module
3121  *
3122  * @param object $module
3123  * @return object the updated module info
3124  */
3125 function update_module($moduleinfo) {
3126     global $DB, $CFG;
3128     require_once($CFG->dirroot . '/course/modlib.php');
3130     // Check the course module exists.
3131     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3133     // Check the course exists.
3134     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3136     // Some checks (capaibility / existing instances).
3137     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3139     // Load module library.
3140     include_modulelib($module->name);
3142     // Retrieve few information needed by update_moduleinfo.
3143     $moduleinfo->modulename = $cm->modname;
3144     if (!isset($moduleinfo->scale)) {
3145         $moduleinfo->scale = 0;
3146     }
3147     $moduleinfo->type = 'mod';
3149     // Update the module.
3150     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3152     return $moduleinfo;
3155 /**
3156  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3157  * Sorts by descending order of time.
3158  *
3159  * @param stdClass $a First object
3160  * @param stdClass $b Second object
3161  * @return int 0,1,-1 representing the order
3162  */
3163 function compare_activities_by_time_desc($a, $b) {
3164     // Make sure the activities actually have a timestamp property.
3165     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3166         return 0;
3167     }
3168     // We treat instances without timestamp as if they have a timestamp of 0.
3169     if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3170         return 1;
3171     }
3172     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3173         return -1;
3174     }
3175     if ($a->timestamp == $b->timestamp) {
3176         return 0;
3177     }
3178     return ($a->timestamp > $b->timestamp) ? -1 : 1;
3181 /**
3182  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3183  * Sorts by ascending order of time.
3184  *
3185  * @param stdClass $a First object
3186  * @param stdClass $b Second object
3187  * @return int 0,1,-1 representing the order
3188  */
3189 function compare_activities_by_time_asc($a, $b) {
3190     // Make sure the activities actually have a timestamp property.
3191     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3192       return 0;
3193     }
3194     // We treat instances without timestamp as if they have a timestamp of 0.
3195     if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3196         return -1;
3197     }
3198     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3199         return 1;
3200     }
3201     if ($a->timestamp == $b->timestamp) {
3202         return 0;
3203     }
3204     return ($a->timestamp < $b->timestamp) ? -1 : 1;