Merge branch 'MDL-26237' of git://github.com/stronk7/moodle
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
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 function make_log_url($module, $url) {
52     switch ($module) {
53         case 'course':
54         case 'file':
55         case 'login':
56         case 'lib':
57         case 'admin':
58         case 'calendar':
59         case 'mnet course':
60             if (strpos($url, '../') === 0) {
61                 $url = ltrim($url, '.');
62             } else {
63                 $url = "/course/$url";
64             }
65             break;
66         case 'user':
67         case 'blog':
68             $url = "/$module/$url";
69             break;
70         case 'upload':
71             $url = $url;
72             break;
73         case 'coursetags':
74             $url = '/'.$url;
75             break;
76         case 'library':
77         case '':
78             $url = '/';
79             break;
80         case 'message':
81             $url = "/message/$url";
82             break;
83         case 'notes':
84             $url = "/notes/$url";
85             break;
86         case 'tag':
87             $url = "/tag/$url";
88             break;
89         case 'role':
90             $url = '/'.$url;
91             break;
92         default:
93             $url = "/mod/$module/$url";
94             break;
95     }
97     //now let's sanitise urls - there might be some ugly nasties:-(
98     $parts = explode('?', $url);
99     $script = array_shift($parts);
100     if (strpos($script, 'http') === 0) {
101         $script = clean_param($script, PARAM_URL);
102     } else {
103         $script = clean_param($script, PARAM_PATH);
104     }
106     $query = '';
107     if ($parts) {
108         $query = implode('', $parts);
109         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
110         $parts = explode('&', $query);
111         $eq = urlencode('=');
112         foreach ($parts as $key=>$part) {
113             $part = urlencode(urldecode($part));
114             $part = str_replace($eq, '=', $part);
115             $parts[$key] = $part;
116         }
117         $query = '?'.implode('&amp;', $parts);
118     }
120     return $script.$query;
124 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
125                    $modname="", $modid=0, $modaction="", $groupid=0) {
126     global $CFG, $DB;
128     // It is assumed that $date is the GMT time of midnight for that day,
129     // and so the next 86400 seconds worth of logs are printed.
131     /// Setup for group handling.
133     // TODO: I don't understand group/context/etc. enough to be able to do
134     // something interesting with it here
135     // What is the context of a remote course?
137     /// If the group mode is separate, and this user does not have editing privileges,
138     /// then only the user's group can be viewed.
139     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
140     //    $groupid = get_current_group($course->id);
141     //}
142     /// If this course doesn't have groups, no groupid can be specified.
143     //else if (!$course->groupmode) {
144     //    $groupid = 0;
145     //}
147     $groupid = 0;
149     $joins = array();
151     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
152               FROM {mnet_log} l
153                LEFT JOIN {user} u ON l.userid = u.id
154               WHERE ";
155     $params = array();
157     $where .= "l.hostid = :hostid";
158     $params['hostid'] = $hostid;
160     // TODO: Is 1 really a magic number referring to the sitename?
161     if ($course != SITEID || $modid != 0) {
162         $where .= " AND l.course=:courseid";
163         $params['courseid'] = $course;
164     }
166     if ($modname) {
167         $where .= " AND l.module = :modname";
168         $params['modname'] = $modname;
169     }
171     if ('site_errors' === $modid) {
172         $where .= " AND ( l.action='error' OR l.action='infected' )";
173     } else if ($modid) {
174         //TODO: This assumes that modids are the same across sites... probably
175         //not true
176         $where .= " AND l.cmid = :modid";
177         $params['modid'] = $modid;
178     }
180     if ($modaction) {
181         $firstletter = substr($modaction, 0, 1);
182         if ($firstletter == '-') {
183             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
184             $params['modaction'] = '%'.substr($modaction, 1).'%';
185         } else {
186             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
187             $params['modaction'] = '%'.$modaction.'%';
188         }
189     }
191     if ($user) {
192         $where .= " AND l.userid = :user";
193         $params['user'] = $user;
194     }
196     if ($date) {
197         $enddate = $date + 86400;
198         $where .= " AND l.time > :date AND l.time < :enddate";
199         $params['date'] = $date;
200         $params['enddate'] = $enddate;
201     }
203     $result = array();
204     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
205     if(!empty($result['totalcount'])) {
206         $where .= " ORDER BY $order";
207         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
208     } else {
209         $result['logs'] = array();
210     }
211     return $result;
214 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
215                    $modname="", $modid=0, $modaction="", $groupid=0) {
216     global $DB, $SESSION, $USER;
217     // It is assumed that $date is the GMT time of midnight for that day,
218     // and so the next 86400 seconds worth of logs are printed.
220     /// Setup for group handling.
222     /// If the group mode is separate, and this user does not have editing privileges,
223     /// then only the user's group can be viewed.
224     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
225         if (isset($SESSION->currentgroup[$course->id])) {
226             $groupid =  $SESSION->currentgroup[$course->id];
227         } else {
228             $groupid = groups_get_all_groups($course->id, $USER->id);
229             if (is_array($groupid)) {
230                 $groupid = array_shift(array_keys($groupid));
231                 $SESSION->currentgroup[$course->id] = $groupid;
232             } else {
233                 $groupid = 0;
234             }
235         }
236     }
237     /// If this course doesn't have groups, no groupid can be specified.
238     else if (!$course->groupmode) {
239         $groupid = 0;
240     }
242     $joins = array();
243     $params = array();
245     if ($course->id != SITEID || $modid != 0) {
246         $joins[] = "l.course = :courseid";
247         $params['courseid'] = $course->id;
248     }
250     if ($modname) {
251         $joins[] = "l.module = :modname";
252         $params['modname'] = $modname;
253     }
255     if ('site_errors' === $modid) {
256         $joins[] = "( l.action='error' OR l.action='infected' )";
257     } else if ($modid) {
258         $joins[] = "l.cmid = :modid";
259         $params['modid'] = $modid;
260     }
262     if ($modaction) {
263         $firstletter = substr($modaction, 0, 1);
264         if ($firstletter == '-') {
265             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
266             $params['modaction'] = '%'.substr($modaction, 1).'%';
267         } else {
268             $joins[] = $DB->sql_like('l.action', ':modaction', false);
269             $params['modaction'] = '%'.$modaction.'%';
270         }
271     }
274     /// Getting all members of a group.
275     if ($groupid and !$user) {
276         if ($gusers = groups_get_members($groupid)) {
277             $gusers = array_keys($gusers);
278             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
279         } else {
280             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
281         }
282     }
283     else if ($user) {
284         $joins[] = "l.userid = :userid";
285         $params['userid'] = $user;
286     }
288     if ($date) {
289         $enddate = $date + 86400;
290         $joins[] = "l.time > :date AND l.time < :enddate";
291         $params['date'] = $date;
292         $params['enddate'] = $enddate;
293     }
295     $selector = implode(' AND ', $joins);
297     $totalcount = 0;  // Initialise
298     $result = array();
299     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
300     $result['totalcount'] = $totalcount;
301     return $result;
305 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
306                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
308     global $CFG, $DB, $OUTPUT;
310     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
311                        $modname, $modid, $modaction, $groupid)) {
312         echo $OUTPUT->notification("No logs found!");
313         echo $OUTPUT->footer();
314         exit;
315     }
317     $courses = array();
319     if ($course->id == SITEID) {
320         $courses[0] = '';
321         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
322             foreach ($ccc as $cc) {
323                 $courses[$cc->id] = $cc->shortname;
324             }
325         }
326     } else {
327         $courses[$course->id] = $course->shortname;
328     }
330     $totalcount = $logs['totalcount'];
331     $count=0;
332     $ldcache = array();
333     $tt = getdate(time());
334     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
336     $strftimedatetime = get_string("strftimedatetime");
338     echo "<div class=\"info\">\n";
339     print_string("displayingrecords", "", $totalcount);
340     echo "</div>\n";
342     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
344     $table = new html_table();
345     $table->classes = array('logtable','generalbox');
346     $table->align = array('right', 'left', 'left');
347     $table->head = array(
348         get_string('time'),
349         get_string('ip_address'),
350         get_string('fullname'),
351         get_string('action'),
352         get_string('info')
353     );
354     $table->data = array();
356     if ($course->id == SITEID) {
357         array_unshift($table->align, 'left');
358         array_unshift($table->head, get_string('course'));
359     }
361     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
362     if (empty($logs['logs'])) {
363         $logs['logs'] = array();
364     }
366     foreach ($logs['logs'] as $log) {
368         if (isset($ldcache[$log->module][$log->action])) {
369             $ld = $ldcache[$log->module][$log->action];
370         } else {
371             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
372             $ldcache[$log->module][$log->action] = $ld;
373         }
374         if ($ld && is_numeric($log->info)) {
375             // ugly hack to make sure fullname is shown correctly
376             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
377                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
378             } else {
379                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
380             }
381         }
383         //Filter log->info
384         $log->info = format_string($log->info);
386         // If $log->url has been trimmed short by the db size restriction
387         // code in add_to_log, keep a note so we don't add a link to a broken url
388         $tl=textlib_get_instance();
389         $brokenurl=($tl->strlen($log->url)==100 && $tl->substr($log->url,97)=='...');
391         $row = array();
392         if ($course->id == SITEID) {
393             if (empty($log->course)) {
394                 $row[] = get_string('site');
395             } else {
396                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
397             }
398         }
400         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
402         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
403         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
405         $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))));
407         $displayaction="$log->module $log->action";
408         if ($brokenurl) {
409             $row[] = $displayaction;
410         } else {
411             $link = make_log_url($log->module,$log->url);
412             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
413         }
414         $row[] = $log->info;
415         $table->data[] = $row;
416     }
418     echo html_writer::table($table);
419     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
423 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
424                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
426     global $CFG, $DB, $OUTPUT;
428     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
429                        $modname, $modid, $modaction, $groupid)) {
430         echo $OUTPUT->notification("No logs found!");
431         echo $OUTPUT->footer();
432         exit;
433     }
435     if ($course->id == SITEID) {
436         $courses[0] = '';
437         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
438             foreach ($ccc as $cc) {
439                 $courses[$cc->id] = $cc->shortname;
440             }
441         }
442     }
444     $totalcount = $logs['totalcount'];
445     $count=0;
446     $ldcache = array();
447     $tt = getdate(time());
448     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
450     $strftimedatetime = get_string("strftimedatetime");
452     echo "<div class=\"info\">\n";
453     print_string("displayingrecords", "", $totalcount);
454     echo "</div>\n";
456     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
458     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
459     echo "<tr>";
460     if ($course->id == SITEID) {
461         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
462     }
463     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
464     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
465     echo "<th class=\"c3 header\">".get_string('fullnamecourse')."</th>\n";
466     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
467     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
468     echo "</tr>\n";
470     if (empty($logs['logs'])) {
471         echo "</table>\n";
472         return;
473     }
475     $row = 1;
476     foreach ($logs['logs'] as $log) {
478         $log->info = $log->coursename;
479         $row = ($row + 1) % 2;
481         if (isset($ldcache[$log->module][$log->action])) {
482             $ld = $ldcache[$log->module][$log->action];
483         } else {
484             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
485             $ldcache[$log->module][$log->action] = $ld;
486         }
487         if (0 && $ld && !empty($log->info)) {
488             // ugly hack to make sure fullname is shown correctly
489             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
490                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
491             } else {
492                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
493             }
494         }
496         //Filter log->info
497         $log->info = format_string($log->info);
499         echo '<tr class="r'.$row.'">';
500         if ($course->id == SITEID) {
501             echo "<td class=\"r$row c0\" >\n";
502             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courses[$log->course]."</a>\n";
503             echo "</td>\n";
504         }
505         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
506              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
507         echo "<td class=\"r$row c2\" >\n";
508         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
509         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
510         echo "</td>\n";
511         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
512         echo "<td class=\"r$row c3\" >\n";
513         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
514         echo "</td>\n";
515         echo "<td class=\"r$row c4\">\n";
516         echo $log->action .': '.$log->module;
517         echo "</td>\n";;
518         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
519         echo "</tr>\n";
520     }
521     echo "</table>\n";
523     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
527 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
528                         $modid, $modaction, $groupid) {
529     global $DB;
531     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
532             get_string('fullnamecourse')."\t".get_string('action')."\t".get_string('info');
534     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
535                        $modname, $modid, $modaction, $groupid)) {
536         return false;
537     }
539     $courses = array();
541     if ($course->id == SITEID) {
542         $courses[0] = '';
543         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
544             foreach ($ccc as $cc) {
545                 $courses[$cc->id] = $cc->shortname;
546             }
547         }
548     } else {
549         $courses[$course->id] = $course->shortname;
550     }
552     $count=0;
553     $ldcache = array();
554     $tt = getdate(time());
555     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
557     $strftimedatetime = get_string("strftimedatetime");
559     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
560     $filename .= '.txt';
561     header("Content-Type: application/download\n");
562     header("Content-Disposition: attachment; filename=$filename");
563     header("Expires: 0");
564     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
565     header("Pragma: public");
567     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
568     echo $text;
570     if (empty($logs['logs'])) {
571         return true;
572     }
574     foreach ($logs['logs'] as $log) {
575         if (isset($ldcache[$log->module][$log->action])) {
576             $ld = $ldcache[$log->module][$log->action];
577         } else {
578             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
579             $ldcache[$log->module][$log->action] = $ld;
580         }
581         if ($ld && !empty($log->info)) {
582             // ugly hack to make sure fullname is shown correctly
583             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
584                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
585             } else {
586                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
587             }
588         }
590         //Filter log->info
591         $log->info = format_string($log->info);
592         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
594         $firstField = $courses[$log->course];
595         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
596         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
597         $text = implode("\t", $row);
598         echo $text." \n";
599     }
600     return true;
604 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
605                         $modid, $modaction, $groupid) {
607     global $CFG, $DB;
609     require_once("$CFG->libdir/excellib.class.php");
611     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
612                        $modname, $modid, $modaction, $groupid)) {
613         return false;
614     }
616     $courses = array();
618     if ($course->id == SITEID) {
619         $courses[0] = '';
620         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
621             foreach ($ccc as $cc) {
622                 $courses[$cc->id] = $cc->shortname;
623             }
624         }
625     } else {
626         $courses[$course->id] = $course->shortname;
627     }
629     $count=0;
630     $ldcache = array();
631     $tt = getdate(time());
632     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
634     $strftimedatetime = get_string("strftimedatetime");
636     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
637     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
638     $filename .= '.xls';
640     $workbook = new MoodleExcelWorkbook('-');
641     $workbook->send($filename);
643     $worksheet = array();
644     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
645                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
647     // Creating worksheets
648     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
649         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
650         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
651         $worksheet[$wsnumber]->set_column(1, 1, 30);
652         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
653                                     userdate(time(), $strftimedatetime));
654         $col = 0;
655         foreach ($headers as $item) {
656             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
657             $col++;
658         }
659     }
661     if (empty($logs['logs'])) {
662         $workbook->close();
663         return true;
664     }
666     $formatDate =& $workbook->add_format();
667     $formatDate->set_num_format(get_string('log_excel_date_format'));
669     $row = FIRSTUSEDEXCELROW;
670     $wsnumber = 1;
671     $myxls =& $worksheet[$wsnumber];
672     foreach ($logs['logs'] as $log) {
673         if (isset($ldcache[$log->module][$log->action])) {
674             $ld = $ldcache[$log->module][$log->action];
675         } else {
676             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
677             $ldcache[$log->module][$log->action] = $ld;
678         }
679         if ($ld && !empty($log->info)) {
680             // ugly hack to make sure fullname is shown correctly
681             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
682                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
683             } else {
684                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
685             }
686         }
688         // Filter log->info
689         $log->info = format_string($log->info);
690         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
692         if ($nroPages>1) {
693             if ($row > EXCELROWS) {
694                 $wsnumber++;
695                 $myxls =& $worksheet[$wsnumber];
696                 $row = FIRSTUSEDEXCELROW;
697             }
698         }
700         $myxls->write($row, 0, $courses[$log->course], '');
701         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
702         $myxls->write($row, 2, $log->ip, '');
703         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
704         $myxls->write($row, 3, $fullname, '');
705         $myxls->write($row, 4, $log->module.' '.$log->action, '');
706         $myxls->write($row, 5, $log->info, '');
708         $row++;
709     }
711     $workbook->close();
712     return true;
715 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
716                         $modid, $modaction, $groupid) {
718     global $CFG, $DB;
720     require_once("$CFG->libdir/odslib.class.php");
722     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
723                        $modname, $modid, $modaction, $groupid)) {
724         return false;
725     }
727     $courses = array();
729     if ($course->id == SITEID) {
730         $courses[0] = '';
731         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
732             foreach ($ccc as $cc) {
733                 $courses[$cc->id] = $cc->shortname;
734             }
735         }
736     } else {
737         $courses[$course->id] = $course->shortname;
738     }
740     $count=0;
741     $ldcache = array();
742     $tt = getdate(time());
743     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
745     $strftimedatetime = get_string("strftimedatetime");
747     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
748     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
749     $filename .= '.ods';
751     $workbook = new MoodleODSWorkbook('-');
752     $workbook->send($filename);
754     $worksheet = array();
755     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
756                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
758     // Creating worksheets
759     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
760         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
761         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
762         $worksheet[$wsnumber]->set_column(1, 1, 30);
763         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
764                                     userdate(time(), $strftimedatetime));
765         $col = 0;
766         foreach ($headers as $item) {
767             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
768             $col++;
769         }
770     }
772     if (empty($logs['logs'])) {
773         $workbook->close();
774         return true;
775     }
777     $formatDate =& $workbook->add_format();
778     $formatDate->set_num_format(get_string('log_excel_date_format'));
780     $row = FIRSTUSEDEXCELROW;
781     $wsnumber = 1;
782     $myxls =& $worksheet[$wsnumber];
783     foreach ($logs['logs'] as $log) {
784         if (isset($ldcache[$log->module][$log->action])) {
785             $ld = $ldcache[$log->module][$log->action];
786         } else {
787             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
788             $ldcache[$log->module][$log->action] = $ld;
789         }
790         if ($ld && !empty($log->info)) {
791             // ugly hack to make sure fullname is shown correctly
792             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
793                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
794             } else {
795                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
796             }
797         }
799         // Filter log->info
800         $log->info = format_string($log->info);
801         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
803         if ($nroPages>1) {
804             if ($row > EXCELROWS) {
805                 $wsnumber++;
806                 $myxls =& $worksheet[$wsnumber];
807                 $row = FIRSTUSEDEXCELROW;
808             }
809         }
811         $myxls->write_string($row, 0, $courses[$log->course]);
812         $myxls->write_date($row, 1, $log->time);
813         $myxls->write_string($row, 2, $log->ip);
814         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
815         $myxls->write_string($row, 3, $fullname);
816         $myxls->write_string($row, 4, $log->module.' '.$log->action);
817         $myxls->write_string($row, 5, $log->info);
819         $row++;
820     }
822     $workbook->close();
823     return true;
827 function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
828     global $CFG, $USER;
829     if (empty($CFG->gdversion)) {
830         echo "(".get_string("gdneed").")";
831     } else {
832         // MDL-10818, do not display broken graph when user has no permission to view graph
833         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
834             ($course->showreports and $USER->id == $userid)) {
835             echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
836                  '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
837         }
838     }
842 function print_overview($courses, array $remote_courses=array()) {
843     global $CFG, $USER, $DB, $OUTPUT;
845     $htmlarray = array();
846     if ($modules = $DB->get_records('modules')) {
847         foreach ($modules as $mod) {
848             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
849                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
850                 $fname = $mod->name.'_print_overview';
851                 if (function_exists($fname)) {
852                     $fname($courses,$htmlarray);
853                 }
854             }
855         }
856     }
857     foreach ($courses as $course) {
858         echo $OUTPUT->box_start('coursebox');
859         $attributes = array('title' => s($course->fullname));
860         if (empty($course->visible)) {
861             $attributes['class'] = 'dimmed';
862         }
863         echo $OUTPUT->heading(html_writer::link(
864             new moodle_url('/course/view.php', array('id' => $course->id)), format_string($course->fullname), $attributes), 3);
865         if (array_key_exists($course->id,$htmlarray)) {
866             foreach ($htmlarray[$course->id] as $modname => $html) {
867                 echo $html;
868             }
869         }
870         echo $OUTPUT->box_end();
871     }
873     if (!empty($remote_courses)) {
874         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
875     }
876     foreach ($remote_courses as $course) {
877         echo $OUTPUT->box_start('coursebox');
878         $attributes = array('title' => s($course->fullname));
879         echo $OUTPUT->heading(html_writer::link(
880             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
881             format_string($course->shortname),
882             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
883         echo $OUTPUT->box_end();
884     }
888 /**
889  * This function trawls through the logs looking for
890  * anything new since the user's last login
891  */
892 function print_recent_activity($course) {
893     // $course is an object
894     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
896     $context = get_context_instance(CONTEXT_COURSE, $course->id);
898     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
900     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
902     if (!isguestuser()) {
903         if (!empty($USER->lastcourseaccess[$course->id])) {
904             if ($USER->lastcourseaccess[$course->id] > $timestart) {
905                 $timestart = $USER->lastcourseaccess[$course->id];
906             }
907         }
908     }
910     echo '<div class="activitydate">';
911     echo get_string('activitysince', '', userdate($timestart));
912     echo '</div>';
913     echo '<div class="activityhead">';
915     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
917     echo "</div>\n";
919     $content = false;
921 /// Firstly, have there been any new enrolments?
923     $users = get_recent_enrolments($course->id, $timestart);
925     //Accessibility: new users now appear in an <OL> list.
926     if ($users) {
927         echo '<div class="newusers">';
928         echo $OUTPUT->heading(get_string("newusers").':', 3);
929         $content = true;
930         echo "<ol class=\"list\">\n";
931         foreach ($users as $user) {
932             $fullname = fullname($user, $viewfullnames);
933             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
934         }
935         echo "</ol>\n</div>\n";
936     }
938 /// Next, have there been any modifications to the course structure?
940     $modinfo =& get_fast_modinfo($course);
942     $changelist = array();
944     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
945                                             module = 'course' AND
946                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
947                                     array($timestart, $course->id), "id ASC");
949     if ($logs) {
950         $actions  = array('add mod', 'update mod', 'delete mod');
951         $newgones = array(); // added and later deleted items
952         foreach ($logs as $key => $log) {
953             if (!in_array($log->action, $actions)) {
954                 continue;
955             }
956             $info = explode(' ', $log->info);
958             // note: in most cases I replaced hardcoding of label with use of
959             // $cm->has_view() but it was not possible to do this here because
960             // we don't necessarily have the $cm for it
961             if ($info[0] == 'label') {     // Labels are ignored in recent activity
962                 continue;
963             }
965             if (count($info) != 2) {
966                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
967                 continue;
968             }
970             $modname    = $info[0];
971             $instanceid = $info[1];
973             if ($log->action == 'delete mod') {
974                 // unfortunately we do not know if the mod was visible
975                 if (!array_key_exists($log->info, $newgones)) {
976                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
977                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
978                 }
979             } else {
980                 if (!isset($modinfo->instances[$modname][$instanceid])) {
981                     if ($log->action == 'add mod') {
982                         // do not display added and later deleted activities
983                         $newgones[$log->info] = true;
984                     }
985                     continue;
986                 }
987                 $cm = $modinfo->instances[$modname][$instanceid];
988                 if (!$cm->uservisible) {
989                     continue;
990                 }
992                 if ($log->action == 'add mod') {
993                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
994                     $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>");
996                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
997                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
998                     $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>");
999                 }
1000             }
1001         }
1002     }
1004     if (!empty($changelist)) {
1005         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1006         $content = true;
1007         foreach ($changelist as $changeinfo => $change) {
1008             echo '<p class="activity">'.$change['text'].'</p>';
1009         }
1010     }
1012 /// Now display new things from each module
1014     $usedmodules = array();
1015     foreach($modinfo->cms as $cm) {
1016         if (isset($usedmodules[$cm->modname])) {
1017             continue;
1018         }
1019         if (!$cm->uservisible) {
1020             continue;
1021         }
1022         $usedmodules[$cm->modname] = $cm->modname;
1023     }
1025     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1026         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1027             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1028             $print_recent_activity = $modname.'_print_recent_activity';
1029             if (function_exists($print_recent_activity)) {
1030                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1031                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1032             }
1033         } else {
1034             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1035         }
1036     }
1038     if (! $content) {
1039         echo '<p class="message">'.get_string('nothingnew').'</p>';
1040     }
1043 /**
1044  * For a given course, returns an array of course activity objects
1045  * Each item in the array contains he following properties:
1046  */
1047 function get_array_of_activities($courseid) {
1048 //  cm - course module id
1049 //  mod - name of the module (eg forum)
1050 //  section - the number of the section (eg week or topic)
1051 //  name - the name of the instance
1052 //  visible - is the instance visible or not
1053 //  groupingid - grouping id
1054 //  groupmembersonly - is this instance visible to group members only
1055 //  extra - contains extra string to include in any link
1056     global $CFG, $DB;
1057     if(!empty($CFG->enableavailability)) {
1058         require_once($CFG->libdir.'/conditionlib.php');
1059     }
1061     $course = $DB->get_record('course', array('id'=>$courseid));
1063     if (empty($course)) {
1064         throw new moodle_exception('courseidnotfound');
1065     }
1067     $mod = array();
1069     $rawmods = get_course_mods($courseid);
1070     if (empty($rawmods)) {
1071         return $mod; // always return array
1072     }
1074     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1075        foreach ($sections as $section) {
1076            if (!empty($section->sequence)) {
1077                $sequence = explode(",", $section->sequence);
1078                foreach ($sequence as $seq) {
1079                    if (empty($rawmods[$seq])) {
1080                        continue;
1081                    }
1082                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1083                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1084                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1085                    $mod[$seq]->section          = $section->section;
1086                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1087                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1088                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1089                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1090                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1091                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1092                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1093                    $mod[$seq]->extra            = "";
1094                    if(!empty($CFG->enableavailability)) {
1095                        condition_info::fill_availability_conditions($rawmods[$seq]);
1096                        $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1097                        $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1098                        $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1099                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1100                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1101                    }
1103                    $modname = $mod[$seq]->mod;
1104                    $functionname = $modname."_get_coursemodule_info";
1106                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1107                        continue;
1108                    }
1110                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1112                    if (function_exists($functionname)) {
1113                        if ($info = $functionname($rawmods[$seq])) {
1114                            if (!empty($info->icon)) {
1115                                $mod[$seq]->icon = $info->icon;
1116                            }
1117                            if (!empty($info->iconcomponent)) {
1118                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1119                            }
1120                            if (!empty($info->name)) {
1121                                $mod[$seq]->name = $info->name;
1122                            }
1123                            if ($info instanceof cached_cm_info) {
1124                                // When using cached_cm_info you can include three new fields
1125                                // that aren't available for legacy code
1126                                if (!empty($info->content)) {
1127                                    $mod[$seq]->content = $info->content;
1128                                }
1129                                if (!empty($info->extraclasses)) {
1130                                    $mod[$seq]->extraclasses = $info->extraclasses;
1131                                }
1132                                if (!empty($info->onclick)) {
1133                                    $mod[$seq]->onclick = $info->onclick;
1134                                }
1135                                if (!empty($info->customdata)) {
1136                                    $mod[$seq]->customdata = $info->customdata;
1137                                }
1138                            } else {
1139                                // When using a stdclass, the (horrible) deprecated ->extra field
1140                                // is available for BC
1141                                if (!empty($info->extra)) {
1142                                    $mod[$seq]->extra = $info->extra;
1143                                }
1144                            }
1145                        }
1146                    }
1147                    if (!isset($mod[$seq]->name)) {
1148                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1149                    }
1151                    // Minimise the database size by unsetting default options when they are
1152                    // 'empty'. This list corresponds to code in the cm_info constructor.
1153                    foreach(array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1154                            'indent', 'completion', 'extra', 'extraclasses', 'onclick', 'content',
1155                            'icon', 'iconcomponent', 'customdata', 'availablefrom', 'availableuntil',
1156                            'conditionscompletion', 'conditionsgrade') as $property) {
1157                        if (property_exists($mod[$seq], $property) &&
1158                                empty($mod[$seq]->{$property})) {
1159                            unset($mod[$seq]->{$property});
1160                        }
1161                    }
1162                }
1163             }
1164         }
1165     }
1166     return $mod;
1170 /**
1171  * Returns a number of useful structures for course displays
1172  */
1173 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1174     global $CFG, $DB, $COURSE;
1176     $mods          = array();    // course modules indexed by id
1177     $modnames      = array();    // all course module names (except resource!)
1178     $modnamesplural= array();    // all course module names (plural form)
1179     $modnamesused  = array();    // course module names used
1181     if ($allmods = $DB->get_records("modules")) {
1182         foreach ($allmods as $mod) {
1183             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1184                 continue;
1185             }
1186             if ($mod->visible) {
1187                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1188                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1189             }
1190         }
1191         textlib_get_instance()->asort($modnames);
1192     } else {
1193         print_error("nomodules", 'debug');
1194     }
1196     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1197     $modinfo = get_fast_modinfo($course);
1199     if ($rawmods=$modinfo->cms) {
1200         foreach($rawmods as $mod) {    // Index the mods
1201             if (empty($modnames[$mod->modname])) {
1202                 continue;
1203             }
1204             $mods[$mod->id] = $mod;
1205             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1206             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1207                 continue;
1208             }
1209             // Check groupings
1210             if (!groups_course_module_visible($mod)) {
1211                 continue;
1212             }
1213             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1214         }
1215         if ($modnamesused) {
1216             textlib_get_instance()->asort($modnamesused);
1217         }
1218     }
1221 /**
1222  * Returns an array of sections for the requested course id
1223  *
1224  * This function stores the sections against the course id within a staticvar encase
1225  * of subsequent requests. This is used all over + in some standard libs and course
1226  * format callbacks so subsequent requests are a reality.
1227  *
1228  * @staticvar array $coursesections
1229  * @param int $courseid
1230  * @return array Array of sections
1231  */
1232 function get_all_sections($courseid) {
1233     global $DB;
1234     static $coursesections = array();
1235     if (!array_key_exists($courseid, $coursesections)) {
1236         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1237                            "section, id, course, name, summary, summaryformat, sequence, visible");
1238     }
1239     return $coursesections[$courseid];
1242 function course_set_display($courseid, $display=0) {
1243     global $USER, $DB;
1245     if ($display == "all" or empty($display)) {
1246         $display = 0;
1247     }
1249     if (!isloggedin() or isguestuser()) {
1250         //do not store settings in db for guests
1251     } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
1252         $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
1253     } else {
1254         $record = new stdClass();
1255         $record->userid = $USER->id;
1256         $record->course = $courseid;
1257         $record->display = $display;
1258         $DB->insert_record("course_display", $record);
1259     }
1261     return $USER->display[$courseid] = $display;  // Note: = not ==
1264 /**
1265  * For a given course section, marks it visible or hidden,
1266  * and does the same for every activity in that section
1267  */
1268 function set_section_visible($courseid, $sectionnumber, $visibility) {
1269     global $DB;
1271     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1272         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1273         if (!empty($section->sequence)) {
1274             $modules = explode(",", $section->sequence);
1275             foreach ($modules as $moduleid) {
1276                 set_coursemodule_visible($moduleid, $visibility, true);
1277             }
1278         }
1279         rebuild_course_cache($courseid);
1280     }
1283 /**
1284  * Obtains shared data that is used in print_section when displaying a
1285  * course-module entry.
1286  *
1287  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1288  *
1289  * This data is also used in other areas of the code.
1290  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1291  * @param object $course Moodle course object
1292  * @return array An array with the following values in this order:
1293  *   $content (optional extra content for after link),
1294  *   $instancename (text of link)
1295  */
1296 function get_print_section_cm_text(cm_info $cm, $course) {
1297     global $OUTPUT;
1299     // Get course context
1300     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1302     // Get content from modinfo if specified. Content displays either
1303     // in addition to the standard link (below), or replaces it if
1304     // the link is turned off by setting ->url to null.
1305     if (($content = $cm->get_content()) !== '') {
1306         $labelformatoptions = new stdClass();
1307         $labelformatoptions->noclean = true;
1308         $labelformatoptions->overflowdiv = true;
1309         $labelformatoptions->context = $coursecontext;
1310         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1311     } else {
1312         $content = '';
1313     }
1315     $stringoptions = new stdClass;
1316     $stringoptions->context = $coursecontext;
1317     $instancename = format_string($cm->name, true,  $stringoptions);
1318     return array($content, $instancename);
1321 /**
1322  * Prints a section full of activity modules
1323  */
1324 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1325     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1327     static $initialised;
1329     static $groupbuttons;
1330     static $groupbuttonslink;
1331     static $isediting;
1332     static $ismoving;
1333     static $strmovehere;
1334     static $strmovefull;
1335     static $strunreadpostsone;
1336     static $groupings;
1337     static $modulenames;
1339     if (!isset($initialised)) {
1340         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1341         $groupbuttonslink = (!$course->groupmodeforce);
1342         $isediting        = $PAGE->user_is_editing();
1343         $ismoving         = $isediting && ismoving($course->id);
1344         if ($ismoving) {
1345             $strmovehere  = get_string("movehere");
1346             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1347         }
1348         $modulenames      = array();
1349         $initialised = true;
1350     }
1352     $tl = textlib_get_instance();
1354     $modinfo = get_fast_modinfo($course);
1355     $completioninfo = new completion_info($course);
1357     //Accessibility: replace table with list <ul>, but don't output empty list.
1358     if (!empty($section->sequence)) {
1360         // Fix bug #5027, don't want style=\"width:$width\".
1361         echo "<ul class=\"section img-text\">\n";
1362         $sectionmods = explode(",", $section->sequence);
1364         foreach ($sectionmods as $modnumber) {
1365             if (empty($mods[$modnumber])) {
1366                 continue;
1367             }
1369             /**
1370              * @var cm_info
1371              */
1372             $mod = $mods[$modnumber];
1374             if ($ismoving and $mod->id == $USER->activitycopy) {
1375                 // do not display moving mod
1376                 continue;
1377             }
1379             if (isset($modinfo->cms[$modnumber])) {
1380                 // We can continue (because it will not be displayed at all)
1381                 // if:
1382                 // 1) The activity is not visible to users
1383                 // and
1384                 // 2a) The 'showavailability' option is not set (if that is set,
1385                 //     we need to display the activity so we can show
1386                 //     availability info)
1387                 // or
1388                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1389                 //     hidden in a way that leaves no info, such as using the
1390                 //     eye icon.
1391                 if (!$modinfo->cms[$modnumber]->uservisible &&
1392                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1393                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1394                     // visibility shortcut
1395                     continue;
1396                 }
1397             } else {
1398                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1399                     // module not installed
1400                     continue;
1401                 }
1402                 if (!coursemodule_visible_for_user($mod) &&
1403                     empty($mod->showavailability)) {
1404                     // full visibility check
1405                     continue;
1406                 }
1407             }
1409             if (!isset($modulenames[$mod->modname])) {
1410                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1411             }
1412             $modulename = $modulenames[$mod->modname];
1414             // In some cases the activity is visible to user, but it is
1415             // dimmed. This is done if viewhiddenactivities is true and if:
1416             // 1. the activity is not visible, or
1417             // 2. the activity has dates set which do not include current, or
1418             // 3. the activity has any other conditions set (regardless of whether
1419             //    current user meets them)
1420             $canviewhidden = has_capability(
1421                 'moodle/course:viewhiddenactivities',
1422                 get_context_instance(CONTEXT_MODULE, $mod->id));
1423             $accessiblebutdim = false;
1424             if ($canviewhidden) {
1425                 $accessiblebutdim = !$mod->visible;
1426                 if (!empty($CFG->enableavailability)) {
1427                     $accessiblebutdim = $accessiblebutdim ||
1428                         $mod->availablefrom > time() ||
1429                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1430                         count($mod->conditionsgrade) > 0 ||
1431                         count($mod->conditionscompletion) > 0;
1432                 }
1433             }
1435             $liclasses = array();
1436             $liclasses[] = 'activity';
1437             $liclasses[] = $mod->modname;
1438             $liclasses[] = 'modtype_'.$mod->modname;
1439             $extraclasses = $mod->get_extra_classes();
1440             if ($extraclasses) {
1441                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1442             }
1443             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1444             if ($ismoving) {
1445                 echo '<a title="'.$strmovefull.'"'.
1446                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1447                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1448                      ' alt="'.$strmovehere.'" /></a><br />
1449                      ';
1450             }
1452             $classes = array('mod-indent');
1453             if (!empty($mod->indent)) {
1454                 $classes[] = 'mod-indent-'.$mod->indent;
1455                 if ($mod->indent > 15) {
1456                     $classes[] = 'mod-indent-huge';
1457                 }
1458             }
1459             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1461             // Get data about this course-module
1462             list($content, $instancename) =
1463                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1465             //Accessibility: for files get description via icon, this is very ugly hack!
1466             $altname = '';
1467             $altname = $mod->modfullname;
1468             if (!empty($customicon)) {
1469                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1470                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1471                     $mimetype = mimeinfo_from_icon('type', $customicon);
1472                     $altname = get_mimetype_description($mimetype);
1473                 }
1474             }
1475             // Avoid unnecessary duplication: if e.g. a forum name already
1476             // includes the word forum (or Forum, etc) then it is unhelpful
1477             // to include that in the accessible description that is added.
1478             if (false !== strpos($tl->strtolower($instancename),
1479                     $tl->strtolower($altname))) {
1480                 $altname = '';
1481             }
1482             // File type after name, for alphabetic lists (screen reader).
1483             if ($altname) {
1484                 $altname = get_accesshide(' '.$altname);
1485             }
1487             // We may be displaying this just in order to show information
1488             // about visibility, without the actual link
1489             $contentpart = '';
1490             if ($mod->uservisible) {
1491                 // Nope - in this case the link is fully working for user
1492                 $linkclasses = '';
1493                 $textclasses = '';
1494                 if ($accessiblebutdim) {
1495                     $linkclasses .= ' dimmed';
1496                     $textclasses .= ' dimmed_text';
1497                     $accesstext = '<span class="accesshide">'.
1498                         get_string('hiddenfromstudents').': </span>';
1499                 } else {
1500                     $accesstext = '';
1501                 }
1502                 if ($linkclasses) {
1503                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1504                 } else {
1505                     $linkcss = '';
1506                 }
1507                 if ($textclasses) {
1508                     $textcss = 'class="' . trim($textclasses) . '" ';
1509                 } else {
1510                     $textcss = '';
1511                 }
1513                 // Get on-click attribute value if specified
1514                 $onclick = $mod->get_on_click();
1515                 if ($onclick) {
1516                     $onclick = ' onclick="' . $onclick . '"';
1517                 }
1519                 if ($url = $mod->get_url()) {
1520                     // Display link itself
1521                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1522                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1523                             '" class="activityicon" alt="' .
1524                             $modulename . '" /> ' .
1525                             $accesstext . '<span class="instancename">' .
1526                             $instancename . $altname . '</span></a>';
1528                     // If specified, display extra content after link
1529                     if ($content) {
1530                         $contentpart = '<div class="contentafterlink' .
1531                                 trim($textclasses) . '">' . $content . '</div>';
1532                     }
1533                 } else {
1534                     // No link, so display only content
1535                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1536                             $accesstext . $content . '</div>';
1537                 }
1539                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1540                     if (!isset($groupings)) {
1541                         $groupings = groups_get_all_groupings($course->id);
1542                     }
1543                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1544                 }
1545             } else {
1546                 $textclasses = $extraclasses;
1547                 $textclasses .= ' dimmed_text';
1548                 if ($textclasses) {
1549                     $textcss = 'class="' . trim($textclasses) . '" ';
1550                 } else {
1551                     $textcss = '';
1552                 }
1553                 $accesstext = '<span class="accesshide">' .
1554                         get_string('notavailableyet', 'condition') .
1555                         ': </span>';
1557                 if ($url = $mod->get_url()) {
1558                     // Display greyed-out text of link
1559                     echo '<div ' . $textcss . $mod->extra .
1560                             ' >' . '<img src="' . $mod->get_icon_url() .
1561                             '" class="activityicon" alt="' .
1562                             $modulename .
1563                             '" /> <span>'. $instancename . $altname .
1564                             '</span></div>';
1566                     // Do not display content after link when it is greyed out like this.
1567                 } else {
1568                     // No link, so display only content (also greyed)
1569                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1570                             $accesstext . $content . '</div>';
1571                 }
1572             }
1574             // Module can put text after the link (e.g. forum unread)
1575             echo $mod->get_after_link();
1577             if ($isediting) {
1578                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1579                     if (! $mod->groupmodelink = $groupbuttonslink) {
1580                         $mod->groupmode = $course->groupmode;
1581                     }
1583                 } else {
1584                     $mod->groupmode = false;
1585                 }
1586                 echo '&nbsp;&nbsp;';
1587                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1588                 echo $mod->get_after_edit_icons();
1589             }
1591             // Completion
1592             $completion = $hidecompletion
1593                 ? COMPLETION_TRACKING_NONE
1594                 : $completioninfo->is_enabled($mod);
1595             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1596                 !isguestuser() && $mod->uservisible) {
1597                 $completiondata = $completioninfo->get_data($mod,true);
1598                 $completionicon = '';
1599                 if ($isediting) {
1600                     switch ($completion) {
1601                         case COMPLETION_TRACKING_MANUAL :
1602                             $completionicon = 'manual-enabled'; break;
1603                         case COMPLETION_TRACKING_AUTOMATIC :
1604                             $completionicon = 'auto-enabled'; break;
1605                         default: // wtf
1606                     }
1607                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1608                     switch($completiondata->completionstate) {
1609                         case COMPLETION_INCOMPLETE:
1610                             $completionicon = 'manual-n'; break;
1611                         case COMPLETION_COMPLETE:
1612                             $completionicon = 'manual-y'; break;
1613                     }
1614                 } else { // Automatic
1615                     switch($completiondata->completionstate) {
1616                         case COMPLETION_INCOMPLETE:
1617                             $completionicon = 'auto-n'; break;
1618                         case COMPLETION_COMPLETE:
1619                             $completionicon = 'auto-y'; break;
1620                         case COMPLETION_COMPLETE_PASS:
1621                             $completionicon = 'auto-pass'; break;
1622                         case COMPLETION_COMPLETE_FAIL:
1623                             $completionicon = 'auto-fail'; break;
1624                     }
1625                 }
1626                 if ($completionicon) {
1627                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1628                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1629                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1630                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1631                         $newstate =
1632                             $completiondata->completionstate==COMPLETION_COMPLETE
1633                             ? COMPLETION_INCOMPLETE
1634                             : COMPLETION_COMPLETE;
1635                         // In manual mode the icon is a toggle form...
1637                         // If this completion state is used by the
1638                         // conditional activities system, we need to turn
1639                         // off the JS.
1640                         if (!empty($CFG->enableavailability) &&
1641                             condition_info::completion_value_used_as_condition($course, $mod)) {
1642                             $extraclass = ' preventjs';
1643                         } else {
1644                             $extraclass = '';
1645                         }
1646                         echo "
1647 <form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>
1648 <input type='hidden' name='id' value='{$mod->id}' />
1649 <input type='hidden' name='sesskey' value='".sesskey()."' />
1650 <input type='hidden' name='completionstate' value='$newstate' />
1651 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1652 </div></form>";
1653                     } else {
1654                         // In auto mode, or when editing, the icon is just an image
1655                         echo "<span class='autocompletion'>";
1656                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1657                     }
1658                 }
1659             }
1661             // Display the content (if any) at this part of the html
1662             echo $contentpart;
1664             // Show availability information (for someone who isn't allowed to
1665             // see the activity itself, or for staff)
1666             if (!$mod->uservisible) {
1667                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1668             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1669                 $ci = new condition_info($mod);
1670                 $fullinfo = $ci->get_full_information();
1671                 if($fullinfo) {
1672                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1673                         ? 'userrestriction_visible'
1674                         : 'userrestriction_hidden','condition',
1675                         $fullinfo).'</div>';
1676                 }
1677             }
1679             echo html_writer::end_tag('div');
1680             echo html_writer::end_tag('li')."\n";
1681         }
1683     } elseif ($ismoving) {
1684         echo "<ul class=\"section\">\n";
1685     }
1687     if ($ismoving) {
1688         echo '<li><a title="'.$strmovefull.'"'.
1689              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1690              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1691              ' alt="'.$strmovehere.'" /></a></li>
1692              ';
1693     }
1694     if (!empty($section->sequence) || $ismoving) {
1695         echo "</ul><!--class='section'-->\n\n";
1696     }
1699 /**
1700  * Prints the menus to add activities and resources.
1701  */
1702 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1703     global $CFG, $OUTPUT;
1705     // check to see if user can add menus
1706     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1707         return false;
1708     }
1710     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1712     $resources = array();
1713     $activities = array();
1715     foreach($modnames as $modname=>$modnamestr) {
1716         if (!course_allowed_module($course, $modname)) {
1717             continue;
1718         }
1720         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1721         if (!file_exists($libfile)) {
1722             continue;
1723         }
1724         include_once($libfile);
1725         $gettypesfunc =  $modname.'_get_types';
1726         if (function_exists($gettypesfunc)) {
1727             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1728             if ($types = $gettypesfunc()) {
1729                 $menu = array();
1730                 $atype = null;
1731                 $groupname = null;
1732                 foreach($types as $type) {
1733                     if ($type->typestr === '--') {
1734                         continue;
1735                     }
1736                     if (strpos($type->typestr, '--') === 0) {
1737                         $groupname = str_replace('--', '', $type->typestr);
1738                         continue;
1739                     }
1740                     $type->type = str_replace('&amp;', '&', $type->type);
1741                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1742                         $atype = MOD_CLASS_RESOURCE;
1743                     }
1744                     $menu[$urlbase.$type->type] = $type->typestr;
1745                 }
1746                 if (!is_null($groupname)) {
1747                     if ($atype == MOD_CLASS_RESOURCE) {
1748                         $resources[] = array($groupname=>$menu);
1749                     } else {
1750                         $activities[] = array($groupname=>$menu);
1751                     }
1752                 } else {
1753                     if ($atype == MOD_CLASS_RESOURCE) {
1754                         $resources = array_merge($resources, $menu);
1755                     } else {
1756                         $activities = array_merge($activities, $menu);
1757                     }
1758                 }
1759             }
1760         } else {
1761             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1762             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1763                 $resources[$urlbase.$modname] = $modnamestr;
1764             } else {
1765                 // all other archetypes are considered activity
1766                 $activities[$urlbase.$modname] = $modnamestr;
1767             }
1768         }
1769     }
1771     $straddactivity = get_string('addactivity');
1772     $straddresource = get_string('addresource');
1774     $output  = '<div class="section_add_menus">';
1776     if (!$vertical) {
1777         $output .= '<div class="horizontal">';
1778     }
1780     if (!empty($resources)) {
1781         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1782         $select->set_help_icon('resources');
1783         $output .= $OUTPUT->render($select);
1784     }
1786     if (!empty($activities)) {
1787         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1788         $select->set_help_icon('activities');
1789         $output .= $OUTPUT->render($select);
1790     }
1792     if (!$vertical) {
1793         $output .= '</div>';
1794     }
1796     $output .= '</div>';
1798     if ($return) {
1799         return $output;
1800     } else {
1801         echo $output;
1802     }
1805 /**
1806  * Return the course category context for the category with id $categoryid, except
1807  * that if $categoryid is 0, return the system context.
1808  *
1809  * @param integer $categoryid a category id or 0.
1810  * @return object the corresponding context
1811  */
1812 function get_category_or_system_context($categoryid) {
1813     if ($categoryid) {
1814         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1815     } else {
1816         return get_context_instance(CONTEXT_SYSTEM);
1817     }
1820 /**
1821  * Rebuilds the cached list of course activities stored in the database
1822  * @param int $courseid - id of course to rebuild, empty means all
1823  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1824  */
1825 function rebuild_course_cache($courseid=0, $clearonly=false) {
1826     global $COURSE, $DB, $OUTPUT;
1828     // Destroy navigation caches
1829     navigation_cache::destroy_volatile_caches();
1831     if ($clearonly) {
1832         if (empty($courseid)) {
1833             $courseselect = array();
1834         } else {
1835             $courseselect = array('id'=>$courseid);
1836         }
1837         $DB->set_field('course', 'modinfo', null, $courseselect);
1838         // update cached global COURSE too ;-)
1839         if ($courseid == $COURSE->id or empty($courseid)) {
1840             $COURSE->modinfo = null;
1841         }
1842         // reset the fast modinfo cache
1843         $reset = 'reset';
1844         get_fast_modinfo($reset);
1845         return;
1846     }
1848     if ($courseid) {
1849         $select = array('id'=>$courseid);
1850     } else {
1851         $select = array();
1852         @set_time_limit(0);  // this could take a while!   MDL-10954
1853     }
1855     $rs = $DB->get_recordset("course", $select,'','id,fullname');
1856     foreach ($rs as $course) {
1857         $modinfo = serialize(get_array_of_activities($course->id));
1858         $DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id));
1859         // update cached global COURSE too ;-)
1860         if ($course->id == $COURSE->id) {
1861             $COURSE->modinfo = $modinfo;
1862         }
1863     }
1864     $rs->close();
1865     // reset the fast modinfo cache
1866     $reset = 'reset';
1867     get_fast_modinfo($reset);
1870 /**
1871  * Gets the child categories of a given courses category. Uses a static cache
1872  * to make repeat calls efficient.
1873  *
1874  * @param int $parentid the id of a course category.
1875  * @return array all the child course categories.
1876  */
1877 function get_child_categories($parentid) {
1878     static $allcategories = null;
1880     // only fill in this variable the first time
1881     if (null == $allcategories) {
1882         $allcategories = array();
1884         $categories = get_categories();
1885         foreach ($categories as $category) {
1886             if (empty($allcategories[$category->parent])) {
1887                 $allcategories[$category->parent] = array();
1888             }
1889             $allcategories[$category->parent][] = $category;
1890         }
1891     }
1893     if (empty($allcategories[$parentid])) {
1894         return array();
1895     } else {
1896         return $allcategories[$parentid];
1897     }
1900 /**
1901  * This function recursively travels the categories, building up a nice list
1902  * for display. It also makes an array that list all the parents for each
1903  * category.
1904  *
1905  * For example, if you have a tree of categories like:
1906  *   Miscellaneous (id = 1)
1907  *      Subcategory (id = 2)
1908  *         Sub-subcategory (id = 4)
1909  *   Other category (id = 3)
1910  * Then after calling this function you will have
1911  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1912  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1913  *      3 => 'Other category');
1914  * $parents = array(2 => array(1), 4 => array(1, 2));
1915  *
1916  * If you specify $requiredcapability, then only categories where the current
1917  * user has that capability will be added to $list, although all categories
1918  * will still be added to $parents, and if you only have $requiredcapability
1919  * in a child category, not the parent, then the child catgegory will still be
1920  * included.
1921  *
1922  * If you specify the option $excluded, then that category, and all its children,
1923  * are omitted from the tree. This is useful when you are doing something like
1924  * moving categories, where you do not want to allow people to move a category
1925  * to be the child of itself.
1926  *
1927  * @param array $list For output, accumulates an array categoryid => full category path name
1928  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1929  * @param string/array $requiredcapability if given, only categories where the current
1930  *      user has this capability will be added to $list. Can also be an array of capabilities,
1931  *      in which case they are all required.
1932  * @param integer $excludeid Omit this category and its children from the lists built.
1933  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1934  * @param string $path For internal use, as part of recursive calls.
1935  */
1936 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1937         $excludeid = 0, $category = NULL, $path = "") {
1939     // initialize the arrays if needed
1940     if (!is_array($list)) {
1941         $list = array();
1942     }
1943     if (!is_array($parents)) {
1944         $parents = array();
1945     }
1947     if (empty($category)) {
1948         // Start at the top level.
1949         $category = new stdClass;
1950         $category->id = 0;
1951     } else {
1952         // This is the excluded category, don't include it.
1953         if ($excludeid > 0 && $excludeid == $category->id) {
1954             return;
1955         }
1957         // Update $path.
1958         if ($path) {
1959             $path = $path.' / '.format_string($category->name);
1960         } else {
1961             $path = format_string($category->name);
1962         }
1964         // Add this category to $list, if the permissions check out.
1965         if (empty($requiredcapability)) {
1966             $list[$category->id] = $path;
1968         } else {
1969             ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1970             $requiredcapability = (array)$requiredcapability;
1971             if (has_all_capabilities($requiredcapability, $category->context)) {
1972                 $list[$category->id] = $path;
1973             }
1974         }
1975     }
1977     // Add all the children recursively, while updating the parents array.
1978     if ($categories = get_child_categories($category->id)) {
1979         foreach ($categories as $cat) {
1980             if (!empty($category->id)) {
1981                 if (isset($parents[$category->id])) {
1982                     $parents[$cat->id]   = $parents[$category->id];
1983                 }
1984                 $parents[$cat->id][] = $category->id;
1985             }
1986             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1987         }
1988     }
1991 /**
1992  * This function generates a structured array of courses and categories.
1993  *
1994  * The depth of categories is limited by $CFG->maxcategorydepth however there
1995  * is no limit on the number of courses!
1996  *
1997  * Suitable for use with the course renderers course_category_tree method:
1998  * $renderer = $PAGE->get_renderer('core','course');
1999  * echo $renderer->course_category_tree(get_course_category_tree());
2000  *
2001  * @global moodle_database $DB
2002  * @param int $id
2003  * @param int $depth
2004  */
2005 function get_course_category_tree($id = 0, $depth = 0) {
2006     global $DB, $CFG;
2007     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2008     $categories = get_child_categories($id);
2009     $categoryids = array();
2010     foreach ($categories as $key => &$category) {
2011         if (!$category->visible && !$viewhiddencats) {
2012             unset($categories[$key]);
2013             continue;
2014         }
2015         $categoryids[$category->id] = $category;
2016         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2017             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2018             foreach ($subcategories as $subid=>$subcat) {
2019                 $categoryids[$subid] = $subcat;
2020             }
2021             $category->courses = array();
2022         }
2023     }
2025     if ($depth > 0) {
2026         // This is a recursive call so return the required array
2027         return array($categories, $categoryids);
2028     }
2030     // The depth is 0 this function has just been called so we can finish it off
2032     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2033     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2034     $sql = "SELECT
2035             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2036             $ccselect
2037             FROM {course} c
2038             $ccjoin
2039             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2040     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2041         // loop throught them
2042         foreach ($courses as $course) {
2043             if ($course->id == SITEID) {
2044                 continue;
2045             }
2046             context_instance_preload($course);
2047             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2048                 $categoryids[$course->category]->courses[$course->id] = $course;
2049             }
2050         }
2051     }
2052     return $categories;
2055 /**
2056  * Recursive function to print out all the categories in a nice format
2057  * with or without courses included
2058  */
2059 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2060     global $CFG;
2062     // maxcategorydepth == 0 meant no limit
2063     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2064         return;
2065     }
2067     if (!$displaylist) {
2068         make_categories_list($displaylist, $parentslist);
2069     }
2071     if ($category) {
2072         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2073             print_category_info($category, $depth, $showcourses);
2074         } else {
2075             return;  // Don't bother printing children of invisible categories
2076         }
2078     } else {
2079         $category->id = "0";
2080     }
2082     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2083         $countcats = count($categories);
2084         $count = 0;
2085         $first = true;
2086         $last = false;
2087         foreach ($categories as $cat) {
2088             $count++;
2089             if ($count == $countcats) {
2090                 $last = true;
2091             }
2092             $up = $first ? false : true;
2093             $down = $last ? false : true;
2094             $first = false;
2096             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2097         }
2098     }
2101 /**
2102  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2103  */
2104 function make_categories_options() {
2105     make_categories_list($cats,$parents);
2106     foreach ($cats as $key => $value) {
2107         if (array_key_exists($key,$parents)) {
2108             if ($indent = count($parents[$key])) {
2109                 for ($i = 0; $i < $indent; $i++) {
2110                     $cats[$key] = '&nbsp;'.$cats[$key];
2111                 }
2112             }
2113         }
2114     }
2115     return $cats;
2118 /**
2119  * Prints the category info in indented fashion
2120  * This function is only used by print_whole_category_list() above
2121  */
2122 function print_category_info($category, $depth=0, $showcourses = false) {
2123     global $CFG, $DB, $OUTPUT;
2125     $strsummary = get_string('summary');
2127     $catlinkcss = null;
2128     if (!$category->visible) {
2129         $catlinkcss = array('class'=>'dimmed');
2130     }
2131     static $coursecount = null;
2132     if (null === $coursecount) {
2133         // only need to check this once
2134         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2135     }
2137     if ($showcourses and $coursecount) {
2138         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2139     } else {
2140         $catimage = "&nbsp;";
2141     }
2143     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2144     if ($showcourses and $coursecount) {
2145         echo '<div class="categorylist clearfix">';
2146         $cat = '';
2147         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2148         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2149         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2151         $html = '';
2152         if ($depth > 0) {
2153             for ($i=0; $i< $depth; $i++) {
2154                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2155                 $cat = '';
2156             }
2157         } else {
2158             $html = $cat;
2159         }
2160         echo html_writer::tag('div', $html, array('class'=>'category'));
2161         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2163         // does the depth exceed maxcategorydepth
2164         // maxcategorydepth == 0 or unset meant no limit
2165         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2166         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2167             foreach ($courses as $course) {
2168                 $linkcss = null;
2169                 if (!$course->visible) {
2170                     $linkcss = array('class'=>'dimmed');
2171                 }
2173                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2175                 // print enrol info
2176                 $courseicon = '';
2177                 if ($icons = enrol_get_course_info_icons($course)) {
2178                     foreach ($icons as $pix_icon) {
2179                         $courseicon = $OUTPUT->render($pix_icon).' ';
2180                     }
2181                 }
2183                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2185                 if ($course->summary) {
2186                     $link = new moodle_url('/course/info.php?id='.$course->id);
2187                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2188                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2189                         array('title'=>$strsummary));
2191                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2192                 }
2194                 $html = '';
2195                 for ($i=0; $i <= $depth; $i++) {
2196                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2197                     $coursecontent = '';
2198                 }
2199                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2200             }
2201         }
2202         echo '</div>';
2203     } else {
2204         echo '<div class="categorylist">';
2205         $html = '';
2206         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2207         $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2209         if ($depth > 0) {
2210             for ($i=0; $i< $depth; $i++) {
2211                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2212                 $cat = '';
2213             }
2214         } else {
2215             $html = $cat;
2216         }
2218         echo html_writer::tag('div', $html, array('class'=>'category'));
2219         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2220         echo '</div>';
2221     }
2224 /**
2225  * Print the buttons relating to course requests.
2226  *
2227  * @param object $systemcontext the system context.
2228  */
2229 function print_course_request_buttons($systemcontext) {
2230     global $CFG, $DB, $OUTPUT;
2231     if (empty($CFG->enablecourserequests)) {
2232         return;
2233     }
2234     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2235     /// Print a button to request a new course
2236         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2237     }
2238     /// Print a button to manage pending requests
2239     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2240         $disabled = !$DB->record_exists('course_request', array());
2241         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2242     }
2245 /**
2246  * Does the user have permission to edit things in this category?
2247  *
2248  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2249  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2250  */
2251 function can_edit_in_category($categoryid = 0) {
2252     $context = get_category_or_system_context($categoryid);
2253     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2256 /**
2257  * Prints the turn editing on/off button on course/index.php or course/category.php.
2258  *
2259  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2260  * @return string HTML of the editing button, or empty string, if this user is not allowed
2261  *      to see it.
2262  */
2263 function update_category_button($categoryid = 0) {
2264     global $CFG, $PAGE, $OUTPUT;
2266     // Check permissions.
2267     if (!can_edit_in_category($categoryid)) {
2268         return '';
2269     }
2271     // Work out the appropriate action.
2272     if ($PAGE->user_is_editing()) {
2273         $label = get_string('turneditingoff');
2274         $edit = 'off';
2275     } else {
2276         $label = get_string('turneditingon');
2277         $edit = 'on';
2278     }
2280     // Generate the button HTML.
2281     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2282     if ($categoryid) {
2283         $options['id'] = $categoryid;
2284         $page = 'category.php';
2285     } else {
2286         $page = 'index.php';
2287     }
2288     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2291 /**
2292  * Category is 0 (for all courses) or an object
2293  */
2294 function print_courses($category) {
2295     global $CFG, $OUTPUT;
2297     if (!is_object($category) && $category==0) {
2298         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2299         if (is_array($categories) && count($categories) == 1) {
2300             $category   = array_shift($categories);
2301             $courses    = get_courses_wmanagers($category->id,
2302                                                 'c.sortorder ASC',
2303                                                 array('summary','summaryformat'));
2304         } else {
2305             $courses    = get_courses_wmanagers('all',
2306                                                 'c.sortorder ASC',
2307                                                 array('summary','summaryformat'));
2308         }
2309         unset($categories);
2310     } else {
2311         $courses    = get_courses_wmanagers($category->id,
2312                                             'c.sortorder ASC',
2313                                             array('summary','summaryformat'));
2314     }
2316     if ($courses) {
2317         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2318         foreach ($courses as $course) {
2319             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2320             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2321                 echo html_writer::start_tag('li');
2322                 print_course($course);
2323                 echo html_writer::end_tag('li');
2324             }
2325         }
2326         echo html_writer::end_tag('ul');
2327     } else {
2328         echo $OUTPUT->heading(get_string("nocoursesyet"));
2329         $context = get_context_instance(CONTEXT_SYSTEM);
2330         if (has_capability('moodle/course:create', $context)) {
2331             $options = array();
2332             if (!empty($category->id)) {
2333                 $options['category'] = $category->id;
2334             } else {
2335                 $options['category'] = $CFG->defaultrequestcategory;
2336             }
2337             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2338             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2339             echo html_writer::end_tag('div');
2340         }
2341     }
2344 /**
2345  * Print a description of a course, suitable for browsing in a list.
2346  *
2347  * @param object $course the course object.
2348  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2349  */
2350 function print_course($course, $highlightterms = '') {
2351     global $CFG, $USER, $DB, $OUTPUT;
2353     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2355     // Rewrite file URLs so that they are correct
2356     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2358     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2359     echo html_writer::start_tag('div', array('class'=>'info'));
2360     echo html_writer::start_tag('h3', array('class'=>'name'));
2362     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2363     $linktext = highlight($highlightterms, format_string($course->fullname));
2364     $linkparams = array('title'=>get_string('entercourse'));
2365     if (empty($course->visible)) {
2366         $linkparams['class'] = 'dimmed';
2367     }
2368     echo html_writer::link($linkhref, $linktext, $linkparams);
2369     echo html_writer::end_tag('h3');
2371     /// first find all roles that are supposed to be displayed
2372     if (!empty($CFG->coursecontact)) {
2373         $managerroles = explode(',', $CFG->coursecontact);
2374         $namesarray = array();
2375         if (isset($course->managers)) {
2376             if (count($course->managers)) {
2377                 $rusers = $course->managers;
2378                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2380                  /// Rename some of the role names if needed
2381                 if (isset($context)) {
2382                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2383                 }
2385                 // keep a note of users displayed to eliminate duplicates
2386                 $usersshown = array();
2387                 foreach ($rusers as $ra) {
2389                     // if we've already displayed user don't again
2390                     if (in_array($ra->user->id,$usersshown)) {
2391                         continue;
2392                     }
2393                     $usersshown[] = $ra->user->id;
2395                     $fullname = fullname($ra->user, $canviewfullnames);
2397                     if (isset($aliasnames[$ra->roleid])) {
2398                         $ra->rolename = $aliasnames[$ra->roleid]->name;
2399                     }
2401                     $namesarray[] = format_string($ra->rolename).': '.
2402                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
2403                 }
2404             }
2405         } else {
2406             $rusers = get_role_users($managerroles, $context,
2407                                      true, '', 'r.sortorder ASC, u.lastname ASC');
2408             if (is_array($rusers) && count($rusers)) {
2409                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2411                 /// Rename some of the role names if needed
2412                 if (isset($context)) {
2413                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2414                 }
2416                 foreach ($rusers as $teacher) {
2417                     $fullname = fullname($teacher, $canviewfullnames);
2419                     /// Apply role names
2420                     if (isset($aliasnames[$teacher->roleid])) {
2421                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2422                     }
2424                     $namesarray[] = format_string($teacher->rolename).': '.
2425                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
2426                 }
2427             }
2428         }
2430         if (!empty($namesarray)) {
2431             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2432             foreach ($namesarray as $name) {
2433                 echo html_writer::tag('li', $name);
2434             }
2435             echo html_writer::end_tag('ul');
2436         }
2437     }
2438     echo html_writer::end_tag('div'); // End of info div
2440     echo html_writer::start_tag('div', array('class'=>'summary'));
2441     $options = NULL;
2442     $options->noclean = true;
2443     $options->para = false;
2444     $options->overflowdiv = true;
2445     if (!isset($course->summaryformat)) {
2446         $course->summaryformat = FORMAT_MOODLE;
2447     }
2448     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2449     if ((!isloggedin() || is_siteadmin()) && $icons = enrol_get_course_info_icons($course)) {
2450         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2451         foreach ($icons as $icon) {
2452             echo $OUTPUT->render($icon);
2453         }
2454         echo html_writer::end_tag('div'); // End of enrolmenticons div
2455     }
2456     echo html_writer::end_tag('div'); // End of summary div
2457     echo html_writer::end_tag('div'); // End of coursebox div
2460 /**
2461  * Prints custom user information on the home page.
2462  * Over time this can include all sorts of information
2463  */
2464 function print_my_moodle() {
2465     global $USER, $CFG, $DB, $OUTPUT;
2467     if (!isloggedin() or isguestuser()) {
2468         print_error('nopermissions', '', '', 'See My Moodle');
2469     }
2471     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2472     $rhosts   = array();
2473     $rcourses = array();
2474     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2475         $rcourses = get_my_remotecourses($USER->id);
2476         $rhosts   = get_my_remotehosts();
2477     }
2479     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2481         if (!empty($courses)) {
2482             echo '<ul class="unlist">';
2483             foreach ($courses as $course) {
2484                 if ($course->id == SITEID) {
2485                     continue;
2486                 }
2487                 echo '<li>';
2488                 print_course($course);
2489                 echo "</li>\n";
2490             }
2491             echo "</ul>\n";
2492         }
2494         // MNET
2495         if (!empty($rcourses)) {
2496             // at the IDP, we know of all the remote courses
2497             foreach ($rcourses as $course) {
2498                 print_remote_course($course, "100%");
2499             }
2500         } elseif (!empty($rhosts)) {
2501             // non-IDP, we know of all the remote servers, but not courses
2502             foreach ($rhosts as $host) {
2503                 print_remote_host($host, "100%");
2504             }
2505         }
2506         unset($course);
2507         unset($host);
2509         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2510             echo "<table width=\"100%\"><tr><td align=\"center\">";
2511             print_course_search("", false, "short");
2512             echo "</td><td align=\"center\">";
2513             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2514             echo "</td></tr></table>\n";
2515         }
2517     } else {
2518         if ($DB->count_records("course_categories") > 1) {
2519             echo $OUTPUT->box_start("categorybox");
2520             print_whole_category_list();
2521             echo $OUTPUT->box_end();
2522         } else {
2523             print_courses(0);
2524         }
2525     }
2529 function print_course_search($value="", $return=false, $format="plain") {
2530     global $CFG;
2531     static $count = 0;
2533     $count++;
2535     $id = 'coursesearch';
2537     if ($count > 1) {
2538         $id .= $count;
2539     }
2541     $strsearchcourses= get_string("searchcourses");
2543     if ($format == 'plain') {
2544         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2545         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2546         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2547         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2548         $output .= '<input type="submit" value="'.get_string('go').'" />';
2549         $output .= '</fieldset></form>';
2550     } else if ($format == 'short') {
2551         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2552         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2553         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2554         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2555         $output .= '<input type="submit" value="'.get_string('go').'" />';
2556         $output .= '</fieldset></form>';
2557     } else if ($format == 'navbar') {
2558         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2559         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2560         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2561         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2562         $output .= '<input type="submit" value="'.get_string('go').'" />';
2563         $output .= '</fieldset></form>';
2564     }
2566     if ($return) {
2567         return $output;
2568     }
2569     echo $output;
2572 function print_remote_course($course, $width="100%") {
2573     global $CFG, $USER;
2575     $linkcss = '';
2577     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2579     echo '<div class="coursebox remotecoursebox clearfix">';
2580     echo '<div class="info">';
2581     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2582          $linkcss.' href="'.$url.'">'
2583         .  format_string($course->fullname) .'</a><br />'
2584         . format_string($course->hostname) . ' : '
2585         . format_string($course->cat_name) . ' : '
2586         . format_string($course->shortname). '</div>';
2587     echo '</div><div class="summary">';
2588     $options = NULL;
2589     $options->noclean = true;
2590     $options->para = false;
2591     $options->overflowdiv = true;
2592     echo format_text($course->summary, $course->summaryformat, $options);
2593     echo '</div>';
2594     echo '</div>';
2597 function print_remote_host($host, $width="100%") {
2598     global $OUTPUT;
2600     $linkcss = '';
2602     echo '<div class="coursebox clearfix">';
2603     echo '<div class="info">';
2604     echo '<div class="name">';
2605     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2606     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2607         . s($host['name']).'</a> - ';
2608     echo $host['count'] . ' ' . get_string('courses');
2609     echo '</div>';
2610     echo '</div>';
2611     echo '</div>';
2615 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2617 function add_course_module($mod) {
2618     global $DB;
2620     $mod->added = time();
2621     unset($mod->id);
2623     return $DB->insert_record("course_modules", $mod);
2626 /**
2627  * Returns course section - creates new if does not exist yet.
2628  * @param int $relative section number
2629  * @param int $courseid
2630  * @return object $course_section object
2631  */
2632 function get_course_section($section, $courseid) {
2633     global $DB;
2635     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2636         return $cw;
2637     }
2638     $cw = new stdClass();
2639     $cw->course   = $courseid;
2640     $cw->section  = $section;
2641     $cw->summary  = "";
2642     $cw->summaryformat = FORMAT_HTML;
2643     $cw->sequence = "";
2644     $id = $DB->insert_record("course_sections", $cw);
2645     return $DB->get_record("course_sections", array("id"=>$id));
2647 /**
2648  * Given a full mod object with section and course already defined, adds this module to that section.
2649  *
2650  * @param object $mod
2651  * @param int $beforemod An existing ID which we will insert the new module before
2652  * @return int The course_sections ID where the mod is inserted
2653  */
2654 function add_mod_to_section($mod, $beforemod=NULL) {
2655     global $DB;
2657     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2659         $section->sequence = trim($section->sequence);
2661         if (empty($section->sequence)) {
2662             $newsequence = "$mod->coursemodule";
2664         } else if ($beforemod) {
2665             $modarray = explode(",", $section->sequence);
2667             if ($key = array_keys($modarray, $beforemod->id)) {
2668                 $insertarray = array($mod->id, $beforemod->id);
2669                 array_splice($modarray, $key[0], 1, $insertarray);
2670                 $newsequence = implode(",", $modarray);
2672             } else {  // Just tack it on the end anyway
2673                 $newsequence = "$section->sequence,$mod->coursemodule";
2674             }
2676         } else {
2677             $newsequence = "$section->sequence,$mod->coursemodule";
2678         }
2680         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2681         return $section->id;     // Return course_sections ID that was used.
2683     } else {  // Insert a new record
2684         $section->course   = $mod->course;
2685         $section->section  = $mod->section;
2686         $section->summary  = "";
2687         $section->summaryformat = FORMAT_HTML;
2688         $section->sequence = $mod->coursemodule;
2689         return $DB->insert_record("course_sections", $section);
2690     }
2693 function set_coursemodule_groupmode($id, $groupmode) {
2694     global $DB;
2695     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2698 function set_coursemodule_idnumber($id, $idnumber) {
2699     global $DB;
2700     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2703 /**
2704 * $prevstateoverrides = true will set the visibility of the course module
2705 * to what is defined in visibleold. This enables us to remember the current
2706 * visibility when making a whole section hidden, so that when we toggle
2707 * that section back to visible, we are able to return the visibility of
2708 * the course module back to what it was originally.
2709 */
2710 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2711     global $DB, $CFG;
2712     require_once($CFG->libdir.'/gradelib.php');
2714     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2715         return false;
2716     }
2717     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2718         return false;
2719     }
2720     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2721         foreach($events as $event) {
2722             if ($visible) {
2723                 show_event($event);
2724             } else {
2725                 hide_event($event);
2726             }
2727         }
2728     }
2730     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2731     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2732     if ($grade_items) {
2733         foreach ($grade_items as $grade_item) {
2734             $grade_item->set_hidden(!$visible);
2735         }
2736     }
2738     if ($prevstateoverrides) {
2739         if ($visible == '0') {
2740             // Remember the current visible state so we can toggle this back.
2741             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2742         } else {
2743             // Get the previous saved visible states.
2744             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2745         }
2746     }
2747     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2750 /**
2751  * Delete a course module and any associated data at the course level (events)
2752  * Until 1.5 this function simply marked a deleted flag ... now it
2753  * deletes it completely.
2754  *
2755  */
2756 function delete_course_module($id) {
2757     global $CFG, $DB;
2758     require_once($CFG->libdir.'/gradelib.php');
2759     require_once($CFG->dirroot.'/blog/lib.php');
2761     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2762         return true;
2763     }
2764     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2765     //delete events from calendar
2766     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2767         foreach($events as $event) {
2768             delete_event($event->id);
2769         }
2770     }
2771     //delete grade items, outcome items and grades attached to modules
2772     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2773                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2774         foreach ($grade_items as $grade_item) {
2775             $grade_item->delete('moddelete');
2776         }
2777     }
2778     // Delete completion and availability data; it is better to do this even if the
2779     // features are not turned on, in case they were turned on previously (these will be
2780     // very quick on an empty table)
2781     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2782     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2784     delete_context(CONTEXT_MODULE, $cm->id);
2785     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2788 function delete_mod_from_section($mod, $section) {
2789     global $DB;
2791     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2793         $modarray = explode(",", $section->sequence);
2795         if ($key = array_keys ($modarray, $mod)) {
2796             array_splice($modarray, $key[0], 1);
2797             $newsequence = implode(",", $modarray);
2798             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2799         } else {
2800             return false;
2801         }
2803     }
2804     return false;
2807 /**
2808  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2809  *
2810  * @param object $course
2811  * @param int $section
2812  * @param int $move (-1 or 1)
2813  */
2814 function move_section($course, $section, $move) {
2815 /// Moves a whole course section up and down within the course
2816     global $USER, $DB;
2818     if (!$move) {
2819         return true;
2820     }
2822     $sectiondest = $section + $move;
2824     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2825         return false;
2826     }
2828     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2829         return false;
2830     }
2832     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2833         return false;
2834     }
2836     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2837     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2839     // if the focus is on the section that is being moved, then move the focus along
2840     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2841         course_set_display($course->id, $sectiondest);
2842     }
2844     // Check for duplicates and fix order if needed.
2845     // There is a very rare case that some sections in the same course have the same section id.
2846     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2847     $n = 0;
2848     foreach ($sections as $section) {
2849         if ($section->section != $n) {
2850             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2851         }
2852         $n++;
2853     }
2854     return true;
2857 /**
2858  * Moves a section within a course, from a position to another.
2859  * Be very careful: $section and $destination refer to section number,
2860  * not id!.
2861  *
2862  * @param object $course
2863  * @param int $section Section number (not id!!!)
2864  * @param int $destination
2865  * @return boolean Result
2866  */
2867 function move_section_to($course, $section, $destination) {
2868 /// Moves a whole course section up and down within the course
2869     global $USER, $DB;
2871     if (!$destination && $destination != 0) {
2872         return true;
2873     }
2875     if ($destination > $course->numsections) {
2876         return false;
2877     }
2879     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2880     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2881             'section ASC, id ASC', 'id, section')) {
2882         return false;
2883     }
2885     $sections = reorder_sections($sections, $section, $destination);
2887     // Update all sections
2888     foreach ($sections as $id => $position) {
2889         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2890     }
2892     // if the focus is on the section that is being moved, then move the focus along
2893     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2894         course_set_display($course->id, $destination);
2895     }
2896     return true;
2899 /**
2900  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2901  * an original position number and a target position number, rebuilds the array so that the
2902  * move is made without any duplication of section positions.
2903  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2904  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2905  *
2906  * @param array $sections
2907  * @param int $origin_position
2908  * @param int $target_position
2909  * @return array
2910  */
2911 function reorder_sections($sections, $origin_position, $target_position) {
2912     if (!is_array($sections)) {
2913         return false;
2914     }
2916     // We can't move section position 0
2917     if ($origin_position < 1) {
2918         echo "We can't move section position 0";
2919         return false;
2920     }
2922     // Locate origin section in sections array
2923     if (!$origin_key = array_search($origin_position, $sections)) {
2924         echo "searched position not in sections array";
2925         return false; // searched position not in sections array
2926     }
2928     // Extract origin section
2929     $origin_section = $sections[$origin_key];
2930     unset($sections[$origin_key]);
2932     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2933     $found = false;
2934     $append_array = array();
2935     foreach ($sections as $id => $position) {
2936         if ($found) {
2937             $append_array[$id] = $position;
2938             unset($sections[$id]);
2939         }
2940         if ($position == $target_position) {
2941             $found = true;
2942         }
2943     }
2945     // Append moved section
2946     $sections[$origin_key] = $origin_section;
2948     // Append rest of array (if applicable)
2949     if (!empty($append_array)) {
2950         foreach ($append_array as $id => $position) {
2951             $sections[$id] = $position;
2952         }
2953     }
2955     // Renumber positions
2956     $position = 0;
2957     foreach ($sections as $id => $p) {
2958         $sections[$id] = $position;
2959         $position++;
2960     }
2962     return $sections;
2966 /**
2967  * Move the module object $mod to the specified $section
2968  * If $beforemod exists then that is the module
2969  * before which $modid should be inserted
2970  * All parameters are objects
2971  */
2972 function moveto_module($mod, $section, $beforemod=NULL) {
2973     global $DB, $OUTPUT;
2975 /// Remove original module from original section
2976     if (! delete_mod_from_section($mod->id, $mod->section)) {
2977         echo $OUTPUT->notification("Could not delete module from existing section");
2978     }
2980 /// Update module itself if necessary
2982     if ($mod->section != $section->id) {
2983         $mod->section = $section->id;
2984         $DB->update_record("course_modules", $mod);
2985         // if moving to a hidden section then hide module
2986         if (!$section->visible) {
2987             set_coursemodule_visible($mod->id, 0);
2988         }
2989     }
2991 /// Add the module into the new section
2993     $mod->course       = $section->course;
2994     $mod->section      = $section->section;  // need relative reference
2995     $mod->coursemodule = $mod->id;
2997     if (! add_mod_to_section($mod, $beforemod)) {
2998         return false;
2999     }
3001     return true;
3004 function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
3005     global $CFG, $USER, $DB, $OUTPUT;
3007     static $str;
3008     static $sesskey;
3010     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3011     // no permission to edit
3012     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
3013         return false;
3014     }
3016     if (!isset($str)) {
3017         $str->assign         = get_string("assignroles", 'role');
3018         $str->delete         = get_string("delete");
3019         $str->move           = get_string("move");
3020         $str->moveup         = get_string("moveup");
3021         $str->movedown       = get_string("movedown");
3022         $str->moveright      = get_string("moveright");
3023         $str->moveleft       = get_string("moveleft");
3024         $str->update         = get_string("update");
3025         $str->duplicate      = get_string("duplicate");
3026         $str->hide           = get_string("hide");
3027         $str->show           = get_string("show");
3028         $str->clicktochange  = get_string("clicktochange");
3029         $str->forcedmode     = get_string("forcedmode");
3030         $str->groupsnone     = get_string("groupsnone");
3031         $str->groupsseparate = get_string("groupsseparate");
3032         $str->groupsvisible  = get_string("groupsvisible");
3033         $sesskey = sesskey();
3034     }
3036     if ($section >= 0) {
3037         $section = '&amp;sr='.$section;   // Section return
3038     } else {
3039         $section = '';
3040     }
3042     if ($absolute) {
3043         $path = $CFG->wwwroot.'/course';
3044     } else {
3045         $path = '.';
3046     }
3047     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3048         if ($mod->visible) {
3049             $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
3050                         '&amp;sesskey='.$sesskey.$section.'"><img'.
3051                         ' src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" '.
3052                         ' alt="'.$str->hide.'" /></a>'."\n";
3053         } else {
3054             $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
3055                         '&amp;sesskey='.$sesskey.$section.'"><img'.
3056                         ' src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" '.
3057                         ' alt="'.$str->show.'" /></a>'."\n";
3058         }
3059     } else {
3060         $hideshow = '';
3061     }
3063     if ($mod->groupmode !== false) {
3064         if ($mod->groupmode == SEPARATEGROUPS) {
3065             $grouptitle = $str->groupsseparate;
3066             $groupclass = 'editing_groupsseparate';
3067             $groupimage = $OUTPUT->pix_url('t/groups') . '';
3068             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
3069         } else if ($mod->groupmode == VISIBLEGROUPS) {
3070             $grouptitle = $str->groupsvisible;
3071             $groupclass = 'editing_groupsvisible';
3072             $groupimage = $OUTPUT->pix_url('t/groupv') . '';
3073             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
3074         } else {
3075             $grouptitle = $str->groupsnone;
3076             $groupclass = 'editing_groupsnone';
3077             $groupimage = $OUTPUT->pix_url('t/groupn') . '';
3078             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
3079         }
3080         if ($mod->groupmodelink) {
3081             $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
3082                          '<img src="'.$groupimage.'" class="iconsmall" '.
3083                          'alt="'.$grouptitle.'" /></a>';
3084         } else {
3085             $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
3086                          ' src="'.$groupimage.'" class="iconsmall" '.
3087                          'alt="'.$grouptitle.'" />';
3088         }
3089     } else {
3090         $groupmode = "";
3091     }
3093     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
3094         if ($moveselect) {
3095             $move =     '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
3096                         '&amp;sesskey='.$sesskey.$section.'"><img'.
3097                         ' src="'.$OUTPUT->pix_url('t/move') . '" class="iconsmall" '.
3098                         ' alt="'.$str->move.'" /></a>'."\n";
3099         } else {
3100             $move =     '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
3101                         '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3102                         ' src="'.$OUTPUT->pix_url('t/up') . '" class="iconsmall" '.
3103                         ' alt="'.$str->moveup.'" /></a>'."\n".
3104                         '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
3105                         '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
3106                         ' src="'.$OUTPUT->pix_url('t/down') . '" class="iconsmall" '.
3107                         ' alt="'.$str->movedown.'" /></a>'."\n";
3108         }
3109     } else {
3110         $move = '';
3111     }
3113     $leftright = '';
3114     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
3116         if (right_to_left()) {   // Exchange arrows on RTL
3117             $rightarrow = 't/left';
3118             $leftarrow  = 't/right';
3119         } else {
3120             $rightarrow = 't/right';
3121             $leftarrow  = 't/left';
3122         }
3124         if ($indent > 0) {
3125             $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
3126                         '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3127                         ' src="'.$OUTPUT->pix_url($leftarrow).'" class="iconsmall" '.
3128                         ' alt="'.$str->moveleft.'" /></a>'."\n";
3129         }
3130         if ($indent >= 0) {
3131             $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
3132                         '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
3133                         ' src="'.$OUTPUT->pix_url($rightarrow).'" class="iconsmall" '.
3134                         ' alt="'.$str->moveright.'" /></a>'."\n";
3135         }
3136     }
3137     if (has_capability('moodle/course:managegroups', $modcontext)){
3138         $context = get_context_instance(CONTEXT_MODULE, $mod->id);
3139         $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
3140             $context->id.'"><img src="'.$OUTPUT->pix_url('i/roles') . '" alt="'.$str->assign.'" class="iconsmall"/></a>';
3141     } else {
3142         $assign = '';
3143     }
3145     return '<span class="commands">'."\n".$leftright.$move.
3146            '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
3147            '&amp;sesskey='.$sesskey.$section.'"><img'.
3148            ' src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" '.
3149            ' alt="'.$str->update.'" /></a>'."\n".
3150            '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
3151            '&amp;sesskey='.$sesskey.$section.'"><img'.
3152            ' src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" '.
3153            ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
3156 /**
3157  * given a course object with shortname & fullname, this function will
3158  * truncate the the number of chars allowed and add ... if it was too long
3159  */
3160 function course_format_name ($course,$max=100) {
3162     $str = $course->shortname.': '. $course->fullname;
3163     if (strlen($str) <= $max) {
3164         return $str;
3165     }
3166     else {
3167         return substr($str,0,$max-3).'...';
3168     }
3171 function update_restricted_mods($course, $mods) {
3172     global $DB;
3174 /// Delete all the current restricted list
3175     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3177     if (empty($course->restrictmodules)) {
3178         return;   // We're done
3179     }
3181 /// Insert the new list of restricted mods
3182     foreach ($mods as $mod) {
3183         if ($mod == 0) {
3184             continue; // this is the 'allow none' option
3185         }
3186         $am = new stdClass();
3187         $am->course = $course->id;
3188         $am->module = $mod;
3189         $DB->insert_record('course_allowed_modules',$am);
3190     }
3193 /**
3194  * This function will take an int (module id) or a string (module name)
3195  * and return true or false, whether it's allowed in the given course (object)
3196  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3197  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3198  */
3200 function course_allowed_module($course,$mod) {
3201     global $DB;
3203     if (empty($course->restrictmodules)) {
3204         return true;
3205     }
3207     // Admins and admin-like people who can edit everything can also add anything.
3208     // Originally there was a course:update test only, but it did not match the test in course edit form
3209     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3210         return true;
3211     }
3213     if (is_numeric($mod)) {
3214         $modid = $mod;
3215     } else if (is_string($mod)) {
3216         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3217     }
3218     if (empty($modid)) {
3219         return false;
3220     }
3222     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3225 /**
3226  * Recursively delete category including all subcategories and courses.
3227  * @param stdClass $category
3228  * @param boolean $showfeedback display some notices
3229  * @return array return deleted courses
3230  */
3231 function category_delete_full($category, $showfeedback=true) {
3232     global $CFG, $DB;
3233     require_once($CFG->libdir.'/gradelib.php');
3234     require_once($CFG->libdir.'/questionlib.php');
3235     require_once($CFG->dirroot.'/cohort/lib.php');
3237     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3238         foreach ($children as $childcat) {
3239             category_delete_full($childcat, $showfeedback);
3240         }
3241     }
3243     $deletedcourses = array();
3244     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3245         foreach ($courses as $course) {
3246             if (!delete_course($course, false)) {
3247                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3248             }
3249             $deletedcourses[] = $course;
3250         }
3251     }
3253     // move or delete cohorts in this context
3254     cohort_delete_category($category);
3256     // now delete anything that may depend on course category context
3257     grade_course_category_delete($category->id, 0, $showfeedback);
3258     if (!question_delete_course_category($category, 0, $showfeedback)) {
3259         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3260     }
3262     // finally delete the category and it's context
3263     $DB->delete_records('course_categories', array('id'=>$category->id));
3264     delete_context(CONTEXT_COURSECAT, $category->id);
3266     events_trigger('course_category_deleted', $category);
3268     return $deletedcourses;
3271 /**
3272  * Delete category, but move contents to another category.
3273  * @param object $ccategory
3274  * @param int $newparentid category id
3275  * @return bool status
3276  */
3277 function category_delete_move($category, $newparentid, $showfeedback=true) {
3278     global $CFG, $DB, $OUTPUT;
3279     require_once($CFG->libdir.'/gradelib.php');
3280     require_once($CFG->libdir.'/questionlib.php');
3281     require_once($CFG->dirroot.'/cohort/lib.php');
3283     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3284         return false;
3285     }
3287     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3288         foreach ($children as $childcat) {
3289             move_category($childcat, $newparentcat);
3290         }
3291     }
3293     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3294         if (!move_courses(array_keys($courses), $newparentid)) {
3295             echo $OUTPUT->notification("Error moving courses");
3296             return false;
3297         }
3298         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3299     }
3301     // move or delete cohorts in this context
3302     cohort_delete_category($category);
3304     // now delete anything that may depend on course category context
3305     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3306     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3307         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3308         return false;
3309     }
3311     // finally delete the category and it's context
3312     $DB->delete_records('course_categories', array('id'=>$category->id));
3313     delete_context(CONTEXT_COURSECAT, $category->id);
3315     events_trigger('course_category_deleted', $category);
3317     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3319     return true;
3322 /**
3323  * Efficiently moves many courses around while maintaining
3324  * sortorder in order.
3325  *
3326  * @param array $courseids is an array of course ids
3327  * @param int $categoryid
3328  * @return bool success
3329  */
3330 function move_courses($courseids, $categoryid) {
3331     global $CFG, $DB, $OUTPUT;
3333     if (empty($courseids)) {
3334         // nothing to do
3335         return;
3336     }
3338     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3339         return false;
3340     }
3342     $courseids = array_reverse($courseids);
3343     $i = 1;
3345     foreach ($courseids as $courseid) {
3346         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3347             $course->category  = $category->id;
3348             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3349             if ($category->visible == 0) {
3350                 // hide the course when moving into hidden category,
3351                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3352                 $course->visible = 0;
3353             }
3355             $DB->update_record('course', $course);
3357             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3358             $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3359             context_moved($context, $newparent);
3360         }
3361     }
3362     fix_course_sortorder();
3364     return true;
3367 /**
3368  * Hide course category and child course and subcategories
3369  * @param stdClass $category
3370  * @return void
3371  */
3372 function course_category_hide($category) {
3373     global $DB;
3375     $category->visible = 0;
3376     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3377     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3378     $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
3379     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3380     // get all child categories and hide too
3381     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3382         foreach ($subcats as $cat) {
3383             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3384             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3385             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3386             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3387         }
3388     }
3391 /**
3392  * Show course category and child course and subcategories
3393  * @param stdClass $category
3394  * @return void
3395  */
3396 function course_category_show($category) {
3397     global $DB;
3399     $category->visible = 1;
3400     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3401     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3402     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3403     // get all child categories and unhide too
3404     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3405         foreach ($subcats as $cat) {
3406             if ($cat->visibleold) {
3407                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3408             }
3409             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3410         }
3411     }
3414 /**
3415  * Efficiently moves a category - NOTE that this can have
3416  * a huge impact access-control-wise...
3417  */
3418 function move_category($category, $newparentcat) {
3419     global $CFG, $DB;
3421     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3423     $hidecat = false;
3424     if (empty($newparentcat->id)) {
3425         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3427         $newparent = get_context_instance(CONTEXT_SYSTEM);
3429     } else {
3430         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3431         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3433         if (!$newparentcat->visible and $category->visible) {
3434             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3435             $hidecat = true;
3436         }
3437     }
3439     context_moved($context, $newparent);
3441     // now make it last in new category
3442     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3444     // and fix the sortorders
3445     fix_course_sortorder();
3447     if ($hidecat) {
3448         course_category_hide($category);
3449     }
3452 /**
3453  * Returns the display name of the given section that the course prefers.
3454  *
3455  * This function utilizes a callback that can be implemented within the course
3456  * formats lib.php file to customize the display name that is used to reference
3457  * the section.
3458  *
3459  * By default (if callback is not defined) the method
3460  * {@see get_numeric_section_name} is called instead.
3461  *
3462  * @param stdClass $course The course to get the section name for
3463  * @param stdClass $section Section object from database
3464  * @return Display name that the course format prefers, e.g. "Week 2"
3465  *
3466  * @see get_generic_section_name
3467  */
3468 function get_section_name(stdClass $course, stdClass $section) {
3469     global $CFG;
3471     /// Inelegant hack for bug 3408
3472     if ($course->format == 'site') {
3473         return get_string('site');
3474     }
3476     // Use course formatter callback if it exists
3477     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3478     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3479     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3480         require_once $namingfile;
3481     }
3482     if (function_exists($namingfunction)) {
3483         return $namingfunction($course, $section);
3484     }
3486     // else, default behavior:
3487     return get_generic_section_name($course->format, $section);
3490 /**
3491  * Gets the generic section name for a courses section.
3492  *
3493  * @param string $format Course format ID e.g. 'weeks' $course->format
3494  * @param stdClass $section Section object from database
3495  * @return Display name that the course format prefers, e.g. "Week 2"
3496  */
3497 function get_generic_section_name($format, stdClass $section) {
3498     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3502 function course_format_uses_sections($format) {
3503     global $CFG;
3505     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3506     $featurefunction = 'callback_'.$format.'_uses_sections';
3507     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3508         require_once $featurefile;
3509     }
3510     if (function_exists($featurefunction)) {
3511         return $featurefunction();
3512     }
3514     return false;
3517 /**
3518  * Returns the information about the ajax support in the given source format
3519  *
3520  * The returned object's property (boolean)capable indicates that