a28be6dc7a2be4344d371dcb30d7cafccd2f504a
[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     $groupid = 0;
153     $joins = array();
155     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
156               FROM {mnet_log} l
157                LEFT JOIN {user} u ON l.userid = u.id
158               WHERE ";
159     $params = array();
161     $where .= "l.hostid = :hostid";
162     $params['hostid'] = $hostid;
164     // TODO: Is 1 really a magic number referring to the sitename?
165     if ($course != SITEID || $modid != 0) {
166         $where .= " AND l.course=:courseid";
167         $params['courseid'] = $course;
168     }
170     if ($modname) {
171         $where .= " AND l.module = :modname";
172         $params['modname'] = $modname;
173     }
175     if ('site_errors' === $modid) {
176         $where .= " AND ( l.action='error' OR l.action='infected' )";
177     } else if ($modid) {
178         //TODO: This assumes that modids are the same across sites... probably
179         //not true
180         $where .= " AND l.cmid = :modid";
181         $params['modid'] = $modid;
182     }
184     if ($modaction) {
185         $firstletter = substr($modaction, 0, 1);
186         if ($firstletter == '-') {
187             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
188             $params['modaction'] = '%'.substr($modaction, 1).'%';
189         } else {
190             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
191             $params['modaction'] = '%'.$modaction.'%';
192         }
193     }
195     if ($user) {
196         $where .= " AND l.userid = :user";
197         $params['user'] = $user;
198     }
200     if ($date) {
201         $enddate = $date + 86400;
202         $where .= " AND l.time > :date AND l.time < :enddate";
203         $params['date'] = $date;
204         $params['enddate'] = $enddate;
205     }
207     $result = array();
208     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
209     if(!empty($result['totalcount'])) {
210         $where .= " ORDER BY $order";
211         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
212     } else {
213         $result['logs'] = array();
214     }
215     return $result;
218 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
219                    $modname="", $modid=0, $modaction="", $groupid=0) {
220     global $DB, $SESSION, $USER;
221     // It is assumed that $date is the GMT time of midnight for that day,
222     // and so the next 86400 seconds worth of logs are printed.
224     /// Setup for group handling.
226     /// If the group mode is separate, and this user does not have editing privileges,
227     /// then only the user's group can be viewed.
228     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
229         if (isset($SESSION->currentgroup[$course->id])) {
230             $groupid =  $SESSION->currentgroup[$course->id];
231         } else {
232             $groupid = groups_get_all_groups($course->id, $USER->id);
233             if (is_array($groupid)) {
234                 $groupid = array_shift(array_keys($groupid));
235                 $SESSION->currentgroup[$course->id] = $groupid;
236             } else {
237                 $groupid = 0;
238             }
239         }
240     }
241     /// If this course doesn't have groups, no groupid can be specified.
242     else if (!$course->groupmode) {
243         $groupid = 0;
244     }
246     $joins = array();
247     $params = array();
249     if ($course->id != SITEID || $modid != 0) {
250         $joins[] = "l.course = :courseid";
251         $params['courseid'] = $course->id;
252     }
254     if ($modname) {
255         $joins[] = "l.module = :modname";
256         $params['modname'] = $modname;
257     }
259     if ('site_errors' === $modid) {
260         $joins[] = "( l.action='error' OR l.action='infected' )";
261     } else if ($modid) {
262         $joins[] = "l.cmid = :modid";
263         $params['modid'] = $modid;
264     }
266     if ($modaction) {
267         $firstletter = substr($modaction, 0, 1);
268         if ($firstletter == '-') {
269             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
270             $params['modaction'] = '%'.substr($modaction, 1).'%';
271         } else {
272             $joins[] = $DB->sql_like('l.action', ':modaction', false);
273             $params['modaction'] = '%'.$modaction.'%';
274         }
275     }
278     /// Getting all members of a group.
279     if ($groupid and !$user) {
280         if ($gusers = groups_get_members($groupid)) {
281             $gusers = array_keys($gusers);
282             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
283         } else {
284             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
285         }
286     }
287     else if ($user) {
288         $joins[] = "l.userid = :userid";
289         $params['userid'] = $user;
290     }
292     if ($date) {
293         $enddate = $date + 86400;
294         $joins[] = "l.time > :date AND l.time < :enddate";
295         $params['date'] = $date;
296         $params['enddate'] = $enddate;
297     }
299     $selector = implode(' AND ', $joins);
301     $totalcount = 0;  // Initialise
302     $result = array();
303     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
304     $result['totalcount'] = $totalcount;
305     return $result;
309 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
310                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
312     global $CFG, $DB, $OUTPUT;
314     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
315                        $modname, $modid, $modaction, $groupid)) {
316         echo $OUTPUT->notification("No logs found!");
317         echo $OUTPUT->footer();
318         exit;
319     }
321     $courses = array();
323     if ($course->id == SITEID) {
324         $courses[0] = '';
325         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
326             foreach ($ccc as $cc) {
327                 $courses[$cc->id] = $cc->shortname;
328             }
329         }
330     } else {
331         $courses[$course->id] = $course->shortname;
332     }
334     $totalcount = $logs['totalcount'];
335     $count=0;
336     $ldcache = array();
337     $tt = getdate(time());
338     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
340     $strftimedatetime = get_string("strftimedatetime");
342     echo "<div class=\"info\">\n";
343     print_string("displayingrecords", "", $totalcount);
344     echo "</div>\n";
346     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
348     $table = new html_table();
349     $table->classes = array('logtable','generalbox');
350     $table->align = array('right', 'left', 'left');
351     $table->head = array(
352         get_string('time'),
353         get_string('ip_address'),
354         get_string('fullnamecourse'),
355         get_string('action'),
356         get_string('info')
357     );
358     $table->data = array();
360     if ($course->id == SITEID) {
361         array_unshift($table->align, 'left');
362         array_unshift($table->head, get_string('course'));
363     }
365     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
366     if (empty($logs['logs'])) {
367         $logs['logs'] = array();
368     }
370     foreach ($logs['logs'] as $log) {
372         if (isset($ldcache[$log->module][$log->action])) {
373             $ld = $ldcache[$log->module][$log->action];
374         } else {
375             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
376             $ldcache[$log->module][$log->action] = $ld;
377         }
378         if ($ld && is_numeric($log->info)) {
379             // ugly hack to make sure fullname is shown correctly
380             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
381                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
382             } else {
383                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
384             }
385         }
387         //Filter log->info
388         $log->info = format_string($log->info);
390         // If $log->url has been trimmed short by the db size restriction
391         // code in add_to_log, keep a note so we don't add a link to a broken url
392         $tl=textlib_get_instance();
393         $brokenurl=($tl->strlen($log->url)==100 && $tl->substr($log->url,97)=='...');
395         $row = array();
396         if ($course->id == SITEID) {
397             if (empty($log->course)) {
398                 $row[] = get_string('site');
399             } else {
400                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
401             }
402         }
404         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
406         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
407         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
409         $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))));
411         $displayaction="$log->module $log->action";
412         if ($brokenurl) {
413             $row[] = $displayaction;
414         } else {
415             $link = make_log_url($log->module,$log->url);
416             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
417         }
418         $row[] = $log->info;
419         $table->data[] = $row;
420     }
422     echo html_writer::table($table);
423     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
427 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
428                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
430     global $CFG, $DB, $OUTPUT;
432     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
433                        $modname, $modid, $modaction, $groupid)) {
434         echo $OUTPUT->notification("No logs found!");
435         echo $OUTPUT->footer();
436         exit;
437     }
439     if ($course->id == SITEID) {
440         $courses[0] = '';
441         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
442             foreach ($ccc as $cc) {
443                 $courses[$cc->id] = $cc->shortname;
444             }
445         }
446     }
448     $totalcount = $logs['totalcount'];
449     $count=0;
450     $ldcache = array();
451     $tt = getdate(time());
452     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
454     $strftimedatetime = get_string("strftimedatetime");
456     echo "<div class=\"info\">\n";
457     print_string("displayingrecords", "", $totalcount);
458     echo "</div>\n";
460     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
462     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
463     echo "<tr>";
464     if ($course->id == SITEID) {
465         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
466     }
467     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
468     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
469     echo "<th class=\"c3 header\">".get_string('fullnamecourse')."</th>\n";
470     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
471     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
472     echo "</tr>\n";
474     if (empty($logs['logs'])) {
475         echo "</table>\n";
476         return;
477     }
479     $row = 1;
480     foreach ($logs['logs'] as $log) {
482         $log->info = $log->coursename;
483         $row = ($row + 1) % 2;
485         if (isset($ldcache[$log->module][$log->action])) {
486             $ld = $ldcache[$log->module][$log->action];
487         } else {
488             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
489             $ldcache[$log->module][$log->action] = $ld;
490         }
491         if (0 && $ld && !empty($log->info)) {
492             // ugly hack to make sure fullname is shown correctly
493             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
494                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
495             } else {
496                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
497             }
498         }
500         //Filter log->info
501         $log->info = format_string($log->info);
503         echo '<tr class="r'.$row.'">';
504         if ($course->id == SITEID) {
505             echo "<td class=\"r$row c0\" >\n";
506             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courses[$log->course]."</a>\n";
507             echo "</td>\n";
508         }
509         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
510              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
511         echo "<td class=\"r$row c2\" >\n";
512         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
513         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
514         echo "</td>\n";
515         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
516         echo "<td class=\"r$row c3\" >\n";
517         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
518         echo "</td>\n";
519         echo "<td class=\"r$row c4\">\n";
520         echo $log->action .': '.$log->module;
521         echo "</td>\n";;
522         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
523         echo "</tr>\n";
524     }
525     echo "</table>\n";
527     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
531 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
532                         $modid, $modaction, $groupid) {
533     global $DB;
535     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
536             get_string('fullnamecourse')."\t".get_string('action')."\t".get_string('info');
538     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
539                        $modname, $modid, $modaction, $groupid)) {
540         return false;
541     }
543     $courses = array();
545     if ($course->id == SITEID) {
546         $courses[0] = '';
547         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
548             foreach ($ccc as $cc) {
549                 $courses[$cc->id] = $cc->shortname;
550             }
551         }
552     } else {
553         $courses[$course->id] = $course->shortname;
554     }
556     $count=0;
557     $ldcache = array();
558     $tt = getdate(time());
559     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
561     $strftimedatetime = get_string("strftimedatetime");
563     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
564     $filename .= '.txt';
565     header("Content-Type: application/download\n");
566     header("Content-Disposition: attachment; filename=$filename");
567     header("Expires: 0");
568     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
569     header("Pragma: public");
571     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
572     echo $text;
574     if (empty($logs['logs'])) {
575         return true;
576     }
578     foreach ($logs['logs'] as $log) {
579         if (isset($ldcache[$log->module][$log->action])) {
580             $ld = $ldcache[$log->module][$log->action];
581         } else {
582             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
583             $ldcache[$log->module][$log->action] = $ld;
584         }
585         if ($ld && !empty($log->info)) {
586             // ugly hack to make sure fullname is shown correctly
587             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
588                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
589             } else {
590                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
591             }
592         }
594         //Filter log->info
595         $log->info = format_string($log->info);
596         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
598         $firstField = $courses[$log->course];
599         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
600         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
601         $text = implode("\t", $row);
602         echo $text." \n";
603     }
604     return true;
608 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
609                         $modid, $modaction, $groupid) {
611     global $CFG, $DB;
613     require_once("$CFG->libdir/excellib.class.php");
615     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
616                        $modname, $modid, $modaction, $groupid)) {
617         return false;
618     }
620     $courses = array();
622     if ($course->id == SITEID) {
623         $courses[0] = '';
624         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
625             foreach ($ccc as $cc) {
626                 $courses[$cc->id] = $cc->shortname;
627             }
628         }
629     } else {
630         $courses[$course->id] = $course->shortname;
631     }
633     $count=0;
634     $ldcache = array();
635     $tt = getdate(time());
636     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
638     $strftimedatetime = get_string("strftimedatetime");
640     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
641     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
642     $filename .= '.xls';
644     $workbook = new MoodleExcelWorkbook('-');
645     $workbook->send($filename);
647     $worksheet = array();
648     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
649                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
651     // Creating worksheets
652     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
653         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
654         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
655         $worksheet[$wsnumber]->set_column(1, 1, 30);
656         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
657                                     userdate(time(), $strftimedatetime));
658         $col = 0;
659         foreach ($headers as $item) {
660             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
661             $col++;
662         }
663     }
665     if (empty($logs['logs'])) {
666         $workbook->close();
667         return true;
668     }
670     $formatDate =& $workbook->add_format();
671     $formatDate->set_num_format(get_string('log_excel_date_format'));
673     $row = FIRSTUSEDEXCELROW;
674     $wsnumber = 1;
675     $myxls =& $worksheet[$wsnumber];
676     foreach ($logs['logs'] as $log) {
677         if (isset($ldcache[$log->module][$log->action])) {
678             $ld = $ldcache[$log->module][$log->action];
679         } else {
680             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
681             $ldcache[$log->module][$log->action] = $ld;
682         }
683         if ($ld && !empty($log->info)) {
684             // ugly hack to make sure fullname is shown correctly
685             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
686                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
687             } else {
688                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
689             }
690         }
692         // Filter log->info
693         $log->info = format_string($log->info);
694         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
696         if ($nroPages>1) {
697             if ($row > EXCELROWS) {
698                 $wsnumber++;
699                 $myxls =& $worksheet[$wsnumber];
700                 $row = FIRSTUSEDEXCELROW;
701             }
702         }
704         $myxls->write($row, 0, $courses[$log->course], '');
705         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
706         $myxls->write($row, 2, $log->ip, '');
707         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
708         $myxls->write($row, 3, $fullname, '');
709         $myxls->write($row, 4, $log->module.' '.$log->action, '');
710         $myxls->write($row, 5, $log->info, '');
712         $row++;
713     }
715     $workbook->close();
716     return true;
719 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
720                         $modid, $modaction, $groupid) {
722     global $CFG, $DB;
724     require_once("$CFG->libdir/odslib.class.php");
726     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
727                        $modname, $modid, $modaction, $groupid)) {
728         return false;
729     }
731     $courses = array();
733     if ($course->id == SITEID) {
734         $courses[0] = '';
735         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
736             foreach ($ccc as $cc) {
737                 $courses[$cc->id] = $cc->shortname;
738             }
739         }
740     } else {
741         $courses[$course->id] = $course->shortname;
742     }
744     $count=0;
745     $ldcache = array();
746     $tt = getdate(time());
747     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
749     $strftimedatetime = get_string("strftimedatetime");
751     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
752     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
753     $filename .= '.ods';
755     $workbook = new MoodleODSWorkbook('-');
756     $workbook->send($filename);
758     $worksheet = array();
759     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
760                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
762     // Creating worksheets
763     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
764         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
765         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
766         $worksheet[$wsnumber]->set_column(1, 1, 30);
767         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
768                                     userdate(time(), $strftimedatetime));
769         $col = 0;
770         foreach ($headers as $item) {
771             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
772             $col++;
773         }
774     }
776     if (empty($logs['logs'])) {
777         $workbook->close();
778         return true;
779     }
781     $formatDate =& $workbook->add_format();
782     $formatDate->set_num_format(get_string('log_excel_date_format'));
784     $row = FIRSTUSEDEXCELROW;
785     $wsnumber = 1;
786     $myxls =& $worksheet[$wsnumber];
787     foreach ($logs['logs'] as $log) {
788         if (isset($ldcache[$log->module][$log->action])) {
789             $ld = $ldcache[$log->module][$log->action];
790         } else {
791             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
792             $ldcache[$log->module][$log->action] = $ld;
793         }
794         if ($ld && !empty($log->info)) {
795             // ugly hack to make sure fullname is shown correctly
796             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
797                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
798             } else {
799                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
800             }
801         }
803         // Filter log->info
804         $log->info = format_string($log->info);
805         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
807         if ($nroPages>1) {
808             if ($row > EXCELROWS) {
809                 $wsnumber++;
810                 $myxls =& $worksheet[$wsnumber];
811                 $row = FIRSTUSEDEXCELROW;
812             }
813         }
815         $myxls->write_string($row, 0, $courses[$log->course]);
816         $myxls->write_date($row, 1, $log->time);
817         $myxls->write_string($row, 2, $log->ip);
818         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
819         $myxls->write_string($row, 3, $fullname);
820         $myxls->write_string($row, 4, $log->module.' '.$log->action);
821         $myxls->write_string($row, 5, $log->info);
823         $row++;
824     }
826     $workbook->close();
827     return true;
831 function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
832     global $CFG, $USER;
833     if (empty($CFG->gdversion)) {
834         echo "(".get_string("gdneed").")";
835     } else {
836         // MDL-10818, do not display broken graph when user has no permission to view graph
837         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
838             ($course->showreports and $USER->id == $userid)) {
839             echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
840                  '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
841         }
842     }
846 function print_overview($courses, array $remote_courses=array()) {
847     global $CFG, $USER, $DB, $OUTPUT;
849     $htmlarray = array();
850     if ($modules = $DB->get_records('modules')) {
851         foreach ($modules as $mod) {
852             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
853                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
854                 $fname = $mod->name.'_print_overview';
855                 if (function_exists($fname)) {
856                     $fname($courses,$htmlarray);
857                 }
858             }
859         }
860     }
861     foreach ($courses as $course) {
862         echo $OUTPUT->box_start('coursebox');
863         $attributes = array('title' => s($course->fullname));
864         if (empty($course->visible)) {
865             $attributes['class'] = 'dimmed';
866         }
867         echo $OUTPUT->heading(html_writer::link(
868             new moodle_url('/course/view.php', array('id' => $course->id)), format_string($course->fullname), $attributes), 3);
869         if (array_key_exists($course->id,$htmlarray)) {
870             foreach ($htmlarray[$course->id] as $modname => $html) {
871                 echo $html;
872             }
873         }
874         echo $OUTPUT->box_end();
875     }
877     if (!empty($remote_courses)) {
878         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
879     }
880     foreach ($remote_courses as $course) {
881         echo $OUTPUT->box_start('coursebox');
882         $attributes = array('title' => s($course->fullname));
883         echo $OUTPUT->heading(html_writer::link(
884             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
885             format_string($course->shortname),
886             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
887         echo $OUTPUT->box_end();
888     }
892 /**
893  * This function trawls through the logs looking for
894  * anything new since the user's last login
895  */
896 function print_recent_activity($course) {
897     // $course is an object
898     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
900     $context = get_context_instance(CONTEXT_COURSE, $course->id);
902     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
904     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
906     if (!isguestuser()) {
907         if (!empty($USER->lastcourseaccess[$course->id])) {
908             if ($USER->lastcourseaccess[$course->id] > $timestart) {
909                 $timestart = $USER->lastcourseaccess[$course->id];
910             }
911         }
912     }
914     echo '<div class="activitydate">';
915     echo get_string('activitysince', '', userdate($timestart));
916     echo '</div>';
917     echo '<div class="activityhead">';
919     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
921     echo "</div>\n";
923     $content = false;
925 /// Firstly, have there been any new enrolments?
927     $users = get_recent_enrolments($course->id, $timestart);
929     //Accessibility: new users now appear in an <OL> list.
930     if ($users) {
931         echo '<div class="newusers">';
932         echo $OUTPUT->heading(get_string("newusers").':', 3);
933         $content = true;
934         echo "<ol class=\"list\">\n";
935         foreach ($users as $user) {
936             $fullname = fullname($user, $viewfullnames);
937             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
938         }
939         echo "</ol>\n</div>\n";
940     }
942 /// Next, have there been any modifications to the course structure?
944     $modinfo =& get_fast_modinfo($course);
946     $changelist = array();
948     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
949                                             module = 'course' AND
950                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
951                                     array($timestart, $course->id), "id ASC");
953     if ($logs) {
954         $actions  = array('add mod', 'update mod', 'delete mod');
955         $newgones = array(); // added and later deleted items
956         foreach ($logs as $key => $log) {
957             if (!in_array($log->action, $actions)) {
958                 continue;
959             }
960             $info = explode(' ', $log->info);
962             if ($info[0] == 'label') {     // Labels are ignored in recent activity
963                 continue;
964             }
966             if (count($info) != 2) {
967                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
968                 continue;
969             }
971             $modname    = $info[0];
972             $instanceid = $info[1];
974             if ($log->action == 'delete mod') {
975                 // unfortunately we do not know if the mod was visible
976                 if (!array_key_exists($log->info, $newgones)) {
977                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
978                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
979                 }
980             } else {
981                 if (!isset($modinfo->instances[$modname][$instanceid])) {
982                     if ($log->action == 'add mod') {
983                         // do not display added and later deleted activities
984                         $newgones[$log->info] = true;
985                     }
986                     continue;
987                 }
988                 $cm = $modinfo->instances[$modname][$instanceid];
989                 if (!$cm->uservisible) {
990                     continue;
991                 }
993                 if ($log->action == 'add mod') {
994                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
995                     $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>");
997                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
998                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
999                     $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>");
1000                 }
1001             }
1002         }
1003     }
1005     if (!empty($changelist)) {
1006         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1007         $content = true;
1008         foreach ($changelist as $changeinfo => $change) {
1009             echo '<p class="activity">'.$change['text'].'</p>';
1010         }
1011     }
1013 /// Now display new things from each module
1015     $usedmodules = array();
1016     foreach($modinfo->cms as $cm) {
1017         if (isset($usedmodules[$cm->modname])) {
1018             continue;
1019         }
1020         if (!$cm->uservisible) {
1021             continue;
1022         }
1023         $usedmodules[$cm->modname] = $cm->modname;
1024     }
1026     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1027         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1028             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1029             $print_recent_activity = $modname.'_print_recent_activity';
1030             if (function_exists($print_recent_activity)) {
1031                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1032                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1033             }
1034         } else {
1035             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1036         }
1037     }
1039     if (! $content) {
1040         echo '<p class="message">'.get_string('nothingnew').'</p>';
1041     }
1044 /**
1045  * For a given course, returns an array of course activity objects
1046  * Each item in the array contains he following properties:
1047  */
1048 function get_array_of_activities($courseid) {
1049 //  cm - course module id
1050 //  mod - name of the module (eg forum)
1051 //  section - the number of the section (eg week or topic)
1052 //  name - the name of the instance
1053 //  visible - is the instance visible or not
1054 //  groupingid - grouping id
1055 //  groupmembersonly - is this instance visible to group members only
1056 //  extra - contains extra string to include in any link
1057     global $CFG, $DB;
1058     if(!empty($CFG->enableavailability)) {
1059         require_once($CFG->libdir.'/conditionlib.php');
1060     }
1062     $course = $DB->get_record('course', array('id'=>$courseid));
1064     if (empty($course)) {
1065         throw new moodle_exception('courseidnotfound');
1066     }
1068     $mod = array();
1070     $rawmods = get_course_mods($courseid);
1071     if (empty($rawmods)) {
1072         return $mod; // always return array
1073     }
1075     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1076        foreach ($sections as $section) {
1077            if (!empty($section->sequence)) {
1078                $sequence = explode(",", $section->sequence);
1079                foreach ($sequence as $seq) {
1080                    if (empty($rawmods[$seq])) {
1081                        continue;
1082                    }
1083                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1084                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1085                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1086                    $mod[$seq]->section          = $section->section;
1087                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1088                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1089                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1090                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1091                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1092                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1093                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1094                    $mod[$seq]->extra            = "";
1095                    if(!empty($CFG->enableavailability)) {
1096                        condition_info::fill_availability_conditions($rawmods[$seq]);
1097                        $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1098                        $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1099                        $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1100                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1101                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1102                    }
1104                    $modname = $mod[$seq]->mod;
1105                    $functionname = $modname."_get_coursemodule_info";
1107                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1108                        continue;
1109                    }
1111                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1113                    if (function_exists($functionname)) {
1114                        if ($info = $functionname($rawmods[$seq])) {
1115                            if (!empty($info->extra)) {
1116                                $mod[$seq]->extra = $info->extra;
1117                            }
1118                            if (!empty($info->icon)) {
1119                                $mod[$seq]->icon = $info->icon;
1120                            }
1121                            if (!empty($info->iconcomponent)) {
1122                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1123                            }
1124                            if (!empty($info->name)) {
1125                                $mod[$seq]->name = $info->name;
1126                            }
1127                        }
1128                    }
1129                    if (!isset($mod[$seq]->name)) {
1130                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1131                    }
1132                }
1133             }
1134         }
1135     }
1136     return $mod;
1140 /**
1141  * Returns a number of useful structures for course displays
1142  */
1143 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1144     global $CFG, $DB, $COURSE;
1146     $mods          = array();    // course modules indexed by id
1147     $modnames      = array();    // all course module names (except resource!)
1148     $modnamesplural= array();    // all course module names (plural form)
1149     $modnamesused  = array();    // course module names used
1151     if ($allmods = $DB->get_records("modules")) {
1152         foreach ($allmods as $mod) {
1153             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1154                 continue;
1155             }
1156             if ($mod->visible) {
1157                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1158                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1159             }
1160         }
1161         textlib_get_instance()->asort($modnames);
1162     } else {
1163         print_error("nomodules", 'debug');
1164     }
1166     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1167     $modinfo = get_fast_modinfo($course);
1169     if ($rawmods=$modinfo->cms) {
1170         foreach($rawmods as $mod) {    // Index the mods
1171             if (empty($modnames[$mod->modname])) {
1172                 continue;
1173             }
1174             $mods[$mod->id] = $mod;
1175             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1176             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1177                 continue;
1178             }
1179             // Check groupings
1180             if (!groups_course_module_visible($mod)) {
1181                 continue;
1182             }
1183             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1184         }
1185         if ($modnamesused) {
1186             textlib_get_instance()->asort($modnamesused);
1187         }
1188     }
1191 /**
1192  * Returns an array of sections for the requested course id
1193  *
1194  * This function stores the sections against the course id within a staticvar encase
1195  * of subsequent requests. This is used all over + in some standard libs and course
1196  * format callbacks so subsequent requests are a reality.
1197  *
1198  * @staticvar array $coursesections
1199  * @param int $courseid
1200  * @return array Array of sections
1201  */
1202 function get_all_sections($courseid) {
1203     global $DB;
1204     static $coursesections = array();
1205     if (!array_key_exists($courseid, $coursesections)) {
1206         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1207                            "section, id, course, name, summary, summaryformat, sequence, visible");
1208     }
1209     return $coursesections[$courseid];
1212 function course_set_display($courseid, $display=0) {
1213     global $USER, $DB;
1215     if ($display == "all" or empty($display)) {
1216         $display = 0;
1217     }
1219     if (!isloggedin() or isguestuser()) {
1220         //do not store settings in db for guests
1221     } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
1222         $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
1223     } else {
1224         $record = new stdClass();
1225         $record->userid = $USER->id;
1226         $record->course = $courseid;
1227         $record->display = $display;
1228         $DB->insert_record("course_display", $record);
1229     }
1231     return $USER->display[$courseid] = $display;  // Note: = not ==
1234 /**
1235  * For a given course section, marks it visible or hidden,
1236  * and does the same for every activity in that section
1237  */
1238 function set_section_visible($courseid, $sectionnumber, $visibility) {
1239     global $DB;
1241     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1242         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1243         if (!empty($section->sequence)) {
1244             $modules = explode(",", $section->sequence);
1245             foreach ($modules as $moduleid) {
1246                 set_coursemodule_visible($moduleid, $visibility, true);
1247             }
1248         }
1249         rebuild_course_cache($courseid);
1250     }
1253 /**
1254  * Prints a section full of activity modules
1255  */
1256 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1257     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1259     static $initialised;
1261     static $groupbuttons;
1262     static $groupbuttonslink;
1263     static $isediting;
1264     static $ismoving;
1265     static $strmovehere;
1266     static $strmovefull;
1267     static $strunreadpostsone;
1268     static $usetracking;
1269     static $groupings;
1271     if (!isset($initialised)) {
1272         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1273         $groupbuttonslink = (!$course->groupmodeforce);
1274         $isediting        = $PAGE->user_is_editing();
1275         $ismoving         = $isediting && ismoving($course->id);
1276         if ($ismoving) {
1277             $strmovehere  = get_string("movehere");
1278             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1279         }
1280         include_once($CFG->dirroot.'/mod/forum/lib.php');
1281         if ($usetracking = forum_tp_can_track_forums()) {
1282             $strunreadpostsone = get_string('unreadpostsone', 'forum');
1283         }
1284         $initialised = true;
1285     }
1287     $labelformatoptions = new stdClass();
1288     $labelformatoptions->noclean = true;
1289     $labelformatoptions->overflowdiv = true;
1291 /// Casting $course->modinfo to string prevents one notice when the field is null
1292     $modinfo = get_fast_modinfo($course);
1293     $completioninfo = new completion_info($course);
1295     //Accessibility: replace table with list <ul>, but don't output empty list.
1296     if (!empty($section->sequence)) {
1298         // Fix bug #5027, don't want style=\"width:$width\".
1299         echo "<ul class=\"section img-text\">\n";
1300         $sectionmods = explode(",", $section->sequence);
1302         foreach ($sectionmods as $modnumber) {
1303             if (empty($mods[$modnumber])) {
1304                 continue;
1305             }
1307             $mod = $mods[$modnumber];
1309             if ($ismoving and $mod->id == $USER->activitycopy) {
1310                 // do not display moving mod
1311                 continue;
1312             }
1314             if (isset($modinfo->cms[$modnumber])) {
1315                 // We can continue (because it will not be displayed at all)
1316                 // if:
1317                 // 1) The activity is not visible to users
1318                 // and
1319                 // 2a) The 'showavailability' option is not set (if that is set,
1320                 //     we need to display the activity so we can show
1321                 //     availability info)
1322                 // or
1323                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1324                 //     hidden in a way that leaves no info, such as using the
1325                 //     eye icon.
1326                 if (!$modinfo->cms[$modnumber]->uservisible &&
1327                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1328                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1329                     // visibility shortcut
1330                     continue;
1331                 }
1332             } else {
1333                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1334                     // module not installed
1335                     continue;
1336                 }
1337                 if (!coursemodule_visible_for_user($mod) &&
1338                     empty($mod->showavailability)) {
1339                     // full visibility check
1340                     continue;
1341                 }
1342             }
1344             // In some cases the activity is visible to user, but it is
1345             // dimmed. This is done if viewhiddenactivities is true and if:
1346             // 1. the activity is not visible, or
1347             // 2. the activity has dates set which do not include current, or
1348             // 3. the activity has any other conditions set (regardless of whether
1349             //    current user meets them)
1350             $canviewhidden = has_capability(
1351                 'moodle/course:viewhiddenactivities',
1352                 get_context_instance(CONTEXT_MODULE, $mod->id));
1353             $accessiblebutdim = false;
1354             if ($canviewhidden) {
1355                 $accessiblebutdim = !$mod->visible;
1356                 if (!empty($CFG->enableavailability)) {
1357                     $accessiblebutdim = $accessiblebutdim ||
1358                         $mod->availablefrom > time() ||
1359                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1360                         count($mod->conditionsgrade) > 0 ||
1361                         count($mod->conditionscompletion) > 0;
1362                 }
1363             }
1365             $liclasses = array();
1366             $liclasses[] = 'activity';
1367             $liclasses[] = $mod->modname;
1368             $liclasses[] = 'modtype_'.$mod->modname;
1369             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1370             if ($ismoving) {
1371                 echo '<a title="'.$strmovefull.'"'.
1372                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1373                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1374                      ' alt="'.$strmovehere.'" /></a><br />
1375                      ';
1376             }
1378             $classes = array('mod-indent');
1379             if (!empty($mod->indent)) {
1380                 $classes[] = 'mod-indent-'.$mod->indent;
1381                 if ($mod->indent > 15) {
1382                     $classes[] = 'mod-indent-huge';
1383                 }
1384             }
1385             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1387             $extra = '';
1388             if (!empty($modinfo->cms[$modnumber]->extra)) {
1389                 $extra = $modinfo->cms[$modnumber]->extra;
1390             }
1392             if ($mod->modname == "label") {
1393                 if ($accessiblebutdim || !$mod->uservisible) {
1394                     echo '<div class="dimmed_text"><span class="accesshide">'.
1395                         get_string('hiddenfromstudents').'</span>';
1396                 } else {
1397                     echo '<div>';
1398                 }
1399                 echo format_text($extra, FORMAT_HTML, $labelformatoptions);
1400                 echo "</div>";
1401                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1402                     if (!isset($groupings)) {
1403                         $groupings = groups_get_all_groupings($course->id);
1404                     }
1405                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1406                 }
1408             } else { // Normal activity
1409                 $instancename = format_string($modinfo->cms[$modnumber]->name, true,  $course->id);
1411                 $customicon = $modinfo->cms[$modnumber]->icon;
1412                 if (!empty($customicon)) {
1413                     if (substr($customicon, 0, 4) === 'mod/') {
1414                         list($modname, $iconname) = explode('/', substr($customicon, 4), 2);
1415                         $icon = $OUTPUT->pix_url($iconname, $modname);
1416                     } else {
1417                         $icon = $OUTPUT->pix_url($customicon);
1418                     }
1419                 } else {
1420                     $icon = $OUTPUT->pix_url('icon', $mod->modname);
1421                 }
1423                 //Accessibility: for files get description via icon, this is very ugly hack!
1424                 $altname = '';
1425                 $altname = $mod->modfullname;
1426                 if (!empty($customicon)) {
1427                     $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1428                     if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1429                         $mimetype = mimeinfo_from_icon('type', $customicon);
1430                         $altname = get_mimetype_description($mimetype);
1431                     }
1432                 }
1433                 // Avoid unnecessary duplication.
1434                 if (false !== stripos($instancename, $altname)) {
1435                     $altname = '';
1436                 }
1437                 // File type after name, for alphabetic lists (screen reader).
1438                 if ($altname) {
1439                     $altname = get_accesshide(' '.$altname);
1440                 }
1442                 // We may be displaying this just in order to show information
1443                 // about visibility, without the actual link
1444                 if ($mod->uservisible) {
1445                     // Display normal module link
1446                     if (!$accessiblebutdim) {
1447                         $linkcss = '';
1448                         $accesstext  ='';
1449                     } else {
1450                         $linkcss = ' class="dimmed" ';
1451                         $accesstext = '<span class="accesshide">'.
1452                             get_string('hiddenfromstudents').': </span>';
1453                     }
1455                     echo '<a '.$linkcss.' '.$extra.
1456                          ' href="'.$CFG->wwwroot.'/mod/'.$mod->modname.'/view.php?id='.$mod->id.'">'.
1457                          '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename',$mod->modname).'" /> '.
1458                          $accesstext.'<span class="instancename">'.$instancename.$altname.'</span></a>';
1460                     if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1461                         if (!isset($groupings)) {
1462                             $groupings = groups_get_all_groupings($course->id);
1463                         }
1464                         echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1465                     }
1466                 } else {
1467                     // Display greyed-out text of link
1468                     echo '<span class="dimmed_text" '.$extra.' ><span class="accesshide">'.
1469                         get_string('notavailableyet','condition').': </span>'.
1470                         '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename', $mod->modname).'" /> <span>'.
1471                         $instancename.$altname.'</span></span>';
1472                 }
1473             }
1474             if ($usetracking && $mod->modname == 'forum') {
1475                 if ($unread = forum_tp_count_forum_unread_posts($mod, $course)) {
1476                     echo '<span class="unread"> <a href="'.$CFG->wwwroot.'/mod/forum/view.php?id='.$mod->id.'">';
1477                     if ($unread == 1) {
1478                         echo $strunreadpostsone;
1479                     } else {
1480                         print_string('unreadpostsnumber', 'forum', $unread);
1481                     }
1482                     echo '</a></span>';
1483                 }
1484             }
1486             if ($isediting) {
1487                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1488                     if (! $mod->groupmodelink = $groupbuttonslink) {
1489                         $mod->groupmode = $course->groupmode;
1490                     }
1492                 } else {
1493                     $mod->groupmode = false;
1494                 }
1495                 echo '&nbsp;&nbsp;';
1496                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1497             }
1499             // Completion
1500             $completion = $hidecompletion
1501                 ? COMPLETION_TRACKING_NONE
1502                 : $completioninfo->is_enabled($mod);
1503             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1504                 !isguestuser() && $mod->uservisible) {
1505                 $completiondata = $completioninfo->get_data($mod,true);
1506                 $completionicon = '';
1507                 if ($isediting) {
1508                     switch ($completion) {
1509                         case COMPLETION_TRACKING_MANUAL :
1510                             $completionicon = 'manual-enabled'; break;
1511                         case COMPLETION_TRACKING_AUTOMATIC :
1512                             $completionicon = 'auto-enabled'; break;
1513                         default: // wtf
1514                     }
1515                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1516                     switch($completiondata->completionstate) {
1517                         case COMPLETION_INCOMPLETE:
1518                             $completionicon = 'manual-n'; break;
1519                         case COMPLETION_COMPLETE:
1520                             $completionicon = 'manual-y'; break;
1521                     }
1522                 } else { // Automatic
1523                     switch($completiondata->completionstate) {
1524                         case COMPLETION_INCOMPLETE:
1525                             $completionicon = 'auto-n'; break;
1526                         case COMPLETION_COMPLETE:
1527                             $completionicon = 'auto-y'; break;
1528                         case COMPLETION_COMPLETE_PASS:
1529                             $completionicon = 'auto-pass'; break;
1530                         case COMPLETION_COMPLETE_FAIL:
1531                             $completionicon = 'auto-fail'; break;
1532                     }
1533                 }
1534                 if ($completionicon) {
1535                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1536                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1537                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1538                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1539                         $newstate =
1540                             $completiondata->completionstate==COMPLETION_COMPLETE
1541                             ? COMPLETION_INCOMPLETE
1542                             : COMPLETION_COMPLETE;
1543                         // In manual mode the icon is a toggle form...
1545                         // If this completion state is used by the
1546                         // conditional activities system, we need to turn
1547                         // off the JS.
1548                         if (!empty($CFG->enableavailability) &&
1549                             condition_info::completion_value_used_as_condition($course, $mod)) {
1550                             $extraclass = ' preventjs';
1551                         } else {
1552                             $extraclass = '';
1553                         }
1554                         echo "
1555 <form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>
1556 <input type='hidden' name='id' value='{$mod->id}' />
1557 <input type='hidden' name='sesskey' value='".sesskey()."' />
1558 <input type='hidden' name='completionstate' value='$newstate' />
1559 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1560 </div></form>";
1561                     } else {
1562                         // In auto mode, or when editing, the icon is just an image
1563                         echo "<span class='autocompletion'>";
1564                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1565                     }
1566                 }
1567             }
1569             // Show availability information (for someone who isn't allowed to
1570             // see the activity itself, or for staff)
1571             if (!$mod->uservisible) {
1572                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1573             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1574                 $ci = new condition_info($mod);
1575                 $fullinfo = $ci->get_full_information();
1576                 if($fullinfo) {
1577                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1578                         ? 'userrestriction_visible'
1579                         : 'userrestriction_hidden','condition',
1580                         $fullinfo).'</div>';
1581                 }
1582             }
1584             echo html_writer::end_tag('div');
1585             echo html_writer::end_tag('li')."\n";
1586         }
1588     } elseif ($ismoving) {
1589         echo "<ul class=\"section\">\n";
1590     }
1592     if ($ismoving) {
1593         echo '<li><a title="'.$strmovefull.'"'.
1594              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1595              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1596              ' alt="'.$strmovehere.'" /></a></li>
1597              ';
1598     }
1599     if (!empty($section->sequence) || $ismoving) {
1600         echo "</ul><!--class='section'-->\n\n";
1601     }
1604 /**
1605  * Prints the menus to add activities and resources.
1606  */
1607 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1608     global $CFG, $OUTPUT;
1610     // check to see if user can add menus
1611     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1612         return false;
1613     }
1615     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1617     $resources = array();
1618     $activities = array();
1620     foreach($modnames as $modname=>$modnamestr) {
1621         if (!course_allowed_module($course, $modname)) {
1622             continue;
1623         }
1625         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1626         if (!file_exists($libfile)) {
1627             continue;
1628         }
1629         include_once($libfile);
1630         $gettypesfunc =  $modname.'_get_types';
1631         if (function_exists($gettypesfunc)) {
1632             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1633             if ($types = $gettypesfunc()) {
1634                 $menu = array();
1635                 $atype = null;
1636                 $groupname = null;
1637                 foreach($types as $type) {
1638                     if ($type->typestr === '--') {
1639                         continue;
1640                     }
1641                     if (strpos($type->typestr, '--') === 0) {
1642                         $groupname = str_replace('--', '', $type->typestr);
1643                         continue;
1644                     }
1645                     $type->type = str_replace('&amp;', '&', $type->type);
1646                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1647                         $atype = MOD_CLASS_RESOURCE;
1648                     }
1649                     $menu[$urlbase.$type->type] = $type->typestr;
1650                 }
1651                 if (!is_null($groupname)) {
1652                     if ($atype == MOD_CLASS_RESOURCE) {
1653                         $resources[] = array($groupname=>$menu);
1654                     } else {
1655                         $activities[] = array($groupname=>$menu);
1656                     }
1657                 } else {
1658                     if ($atype == MOD_CLASS_RESOURCE) {
1659                         $resources = array_merge($resources, $menu);
1660                     } else {
1661                         $activities = array_merge($activities, $menu);
1662                     }
1663                 }
1664             }
1665         } else {
1666             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1667             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1668                 $resources[$urlbase.$modname] = $modnamestr;
1669             } else {
1670                 // all other archetypes are considered activity
1671                 $activities[$urlbase.$modname] = $modnamestr;
1672             }
1673         }
1674     }
1676     $straddactivity = get_string('addactivity');
1677     $straddresource = get_string('addresource');
1679     $output  = '<div class="section_add_menus">';
1681     if (!$vertical) {
1682         $output .= '<div class="horizontal">';
1683     }
1685     if (!empty($resources)) {
1686         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1687         $select->set_help_icon('resources');
1688         $output .= $OUTPUT->render($select);
1689     }
1691     if (!empty($activities)) {
1692         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1693         $select->set_help_icon('activities');
1694         $output .= $OUTPUT->render($select);
1695     }
1697     if (!$vertical) {
1698         $output .= '</div>';
1699     }
1701     $output .= '</div>';
1703     if ($return) {
1704         return $output;
1705     } else {
1706         echo $output;
1707     }
1710 /**
1711  * Return the course category context for the category with id $categoryid, except
1712  * that if $categoryid is 0, return the system context.
1713  *
1714  * @param integer $categoryid a category id or 0.
1715  * @return object the corresponding context
1716  */
1717 function get_category_or_system_context($categoryid) {
1718     if ($categoryid) {
1719         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1720     } else {
1721         return get_context_instance(CONTEXT_SYSTEM);
1722     }
1725 /**
1726  * Rebuilds the cached list of course activities stored in the database
1727  * @param int $courseid - id of course to rebuild, empty means all
1728  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1729  */
1730 function rebuild_course_cache($courseid=0, $clearonly=false) {
1731     global $COURSE, $DB, $OUTPUT;
1733     // Destroy navigation caches
1734     navigation_cache::destroy_volatile_caches();
1736     if ($clearonly) {
1737         if (empty($courseid)) {
1738             $courseselect = array();
1739         } else {
1740             $courseselect = array('id'=>$courseid);
1741         }
1742         $DB->set_field('course', 'modinfo', null, $courseselect);
1743         // update cached global COURSE too ;-)
1744         if ($courseid == $COURSE->id or empty($courseid)) {
1745             $COURSE->modinfo = null;
1746         }
1747         // reset the fast modinfo cache
1748         $reset = 'reset';
1749         get_fast_modinfo($reset);
1750         return;
1751     }
1753     if ($courseid) {
1754         $select = array('id'=>$courseid);
1755     } else {
1756         $select = array();
1757         @set_time_limit(0);  // this could take a while!   MDL-10954
1758     }
1760     if ($rs = $DB->get_recordset("course", $select,'','id,fullname')) {
1761         foreach ($rs as $course) {
1762             $modinfo = serialize(get_array_of_activities($course->id));
1763             $DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id));
1764             // update cached global COURSE too ;-)
1765             if ($course->id == $COURSE->id) {
1766                 $COURSE->modinfo = $modinfo;
1767             }
1768         }
1769         $rs->close();
1770     }
1771     // reset the fast modinfo cache
1772     $reset = 'reset';
1773     get_fast_modinfo($reset);
1776 /**
1777  * Gets the child categories of a given courses category. Uses a static cache
1778  * to make repeat calls efficient.
1779  *
1780  * @param int $parentid the id of a course category.
1781  * @return array all the child course categories.
1782  */
1783 function get_child_categories($parentid) {
1784     static $allcategories = null;
1786     // only fill in this variable the first time
1787     if (null == $allcategories) {
1788         $allcategories = array();
1790         $categories = get_categories();
1791         foreach ($categories as $category) {
1792             if (empty($allcategories[$category->parent])) {
1793                 $allcategories[$category->parent] = array();
1794             }
1795             $allcategories[$category->parent][] = $category;
1796         }
1797     }
1799     if (empty($allcategories[$parentid])) {
1800         return array();
1801     } else {
1802         return $allcategories[$parentid];
1803     }
1806 /**
1807  * This function recursively travels the categories, building up a nice list
1808  * for display. It also makes an array that list all the parents for each
1809  * category.
1810  *
1811  * For example, if you have a tree of categories like:
1812  *   Miscellaneous (id = 1)
1813  *      Subcategory (id = 2)
1814  *         Sub-subcategory (id = 4)
1815  *   Other category (id = 3)
1816  * Then after calling this function you will have
1817  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1818  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1819  *      3 => 'Other category');
1820  * $parents = array(2 => array(1), 4 => array(1, 2));
1821  *
1822  * If you specify $requiredcapability, then only categories where the current
1823  * user has that capability will be added to $list, although all categories
1824  * will still be added to $parents, and if you only have $requiredcapability
1825  * in a child category, not the parent, then the child catgegory will still be
1826  * included.
1827  *
1828  * If you specify the option $excluded, then that category, and all its children,
1829  * are omitted from the tree. This is useful when you are doing something like
1830  * moving categories, where you do not want to allow people to move a category
1831  * to be the child of itself.
1832  *
1833  * @param array $list For output, accumulates an array categoryid => full category path name
1834  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1835  * @param string/array $requiredcapability if given, only categories where the current
1836  *      user has this capability will be added to $list. Can also be an array of capabilities,
1837  *      in which case they are all required.
1838  * @param integer $excludeid Omit this category and its children from the lists built.
1839  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1840  * @param string $path For internal use, as part of recursive calls.
1841  */
1842 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1843         $excludeid = 0, $category = NULL, $path = "") {
1845     // initialize the arrays if needed
1846     if (!is_array($list)) {
1847         $list = array();
1848     }
1849     if (!is_array($parents)) {
1850         $parents = array();
1851     }
1853     if (empty($category)) {
1854         // Start at the top level.
1855         $category = new stdClass;
1856         $category->id = 0;
1857     } else {
1858         // This is the excluded category, don't include it.
1859         if ($excludeid > 0 && $excludeid == $category->id) {
1860             return;
1861         }
1863         // Update $path.
1864         if ($path) {
1865             $path = $path.' / '.format_string($category->name);
1866         } else {
1867             $path = format_string($category->name);
1868         }
1870         // Add this category to $list, if the permissions check out.
1871         if (empty($requiredcapability)) {
1872             $list[$category->id] = $path;
1874         } else {
1875             ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1876             $requiredcapability = (array)$requiredcapability;
1877             if (has_all_capabilities($requiredcapability, $category->context)) {
1878                 $list[$category->id] = $path;
1879             }
1880         }
1881     }
1883     // Add all the children recursively, while updating the parents array.
1884     if ($categories = get_child_categories($category->id)) {
1885         foreach ($categories as $cat) {
1886             if (!empty($category->id)) {
1887                 if (isset($parents[$category->id])) {
1888                     $parents[$cat->id]   = $parents[$category->id];
1889                 }
1890                 $parents[$cat->id][] = $category->id;
1891             }
1892             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1893         }
1894     }
1897 /**
1898  * This function generates a structured array of courses and categories.
1899  *
1900  * The depth of categories is limited by $CFG->maxcategorydepth however there
1901  * is no limit on the number of courses!
1902  *
1903  * Suitable for use with the course renderers course_category_tree method:
1904  * $renderer = $PAGE->get_renderer('core','course');
1905  * echo $renderer->course_category_tree(get_course_category_tree());
1906  *
1907  * @global moodle_database $DB
1908  * @param int $id
1909  * @param int $depth
1910  */
1911 function get_course_category_tree($id = 0, $depth = 0) {
1912     global $DB, $CFG;
1913     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
1914     $categories = get_child_categories($id);
1915     $categoryids = array();
1916     foreach ($categories as $key => &$category) {
1917         if (!$category->visible && !$viewhiddencats) {
1918             unset($categories[$key]);
1919             continue;
1920         }
1921         $categoryids[$category->id] = $category;
1922         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1923             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1924             foreach ($subcategories as $subid=>$subcat) {
1925                 $categoryids[$subid] = $subcat;
1926             }
1927             $category->courses = array();
1928         }
1929     }
1931     if ($depth > 0) {
1932         // This is a recursive call so return the required array
1933         return array($categories, $categoryids);
1934     }
1936     // The depth is 0 this function has just been called so we can finish it off
1938     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1939     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1940     $sql = "SELECT
1941             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1942             $ccselect
1943             FROM {course} c
1944             $ccjoin
1945             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1946     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1947         // loop throught them
1948         foreach ($courses as $course) {
1949             if ($course->id == SITEID) {
1950                 continue;
1951             }
1952             context_instance_preload($course);
1953             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1954                 $categoryids[$course->category]->courses[$course->id] = $course;
1955             }
1956         }
1957     }
1958     return $categories;
1961 /**
1962  * Recursive function to print out all the categories in a nice format
1963  * with or without courses included
1964  */
1965 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
1966     global $CFG;
1968     // maxcategorydepth == 0 meant no limit
1969     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1970         return;
1971     }
1973     if (!$displaylist) {
1974         make_categories_list($displaylist, $parentslist);
1975     }
1977     if ($category) {
1978         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
1979             print_category_info($category, $depth, $showcourses);
1980         } else {
1981             return;  // Don't bother printing children of invisible categories
1982         }
1984     } else {
1985         $category->id = "0";
1986     }
1988     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
1989         $countcats = count($categories);
1990         $count = 0;
1991         $first = true;
1992         $last = false;
1993         foreach ($categories as $cat) {
1994             $count++;
1995             if ($count == $countcats) {
1996                 $last = true;
1997             }
1998             $up = $first ? false : true;
1999             $down = $last ? false : true;
2000             $first = false;
2002             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2003         }
2004     }
2007 /**
2008  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2009  */
2010 function make_categories_options() {
2011     make_categories_list($cats,$parents);
2012     foreach ($cats as $key => $value) {
2013         if (array_key_exists($key,$parents)) {
2014             if ($indent = count($parents[$key])) {
2015                 for ($i = 0; $i < $indent; $i++) {
2016                     $cats[$key] = '&nbsp;'.$cats[$key];
2017                 }
2018             }
2019         }
2020     }
2021     return $cats;
2024 /**
2025  * Prints the category info in indented fashion
2026  * This function is only used by print_whole_category_list() above
2027  */
2028 function print_category_info($category, $depth=0, $showcourses = false) {
2029     global $CFG, $DB, $OUTPUT;
2031     $strsummary = get_string('summary');
2033     $catlinkcss = null;
2034     if (!$category->visible) {
2035         $catlinkcss = array('class'=>'dimmed');
2036     }
2037     static $coursecount = null;
2038     if (null === $coursecount) {
2039         // only need to check this once
2040         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2041     }
2043     if ($showcourses and $coursecount) {
2044         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2045     } else {
2046         $catimage = "&nbsp;";
2047     }
2049     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2050     if ($showcourses and $coursecount) {
2051         echo '<div class="categorylist clearfix">';
2052         $cat = '';
2053         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2054         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2055         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2057         $html = '';
2058         if ($depth > 0) {
2059             for ($i=0; $i< $depth; $i++) {
2060                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2061                 $cat = '';
2062             }
2063         } else {
2064             $html = $cat;
2065         }
2066         echo html_writer::tag('div', $html, array('class'=>'category'));
2067         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2069         // does the depth exceed maxcategorydepth
2070         // maxcategorydepth == 0 or unset meant no limit
2071         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2072         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2073             foreach ($courses as $course) {
2074                 $linkcss = null;
2075                 if (!$course->visible) {
2076                     $linkcss = array('class'=>'dimmed');
2077                 }
2079                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2081                 // print enrol info
2082                 $courseicon = '';
2083                 if ($icons = enrol_get_course_info_icons($course)) {
2084                     foreach ($icons as $pix_icon) {
2085                         $courseicon = $OUTPUT->render($pix_icon).' ';
2086                     }
2087                 }
2089                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2091                 if ($course->summary) {
2092                     $link = new moodle_url('/course/info.php?id='.$course->id);
2093                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2094                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2095                         array('title'=>$strsummary));
2097                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2098                 }
2100                 $html = '';
2101                 for ($i=0; $i <= $depth; $i++) {
2102                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2103                     $coursecontent = '';
2104                 }
2105                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2106             }
2107         }
2108         echo '</div>';
2109     } else {
2110         echo '<div class="categorylist">';
2111         $html = '';
2112         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2113         $cat .= html_writer::tag('span', '('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2115         if ($depth > 0) {
2116             for ($i=0; $i< $depth; $i++) {
2117                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2118                 $cat = '';
2119             }
2120         } else {
2121             $html = $cat;
2122         }
2124         echo html_writer::tag('div', $html, array('class'=>'category'));
2125         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2126         echo '</div>';
2127     }
2130 /**
2131  * Print the buttons relating to course requests.
2132  *
2133  * @param object $systemcontext the system context.
2134  */
2135 function print_course_request_buttons($systemcontext) {
2136     global $CFG, $DB, $OUTPUT;
2137     if (empty($CFG->enablecourserequests)) {
2138         return;
2139     }
2140     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2141     /// Print a button to request a new course
2142         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2143     }
2144     /// Print a button to manage pending requests
2145     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2146         $disabled = !$DB->record_exists('course_request', array());
2147         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2148     }
2151 /**
2152  * Does the user have permission to edit things in this category?
2153  *
2154  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2155  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2156  */
2157 function can_edit_in_category($categoryid = 0) {
2158     $context = get_category_or_system_context($categoryid);
2159     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2162 /**
2163  * Prints the turn editing on/off button on course/index.php or course/category.php.
2164  *
2165  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2166  * @return string HTML of the editing button, or empty string, if this user is not allowed
2167  *      to see it.
2168  */
2169 function update_category_button($categoryid = 0) {
2170     global $CFG, $PAGE, $OUTPUT;
2172     // Check permissions.
2173     if (!can_edit_in_category($categoryid)) {
2174         return '';
2175     }
2177     // Work out the appropriate action.
2178     if ($PAGE->user_is_editing()) {
2179         $label = get_string('turneditingoff');
2180         $edit = 'off';
2181     } else {
2182         $label = get_string('turneditingon');
2183         $edit = 'on';
2184     }
2186     // Generate the button HTML.
2187     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2188     if ($categoryid) {
2189         $options['id'] = $categoryid;
2190         $page = 'category.php';
2191     } else {
2192         $page = 'index.php';
2193     }
2194     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2197 /**
2198  * Category is 0 (for all courses) or an object
2199  */
2200 function print_courses($category) {
2201     global $CFG, $OUTPUT;
2203     if (!is_object($category) && $category==0) {
2204         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2205         if (is_array($categories) && count($categories) == 1) {
2206             $category   = array_shift($categories);
2207             $courses    = get_courses_wmanagers($category->id,
2208                                                 'c.sortorder ASC',
2209                                                 array('summary','summaryformat'));
2210         } else {
2211             $courses    = get_courses_wmanagers('all',
2212                                                 'c.sortorder ASC',
2213                                                 array('summary','summaryformat'));
2214         }
2215         unset($categories);
2216     } else {
2217         $courses    = get_courses_wmanagers($category->id,
2218                                             'c.sortorder ASC',
2219                                             array('summary','summaryformat'));
2220     }
2222     if ($courses) {
2223         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2224         foreach ($courses as $course) {
2225             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2226             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2227                 echo html_writer::start_tag('li');
2228                 print_course($course);
2229                 echo html_writer::end_tag('li');
2230             }
2231         }
2232         echo html_writer::end_tag('ul');
2233     } else {
2234         echo $OUTPUT->heading(get_string("nocoursesyet"));
2235         $context = get_context_instance(CONTEXT_SYSTEM);
2236         if (has_capability('moodle/course:create', $context)) {
2237             $options = array();
2238             if (!empty($category->id)) {
2239                 $options['category'] = $category->id;
2240             } else {
2241                 $options['category'] = $CFG->defaultrequestcategory;
2242             }
2243             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2244             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2245             echo html_writer::end_tag('div');
2246         }
2247     }
2250 /**
2251  * Print a description of a course, suitable for browsing in a list.
2252  *
2253  * @param object $course the course object.
2254  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2255  */
2256 function print_course($course, $highlightterms = '') {
2257     global $CFG, $USER, $DB, $OUTPUT;
2259     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2261     // Rewrite file URLs so that they are correct
2262     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2264     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2265     echo html_writer::start_tag('div', array('class'=>'info'));
2266     echo html_writer::start_tag('h3', array('class'=>'name'));
2268     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2269     $linktext = highlight($highlightterms, format_string($course->fullname));
2270     $linkparams = array('title'=>get_string('entercourse'));
2271     if (empty($course->visible)) {
2272         $linkparams['class'] = 'dimmed';
2273     }
2274     echo html_writer::link($linkhref, $linktext, $linkparams);
2275     echo html_writer::end_tag('h3');
2277     /// first find all roles that are supposed to be displayed
2278     if (!empty($CFG->coursecontact)) {
2279         $managerroles = explode(',', $CFG->coursecontact);
2280         $namesarray = array();
2281         if (isset($course->managers)) {
2282             if (count($course->managers)) {
2283                 $rusers = $course->managers;
2284                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2286                  /// Rename some of the role names if needed
2287                 if (isset($context)) {
2288                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2289                 }
2291                 // keep a note of users displayed to eliminate duplicates
2292                 $usersshown = array();
2293                 foreach ($rusers as $ra) {
2295                     // if we've already displayed user don't again
2296                     if (in_array($ra->user->id,$usersshown)) {
2297                         continue;
2298                     }
2299                     $usersshown[] = $ra->user->id;
2301                     $fullname = fullname($ra->user, $canviewfullnames);
2303                     if (isset($aliasnames[$ra->roleid])) {
2304                         $ra->rolename = $aliasnames[$ra->roleid]->name;
2305                     }
2307                     $namesarray[] = format_string($ra->rolename).': '.
2308                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
2309                 }
2310             }
2311         } else {
2312             $rusers = get_role_users($managerroles, $context,
2313                                      true, '', 'r.sortorder ASC, u.lastname ASC');
2314             if (is_array($rusers) && count($rusers)) {
2315                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2317                 /// Rename some of the role names if needed
2318                 if (isset($context)) {
2319                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2320                 }
2322                 foreach ($rusers as $teacher) {
2323                     $fullname = fullname($teacher, $canviewfullnames);
2325                     /// Apply role names
2326                     if (isset($aliasnames[$teacher->roleid])) {
2327                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2328                     }
2330                     $namesarray[] = format_string($teacher->rolename).': '.
2331                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
2332                 }
2333             }
2334         }
2336         if (!empty($namesarray)) {
2337             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2338             foreach ($namesarray as $name) {
2339                 echo html_writer::tag('li', $name);
2340             }
2341             echo html_writer::end_tag('ul');
2342         }
2343     }
2344     echo html_writer::end_tag('div'); // End of info div
2346     echo html_writer::start_tag('div', array('class'=>'summary'));
2347     $options = NULL;
2348     $options->noclean = true;
2349     $options->para = false;
2350     $options->overflowdiv = true;
2351     if (!isset($course->summaryformat)) {
2352         $course->summaryformat = FORMAT_MOODLE;
2353     }
2354     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2355     if ((!isloggedin() || is_siteadmin()) && $icons = enrol_get_course_info_icons($course)) {
2356         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2357         foreach ($icons as $icon) {
2358             echo $OUTPUT->render($icon);
2359         }
2360         echo html_writer::end_tag('div'); // End of enrolmenticons div
2361     }
2362     echo html_writer::end_tag('div'); // End of summary div
2363     echo html_writer::end_tag('div'); // End of coursebox div
2366 /**
2367  * Prints custom user information on the home page.
2368  * Over time this can include all sorts of information
2369  */
2370 function print_my_moodle() {
2371     global $USER, $CFG, $DB, $OUTPUT;
2373     if (!isloggedin() or isguestuser()) {
2374         print_error('nopermissions', '', '', 'See My Moodle');
2375     }
2377     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2378     $rhosts   = array();
2379     $rcourses = array();
2380     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2381         $rcourses = get_my_remotecourses($USER->id);
2382         $rhosts   = get_my_remotehosts();
2383     }
2385     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2387         if (!empty($courses)) {
2388             echo '<ul class="unlist">';
2389             foreach ($courses as $course) {
2390                 if ($course->id == SITEID) {
2391                     continue;
2392                 }
2393                 echo '<li>';
2394                 print_course($course);
2395                 echo "</li>\n";
2396             }
2397             echo "</ul>\n";
2398         }
2400         // MNET
2401         if (!empty($rcourses)) {
2402             // at the IDP, we know of all the remote courses
2403             foreach ($rcourses as $course) {
2404                 print_remote_course($course, "100%");
2405             }
2406         } elseif (!empty($rhosts)) {
2407             // non-IDP, we know of all the remote servers, but not courses
2408             foreach ($rhosts as $host) {
2409                 print_remote_host($host, "100%");
2410             }
2411         }
2412         unset($course);
2413         unset($host);
2415         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2416             echo "<table width=\"100%\"><tr><td align=\"center\">";
2417             print_course_search("", false, "short");
2418             echo "</td><td align=\"center\">";
2419             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2420             echo "</td></tr></table>\n";
2421         }
2423     } else {
2424         if ($DB->count_records("course_categories") > 1) {
2425             echo $OUTPUT->box_start("categorybox");
2426             print_whole_category_list();
2427             echo $OUTPUT->box_end();
2428         } else {
2429             print_courses(0);
2430         }
2431     }
2435 function print_course_search($value="", $return=false, $format="plain") {
2436     global $CFG;
2437     static $count = 0;
2439     $count++;
2441     $id = 'coursesearch';
2443     if ($count > 1) {
2444         $id .= $count;
2445     }
2447     $strsearchcourses= get_string("searchcourses");
2449     if ($format == 'plain') {
2450         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2451         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2452         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2453         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2454         $output .= '<input type="submit" value="'.get_string('go').'" />';
2455         $output .= '</fieldset></form>';
2456     } else if ($format == 'short') {
2457         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2458         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2459         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2460         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2461         $output .= '<input type="submit" value="'.get_string('go').'" />';
2462         $output .= '</fieldset></form>';
2463     } else if ($format == 'navbar') {
2464         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2465         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2466         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2467         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2468         $output .= '<input type="submit" value="'.get_string('go').'" />';
2469         $output .= '</fieldset></form>';
2470     }
2472     if ($return) {
2473         return $output;
2474     }
2475     echo $output;
2478 function print_remote_course($course, $width="100%") {
2479     global $CFG, $USER;
2481     $linkcss = '';
2483     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2485     echo '<div class="coursebox remotecoursebox clearfix">';
2486     echo '<div class="info">';
2487     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2488          $linkcss.' href="'.$url.'">'
2489         .  format_string($course->fullname) .'</a><br />'
2490         . format_string($course->hostname) . ' : '
2491         . format_string($course->cat_name) . ' : '
2492         . format_string($course->shortname). '</div>';
2493     echo '</div><div class="summary">';
2494     $options = NULL;
2495     $options->noclean = true;
2496     $options->para = false;
2497     $options->overflowdiv = true;
2498     echo format_text($course->summary, $course->summaryformat, $options);
2499     echo '</div>';
2500     echo '</div>';
2503 function print_remote_host($host, $width="100%") {
2504     global $OUTPUT;
2506     $linkcss = '';
2508     echo '<div class="coursebox clearfix">';
2509     echo '<div class="info">';
2510     echo '<div class="name">';
2511     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2512     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2513         . s($host['name']).'</a> - ';
2514     echo $host['count'] . ' ' . get_string('courses');
2515     echo '</div>';
2516     echo '</div>';
2517     echo '</div>';
2521 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2523 function add_course_module($mod) {
2524     global $DB;
2526     $mod->added = time();
2527     unset($mod->id);
2529     return $DB->insert_record("course_modules", $mod);
2532 /**
2533  * Returns course section - creates new if does not exist yet.
2534  * @param int $relative section number
2535  * @param int $courseid
2536  * @return object $course_section object
2537  */
2538 function get_course_section($section, $courseid) {
2539     global $DB;
2541     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2542         return $cw;
2543     }
2544     $cw = new stdClass();
2545     $cw->course   = $courseid;
2546     $cw->section  = $section;
2547     $cw->summary  = "";
2548     $cw->summaryformat = FORMAT_HTML;
2549     $cw->sequence = "";
2550     $id = $DB->insert_record("course_sections", $cw);
2551     return $DB->get_record("course_sections", array("id"=>$id));
2553 /**
2554  * Given a full mod object with section and course already defined, adds this module to that section.
2555  *
2556  * @param object $mod
2557  * @param int $beforemod An existing ID which we will insert the new module before
2558  * @return int The course_sections ID where the mod is inserted
2559  */
2560 function add_mod_to_section($mod, $beforemod=NULL) {
2561     global $DB;
2563     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2565         $section->sequence = trim($section->sequence);
2567         if (empty($section->sequence)) {
2568             $newsequence = "$mod->coursemodule";
2570         } else if ($beforemod) {
2571             $modarray = explode(",", $section->sequence);
2573             if ($key = array_keys($modarray, $beforemod->id)) {
2574                 $insertarray = array($mod->id, $beforemod->id);
2575                 array_splice($modarray, $key[0], 1, $insertarray);
2576                 $newsequence = implode(",", $modarray);
2578             } else {  // Just tack it on the end anyway
2579                 $newsequence = "$section->sequence,$mod->coursemodule";
2580             }
2582         } else {
2583             $newsequence = "$section->sequence,$mod->coursemodule";
2584         }
2586         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2587         return $section->id;     // Return course_sections ID that was used.
2589     } else {  // Insert a new record
2590         $section->course   = $mod->course;
2591         $section->section  = $mod->section;
2592         $section->summary  = "";
2593         $section->summaryformat = FORMAT_HTML;
2594         $section->sequence = $mod->coursemodule;
2595         return $DB->insert_record("course_sections", $section);
2596     }
2599 function set_coursemodule_groupmode($id, $groupmode) {
2600     global $DB;
2601     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2604 function set_coursemodule_idnumber($id, $idnumber) {
2605     global $DB;
2606     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2609 /**
2610 * $prevstateoverrides = true will set the visibility of the course module
2611 * to what is defined in visibleold. This enables us to remember the current
2612 * visibility when making a whole section hidden, so that when we toggle
2613 * that section back to visible, we are able to return the visibility of
2614 * the course module back to what it was originally.
2615 */
2616 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2617     global $DB, $CFG;
2618     require_once($CFG->libdir.'/gradelib.php');
2620     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2621         return false;
2622     }
2623     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2624         return false;
2625     }
2626     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2627         foreach($events as $event) {
2628             if ($visible) {
2629                 show_event($event);
2630             } else {
2631                 hide_event($event);
2632             }
2633         }
2634     }
2636     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2637     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2638     if ($grade_items) {
2639         foreach ($grade_items as $grade_item) {
2640             $grade_item->set_hidden(!$visible);
2641         }
2642     }
2644     if ($prevstateoverrides) {
2645         if ($visible == '0') {
2646             // Remember the current visible state so we can toggle this back.
2647             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2648         } else {
2649             // Get the previous saved visible states.
2650             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2651         }
2652     }
2653     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2656 /**
2657  * Delete a course module and any associated data at the course level (events)
2658  * Until 1.5 this function simply marked a deleted flag ... now it
2659  * deletes it completely.
2660  *
2661  */
2662 function delete_course_module($id) {
2663     global $CFG, $DB;
2664     require_once($CFG->libdir.'/gradelib.php');
2665     require_once($CFG->dirroot.'/blog/lib.php');
2667     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2668         return true;
2669     }
2670     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2671     //delete events from calendar
2672     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2673         foreach($events as $event) {
2674             delete_event($event->id);
2675         }
2676     }
2677     //delete grade items, outcome items and grades attached to modules
2678     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2679                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2680         foreach ($grade_items as $grade_item) {
2681             $grade_item->delete('moddelete');
2682         }
2683     }
2684     // Delete completion and availability data; it is better to do this even if the
2685     // features are not turned on, in case they were turned on previously (these will be
2686     // very quick on an empty table)
2687     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2688     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2690     delete_context(CONTEXT_MODULE, $cm->id);
2691     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2694 function delete_mod_from_section($mod, $section) {
2695     global $DB;
2697     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2699         $modarray = explode(",", $section->sequence);
2701         if ($key = array_keys ($modarray, $mod)) {
2702             array_splice($modarray, $key[0], 1);
2703             $newsequence = implode(",", $modarray);
2704             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2705         } else {
2706             return false;
2707         }
2709     }
2710     return false;
2713 /**
2714  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2715  *
2716  * @param object $course
2717  * @param int $section
2718  * @param int $move (-1 or 1)
2719  */
2720 function move_section($course, $section, $move) {
2721 /// Moves a whole course section up and down within the course
2722     global $USER, $DB;
2724     if (!$move) {
2725         return true;
2726     }
2728     $sectiondest = $section + $move;
2730     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2731         return false;
2732     }
2734     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2735         return false;
2736     }
2738     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2739         return false;
2740     }
2742     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2743     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2745     // if the focus is on the section that is being moved, then move the focus along
2746     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2747         course_set_display($course->id, $sectiondest);
2748     }
2750     // Check for duplicates and fix order if needed.
2751     // There is a very rare case that some sections in the same course have the same section id.
2752     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2753     $n = 0;
2754     foreach ($sections as $section) {
2755         if ($section->section != $n) {
2756             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2757         }
2758         $n++;
2759     }
2760     return true;
2763 /**
2764  * Moves a section within a course, from a position to another.
2765  * Be very careful: $section and $destination refer to section number,
2766  * not id!.
2767  *
2768  * @param object $course
2769  * @param int $section Section number (not id!!!)
2770  * @param int $destination
2771  * @return boolean Result
2772  */
2773 function move_section_to($course, $section, $destination) {
2774 /// Moves a whole course section up and down within the course
2775     global $USER, $DB;
2777     if (!$destination && $destination != 0) {
2778         return true;
2779     }
2781     if ($destination > $course->numsections) {
2782         return false;
2783     }
2785     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2786     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2787             'section ASC, id ASC', 'id, section')) {
2788         return false;
2789     }
2791     $sections = reorder_sections($sections, $section, $destination);
2793     // Update all sections
2794     foreach ($sections as $id => $position) {
2795         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2796     }
2798     // if the focus is on the section that is being moved, then move the focus along
2799     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2800         course_set_display($course->id, $destination);
2801     }
2802     return true;
2805 /**
2806  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2807  * an original position number and a target position number, rebuilds the array so that the
2808  * move is made without any duplication of section positions.
2809  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2810  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2811  *
2812  * @param array $sections
2813  * @param int $origin_position
2814  * @param int $target_position
2815  * @return array
2816  */
2817 function reorder_sections($sections, $origin_position, $target_position) {
2818     if (!is_array($sections)) {
2819         return false;
2820     }
2822     // We can't move section position 0
2823     if ($origin_position < 1) {
2824         echo "We can't move section position 0";
2825         return false;
2826     }
2828     // Locate origin section in sections array
2829     if (!$origin_key = array_search($origin_position, $sections)) {
2830         echo "searched position not in sections array";
2831         return false; // searched position not in sections array
2832     }
2834     // Extract origin section
2835     $origin_section = $sections[$origin_key];
2836     unset($sections[$origin_key]);
2838     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2839     $found = false;
2840     $append_array = array();
2841     foreach ($sections as $id => $position) {
2842         if ($found) {
2843             $append_array[$id] = $position;
2844             unset($sections[$id]);
2845         }
2846         if ($position == $target_position) {
2847             $found = true;
2848         }
2849     }
2851     // Append moved section
2852     $sections[$origin_key] = $origin_section;
2854     // Append rest of array (if applicable)
2855     if (!empty($append_array)) {
2856         foreach ($append_array as $id => $position) {
2857             $sections[$id] = $position;
2858         }
2859     }
2861     // Renumber positions
2862     $position = 0;
2863     foreach ($sections as $id => $p) {
2864         $sections[$id] = $position;
2865         $position++;
2866     }
2868     return $sections;
2872 /**
2873  * Move the module object $mod to the specified $section
2874  * If $beforemod exists then that is the module
2875  * before which $modid should be inserted
2876  * All parameters are objects
2877  */
2878 function moveto_module($mod, $section, $beforemod=NULL) {
2879     global $DB, $OUTPUT;
2881 /// Remove original module from original section
2882     if (! delete_mod_from_section($mod->id, $mod->section)) {
2883         echo $OUTPUT->notification("Could not delete module from existing section");
2884     }
2886 /// Update module itself if necessary
2888     if ($mod->section != $section->id) {
2889         $mod->section = $section->id;
2890         $DB->update_record("course_modules", $mod);
2891         // if moving to a hidden section then hide module
2892         if (!$section->visible) {
2893             set_coursemodule_visible($mod->id, 0);
2894         }
2895     }
2897 /// Add the module into the new section
2899     $mod->course       = $section->course;
2900     $mod->section      = $section->section;  // need relative reference
2901     $mod->coursemodule = $mod->id;
2903     if (! add_mod_to_section($mod, $beforemod)) {
2904         return false;
2905     }
2907     return true;
2910 function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
2911     global $CFG, $USER, $DB, $OUTPUT;
2913     static $str;
2914     static $sesskey;
2916     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
2917     // no permission to edit
2918     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
2919         return false;
2920     }
2922     if (!isset($str)) {
2923         $str->assign         = get_string("assignroles", 'role');
2924         $str->delete         = get_string("delete");
2925         $str->move           = get_string("move");
2926         $str->moveup         = get_string("moveup");
2927         $str->movedown       = get_string("movedown");
2928         $str->moveright      = get_string("moveright");
2929         $str->moveleft       = get_string("moveleft");
2930         $str->update         = get_string("update");
2931         $str->duplicate      = get_string("duplicate");
2932         $str->hide           = get_string("hide");
2933         $str->show           = get_string("show");
2934         $str->clicktochange  = get_string("clicktochange");
2935         $str->forcedmode     = get_string("forcedmode");
2936         $str->groupsnone     = get_string("groupsnone");
2937         $str->groupsseparate = get_string("groupsseparate");
2938         $str->groupsvisible  = get_string("groupsvisible");
2939         $sesskey = sesskey();
2940     }
2942     if ($section >= 0) {
2943         $section = '&amp;sr='.$section;   // Section return
2944     } else {
2945         $section = '';
2946     }
2948     if ($absolute) {
2949         $path = $CFG->wwwroot.'/course';
2950     } else {
2951         $path = '.';
2952     }
2953     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2954         if ($mod->visible) {
2955             $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
2956                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2957                         ' src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" '.
2958                         ' alt="'.$str->hide.'" /></a>'."\n";
2959         } else {
2960             $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
2961                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2962                         ' src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" '.
2963                         ' alt="'.$str->show.'" /></a>'."\n";
2964         }
2965     } else {
2966         $hideshow = '';
2967     }
2969     if ($mod->groupmode !== false) {
2970         if ($mod->groupmode == SEPARATEGROUPS) {
2971             $grouptitle = $str->groupsseparate;
2972             $groupclass = 'editing_groupsseparate';
2973             $groupimage = $OUTPUT->pix_url('t/groups') . '';
2974             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
2975         } else if ($mod->groupmode == VISIBLEGROUPS) {
2976             $grouptitle = $str->groupsvisible;
2977             $groupclass = 'editing_groupsvisible';
2978             $groupimage = $OUTPUT->pix_url('t/groupv') . '';
2979             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
2980         } else {
2981             $grouptitle = $str->groupsnone;
2982             $groupclass = 'editing_groupsnone';
2983             $groupimage = $OUTPUT->pix_url('t/groupn') . '';
2984             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
2985         }
2986         if ($mod->groupmodelink) {
2987             $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
2988                          '<img src="'.$groupimage.'" class="iconsmall" '.
2989                          'alt="'.$grouptitle.'" /></a>';
2990         } else {
2991             $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
2992                          ' src="'.$groupimage.'" class="iconsmall" '.
2993                          'alt="'.$grouptitle.'" />';
2994         }
2995     } else {
2996         $groupmode = "";
2997     }
2999     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
3000         if ($moveselect) {
3001             $move =     '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
3002                         '&amp;sesskey='.$sesskey.$section.'"><img'.
3003                         ' src="'.$OUTPUT->pix_url('t/move') . '" class="iconsmall" '.
3004                         ' alt="'.$str->move.'" /></a>'."\n";
3005         } else {
3006             $move =     '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
3007                         '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3008                         ' src="'.$OUTPUT->pix_url('t/up') . '" class="iconsmall" '.
3009                         ' alt="'.$str->moveup.'" /></a>'."\n".
3010                         '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
3011                         '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
3012                         ' src="'.$OUTPUT->pix_url('t/down') . '" class="iconsmall" '.
3013                         ' alt="'.$str->movedown.'" /></a>'."\n";
3014         }
3015     } else {
3016         $move = '';
3017     }
3019     $leftright = '';
3020     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
3022         if (right_to_left()) {   // Exchange arrows on RTL
3023             $rightarrow = 't/left';
3024             $leftarrow  = 't/right';
3025         } else {
3026             $rightarrow = 't/right';
3027             $leftarrow  = 't/left';
3028         }
3030         if ($indent > 0) {
3031             $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
3032                         '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3033                         ' src="'.$OUTPUT->pix_url($leftarrow).'" class="iconsmall" '.
3034                         ' alt="'.$str->moveleft.'" /></a>'."\n";
3035         }
3036         if ($indent >= 0) {
3037             $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
3038                         '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
3039                         ' src="'.$OUTPUT->pix_url($rightarrow).'" class="iconsmall" '.
3040                         ' alt="'.$str->moveright.'" /></a>'."\n";
3041         }
3042     }
3043     if (has_capability('moodle/course:managegroups', $modcontext)){
3044         $context = get_context_instance(CONTEXT_MODULE, $mod->id);
3045         $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
3046             $context->id.'"><img src="'.$OUTPUT->pix_url('i/roles') . '" alt="'.$str->assign.'" class="iconsmall"/></a>';
3047     } else {
3048         $assign = '';
3049     }
3051     return '<span class="commands">'."\n".$leftright.$move.
3052            '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
3053            '&amp;sesskey='.$sesskey.$section.'"><img'.
3054            ' src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" '.
3055            ' alt="'.$str->update.'" /></a>'."\n".
3056            '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
3057            '&amp;sesskey='.$sesskey.$section.'"><img'.
3058            ' src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" '.
3059            ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
3062 /**
3063  * given a course object with shortname & fullname, this function will
3064  * truncate the the number of chars allowed and add ... if it was too long
3065  */
3066 function course_format_name ($course,$max=100) {
3068     $str = $course->shortname.': '. $course->fullname;
3069     if (strlen($str) <= $max) {
3070         return $str;
3071     }
3072     else {
3073         return substr($str,0,$max-3).'...';
3074     }
3077 function update_restricted_mods($course, $mods) {
3078     global $DB;
3080 /// Delete all the current restricted list
3081     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3083     if (empty($course->restrictmodules)) {
3084         return;   // We're done
3085     }
3087 /// Insert the new list of restricted mods
3088     foreach ($mods as $mod) {
3089         if ($mod == 0) {
3090             continue; // this is the 'allow none' option
3091         }
3092         $am = new stdClass();
3093         $am->course = $course->id;
3094         $am->module = $mod;
3095         $DB->insert_record('course_allowed_modules',$am);
3096     }
3099 /**
3100  * This function will take an int (module id) or a string (module name)
3101  * and return true or false, whether it's allowed in the given course (object)
3102  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3103  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3104  */
3106 function course_allowed_module($course,$mod) {
3107     global $DB;
3109     if (empty($course->restrictmodules)) {
3110         return true;
3111     }
3113     // Admins and admin-like people who can edit everything can also add anything.
3114     // Originally there was a course:update test only, but it did not match the test in course edit form
3115     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3116         return true;
3117     }
3119     if (is_numeric($mod)) {
3120         $modid = $mod;
3121     } else if (is_string($mod)) {
3122         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3123     }
3124     if (empty($modid)) {
3125         return false;
3126     }
3128     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3131 /**
3132  * Recursively delete category including all subcategories and courses.
3133  * @param stdClass $category
3134  * @param boolean $showfeedback display some notices
3135  * @return array return deleted courses
3136  */
3137 function category_delete_full($category, $showfeedback=true) {
3138     global $CFG, $DB;
3139     require_once($CFG->libdir.'/gradelib.php');
3140     require_once($CFG->libdir.'/questionlib.php');
3141     require_once($CFG->dirroot.'/cohort/lib.php');
3143     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3144         foreach ($children as $childcat) {
3145             category_delete_full($childcat, $showfeedback);
3146         }
3147     }
3149     $deletedcourses = array();
3150     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3151         foreach ($courses as $course) {
3152             if (!delete_course($course, false)) {
3153                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3154             }
3155             $deletedcourses[] = $course;
3156         }
3157     }
3159     // move or delete cohorts in this context
3160     cohort_delete_category($category);
3162     // now delete anything that may depend on course category context
3163     grade_course_category_delete($category->id, 0, $showfeedback);
3164     if (!question_delete_course_category($category, 0, $showfeedback)) {
3165         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3166     }
3168     // finally delete the category and it's context
3169     $DB->delete_records('course_categories', array('id'=>$category->id));
3170     delete_context(CONTEXT_COURSECAT, $category->id);
3172     events_trigger('course_category_deleted', $category);
3174     return $deletedcourses;
3177 /**
3178  * Delete category, but move contents to another category.
3179  * @param object $ccategory
3180  * @param int $newparentid category id
3181  * @return bool status
3182  */
3183 function category_delete_move($category, $newparentid, $showfeedback=true) {
3184     global $CFG, $DB, $OUTPUT;
3185     require_once($CFG->libdir.'/gradelib.php');
3186     require_once($CFG->libdir.'/questionlib.php');
3187     require_once($CFG->dirroot.'/cohort/lib.php');
3189     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3190         return false;
3191     }
3193     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3194         foreach ($children as $childcat) {
3195             move_category($childcat, $newparentcat);
3196         }
3197     }
3199     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3200         if (!move_courses(array_keys($courses), $newparentid)) {
3201             echo $OUTPUT->notification("Error moving courses");
3202             return false;
3203         }
3204         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3205     }
3207     // move or delete cohorts in this context
3208     cohort_delete_category($category);
3210     // now delete anything that may depend on course category context
3211     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3212     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3213         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3214         return false;
3215     }
3217     // finally delete the category and it's context
3218     $DB->delete_records('course_categories', array('id'=>$category->id));
3219     delete_context(CONTEXT_COURSECAT, $category->id);
3221     events_trigger('course_category_deleted', $category);
3223     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3225     return true;
3228 /**
3229  * Efficiently moves many courses around while maintaining
3230  * sortorder in order.
3231  *
3232  * @param array $courseids is an array of course ids
3233  * @param int $categoryid
3234  * @return bool success
3235  */
3236 function move_courses($courseids, $categoryid) {
3237     global $CFG, $DB, $OUTPUT;
3239     if (empty($courseids)) {
3240         // nothing to do
3241         return;
3242     }
3244     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3245         return false;
3246     }
3248     $courseids = array_reverse($courseids);
3249     $i = 1;
3251     foreach ($courseids as $courseid) {
3252         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3253             $course->category  = $category->id;
3254             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3255             if ($category->visible == 0) {
3256                 // hide the course when moving into hidden category,
3257                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3258                 $course->visible = 0;
3259             }
3261             $DB->update_record('course', $course);
3263             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3264             $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3265             context_moved($context, $newparent);
3266         }
3267     }
3268     fix_course_sortorder();
3270     return true;
3273 /**
3274  * Hide course category and child course and subcategories
3275  * @param stdClass $category
3276  * @return void
3277  */
3278 function course_category_hide($category) {
3279     global $DB;
3281     $category->visible = 0;
3282     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3283     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3284     $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
3285     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3286     // get all child categories and hide too
3287     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3288         foreach ($subcats as $cat) {
3289             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3290             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3291             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3292             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3293         }
3294     }
3297 /**
3298  * Show course category and child course and subcategories
3299  * @param stdClass $category
3300  * @return void
3301  */
3302 function course_category_show($category) {
3303     global $DB;
3305     $category->visible = 1;
3306     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3307     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3308     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3309     // get all child categories and unhide too
3310     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3311         foreach ($subcats as $cat) {
3312             if ($cat->visibleold) {
3313                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3314             }
3315             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3316         }
3317     }
3320 /**
3321  * Efficiently moves a category - NOTE that this can have
3322  * a huge impact access-control-wise...
3323  */
3324 function move_category($category, $newparentcat) {
3325     global $CFG, $DB;
3327     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3329     $hidecat = false;
3330     if (empty($newparentcat->id)) {
3331         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3333         $newparent = get_context_instance(CONTEXT_SYSTEM);
3335     } else {
3336         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3337         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3339         if (!$newparentcat->visible and $category->visible) {
3340             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3341             $hidecat = true;
3342         }
3343     }
3345     context_moved($context, $newparent);
3347     // now make it last in new category
3348     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3350     // and fix the sortorders
3351     fix_course_sortorder();
3353     if ($hidecat) {
3354         course_category_hide($category);
3355     }
3358 /**
3359  * Returns the display name of the given section that the course prefers.
3360  *
3361  * This function utilizes a callback that can be implemented within the course
3362  * formats lib.php file to customize the display name that is used to reference
3363  * the section.
3364  *
3365  * By default (if callback is not defined) the method
3366  * {@see get_numeric_section_name} is called instead.
3367  *
3368  * @param stdClass $course The course to get the section name for
3369  * @param stdClass $section Section object from database
3370  * @return Display name that the course format prefers, e.g. "Week 2"
3371  *
3372  * @see get_generic_section_name
3373  */
3374 function get_section_name(stdClass $course, stdClass $section) {
3375     global $CFG;
3377     /// Inelegant hack for bug 3408
3378     if ($course->format == 'site') {
3379         return get_string('site');
3380     }
3382     // Use course formatter callback if it exists
3383     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3384     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3385     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3386         require_once $namingfile;
3387     }
3388     if (function_exists($namingfunction)) {
3389         return $namingfunction($course, $section);
3390     }
3392     // else, default behavior:
3393     return get_generic_section_name($course->format, $section);
3396 /**
3397  * Gets the generic section name for a courses section.
3398  *
3399  * @param string $format Course format ID e.g. 'weeks' $course->format
3400  * @param stdClass $section Section object from database
3401  * @return Display name that the course format prefers, e.g. "Week 2"
3402  */
3403 function get_generic_section_name($format, stdClass $section) {
3404     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3408 function course_format_uses_sections($format) {
3409     global $CFG;
3411     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3412     $featurefunction = 'callback_'.$format.'_uses_sections';
3413     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3414         require_once $featurefile;
3415     }
3416     if (function_exists($featurefunction)) {
3417         return $featurefunction();
3418     }
3420     return false;
3423 /**
3424  * Returns the information about the ajax support in the given source format
3425  *
3426  * The returned object's property (boolean)capable indicates that
3427  * the course format supports Moodle course ajax features.
3428  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3429  *
3430  * @param string $format
3431  * @return stdClass
3432  */
3433 function course_format_ajax_support($format) {
3434     global $CFG;
3436     // set up default values
3437     $ajaxsupport = new stdClass();
3438     $ajaxsupport->capable = false;
3439     $ajaxsupport->testedbrowsers = array();
3441     // get the information from the course format library
3442     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3443     $featurefunction = 'callback_'.$format.'_ajax_support';
3444     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3445         require_once $featurefile;
3446     }
3447     if (function_exists($featurefunction)) {
3448         $formatsupport = $featurefunction();
3449         if (isset($formatsupport->capable)) {
3450             $ajaxsupport->capable = $formatsupport->capable;
3451         }
3452         if (is_array($formatsupport->testedbrowsers)) {
3453             $ajaxsupport->testedbrowsers = $formatsupport->testedbrowsers;
3454         }
3455     }
3457     return $ajaxsupport;
3460 /**
3461  * Can the current user delete this course?
3462  * Course creators have exception,
3463  * 1 day after the creation they can sill delete the course.
3464  * @param int $courseid
3465  * @return boolean
3466  */
3467 function can_delete_course($courseid) {
3468     global $USER, $DB;
3470     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3472     if (has_capability('moodle/course:delete', $context)) {
3473         return true;
3474     }
3476     // hack: now try to find out if creator created this course recently (1 day)
3477     if (!has_capability('moodle/course:create', $context)) {
3478         return false;
3479     }
3481     $since = time() - 60*60*24;
3483     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3484     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3486     return $DB->record_exists_select('log', $select, $params);
3489 /**
3490  * Save the Your name for 'Some role' strings.
3491  *
3492  * @param integer $courseid the id of this course.
3493  * @param array $data the data that came from the course settings form.
3494  */
3495 function save_local_role_names($courseid, $data) {
3496     global $DB;
3497     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3499     foreach ($data as $fieldname => $value) {
3500         if (strpos($fieldname, 'role_') !== 0) {
3501             continue;
3502         }
3503         list($ignored, $roleid) = explode('_', $fieldname);
3505         // make up our mind whether we want to delete, update or insert
3506         if (!$value) {
3507             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3509         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3510             $rolename->name = $value;
3511             $DB->update_record('role_names', $rolename);
3513         } else {
3514             $rolename = new stdClass;
3515             $rolename->contextid = $context->id;
3516             $rolename->roleid = $roleid;
3517             $rolename->name = $value;
3518             $DB->insert_record('role_names', $rolename);
3519         }
3520     }
3523 /**
3524  * Create a course and either return a $course object
3525  *
3526  * Please note this functions does not verify any access control,
3527  * the calling code is responsible for all validation (usually it is the form definition).
3528  *
3529  * @param array $editoroptions course description editor options
3530  * @param object $data  - all the data needed for an entry in the 'course' table
3531  * @return object new course instance
3532  */
3533 function create_course($data, $editoroptions = NULL) {
3534     global $CFG, $DB;
3536     //check the categoryid - must be given for all new courses
3537     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3539     //check if the shortname already exist
3540     if (!empty($data->shortname)) {
3541         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3542             throw new moodle_exception('shortnametaken');
3543         }
3544     }
3546     //check if the id number already exist
3547     if (!empty($data->idnumber)) {
3548         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3549             throw new moodle_exception('idnumbertaken');
3550         }
3551     }
3553     $data->timecreated  = time();
3554     $data->timemodified = $data->timecreated;
3556     // place at beginning of any category
3557     $data->sortorder = 0;
3559     if ($editoroptions) {
3560         // summary text is updated later, we need context to store the files first
3561         $data->summary = '';
3562         $data->summary_format = FORMAT_HTML;
3563     }
3565     if (!isset($data->visible)) {
3566         // data not from form, add missing visibility info
3567         $data->visible = $category->visible;
3568     }
3569     $data->visibleold = $data->visible;
3571     $newcourseid = $DB->insert_record('course', $data);
3572     $context = get_context_instance(CONTEXT_COURSE, $newcourseid, MUST_EXIST);
3574     if ($editoroptions) {
3575         // Save the files used in the summary editor and store
3576         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3577         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3578         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3579     }
3581     $course = $DB->get_record('course', array('id'=>$newcourseid));
3583     // Setup the blocks
3584     blocks_add_default_course_blocks($course);
3586     $section = new stdClass();
3587     $section->course        = $course->id;   // Create a default section.
3588     $section->section       = 0;
3589     $section->summaryformat = FORMAT_HTML;
3590     $DB->insert_record('course_sections', $section);
3592     fix_course_sortorder();
3594     // update module restrictions
3595     if ($course->restrictmodules) {
3596         if (isset($data->allowedmods)) {
3597             update_restricted_mods($course, $data->allowedmods);
3598         } else {
3599             if (!empty($CFG->defaultallowedmodules)) {
3600                 update_restricted_mods($course, explode(',', $CFG->defaultallowedmodules));
3601             }
3602         }
3603     }
3605     // new context created - better mark it as dirty
3606     mark_context_dirty($context->path);
3608     // Save any custom role names.
3609     save_local_role_names($course->id, (array)$data);
3611     // set up enrolments
3612     enrol_course_updated(true, $course, $data);
3614     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3616     // Trigger events
3617     events_trigger('course_created', $course);
3619     return $course;
3622 /**
3623  * Update a course.
3624  *
3625  * Please note this functions does not verify any access control,
3626  * the calling code is responsible for all validation (usually it is the form definition).
3627  *
3628  * @param object $data  - all the data needed for an entry in the 'course' table
3629  * @param array $editoroptions course description editor options
3630  * @return void
3631  */
3632 function update_course($data, $editoroptions = NULL) {
3633     global $CFG, $DB;
3635     $data->timemodified = time();
3637     $oldcourse = $DB->get_record('course', array('id'=>$data->id), '*', MUST_EXIST);
3638     $context   = get_context_instance(CONTEXT_COURSE, $oldcourse->id);
3640     if ($editoroptions) {
3641         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3642     }
3644     if (!isset($data->category) or empty($data->category)) {
3645         // prevent nulls and 0 in category field
3646         unset($data->category);
3647     }
3648     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3650     if (!isset($data->visible)) {
3651         // data not from form, add missing visibility info
3652         $data->visible = $oldcourse->visible;
3653     }
3655     if ($data->visible != $oldcourse->visible) {
3656         // reset the visibleold flag when manually hiding/unhiding course
3657         $data->visibleold = $data->visible;
3658     } else {
3659         if ($movecat) {
3660             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3661             if (empty($newcategory->visible)) {
3662                 // make sure when moving into hidden category the course is hidden automatically
3663                 $data->visible = 0;
3664             }
3665         }
3666     }
3668     // Update with the new data
3669     $DB->update_record('course', $data);
3671     $course = $DB->get_record('course', array('id'=>$data->id));
3673     if ($movecat) {
3674         $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3675         context_moved($context, $newparent);
3676     }
3678     fix_course_sortorder();
3680     // Test for and remove blocks which aren't appropriate anymore
3681     blocks_remove_inappropriate($course);
3683     // update module restrictions
3684     if (isset($data->allowedmods)) {
3685         update_restricted_mods($course, $data->allowedmods);
3686     }
3688     // Save any custom role names.
3689     save_local_role_names($course->id, $data);
3691     // update enrol settings
3692     enrol_course_updated(false, $course, $data);
3694     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3696     // Trigger events
3697     events_trigger('course_updated', $course);
3700 /**
3701  * Average number of participants
3702  * @return integer
3703  */
3704 function average_number_of_participants() {
3705     global $DB, $SITE;
3707     //count total of enrolments for visible course (except front page)
3708     $sql = 'SELECT COUNT(*) FROM (
3709         SELECT DISTINCT ue.userid, e.courseid
3710         FROM {user_enrolments} ue, {enrol} e, {course} c
3711         WHERE ue.enrolid = e.id
3712             AND e.courseid <> :siteid
3713             AND c.id = e.courseid
3714             AND c.visible = 1) as total';
3715     $params = array('siteid' => $SITE->id);
3716     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3719     //count total of visible courses (minus front page)
3720     $coursetotal = $DB->count_records('course', array('visible' => 1));
3721     $coursetotal = $coursetotal - 1 ;
3723     //average of enrolment
3724     if (empty($coursetotal)) {
3725         $participantaverage = 0;
3726     } else {
3727         $participantaverage = $enrolmenttotal / $coursetotal;
3728     }
3730     return $participantaverage;
3733 /**
3734  * Average number of course modules
3735  * @return integer
3736  */
3737 function average_number_of_courses_modules() {
3738     global $DB, $SITE;
3740     //count total of visible course module (except front page)
3741     $sql = 'SELECT COUNT(*) FROM (
3742         SELECT cm.course, cm.module
3743         FROM {course} c, {course_modules} cm
3744         WHERE c.id = cm.course
3745             AND c.id <> :siteid
3746             AND cm.visible = 1
3747             AND c.visible = 1) as total';
3748     $params = array('siteid' => $SITE->id);
3749     $moduletotal = $DB->count_records_sql($sql, $params);
3752     //count total of visible courses (minus front page)
3753     $coursetotal = $DB->count_records('course', array('visible' => 1));
3754     $coursetotal = $coursetotal - 1 ;
3756     //average of course module
3757     if (empty($coursetotal)) {
3758         $coursemoduleaverage = 0;
3759     } else {
3760         $coursemoduleaverage = $moduletotal / $coursetotal;
3761     }
3763     return $coursemoduleaverage;
3766 /**
3767  * This class pertains to course requests and contains methods associated with
3768  * create, approving, and removing course requests.
3769  *
3770  * Please note we do not allow embedded images here because there is no context
3771  * to store them with proper access control.
3772  *
3773  * @copyright 2009 Sam Hemelryk
3774  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3775  * @since Moodle 2.0
3776  *
3777  * @property-read int $id
3778  * @property-read string $fullname
3779  * @property-read string $shortname
3780  * @property-read string $summary
3781  * @property-read int $summaryformat
3782  * @property-read int $summarytrust
3783  * @property-read string $reason
3784  * @property-read int $requester
3785  */
3786 class course_request {
3788     /**
3789      * This is the stdClass that stores the properties for the course request
3790      * and is externally accessed through the __get magic method
3791      * @var stdClass
3792      */
3793     protected $properties;
3795     /**
3796      * An array of options for the summary editor used by course request forms.
3797      * This is initially set by {@link summary_editor_options()}
3798      * @var array
3799      * @static
3800      */
3801     protected static $summaryeditoroptions;
3803     /**
3804      * Static function to prepare the summary editor for working with a course
3805      * request.
3806      *
3807      * @static
3808      * @param null|stdClass $data Optional, an object containing the default values
3809      *                       for the form, these may be modified when preparing the
3810      *                       editor so this should be called before creating the form
3811      * @return stdClass An object that can be used to set the default values for
3812      *                   an mforms form
3813      */
3814     public static function prepare($data=null) {
3815         if ($data === null) {
3816             $data = new stdClass;
3817         }
3818         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
3819         return $data;
3820     }
3822     /**
3823      * Static function to create a new course request when passed an array of properties
3824      * for it.
3825      *
3826      * This function also handles saving any files that may have been used in the editor
3827      *
3828      * @static
3829      * @param stdClass $data
3830      * @return course_request The newly created course request
3831      */
3832     public static function create($data) {
3833         global $USER, $DB, $CFG;
3834         $data->requester = $USER->id;
3836         // Summary is a required field so copy the text over
3837         $data->summary       = $data->summary_editor['text'];
3838         $data->summaryformat = $data->summary_editor['format'];
3840         $data->id = $DB->insert_record('course_request', $data);
3842         // Create a new course_request object and return it
3843         $request = new course_request($data);
3845         // Notify the admin if required.
3846         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
3848             $a = new stdClass;
3849             $a->link = "$CFG->wwwroot/course/pending.php";
3850             $a->user = fullname($USER);
3851             $subject = get_string('courserequest');
3852             $message = get_string('courserequestnotifyemail', 'admin', $a);
3853             foreach ($users as $user) {
3854                 $request->notify($user, $USER, 'courserequested', $subject, $message);
3855             }
3856         }
3858         return $request;
3859     }
3861     /**
3862      * Returns an array of options to use with a summary editor
3863      *
3864      * @uses course_request::$summaryeditoroptions
3865      * @return array An array of options to use with the editor
3866      */
3867     public static function summary_editor_options() {
3868         global $CFG;
3869         if (self::$summaryeditoroptions === null) {
3870             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
3871         }
3872         return self::$summaryeditoroptions;
3873     }
3875     /**
3876      * Loads the properties for this course request object. Id is required and if
3877      * only id is provided then we load the rest of the properties from the database
3878      *
3879      * @param stdClass|int $properties Either an object containing properties
3880      *                      or the course_request id to load
3881      */
3882     public function __construct($properties) {
3883         global $DB;
3884         if (empty($properties->id)) {
3885             if (empty($properties)) {
3886                 throw new coding_exception('You must provide a course request id when creating a course_request object');
3887             }
3888             $id = $properties;
3889             $properties = new stdClass;
3890             $properties->id = (int)$id;
3891             unset($id);
3892         }
3893         if (empty($properties->requester)) {
3894             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3895                 print_error('unknowncourserequest');
3896             }
3897         } else {
3898             $this->properties = $properties;
3899         }
3900         $this->properties->collision = null;
3901     }
3903     /**
3904      * Returns the requested property
3905      *
3906      * @param string $key
3907      * @return mixed
3908      */
3909     public function __get($key) {
3910         return $this->properties->$key;
3911     }
3913     /**
3914      * Override this to ensure empty($request->blah) calls return a reliable answer...
3915      *
3916      * This is required because we define the __get method
3917      *
3918      * @param mixed $key
3919      * @return bool True is it not empty, false otherwise
3920      */
3921     public function __isset($key) {
3922         return (!empty($this->properties->$key));
3923     }
3925     /**
3926      * Returns the user who requested this course
3927      *
3928      * Uses a static var to cache the results and cut down the number of db queries
3929      *
3930      * @staticvar array $requesters An array of cached users
3931      * @return stdClass The user who requested the course
3932      */
3933     public function get_requester() {
3934         global $DB;
3935         static $requesters= array();
3936         if (!array_key_exists($this->properties->requester, $requesters)) {
3937             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3938         }
3939         return $requesters[$this->properties->requester];
3940     }
3942     /**
3943      * Checks that the shortname used by the course does not conflict with any other
3944      * courses that exist
3945      *
3946      * @param string|null $shortnamemark The string to append to the requests shortname
3947      *                     should a conflict be found
3948      * @return bool true is there is a conflict, false otherwise
3949      */
3950     public function check_shortname_collision($shortnamemark = '[*]') {
3951         global $DB;
3953         if ($this->properties->collision !== null) {
3954             return $this->properties->collision;
3955         }
3957         if (empty($this->properties->shortname)) {
3958             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3959             $this->properties->collision = false;
3960         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3961             if (!empty($shortnamemark)) {
3962                 $this->properties->shortname .= ' '.$shortnamemark;
3963             }
3964             $this->properties->collision = true;
3965         } else {
3966             $this->properties->collision = false;
3967         }
3968         return $this->properties->collision;
3969     }
3971     /**
3972      * This function approves the request turning it into a course
3973      *
3974      * This function converts the course request into a course, at the same time
3975      * transferring any files used in the summary to the new course and then removing
3976      * the course request and the files associated with it.
3977      *
3978      * @return int The id of the course that was created from this request
3979      */
3980     public function approve() {
3981         global $CFG, $DB, $USER;
3983         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3985         $category = get_course_category($CFG->defaultrequestcategory);
3986         $courseconfig = get_config('moodlecourse');
3988         // Transfer appropriate settings
3989         $data = clone($this->properties);
3990         unset($data->id);
3991         unset($data->reason);
3992         unset($data->requester);
3994         // Set category
3995         $data->category = $category->id;
3996         $data->sortorder = $category->sortorder; // place as the first in category
3998         // Set misc settings
3999         $data->requested = 1;
4000         if (!empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor != 'none' && !empty($CFG->restrictbydefault)) {
4001             $data->restrictmodules = 1;
4002         }
4004         // Apply course default settings
4005         $data->format             = $courseconfig->format;
4006         $data->numsections        = $courseconfig->numsections;
4007         $data->hiddensections     = $courseconfig->hiddensections;
4008         $data->newsitems          = $courseconfig->newsitems;
4009         $data->showgrades         = $courseconfig->showgrades;
4010         $data->showreports        = $courseconfig->showreports;
4011         $data->maxbytes           = $courseconfig->maxbytes;
4012         $data->groupmode          = $courseconfig->groupmode;
4013         $data->groupmodeforce     = $courseconfig->groupmodeforce;
4014         $data->visible            = $courseconfig->visible;
4015         $data->visibleold         = $data->visible;
4016         $data->lang               = $courseconfig->lang;
4018         $course = create_course($data);
4019         $context = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
4021         // add enrol instances
4022         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
4023             if ($manual = enrol_get_plugin('manual')) {
4024                 $manual->add_default_instance($course);
4025             }
4026         }
4028         // enrol the requester as teacher if necessary
4029         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
4030             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
4031         }
4033         $this->delete();
4035         $a = new stdClass();
4036         $a->name = $course->fullname;
4037         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
4038         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
4040         return $course->id;
4041     }
4043     /**
4044      * Reject a course request
4045      *
4046      * This function rejects a course request, emailing the requesting user the
4047      * provided notice and then removing the request from the database
4048      *
4049      * @param string $notice The message to display to the user
4050      */
4051     public function reject($notice) {
4052         global $USER, $DB;
4053         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
4054         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
4055         $this->delete();
4056     }
4058     /**
4059      * Deletes the course request and any associated files
4060      */
4061     public function delete() {
4062         global $DB;
4063         $DB->delete_records('course_request', array('id' => $this->properties->id));
4064     }
4066     /**
4067      * Send a message from one user to another using events_trigger
4068      *
4069      * @param object $touser
4070      * @param object $fromuser
4071      * @param string $name
4072      * @param string $subject
4073      * @param string $message
4074      */
4075     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
4076         $eventdata = new stdClass();
4077         $eventdata->modulename        = 'moodle';
4078         $eventdata->component         = 'course';
4079         $eventdata->name              = $name;
4080         $eventdata->userfrom          = $fromuser;
4081         $eventdata->userto            = $touser;
4082         $eventdata->subject           = $subject;
4083         $eventdata->fullmessage       = $message;
4084         $eventdata->fullmessageformat = FORMAT_PLAIN;
4085         $eventdata->fullmessagehtml   = '';
4086         $eventdata->smallmessage      = '';
4087         message_send($eventdata);
4088     }