94a02429e9319ba6b8a11844c2be8617581ddea0
[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');
32 define('COURSE_MAX_LOG_DISPLAY', 150);          // days
33 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
34 define('COURSE_LIVELOG_REFRESH', 60);           // Seconds
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
36 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
37 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
38 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
39 define('FRONTPAGENEWS',           '0');
40 define('FRONTPAGECOURSELIST',     '1');
41 define('FRONTPAGECATEGORYNAMES',  '2');
42 define('FRONTPAGETOPICONLY',      '3');
43 define('FRONTPAGECATEGORYCOMBO',  '4');
44 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
45 define('EXCELROWS', 65535);
46 define('FIRSTUSEDEXCELROW', 3);
48 define('MOD_CLASS_ACTIVITY', 0);
49 define('MOD_CLASS_RESOURCE', 1);
51 if (!defined('MAX_MODINFO_CACHE_SIZE')) {
52     define('MAX_MODINFO_CACHE_SIZE', 10);
53 }
55 function make_log_url($module, $url) {
56     switch ($module) {
57         case 'course':
58         case 'file':
59         case 'login':
60         case 'lib':
61         case 'admin':
62         case 'calendar':
63         case 'mnet course':
64             if (strpos($url, '../') === 0) {
65                 $url = ltrim($url, '.');
66             } else {
67                 $url = "/course/$url";
68             }
69             break;
70         case 'user':
71         case 'blog':
72             $url = "/$module/$url";
73             break;
74         case 'upload':
75             $url = $url;
76             break;
77         case 'coursetags':
78             $url = '/'.$url;
79             break;
80         case 'library':
81         case '':
82             $url = '/';
83             break;
84         case 'message':
85             $url = "/message/$url";
86             break;
87         case 'notes':
88             $url = "/notes/$url";
89             break;
90         case 'tag':
91             $url = "/tag/$url";
92             break;
93         case 'role':
94             $url = '/'.$url;
95             break;
96         default:
97             $url = "/mod/$module/$url";
98             break;
99     }
101     //now let's sanitise urls - there might be some ugly nasties:-(
102     $parts = explode('?', $url);
103     $script = array_shift($parts);
104     if (strpos($script, 'http') === 0) {
105         $script = clean_param($script, PARAM_URL);
106     } else {
107         $script = clean_param($script, PARAM_PATH);
108     }
110     $query = '';
111     if ($parts) {
112         $query = implode('', $parts);
113         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
114         $parts = explode('&', $query);
115         $eq = urlencode('=');
116         foreach ($parts as $key=>$part) {
117             $part = urlencode(urldecode($part));
118             $part = str_replace($eq, '=', $part);
119             $parts[$key] = $part;
120         }
121         $query = '?'.implode('&amp;', $parts);
122     }
124     return $script.$query;
128 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
129                    $modname="", $modid=0, $modaction="", $groupid=0) {
130     global $CFG, $DB;
132     // It is assumed that $date is the GMT time of midnight for that day,
133     // and so the next 86400 seconds worth of logs are printed.
135     /// Setup for group handling.
137     // TODO: I don't understand group/context/etc. enough to be able to do
138     // something interesting with it here
139     // What is the context of a remote course?
141     /// If the group mode is separate, and this user does not have editing privileges,
142     /// then only the user's group can be viewed.
143     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
144     //    $groupid = get_current_group($course->id);
145     //}
146     /// If this course doesn't have groups, no groupid can be specified.
147     //else if (!$course->groupmode) {
148     //    $groupid = 0;
149     //}
151     $ILIKE = $DB->sql_ilike();
153     $groupid = 0;
155     $joins = array();
157     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
158               FROM {mnet_log} l
159                LEFT JOIN {user} u ON l.userid = u.id
160               WHERE ";
161     $params = array();
163     $where .= "l.hostid = :hostid";
164     $params['hostid'] = $hostid;
166     // TODO: Is 1 really a magic number referring to the sitename?
167     if ($course != SITEID || $modid != 0) {
168         $where .= " AND l.course=:courseid";
169         $params['courseid'] = $course;
170     }
172     if ($modname) {
173         $where .= " AND l.module = :modname";
174         $params['modname'] = $modname;
175     }
177     if ('site_errors' === $modid) {
178         $where .= " AND ( l.action='error' OR l.action='infected' )";
179     } else if ($modid) {
180         //TODO: This assumes that modids are the same across sites... probably
181         //not true
182         $where .= " AND l.cmid = :modid";
183         $params['modid'] = $modid;
184     }
186     if ($modaction) {
187         $firstletter = substr($modaction, 0, 1);
188         if (preg_match('/[[:alpha:]]/', $firstletter)) {
189             $where .= " AND lower(l.action) $ILIKE :modaction";
190             $params['modaction'] = "%$modaction%";
191         } else if ($firstletter == '-') {
192             $where .= " AND lower(l.action) NOT $ILIKE :modaction";
193             $params['modaction'] = "%$modaction%";
194         }
195     }
197     if ($user) {
198         $where .= " AND l.userid = :user";
199         $params['user'] = $user;
200     }
202     if ($date) {
203         $enddate = $date + 86400;
204         $where .= " AND l.time > :date AND l.time < :enddate";
205         $params['date'] = $date;
206         $params['enddate'] = $enddate;
207     }
209     $result = array();
210     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
211     if(!empty($result['totalcount'])) {
212         $where .= " ORDER BY $order";
213         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
214     } else {
215         $result['logs'] = array();
216     }
217     return $result;
220 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
221                    $modname="", $modid=0, $modaction="", $groupid=0) {
222     global $DB, $SESSION;
223     // It is assumed that $date is the GMT time of midnight for that day,
224     // and so the next 86400 seconds worth of logs are printed.
226     /// Setup for group handling.
228     /// If the group mode is separate, and this user does not have editing privileges,
229     /// then only the user's group can be viewed.
230     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
231         if (isset($SESSION->currentgroup[$course->id])) {
232             $groupid =  $SESSION->currentgroup[$course->id];
233         } else {
234             $groupid = groups_get_all_groups($course->id, $USER->id);
235             if (is_array($groupid)) {
236                 $groupid = array_shift(array_keys($groupid));
237                 $SESSION->currentgroup[$course->id] = $groupid;
238             } else {
239                 $groupid = 0;
240             }
241         }
242     }
243     /// If this course doesn't have groups, no groupid can be specified.
244     else if (!$course->groupmode) {
245         $groupid = 0;
246     }
248     $joins = array();
249     $oarams = array();
251     if ($course->id != SITEID || $modid != 0) {
252         $joins[] = "l.course = :courseid";
253         $params['courseid'] = $course->id;
254     }
256     if ($modname) {
257         $joins[] = "l.module = :modname";
258         $params['modname'] = $modname;
259     }
261     if ('site_errors' === $modid) {
262         $joins[] = "( l.action='error' OR l.action='infected' )";
263     } else if ($modid) {
264         $joins[] = "l.cmid = :modid";
265         $params['modid'] = $modid;
266     }
268     if ($modaction) {
269         $ILIKE = $DB->sql_ilike();
270         $firstletter = substr($modaction, 0, 1);
271         if (preg_match('/[[:alpha:]]/', $firstletter)) {
272             $joins[] = "l.action $ILIKE :modaction";
273             $params['modaction'] = '%'.$modaction.'%';
274         } else if ($firstletter == '-') {
275             $joins[] = "l.action NOT $ILIKE :modaction";
276             $params['modaction'] = '%'.substr($modaction, 1).'%';
277         }
278     }
281     /// Getting all members of a group.
282     if ($groupid and !$user) {
283         if ($gusers = groups_get_members($groupid)) {
284             $gusers = array_keys($gusers);
285             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
286         } else {
287             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
288         }
289     }
290     else if ($user) {
291         $joins[] = "l.userid = :userid";
292         $params['userid'] = $user;
293     }
295     if ($date) {
296         $enddate = $date + 86400;
297         $joins[] = "l.time > :date AND l.time < :enddate";
298         $params['date'] = $date;
299         $params['enddate'] = $enddate;
300     }
302     $selector = implode(' AND ', $joins);
304     $totalcount = 0;  // Initialise
305     $result = array();
306     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
307     $result['totalcount'] = $totalcount;
308     return $result;
312 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
313                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
315     global $CFG, $DB, $OUTPUT;
317     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
318                        $modname, $modid, $modaction, $groupid)) {
319         echo $OUTPUT->notification("No logs found!");
320         echo $OUTPUT->footer();
321         exit;
322     }
324     $courses = array();
326     if ($course->id == SITEID) {
327         $courses[0] = '';
328         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
329             foreach ($ccc as $cc) {
330                 $courses[$cc->id] = $cc->shortname;
331             }
332         }
333     } else {
334         $courses[$course->id] = $course->shortname;
335     }
337     $totalcount = $logs['totalcount'];
338     $count=0;
339     $ldcache = array();
340     $tt = getdate(time());
341     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
343     $strftimedatetime = get_string("strftimedatetime");
345     echo "<div class=\"info\">\n";
346     print_string("displayingrecords", "", $totalcount);
347     echo "</div>\n";
349     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
351     $table = new html_table();
352     $table->classes = array('logtable','generalbox');
353     $table->align = array('right', 'left', 'left');
354     $table->head = array(
355         get_string('time'),
356         get_string('ip_address'),
357         get_string('fullnamecourse'),
358         get_string('action'),
359         get_string('info')
360     );
361     $table->data = array();
363     if ($course->id == SITEID) {
364         array_unshift($table->align, 'left');
365         array_unshift($table->head, get_string('course'));
366     }
368     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
369     if (empty($logs['logs'])) {
370         $logs['logs'] = array();
371     }
373     foreach ($logs['logs'] as $log) {
375         if (isset($ldcache[$log->module][$log->action])) {
376             $ld = $ldcache[$log->module][$log->action];
377         } else {
378             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
379             $ldcache[$log->module][$log->action] = $ld;
380         }
381         if ($ld && is_numeric($log->info)) {
382             // ugly hack to make sure fullname is shown correctly
383             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
384                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
385             } else {
386                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
387             }
388         }
390         //Filter log->info
391         $log->info = format_string($log->info);
393         // If $log->url has been trimmed short by the db size restriction
394         // code in add_to_log, keep a note so we don't add a link to a broken url
395         $tl=textlib_get_instance();
396         $brokenurl=($tl->strlen($log->url)==100 && $tl->substr($log->url,97)=='...');
398         $row = array();
399         if ($course->id == SITEID) {
400             if (empty($log->course)) {
401                 $row[] = get_string('site');
402             } else {
403                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
404             }
405         }
407         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
409         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
410         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
412         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id))));
414         $displayaction="$log->module $log->action";
415         if ($brokenurl) {
416             $row[] = $displayaction;
417         } else {
418             $link = make_log_url($log->module,$log->url);
419             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
420         }
421         $row[] = $log->info;
422         $table->data[] = $row;
423     }
425     echo html_writer::table($table);
426     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
430 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
431                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
433     global $CFG, $DB, $OUTPUT;
435     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
436                        $modname, $modid, $modaction, $groupid)) {
437         echo $OUTPUT->notification("No logs found!");
438         echo $OUTPUT->footer();
439         exit;
440     }
442     if ($course->id == SITEID) {
443         $courses[0] = '';
444         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
445             foreach ($ccc as $cc) {
446                 $courses[$cc->id] = $cc->shortname;
447             }
448         }
449     }
451     $totalcount = $logs['totalcount'];
452     $count=0;
453     $ldcache = array();
454     $tt = getdate(time());
455     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
457     $strftimedatetime = get_string("strftimedatetime");
459     echo "<div class=\"info\">\n";
460     print_string("displayingrecords", "", $totalcount);
461     echo "</div>\n";
463     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
465     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
466     echo "<tr>";
467     if ($course->id == SITEID) {
468         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
469     }
470     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
471     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
472     echo "<th class=\"c3 header\">".get_string('fullnamecourse')."</th>\n";
473     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
474     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
475     echo "</tr>\n";
477     if (empty($logs['logs'])) {
478         echo "</table>\n";
479         return;
480     }
482     $row = 1;
483     foreach ($logs['logs'] as $log) {
485         $log->info = $log->coursename;
486         $row = ($row + 1) % 2;
488         if (isset($ldcache[$log->module][$log->action])) {
489             $ld = $ldcache[$log->module][$log->action];
490         } else {
491             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
492             $ldcache[$log->module][$log->action] = $ld;
493         }
494         if (0 && $ld && !empty($log->info)) {
495             // ugly hack to make sure fullname is shown correctly
496             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
497                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
498             } else {
499                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
500             }
501         }
503         //Filter log->info
504         $log->info = format_string($log->info);
506         echo '<tr class="r'.$row.'">';
507         if ($course->id == SITEID) {
508             echo "<td class=\"r$row c0\" >\n";
509             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courses[$log->course]."</a>\n";
510             echo "</td>\n";
511         }
512         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
513              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
514         echo "<td class=\"r$row c2\" >\n";
515         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
516         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
517         echo "</td>\n";
518         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
519         echo "<td class=\"r$row c3\" >\n";
520         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
521         echo "</td>\n";
522         echo "<td class=\"r$row c4\">\n";
523         echo $log->action .': '.$log->module;
524         echo "</td>\n";;
525         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
526         echo "</tr>\n";
527     }
528     echo "</table>\n";
530     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
534 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
535                         $modid, $modaction, $groupid) {
536     global $DB;
538     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
539             get_string('fullnamecourse')."\t".get_string('action')."\t".get_string('info');
541     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
542                        $modname, $modid, $modaction, $groupid)) {
543         return false;
544     }
546     $courses = array();
548     if ($course->id == SITEID) {
549         $courses[0] = '';
550         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
551             foreach ($ccc as $cc) {
552                 $courses[$cc->id] = $cc->shortname;
553             }
554         }
555     } else {
556         $courses[$course->id] = $course->shortname;
557     }
559     $count=0;
560     $ldcache = array();
561     $tt = getdate(time());
562     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
564     $strftimedatetime = get_string("strftimedatetime");
566     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
567     $filename .= '.txt';
568     header("Content-Type: application/download\n");
569     header("Content-Disposition: attachment; filename=$filename");
570     header("Expires: 0");
571     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
572     header("Pragma: public");
574     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
575     echo $text;
577     if (empty($logs['logs'])) {
578         return true;
579     }
581     foreach ($logs['logs'] as $log) {
582         if (isset($ldcache[$log->module][$log->action])) {
583             $ld = $ldcache[$log->module][$log->action];
584         } else {
585             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
586             $ldcache[$log->module][$log->action] = $ld;
587         }
588         if ($ld && !empty($log->info)) {
589             // ugly hack to make sure fullname is shown correctly
590             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
591                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
592             } else {
593                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
594             }
595         }
597         //Filter log->info
598         $log->info = format_string($log->info);
599         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
601         $firstField = $courses[$log->course];
602         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
603         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
604         $text = implode("\t", $row);
605         echo $text." \n";
606     }
607     return true;
611 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
612                         $modid, $modaction, $groupid) {
614     global $CFG, $DB;
616     require_once("$CFG->libdir/excellib.class.php");
618     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
619                        $modname, $modid, $modaction, $groupid)) {
620         return false;
621     }
623     $courses = array();
625     if ($course->id == SITEID) {
626         $courses[0] = '';
627         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
628             foreach ($ccc as $cc) {
629                 $courses[$cc->id] = $cc->shortname;
630             }
631         }
632     } else {
633         $courses[$course->id] = $course->shortname;
634     }
636     $count=0;
637     $ldcache = array();
638     $tt = getdate(time());
639     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
641     $strftimedatetime = get_string("strftimedatetime");
643     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
644     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
645     $filename .= '.xls';
647     $workbook = new MoodleExcelWorkbook('-');
648     $workbook->send($filename);
650     $worksheet = array();
651     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
652                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
654     // Creating worksheets
655     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
656         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
657         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
658         $worksheet[$wsnumber]->set_column(1, 1, 30);
659         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
660                                     userdate(time(), $strftimedatetime));
661         $col = 0;
662         foreach ($headers as $item) {
663             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
664             $col++;
665         }
666     }
668     if (empty($logs['logs'])) {
669         $workbook->close();
670         return true;
671     }
673     $formatDate =& $workbook->add_format();
674     $formatDate->set_num_format(get_string('log_excel_date_format'));
676     $row = FIRSTUSEDEXCELROW;
677     $wsnumber = 1;
678     $myxls =& $worksheet[$wsnumber];
679     foreach ($logs['logs'] as $log) {
680         if (isset($ldcache[$log->module][$log->action])) {
681             $ld = $ldcache[$log->module][$log->action];
682         } else {
683             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
684             $ldcache[$log->module][$log->action] = $ld;
685         }
686         if ($ld && !empty($log->info)) {
687             // ugly hack to make sure fullname is shown correctly
688             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
689                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
690             } else {
691                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
692             }
693         }
695         // Filter log->info
696         $log->info = format_string($log->info);
697         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
699         if ($nroPages>1) {
700             if ($row > EXCELROWS) {
701                 $wsnumber++;
702                 $myxls =& $worksheet[$wsnumber];
703                 $row = FIRSTUSEDEXCELROW;
704             }
705         }
707         $myxls->write($row, 0, $courses[$log->course], '');
708         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
709         $myxls->write($row, 2, $log->ip, '');
710         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
711         $myxls->write($row, 3, $fullname, '');
712         $myxls->write($row, 4, $log->module.' '.$log->action, '');
713         $myxls->write($row, 5, $log->info, '');
715         $row++;
716     }
718     $workbook->close();
719     return true;
722 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
723                         $modid, $modaction, $groupid) {
725     global $CFG, $DB;
727     require_once("$CFG->libdir/odslib.class.php");
729     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
730                        $modname, $modid, $modaction, $groupid)) {
731         return false;
732     }
734     $courses = array();
736     if ($course->id == SITEID) {
737         $courses[0] = '';
738         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
739             foreach ($ccc as $cc) {
740                 $courses[$cc->id] = $cc->shortname;
741             }
742         }
743     } else {
744         $courses[$course->id] = $course->shortname;
745     }
747     $count=0;
748     $ldcache = array();
749     $tt = getdate(time());
750     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
752     $strftimedatetime = get_string("strftimedatetime");
754     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
755     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
756     $filename .= '.ods';
758     $workbook = new MoodleODSWorkbook('-');
759     $workbook->send($filename);
761     $worksheet = array();
762     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
763                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
765     // Creating worksheets
766     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
767         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
768         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
769         $worksheet[$wsnumber]->set_column(1, 1, 30);
770         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
771                                     userdate(time(), $strftimedatetime));
772         $col = 0;
773         foreach ($headers as $item) {
774             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
775             $col++;
776         }
777     }
779     if (empty($logs['logs'])) {
780         $workbook->close();
781         return true;
782     }
784     $formatDate =& $workbook->add_format();
785     $formatDate->set_num_format(get_string('log_excel_date_format'));
787     $row = FIRSTUSEDEXCELROW;
788     $wsnumber = 1;
789     $myxls =& $worksheet[$wsnumber];
790     foreach ($logs['logs'] as $log) {
791         if (isset($ldcache[$log->module][$log->action])) {
792             $ld = $ldcache[$log->module][$log->action];
793         } else {
794             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
795             $ldcache[$log->module][$log->action] = $ld;
796         }
797         if ($ld && !empty($log->info)) {
798             // ugly hack to make sure fullname is shown correctly
799             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
800                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
801             } else {
802                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
803             }
804         }
806         // Filter log->info
807         $log->info = format_string($log->info);
808         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
810         if ($nroPages>1) {
811             if ($row > EXCELROWS) {
812                 $wsnumber++;
813                 $myxls =& $worksheet[$wsnumber];
814                 $row = FIRSTUSEDEXCELROW;
815             }
816         }
818         $myxls->write_string($row, 0, $courses[$log->course]);
819         $myxls->write_date($row, 1, $log->time);
820         $myxls->write_string($row, 2, $log->ip);
821         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
822         $myxls->write_string($row, 3, $fullname);
823         $myxls->write_string($row, 4, $log->module.' '.$log->action);
824         $myxls->write_string($row, 5, $log->info);
826         $row++;
827     }
829     $workbook->close();
830     return true;
834 function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
835     global $CFG, $USER;
836     if (empty($CFG->gdversion)) {
837         echo "(".get_string("gdneed").")";
838     } else {
839         // MDL-10818, do not display broken graph when user has no permission to view graph
840         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
841             ($course->showreports and $USER->id == $userid)) {
842             echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
843                  '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
844         }
845     }
849 function print_overview($courses) {
850     global $CFG, $USER, $DB, $OUTPUT;
852     $htmlarray = array();
853     if ($modules = $DB->get_records('modules')) {
854         foreach ($modules as $mod) {
855             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
856                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
857                 $fname = $mod->name.'_print_overview';
858                 if (function_exists($fname)) {
859                     $fname($courses,$htmlarray);
860                 }
861             }
862         }
863     }
864     foreach ($courses as $course) {
865         echo $OUTPUT->box_start("coursebox");
866         $linkcss = '';
867         if (empty($course->visible)) {
868             $linkcss = 'class="dimmed"';
869         }
870         echo $OUTPUT->heading('<a title="'. format_string($course->fullname).'" '.$linkcss.' href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'. format_string($course->fullname).'</a>', 3);
871         if (array_key_exists($course->id,$htmlarray)) {
872             foreach ($htmlarray[$course->id] as $modname => $html) {
873                 echo $html;
874             }
875         }
876         echo $OUTPUT->box_end();
877     }
881 /**
882  * This function trawls through the logs looking for
883  * anything new since the user's last login
884  */
885 function print_recent_activity($course) {
886     // $course is an object
887     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
889     $context = get_context_instance(CONTEXT_COURSE, $course->id);
891     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
893     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
895     if (!isguestuser()) {
896         if (!empty($USER->lastcourseaccess[$course->id])) {
897             if ($USER->lastcourseaccess[$course->id] > $timestart) {
898                 $timestart = $USER->lastcourseaccess[$course->id];
899             }
900         }
901     }
903     echo '<div class="activitydate">';
904     echo get_string('activitysince', '', userdate($timestart));
905     echo '</div>';
906     echo '<div class="activityhead">';
908     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
910     echo "</div>\n";
912     $content = false;
914 /// Firstly, have there been any new enrolments?
916     $users = get_recent_enrolments($course->id, $timestart);
918     //Accessibility: new users now appear in an <OL> list.
919     if ($users) {
920         echo '<div class="newusers">';
921         echo $OUTPUT->heading(get_string("newusers").':', 3);
922         $content = true;
923         echo "<ol class=\"list\">\n";
924         foreach ($users as $user) {
925             $fullname = fullname($user, $viewfullnames);
926             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
927         }
928         echo "</ol>\n</div>\n";
929     }
931 /// Next, have there been any modifications to the course structure?
933     $modinfo =& get_fast_modinfo($course);
935     $changelist = array();
937     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
938                                             module = 'course' AND
939                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
940                                     array($timestart, $course->id), "id ASC");
942     if ($logs) {
943         $actions  = array('add mod', 'update mod', 'delete mod');
944         $newgones = array(); // added and later deleted items
945         foreach ($logs as $key => $log) {
946             if (!in_array($log->action, $actions)) {
947                 continue;
948             }
949             $info = explode(' ', $log->info);
951             if ($info[0] == 'label') {     // Labels are ignored in recent activity
952                 continue;
953             }
955             if (count($info) != 2) {
956                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
957                 continue;
958             }
960             $modname    = $info[0];
961             $instanceid = $info[1];
963             if ($log->action == 'delete mod') {
964                 // unfortunately we do not know if the mod was visible
965                 if (!array_key_exists($log->info, $newgones)) {
966                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
967                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
968                 }
969             } else {
970                 if (!isset($modinfo->instances[$modname][$instanceid])) {
971                     if ($log->action == 'add mod') {
972                         // do not display added and later deleted activities
973                         $newgones[$log->info] = true;
974                     }
975                     continue;
976                 }
977                 $cm = $modinfo->instances[$modname][$instanceid];
978                 if (!$cm->uservisible) {
979                     continue;
980                 }
982                 if ($log->action == 'add mod') {
983                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
984                     $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
986                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
987                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
988                     $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
989                 }
990             }
991         }
992     }
994     if (!empty($changelist)) {
995         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
996         $content = true;
997         foreach ($changelist as $changeinfo => $change) {
998             echo '<p class="activity">'.$change['text'].'</p>';
999         }
1000     }
1002 /// Now display new things from each module
1004     $usedmodules = array();
1005     foreach($modinfo->cms as $cm) {
1006         if (isset($usedmodules[$cm->modname])) {
1007             continue;
1008         }
1009         if (!$cm->uservisible) {
1010             continue;
1011         }
1012         $usedmodules[$cm->modname] = $cm->modname;
1013     }
1015     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1016         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1017             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1018             $print_recent_activity = $modname.'_print_recent_activity';
1019             if (function_exists($print_recent_activity)) {
1020                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1021                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1022             }
1023         } else {
1024             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1025         }
1026     }
1028     if (! $content) {
1029         echo '<p class="message">'.get_string('nothingnew').'</p>';
1030     }
1033 /**
1034  * For a given course, returns an array of course activity objects
1035  * Each item in the array contains he following properties:
1036  */
1037 function get_array_of_activities($courseid) {
1038 //  cm - course module id
1039 //  mod - name of the module (eg forum)
1040 //  section - the number of the section (eg week or topic)
1041 //  name - the name of the instance
1042 //  visible - is the instance visible or not
1043 //  groupingid - grouping id
1044 //  groupmembersonly - is this instance visible to group members only
1045 //  extra - contains extra string to include in any link
1046     global $CFG, $DB;
1047     if(!empty($CFG->enableavailability)) {
1048         require_once($CFG->libdir.'/conditionlib.php');
1049     }
1051     $course = $DB->get_record('course', array('id'=>$courseid));
1053     if (empty($course)) {
1054         throw new moodle_exception('courseidnotfound');
1055     }
1057     $mod = array();
1059     $rawmods = get_course_mods($courseid);
1060     if (empty($rawmods)) {
1061         return $mod; // always return array
1062     }
1064     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1065        foreach ($sections as $section) {
1066            if (!empty($section->sequence)) {
1067                $sequence = explode(",", $section->sequence);
1068                foreach ($sequence as $seq) {
1069                    if (empty($rawmods[$seq])) {
1070                        continue;
1071                    }
1072                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1073                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1074                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1075                    $mod[$seq]->section          = $section->section;
1076                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1077                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1078                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1079                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1080                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1081                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1082                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1083                    $mod[$seq]->extra            = "";
1084                    if(!empty($CFG->enableavailability)) {
1085                        condition_info::fill_availability_conditions($rawmods[$seq]);
1086                        $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1087                        $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1088                        $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1089                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1090                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1091                    }
1093                    $modname = $mod[$seq]->mod;
1094                    $functionname = $modname."_get_coursemodule_info";
1096                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1097                        continue;
1098                    }
1100                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1102                    if (function_exists($functionname)) {
1103                        if ($info = $functionname($rawmods[$seq])) {
1104                            if (!empty($info->extra)) {
1105                                $mod[$seq]->extra = $info->extra;
1106                            }
1107                            if (!empty($info->icon)) {
1108                                $mod[$seq]->icon = $info->icon;
1109                            }
1110                            if (!empty($info->iconcomponent)) {
1111                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1112                            }
1113                            if (!empty($info->name)) {
1114                                $mod[$seq]->name = $info->name;
1115                            }
1116                        }
1117                    }
1118                    if (!isset($mod[$seq]->name)) {
1119                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1120                    }
1121                }
1122             }
1123         }
1124     }
1125     return $mod;
1129 /**
1130  * Returns a number of useful structures for course displays
1131  */
1132 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1133     global $CFG, $DB, $COURSE;
1135     $mods          = array();    // course modules indexed by id
1136     $modnames      = array();    // all course module names (except resource!)
1137     $modnamesplural= array();    // all course module names (plural form)
1138     $modnamesused  = array();    // course module names used
1140     if ($allmods = $DB->get_records("modules")) {
1141         foreach ($allmods as $mod) {
1142             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1143                 continue;
1144             }
1145             if ($mod->visible) {
1146                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1147                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1148             }
1149         }
1150         asort($modnames, SORT_LOCALE_STRING);
1151     } else {
1152         print_error("nomodules", 'debug');
1153     }
1155     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1156     $modinfo = get_fast_modinfo($course);
1158     if ($rawmods=$modinfo->cms) {
1159         foreach($rawmods as $mod) {    // Index the mods
1160             if (empty($modnames[$mod->modname])) {
1161                 continue;
1162             }
1163             $mods[$mod->id] = $mod;
1164             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1165             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1166                 continue;
1167             }
1168             // Check groupings
1169             if (!groups_course_module_visible($mod)) {
1170                 continue;
1171             }
1172             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1173         }
1174         if ($modnamesused) {
1175             asort($modnamesused, SORT_LOCALE_STRING);
1176         }
1177     }
1180 /**
1181  * Returns an array of sections for the requested course id
1182  *
1183  * This function stores the sections against the course id within a staticvar encase
1184  * of subsequent requests. This is used all over + in some standard libs and course
1185  * format callbacks so subsequent requests are a reality.
1186  *
1187  * @staticvar array $coursesections
1188  * @param int $courseid
1189  * @return array Array of sections
1190  */
1191 function get_all_sections($courseid) {
1192     global $DB;
1193     static $coursesections = array();
1194     if (!array_key_exists($courseid, $coursesections)) {
1195         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1196                            "section, id, course, name, summary, summaryformat, sequence, visible");
1197     }
1198     return $coursesections[$courseid];
1201 function course_set_display($courseid, $display=0) {
1202     global $USER, $DB;
1204     if ($display == "all" or empty($display)) {
1205         $display = 0;
1206     }
1208     if (!isloggedin() or isguestuser()) {
1209         //do not store settings in db for guests
1210     } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
1211         $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
1212     } else {
1213         $record = new object();
1214         $record->userid = $USER->id;
1215         $record->course = $courseid;
1216         $record->display = $display;
1217         $DB->insert_record("course_display", $record);
1218     }
1220     return $USER->display[$courseid] = $display;  // Note: = not ==
1223 /**
1224  * For a given course section, markes it visible or hidden,
1225  * and does the same for every activity in that section
1226  */
1227 function set_section_visible($courseid, $sectionnumber, $visibility) {
1228     global $DB;
1230     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1231         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1232         if (!empty($section->sequence)) {
1233             $modules = explode(",", $section->sequence);
1234             foreach ($modules as $moduleid) {
1235                 set_coursemodule_visible($moduleid, $visibility, true);
1236             }
1237         }
1238         rebuild_course_cache($courseid);
1239     }
1242 /**
1243  * Prints a section full of activity modules
1244  */
1245 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1246     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1248     static $initialised;
1250     static $groupbuttons;
1251     static $groupbuttonslink;
1252     static $isediting;
1253     static $ismoving;
1254     static $strmovehere;
1255     static $strmovefull;
1256     static $strunreadpostsone;
1257     static $usetracking;
1258     static $groupings;
1260     if (!isset($initialised)) {
1261         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1262         $groupbuttonslink = (!$course->groupmodeforce);
1263         $isediting        = $PAGE->user_is_editing();
1264         $ismoving         = $isediting && ismoving($course->id);
1265         if ($ismoving) {
1266             $strmovehere  = get_string("movehere");
1267             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1268         }
1269         include_once($CFG->dirroot.'/mod/forum/lib.php');
1270         if ($usetracking = forum_tp_can_track_forums()) {
1271             $strunreadpostsone = get_string('unreadpostsone', 'forum');
1272         }
1273         $initialised = true;
1274     }
1276     $labelformatoptions = new object();
1277     $labelformatoptions->noclean = true;
1279 /// Casting $course->modinfo to string prevents one notice when the field is null
1280     $modinfo = get_fast_modinfo($course);
1281     $completioninfo = new completion_info($course);
1283     //Acccessibility: replace table with list <ul>, but don't output empty list.
1284     if (!empty($section->sequence)) {
1286         // Fix bug #5027, don't want style=\"width:$width\".
1287         echo "<ul class=\"section img-text\">\n";
1288         $sectionmods = explode(",", $section->sequence);
1290         foreach ($sectionmods as $modnumber) {
1291             if (empty($mods[$modnumber])) {
1292                 continue;
1293             }
1295             $mod = $mods[$modnumber];
1297             if ($ismoving and $mod->id == $USER->activitycopy) {
1298                 // do not display moving mod
1299                 continue;
1300             }
1302             if (isset($modinfo->cms[$modnumber])) {
1303                 // We can continue (because it will not be displayed at all)
1304                 // if:
1305                 // 1) The activity is not visible to users
1306                 // and
1307                 // 2a) The 'showavailability' option is not set (if that is set,
1308                 //     we need to display the activity so we can show
1309                 //     availability info)
1310                 // or
1311                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1312                 //     hidden in a way that leaves no info, such as using the
1313                 //     eye icon.
1314                 if (!$modinfo->cms[$modnumber]->uservisible &&
1315                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1316                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1317                     // visibility shortcut
1318                     continue;
1319                 }
1320             } else {
1321                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1322                     // module not installed
1323                     continue;
1324                 }
1325                 if (!coursemodule_visible_for_user($mod) &&
1326                     empty($mod->showavailability)) {
1327                     // full visibility check
1328                     continue;
1329                 }
1330             }
1332             // In some cases the activity is visible to user, but it is
1333             // dimmed. This is done if viewhiddenactivities is true and if:
1334             // 1. the activity is not visible, or
1335             // 2. the activity has dates set which do not include current, or
1336             // 3. the activity has any other conditions set (regardless of whether
1337             //    current user meets them)
1338             $canviewhidden = has_capability(
1339                 'moodle/course:viewhiddenactivities',
1340                 get_context_instance(CONTEXT_MODULE, $mod->id));
1341             $accessiblebutdim = false;
1342             if ($canviewhidden) {
1343                 $accessiblebutdim = !$mod->visible;
1344                 if (!empty($CFG->enableavailability)) {
1345                     $accessiblebutdim = $accessiblebutdim ||
1346                         $mod->availablefrom > time() ||
1347                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1348                         count($mod->conditionsgrade) > 0 ||
1349                         count($mod->conditionscompletion) > 0;
1350                 }
1351             }
1353             echo '<li class="activity '.$mod->modname.'" id="module-'.$modnumber.'">';  // Unique ID
1354             if ($ismoving) {
1355                 echo '<a title="'.$strmovefull.'"'.
1356                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1357                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1358                      ' alt="'.$strmovehere.'" /></a><br />
1359                      ';
1360             }
1362             if ($mod->indent) {
1363                 echo $OUTPUT->spacer(array('height'=>12, 'width'=>(20 * $mod->indent))); // should be done with CSS instead
1364             }
1366             $extra = '';
1367             if (!empty($modinfo->cms[$modnumber]->extra)) {
1368                 $extra = $modinfo->cms[$modnumber]->extra;
1369             }
1371             if ($mod->modname == "label") {
1372                 if ($accessiblebutdim || !$mod->uservisible) {
1373                     echo '<div class="dimmed_text"><span class="accesshide">'.
1374                         get_string('hiddenfromstudents').'</span>';
1375                 } else {
1376                     echo '<div>';
1377                 }
1378                 echo format_text($extra, FORMAT_HTML, $labelformatoptions);
1379                 echo "</div>";
1380                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1381                     if (!isset($groupings)) {
1382                         $groupings = groups_get_all_groupings($course->id);
1383                     }
1384                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1385                 }
1387             } else { // Normal activity
1388                 $instancename = format_string($modinfo->cms[$modnumber]->name, true,  $course->id);
1390                 $customicon = $modinfo->cms[$modnumber]->icon;
1391                 if (!empty($customicon)) {
1392                     if (substr($customicon, 0, 4) === 'mod/') {
1393                         list($modname, $iconname) = explode('/', substr($customicon, 4), 2);
1394                         $icon = $OUTPUT->pix_url($customicon, $modname);
1395                     } else {
1396                         $icon = $OUTPUT->pix_url($customicon);
1397                     }
1398                 } else {
1399                     $icon = $OUTPUT->pix_url('icon', $mod->modname);
1400                 }
1402                 //Accessibility: for files get description via icon, this is very ugly hack!
1403                 $altname = '';
1404                 $altname = $mod->modfullname;
1405                 if (!empty($customicon)) {
1406                     $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1407                     if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1408                         $mimetype = mimeinfo_from_icon('type', $customicon);
1409                         $altname = get_mimetype_description($mimetype);
1410                     }
1411                 }
1412                 // Avoid unnecessary duplication.
1413                 if (false !== stripos($instancename, $altname)) {
1414                     $altname = '';
1415                 }
1416                 // File type after name, for alphabetic lists (screen reader).
1417                 if ($altname) {
1418                     $altname = get_accesshide(' '.$altname);
1419                 }
1421                 // We may be displaying this just in order to show information
1422                 // about visibility, without the actual link
1423                 if ($mod->uservisible) {
1424                     // Display normal module link
1425                     if (!$accessiblebutdim) {
1426                         $linkcss = '';
1427                         $accesstext  ='';
1428                     } else {
1429                         $linkcss = ' class="dimmed" ';
1430                         $accesstext = '<span class="accesshide">'.
1431                             get_string('hiddenfromstudents').': </span>';
1432                     }
1434                     echo '<a '.$linkcss.' '.$extra.
1435                          ' href="'.$CFG->wwwroot.'/mod/'.$mod->modname.'/view.php?id='.$mod->id.'">'.
1436                          '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename',$mod->modname).'" /> '.
1437                          $accesstext.'<span>'.$instancename.$altname.'</span></a>';
1439                     if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1440                         if (!isset($groupings)) {
1441                             $groupings = groups_get_all_groupings($course->id);
1442                         }
1443                         echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1444                     }
1445                 } else {
1446                     // Display greyed-out text of link
1447                     echo '<span class="dimmed_text" '.$extra.' ><span class="accesshide">'.
1448                         get_string('notavailableyet','condition').': </span>'.
1449                         '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename', $mod->modname).'" /> <span>'.
1450                         $instancename.$altname.'</span></span>';
1451                 }
1452             }
1453             if ($usetracking && $mod->modname == 'forum') {
1454                 if ($unread = forum_tp_count_forum_unread_posts($mod, $course)) {
1455                     echo '<span class="unread"> <a href="'.$CFG->wwwroot.'/mod/forum/view.php?id='.$mod->id.'">';
1456                     if ($unread == 1) {
1457                         echo $strunreadpostsone;
1458                     } else {
1459                         print_string('unreadpostsnumber', 'forum', $unread);
1460                     }
1461                     echo '</a></span>';
1462                 }
1463             }
1465             if ($isediting) {
1466                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1467                     if (! $mod->groupmodelink = $groupbuttonslink) {
1468                         $mod->groupmode = $course->groupmode;
1469                     }
1471                 } else {
1472                     $mod->groupmode = false;
1473                 }
1474                 echo '&nbsp;&nbsp;';
1475                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1476             }
1478             // Completion
1479             $completion = $hidecompletion
1480                 ? COMPLETION_TRACKING_NONE
1481                 : $completioninfo->is_enabled($mod);
1482             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1483                 !isguestuser() && $mod->uservisible) {
1484                 $completiondata = $completioninfo->get_data($mod,true);
1485                 $completionicon = '';
1486                 if ($isediting) {
1487                     switch ($completion) {
1488                         case COMPLETION_TRACKING_MANUAL :
1489                             $completionicon = 'manual-enabled'; break;
1490                         case COMPLETION_TRACKING_AUTOMATIC :
1491                             $completionicon = 'auto-enabled'; break;
1492                         default: // wtf
1493                     }
1494                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1495                     switch($completiondata->completionstate) {
1496                         case COMPLETION_INCOMPLETE:
1497                             $completionicon = 'manual-n'; break;
1498                         case COMPLETION_COMPLETE:
1499                             $completionicon = 'manual-y'; break;
1500                     }
1501                 } else { // Automatic
1502                     switch($completiondata->completionstate) {
1503                         case COMPLETION_INCOMPLETE:
1504                             $completionicon = 'auto-n'; break;
1505                         case COMPLETION_COMPLETE:
1506                             $completionicon = 'auto-y'; break;
1507                         case COMPLETION_COMPLETE_PASS:
1508                             $completionicon = 'auto-pass'; break;
1509                         case COMPLETION_COMPLETE_FAIL:
1510                             $completionicon = 'auto-fail'; break;
1511                     }
1512                 }
1513                 if ($completionicon) {
1514                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1515                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1516                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1517                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1518                         $newstate =
1519                             $completiondata->completionstate==COMPLETION_COMPLETE
1520                             ? COMPLETION_INCOMPLETE
1521                             : COMPLETION_COMPLETE;
1522                         // In manual mode the icon is a toggle form...
1524                         // If this completion state is used by the
1525                         // conditional activities system, we need to turn
1526                         // off the JS.
1527                         if (!empty($CFG->enableavailability) &&
1528                             condition_info::completion_value_used_as_condition($course, $mod)) {
1529                             $extraclass = ' preventjs';
1530                         } else {
1531                             $extraclass = '';
1532                         }
1533                         echo "
1534 <form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>
1535 <input type='hidden' name='id' value='{$mod->id}' />
1536 <input type='hidden' name='sesskey' value='".sesskey()."' />
1537 <input type='hidden' name='completionstate' value='$newstate' />
1538 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1539 </div></form>";
1540                     } else {
1541                         // In auto mode, or when editing, the icon is just an image
1542                         echo "<span class='autocompletion'>";
1543                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1544                     }
1545                 }
1546             }
1548             // Show availability information (for someone who isn't allowed to
1549             // see the activity itself, or for staff)
1550             if (!$mod->uservisible) {
1551                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1552             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1553                 $ci = new condition_info($mod);
1554                 $fullinfo = $ci->get_full_information();
1555                 if($fullinfo) {
1556                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1557                         ? 'userrestriction_visible'
1558                         : 'userrestriction_hidden','condition',
1559                         $fullinfo).'</div>';
1560                 }
1561             }
1563             echo "</li>\n";
1564         }
1566     } elseif ($ismoving) {
1567         echo "<ul class=\"section\">\n";
1568     }
1570     if ($ismoving) {
1571         echo '<li><a title="'.$strmovefull.'"'.
1572              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1573              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1574              ' alt="'.$strmovehere.'" /></a></li>
1575              ';
1576     }
1577     if (!empty($section->sequence) || $ismoving) {
1578         echo "</ul><!--class='section'-->\n\n";
1579     }
1582 /**
1583  * Prints the menus to add activities and resources.
1584  */
1585 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1586     global $CFG, $OUTPUT;
1588     // check to see if user can add menus
1589     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1590         return false;
1591     }
1593     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1595     $resources = array();
1596     $activities = array();
1598     foreach($modnames as $modname=>$modnamestr) {
1599         if (!course_allowed_module($course, $modname)) {
1600             continue;
1601         }
1603         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1604         if (!file_exists($libfile)) {
1605             continue;
1606         }
1607         include_once($libfile);
1608         $gettypesfunc =  $modname.'_get_types';
1609         if (function_exists($gettypesfunc)) {
1610             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1611             if ($types = $gettypesfunc()) {
1612                 $menu = array();
1613                 $atype = null;
1614                 $groupname = null;
1615                 foreach($types as $type) {
1616                     if ($type->typestr === '--') {
1617                         continue;
1618                     }
1619                     if (strpos($type->typestr, '--') === 0) {
1620                         $groupname = str_replace('--', '', $type->typestr);
1621                         continue;
1622                     }
1623                     $type->type = str_replace('&amp;', '&', $type->type);
1624                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1625                         $atype = MOD_CLASS_RESOURCE;
1626                     }
1627                     $menu[$urlbase.$type->type] = $type->typestr;
1628                 }
1629                 if (!is_null($groupname)) {
1630                     if ($atype == MOD_CLASS_RESOURCE) {
1631                         $resources[] = array($groupname=>$menu);
1632                     } else {
1633                         $activities[] = array($groupname=>$menu);
1634                     }
1635                 } else {
1636                     if ($atype == MOD_CLASS_RESOURCE) {
1637                         $resources = array_merge($resources, $menu);
1638                     } else {
1639                         $activities = array_merge($activities, $menu);
1640                     }
1641                 }
1642             }
1643         } else {
1644             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1645             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1646                 $resources[$urlbase.$modname] = $modnamestr;
1647             } else {
1648                 // all other archetypes are considered activity
1649                 $activities[$urlbase.$modname] = $modnamestr;
1650             }
1651         }
1652     }
1654     $straddactivity = get_string('addactivity');
1655     $straddresource = get_string('addresource');
1657     $output  = '<div class="section_add_menus">';
1659     if (!$vertical) {
1660         $output .= '<div class="horizontal">';
1661     }
1663     if (!empty($resources)) {
1664         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1665         $select->set_help_icon('resources');
1666         $output .= $OUTPUT->render($select);
1667     }
1669     if (!empty($activities)) {
1670         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1671         $select->set_help_icon('activities');
1672         $output .= $OUTPUT->render($select);
1673     }
1675     if (!$vertical) {
1676         $output .= '</div>';
1677     }
1679     $output .= '</div>';
1681     if ($return) {
1682         return $output;
1683     } else {
1684         echo $output;
1685     }
1688 /**
1689  * Return the course category context for the category with id $categoryid, except
1690  * that if $categoryid is 0, return the system context.
1691  *
1692  * @param integer $categoryid a category id or 0.
1693  * @return object the corresponding context
1694  */
1695 function get_category_or_system_context($categoryid) {
1696     if ($categoryid) {
1697         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1698     } else {
1699         return get_context_instance(CONTEXT_SYSTEM);
1700     }
1703 /**
1704  * Rebuilds the cached list of course activities stored in the database
1705  * @param int $courseid - id of course to rebuil, empty means all
1706  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1707  */
1708 function rebuild_course_cache($courseid=0, $clearonly=false) {
1709     global $COURSE, $DB, $OUTPUT;
1711     if ($clearonly) {
1712         if (empty($courseid)) {
1713             $courseselect = array();
1714         } else {
1715             $courseselect = array('id'=>$courseid);
1716         }
1717         $DB->set_field('course', 'modinfo', null, $courseselect);
1718         // update cached global COURSE too ;-)
1719         if ($courseid == $COURSE->id or empty($courseid)) {
1720             $COURSE->modinfo = null;
1721         }
1722         // reset the fast modinfo cache
1723         $reset = 'reset';
1724         get_fast_modinfo($reset);
1725         return;
1726     }
1728     if ($courseid) {
1729         $select = array('id'=>$courseid);
1730     } else {
1731         $select = array();
1732         @set_time_limit(0);  // this could take a while!   MDL-10954
1733     }
1735     if ($rs = $DB->get_recordset("course", $select,'','id,fullname')) {
1736         foreach ($rs as $course) {
1737             $modinfo = serialize(get_array_of_activities($course->id));
1738             if (!$DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id))) {
1739                 echo $OUTPUT->notification("Could not cache module information for course '" . format_string($course->fullname) . "'!");
1740             }
1741             // update cached global COURSE too ;-)
1742             if ($course->id == $COURSE->id) {
1743                 $COURSE->modinfo = $modinfo;
1744             }
1745         }
1746         $rs->close();
1747     }
1748     // reset the fast modinfo cache
1749     $reset = 'reset';
1750     get_fast_modinfo($reset);
1753 /**
1754  * Gets the child categories of a given coures category. Uses a static cache
1755  * to make repeat calls efficient.
1756  *
1757  * @param unknown_type $parentid the id of a course category.
1758  * @return array all the child course categories.
1759  */
1760 function get_child_categories($parentid) {
1761     static $allcategories = null;
1763     // only fill in this variable the first time
1764     if (null == $allcategories) {
1765         $allcategories = array();
1767         $categories = get_categories();
1768         foreach ($categories as $category) {
1769             if (empty($allcategories[$category->parent])) {
1770                 $allcategories[$category->parent] = array();
1771             }
1772             $allcategories[$category->parent][] = $category;
1773         }
1774     }
1776     if (empty($allcategories[$parentid])) {
1777         return array();
1778     } else {
1779         return $allcategories[$parentid];
1780     }
1783 /**
1784  * This function recursively travels the categories, building up a nice list
1785  * for display. It also makes an array that list all the parents for each
1786  * category.
1787  *
1788  * For example, if you have a tree of categories like:
1789  *   Miscellaneous (id = 1)
1790  *      Subcategory (id = 2)
1791  *         Sub-subcategory (id = 4)
1792  *   Other category (id = 3)
1793  * Then after calling this function you will have
1794  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1795  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1796  *      3 => 'Other category');
1797  * $parents = array(2 => array(1), 4 => array(1, 2));
1798  *
1799  * If you specify $requiredcapability, then only categories where the current
1800  * user has that capability will be added to $list, although all categories
1801  * will still be added to $parents, and if you only have $requiredcapability
1802  * in a child category, not the parent, then the child catgegory will still be
1803  * included.
1804  *
1805  * If you specify the option $excluded, then that category, and all its children,
1806  * are omitted from the tree. This is useful when you are doing something like
1807  * moving categories, where you do not want to allow people to move a category
1808  * to be the child of itself.
1809  *
1810  * @param array $list For output, accumulates an array categoryid => full category path name
1811  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1812  * @param string/array $requiredcapability if given, only categories where the current
1813  *      user has this capability will be added to $list. Can also be an array of capabilities,
1814  *      in which case they are all required.
1815  * @param integer $excludeid Omit this category and its children from the lists built.
1816  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1817  * @param string $path For internal use, as part of recursive calls.
1818  */
1819 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1820         $excludeid = 0, $category = NULL, $path = "") {
1822     // initialize the arrays if needed
1823     if (!is_array($list)) {
1824         $list = array();
1825     }
1826     if (!is_array($parents)) {
1827         $parents = array();
1828     }
1830     if (empty($category)) {
1831         // Start at the top level.
1832         $category = new stdClass;
1833         $category->id = 0;
1834     } else {
1835         // This is the excluded category, don't include it.
1836         if ($excludeid > 0 && $excludeid == $category->id) {
1837             return;
1838         }
1840         // Update $path.
1841         if ($path) {
1842             $path = $path.' / '.format_string($category->name);
1843         } else {
1844             $path = format_string($category->name);
1845         }
1847         // Add this category to $list, if the permissions check out.
1848         if (empty($requiredcapability)) {
1849             $list[$category->id] = $path;
1851         } else {
1852             ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1853             $requiredcapability = (array)$requiredcapability;
1854             if (has_all_capabilities($requiredcapability, $category->context)) {
1855                 $list[$category->id] = $path;
1856             }
1857         }
1858     }
1860     // Add all the children recursively, while updating the parents array.
1861     if ($categories = get_child_categories($category->id)) {
1862         foreach ($categories as $cat) {
1863             if (!empty($category->id)) {
1864                 if (isset($parents[$category->id])) {
1865                     $parents[$cat->id]   = $parents[$category->id];
1866                 }
1867                 $parents[$cat->id][] = $category->id;
1868             }
1869             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1870         }
1871     }
1874 /**
1875  * This function generates a structured array of courses and categories.
1876  *
1877  * The depth of categories is limited by $CFG->maxcategorydepth however there
1878  * is no limit on the number of courses!
1879  *
1880  * Suitable for use with the course renderers course_category_tree method:
1881  * $renderer = $PAGE->get_renderer('core','course');
1882  * echo $renderer->course_category_tree(get_course_category_tree());
1883  *
1884  * @global moodle_database $DB
1885  * @param int $id
1886  * @param int $depth
1887  */
1888 function get_course_category_tree($id = 0, $depth = 0) {
1889     global $DB;
1890     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
1891     $categories = get_child_categories($id);
1892     $categoryids = array();
1893     foreach ($categories as $key => &$category) {
1894         if (!$category->visible && !$viewhiddencats) {
1895             unset($categories[$key]);
1896             continue;
1897         }
1898         $categoryids[$category->id] = $category;
1899         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1900             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1901             foreach ($subcategories as $subid=>$subcat) {
1902                 $categoryids[$subid] = $subcat;
1903             }
1904             $category->courses = array();
1905         }
1906     }
1908     if ($depth > 0) {
1909         // This is a recursive call so return the required array
1910         return array($categories, $categoryids);
1911     }
1913     // The depth is 0 this function has just been called so we can finish it off
1915     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1916     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1917     $sql = "SELECT
1918             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1919             $ccselect
1920             FROM {course} c
1921             $ccjoin
1922             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1923     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1924         // loop throught them
1925         foreach ($courses as $course) {
1926             if ($course->id == SITEID) {
1927                 continue;
1928             }
1929             context_instance_preload($course);
1930             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1931                 $categoryids[$course->category]->courses[$course->id] = $course;
1932             }
1933         }
1934     }
1935     return $categories;
1938 /**
1939  * Recursive function to print out all the categories in a nice format
1940  * with or without courses included
1941  */
1942 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
1943     global $CFG;
1945     // maxcategorydepth == 0 meant no limit
1946     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1947         return;
1948     }
1950     if (!$displaylist) {
1951         make_categories_list($displaylist, $parentslist);
1952     }
1954     if ($category) {
1955         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
1956             print_category_info($category, $depth, $showcourses);
1957         } else {
1958             return;  // Don't bother printing children of invisible categories
1959         }
1961     } else {
1962         $category->id = "0";
1963     }
1965     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
1966         $countcats = count($categories);
1967         $count = 0;
1968         $first = true;
1969         $last = false;
1970         foreach ($categories as $cat) {
1971             $count++;
1972             if ($count == $countcats) {
1973                 $last = true;
1974             }
1975             $up = $first ? false : true;
1976             $down = $last ? false : true;
1977             $first = false;
1979             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
1980         }
1981     }
1984 /**
1985  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
1986  */
1987 function make_categories_options() {
1988     make_categories_list($cats,$parents);
1989     foreach ($cats as $key => $value) {
1990         if (array_key_exists($key,$parents)) {
1991             if ($indent = count($parents[$key])) {
1992                 for ($i = 0; $i < $indent; $i++) {
1993                     $cats[$key] = '&nbsp;'.$cats[$key];
1994                 }
1995             }
1996         }
1997     }
1998     return $cats;
2001 /**
2002  * Prints the category info in indented fashion
2003  * This function is only used by print_whole_category_list() above
2004  */
2005 function print_category_info($category, $depth, $showcourses = false) {
2006     global $CFG, $DB, $OUTPUT;
2008     $strsummary = get_string('summary');
2010     $catlinkcss = null;
2011     if (!$category->visible) {
2012         $catlinkcss = array('class'=>'dimmed');
2013     }
2014     static $coursecount = null;
2015     if (null === $coursecount) {
2016         // only need to check this once
2017         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2018     }
2020     if ($showcourses and $coursecount) {
2021         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2022     } else {
2023         $catimage = "&nbsp;";
2024     }
2026     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2027     if ($showcourses and $coursecount) {
2028         echo '<div class="categorylist clearfix">';
2029         $cat = '';
2030         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2031         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2032         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2034         $html = '';
2035         if ($depth > 0) {
2036             for ($i=0; $i< $depth; $i++) {
2037                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2038                 $cat = '';
2039             }
2040         } else {
2041             $html = $cat;
2042         }
2043         echo html_writer::tag('div', $html, array('class'=>'category'));
2044         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2046         // does the depth exceed maxcategorydepth
2047         // maxcategorydepth == 0 or unset meant no limit
2048         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2049         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2050             foreach ($courses as $course) {
2051                 $linkcss = null;
2052                 if (!$course->visible) {
2053                     $linkcss = array('class'=>'dimmed');
2054                 }
2056                 $coursecontent = '';
2057                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2058                 $coursecontent .= html_writer::tag('div', $courselink, array('class'=>'name'));
2060                 // print enrol info
2061                 if ($icons = enrol_get_course_info_icons($course)) {
2062                     foreach ($icons as $pix_icon) {
2063                         echo $OUTPUT->render($pix_icon);
2064                     }
2065                 }
2067                 if ($course->summary) {
2068                     $link = new moodle_url('/course/info.php?id='.$course->id);
2069                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2070                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2071                         array('title'=>$strsummary));
2073                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2074                 }
2076                 $html = '';
2077                 for ($i=1; $i <= $depth; $i++) {
2078                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2079                     $coursecontent = '';
2080                 }
2081                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2082             }
2083         }
2084         echo '</div>';
2085     } else {
2086         echo '<div class="categorylist">';
2087         $html = '';
2088         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2089         $cat .= html_writer::tag('span', '('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2091         if ($depth > 0) {
2092             for ($i=0; $i< $depth; $i++) {
2093                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2094                 $cat = '';
2095             }
2096         } else {
2097             $html = $cat;
2098         }
2100         echo html_writer::tag('div', $html, array('class'=>'category'));
2101         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2102         echo '</div>';
2103     }
2106 /**
2107  * Print the buttons relating to course requests.
2108  *
2109  * @param object $systemcontext the system context.
2110  */
2111 function print_course_request_buttons($systemcontext) {
2112     global $CFG, $DB, $OUTPUT;
2113     if (empty($CFG->enablecourserequests)) {
2114         return;
2115     }
2116     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2117     /// Print a button to request a new course
2118         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2119     }
2120     /// Print a button to manage pending requests
2121     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2122         $disabled = !$DB->record_exists('course_request', array());
2123         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2124     }
2127 /**
2128  * Does the user have permission to edit things in this category?
2129  *
2130  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2131  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2132  */
2133 function can_edit_in_category($categoryid = 0) {
2134     $context = get_category_or_system_context($categoryid);
2135     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2138 /**
2139  * Prints the turn editing on/off button on course/index.php or course/category.php.
2140  *
2141  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2142  * @return string HTML of the editing button, or empty string, if this user is not allowed
2143  *      to see it.
2144  */
2145 function update_category_button($categoryid = 0) {
2146     global $CFG, $PAGE, $OUTPUT;
2148     // Check permissions.
2149     if (!can_edit_in_category($categoryid)) {
2150         return '';
2151     }
2153     // Work out the appropriate action.
2154     if ($PAGE->user_is_editing()) {
2155         $label = get_string('turneditingoff');
2156         $edit = 'off';
2157     } else {
2158         $label = get_string('turneditingon');
2159         $edit = 'on';
2160     }
2162     // Generate the button HTML.
2163     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2164     if ($categoryid) {
2165         $options['id'] = $categoryid;
2166         $page = 'category.php';
2167     } else {
2168         $page = 'index.php';
2169     }
2170     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2173 /**
2174  * Category is 0 (for all courses) or an object
2175  */
2176 function print_courses($category) {
2177     global $CFG, $OUTPUT;
2179     if (!is_object($category) && $category==0) {
2180         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2181         if (is_array($categories) && count($categories) == 1) {
2182             $category   = array_shift($categories);
2183             $courses    = get_courses_wmanagers($category->id,
2184                                                 'c.sortorder ASC',
2185                                                 array('summary','summaryformat'));
2186         } else {
2187             $courses    = get_courses_wmanagers('all',
2188                                                 'c.sortorder ASC',
2189                                                 array('summary','summaryformat'));
2190         }
2191         unset($categories);
2192     } else {
2193         $courses    = get_courses_wmanagers($category->id,
2194                                             'c.sortorder ASC',
2195                                             array('summary','summaryformat'));
2196     }
2198     if ($courses) {
2199         echo '<ul class="unlist">';
2200         foreach ($courses as $course) {
2201             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2202             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2203                 echo '<li>';
2204                 print_course($course);
2205                 echo "</li>\n";
2206             }
2207         }
2208         echo "</ul>\n";
2209     } else {
2210         echo $OUTPUT->heading(get_string("nocoursesyet"));
2211         $context = get_context_instance(CONTEXT_SYSTEM);
2212         if (has_capability('moodle/course:create', $context)) {
2213             $options = array();
2214             if (!empty($category->id)) {
2215                 $options['category'] = $category->id;
2216             } else {
2217                 $options['category'] = $CFG->defaultrequestcategory;
2218             }
2219             echo '<div class="addcoursebutton">';
2220             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2221             echo '</div>';
2222         }
2223     }
2226 /**
2227  * Print a description of a course, suitable for browsing in a list.
2228  *
2229  * @param object $course the course object.
2230  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2231  */
2232 function print_course($course, $highlightterms = '') {
2233     global $CFG, $USER, $DB, $OUTPUT;
2235     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2237     // Rewrite file URLs so that they are correct
2238     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2240     $linkcss = $course->visible ? '' : ' class="dimmed" ';
2242     echo '<div class="coursebox clearfix">';
2243     echo '<div class="info">';
2244     echo '<h3 class="name"><a title="'.get_string('entercourse').'"'.
2245          $linkcss.' href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.
2246          highlight($highlightterms, format_string($course->fullname)).'</a></h3>';
2248     /// first find all roles that are supposed to be displayed
2250     if (!empty($CFG->coursecontact)) {
2251         $managerroles = explode(',', $CFG->coursecontact);
2252         $namesarray = array();
2253         if (isset($course->managers)) {
2254             if (count($course->managers)) {
2255                 $rusers = $course->managers;
2256                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2258                  /// Rename some of the role names if needed
2259                 if (isset($context)) {
2260                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2261                 }
2263                 // keep a note of users displayed to eliminate duplicates
2264                 $usersshown = array();
2265                 foreach ($rusers as $ra) {
2267                     // if we've already displayed user don't again
2268                     if (in_array($ra->user->id,$usersshown)) {
2269                         continue;
2270                     }
2271                     $usersshown[] = $ra->user->id;
2273                     $fullname = fullname($ra->user, $canviewfullnames);
2275                     if (isset($aliasnames[$ra->roleid])) {
2276                         $ra->rolename = $aliasnames[$ra->roleid]->name;
2277                     }
2279                     $namesarray[] = format_string($ra->rolename)
2280                         . ': <a href="'.$CFG->wwwroot.'/user/view.php?id='.$ra->user->id.'&amp;course='.SITEID.'">'
2281                         . $fullname . '</a>';
2282                 }
2283             }
2284         } else {
2285             $rusers = get_role_users($managerroles, $context,
2286                                      true, '', 'r.sortorder ASC, u.lastname ASC');
2287             if (is_array($rusers) && count($rusers)) {
2288                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2290                 /// Rename some of the role names if needed
2291                 if (isset($context)) {
2292                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2293                 }
2295                 foreach ($rusers as $teacher) {
2296                     $fullname = fullname($teacher, $canviewfullnames);
2298                     /// Apply role names
2299                     if (isset($aliasnames[$teacher->roleid])) {
2300                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2301                     }
2303                     $namesarray[] = format_string($teacher->rolename)
2304                         . ': <a href="'.$CFG->wwwroot.'/user/view.php?id='.$teacher->id.'&amp;course='.SITEID.'">'
2305                         . $fullname . '</a>';
2306                 }
2307             }
2308         }
2310         if (!empty($namesarray)) {
2311             echo "<ul class=\"teachers\">\n<li>";
2312             echo implode('</li><li>', $namesarray);
2313             echo "</li></ul>";
2314         }
2315     }
2317     // TODO: print some enrol icons
2319     echo '</div><div class="summary">';
2320     $options = NULL;
2321     $options->noclean = true;
2322     $options->para = false;
2323     if (!isset($course->summaryformat)) {
2324         $course->summaryformat = FORMAT_MOODLE;
2325     }
2326     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2327     echo '</div>';
2328     echo '</div>';
2331 /**
2332  * Prints custom user information on the home page.
2333  * Over time this can include all sorts of information
2334  */
2335 function print_my_moodle() {
2336     global $USER, $CFG, $DB, $OUTPUT;
2338     if (!isloggedin() or isguestuser()) {
2339         print_error('nopermissions', '', '', 'See My Moodle');
2340     }
2342     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2343     $rhosts   = array();
2344     $rcourses = array();
2345     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2346         $rcourses = get_my_remotecourses($USER->id);
2347         $rhosts   = get_my_remotehosts();
2348     }
2350     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2352         if (!empty($courses)) {
2353             echo '<ul class="unlist">';
2354             foreach ($courses as $course) {
2355                 if ($course->id == SITEID) {
2356                     continue;
2357                 }
2358                 echo '<li>';
2359                 print_course($course);
2360                 echo "</li>\n";
2361             }
2362             echo "</ul>\n";
2363         }
2365         // MNET
2366         if (!empty($rcourses)) {
2367             // at the IDP, we know of all the remote courses
2368             foreach ($rcourses as $course) {
2369                 print_remote_course($course, "100%");
2370             }
2371         } elseif (!empty($rhosts)) {
2372             // non-IDP, we know of all the remote servers, but not courses
2373             foreach ($rhosts as $host) {
2374                 print_remote_host($host, "100%");
2375             }
2376         }
2377         unset($course);
2378         unset($host);
2380         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2381             echo "<table width=\"100%\"><tr><td align=\"center\">";
2382             print_course_search("", false, "short");
2383             echo "</td><td align=\"center\">";
2384             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2385             echo "</td></tr></table>\n";
2386         }
2388     } else {
2389         if ($DB->count_records("course_categories") > 1) {
2390             echo $OUTPUT->box_start("categorybox");
2391             print_whole_category_list();
2392             echo $OUTPUT->box_end();
2393         } else {
2394             print_courses(0);
2395         }
2396     }
2400 function print_course_search($value="", $return=false, $format="plain") {
2401     global $CFG;
2402     static $count = 0;
2404     $count++;
2406     $id = 'coursesearch';
2408     if ($count > 1) {
2409         $id .= $count;
2410     }
2412     $strsearchcourses= get_string("searchcourses");
2414     if ($format == 'plain') {
2415         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2416         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2417         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2418         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2419         $output .= '<input type="submit" value="'.get_string('go').'" />';
2420         $output .= '</fieldset></form>';
2421     } else if ($format == 'short') {
2422         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2423         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2424         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2425         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2426         $output .= '<input type="submit" value="'.get_string('go').'" />';
2427         $output .= '</fieldset></form>';
2428     } else if ($format == 'navbar') {
2429         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2430         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2431         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2432         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2433         $output .= '<input type="submit" value="'.get_string('go').'" />';
2434         $output .= '</fieldset></form>';
2435     }
2437     if ($return) {
2438         return $output;
2439     }
2440     echo $output;
2443 function print_remote_course($course, $width="100%") {
2444     global $CFG, $USER;
2446     $linkcss = '';
2448     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2450     echo '<div class="coursebox remotecoursebox clearfix">';
2451     echo '<div class="info">';
2452     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2453          $linkcss.' href="'.$url.'">'
2454         .  format_string($course->fullname) .'</a><br />'
2455         . format_string($course->hostname) . ' : '
2456         . format_string($course->cat_name) . ' : '
2457         . format_string($course->shortname). '</div>';
2458     echo '</div><div class="summary">';
2459     $options = NULL;
2460     $options->noclean = true;
2461     $options->para = false;
2462     echo format_text($course->summary, $course->summaryformat, $options);
2463     echo '</div>';
2464     echo '</div>';
2467 function print_remote_host($host, $width="100%") {
2468     global $OUTPUT;
2470     $linkcss = '';
2472     echo '<div class="coursebox clearfix">';
2473     echo '<div class="info">';
2474     echo '<div class="name">';
2475     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2476     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2477         . s($host['name']).'</a> - ';
2478     echo $host['count'] . ' ' . get_string('courses');
2479     echo '</div>';
2480     echo '</div>';
2481     echo '</div>';
2485 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2487 function add_course_module($mod) {
2488     global $DB;
2490     $mod->added = time();
2491     unset($mod->id);
2493     return $DB->insert_record("course_modules", $mod);
2496 /**
2497  * Returns course section - creates new if does not exist yet.
2498  * @param int $relative section number
2499  * @param int $courseid
2500  * @return object $course_section object
2501  */
2502 function get_course_section($section, $courseid) {
2503     global $DB;
2505     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2506         return $cw;
2507     }
2508     $cw = new object();
2509     $cw->course   = $courseid;
2510     $cw->section  = $section;
2511     $cw->summary  = "";
2512     $cw->summaryformat = FORMAT_HTML;
2513     $cw->sequence = "";
2514     $id = $DB->insert_record("course_sections", $cw);
2515     return $DB->get_record("course_sections", array("id"=>$id));
2517 /**
2518  * Given a full mod object with section and course already defined, adds this module to that section.
2519  *
2520  * @param object $mod
2521  * @param int $beforemod An existing ID which we will insert the new module before
2522  * @return int The course_sections ID where the mod is inserted
2523  */
2524 function add_mod_to_section($mod, $beforemod=NULL) {
2525     global $DB;
2527     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2529         $section->sequence = trim($section->sequence);
2531         if (empty($section->sequence)) {
2532             $newsequence = "$mod->coursemodule";
2534         } else if ($beforemod) {
2535             $modarray = explode(",", $section->sequence);
2537             if ($key = array_keys($modarray, $beforemod->id)) {
2538                 $insertarray = array($mod->id, $beforemod->id);
2539                 array_splice($modarray, $key[0], 1, $insertarray);
2540                 $newsequence = implode(",", $modarray);
2542             } else {  // Just tack it on the end anyway
2543                 $newsequence = "$section->sequence,$mod->coursemodule";
2544             }
2546         } else {
2547             $newsequence = "$section->sequence,$mod->coursemodule";
2548         }
2550         if ($DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id))) {
2551             return $section->id;     // Return course_sections ID that was used.
2552         } else {
2553             return 0;
2554         }
2556     } else {  // Insert a new record
2557         $section->course   = $mod->course;
2558         $section->section  = $mod->section;
2559         $section->summary  = "";
2560         $section->summaryformat = FORMAT_HTML;
2561         $section->sequence = $mod->coursemodule;
2562         return $DB->insert_record("course_sections", $section);
2563     }
2566 function set_coursemodule_groupmode($id, $groupmode) {
2567     global $DB;
2568     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2571 function set_coursemodule_idnumber($id, $idnumber) {
2572     global $DB;
2573     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2576 /**
2577 * $prevstateoverrides = true will set the visibility of the course module
2578 * to what is defined in visibleold. This enables us to remember the current
2579 * visibility when making a whole section hidden, so that when we toggle
2580 * that section back to visible, we are able to return the visibility of
2581 * the course module back to what it was originally.
2582 */
2583 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2584     global $DB;
2585     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2586         return false;
2587     }
2588     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2589         return false;
2590     }
2591     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2592         foreach($events as $event) {
2593             if ($visible) {
2594                 show_event($event);
2595             } else {
2596                 hide_event($event);
2597             }
2598         }
2599     }
2600     if ($prevstateoverrides) {
2601         if ($visible == '0') {
2602             // Remember the current visible state so we can toggle this back.
2603             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2604         } else {
2605             // Get the previous saved visible states.
2606             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2607         }
2608     }
2609     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2612 /**
2613  * Delete a course module and any associated data at the course level (events)
2614  * Until 1.5 this function simply marked a deleted flag ... now it
2615  * deletes it completely.
2616  *
2617  */
2618 function delete_course_module($id) {
2619     global $CFG, $DB;
2620     require_once($CFG->libdir.'/gradelib.php');
2621     require_once($CFG->dirroot.'/blog/lib.php');
2623     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2624         return true;
2625     }
2626     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2627     //delete events from calendar
2628     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2629         foreach($events as $event) {
2630             delete_event($event->id);
2631         }
2632     }
2633     //delete grade items, outcome items and grades attached to modules
2634     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2635                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2636         foreach ($grade_items as $grade_item) {
2637             $grade_item->delete('moddelete');
2638         }
2639     }
2641     delete_context(CONTEXT_MODULE, $cm->id);
2642     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2645 function delete_mod_from_section($mod, $section) {
2646     global $DB;
2648     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2650         $modarray = explode(",", $section->sequence);
2652         if ($key = array_keys ($modarray, $mod)) {
2653             array_splice($modarray, $key[0], 1);
2654             $newsequence = implode(",", $modarray);
2655             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2656         } else {
2657             return false;
2658         }
2660     }
2661     return false;
2664 /**
2665  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2666  *
2667  * @param object $course
2668  * @param int $section
2669  * @param int $move (-1 or 1)
2670  */
2671 function move_section($course, $section, $move) {
2672 /// Moves a whole course section up and down within the course
2673     global $USER, $DB;
2675     if (!$move) {
2676         return true;
2677     }
2679     $sectiondest = $section + $move;
2681     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2682         return false;
2683     }
2685     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2686         return false;
2687     }
2689     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2690         return false;
2691     }
2693     if (!$DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id))) {
2694         return false;
2695     }
2696     if (!$DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id))) {
2697         return false;
2698     }
2699     // if the focus is on the section that is being moved, then move the focus along
2700     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2701         course_set_display($course->id, $sectiondest);
2702     }
2704     // Check for duplicates and fix order if needed.
2705     // There is a very rare case that some sections in the same course have the same section id.
2706     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2707     $n = 0;
2708     foreach ($sections as $section) {
2709         if ($section->section != $n) {
2710             if (!$DB->set_field('course_sections', 'section', $n, array('id'=>$section->id))) {
2711                 return false;
2712             }
2713         }
2714         $n++;
2715     }
2716     return true;
2719 /**
2720  * Moves a section within a course, from a position to another.
2721  * Be very careful: $section and $destination refer to section number,
2722  * not id!.
2723  *
2724  * @param object $course
2725  * @param int $section Section number (not id!!!)
2726  * @param int $destination
2727  * @return boolean Result
2728  */
2729 function move_section_to($course, $section, $destination) {
2730 /// Moves a whole course section up and down within the course
2731     global $USER, $DB;
2733     if (!$destination && $destination != 0) {
2734         return true;
2735     }
2737     if ($destination > $course->numsections) {
2738         return false;
2739     }
2741     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2742     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2743             'section ASC, id ASC', 'id, section')) {
2744         return false;
2745     }
2747     $sections = reorder_sections($sections, $section, $destination);
2749     // Update all sections
2750     foreach ($sections as $id => $position) {
2751         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2752     }
2754     // if the focus is on the section that is being moved, then move the focus along
2755     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2756         course_set_display($course->id, $destination);
2757     }
2758     return true;
2761 /**
2762  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2763  * an original position number and a target position number, rebuilds the array so that the
2764  * move is made without any duplication of section positions.
2765  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2766  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2767  *
2768  * @param array $sections
2769  * @param int $origin_position
2770  * @param int $target_position
2771  * @return array
2772  */
2773 function reorder_sections($sections, $origin_position, $target_position) {
2774     if (!is_array($sections)) {
2775         return false;
2776     }
2778     // We can't move section position 0
2779     if ($origin_position < 1) {
2780         echo "We can't move section position 0";
2781         return false;
2782     }
2784     // Locate origin section in sections array
2785     if (!$origin_key = array_search($origin_position, $sections)) {
2786         echo "searched position not in sections array";
2787         return false; // searched position not in sections array
2788     }
2790     // Extract origin section
2791     $origin_section = $sections[$origin_key];
2792     unset($sections[$origin_key]);
2794     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2795     $found = false;
2796     $append_array = array();
2797     foreach ($sections as $id => $position) {
2798         if ($found) {
2799             $append_array[$id] = $position;
2800             unset($sections[$id]);
2801         }
2802         if ($position == $target_position) {
2803             $found = true;
2804         }
2805     }
2807     // Append moved section
2808     $sections[$origin_key] = $origin_section;
2810     // Append rest of array (if applicable)
2811     if (!empty($append_array)) {
2812         foreach ($append_array as $id => $position) {
2813             $sections[$id] = $position;
2814         }
2815     }
2817     // Renumber positions
2818     $position = 0;
2819     foreach ($sections as $id => $p) {
2820         $sections[$id] = $position;
2821         $position++;
2822     }
2824     return $sections;
2828 /**
2829  * Move the module object $mod to the specified $section
2830  * If $beforemod exists then that is the module
2831  * before which $modid should be inserted
2832  * All parameters are objects
2833  */
2834 function moveto_module($mod, $section, $beforemod=NULL) {
2835     global $DB, $OUTPUT;
2837 /// Remove original module from original section
2838     if (! delete_mod_from_section($mod->id, $mod->section)) {
2839         echo $OUTPUT->notification("Could not delete module from existing section");
2840     }
2842 /// Update module itself if necessary
2844     if ($mod->section != $section->id) {
2845         $mod->section = $section->id;
2846         $DB->update_record("course_modules", $mod);
2847         // if moving to a hidden section then hide module
2848         if (!$section->visible) {
2849             set_coursemodule_visible($mod->id, 0);
2850         }
2851     }
2853 /// Add the module into the new section
2855     $mod->course       = $section->course;
2856     $mod->section      = $section->section;  // need relative reference
2857     $mod->coursemodule = $mod->id;
2859     if (! add_mod_to_section($mod, $beforemod)) {
2860         return false;
2861     }
2863     return true;
2866 function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
2867     global $CFG, $USER, $DB, $OUTPUT;
2869     static $str;
2870     static $sesskey;
2872     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
2873     // no permission to edit
2874     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
2875         return false;
2876     }
2878     if (!isset($str)) {
2879         $str->assign         = get_string("assignroles", 'role');
2880         $str->delete         = get_string("delete");
2881         $str->move           = get_string("move");
2882         $str->moveup         = get_string("moveup");
2883         $str->movedown       = get_string("movedown");
2884         $str->moveright      = get_string("moveright");
2885         $str->moveleft       = get_string("moveleft");
2886         $str->update         = get_string("update");
2887         $str->duplicate      = get_string("duplicate");
2888         $str->hide           = get_string("hide");
2889         $str->show           = get_string("show");
2890         $str->clicktochange  = get_string("clicktochange");
2891         $str->forcedmode     = get_string("forcedmode");
2892         $str->groupsnone     = get_string("groupsnone");
2893         $str->groupsseparate = get_string("groupsseparate");
2894         $str->groupsvisible  = get_string("groupsvisible");
2895         $sesskey = sesskey();
2896     }
2898     if ($section >= 0) {
2899         $section = '&amp;sr='.$section;   // Section return
2900     } else {
2901         $section = '';
2902     }
2904     if ($absolute) {
2905         $path = $CFG->wwwroot.'/course';
2906     } else {
2907         $path = '.';
2908     }
2909     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2910         if ($mod->visible) {
2911             $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
2912                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2913                         ' src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" '.
2914                         ' alt="'.$str->hide.'" /></a>'."\n";
2915         } else {
2916             $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
2917                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2918                         ' src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" '.
2919                         ' alt="'.$str->show.'" /></a>'."\n";
2920         }
2921     } else {
2922         $hideshow = '';
2923     }
2925     if ($mod->groupmode !== false) {
2926         if ($mod->groupmode == SEPARATEGROUPS) {
2927             $grouptitle = $str->groupsseparate;
2928             $groupclass = 'editing_groupsseparate';
2929             $groupimage = $OUTPUT->pix_url('t/groups') . '';
2930             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
2931         } else if ($mod->groupmode == VISIBLEGROUPS) {
2932             $grouptitle = $str->groupsvisible;
2933             $groupclass = 'editing_groupsvisible';
2934             $groupimage = $OUTPUT->pix_url('t/groupv') . '';
2935             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
2936         } else {
2937             $grouptitle = $str->groupsnone;
2938             $groupclass = 'editing_groupsnone';
2939             $groupimage = $OUTPUT->pix_url('t/groupn') . '';
2940             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
2941         }
2942         if ($mod->groupmodelink) {
2943             $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
2944                          '<img src="'.$groupimage.'" class="iconsmall" '.
2945                          'alt="'.$grouptitle.'" /></a>';
2946         } else {
2947             $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
2948                          ' src="'.$groupimage.'" class="iconsmall" '.
2949                          'alt="'.$grouptitle.'" />';
2950         }
2951     } else {
2952         $groupmode = "";
2953     }
2955     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2956         if ($moveselect) {
2957             $move =     '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
2958                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2959                         ' src="'.$OUTPUT->pix_url('t/move') . '" class="iconsmall" '.
2960                         ' alt="'.$str->move.'" /></a>'."\n";
2961         } else {
2962             $move =     '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
2963                         '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
2964                         ' src="'.$OUTPUT->pix_url('t/up') . '" class="iconsmall" '.
2965                         ' alt="'.$str->moveup.'" /></a>'."\n".
2966                         '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
2967                         '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
2968                         ' src="'.$OUTPUT->pix_url('t/down') . '" class="iconsmall" '.
2969                         ' alt="'.$str->movedown.'" /></a>'."\n";
2970         }
2971     } else {
2972         $move = '';
2973     }
2975     $leftright = '';
2976     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2978         if (right_to_left()) {   // Exchange arrows on RTL
2979             $rightarrow = 't/left';
2980             $leftarrow  = 't/right';
2981         } else {
2982             $rightarrow = 't/right';
2983             $leftarrow  = 't/left';
2984         }
2986         if ($indent > 0) {
2987             $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
2988                         '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
2989                         ' src="'.$OUTPUT->pix_url($leftarrow).'" class="iconsmall" '.
2990                         ' alt="'.$str->moveleft.'" /></a>'."\n";
2991         }
2992         if ($indent >= 0) {
2993             $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
2994                         '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
2995                         ' src="'.$OUTPUT->pix_url($rightarrow).'" class="iconsmall" '.
2996                         ' alt="'.$str->moveright.'" /></a>'."\n";
2997         }
2998     }
2999     if (has_capability('moodle/course:managegroups', $modcontext)){
3000         $context = get_context_instance(CONTEXT_MODULE, $mod->id);
3001         $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
3002             $context->id.'"><img src="'.$OUTPUT->pix_url('i/roles') . '" alt="'.$str->assign.'" class="iconsmall"/></a>';
3003     } else {
3004         $assign = '';
3005     }
3007     return '<span class="commands">'."\n".$leftright.$move.
3008            '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
3009            '&amp;sesskey='.$sesskey.$section.'"><img'.
3010            ' src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" '.
3011            ' alt="'.$str->update.'" /></a>'."\n".
3012            '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
3013            '&amp;sesskey='.$sesskey.$section.'"><img'.
3014            ' src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" '.
3015            ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
3018 /**
3019  * given a course object with shortname & fullname, this function will
3020  * truncate the the number of chars allowed and add ... if it was too long
3021  */
3022 function course_format_name ($course,$max=100) {
3024     $str = $course->shortname.': '. $course->fullname;
3025     if (strlen($str) <= $max) {
3026         return $str;
3027     }
3028     else {
3029         return substr($str,0,$max-3).'...';
3030     }
3033 function update_restricted_mods($course, $mods) {
3034     global $DB;
3036 /// Delete all the current restricted list
3037     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3039     if (empty($course->restrictmodules)) {
3040         return;   // We're done
3041     }
3043 /// Insert the new list of restricted mods
3044     foreach ($mods as $mod) {
3045         if ($mod == 0) {
3046             continue; // this is the 'allow none' option
3047         }
3048         $am = new object();
3049         $am->course = $course->id;
3050         $am->module = $mod;
3051         $DB->insert_record('course_allowed_modules',$am);
3052     }
3055 /**
3056  * This function will take an int (module id) or a string (module name)
3057  * and return true or false, whether it's allowed in the given course (object)
3058  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3059  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3060  */
3062 function course_allowed_module($course,$mod) {
3063     global $DB;
3065     if (empty($course->restrictmodules)) {
3066         return true;
3067     }
3069     // Admins and admin-like people who can edit everything can also add anything.
3070     // Originally there was a coruse:update test only, but it did not match the test in course edit form
3071     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3072         return true;
3073     }
3075     if (is_numeric($mod)) {
3076         $modid = $mod;
3077     } else if (is_string($mod)) {
3078         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3079     }
3080     if (empty($modid)) {
3081         return false;
3082     }
3084     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3087 /**
3088  * Recursively delete category including all subcategories and courses.
3089  * @param object $category
3090  * @param boolean $showfeedback display some notices
3091  * @return array return deleted courses
3092  */
3093 function category_delete_full($category, $showfeedback=true) {
3094     global $CFG, $DB;
3095     require_once($CFG->libdir.'/gradelib.php');
3096     require_once($CFG->libdir.'/questionlib.php');
3097     require_once($CFG->dirroot.'/cohort/lib.php');
3099     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3100         foreach ($children as $childcat) {
3101             category_delete_full($childcat, $showfeedback);
3102         }
3103     }
3105     $deletedcourses = array();
3106     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3107         foreach ($courses as $course) {
3108             if (!delete_course($course, false)) {
3109                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3110             }
3111             $deletedcourses[] = $course;
3112         }
3113     }
3115     // move or delete cohorts in this context
3116     cohort_delete_category($category);
3118     // now delete anything that may depend on course category context
3119     grade_course_category_delete($category->id, 0, $showfeedback);
3120     if (!question_delete_course_category($category, 0, $showfeedback)) {
3121         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3122     }
3124     // finally delete the category and it's context
3125     $DB->delete_records('course_categories', array('id'=>$category->id));
3126     delete_context(CONTEXT_COURSECAT, $category->id);
3128     events_trigger('course_category_deleted', $category);
3130     return $deletedcourses;
3133 /**
3134  * Delete category, but move contents to another category.
3135  * @param object $ccategory
3136  * @param int $newparentid category id
3137  * @return bool status
3138  */
3139 function category_delete_move($category, $newparentid, $showfeedback=true) {
3140     global $CFG, $DB, $OUTPUT;
3141     require_once($CFG->libdir.'/gradelib.php');
3142     require_once($CFG->libdir.'/questionlib.php');
3143     require_once($CFG->dirroot.'/cohort/lib.php');
3145     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3146         return false;
3147     }
3149     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3150         foreach ($children as $childcat) {
3151             move_category($childcat, $newparentcat);
3152         }
3153     }
3155     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3156         if (!move_courses(array_keys($courses), $newparentid)) {
3157             echo $OUTPUT->notification("Error moving courses");
3158             return false;
3159         }
3160         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3161     }
3163     // move or delete cohorts in this context
3164     cohort_delete_category($category);
3166     // now delete anything that may depend on course category context
3167     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3168     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3169         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3170         return false;
3171     }
3173     // finally delete the category and it's context
3174     $DB->delete_records('course_categories', array('id'=>$category->id));
3175     delete_context(CONTEXT_COURSECAT, $category->id);
3177     events_trigger('course_category_deleted', $category);
3179     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3181     return true;
3184 /**
3185  * Efficiently moves many courses around while maintaining
3186  * sortorder in order.
3187  *
3188  * @param $courseids is an array of course ids
3189  * @return bool success
3190  */
3191 function move_courses($courseids, $categoryid) {
3192     global $CFG, $DB, $OUTPUT;
3194     if (empty($courseids)) {
3195         // nothing to do
3196         return;
3197     }
3199     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3200         return false;
3201     }
3203     $courseids = array_reverse($courseids);
3204     $i = 1;
3206     foreach ($courseids as $courseid) {
3207         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3208             $course->category  = $category->id;
3209             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3210             if ($category->visible == 0) {
3211                 // hide the course when moving into hidden category,
3212                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3213                 $course->visible = 0;
3214             }
3216             $DB->update_record('course', $course);
3218             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3219             $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3220             context_moved($context, $newparent);
3221         }
3222     }
3223     fix_course_sortorder();
3225     return true;
3228 /**
3229  * Hide course category and child course and subcategories
3230  * @param $category
3231  * @return void
3232  */
3233 function course_category_hide($category) {
3234     global $DB;
3236     $category->visible = 0;
3237     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3238     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3239     $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($category->id)); // store visible flag so that we can return to it if we immediately unhide
3240     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3241     // get all child categories and hide too
3242     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3243         foreach ($subcats as $cat) {
3244             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3245             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3246             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3247             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3248         }
3249     }
3252 /**
3253  * Show course category and child course and subcategories
3254  * @param $category
3255  * @return void
3256  */
3257 function course_category_show($category) {
3258     global $DB;
3260     $category->visible = 1;
3261     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3262     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3263     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3264     // get all child categories and unhide too
3265     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3266         foreach ($subcats as $cat) {
3267             if ($cat->visibleold) {
3268                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3269             }
3270             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3271         }
3272     }
3275 /**
3276  * Efficiently moves a category - NOTE that this can have
3277  * a huge impact access-control-wise...
3278  */
3279 function move_category($category, $newparentcat) {
3280     global $CFG, $DB;
3282     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3284     $hidecat = false;
3285     if (empty($newparentcat->id)) {
3286         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3288         $newparent = get_context_instance(CONTEXT_SYSTEM);
3290     } else {
3291         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3292         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3294         if (!$newparentcat->visible and $category->visible) {
3295             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3296             $hidecat = true;
3297         }
3298     }
3300     context_moved($context, $newparent);
3302     // now make it last in new category
3303     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3305     // and fix the sortorders
3306     fix_course_sortorder();
3308     if ($hidecat) {
3309         course_category_hide($category);
3310     }
3313 /**
3314  * Returns the display name of the given section that the course prefers.
3315  *
3316  * This function utilizes a callback that can be implemented within the course
3317  * formats lib.php file to customize the display name that is used to reference
3318  * the section.
3319  *
3320  * By default (if callback is not defined) the method
3321  * {@see get_numeric_section_name} is called instead.
3322  *
3323  * @param stdClass $course The course to get the section name for
3324  * @param stdClass $section Section object from database
3325  * @return Display name that the course format prefers, e.g. "Week 2"
3326  *
3327  * @see get_generic_section_name
3328  */
3329 function get_section_name(stdClass $course, stdClass $section) {
3330     global $CFG;
3332     /// Inelegant hack for bug 3408
3333     if ($course->format == 'site') {
3334         return get_string('site');
3335     }
3337     // Use course formatter callback if it exists
3338     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3339     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3340     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3341         require_once $namingfile;
3342     }
3343     if (function_exists($namingfunction)) {
3344         return $namingfunction($course, $section);
3345     }
3347     // else, default behavior:
3348     return get_generic_section_name($course->format, $section);
3351 /**
3352  * Gets the generic section name for a courses section.
3353  *
3354  * @param string $format Course format ID e.g. 'weeks' $course->format
3355  * @param stdClass $section Section object from database
3356  * @return Display name that the course format prefers, e.g. "Week 2"
3357  */
3358 function get_generic_section_name($format, stdClass $section) {
3359     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3363 function course_format_uses_sections($format) {
3364     global $CFG;
3366     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3367     $featurefunction = 'callback_'.$format.'_uses_sections';
3368     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3369         require_once $featurefile;
3370     }
3371     if (function_exists($featurefunction)) {
3372         return $featurefunction();
3373     }
3375     return false;
3378 /**
3379  * Can the current user delete this course?
3380  * Course creators have exception,
3381  * 1 day after the creation they can sill delete the course.
3382  * @param int $courseid
3383  * @return boolean
3384  */
3385 function can_delete_course($courseid) {
3386     global $USER, $DB;
3388     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3390     if (has_capability('moodle/course:delete', $context)) {
3391         return true;
3392     }
3394     // hack: now try to find out if creator created this course recently (1 day)
3395     if (!has_capability('moodle/course:create', $context)) {
3396         return false;
3397     }
3399     $since = time() - 60*60*24;
3401     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3402     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3404     return $DB->record_exists_select('log', $select, $params);
3407 /**
3408  * Save the Your name for 'Some role' strings.
3409  *
3410  * @param integer $courseid the id of this course.
3411  * @param array $data the data that came from the course settings form.
3412  */
3413 function save_local_role_names($courseid, $data) {
3414     global $DB;
3415     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3417     foreach ($data as $fieldname => $value) {
3418         if (strpos($fieldname, 'role_') !== 0) {
3419             continue;
3420         }
3421         list($ignored, $roleid) = explode('_', $fieldname);
3423         // make up our mind whether we want to delete, update or insert
3424         if (!$value) {
3425             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3427         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3428             $rolename->name = $value;
3429             $DB->update_record('role_names', $rolename);
3431         } else {
3432             $rolename = new stdClass;
3433             $rolename->contextid = $context->id;
3434             $rolename->roleid = $roleid;
3435             $rolename->name = $value;
3436             $DB->insert_record('role_names', $rolename);
3437         }
3438     }
3441 /**
3442  * Create a course and either return a $course object
3443  *
3444  * Please note this functions does not verify any access control,
3445  * the calling code is responsible for all validation (usually it is the form definition).
3446  *
3447  * @param array $editoroptions course description editor options
3448  * @param object $data  - all the data needed for an entry in the 'course' table
3449  * @return object new course instance
3450  */
3451 function create_course($data, $editoroptions = NULL) {
3452     global $CFG, $DB;
3454     //check the categoryid - must be given for all new courses
3455     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3457     //check if the shortname already exist
3458     if (!empty($data->shortname)) {
3459         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3460             throw new moodle_exception('shortnametaken');
3461         }
3462     }
3464     //check if the id number already exist
3465     if (!empty($data->idnumber)) {
3466         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3467             throw new moodle_exception('idnumbertaken');
3468         }
3469     }
3471     $data->timecreated  = time();
3472     $data->timemodified = $data->timecreated;
3474     // place at beginning of any category
3475     $data->sortorder = 0;
3477     if ($editoroptions) {
3478         // summary text is updated later, we need context to store the files first
3479         $data->summary = '';
3480         $data->summary_format = FORMAT_HTML;
3481     }
3483     if (!isset($data->visible)) {
3484         // data not from form, add missing visibility info
3485         $data->visible = $category->visible;
3486     }
3487     $data->visibleold = $data->visible;
3489     $newcourseid = $DB->insert_record('course', $data);
3490     $context = get_context_instance(CONTEXT_COURSE, $newcourseid, MUST_EXIST);
3492     if ($editoroptions) {
3493         // Save the files used in the summary editor and store
3494         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3495         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3496         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3497     }
3499     $course = $DB->get_record('course', array('id'=>$newcourseid));
3501     // Setup the blocks
3502     blocks_add_default_course_blocks($course);
3504     $section = new object();
3505     $section->course        = $course->id;   // Create a default section.
3506     $section->section       = 0;
3507     $section->summaryformat = FORMAT_HTML;
3508     $DB->insert_record('course_sections', $section);
3510     fix_course_sortorder();
3512     // update module restrictions
3513     if ($course->restrictmodules) {
3514         if (isset($data->allowedmods)) {
3515             update_restricted_mods($data->allowedmods);
3516         } else {
3517             if (!empty($CFG->defaultallowedmodules)) {
3518                 update_restricted_mods($course, explode(',', $CFG->defaultallowedmodules));
3519             }
3520         }
3521     }
3523     // new context created - better mark it as dirty
3524     mark_context_dirty($context->path);
3526     // Save any custom role names.
3527     save_local_role_names($course->id, $data);
3529     // set up enrolments
3530     enrol_course_updated(true, $course, $data);
3532     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3534     // Trigger events
3535     events_trigger('course_created', $course);
3537     return $course;
3540 /**
3541  * Update a course.
3542  *
3543  * Please note this functions does not verify any access control,
3544  * the calling code is responsible for all validation (usually it is the form definition).
3545  *
3546  * @param object $data  - all the data needed for an entry in the 'course' table
3547  * @param array $editoroptions course description editor options
3548  * @return void
3549  */
3550 function update_course($data, $editoroptions = NULL) {
3551     global $CFG, $DB;
3553     $data->timemodified = time();
3555     $oldcourse = $DB->get_record('course', array('id'=>$data->id), '*', MUST_EXIST);
3556     $context   = get_context_instance(CONTEXT_COURSE, $oldcourse->id);
3558     if ($editoroptions) {
3559         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3560     }
3562     if (!isset($data->category) or empty($data->category)) {
3563         // prevent nulls and 0 in category field
3564         unset($data->category);
3565     }
3566     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3568     if (!isset($data->visible)) {
3569         // data not from form, add missing visibility info
3570         $data->visible = $oldcourse->visible;
3571     }
3573     if ($data->visible != $oldcourse->visible) {
3574         // reset the visibleold flag when manually hiding/unhiding course
3575         $data->visibleold = $data->visible;
3576     } else {
3577         if ($movecat) {
3578             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3579             if (empty($newcategory->visible)) {
3580                 // make sure when moving into hidden category the course is hidden automatically
3581                 $data->visible = 0;
3582             }
3583         }
3584     }
3586     // Update with the new data
3587     $DB->update_record('course', $data);
3589     $course = $DB->get_record('course', array('id'=>$data->id));
3591     if ($movecat) {
3592         $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3593         context_moved($context, $newparent);
3594     }
3596     fix_course_sortorder();
3598     // Test for and remove blocks which aren't appropriate anymore
3599     blocks_remove_inappropriate($course);
3601     // update module restrictions
3602     if (isset($data->allowedmods)) {
3603         update_restricted_mods($course, $data->allowedmods);
3604     }
3606     // Save any custom role names.
3607     save_local_role_names($course->id, $data);
3609     // update enrol settings
3610     enrol_course_updated(false, $course, $data);
3612     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3614     // Trigger events
3615     events_trigger('course_updated', $course);
3618 /**
3619  * TODO: Average number of participants (in non-empty courses)
3620  * @return integer
3621  */
3622 function average_number_of_participants() {
3623     global $DB;
3624     return 0;
3625     return $avg;
3628 /**
3629  * TODO: Average number of course modules (in non-empty courses)
3630  * @return integer
3631  */
3632 function average_number_of_courses_modules() {
3633     global $DB;
3634     return 0;
3635     return $avg;
3638 /**
3639  * This class pertains to course requests and contains methods associated with
3640  * create, approving, and removing course requests.
3641  *
3642  * Please note we do not allow embedded images here because there is no context
3643  * to store them with proper access control.
3644  *
3645  * @copyright 2009 Sam Hemelryk
3646  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3647  * @since Moodle 2.0
3648  *
3649  * @property-read int $id
3650  * @property-read string $fullname
3651  * @property-read string $shortname
3652  * @property-read string $summary
3653  * @property-read int $summaryformat
3654  * @property-read int $summarytrust
3655  * @property-read string $reason
3656  * @property-read int $requester
3657  */
3658 class course_request {
3660     /**
3661      * This is the stdClass that stores the properties for the course request
3662      * and is externally acccessed through the __get magic method
3663      * @var stdClass
3664      */
3665     protected $properties;
3667     /**
3668      * An array of options for the summary editor used by course request forms.
3669      * This is initially set by {@link summary_editor_options()}
3670      * @var array
3671      * @static
3672      */
3673     protected static $summaryeditoroptions;
3675     /**
3676      * Static function to prepare the summary editor for working with a course
3677      * request.
3678      *
3679      * @static
3680      * @param null|stdClass $data Optional, an object containing the default values
3681      *                       for the form, these may be modified when preparing the
3682      *                       editor so this should be called before creating the form
3683      * @return stdClass An object that can be used to set the default values for
3684      *                   an mforms form
3685      */
3686     public static function prepare($data=null) {
3687         if ($data === null) {
3688             $data = new stdClass;
3689         }
3690         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
3691         return $data;
3692     }
3694     /**
3695      * Static function to create a new course request when passed an array of properties
3696      * for it.
3697      *
3698      * This function also handles saving any files that may have been used in the editor
3699      *
3700      * @static
3701      * @param stdClass $data
3702      * @return course_request The newly created course request
3703      */
3704     public static function create($data) {
3705         global $USER, $DB, $CFG;
3706         $data->requester = $USER->id;
3708         // Summary is a required field so copy the text over
3709         $data->summary       = $data->summary_editor['text'];
3710         $data->summaryformat = $data->summary_editor['format'];
3712         $data->id = $DB->insert_record('course_request', $data);
3714         // Create a new course_request object and return it
3715         $request = new course_request($data);
3717         // Notify the admin if required.
3718         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
3720             $a = new stdClass;
3721             $a->link = "$CFG->wwwroot/course/pending.php";
3722             $a->user = fullname($USER);
3723             $subject = get_string('courserequest');
3724             $message = get_string('courserequestnotifyemail', 'admin', $a);
3725             foreach ($users as $user) {
3726                 $request->notify($user, $USER, 'courserequested', $subject, $message);
3727             }
3728         }
3730         return $request;
3731     }
3733     /**
3734      * Returns an array of options to use with a summary editor
3735      *
3736      * @uses course_request::$summaryeditoroptions
3737      * @return array An array of options to use with the editor
3738      */
3739     public static function summary_editor_options() {
3740         global $CFG;
3741         if (self::$summaryeditoroptions === null) {
3742             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
3743         }
3744         return self::$summaryeditoroptions;
3745     }
3747     /**
3748      * Loads the properties for this course request object. Id is required and if
3749      * only id is provided then we load the rest of the properties from the database
3750      *
3751      * @param stdClass|int $properties Either an object containing properties
3752      *                      or the course_request id to load
3753      */
3754     public function __construct($properties) {
3755         global $DB;
3756         if (empty($properties->id)) {
3757             if (empty($properties)) {
3758                 throw new coding_exception('You must provide a course request id when creating a course_request object');
3759             }
3760             $id = $properties;
3761             $properties = new stdClass;
3762             $properties->id = (int)$id;
3763             unset($id);
3764         }
3765         if (empty($properties->requester)) {
3766             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3767                 print_error('unknowncourserequest');
3768             }
3769         } else {
3770             $this->properties = $properties;
3771         }
3772         $this->properties->collision = null;
3773     }
3775     /**
3776      * Returns the requested property
3777      *
3778      * @param string $key
3779      * @return mixed
3780      */
3781     public function __get($key) {
3782         return $this->properties->$key;
3783     }
3785     /**
3786      * Override this to ensure empty($request->blah) calls return a reliable answer...
3787      *
3788      * This is required because we define the __get method
3789      *
3790      * @param mixed $key
3791      * @return bool True is it not empty, false otherwise
3792      */
3793     public function __isset($key) {
3794         return (!empty($this->properties->$key));
3795     }
3797     /**
3798      * Returns the user who requested this course
3799      *
3800      * Uses a static var to cache the results and cut down the number of db queries
3801      *
3802      * @staticvar array $requesters An array of cached users
3803      * @return stdClass The user who requested the course
3804      */
3805     public function get_requester() {
3806         global $DB;
3807         static $requesters= array();
3808         if (!array_key_exists($this->properties->requester, $requesters)) {
3809             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3810         }
3811         return $requesters[$this->properties->requester];
3812     }
3814     /**
3815      * Checks that the shortname used by the course does not conflict with any other
3816      * courses that exist
3817      *
3818      * @param string|null $shortnamemark The string to append to the requests shortname
3819      *                     should a conflict be found
3820      * @return bool true is there is a conflict, false otherwise
3821      */
3822     public function check_shortname_collision($shortnamemark = '[*]') {
3823         global $DB;
3825         if ($this->properties->collision !== null) {
3826             return $this->properties->collision;
3827         }
3829         if (empty($this->properties->shortname)) {
3830             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3831             $this->properties->collision = false;
3832         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3833             if (!empty($shortnamemark)) {
3834                 $this->properties->shortname .= ' '.$shortnamemark;
3835             }
3836             $this->properties->collision = true;
3837         } else {
3838             $this->properties->collision = false;
3839         }
3840         return $this->properties->collision;
3841     }
3843     /**
3844      * This function approves the request turning it into a course
3845      *
3846      * This function converts the course request into a course, at the same time
3847      * transfering any files used in the summary to the new course and then removing
3848      * the course request and the files associated with it.
3849      *
3850      * @return int The id of the course that was created from this request
3851      */
3852     public function approve() {
3853         global $CFG, $DB, $USER;
3855         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3857         $category = get_course_category($CFG->defaultrequestcategory);
3858         $courseconfig = get_config('moodlecourse');
3860         // Transfer appropriate settings
3861         $data = clone($this->properties);
3862         unset($data->id);
3863         unset($data->reason);
3864         unset($data->requester);
3866         // Set category
3867         $data->category = $category->id;
3868         $data->sortorder = $category->sortorder; // place as the first in category
3870         // Set misc settings
3871         $data->requested = 1;
3872         if (!empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor != 'none' && !empty($CFG->restrictbydefault)) {
3873             $data->restrictmodules = 1;
3874         }
3876         // Apply course default settings
3877         $data->format             = $courseconfig->format;
3878         $data->numsections        = $courseconfig->numsections;
3879         $data->hiddensections     = $courseconfig->hiddensections;
3880         $data->newsitems          = $courseconfig->newsitems;
3881         $data->showgrades         = $courseconfig->showgrades;
3882         $data->showreports        = $courseconfig->showreports;
3883         $data->maxbytes           = $courseconfig->maxbytes;
3884         $data->groupmode          = $courseconfig->groupmode;
3885         $data->groupmodeforce     = $courseconfig->groupmodeforce;
3886         $data->visible            = $courseconfig->visible;
3887         $data->visibleold         = $data->visible;
3888         $data->lang               = $courseconfig->lang;
3890         $course = create_course($data);
3891         $context = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
3893         // add enrol instances
3894         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3895             if ($manual = enrol_get_plugin('manual')) {
3896                 $manual->add_default_instance($course);
3897             }
3898         }
3900         // enrol the requester as teacher if necessary
3901         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3902             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3903         }
3905         $this->delete();
3907         $a = new object();
3908         $a->name = $course->fullname;
3909         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3910         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3912         return $course->id;
3913     }
3915     /**
3916      * Reject a course request
3917      *
3918      * This function rejects a course request, emailing the requesting user the
3919      * provided notice and then removing the request from the database
3920      *
3921      * @param string $notice The message to display to the user
3922      */
3923     public function reject($notice) {
3924         global $USER, $DB;
3925         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
3926         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3927         $this->delete();
3928     }
3930     /**
3931      * Deletes the course request and any associated files
3932      */
3933     public function delete() {
3934         global $DB;
3935         $DB->delete_records('course_request', array('id' => $this->properties->id));
3936     }
3938     /**
3939      * Send a message from one user to another using events_trigger
3940      *
3941      * @param object $touser
3942      * @param object $fromuser
3943      * @param string $name
3944      * @param string $subject
3945      * @param string $message
3946      */
3947     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
3948         $eventdata = new object();
3949         $eventdata->modulename        = 'moodle';
3950         $eventdata->component         = 'course';
3951         $eventdata->name              = $name;
3952         $eventdata->userfrom          = $fromuser;
3953         $eventdata->userto            = $touser;
3954         $eventdata->subject           = $subject;
3955         $eventdata->fullmessage       = $message;
3956         $eventdata->fullmessageformat = FORMAT_PLAIN;
3957         $eventdata->fullmessagehtml   = '';
3958         $eventdata->smallmessage      = '';
3959         message_send($eventdata);
3960     }