609235060aefd332c6b97f83e0a80570cebf1c44
[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/dnduploadlib.php');
32 require_once($CFG->dirroot.'/course/format/lib.php');
34 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
37 /**
38  * Number of courses to display when summaries are included.
39  * @var int
40  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
41  */
42 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
44 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
45 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
46 define('FRONTPAGENEWS',           '0');
47 define('FRONTPAGECOURSELIST',     '1');         // Not used. TODO MDL-38832 remove
48 define('FRONTPAGECATEGORYNAMES',  '2');
49 define('FRONTPAGETOPICONLY',      '3');         // Not used. TODO MDL-38832 remove
50 define('FRONTPAGECATEGORYCOMBO',  '4');
51 define('FRONTPAGEENROLLEDCOURSELIST', '5');
52 define('FRONTPAGEALLCOURSELIST',  '6');
53 define('FRONTPAGECOURSESEARCH',   '7');
54 define('FRONTPAGECOURSELIMIT',    200);         // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage. TODO MDL-38832 remove
55 define('EXCELROWS', 65535);
56 define('FIRSTUSEDEXCELROW', 3);
58 define('MOD_CLASS_ACTIVITY', 0);
59 define('MOD_CLASS_RESOURCE', 1);
61 function make_log_url($module, $url) {
62     switch ($module) {
63         case 'course':
64             if (strpos($url, 'report/') === 0) {
65                 // there is only one report type, course reports are deprecated
66                 $url = "/$url";
67                 break;
68             }
69         case 'file':
70         case 'login':
71         case 'lib':
72         case 'admin':
73         case 'calendar':
74         case 'category':
75         case 'mnet course':
76             if (strpos($url, '../') === 0) {
77                 $url = ltrim($url, '.');
78             } else {
79                 $url = "/course/$url";
80             }
81             break;
82         case 'user':
83         case 'blog':
84             $url = "/$module/$url";
85             break;
86         case 'upload':
87             $url = $url;
88             break;
89         case 'coursetags':
90             $url = '/'.$url;
91             break;
92         case 'library':
93         case '':
94             $url = '/';
95             break;
96         case 'message':
97             $url = "/message/$url";
98             break;
99         case 'notes':
100             $url = "/notes/$url";
101             break;
102         case 'tag':
103             $url = "/tag/$url";
104             break;
105         case 'role':
106             $url = '/'.$url;
107             break;
108         case 'grade':
109             $url = "/grade/$url";
110             break;
111         default:
112             $url = "/mod/$module/$url";
113             break;
114     }
116     //now let's sanitise urls - there might be some ugly nasties:-(
117     $parts = explode('?', $url);
118     $script = array_shift($parts);
119     if (strpos($script, 'http') === 0) {
120         $script = clean_param($script, PARAM_URL);
121     } else {
122         $script = clean_param($script, PARAM_PATH);
123     }
125     $query = '';
126     if ($parts) {
127         $query = implode('', $parts);
128         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
129         $parts = explode('&', $query);
130         $eq = urlencode('=');
131         foreach ($parts as $key=>$part) {
132             $part = urlencode(urldecode($part));
133             $part = str_replace($eq, '=', $part);
134             $parts[$key] = $part;
135         }
136         $query = '?'.implode('&amp;', $parts);
137     }
139     return $script.$query;
143 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
144                    $modname="", $modid=0, $modaction="", $groupid=0) {
145     global $CFG, $DB;
147     // It is assumed that $date is the GMT time of midnight for that day,
148     // and so the next 86400 seconds worth of logs are printed.
150     /// Setup for group handling.
152     // TODO: I don't understand group/context/etc. enough to be able to do
153     // something interesting with it here
154     // What is the context of a remote course?
156     /// If the group mode is separate, and this user does not have editing privileges,
157     /// then only the user's group can be viewed.
158     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
159     //    $groupid = get_current_group($course->id);
160     //}
161     /// If this course doesn't have groups, no groupid can be specified.
162     //else if (!$course->groupmode) {
163     //    $groupid = 0;
164     //}
166     $groupid = 0;
168     $joins = array();
169     $where = '';
171     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
172               FROM {mnet_log} l
173                LEFT JOIN {user} u ON l.userid = u.id
174               WHERE ";
175     $params = array();
177     $where .= "l.hostid = :hostid";
178     $params['hostid'] = $hostid;
180     // TODO: Is 1 really a magic number referring to the sitename?
181     if ($course != SITEID || $modid != 0) {
182         $where .= " AND l.course=:courseid";
183         $params['courseid'] = $course;
184     }
186     if ($modname) {
187         $where .= " AND l.module = :modname";
188         $params['modname'] = $modname;
189     }
191     if ('site_errors' === $modid) {
192         $where .= " AND ( l.action='error' OR l.action='infected' )";
193     } else if ($modid) {
194         //TODO: This assumes that modids are the same across sites... probably
195         //not true
196         $where .= " AND l.cmid = :modid";
197         $params['modid'] = $modid;
198     }
200     if ($modaction) {
201         $firstletter = substr($modaction, 0, 1);
202         if ($firstletter == '-') {
203             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
204             $params['modaction'] = '%'.substr($modaction, 1).'%';
205         } else {
206             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
207             $params['modaction'] = '%'.$modaction.'%';
208         }
209     }
211     if ($user) {
212         $where .= " AND l.userid = :user";
213         $params['user'] = $user;
214     }
216     if ($date) {
217         $enddate = $date + 86400;
218         $where .= " AND l.time > :date AND l.time < :enddate";
219         $params['date'] = $date;
220         $params['enddate'] = $enddate;
221     }
223     $result = array();
224     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
225     if(!empty($result['totalcount'])) {
226         $where .= " ORDER BY $order";
227         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
228     } else {
229         $result['logs'] = array();
230     }
231     return $result;
234 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
235                    $modname="", $modid=0, $modaction="", $groupid=0) {
236     global $DB, $SESSION, $USER;
237     // It is assumed that $date is the GMT time of midnight for that day,
238     // and so the next 86400 seconds worth of logs are printed.
240     /// Setup for group handling.
242     /// If the group mode is separate, and this user does not have editing privileges,
243     /// then only the user's group can be viewed.
244     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
245         if (isset($SESSION->currentgroup[$course->id])) {
246             $groupid =  $SESSION->currentgroup[$course->id];
247         } else {
248             $groupid = groups_get_all_groups($course->id, $USER->id);
249             if (is_array($groupid)) {
250                 $groupid = array_shift(array_keys($groupid));
251                 $SESSION->currentgroup[$course->id] = $groupid;
252             } else {
253                 $groupid = 0;
254             }
255         }
256     }
257     /// If this course doesn't have groups, no groupid can be specified.
258     else if (!$course->groupmode) {
259         $groupid = 0;
260     }
262     $joins = array();
263     $params = array();
265     if ($course->id != SITEID || $modid != 0) {
266         $joins[] = "l.course = :courseid";
267         $params['courseid'] = $course->id;
268     }
270     if ($modname) {
271         $joins[] = "l.module = :modname";
272         $params['modname'] = $modname;
273     }
275     if ('site_errors' === $modid) {
276         $joins[] = "( l.action='error' OR l.action='infected' )";
277     } else if ($modid) {
278         $joins[] = "l.cmid = :modid";
279         $params['modid'] = $modid;
280     }
282     if ($modaction) {
283         $firstletter = substr($modaction, 0, 1);
284         if ($firstletter == '-') {
285             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
286             $params['modaction'] = '%'.substr($modaction, 1).'%';
287         } else {
288             $joins[] = $DB->sql_like('l.action', ':modaction', false);
289             $params['modaction'] = '%'.$modaction.'%';
290         }
291     }
294     /// Getting all members of a group.
295     if ($groupid and !$user) {
296         if ($gusers = groups_get_members($groupid)) {
297             $gusers = array_keys($gusers);
298             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
299         } else {
300             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
301         }
302     }
303     else if ($user) {
304         $joins[] = "l.userid = :userid";
305         $params['userid'] = $user;
306     }
308     if ($date) {
309         $enddate = $date + 86400;
310         $joins[] = "l.time > :date AND l.time < :enddate";
311         $params['date'] = $date;
312         $params['enddate'] = $enddate;
313     }
315     $selector = implode(' AND ', $joins);
317     $totalcount = 0;  // Initialise
318     $result = array();
319     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
320     $result['totalcount'] = $totalcount;
321     return $result;
325 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
326                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
328     global $CFG, $DB, $OUTPUT;
330     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
331                        $modname, $modid, $modaction, $groupid)) {
332         echo $OUTPUT->notification("No logs found!");
333         echo $OUTPUT->footer();
334         exit;
335     }
337     $courses = array();
339     if ($course->id == SITEID) {
340         $courses[0] = '';
341         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
342             foreach ($ccc as $cc) {
343                 $courses[$cc->id] = $cc->shortname;
344             }
345         }
346     } else {
347         $courses[$course->id] = $course->shortname;
348     }
350     $totalcount = $logs['totalcount'];
351     $count=0;
352     $ldcache = array();
353     $tt = getdate(time());
354     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
356     $strftimedatetime = get_string("strftimedatetime");
358     echo "<div class=\"info\">\n";
359     print_string("displayingrecords", "", $totalcount);
360     echo "</div>\n";
362     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
364     $table = new html_table();
365     $table->classes = array('logtable','generaltable');
366     $table->align = array('right', 'left', 'left');
367     $table->head = array(
368         get_string('time'),
369         get_string('ip_address'),
370         get_string('fullnameuser'),
371         get_string('action'),
372         get_string('info')
373     );
374     $table->data = array();
376     if ($course->id == SITEID) {
377         array_unshift($table->align, 'left');
378         array_unshift($table->head, get_string('course'));
379     }
381     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
382     if (empty($logs['logs'])) {
383         $logs['logs'] = array();
384     }
386     foreach ($logs['logs'] as $log) {
388         if (isset($ldcache[$log->module][$log->action])) {
389             $ld = $ldcache[$log->module][$log->action];
390         } else {
391             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
392             $ldcache[$log->module][$log->action] = $ld;
393         }
394         if ($ld && is_numeric($log->info)) {
395             // ugly hack to make sure fullname is shown correctly
396             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
397                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
398             } else {
399                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
400             }
401         }
403         //Filter log->info
404         $log->info = format_string($log->info);
406         // If $log->url has been trimmed short by the db size restriction
407         // code in add_to_log, keep a note so we don't add a link to a broken url
408         $brokenurl=(core_text::strlen($log->url)==100 && core_text::substr($log->url,97)=='...');
410         $row = array();
411         if ($course->id == SITEID) {
412             if (empty($log->course)) {
413                 $row[] = get_string('site');
414             } else {
415                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
416             }
417         }
419         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
421         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
422         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
424         $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))));
426         $displayaction="$log->module $log->action";
427         if ($brokenurl) {
428             $row[] = $displayaction;
429         } else {
430             $link = make_log_url($log->module,$log->url);
431             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
432         }
433         $row[] = $log->info;
434         $table->data[] = $row;
435     }
437     echo html_writer::table($table);
438     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
442 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
443                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
445     global $CFG, $DB, $OUTPUT;
447     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
448                        $modname, $modid, $modaction, $groupid)) {
449         echo $OUTPUT->notification("No logs found!");
450         echo $OUTPUT->footer();
451         exit;
452     }
454     if ($course->id == SITEID) {
455         $courses[0] = '';
456         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
457             foreach ($ccc as $cc) {
458                 $courses[$cc->id] = $cc->shortname;
459             }
460         }
461     }
463     $totalcount = $logs['totalcount'];
464     $count=0;
465     $ldcache = array();
466     $tt = getdate(time());
467     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
469     $strftimedatetime = get_string("strftimedatetime");
471     echo "<div class=\"info\">\n";
472     print_string("displayingrecords", "", $totalcount);
473     echo "</div>\n";
475     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
477     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
478     echo "<tr>";
479     if ($course->id == SITEID) {
480         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
481     }
482     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
483     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
484     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
485     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
486     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
487     echo "</tr>\n";
489     if (empty($logs['logs'])) {
490         echo "</table>\n";
491         return;
492     }
494     $row = 1;
495     foreach ($logs['logs'] as $log) {
497         $log->info = $log->coursename;
498         $row = ($row + 1) % 2;
500         if (isset($ldcache[$log->module][$log->action])) {
501             $ld = $ldcache[$log->module][$log->action];
502         } else {
503             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
504             $ldcache[$log->module][$log->action] = $ld;
505         }
506         if (0 && $ld && !empty($log->info)) {
507             // ugly hack to make sure fullname is shown correctly
508             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
509                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
510             } else {
511                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
512             }
513         }
515         //Filter log->info
516         $log->info = format_string($log->info);
518         echo '<tr class="r'.$row.'">';
519         if ($course->id == SITEID) {
520             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
521             echo "<td class=\"r$row c0\" >\n";
522             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
523             echo "</td>\n";
524         }
525         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
526              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
527         echo "<td class=\"r$row c2\" >\n";
528         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
529         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
530         echo "</td>\n";
531         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
532         echo "<td class=\"r$row c3\" >\n";
533         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
534         echo "</td>\n";
535         echo "<td class=\"r$row c4\">\n";
536         echo $log->action .': '.$log->module;
537         echo "</td>\n";
538         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
539         echo "</tr>\n";
540     }
541     echo "</table>\n";
543     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
547 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
548                         $modid, $modaction, $groupid) {
549     global $DB, $CFG;
551     require_once($CFG->libdir . '/csvlib.class.php');
553     $csvexporter = new csv_export_writer('tab');
555     $header = array();
556     $header[] = get_string('course');
557     $header[] = get_string('time');
558     $header[] = get_string('ip_address');
559     $header[] = get_string('fullnameuser');
560     $header[] = get_string('action');
561     $header[] = get_string('info');
563     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
564                        $modname, $modid, $modaction, $groupid)) {
565         return false;
566     }
568     $courses = array();
570     if ($course->id == SITEID) {
571         $courses[0] = '';
572         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
573             foreach ($ccc as $cc) {
574                 $courses[$cc->id] = $cc->shortname;
575             }
576         }
577     } else {
578         $courses[$course->id] = $course->shortname;
579     }
581     $count=0;
582     $ldcache = array();
583     $tt = getdate(time());
584     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
586     $strftimedatetime = get_string("strftimedatetime");
588     $csvexporter->set_filename('logs', '.txt');
589     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
590     $csvexporter->add_data($title);
591     $csvexporter->add_data($header);
593     if (empty($logs['logs'])) {
594         return true;
595     }
597     foreach ($logs['logs'] as $log) {
598         if (isset($ldcache[$log->module][$log->action])) {
599             $ld = $ldcache[$log->module][$log->action];
600         } else {
601             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
602             $ldcache[$log->module][$log->action] = $ld;
603         }
604         if ($ld && is_numeric($log->info)) {
605             // ugly hack to make sure fullname is shown correctly
606             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
607                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
608             } else {
609                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
610             }
611         }
613         //Filter log->info
614         $log->info = format_string($log->info);
615         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
617         $coursecontext = context_course::instance($course->id);
618         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
619         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
620         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
621         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
622         $csvexporter->add_data($row);
623     }
624     $csvexporter->download_file();
625     return true;
629 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
630                         $modid, $modaction, $groupid) {
632     global $CFG, $DB;
634     require_once("$CFG->libdir/excellib.class.php");
636     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
637                        $modname, $modid, $modaction, $groupid)) {
638         return false;
639     }
641     $courses = array();
643     if ($course->id == SITEID) {
644         $courses[0] = '';
645         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
646             foreach ($ccc as $cc) {
647                 $courses[$cc->id] = $cc->shortname;
648             }
649         }
650     } else {
651         $courses[$course->id] = $course->shortname;
652     }
654     $count=0;
655     $ldcache = array();
656     $tt = getdate(time());
657     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
659     $strftimedatetime = get_string("strftimedatetime");
661     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
662     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
663     $filename .= '.xls';
665     $workbook = new MoodleExcelWorkbook('-');
666     $workbook->send($filename);
668     $worksheet = array();
669     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
670                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
672     // Creating worksheets
673     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
674         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
675         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
676         $worksheet[$wsnumber]->set_column(1, 1, 30);
677         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
678                                     userdate(time(), $strftimedatetime));
679         $col = 0;
680         foreach ($headers as $item) {
681             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
682             $col++;
683         }
684     }
686     if (empty($logs['logs'])) {
687         $workbook->close();
688         return true;
689     }
691     $formatDate =& $workbook->add_format();
692     $formatDate->set_num_format(get_string('log_excel_date_format'));
694     $row = FIRSTUSEDEXCELROW;
695     $wsnumber = 1;
696     $myxls =& $worksheet[$wsnumber];
697     foreach ($logs['logs'] as $log) {
698         if (isset($ldcache[$log->module][$log->action])) {
699             $ld = $ldcache[$log->module][$log->action];
700         } else {
701             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
702             $ldcache[$log->module][$log->action] = $ld;
703         }
704         if ($ld && is_numeric($log->info)) {
705             // ugly hack to make sure fullname is shown correctly
706             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
707                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
708             } else {
709                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
710             }
711         }
713         // Filter log->info
714         $log->info = format_string($log->info);
715         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
717         if ($nroPages>1) {
718             if ($row > EXCELROWS) {
719                 $wsnumber++;
720                 $myxls =& $worksheet[$wsnumber];
721                 $row = FIRSTUSEDEXCELROW;
722             }
723         }
725         $coursecontext = context_course::instance($course->id);
727         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
728         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
729         $myxls->write($row, 2, $log->ip, '');
730         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
731         $myxls->write($row, 3, $fullname, '');
732         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
733         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
734         $myxls->write($row, 5, $log->info, '');
736         $row++;
737     }
739     $workbook->close();
740     return true;
743 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
744                         $modid, $modaction, $groupid) {
746     global $CFG, $DB;
748     require_once("$CFG->libdir/odslib.class.php");
750     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
751                        $modname, $modid, $modaction, $groupid)) {
752         return false;
753     }
755     $courses = array();
757     if ($course->id == SITEID) {
758         $courses[0] = '';
759         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
760             foreach ($ccc as $cc) {
761                 $courses[$cc->id] = $cc->shortname;
762             }
763         }
764     } else {
765         $courses[$course->id] = $course->shortname;
766     }
768     $count=0;
769     $ldcache = array();
770     $tt = getdate(time());
771     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
773     $strftimedatetime = get_string("strftimedatetime");
775     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
776     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
777     $filename .= '.ods';
779     $workbook = new MoodleODSWorkbook('-');
780     $workbook->send($filename);
782     $worksheet = array();
783     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
784                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
786     // Creating worksheets
787     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
788         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
789         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
790         $worksheet[$wsnumber]->set_column(1, 1, 30);
791         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
792                                     userdate(time(), $strftimedatetime));
793         $col = 0;
794         foreach ($headers as $item) {
795             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
796             $col++;
797         }
798     }
800     if (empty($logs['logs'])) {
801         $workbook->close();
802         return true;
803     }
805     $formatDate =& $workbook->add_format();
806     $formatDate->set_num_format(get_string('log_excel_date_format'));
808     $row = FIRSTUSEDEXCELROW;
809     $wsnumber = 1;
810     $myxls =& $worksheet[$wsnumber];
811     foreach ($logs['logs'] as $log) {
812         if (isset($ldcache[$log->module][$log->action])) {
813             $ld = $ldcache[$log->module][$log->action];
814         } else {
815             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
816             $ldcache[$log->module][$log->action] = $ld;
817         }
818         if ($ld && is_numeric($log->info)) {
819             // ugly hack to make sure fullname is shown correctly
820             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
821                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
822             } else {
823                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
824             }
825         }
827         // Filter log->info
828         $log->info = format_string($log->info);
829         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
831         if ($nroPages>1) {
832             if ($row > EXCELROWS) {
833                 $wsnumber++;
834                 $myxls =& $worksheet[$wsnumber];
835                 $row = FIRSTUSEDEXCELROW;
836             }
837         }
839         $coursecontext = context_course::instance($course->id);
841         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
842         $myxls->write_date($row, 1, $log->time);
843         $myxls->write_string($row, 2, $log->ip);
844         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
845         $myxls->write_string($row, 3, $fullname);
846         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
847         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
848         $myxls->write_string($row, 5, $log->info);
850         $row++;
851     }
853     $workbook->close();
854     return true;
857 /**
858  * For a given course, returns an array of course activity objects
859  * Each item in the array contains he following properties:
860  */
861 function get_array_of_activities($courseid) {
862 //  cm - course module id
863 //  mod - name of the module (eg forum)
864 //  section - the number of the section (eg week or topic)
865 //  name - the name of the instance
866 //  visible - is the instance visible or not
867 //  groupingid - grouping id
868 //  groupmembersonly - is this instance visible to group members only
869 //  extra - contains extra string to include in any link
870     global $CFG, $DB;
871     if(!empty($CFG->enableavailability)) {
872         require_once($CFG->libdir.'/conditionlib.php');
873     }
875     $course = $DB->get_record('course', array('id'=>$courseid));
877     if (empty($course)) {
878         throw new moodle_exception('courseidnotfound');
879     }
881     $mod = array();
883     $rawmods = get_course_mods($courseid);
884     if (empty($rawmods)) {
885         return $mod; // always return array
886     }
888     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
889        foreach ($sections as $section) {
890            if (!empty($section->sequence)) {
891                $sequence = explode(",", $section->sequence);
892                foreach ($sequence as $seq) {
893                    if (empty($rawmods[$seq])) {
894                        continue;
895                    }
896                    $mod[$seq] = new stdClass();
897                    $mod[$seq]->id               = $rawmods[$seq]->instance;
898                    $mod[$seq]->cm               = $rawmods[$seq]->id;
899                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
901                     // Oh dear. Inconsistent names left here for backward compatibility.
902                    $mod[$seq]->section          = $section->section;
903                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
905                    $mod[$seq]->module           = $rawmods[$seq]->module;
906                    $mod[$seq]->added            = $rawmods[$seq]->added;
907                    $mod[$seq]->score            = $rawmods[$seq]->score;
908                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
909                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
910                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
911                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
912                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
913                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
914                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
915                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
916                    $mod[$seq]->extra            = "";
917                    $mod[$seq]->completiongradeitemnumber =
918                            $rawmods[$seq]->completiongradeitemnumber;
919                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
920                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
921                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
922                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
923                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
924                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
925                    if (!empty($CFG->enableavailability)) {
926                        condition_info::fill_availability_conditions($rawmods[$seq]);
927                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
928                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
929                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
930                    }
932                    $modname = $mod[$seq]->mod;
933                    $functionname = $modname."_get_coursemodule_info";
935                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
936                        continue;
937                    }
939                    include_once("$CFG->dirroot/mod/$modname/lib.php");
941                    if ($hasfunction = function_exists($functionname)) {
942                        if ($info = $functionname($rawmods[$seq])) {
943                            if (!empty($info->icon)) {
944                                $mod[$seq]->icon = $info->icon;
945                            }
946                            if (!empty($info->iconcomponent)) {
947                                $mod[$seq]->iconcomponent = $info->iconcomponent;
948                            }
949                            if (!empty($info->name)) {
950                                $mod[$seq]->name = $info->name;
951                            }
952                            if ($info instanceof cached_cm_info) {
953                                // When using cached_cm_info you can include three new fields
954                                // that aren't available for legacy code
955                                if (!empty($info->content)) {
956                                    $mod[$seq]->content = $info->content;
957                                }
958                                if (!empty($info->extraclasses)) {
959                                    $mod[$seq]->extraclasses = $info->extraclasses;
960                                }
961                                if (!empty($info->iconurl)) {
962                                    $mod[$seq]->iconurl = $info->iconurl;
963                                }
964                                if (!empty($info->onclick)) {
965                                    $mod[$seq]->onclick = $info->onclick;
966                                }
967                                if (!empty($info->customdata)) {
968                                    $mod[$seq]->customdata = $info->customdata;
969                                }
970                            } else {
971                                // When using a stdclass, the (horrible) deprecated ->extra field
972                                // is available for BC
973                                if (!empty($info->extra)) {
974                                    $mod[$seq]->extra = $info->extra;
975                                }
976                            }
977                        }
978                    }
979                    // When there is no modname_get_coursemodule_info function,
980                    // but showdescriptions is enabled, then we use the 'intro'
981                    // and 'introformat' fields in the module table
982                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
983                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
984                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
985                            // Set content from intro and introformat. Filters are disabled
986                            // because we  filter it with format_text at display time
987                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
988                                    $modvalues, $rawmods[$seq]->id, false);
990                            // To save making another query just below, put name in here
991                            $mod[$seq]->name = $modvalues->name;
992                        }
993                    }
994                    if (!isset($mod[$seq]->name)) {
995                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
996                    }
998                    // Minimise the database size by unsetting default options when they are
999                    // 'empty'. This list corresponds to code in the cm_info constructor.
1000                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1001                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1002                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1003                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1004                            'completionview', 'completionexpected', 'score', 'showdescription')
1005                            as $property) {
1006                        if (property_exists($mod[$seq], $property) &&
1007                                empty($mod[$seq]->{$property})) {
1008                            unset($mod[$seq]->{$property});
1009                        }
1010                    }
1011                    // Special case: this value is usually set to null, but may be 0
1012                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1013                            is_null($mod[$seq]->completiongradeitemnumber)) {
1014                        unset($mod[$seq]->completiongradeitemnumber);
1015                    }
1016                }
1017             }
1018         }
1019     }
1020     return $mod;
1023 /**
1024  * Returns the localised human-readable names of all used modules
1025  *
1026  * @param bool $plural if true returns the plural forms of the names
1027  * @return array where key is the module name (component name without 'mod_') and
1028  *     the value is the human-readable string. Array sorted alphabetically by value
1029  */
1030 function get_module_types_names($plural = false) {
1031     static $modnames = null;
1032     global $DB, $CFG;
1033     if ($modnames === null) {
1034         $modnames = array(0 => array(), 1 => array());
1035         if ($allmods = $DB->get_records("modules")) {
1036             foreach ($allmods as $mod) {
1037                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1038                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1039                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1040                 }
1041             }
1042             core_collator::asort($modnames[0]);
1043             core_collator::asort($modnames[1]);
1044         }
1045     }
1046     return $modnames[(int)$plural];
1049 /**
1050  * Set highlighted section. Only one section can be highlighted at the time.
1051  *
1052  * @param int $courseid course id
1053  * @param int $marker highlight section with this number, 0 means remove higlightin
1054  * @return void
1055  */
1056 function course_set_marker($courseid, $marker) {
1057     global $DB;
1058     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1059     format_base::reset_course_cache($courseid);
1062 /**
1063  * For a given course section, marks it visible or hidden,
1064  * and does the same for every activity in that section
1065  *
1066  * @param int $courseid course id
1067  * @param int $sectionnumber The section number to adjust
1068  * @param int $visibility The new visibility
1069  * @return array A list of resources which were hidden in the section
1070  */
1071 function set_section_visible($courseid, $sectionnumber, $visibility) {
1072     global $DB;
1074     $resourcestotoggle = array();
1075     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1076         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1077         if (!empty($section->sequence)) {
1078             $modules = explode(",", $section->sequence);
1079             foreach ($modules as $moduleid) {
1080                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1081                     if ($visibility) {
1082                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1083                         set_coursemodule_visible($moduleid, $cm->visibleold);
1084                     } else {
1085                         // We hide the section, so we hide the module but we store the original state in visibleold.
1086                         set_coursemodule_visible($moduleid, 0);
1087                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1088                     }
1089                 }
1090             }
1091         }
1092         rebuild_course_cache($courseid, true);
1094         // Determine which modules are visible for AJAX update
1095         if (!empty($modules)) {
1096             list($insql, $params) = $DB->get_in_or_equal($modules);
1097             $select = 'id ' . $insql . ' AND visible = ?';
1098             array_push($params, $visibility);
1099             if (!$visibility) {
1100                 $select .= ' AND visibleold = 1';
1101             }
1102             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1103         }
1104     }
1105     return $resourcestotoggle;
1108 /**
1109  * Retrieve all metadata for the requested modules
1110  *
1111  * @param object $course The Course
1112  * @param array $modnames An array containing the list of modules and their
1113  * names
1114  * @param int $sectionreturn The section to return to
1115  * @return array A list of stdClass objects containing metadata about each
1116  * module
1117  */
1118 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1119     global $CFG, $OUTPUT;
1121     // get_module_metadata will be called once per section on the page and courses may show
1122     // different modules to one another
1123     static $modlist = array();
1124     if (!isset($modlist[$course->id])) {
1125         $modlist[$course->id] = array();
1126     }
1128     $return = array();
1129     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1130     if ($sectionreturn !== null) {
1131         $urlbase->param('sr', $sectionreturn);
1132     }
1133     foreach($modnames as $modname => $modnamestr) {
1134         if (!course_allowed_module($course, $modname)) {
1135             continue;
1136         }
1137         if (isset($modlist[$course->id][$modname])) {
1138             // This module is already cached
1139             $return[$modname] = $modlist[$course->id][$modname];
1140             continue;
1141         }
1143         // Include the module lib
1144         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1145         if (!file_exists($libfile)) {
1146             continue;
1147         }
1148         include_once($libfile);
1150         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1151         $gettypesfunc =  $modname.'_get_types';
1152         if (function_exists($gettypesfunc)) {
1153             $types = $gettypesfunc();
1154             if (is_array($types) && count($types) > 0) {
1155                 $group = new stdClass();
1156                 $group->name = $modname;
1157                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1158                 foreach($types as $type) {
1159                     if ($type->typestr === '--') {
1160                         continue;
1161                     }
1162                     if (strpos($type->typestr, '--') === 0) {
1163                         $group->title = str_replace('--', '', $type->typestr);
1164                         continue;
1165                     }
1166                     // Set the Sub Type metadata
1167                     $subtype = new stdClass();
1168                     $subtype->title = $type->typestr;
1169                     $subtype->type = str_replace('&amp;', '&', $type->type);
1170                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1171                     $subtype->archetype = $type->modclass;
1173                     // The group archetype should match the subtype archetypes and all subtypes
1174                     // should have the same archetype
1175                     $group->archetype = $subtype->archetype;
1177                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1178                         $subtype->help = get_string('help' . $subtype->name, $modname);
1179                     }
1180                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1181                     $group->types[] = $subtype;
1182                 }
1183                 $modlist[$course->id][$modname] = $group;
1184             }
1185         } else {
1186             $module = new stdClass();
1187             $module->title = $modnamestr;
1188             $module->name = $modname;
1189             $module->link = new moodle_url($urlbase, array('add' => $modname));
1190             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1191             $sm = get_string_manager();
1192             if ($sm->string_exists('modulename_help', $modname)) {
1193                 $module->help = get_string('modulename_help', $modname);
1194                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1195                     $link = get_string('modulename_link', $modname);
1196                     $linktext = get_string('morehelp');
1197                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1198                 }
1199             }
1200             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1201             $modlist[$course->id][$modname] = $module;
1202         }
1203         if (isset($modlist[$course->id][$modname])) {
1204             $return[$modname] = $modlist[$course->id][$modname];
1205         } else {
1206             debugging("Invalid module metadata configuration for {$modname}");
1207         }
1208     }
1210     return $return;
1213 /**
1214  * Return the course category context for the category with id $categoryid, except
1215  * that if $categoryid is 0, return the system context.
1216  *
1217  * @param integer $categoryid a category id or 0.
1218  * @return object the corresponding context
1219  */
1220 function get_category_or_system_context($categoryid) {
1221     if ($categoryid) {
1222         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1223     } else {
1224         return context_system::instance();
1225     }
1228 /**
1229  * Returns full course categories trees to be used in html_writer::select()
1230  *
1231  * Calls {@link coursecat::make_categories_list()} to build the tree and
1232  * adds whitespace to denote nesting
1233  *
1234  * @return array array mapping coursecat id to the display name
1235  */
1236 function make_categories_options() {
1237     global $CFG;
1238     require_once($CFG->libdir. '/coursecatlib.php');
1239     $cats = coursecat::make_categories_list();
1240     foreach ($cats as $key => $value) {
1241         $cats[$key] = str_repeat('&nbsp;', coursecat::get($key)->depth - 1). $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  * @param int|stdClass $courseorid course id or course object
1332  * @param int $cmid id of the module already existing in course_modules table
1333  * @param int $sectionnum relative number of the section (field course_sections.section)
1334  *     If section does not exist it will be created
1335  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1336  *     before which the module needs to be included. Null for inserting in the
1337  *     end of the section
1338  * @return int The course_sections ID where the module is inserted
1339  */
1340 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1341     global $DB, $COURSE;
1342     if (is_object($beforemod)) {
1343         $beforemod = $beforemod->id;
1344     }
1345     if (is_object($courseorid)) {
1346         $courseid = $courseorid->id;
1347     } else {
1348         $courseid = $courseorid;
1349     }
1350     course_create_sections_if_missing($courseorid, $sectionnum);
1351     // Do not try to use modinfo here, there is no guarantee it is valid!
1352     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
1353     $modarray = explode(",", trim($section->sequence));
1354     if (empty($section->sequence)) {
1355         $newsequence = "$cmid";
1356     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1357         $insertarray = array($cmid, $beforemod);
1358         array_splice($modarray, $key[0], 1, $insertarray);
1359         $newsequence = implode(",", $modarray);
1360     } else {
1361         $newsequence = "$section->sequence,$cmid";
1362     }
1363     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
1364     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
1365     if (is_object($courseorid)) {
1366         rebuild_course_cache($courseorid->id, true);
1367     } else {
1368         rebuild_course_cache($courseorid, true);
1369     }
1370     return $section->id;     // Return course_sections ID that was used.
1373 function set_coursemodule_groupmode($id, $groupmode) {
1374     global $DB;
1375     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1376     if ($cm->groupmode != $groupmode) {
1377         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1378         rebuild_course_cache($cm->course, true);
1379     }
1380     return ($cm->groupmode != $groupmode);
1383 function set_coursemodule_idnumber($id, $idnumber) {
1384     global $DB;
1385     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1386     if ($cm->idnumber != $idnumber) {
1387         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1388         rebuild_course_cache($cm->course, true);
1389     }
1390     return ($cm->idnumber != $idnumber);
1393 /**
1394  * Set the visibility of a module and inherent properties.
1395  *
1396  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1397  * has been moved to {@link set_section_visible()} which was the only place from which
1398  * the parameter was used.
1399  *
1400  * @param int $id of the module
1401  * @param int $visible state of the module
1402  * @return bool false when the module was not found, true otherwise
1403  */
1404 function set_coursemodule_visible($id, $visible) {
1405     global $DB, $CFG;
1406     require_once($CFG->libdir.'/gradelib.php');
1407     require_once($CFG->dirroot.'/calendar/lib.php');
1409     // Trigger developer's attention when using the previously removed argument.
1410     if (func_num_args() > 2) {
1411         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1412             has been removed.', DEBUG_DEVELOPER);
1413     }
1415     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1416         return false;
1417     }
1419     // Create events and propagate visibility to associated grade items if the value has changed.
1420     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1421     if ($cm->visible == $visible) {
1422         return true;
1423     }
1425     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
1426         return false;
1427     }
1428     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
1429         foreach($events as $event) {
1430             if ($visible) {
1431                 $event = new calendar_event($event);
1432                 $event->toggle_visibility(true);
1433             } else {
1434                 $event = new calendar_event($event);
1435                 $event->toggle_visibility(false);
1436             }
1437         }
1438     }
1440     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1441     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1442     if ($grade_items) {
1443         foreach ($grade_items as $grade_item) {
1444             $grade_item->set_hidden(!$visible);
1445         }
1446     }
1448     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1449     // affect visibleold to allow for an original visibility restore. See set_section_visible().
1450     $cminfo = new stdClass();
1451     $cminfo->id = $id;
1452     $cminfo->visible = $visible;
1453     $cminfo->visibleold = $visible;
1454     $DB->update_record('course_modules', $cminfo);
1456     rebuild_course_cache($cm->course, true);
1457     return true;
1460 /**
1461  * This function will handles the whole deletion process of a module. This includes calling
1462  * the modules delete_instance function, deleting files, events, grades, conditional data,
1463  * the data in the course_module and course_sections table and adding a module deletion
1464  * event to the DB.
1465  *
1466  * @param int $cmid the course module id
1467  * @since 2.5
1468  */
1469 function course_delete_module($cmid) {
1470     global $CFG, $DB, $USER;
1472     require_once($CFG->libdir.'/gradelib.php');
1473     require_once($CFG->dirroot.'/blog/lib.php');
1474     require_once($CFG->dirroot.'/calendar/lib.php');
1476     // Get the course module.
1477     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1478         return true;
1479     }
1481     // Get the module context.
1482     $modcontext = context_module::instance($cm->id);
1484     // Get the course module name.
1485     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1487     // Get the file location of the delete_instance function for this module.
1488     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1490     // Include the file required to call the delete_instance function for this module.
1491     if (file_exists($modlib)) {
1492         require_once($modlib);
1493     } else {
1494         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1495             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1496     }
1498     $deleteinstancefunction = $modulename . '_delete_instance';
1500     // Ensure the delete_instance function exists for this module.
1501     if (!function_exists($deleteinstancefunction)) {
1502         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1503             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1504     }
1506     // Call the delete_instance function, if it returns false throw an exception.
1507     if (!$deleteinstancefunction($cm->instance)) {
1508         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1509             "Cannot delete the module $modulename (instance).");
1510     }
1512     // Remove all module files in case modules forget to do that.
1513     $fs = get_file_storage();
1514     $fs->delete_area_files($modcontext->id);
1516     // Delete events from calendar.
1517     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1518         foreach($events as $event) {
1519             $calendarevent = calendar_event::load($event->id);
1520             $calendarevent->delete();
1521         }
1522     }
1524     // Delete grade items, outcome items and grades attached to modules.
1525     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1526                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1527         foreach ($grade_items as $grade_item) {
1528             $grade_item->delete('moddelete');
1529         }
1530     }
1532     // Delete completion and availability data; it is better to do this even if the
1533     // features are not turned on, in case they were turned on previously (these will be
1534     // very quick on an empty table).
1535     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1536     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
1537     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
1538     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1539                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1541     // Delete the context.
1542     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1544     // Delete the module from the course_modules table.
1545     $DB->delete_records('course_modules', array('id' => $cm->id));
1547     // Delete module from that section.
1548     if (!delete_mod_from_section($cm->id, $cm->section)) {
1549         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1550             "Cannot delete the module $modulename (instance) from section.");
1551     }
1553     // Trigger a mod_deleted event with information about this module.
1554     $eventdata = new stdClass();
1555     $eventdata->modulename = $modulename;
1556     $eventdata->cmid       = $cm->id;
1557     $eventdata->courseid   = $cm->course;
1558     $eventdata->userid     = $USER->id;
1559     events_trigger('mod_deleted', $eventdata);
1561     add_to_log($cm->course, 'course', "delete mod",
1562                "view.php?id=$cm->course",
1563                "$modulename $cm->instance", $cm->id);
1565     rebuild_course_cache($cm->course, true);
1568 function delete_mod_from_section($modid, $sectionid) {
1569     global $DB;
1571     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1573         $modarray = explode(",", $section->sequence);
1575         if ($key = array_keys ($modarray, $modid)) {
1576             array_splice($modarray, $key[0], 1);
1577             $newsequence = implode(",", $modarray);
1578             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1579             rebuild_course_cache($section->course, true);
1580             return true;
1581         } else {
1582             return false;
1583         }
1585     }
1586     return false;
1589 /**
1590  * Moves a section within a course, from a position to another.
1591  * Be very careful: $section and $destination refer to section number,
1592  * not id!.
1593  *
1594  * @param object $course
1595  * @param int $section Section number (not id!!!)
1596  * @param int $destination
1597  * @return boolean Result
1598  */
1599 function move_section_to($course, $section, $destination) {
1600 /// Moves a whole course section up and down within the course
1601     global $USER, $DB;
1603     if (!$destination && $destination != 0) {
1604         return true;
1605     }
1607     // compartibility with course formats using field 'numsections'
1608     $courseformatoptions = course_get_format($course)->get_format_options();
1609     if ((array_key_exists('numsections', $courseformatoptions) &&
1610             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1611         return false;
1612     }
1614     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1615     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1616             'section ASC, id ASC', 'id, section')) {
1617         return false;
1618     }
1620     $movedsections = reorder_sections($sections, $section, $destination);
1622     // Update all sections. Do this in 2 steps to avoid breaking database
1623     // uniqueness constraint
1624     $transaction = $DB->start_delegated_transaction();
1625     foreach ($movedsections as $id => $position) {
1626         if ($sections[$id] !== $position) {
1627             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1628         }
1629     }
1630     foreach ($movedsections as $id => $position) {
1631         if ($sections[$id] !== $position) {
1632             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1633         }
1634     }
1636     // If we move the highlighted section itself, then just highlight the destination.
1637     // Adjust the higlighted section location if we move something over it either direction.
1638     if ($section == $course->marker) {
1639         course_set_marker($course->id, $destination);
1640     } elseif ($section > $course->marker && $course->marker >= $destination) {
1641         course_set_marker($course->id, $course->marker+1);
1642     } elseif ($section < $course->marker && $course->marker <= $destination) {
1643         course_set_marker($course->id, $course->marker-1);
1644     }
1646     $transaction->allow_commit();
1647     rebuild_course_cache($course->id, true);
1648     return true;
1651 /**
1652  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1653  * an original position number and a target position number, rebuilds the array so that the
1654  * move is made without any duplication of section positions.
1655  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1656  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1657  *
1658  * @param array $sections
1659  * @param int $origin_position
1660  * @param int $target_position
1661  * @return array
1662  */
1663 function reorder_sections($sections, $origin_position, $target_position) {
1664     if (!is_array($sections)) {
1665         return false;
1666     }
1668     // We can't move section position 0
1669     if ($origin_position < 1) {
1670         echo "We can't move section position 0";
1671         return false;
1672     }
1674     // Locate origin section in sections array
1675     if (!$origin_key = array_search($origin_position, $sections)) {
1676         echo "searched position not in sections array";
1677         return false; // searched position not in sections array
1678     }
1680     // Extract origin section
1681     $origin_section = $sections[$origin_key];
1682     unset($sections[$origin_key]);
1684     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1685     $found = false;
1686     $append_array = array();
1687     foreach ($sections as $id => $position) {
1688         if ($found) {
1689             $append_array[$id] = $position;
1690             unset($sections[$id]);
1691         }
1692         if ($position == $target_position) {
1693             if ($target_position < $origin_position) {
1694                 $append_array[$id] = $position;
1695                 unset($sections[$id]);
1696             }
1697             $found = true;
1698         }
1699     }
1701     // Append moved section
1702     $sections[$origin_key] = $origin_section;
1704     // Append rest of array (if applicable)
1705     if (!empty($append_array)) {
1706         foreach ($append_array as $id => $position) {
1707             $sections[$id] = $position;
1708         }
1709     }
1711     // Renumber positions
1712     $position = 0;
1713     foreach ($sections as $id => $p) {
1714         $sections[$id] = $position;
1715         $position++;
1716     }
1718     return $sections;
1722 /**
1723  * Move the module object $mod to the specified $section
1724  * If $beforemod exists then that is the module
1725  * before which $modid should be inserted
1726  * All parameters are objects
1727  */
1728 function moveto_module($mod, $section, $beforemod=NULL) {
1729     global $OUTPUT, $DB;
1731 /// Remove original module from original section
1732     if (! delete_mod_from_section($mod->id, $mod->section)) {
1733         echo $OUTPUT->notification("Could not delete module from existing section");
1734     }
1736     // if moving to a hidden section then hide module
1737     if ($mod->section != $section->id) {
1738         if (!$section->visible && $mod->visible) {
1739             // Set this in the object because it is sent as a response to ajax calls.
1740             $mod->visible = 0;
1741             set_coursemodule_visible($mod->id, 0);
1742             // Set visibleold to 1 so module will be visible when section is made visible.
1743             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1744         }
1745         if ($section->visible && !$mod->visible) {
1746             set_coursemodule_visible($mod->id, $mod->visibleold);
1747             // Set this in the object because it is sent as a response to ajax calls.
1748             $mod->visible = $mod->visibleold;
1749         }
1750     }
1752 /// Add the module into the new section
1753     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
1754     return true;
1757 /**
1758  * Returns the list of all editing actions that current user can perform on the module
1759  *
1760  * @param cm_info $mod The module to produce editing buttons for
1761  * @param int $indent The current indenting (default -1 means no move left-right actions)
1762  * @param int $sr The section to link back to (used for creating the links)
1763  * @return array array of action_link or pix_icon objects
1764  */
1765 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
1766     global $COURSE, $SITE;
1768     static $str;
1770     $coursecontext = context_course::instance($mod->course);
1771     $modcontext = context_module::instance($mod->id);
1773     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1774     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1776     // No permission to edit anything.
1777     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1778         return array();
1779     }
1781     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1783     if (!isset($str)) {
1784         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1785             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
1786         $str->assign         = get_string('assignroles', 'role');
1787         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1788         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1789         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1790         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
1791         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
1792         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
1793     }
1795     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1797     if ($sr !== null) {
1798         $baseurl->param('sr', $sr);
1799     }
1800     $actions = array();
1802     // AJAX edit title.
1803     if ($mod->has_view() && $hasmanageactivities &&
1804                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
1805                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
1806         // we will not display link if we are on some other-course page (where we should not see this module anyway)
1807         $actions['title'] = new action_menu_link_secondary(
1808             new moodle_url($baseurl, array('update' => $mod->id)),
1809             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
1810             $str->edittitle,
1811             array('class' => 'editing_title', 'data-action' => 'edittitle')
1812         );
1813     }
1815     // Indent.
1816     if ($hasmanageactivities) {
1817         if (right_to_left()) {   // Exchange arrows on RTL
1818             $rightarrow = 't/left';
1819             $leftarrow  = 't/right';
1820         } else {
1821             $rightarrow = 't/right';
1822             $leftarrow  = 't/left';
1823         }
1825         $hiddenclass = 'hidden';
1826         if ($indent > 0) {
1827             $hiddenclass = '';
1828         }
1829         $actions['moveleft'] = new action_menu_link_secondary(
1830             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
1831             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1832             $str->moveleft,
1833             array('class' => 'editing_moveleft ' . $hiddenclass, 'data-action' => 'moveleft')
1834         );
1835         $hiddenclass = 'hidden';
1836         if ($indent >= 0) {
1837             $hiddenclass = '';
1838         }
1839         $actions['moveright'] = new action_menu_link_secondary(
1840             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
1841             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1842             $str->moveright,
1843             array('class' => 'editing_moveright ' . $hiddenclass, 'data-action' => 'moveright')
1844         );
1845     }
1847     // Move.
1848     if ($hasmanageactivities) {
1849         $actions['move'] = new action_menu_link_primary(
1850             new moodle_url($baseurl, array('copy' => $mod->id)),
1851             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1852             $str->move,
1853             array('class' => 'editing_move status', 'data-action' => 'move')
1854         );
1855     }
1857     // Update.
1858     if ($hasmanageactivities) {
1859         $actions['update'] = new action_menu_link_secondary(
1860             new moodle_url($baseurl, array('update' => $mod->id)),
1861             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1862             $str->update,
1863             array('class' => 'editing_update', 'data-action' => 'update')
1864         );
1865     }
1867     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1868     // Note that restoring on front page is never allowed.
1869     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
1870             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
1871         $actions['duplicate'] = new action_menu_link_secondary(
1872             new moodle_url($baseurl, array('duplicate' => $mod->id)),
1873             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1874             $str->duplicate,
1875             array('class' => 'editing_duplicate', 'data-action' => 'duplicate')
1876         );
1877     }
1879     // Delete.
1880     if ($hasmanageactivities) {
1881         $actions['delete'] = new action_menu_link_secondary(
1882             new moodle_url($baseurl, array('delete' => $mod->id)),
1883             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1884             $str->delete,
1885             array('class' => 'editing_delete', 'data-action' => 'delete')
1886         );
1887     }
1889     // Hide/Show.
1890     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1891         if ($mod->visible) {
1892             $actions['hide'] = new action_menu_link_primary(
1893                 new moodle_url($baseurl, array('hide' => $mod->id)),
1894                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1895                 $str->hide,
1896                 array('class' => 'editing_hide', 'data-action' => 'hide')
1897             );
1898         } else {
1899             $actions['show'] = new action_menu_link_primary(
1900                 new moodle_url($baseurl, array('show' => $mod->id)),
1901                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1902                 $str->show,
1903                 array('class' => 'editing_show', 'data-action' => 'show')
1904             );
1905         }
1906     }
1908     // Groupmode.
1909     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1910         if ($mod->coursegroupmodeforce) {
1911             $modgroupmode = $mod->coursegroupmode;
1912         } else {
1913             $modgroupmode = $mod->groupmode;
1914         }
1915         if ($modgroupmode == SEPARATEGROUPS) {
1916             $nextgroupmode = VISIBLEGROUPS;
1917             $grouptitle = $str->groupsseparate;
1918             $forcedgrouptitle = $str->forcedgroupsseparate;
1919             $actionname = 'groupsseparate';
1920             $groupimage = 't/groups';
1921         } else if ($modgroupmode == VISIBLEGROUPS) {
1922             $nextgroupmode = NOGROUPS;
1923             $grouptitle = $str->groupsvisible;
1924             $forcedgrouptitle = $str->forcedgroupsvisible;
1925             $actionname = 'groupsvisible';
1926             $groupimage = 't/groupv';
1927         } else {
1928             $nextgroupmode = SEPARATEGROUPS;
1929             $grouptitle = $str->groupsnone;
1930             $forcedgrouptitle = $str->forcedgroupsnone;
1931             $actionname = 'groupsnone';
1932             $groupimage = 't/groupn';
1933         }
1934         if (!$mod->coursegroupmodeforce) {
1935             $actions[$actionname] = new action_menu_link_primary(
1936                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
1937                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1938                 $grouptitle,
1939                 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode)
1940             );
1941         } else {
1942             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => '', 'class' => 'iconsmall'));
1943         }
1944     }
1946     // Assign.
1947     if (has_capability('moodle/role:assign', $modcontext)){
1948         $actions['assign'] = new action_menu_link_secondary(
1949             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
1950             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1951             $str->assign,
1952             array('class' => 'editing_assign', 'data-action' => 'assignroles')
1953         );
1954     }
1956     return $actions;
1959 /**
1960  * given a course object with shortname & fullname, this function will
1961  * truncate the the number of chars allowed and add ... if it was too long
1962  */
1963 function course_format_name ($course,$max=100) {
1965     $context = context_course::instance($course->id);
1966     $shortname = format_string($course->shortname, true, array('context' => $context));
1967     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
1968     $str = $shortname.': '. $fullname;
1969     if (core_text::strlen($str) <= $max) {
1970         return $str;
1971     }
1972     else {
1973         return core_text::substr($str,0,$max-3).'...';
1974     }
1977 /**
1978  * Is the user allowed to add this type of module to this course?
1979  * @param object $course the course settings. Only $course->id is used.
1980  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
1981  * @return bool whether the current user is allowed to add this type of module to this course.
1982  */
1983 function course_allowed_module($course, $modname) {
1984     if (is_numeric($modname)) {
1985         throw new coding_exception('Function course_allowed_module no longer
1986                 supports numeric module ids. Please update your code to pass the module name.');
1987     }
1989     $capability = 'mod/' . $modname . ':addinstance';
1990     if (!get_capability_info($capability)) {
1991         // Debug warning that the capability does not exist, but no more than once per page.
1992         static $warned = array();
1993         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1994         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
1995             debugging('The module ' . $modname . ' does not define the standard capability ' .
1996                     $capability , DEBUG_DEVELOPER);
1997             $warned[$modname] = 1;
1998         }
2000         // If the capability does not exist, the module can always be added.
2001         return true;
2002     }
2004     $coursecontext = context_course::instance($course->id);
2005     return has_capability($capability, $coursecontext);
2008 /**
2009  * Efficiently moves many courses around while maintaining
2010  * sortorder in order.
2011  *
2012  * @param array $courseids is an array of course ids
2013  * @param int $categoryid
2014  * @return bool success
2015  */
2016 function move_courses($courseids, $categoryid) {
2017     global $CFG, $DB, $OUTPUT;
2019     if (empty($courseids)) {
2020         // nothing to do
2021         return;
2022     }
2024     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
2025         return false;
2026     }
2028     $courseids = array_reverse($courseids);
2029     $newparent = context_coursecat::instance($category->id);
2030     $i = 1;
2032     foreach ($courseids as $courseid) {
2033         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
2034             $course = new stdClass();
2035             $course->id = $courseid;
2036             $course->category  = $category->id;
2037             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2038             if ($category->visible == 0) {
2039                 // hide the course when moving into hidden category,
2040                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
2041                 $course->visible = 0;
2042             }
2044             $DB->update_record('course', $course);
2045             add_to_log($course->id, "course", "move", "edit.php?id=$course->id", $course->id);
2047             $context   = context_course::instance($course->id);
2048             $context->update_moved($newparent);
2049         }
2050     }
2051     fix_course_sortorder();
2052     cache_helper::purge_by_event('changesincourse');
2054     return true;
2057 /**
2058  * Returns the display name of the given section that the course prefers
2059  *
2060  * Implementation of this function is provided by course format
2061  * @see format_base::get_section_name()
2062  *
2063  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2064  * @param int|stdClass $section Section object from database or just field course_sections.section
2065  * @return string Display name that the course format prefers, e.g. "Week 2"
2066  */
2067 function get_section_name($courseorid, $section) {
2068     return course_get_format($courseorid)->get_section_name($section);
2071 /**
2072  * Tells if current course format uses sections
2073  *
2074  * @param string $format Course format ID e.g. 'weeks' $course->format
2075  * @return bool
2076  */
2077 function course_format_uses_sections($format) {
2078     $course = new stdClass();
2079     $course->format = $format;
2080     return course_get_format($course)->uses_sections();
2083 /**
2084  * Returns the information about the ajax support in the given source format
2085  *
2086  * The returned object's property (boolean)capable indicates that
2087  * the course format supports Moodle course ajax features.
2088  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
2089  *
2090  * @param string $format
2091  * @return stdClass
2092  */
2093 function course_format_ajax_support($format) {
2094     $course = new stdClass();
2095     $course->format = $format;
2096     return course_get_format($course)->supports_ajax();
2099 /**
2100  * Can the current user delete this course?
2101  * Course creators have exception,
2102  * 1 day after the creation they can sill delete the course.
2103  * @param int $courseid
2104  * @return boolean
2105  */
2106 function can_delete_course($courseid) {
2107     global $USER, $DB;
2109     $context = context_course::instance($courseid);
2111     if (has_capability('moodle/course:delete', $context)) {
2112         return true;
2113     }
2115     // hack: now try to find out if creator created this course recently (1 day)
2116     if (!has_capability('moodle/course:create', $context)) {
2117         return false;
2118     }
2120     $since = time() - 60*60*24;
2122     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
2123     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
2125     return $DB->record_exists_select('log', $select, $params);
2128 /**
2129  * Save the Your name for 'Some role' strings.
2130  *
2131  * @param integer $courseid the id of this course.
2132  * @param array $data the data that came from the course settings form.
2133  */
2134 function save_local_role_names($courseid, $data) {
2135     global $DB;
2136     $context = context_course::instance($courseid);
2138     foreach ($data as $fieldname => $value) {
2139         if (strpos($fieldname, 'role_') !== 0) {
2140             continue;
2141         }
2142         list($ignored, $roleid) = explode('_', $fieldname);
2144         // make up our mind whether we want to delete, update or insert
2145         if (!$value) {
2146             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2148         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2149             $rolename->name = $value;
2150             $DB->update_record('role_names', $rolename);
2152         } else {
2153             $rolename = new stdClass;
2154             $rolename->contextid = $context->id;
2155             $rolename->roleid = $roleid;
2156             $rolename->name = $value;
2157             $DB->insert_record('role_names', $rolename);
2158         }
2159     }
2162 /**
2163  * Returns options to use in course overviewfiles filemanager
2164  *
2165  * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2166  *     may be empty if course does not exist yet (course create form)
2167  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2168  *     or null if overviewfiles are disabled
2169  */
2170 function course_overviewfiles_options($course) {
2171     global $CFG;
2172     if (empty($CFG->courseoverviewfileslimit)) {
2173         return null;
2174     }
2175     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2176     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2177         $accepted_types = '*';
2178     } else {
2179         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2180         // Make sure extensions are prefixed with dot unless they are valid typegroups
2181         foreach ($accepted_types as $i => $type) {
2182             if (substr($type, 0, 1) !== '.') {
2183                 require_once($CFG->libdir. '/filelib.php');
2184                 if (!count(file_get_typegroup('extension', $type))) {
2185                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2186                     $accepted_types[$i] = '.'. $type;
2187                     $corrected = true;
2188                 }
2189             }
2190         }
2191         if (!empty($corrected)) {
2192             set_config('courseoverviewfilesext', join(',', $accepted_types));
2193         }
2194     }
2195     $options = array(
2196         'maxfiles' => $CFG->courseoverviewfileslimit,
2197         'maxbytes' => $CFG->maxbytes,
2198         'subdirs' => 0,
2199         'accepted_types' => $accepted_types
2200     );
2201     if (!empty($course->id)) {
2202         $options['context'] = context_course::instance($course->id);
2203     } else if (is_int($course) && $course > 0) {
2204         $options['context'] = context_course::instance($course);
2205     }
2206     return $options;
2209 /**
2210  * Create a course and either return a $course object
2211  *
2212  * Please note this functions does not verify any access control,
2213  * the calling code is responsible for all validation (usually it is the form definition).
2214  *
2215  * @param array $editoroptions course description editor options
2216  * @param object $data  - all the data needed for an entry in the 'course' table
2217  * @return object new course instance
2218  */
2219 function create_course($data, $editoroptions = NULL) {
2220     global $CFG, $DB;
2222     //check the categoryid - must be given for all new courses
2223     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2225     //check if the shortname already exist
2226     if (!empty($data->shortname)) {
2227         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2228             throw new moodle_exception('shortnametaken');
2229         }
2230     }
2232     //check if the id number already exist
2233     if (!empty($data->idnumber)) {
2234         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2235             throw new moodle_exception('idnumbertaken');
2236         }
2237     }
2239     $data->timecreated  = time();
2240     $data->timemodified = $data->timecreated;
2242     // place at beginning of any category
2243     $data->sortorder = 0;
2245     if ($editoroptions) {
2246         // summary text is updated later, we need context to store the files first
2247         $data->summary = '';
2248         $data->summary_format = FORMAT_HTML;
2249     }
2251     if (!isset($data->visible)) {
2252         // data not from form, add missing visibility info
2253         $data->visible = $category->visible;
2254     }
2255     $data->visibleold = $data->visible;
2257     $newcourseid = $DB->insert_record('course', $data);
2258     $context = context_course::instance($newcourseid, MUST_EXIST);
2260     if ($editoroptions) {
2261         // Save the files used in the summary editor and store
2262         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2263         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2264         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2265     }
2266     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2267         // Save the course overviewfiles
2268         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2269     }
2271     // update course format options
2272     course_get_format($newcourseid)->update_course_format_options($data);
2274     $course = course_get_format($newcourseid)->get_course();
2276     // Setup the blocks
2277     blocks_add_default_course_blocks($course);
2279     // Create a default section.
2280     course_create_sections_if_missing($course, 0);
2282     fix_course_sortorder();
2283     // purge appropriate caches in case fix_course_sortorder() did not change anything
2284     cache_helper::purge_by_event('changesincourse');
2286     // new context created - better mark it as dirty
2287     $context->mark_dirty();
2289     // Save any custom role names.
2290     save_local_role_names($course->id, (array)$data);
2292     // set up enrolments
2293     enrol_course_updated(true, $course, $data);
2295     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
2297     // Trigger events
2298     events_trigger('course_created', $course);
2300     return $course;
2303 /**
2304  * Update a course.
2305  *
2306  * Please note this functions does not verify any access control,
2307  * the calling code is responsible for all validation (usually it is the form definition).
2308  *
2309  * @param object $data  - all the data needed for an entry in the 'course' table
2310  * @param array $editoroptions course description editor options
2311  * @return void
2312  */
2313 function update_course($data, $editoroptions = NULL) {
2314     global $CFG, $DB;
2316     $data->timemodified = time();
2318     $oldcourse = course_get_format($data->id)->get_course();
2319     $context   = context_course::instance($oldcourse->id);
2321     if ($editoroptions) {
2322         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2323     }
2324     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2325         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2326     }
2328     if (!isset($data->category) or empty($data->category)) {
2329         // prevent nulls and 0 in category field
2330         unset($data->category);
2331     }
2332     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2334     if (!isset($data->visible)) {
2335         // data not from form, add missing visibility info
2336         $data->visible = $oldcourse->visible;
2337     }
2339     if ($data->visible != $oldcourse->visible) {
2340         // reset the visibleold flag when manually hiding/unhiding course
2341         $data->visibleold = $data->visible;
2342         $changesincoursecat = true;
2343     } else {
2344         if ($movecat) {
2345             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2346             if (empty($newcategory->visible)) {
2347                 // make sure when moving into hidden category the course is hidden automatically
2348                 $data->visible = 0;
2349             }
2350         }
2351     }
2353     // Update with the new data
2354     $DB->update_record('course', $data);
2355     // make sure the modinfo cache is reset
2356     rebuild_course_cache($data->id);
2358     // update course format options with full course data
2359     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2361     $course = $DB->get_record('course', array('id'=>$data->id));
2363     if ($movecat) {
2364         $newparent = context_coursecat::instance($course->category);
2365         $context->update_moved($newparent);
2366     }
2368     fix_course_sortorder();
2369     // purge appropriate caches in case fix_course_sortorder() did not change anything
2370     cache_helper::purge_by_event('changesincourse');
2371     if ($changesincoursecat) {
2372         cache_helper::purge_by_event('changesincoursecat');
2373     }
2375     // Test for and remove blocks which aren't appropriate anymore
2376     blocks_remove_inappropriate($course);
2378     // Save any custom role names.
2379     save_local_role_names($course->id, $data);
2381     // update enrol settings
2382     enrol_course_updated(false, $course, $data);
2384     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
2386     // Trigger events
2387     events_trigger('course_updated', $course);
2389     if ($oldcourse->format !== $course->format) {
2390         // Remove all options stored for the previous format
2391         // We assume that new course format migrated everything it needed watching trigger
2392         // 'course_updated' and in method format_XXX::update_course_format_options()
2393         $DB->delete_records('course_format_options',
2394                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2395     }
2398 /**
2399  * Average number of participants
2400  * @return integer
2401  */
2402 function average_number_of_participants() {
2403     global $DB, $SITE;
2405     //count total of enrolments for visible course (except front page)
2406     $sql = 'SELECT COUNT(*) FROM (
2407         SELECT DISTINCT ue.userid, e.courseid
2408         FROM {user_enrolments} ue, {enrol} e, {course} c
2409         WHERE ue.enrolid = e.id
2410             AND e.courseid <> :siteid
2411             AND c.id = e.courseid
2412             AND c.visible = 1) total';
2413     $params = array('siteid' => $SITE->id);
2414     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2417     //count total of visible courses (minus front page)
2418     $coursetotal = $DB->count_records('course', array('visible' => 1));
2419     $coursetotal = $coursetotal - 1 ;
2421     //average of enrolment
2422     if (empty($coursetotal)) {
2423         $participantaverage = 0;
2424     } else {
2425         $participantaverage = $enrolmenttotal / $coursetotal;
2426     }
2428     return $participantaverage;
2431 /**
2432  * Average number of course modules
2433  * @return integer
2434  */
2435 function average_number_of_courses_modules() {
2436     global $DB, $SITE;
2438     //count total of visible course module (except front page)
2439     $sql = 'SELECT COUNT(*) FROM (
2440         SELECT cm.course, cm.module
2441         FROM {course} c, {course_modules} cm
2442         WHERE c.id = cm.course
2443             AND c.id <> :siteid
2444             AND cm.visible = 1
2445             AND c.visible = 1) total';
2446     $params = array('siteid' => $SITE->id);
2447     $moduletotal = $DB->count_records_sql($sql, $params);
2450     //count total of visible courses (minus front page)
2451     $coursetotal = $DB->count_records('course', array('visible' => 1));
2452     $coursetotal = $coursetotal - 1 ;
2454     //average of course module
2455     if (empty($coursetotal)) {
2456         $coursemoduleaverage = 0;
2457     } else {
2458         $coursemoduleaverage = $moduletotal / $coursetotal;
2459     }
2461     return $coursemoduleaverage;
2464 /**
2465  * This class pertains to course requests and contains methods associated with
2466  * create, approving, and removing course requests.
2467  *
2468  * Please note we do not allow embedded images here because there is no context
2469  * to store them with proper access control.
2470  *
2471  * @copyright 2009 Sam Hemelryk
2472  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2473  * @since Moodle 2.0
2474  *
2475  * @property-read int $id
2476  * @property-read string $fullname
2477  * @property-read string $shortname
2478  * @property-read string $summary
2479  * @property-read int $summaryformat
2480  * @property-read int $summarytrust
2481  * @property-read string $reason
2482  * @property-read int $requester
2483  */
2484 class course_request {
2486     /**
2487      * This is the stdClass that stores the properties for the course request
2488      * and is externally accessed through the __get magic method
2489      * @var stdClass
2490      */
2491     protected $properties;
2493     /**
2494      * An array of options for the summary editor used by course request forms.
2495      * This is initially set by {@link summary_editor_options()}
2496      * @var array
2497      * @static
2498      */
2499     protected static $summaryeditoroptions;
2501     /**
2502      * Static function to prepare the summary editor for working with a course
2503      * request.
2504      *
2505      * @static
2506      * @param null|stdClass $data Optional, an object containing the default values
2507      *                       for the form, these may be modified when preparing the
2508      *                       editor so this should be called before creating the form
2509      * @return stdClass An object that can be used to set the default values for
2510      *                   an mforms form
2511      */
2512     public static function prepare($data=null) {
2513         if ($data === null) {
2514             $data = new stdClass;
2515         }
2516         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2517         return $data;
2518     }
2520     /**
2521      * Static function to create a new course request when passed an array of properties
2522      * for it.
2523      *
2524      * This function also handles saving any files that may have been used in the editor
2525      *
2526      * @static
2527      * @param stdClass $data
2528      * @return course_request The newly created course request
2529      */
2530     public static function create($data) {
2531         global $USER, $DB, $CFG;
2532         $data->requester = $USER->id;
2534         // Setting the default category if none set.
2535         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2536             $data->category = $CFG->defaultrequestcategory;
2537         }
2539         // Summary is a required field so copy the text over
2540         $data->summary       = $data->summary_editor['text'];
2541         $data->summaryformat = $data->summary_editor['format'];
2543         $data->id = $DB->insert_record('course_request', $data);
2545         // Create a new course_request object and return it
2546         $request = new course_request($data);
2548         // Notify the admin if required.
2549         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2551             $a = new stdClass;
2552             $a->link = "$CFG->wwwroot/course/pending.php";
2553             $a->user = fullname($USER);
2554             $subject = get_string('courserequest');
2555             $message = get_string('courserequestnotifyemail', 'admin', $a);
2556             foreach ($users as $user) {
2557                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2558             }
2559         }
2561         return $request;
2562     }
2564     /**
2565      * Returns an array of options to use with a summary editor
2566      *
2567      * @uses course_request::$summaryeditoroptions
2568      * @return array An array of options to use with the editor
2569      */
2570     public static function summary_editor_options() {
2571         global $CFG;
2572         if (self::$summaryeditoroptions === null) {
2573             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2574         }
2575         return self::$summaryeditoroptions;
2576     }
2578     /**
2579      * Loads the properties for this course request object. Id is required and if
2580      * only id is provided then we load the rest of the properties from the database
2581      *
2582      * @param stdClass|int $properties Either an object containing properties
2583      *                      or the course_request id to load
2584      */
2585     public function __construct($properties) {
2586         global $DB;
2587         if (empty($properties->id)) {
2588             if (empty($properties)) {
2589                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2590             }
2591             $id = $properties;
2592             $properties = new stdClass;
2593             $properties->id = (int)$id;
2594             unset($id);
2595         }
2596         if (empty($properties->requester)) {
2597             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2598                 print_error('unknowncourserequest');
2599             }
2600         } else {
2601             $this->properties = $properties;
2602         }
2603         $this->properties->collision = null;
2604     }
2606     /**
2607      * Returns the requested property
2608      *
2609      * @param string $key
2610      * @return mixed
2611      */
2612     public function __get($key) {
2613         return $this->properties->$key;
2614     }
2616     /**
2617      * Override this to ensure empty($request->blah) calls return a reliable answer...
2618      *
2619      * This is required because we define the __get method
2620      *
2621      * @param mixed $key
2622      * @return bool True is it not empty, false otherwise
2623      */
2624     public function __isset($key) {
2625         return (!empty($this->properties->$key));
2626     }
2628     /**
2629      * Returns the user who requested this course
2630      *
2631      * Uses a static var to cache the results and cut down the number of db queries
2632      *
2633      * @staticvar array $requesters An array of cached users
2634      * @return stdClass The user who requested the course
2635      */
2636     public function get_requester() {
2637         global $DB;
2638         static $requesters= array();
2639         if (!array_key_exists($this->properties->requester, $requesters)) {
2640             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
2641         }
2642         return $requesters[$this->properties->requester];
2643     }
2645     /**
2646      * Checks that the shortname used by the course does not conflict with any other
2647      * courses that exist
2648      *
2649      * @param string|null $shortnamemark The string to append to the requests shortname
2650      *                     should a conflict be found
2651      * @return bool true is there is a conflict, false otherwise
2652      */
2653     public function check_shortname_collision($shortnamemark = '[*]') {
2654         global $DB;
2656         if ($this->properties->collision !== null) {
2657             return $this->properties->collision;
2658         }
2660         if (empty($this->properties->shortname)) {
2661             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
2662             $this->properties->collision = false;
2663         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
2664             if (!empty($shortnamemark)) {
2665                 $this->properties->shortname .= ' '.$shortnamemark;
2666             }
2667             $this->properties->collision = true;
2668         } else {
2669             $this->properties->collision = false;
2670         }
2671         return $this->properties->collision;
2672     }
2674     /**
2675      * Returns the category where this course request should be created
2676      *
2677      * Note that we don't check here that user has a capability to view
2678      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2679      * 'moodle/course:changecategory'
2680      *
2681      * @return coursecat
2682      */
2683     public function get_category() {
2684         global $CFG;
2685         require_once($CFG->libdir.'/coursecatlib.php');
2686         // If the category is not set, if the current user does not have the rights to change the category, or if the
2687         // category does not exist, we set the default category to the course to be approved.
2688         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2689         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
2690                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
2691             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
2692         }
2693         if (!$category) {
2694             $category = coursecat::get_default();
2695         }
2696         return $category;
2697     }
2699     /**
2700      * This function approves the request turning it into a course
2701      *
2702      * This function converts the course request into a course, at the same time
2703      * transferring any files used in the summary to the new course and then removing
2704      * the course request and the files associated with it.
2705      *
2706      * @return int The id of the course that was created from this request
2707      */
2708     public function approve() {
2709         global $CFG, $DB, $USER;
2711         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
2713         $courseconfig = get_config('moodlecourse');
2715         // Transfer appropriate settings
2716         $data = clone($this->properties);
2717         unset($data->id);
2718         unset($data->reason);
2719         unset($data->requester);
2721         // Set category
2722         $category = $this->get_category();
2723         $data->category = $category->id;
2724         // Set misc settings
2725         $data->requested = 1;
2727         // Apply course default settings
2728         $data->format             = $courseconfig->format;
2729         $data->newsitems          = $courseconfig->newsitems;
2730         $data->showgrades         = $courseconfig->showgrades;
2731         $data->showreports        = $courseconfig->showreports;
2732         $data->maxbytes           = $courseconfig->maxbytes;
2733         $data->groupmode          = $courseconfig->groupmode;
2734         $data->groupmodeforce     = $courseconfig->groupmodeforce;
2735         $data->visible            = $courseconfig->visible;
2736         $data->visibleold         = $data->visible;
2737         $data->lang               = $courseconfig->lang;
2739         $course = create_course($data);
2740         $context = context_course::instance($course->id, MUST_EXIST);
2742         // add enrol instances
2743         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
2744             if ($manual = enrol_get_plugin('manual')) {
2745                 $manual->add_default_instance($course);
2746             }
2747         }
2749         // enrol the requester as teacher if necessary
2750         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2751             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
2752         }
2754         $this->delete();
2756         $a = new stdClass();
2757         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2758         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
2759         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
2761         return $course->id;
2762     }
2764     /**
2765      * Reject a course request
2766      *
2767      * This function rejects a course request, emailing the requesting user the
2768      * provided notice and then removing the request from the database
2769      *
2770      * @param string $notice The message to display to the user
2771      */
2772     public function reject($notice) {
2773         global $USER, $DB;
2774         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
2775         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
2776         $this->delete();
2777     }
2779     /**
2780      * Deletes the course request and any associated files
2781      */
2782     public function delete() {
2783         global $DB;
2784         $DB->delete_records('course_request', array('id' => $this->properties->id));
2785     }
2787     /**
2788      * Send a message from one user to another using events_trigger
2789      *
2790      * @param object $touser
2791      * @param object $fromuser
2792      * @param string $name
2793      * @param string $subject
2794      * @param string $message
2795      */
2796     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
2797         $eventdata = new stdClass();
2798         $eventdata->component         = 'moodle';
2799         $eventdata->name              = $name;
2800         $eventdata->userfrom          = $fromuser;
2801         $eventdata->userto            = $touser;
2802         $eventdata->subject           = $subject;
2803         $eventdata->fullmessage       = $message;
2804         $eventdata->fullmessageformat = FORMAT_PLAIN;
2805         $eventdata->fullmessagehtml   = '';
2806         $eventdata->smallmessage      = '';
2807         $eventdata->notification      = 1;
2808         message_send($eventdata);
2809     }
2812 /**
2813  * Return a list of page types
2814  * @param string $pagetype current page type
2815  * @param context $parentcontext Block's parent context
2816  * @param context $currentcontext Current context of block
2817  * @return array array of page types
2818  */
2819 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
2820     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
2821         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
2822         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2823             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
2824         );
2825     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
2826         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
2827         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
2828     } else {
2829         // Otherwise consider it a page inside a course even if $currentcontext is null
2830         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2831             'course-*' => get_string('page-course-x', 'pagetype'),
2832             'course-view-*' => get_string('page-course-view-x', 'pagetype')
2833         );
2834     }
2835     return $pagetypes;
2838 /**
2839  * Determine whether course ajax should be enabled for the specified course
2840  *
2841  * @param stdClass $course The course to test against
2842  * @return boolean Whether course ajax is enabled or note
2843  */
2844 function course_ajax_enabled($course) {
2845     global $CFG, $PAGE, $SITE;
2847     // Ajax must be enabled globally
2848     if (!$CFG->enableajax) {
2849         return false;
2850     }
2852     // The user must be editing for AJAX to be included
2853     if (!$PAGE->user_is_editing()) {
2854         return false;
2855     }
2857     // Check that the theme suports
2858     if (!$PAGE->theme->enablecourseajax) {
2859         return false;
2860     }
2862     // Check that the course format supports ajax functionality
2863     // The site 'format' doesn't have information on course format support
2864     if ($SITE->id !== $course->id) {
2865         $courseformatajaxsupport = course_format_ajax_support($course->format);
2866         if (!$courseformatajaxsupport->capable) {
2867             return false;
2868         }
2869     }
2871     // All conditions have been met so course ajax should be enabled
2872     return true;
2875 /**
2876  * Include the relevant javascript and language strings for the resource
2877  * toolbox YUI module
2878  *
2879  * @param integer $id The ID of the course being applied to
2880  * @param array $usedmodules An array containing the names of the modules in use on the page
2881  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
2882  * @param stdClass $config An object containing configuration parameters for ajax modules including:
2883  *          * resourceurl   The URL to post changes to for resource changes
2884  *          * sectionurl    The URL to post changes to for section changes
2885  *          * pageparams    Additional parameters to pass through in the post
2886  * @return bool
2887  */
2888 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
2889     global $PAGE, $SITE;
2891     // Ensure that ajax should be included
2892     if (!course_ajax_enabled($course)) {
2893         return false;
2894     }
2896     if (!$config) {
2897         $config = new stdClass();
2898     }
2900     // The URL to use for resource changes
2901     if (!isset($config->resourceurl)) {
2902         $config->resourceurl = '/course/rest.php';
2903     }
2905     // The URL to use for section changes
2906     if (!isset($config->sectionurl)) {
2907         $config->sectionurl = '/course/rest.php';
2908     }
2910     // Any additional parameters which need to be included on page submission
2911     if (!isset($config->pageparams)) {
2912         $config->pageparams = array();
2913     }
2915     // Include toolboxes
2916     $PAGE->requires->yui_module('moodle-course-toolboxes',
2917             'M.course.init_resource_toolbox',
2918             array(array(
2919                 'courseid' => $course->id,
2920                 'ajaxurl' => $config->resourceurl,
2921                 'config' => $config,
2922             ))
2923     );
2924     $PAGE->requires->yui_module('moodle-course-toolboxes',
2925             'M.course.init_section_toolbox',
2926             array(array(
2927                 'courseid' => $course->id,
2928                 'format' => $course->format,
2929                 'ajaxurl' => $config->sectionurl,
2930                 'config' => $config,
2931             ))
2932     );
2934     // Include course dragdrop
2935     if ($course->id != $SITE->id) {
2936         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
2937             array(array(
2938                 'courseid' => $course->id,
2939                 'ajaxurl' => $config->sectionurl,
2940                 'config' => $config,
2941             )), null, true);
2943         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
2944             array(array(
2945                 'courseid' => $course->id,
2946                 'ajaxurl' => $config->resourceurl,
2947                 'config' => $config,
2948             )), null, true);
2949     }
2951     // Require various strings for the command toolbox
2952     $PAGE->requires->strings_for_js(array(
2953             'moveleft',
2954             'deletechecktype',
2955             'deletechecktypename',
2956             'edittitle',
2957             'edittitleinstructions',
2958             'show',
2959             'hide',
2960             'groupsnone',
2961             'groupsvisible',
2962             'groupsseparate',
2963             'clicktochangeinbrackets',
2964             'markthistopic',
2965             'markedthistopic',
2966             'move',
2967             'movesection',
2968         ), 'moodle');
2970     // Include format-specific strings
2971     if ($course->id != $SITE->id) {
2972         $PAGE->requires->strings_for_js(array(
2973                 'showfromothers',
2974                 'hidefromothers',
2975             ), 'format_' . $course->format);
2976     }
2978     // For confirming resource deletion we need the name of the module in question
2979     foreach ($usedmodules as $module => $modname) {
2980         $PAGE->requires->string_for_js('pluginname', $module);
2981     }
2983     // Load drag and drop upload AJAX.
2984     dndupload_add_to_course($course, $enabledmodules);
2986     return true;
2989 /**
2990  * Returns the sorted list of available course formats, filtered by enabled if necessary
2991  *
2992  * @param bool $enabledonly return only formats that are enabled
2993  * @return array array of sorted format names
2994  */
2995 function get_sorted_course_formats($enabledonly = false) {
2996     global $CFG;
2997     $formats = core_component::get_plugin_list('format');
2999     if (!empty($CFG->format_plugins_sortorder)) {
3000         $order = explode(',', $CFG->format_plugins_sortorder);
3001         $order = array_merge(array_intersect($order, array_keys($formats)),
3002                     array_diff(array_keys($formats), $order));
3003     } else {
3004         $order = array_keys($formats);
3005     }
3006     if (!$enabledonly) {
3007         return $order;
3008     }
3009     $sortedformats = array();
3010     foreach ($order as $formatname) {
3011         if (!get_config('format_'.$formatname, 'disabled')) {
3012             $sortedformats[] = $formatname;
3013         }
3014     }
3015     return $sortedformats;
3018 /**
3019  * The URL to use for the specified course (with section)
3020  *
3021  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3022  * @param int|stdClass $section Section object from database or just field course_sections.section
3023  *     if omitted the course view page is returned
3024  * @param array $options options for view URL. At the moment core uses:
3025  *     'navigation' (bool) if true and section has no separate page, the function returns null
3026  *     'sr' (int) used by multipage formats to specify to which section to return
3027  * @return moodle_url The url of course
3028  */
3029 function course_get_url($courseorid, $section = null, $options = array()) {
3030     return course_get_format($courseorid)->get_view_url($section, $options);
3033 /**
3034  * Create a module.
3035  *
3036  * It includes:
3037  *      - capability checks and other checks
3038  *      - create the module from the module info
3039  *
3040  * @param object $module
3041  * @return object the created module info
3042  */
3043 function create_module($moduleinfo) {
3044     global $DB, $CFG;
3046     require_once($CFG->dirroot . '/course/modlib.php');
3048     // Check manadatory attributs.
3049     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3050     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3051         $mandatoryfields[] = 'introeditor';
3052     }
3053     foreach($mandatoryfields as $mandatoryfield) {
3054         if (!isset($moduleinfo->{$mandatoryfield})) {
3055             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3056         }
3057     }
3059     // Some additional checks (capability / existing instances).
3060     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3061     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3063     // Load module library.
3064     include_modulelib($module->name);
3066     // Add the module.
3067     $moduleinfo->module = $module->id;
3068     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3070     return $moduleinfo;
3073 /**
3074  * Update a module.
3075  *
3076  * It includes:
3077  *      - capability and other checks
3078  *      - update the module
3079  *
3080  * @param object $module
3081  * @return object the updated module info
3082  */
3083 function update_module($moduleinfo) {
3084     global $DB, $CFG;
3086     require_once($CFG->dirroot . '/course/modlib.php');
3088     // Check the course module exists.
3089     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3091     // Check the course exists.
3092     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3094     // Some checks (capaibility / existing instances).
3095     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3097     // Load module library.
3098     include_modulelib($module->name);
3100     // Retrieve few information needed by update_moduleinfo.
3101     $moduleinfo->modulename = $cm->modname;
3102     if (!isset($moduleinfo->scale)) {
3103         $moduleinfo->scale = 0;
3104     }
3105     $moduleinfo->type = 'mod';
3107     // Update the module.
3108     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3110     return $moduleinfo;
3113 /**
3114  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3115  * Sorts by descending order of time.
3116  *
3117  * @param stdClass $a First object
3118  * @param stdClass $b Second object
3119  * @return int 0,1,-1 representing the order
3120  */
3121 function compare_activities_by_time_desc($a, $b) {
3122     // Make sure the activities actually have a timestamp property.
3123     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3124         return 0;
3125     }
3126     // We treat instances without timestamp as if they have a timestamp of 0.
3127     if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3128         return 1;
3129     }
3130     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3131         return -1;
3132     }
3133     if ($a->timestamp == $b->timestamp) {
3134         return 0;
3135     }
3136     return ($a->timestamp > $b->timestamp) ? -1 : 1;
3139 /**
3140  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3141  * Sorts by ascending order of time.
3142  *
3143  * @param stdClass $a First object
3144  * @param stdClass $b Second object
3145  * @return int 0,1,-1 representing the order
3146  */
3147 function compare_activities_by_time_asc($a, $b) {
3148     // Make sure the activities actually have a timestamp property.
3149     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3150       return 0;
3151     }
3152     // We treat instances without timestamp as if they have a timestamp of 0.
3153     if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3154         return -1;
3155     }
3156     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3157         return 1;
3158     }
3159     if ($a->timestamp == $b->timestamp) {
3160         return 0;
3161     }
3162     return ($a->timestamp < $b->timestamp) ? -1 : 1;