Merge branch MDL-29187-master of git://github.com/samhemelryk/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('fullnameuser'),
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('fullnameuser')."</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             $courseshortname = format_string($courses[$log->course], true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
502             echo "<td class=\"r$row c0\" >\n";
503             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
504             echo "</td>\n";
505         }
506         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
507              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
508         echo "<td class=\"r$row c2\" >\n";
509         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
510         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
511         echo "</td>\n";
512         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
513         echo "<td class=\"r$row c3\" >\n";
514         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
515         echo "</td>\n";
516         echo "<td class=\"r$row c4\">\n";
517         echo $log->action .': '.$log->module;
518         echo "</td>\n";;
519         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
520         echo "</tr>\n";
521     }
522     echo "</table>\n";
524     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
528 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
529                         $modid, $modaction, $groupid) {
530     global $DB;
532     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
533             get_string('fullnameuser')."\t".get_string('action')."\t".get_string('info');
535     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
536                        $modname, $modid, $modaction, $groupid)) {
537         return false;
538     }
540     $courses = array();
542     if ($course->id == SITEID) {
543         $courses[0] = '';
544         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
545             foreach ($ccc as $cc) {
546                 $courses[$cc->id] = $cc->shortname;
547             }
548         }
549     } else {
550         $courses[$course->id] = $course->shortname;
551     }
553     $count=0;
554     $ldcache = array();
555     $tt = getdate(time());
556     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
558     $strftimedatetime = get_string("strftimedatetime");
560     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
561     $filename .= '.txt';
562     header("Content-Type: application/download\n");
563     header("Content-Disposition: attachment; filename=$filename");
564     header("Expires: 0");
565     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
566     header("Pragma: public");
568     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
569     echo $text."\n";
571     if (empty($logs['logs'])) {
572         return true;
573     }
575     foreach ($logs['logs'] as $log) {
576         if (isset($ldcache[$log->module][$log->action])) {
577             $ld = $ldcache[$log->module][$log->action];
578         } else {
579             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
580             $ldcache[$log->module][$log->action] = $ld;
581         }
582         if ($ld && !empty($log->info)) {
583             // ugly hack to make sure fullname is shown correctly
584             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
585                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
586             } else {
587                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
588             }
589         }
591         //Filter log->info
592         $log->info = format_string($log->info);
593         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
595         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
596         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
597         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
598         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
599         $text = implode("\t", $row);
600         echo $text." \n";
601     }
602     return true;
606 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
607                         $modid, $modaction, $groupid) {
609     global $CFG, $DB;
611     require_once("$CFG->libdir/excellib.class.php");
613     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
614                        $modname, $modid, $modaction, $groupid)) {
615         return false;
616     }
618     $courses = array();
620     if ($course->id == SITEID) {
621         $courses[0] = '';
622         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
623             foreach ($ccc as $cc) {
624                 $courses[$cc->id] = $cc->shortname;
625             }
626         }
627     } else {
628         $courses[$course->id] = $course->shortname;
629     }
631     $count=0;
632     $ldcache = array();
633     $tt = getdate(time());
634     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
636     $strftimedatetime = get_string("strftimedatetime");
638     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
639     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
640     $filename .= '.xls';
642     $workbook = new MoodleExcelWorkbook('-');
643     $workbook->send($filename);
645     $worksheet = array();
646     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
647                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
649     // Creating worksheets
650     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
651         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
652         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
653         $worksheet[$wsnumber]->set_column(1, 1, 30);
654         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
655                                     userdate(time(), $strftimedatetime));
656         $col = 0;
657         foreach ($headers as $item) {
658             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
659             $col++;
660         }
661     }
663     if (empty($logs['logs'])) {
664         $workbook->close();
665         return true;
666     }
668     $formatDate =& $workbook->add_format();
669     $formatDate->set_num_format(get_string('log_excel_date_format'));
671     $row = FIRSTUSEDEXCELROW;
672     $wsnumber = 1;
673     $myxls =& $worksheet[$wsnumber];
674     foreach ($logs['logs'] as $log) {
675         if (isset($ldcache[$log->module][$log->action])) {
676             $ld = $ldcache[$log->module][$log->action];
677         } else {
678             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
679             $ldcache[$log->module][$log->action] = $ld;
680         }
681         if ($ld && !empty($log->info)) {
682             // ugly hack to make sure fullname is shown correctly
683             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
684                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
685             } else {
686                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
687             }
688         }
690         // Filter log->info
691         $log->info = format_string($log->info);
692         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
694         if ($nroPages>1) {
695             if ($row > EXCELROWS) {
696                 $wsnumber++;
697                 $myxls =& $worksheet[$wsnumber];
698                 $row = FIRSTUSEDEXCELROW;
699             }
700         }
702         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
704         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
705         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
706         $myxls->write($row, 2, $log->ip, '');
707         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
708         $myxls->write($row, 3, $fullname, '');
709         $myxls->write($row, 4, $log->module.' '.$log->action, '');
710         $myxls->write($row, 5, $log->info, '');
712         $row++;
713     }
715     $workbook->close();
716     return true;
719 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
720                         $modid, $modaction, $groupid) {
722     global $CFG, $DB;
724     require_once("$CFG->libdir/odslib.class.php");
726     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
727                        $modname, $modid, $modaction, $groupid)) {
728         return false;
729     }
731     $courses = array();
733     if ($course->id == SITEID) {
734         $courses[0] = '';
735         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
736             foreach ($ccc as $cc) {
737                 $courses[$cc->id] = $cc->shortname;
738             }
739         }
740     } else {
741         $courses[$course->id] = $course->shortname;
742     }
744     $count=0;
745     $ldcache = array();
746     $tt = getdate(time());
747     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
749     $strftimedatetime = get_string("strftimedatetime");
751     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
752     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
753     $filename .= '.ods';
755     $workbook = new MoodleODSWorkbook('-');
756     $workbook->send($filename);
758     $worksheet = array();
759     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
760                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
762     // Creating worksheets
763     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
764         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
765         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
766         $worksheet[$wsnumber]->set_column(1, 1, 30);
767         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
768                                     userdate(time(), $strftimedatetime));
769         $col = 0;
770         foreach ($headers as $item) {
771             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
772             $col++;
773         }
774     }
776     if (empty($logs['logs'])) {
777         $workbook->close();
778         return true;
779     }
781     $formatDate =& $workbook->add_format();
782     $formatDate->set_num_format(get_string('log_excel_date_format'));
784     $row = FIRSTUSEDEXCELROW;
785     $wsnumber = 1;
786     $myxls =& $worksheet[$wsnumber];
787     foreach ($logs['logs'] as $log) {
788         if (isset($ldcache[$log->module][$log->action])) {
789             $ld = $ldcache[$log->module][$log->action];
790         } else {
791             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
792             $ldcache[$log->module][$log->action] = $ld;
793         }
794         if ($ld && !empty($log->info)) {
795             // ugly hack to make sure fullname is shown correctly
796             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
797                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
798             } else {
799                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
800             }
801         }
803         // Filter log->info
804         $log->info = format_string($log->info);
805         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
807         if ($nroPages>1) {
808             if ($row > EXCELROWS) {
809                 $wsnumber++;
810                 $myxls =& $worksheet[$wsnumber];
811                 $row = FIRSTUSEDEXCELROW;
812             }
813         }
815         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
817         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $context)));
818         $myxls->write_date($row, 1, $log->time);
819         $myxls->write_string($row, 2, $log->ip);
820         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
821         $myxls->write_string($row, 3, $fullname);
822         $myxls->write_string($row, 4, $log->module.' '.$log->action);
823         $myxls->write_string($row, 5, $log->info);
825         $row++;
826     }
828     $workbook->close();
829     return true;
833 function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
834     global $CFG, $USER;
835     if (empty($CFG->gdversion)) {
836         echo "(".get_string("gdneed").")";
837     } else {
838         // MDL-10818, do not display broken graph when user has no permission to view graph
839         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
840             ($course->showreports and $USER->id == $userid)) {
841             echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
842                  '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
843         }
844     }
848 function print_overview($courses, array $remote_courses=array()) {
849     global $CFG, $USER, $DB, $OUTPUT;
851     $htmlarray = array();
852     if ($modules = $DB->get_records('modules')) {
853         foreach ($modules as $mod) {
854             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
855                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
856                 $fname = $mod->name.'_print_overview';
857                 if (function_exists($fname)) {
858                     $fname($courses,$htmlarray);
859                 }
860             }
861         }
862     }
863     foreach ($courses as $course) {
864         echo $OUTPUT->box_start('coursebox');
865         $attributes = array('title' => s($course->fullname));
866         if (empty($course->visible)) {
867             $attributes['class'] = 'dimmed';
868         }
869         echo $OUTPUT->heading(html_writer::link(
870             new moodle_url('/course/view.php', array('id' => $course->id)), format_string($course->fullname), $attributes), 3);
871         if (array_key_exists($course->id,$htmlarray)) {
872             foreach ($htmlarray[$course->id] as $modname => $html) {
873                 echo $html;
874             }
875         }
876         echo $OUTPUT->box_end();
877     }
879     if (!empty($remote_courses)) {
880         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
881     }
882     foreach ($remote_courses as $course) {
883         echo $OUTPUT->box_start('coursebox');
884         $attributes = array('title' => s($course->fullname));
885         echo $OUTPUT->heading(html_writer::link(
886             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
887             format_string($course->shortname),
888             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
889         echo $OUTPUT->box_end();
890     }
894 /**
895  * This function trawls through the logs looking for
896  * anything new since the user's last login
897  */
898 function print_recent_activity($course) {
899     // $course is an object
900     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
902     $context = get_context_instance(CONTEXT_COURSE, $course->id);
904     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
906     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
908     if (!isguestuser()) {
909         if (!empty($USER->lastcourseaccess[$course->id])) {
910             if ($USER->lastcourseaccess[$course->id] > $timestart) {
911                 $timestart = $USER->lastcourseaccess[$course->id];
912             }
913         }
914     }
916     echo '<div class="activitydate">';
917     echo get_string('activitysince', '', userdate($timestart));
918     echo '</div>';
919     echo '<div class="activityhead">';
921     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
923     echo "</div>\n";
925     $content = false;
927 /// Firstly, have there been any new enrolments?
929     $users = get_recent_enrolments($course->id, $timestart);
931     //Accessibility: new users now appear in an <OL> list.
932     if ($users) {
933         echo '<div class="newusers">';
934         echo $OUTPUT->heading(get_string("newusers").':', 3);
935         $content = true;
936         echo "<ol class=\"list\">\n";
937         foreach ($users as $user) {
938             $fullname = fullname($user, $viewfullnames);
939             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
940         }
941         echo "</ol>\n</div>\n";
942     }
944 /// Next, have there been any modifications to the course structure?
946     $modinfo =& get_fast_modinfo($course);
948     $changelist = array();
950     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
951                                             module = 'course' AND
952                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
953                                     array($timestart, $course->id), "id ASC");
955     if ($logs) {
956         $actions  = array('add mod', 'update mod', 'delete mod');
957         $newgones = array(); // added and later deleted items
958         foreach ($logs as $key => $log) {
959             if (!in_array($log->action, $actions)) {
960                 continue;
961             }
962             $info = explode(' ', $log->info);
964             // note: in most cases I replaced hardcoding of label with use of
965             // $cm->has_view() but it was not possible to do this here because
966             // we don't necessarily have the $cm for it
967             if ($info[0] == 'label') {     // Labels are ignored in recent activity
968                 continue;
969             }
971             if (count($info) != 2) {
972                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
973                 continue;
974             }
976             $modname    = $info[0];
977             $instanceid = $info[1];
979             if ($log->action == 'delete mod') {
980                 // unfortunately we do not know if the mod was visible
981                 if (!array_key_exists($log->info, $newgones)) {
982                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
983                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
984                 }
985             } else {
986                 if (!isset($modinfo->instances[$modname][$instanceid])) {
987                     if ($log->action == 'add mod') {
988                         // do not display added and later deleted activities
989                         $newgones[$log->info] = true;
990                     }
991                     continue;
992                 }
993                 $cm = $modinfo->instances[$modname][$instanceid];
994                 if (!$cm->uservisible) {
995                     continue;
996                 }
998                 if ($log->action == 'add mod') {
999                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
1000                     $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>");
1002                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
1003                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
1004                     $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>");
1005                 }
1006             }
1007         }
1008     }
1010     if (!empty($changelist)) {
1011         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1012         $content = true;
1013         foreach ($changelist as $changeinfo => $change) {
1014             echo '<p class="activity">'.$change['text'].'</p>';
1015         }
1016     }
1018 /// Now display new things from each module
1020     $usedmodules = array();
1021     foreach($modinfo->cms as $cm) {
1022         if (isset($usedmodules[$cm->modname])) {
1023             continue;
1024         }
1025         if (!$cm->uservisible) {
1026             continue;
1027         }
1028         $usedmodules[$cm->modname] = $cm->modname;
1029     }
1031     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1032         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1033             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1034             $print_recent_activity = $modname.'_print_recent_activity';
1035             if (function_exists($print_recent_activity)) {
1036                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1037                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1038             }
1039         } else {
1040             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1041         }
1042     }
1044     if (! $content) {
1045         echo '<p class="message">'.get_string('nothingnew').'</p>';
1046     }
1049 /**
1050  * For a given course, returns an array of course activity objects
1051  * Each item in the array contains he following properties:
1052  */
1053 function get_array_of_activities($courseid) {
1054 //  cm - course module id
1055 //  mod - name of the module (eg forum)
1056 //  section - the number of the section (eg week or topic)
1057 //  name - the name of the instance
1058 //  visible - is the instance visible or not
1059 //  groupingid - grouping id
1060 //  groupmembersonly - is this instance visible to group members only
1061 //  extra - contains extra string to include in any link
1062     global $CFG, $DB;
1063     if(!empty($CFG->enableavailability)) {
1064         require_once($CFG->libdir.'/conditionlib.php');
1065     }
1067     $course = $DB->get_record('course', array('id'=>$courseid));
1069     if (empty($course)) {
1070         throw new moodle_exception('courseidnotfound');
1071     }
1073     $mod = array();
1075     $rawmods = get_course_mods($courseid);
1076     if (empty($rawmods)) {
1077         return $mod; // always return array
1078     }
1080     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1081        foreach ($sections as $section) {
1082            if (!empty($section->sequence)) {
1083                $sequence = explode(",", $section->sequence);
1084                foreach ($sequence as $seq) {
1085                    if (empty($rawmods[$seq])) {
1086                        continue;
1087                    }
1088                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1089                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1090                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1092                     // Oh dear. Inconsistent names left here for backward compatibility.
1093                    $mod[$seq]->section          = $section->section;
1094                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1096                    $mod[$seq]->module           = $rawmods[$seq]->module;
1097                    $mod[$seq]->added            = $rawmods[$seq]->added;
1098                    $mod[$seq]->score            = $rawmods[$seq]->score;
1099                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1100                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1101                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1102                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1103                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1104                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1105                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1106                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1107                    $mod[$seq]->extra            = "";
1108                    $mod[$seq]->completiongradeitemnumber =
1109                            $rawmods[$seq]->completiongradeitemnumber;
1110                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1111                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1112                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1113                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1114                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1115                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1116                    if (!empty($CFG->enableavailability)) {
1117                        condition_info::fill_availability_conditions($rawmods[$seq]);
1118                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1119                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1120                    }
1122                    $modname = $mod[$seq]->mod;
1123                    $functionname = $modname."_get_coursemodule_info";
1125                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1126                        continue;
1127                    }
1129                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1131                    if ($hasfunction = function_exists($functionname)) {
1132                        if ($info = $functionname($rawmods[$seq])) {
1133                            if (!empty($info->icon)) {
1134                                $mod[$seq]->icon = $info->icon;
1135                            }
1136                            if (!empty($info->iconcomponent)) {
1137                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1138                            }
1139                            if (!empty($info->name)) {
1140                                $mod[$seq]->name = $info->name;
1141                            }
1142                            if ($info instanceof cached_cm_info) {
1143                                // When using cached_cm_info you can include three new fields
1144                                // that aren't available for legacy code
1145                                if (!empty($info->content)) {
1146                                    $mod[$seq]->content = $info->content;
1147                                }
1148                                if (!empty($info->extraclasses)) {
1149                                    $mod[$seq]->extraclasses = $info->extraclasses;
1150                                }
1151                                if (!empty($info->onclick)) {
1152                                    $mod[$seq]->onclick = $info->onclick;
1153                                }
1154                                if (!empty($info->customdata)) {
1155                                    $mod[$seq]->customdata = $info->customdata;
1156                                }
1157                            } else {
1158                                // When using a stdclass, the (horrible) deprecated ->extra field
1159                                // is available for BC
1160                                if (!empty($info->extra)) {
1161                                    $mod[$seq]->extra = $info->extra;
1162                                }
1163                            }
1164                        }
1165                    }
1166                    // When there is no modname_get_coursemodule_info function,
1167                    // but showdescriptions is enabled, then we use the 'intro'
1168                    // and 'introformat' fields in the module table
1169                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1170                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1171                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1172                            // Set content from intro and introformat. Filters are disabled
1173                            // because we  filter it with format_text at display time
1174                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1175                                    $modvalues, $rawmods[$seq]->id, false);
1177                            // To save making another query just below, put name in here
1178                            $mod[$seq]->name = $modvalues->name;
1179                        }
1180                    }
1181                    if (!isset($mod[$seq]->name)) {
1182                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1183                    }
1185                    // Minimise the database size by unsetting default options when they are
1186                    // 'empty'. This list corresponds to code in the cm_info constructor.
1187                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1188                            'indent', 'completion', 'extra', 'extraclasses', 'onclick', 'content',
1189                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1190                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1191                            'completionview', 'completionexpected', 'score', 'showdescription')
1192                            as $property) {
1193                        if (property_exists($mod[$seq], $property) &&
1194                                empty($mod[$seq]->{$property})) {
1195                            unset($mod[$seq]->{$property});
1196                        }
1197                    }
1198                    // Special case: this value is usually set to null, but may be 0
1199                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1200                            is_null($mod[$seq]->completiongradeitemnumber)) {
1201                        unset($mod[$seq]->completiongradeitemnumber);
1202                    }
1203                }
1204             }
1205         }
1206     }
1207     return $mod;
1211 /**
1212  * Returns a number of useful structures for course displays
1213  */
1214 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1215     global $CFG, $DB, $COURSE;
1217     $mods          = array();    // course modules indexed by id
1218     $modnames      = array();    // all course module names (except resource!)
1219     $modnamesplural= array();    // all course module names (plural form)
1220     $modnamesused  = array();    // course module names used
1222     if ($allmods = $DB->get_records("modules")) {
1223         foreach ($allmods as $mod) {
1224             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1225                 continue;
1226             }
1227             if ($mod->visible) {
1228                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1229                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1230             }
1231         }
1232         collatorlib::asort($modnames);
1233     } else {
1234         print_error("nomodules", 'debug');
1235     }
1237     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1238     $modinfo = get_fast_modinfo($course);
1240     if ($rawmods=$modinfo->cms) {
1241         foreach($rawmods as $mod) {    // Index the mods
1242             if (empty($modnames[$mod->modname])) {
1243                 continue;
1244             }
1245             $mods[$mod->id] = $mod;
1246             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1247             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1248                 continue;
1249             }
1250             // Check groupings
1251             if (!groups_course_module_visible($mod)) {
1252                 continue;
1253             }
1254             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1255         }
1256         if ($modnamesused) {
1257             collatorlib::asort($modnamesused);
1258         }
1259     }
1262 /**
1263  * Returns an array of sections for the requested course id
1264  *
1265  * This function stores the sections against the course id within a staticvar encase
1266  * of subsequent requests. This is used all over + in some standard libs and course
1267  * format callbacks so subsequent requests are a reality.
1268  *
1269  * @staticvar array $coursesections
1270  * @param int $courseid
1271  * @return array Array of sections
1272  */
1273 function get_all_sections($courseid) {
1274     global $DB;
1275     static $coursesections = array();
1276     if (!array_key_exists($courseid, $coursesections)) {
1277         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1278                            "section, id, course, name, summary, summaryformat, sequence, visible");
1279     }
1280     return $coursesections[$courseid];
1283 /**
1284  * Returns the course section to display or 0 meaning show all sections. Returns 0 for guests.
1285  * It also sets the $USER->display cache to array($courseid=>return value)
1286  *
1287  * @param int $courseid The course id
1288  * @return int Course section to display, 0 means all
1289  */
1290 function course_get_display($courseid) {
1291     global $USER, $DB;
1293     if (!isloggedin() or isguestuser()) {
1294         //do not get settings in db for guests
1295         return 0; //return the implicit setting
1296     }
1298     if (!isset($USER->display[$courseid])) {
1299         if (!$display = $DB->get_field('course_display', 'display', array('userid' => $USER->id, 'course'=>$courseid))) {
1300             $display = 0; // all sections option is not stored in DB, this makes the table much smaller
1301         }
1302         //use display cache for one course only - we need to keep session small
1303         $USER->display = array($courseid => $display);
1304     }
1306     return $USER->display[$courseid];
1309 /**
1310  * Show one section only or all sections.
1311  *
1312  * @param int $courseid The course id
1313  * @param mixed $display show only this section, 0 or 'all' means show all sections
1314  * @return int Course section to display, 0 means all
1315  */
1316 function course_set_display($courseid, $display) {
1317     global $USER, $DB;
1319     if ($display === 'all' or empty($display)) {
1320         $display = 0;
1321     }
1323     if (!isloggedin() or isguestuser()) {
1324         //do not store settings in db for guests
1325         return 0;
1326     }
1328     if ($display == 0) {
1329         //show all, do not store anything in database
1330         $DB->delete_records('course_display', array('userid' => $USER->id, 'course' => $courseid));
1332     } else {
1333         if ($DB->record_exists('course_display', array('userid' => $USER->id, 'course' => $courseid))) {
1334             $DB->set_field('course_display', 'display', $display, array('userid' => $USER->id, 'course' => $courseid));
1335         } else {
1336             $record = new stdClass();
1337             $record->userid = $USER->id;
1338             $record->course = $courseid;
1339             $record->display = $display;
1340             $DB->insert_record('course_display', $record);
1341         }
1342     }
1344     //use display cache for one course only - we need to keep session small
1345     $USER->display = array($courseid => $display);
1347     return $display;
1350 /**
1351  * For a given course section, marks it visible or hidden,
1352  * and does the same for every activity in that section
1353  */
1354 function set_section_visible($courseid, $sectionnumber, $visibility) {
1355     global $DB;
1357     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1358         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1359         if (!empty($section->sequence)) {
1360             $modules = explode(",", $section->sequence);
1361             foreach ($modules as $moduleid) {
1362                 set_coursemodule_visible($moduleid, $visibility, true);
1363             }
1364         }
1365         rebuild_course_cache($courseid);
1366     }
1369 /**
1370  * Obtains shared data that is used in print_section when displaying a
1371  * course-module entry.
1372  *
1373  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1374  *
1375  * This data is also used in other areas of the code.
1376  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1377  * @param object $course Moodle course object
1378  * @return array An array with the following values in this order:
1379  *   $content (optional extra content for after link),
1380  *   $instancename (text of link)
1381  */
1382 function get_print_section_cm_text(cm_info $cm, $course) {
1383     global $OUTPUT;
1385     // Get content from modinfo if specified. Content displays either
1386     // in addition to the standard link (below), or replaces it if
1387     // the link is turned off by setting ->url to null.
1388     if (($content = $cm->get_content()) !== '') {
1389         // Improve filter performance by preloading filter setttings for all
1390         // activities on the course (this does nothing if called multiple
1391         // times)
1392         filter_preload_activities($cm->get_modinfo());
1394         // Get module context
1395         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1396         $labelformatoptions = new stdClass();
1397         $labelformatoptions->noclean = true;
1398         $labelformatoptions->overflowdiv = true;
1399         $labelformatoptions->context = $modulecontext;
1400         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1401     } else {
1402         $content = '';
1403     }
1405     // Get course context
1406     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1407     $stringoptions = new stdClass;
1408     $stringoptions->context = $coursecontext;
1409     $instancename = format_string($cm->name, true,  $stringoptions);
1410     return array($content, $instancename);
1413 /**
1414  * Prints a section full of activity modules
1415  */
1416 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1417     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1419     static $initialised;
1421     static $groupbuttons;
1422     static $groupbuttonslink;
1423     static $isediting;
1424     static $ismoving;
1425     static $strmovehere;
1426     static $strmovefull;
1427     static $strunreadpostsone;
1428     static $groupings;
1429     static $modulenames;
1431     if (!isset($initialised)) {
1432         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1433         $groupbuttonslink = (!$course->groupmodeforce);
1434         $isediting        = $PAGE->user_is_editing();
1435         $ismoving         = $isediting && ismoving($course->id);
1436         if ($ismoving) {
1437             $strmovehere  = get_string("movehere");
1438             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1439         }
1440         $modulenames      = array();
1441         $initialised = true;
1442     }
1444     $tl = textlib_get_instance();
1446     $modinfo = get_fast_modinfo($course);
1447     $completioninfo = new completion_info($course);
1449     //Accessibility: replace table with list <ul>, but don't output empty list.
1450     if (!empty($section->sequence)) {
1452         // Fix bug #5027, don't want style=\"width:$width\".
1453         echo "<ul class=\"section img-text\">\n";
1454         $sectionmods = explode(",", $section->sequence);
1456         foreach ($sectionmods as $modnumber) {
1457             if (empty($mods[$modnumber])) {
1458                 continue;
1459             }
1461             /**
1462              * @var cm_info
1463              */
1464             $mod = $mods[$modnumber];
1466             if ($ismoving and $mod->id == $USER->activitycopy) {
1467                 // do not display moving mod
1468                 continue;
1469             }
1471             if (isset($modinfo->cms[$modnumber])) {
1472                 // We can continue (because it will not be displayed at all)
1473                 // if:
1474                 // 1) The activity is not visible to users
1475                 // and
1476                 // 2a) The 'showavailability' option is not set (if that is set,
1477                 //     we need to display the activity so we can show
1478                 //     availability info)
1479                 // or
1480                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1481                 //     hidden in a way that leaves no info, such as using the
1482                 //     eye icon.
1483                 if (!$modinfo->cms[$modnumber]->uservisible &&
1484                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1485                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1486                     // visibility shortcut
1487                     continue;
1488                 }
1489             } else {
1490                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1491                     // module not installed
1492                     continue;
1493                 }
1494                 if (!coursemodule_visible_for_user($mod) &&
1495                     empty($mod->showavailability)) {
1496                     // full visibility check
1497                     continue;
1498                 }
1499             }
1501             if (!isset($modulenames[$mod->modname])) {
1502                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1503             }
1504             $modulename = $modulenames[$mod->modname];
1506             // In some cases the activity is visible to user, but it is
1507             // dimmed. This is done if viewhiddenactivities is true and if:
1508             // 1. the activity is not visible, or
1509             // 2. the activity has dates set which do not include current, or
1510             // 3. the activity has any other conditions set (regardless of whether
1511             //    current user meets them)
1512             $canviewhidden = has_capability(
1513                 'moodle/course:viewhiddenactivities',
1514                 get_context_instance(CONTEXT_MODULE, $mod->id));
1515             $accessiblebutdim = false;
1516             if ($canviewhidden) {
1517                 $accessiblebutdim = !$mod->visible;
1518                 if (!empty($CFG->enableavailability)) {
1519                     $accessiblebutdim = $accessiblebutdim ||
1520                         $mod->availablefrom > time() ||
1521                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1522                         count($mod->conditionsgrade) > 0 ||
1523                         count($mod->conditionscompletion) > 0;
1524                 }
1525             }
1527             $liclasses = array();
1528             $liclasses[] = 'activity';
1529             $liclasses[] = $mod->modname;
1530             $liclasses[] = 'modtype_'.$mod->modname;
1531             $extraclasses = $mod->get_extra_classes();
1532             if ($extraclasses) {
1533                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1534             }
1535             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1536             if ($ismoving) {
1537                 echo '<a title="'.$strmovefull.'"'.
1538                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1539                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1540                      ' alt="'.$strmovehere.'" /></a><br />
1541                      ';
1542             }
1544             $classes = array('mod-indent');
1545             if (!empty($mod->indent)) {
1546                 $classes[] = 'mod-indent-'.$mod->indent;
1547                 if ($mod->indent > 15) {
1548                     $classes[] = 'mod-indent-huge';
1549                 }
1550             }
1551             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1553             // Get data about this course-module
1554             list($content, $instancename) =
1555                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1557             //Accessibility: for files get description via icon, this is very ugly hack!
1558             $altname = '';
1559             $altname = $mod->modfullname;
1560             if (!empty($customicon)) {
1561                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1562                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1563                     $mimetype = mimeinfo_from_icon('type', $customicon);
1564                     $altname = get_mimetype_description($mimetype);
1565                 }
1566             }
1567             // Avoid unnecessary duplication: if e.g. a forum name already
1568             // includes the word forum (or Forum, etc) then it is unhelpful
1569             // to include that in the accessible description that is added.
1570             if (false !== strpos($tl->strtolower($instancename),
1571                     $tl->strtolower($altname))) {
1572                 $altname = '';
1573             }
1574             // File type after name, for alphabetic lists (screen reader).
1575             if ($altname) {
1576                 $altname = get_accesshide(' '.$altname);
1577             }
1579             // We may be displaying this just in order to show information
1580             // about visibility, without the actual link
1581             $contentpart = '';
1582             if ($mod->uservisible) {
1583                 // Nope - in this case the link is fully working for user
1584                 $linkclasses = '';
1585                 $textclasses = '';
1586                 if ($accessiblebutdim) {
1587                     $linkclasses .= ' dimmed';
1588                     $textclasses .= ' dimmed_text';
1589                     $accesstext = '<span class="accesshide">'.
1590                         get_string('hiddenfromstudents').': </span>';
1591                 } else {
1592                     $accesstext = '';
1593                 }
1594                 if ($linkclasses) {
1595                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1596                 } else {
1597                     $linkcss = '';
1598                 }
1599                 if ($textclasses) {
1600                     $textcss = 'class="' . trim($textclasses) . '" ';
1601                 } else {
1602                     $textcss = '';
1603                 }
1605                 // Get on-click attribute value if specified
1606                 $onclick = $mod->get_on_click();
1607                 if ($onclick) {
1608                     $onclick = ' onclick="' . $onclick . '"';
1609                 }
1611                 if ($url = $mod->get_url()) {
1612                     // Display link itself
1613                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1614                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1615                             '" class="activityicon" alt="' .
1616                             $modulename . '" /> ' .
1617                             $accesstext . '<span class="instancename">' .
1618                             $instancename . $altname . '</span></a>';
1620                     // If specified, display extra content after link
1621                     if ($content) {
1622                         $contentpart = '<div class="contentafterlink' .
1623                                 trim($textclasses) . '">' . $content . '</div>';
1624                     }
1625                 } else {
1626                     // No link, so display only content
1627                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1628                             $accesstext . $content . '</div>';
1629                 }
1631                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1632                     if (!isset($groupings)) {
1633                         $groupings = groups_get_all_groupings($course->id);
1634                     }
1635                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1636                 }
1637             } else {
1638                 $textclasses = $extraclasses;
1639                 $textclasses .= ' dimmed_text';
1640                 if ($textclasses) {
1641                     $textcss = 'class="' . trim($textclasses) . '" ';
1642                 } else {
1643                     $textcss = '';
1644                 }
1645                 $accesstext = '<span class="accesshide">' .
1646                         get_string('notavailableyet', 'condition') .
1647                         ': </span>';
1649                 if ($url = $mod->get_url()) {
1650                     // Display greyed-out text of link
1651                     echo '<div ' . $textcss . $mod->extra .
1652                             ' >' . '<img src="' . $mod->get_icon_url() .
1653                             '" class="activityicon" alt="' .
1654                             $modulename .
1655                             '" /> <span>'. $instancename . $altname .
1656                             '</span></div>';
1658                     // Do not display content after link when it is greyed out like this.
1659                 } else {
1660                     // No link, so display only content (also greyed)
1661                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1662                             $accesstext . $content . '</div>';
1663                 }
1664             }
1666             // Module can put text after the link (e.g. forum unread)
1667             echo $mod->get_after_link();
1669             // If there is content but NO link (eg label), then display the
1670             // content here (BEFORE any icons). In this case cons must be
1671             // displayed after the content so that it makes more sense visually
1672             // and for accessibility reasons, e.g. if you have a one-line label
1673             // it should work similarly (at least in terms of ordering) to an
1674             // activity.
1675             if (empty($url)) {
1676                 echo $contentpart;
1677             }
1679             if ($isediting) {
1680                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1681                     if (! $mod->groupmodelink = $groupbuttonslink) {
1682                         $mod->groupmode = $course->groupmode;
1683                     }
1685                 } else {
1686                     $mod->groupmode = false;
1687                 }
1688                 echo '&nbsp;&nbsp;';
1689                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1690                 echo $mod->get_after_edit_icons();
1691             }
1693             // Completion
1694             $completion = $hidecompletion
1695                 ? COMPLETION_TRACKING_NONE
1696                 : $completioninfo->is_enabled($mod);
1697             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1698                 !isguestuser() && $mod->uservisible) {
1699                 $completiondata = $completioninfo->get_data($mod,true);
1700                 $completionicon = '';
1701                 if ($isediting) {
1702                     switch ($completion) {
1703                         case COMPLETION_TRACKING_MANUAL :
1704                             $completionicon = 'manual-enabled'; break;
1705                         case COMPLETION_TRACKING_AUTOMATIC :
1706                             $completionicon = 'auto-enabled'; break;
1707                         default: // wtf
1708                     }
1709                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1710                     switch($completiondata->completionstate) {
1711                         case COMPLETION_INCOMPLETE:
1712                             $completionicon = 'manual-n'; break;
1713                         case COMPLETION_COMPLETE:
1714                             $completionicon = 'manual-y'; break;
1715                     }
1716                 } else { // Automatic
1717                     switch($completiondata->completionstate) {
1718                         case COMPLETION_INCOMPLETE:
1719                             $completionicon = 'auto-n'; break;
1720                         case COMPLETION_COMPLETE:
1721                             $completionicon = 'auto-y'; break;
1722                         case COMPLETION_COMPLETE_PASS:
1723                             $completionicon = 'auto-pass'; break;
1724                         case COMPLETION_COMPLETE_FAIL:
1725                             $completionicon = 'auto-fail'; break;
1726                     }
1727                 }
1728                 if ($completionicon) {
1729                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1730                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1731                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1732                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1733                         $newstate =
1734                             $completiondata->completionstate==COMPLETION_COMPLETE
1735                             ? COMPLETION_INCOMPLETE
1736                             : COMPLETION_COMPLETE;
1737                         // In manual mode the icon is a toggle form...
1739                         // If this completion state is used by the
1740                         // conditional activities system, we need to turn
1741                         // off the JS.
1742                         if (!empty($CFG->enableavailability) &&
1743                             condition_info::completion_value_used_as_condition($course, $mod)) {
1744                             $extraclass = ' preventjs';
1745                         } else {
1746                             $extraclass = '';
1747                         }
1748                         echo "
1749 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1750 <input type='hidden' name='id' value='{$mod->id}' />
1751 <input type='hidden' name='sesskey' value='".sesskey()."' />
1752 <input type='hidden' name='completionstate' value='$newstate' />
1753 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1754 </div></form>";
1755                     } else {
1756                         // In auto mode, or when editing, the icon is just an image
1757                         echo "<span class='autocompletion'>";
1758                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1759                     }
1760                 }
1761             }
1763             // If there is content AND a link, then display the content here
1764             // (AFTER any icons). Otherwise it was displayed before
1765             if (!empty($url)) {
1766                 echo $contentpart;
1767             }
1769             // Show availability information (for someone who isn't allowed to
1770             // see the activity itself, or for staff)
1771             if (!$mod->uservisible) {
1772                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1773             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1774                 $ci = new condition_info($mod);
1775                 $fullinfo = $ci->get_full_information();
1776                 if($fullinfo) {
1777                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1778                         ? 'userrestriction_visible'
1779                         : 'userrestriction_hidden','condition',
1780                         $fullinfo).'</div>';
1781                 }
1782             }
1784             echo html_writer::end_tag('div');
1785             echo html_writer::end_tag('li')."\n";
1786         }
1788     } elseif ($ismoving) {
1789         echo "<ul class=\"section\">\n";
1790     }
1792     if ($ismoving) {
1793         echo '<li><a title="'.$strmovefull.'"'.
1794              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1795              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1796              ' alt="'.$strmovehere.'" /></a></li>
1797              ';
1798     }
1799     if (!empty($section->sequence) || $ismoving) {
1800         echo "</ul><!--class='section'-->\n\n";
1801     }
1804 /**
1805  * Prints the menus to add activities and resources.
1806  */
1807 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1808     global $CFG, $OUTPUT;
1810     // check to see if user can add menus
1811     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1812         return false;
1813     }
1815     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1817     $resources = array();
1818     $activities = array();
1820     foreach($modnames as $modname=>$modnamestr) {
1821         if (!course_allowed_module($course, $modname)) {
1822             continue;
1823         }
1825         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1826         if (!file_exists($libfile)) {
1827             continue;
1828         }
1829         include_once($libfile);
1830         $gettypesfunc =  $modname.'_get_types';
1831         if (function_exists($gettypesfunc)) {
1832             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1833             if ($types = $gettypesfunc()) {
1834                 $menu = array();
1835                 $atype = null;
1836                 $groupname = null;
1837                 foreach($types as $type) {
1838                     if ($type->typestr === '--') {
1839                         continue;
1840                     }
1841                     if (strpos($type->typestr, '--') === 0) {
1842                         $groupname = str_replace('--', '', $type->typestr);
1843                         continue;
1844                     }
1845                     $type->type = str_replace('&amp;', '&', $type->type);
1846                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1847                         $atype = MOD_CLASS_RESOURCE;
1848                     }
1849                     $menu[$urlbase.$type->type] = $type->typestr;
1850                 }
1851                 if (!is_null($groupname)) {
1852                     if ($atype == MOD_CLASS_RESOURCE) {
1853                         $resources[] = array($groupname=>$menu);
1854                     } else {
1855                         $activities[] = array($groupname=>$menu);
1856                     }
1857                 } else {
1858                     if ($atype == MOD_CLASS_RESOURCE) {
1859                         $resources = array_merge($resources, $menu);
1860                     } else {
1861                         $activities = array_merge($activities, $menu);
1862                     }
1863                 }
1864             }
1865         } else {
1866             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1867             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1868                 $resources[$urlbase.$modname] = $modnamestr;
1869             } else {
1870                 // all other archetypes are considered activity
1871                 $activities[$urlbase.$modname] = $modnamestr;
1872             }
1873         }
1874     }
1876     $straddactivity = get_string('addactivity');
1877     $straddresource = get_string('addresource');
1879     $output  = '<div class="section_add_menus">';
1881     if (!$vertical) {
1882         $output .= '<div class="horizontal">';
1883     }
1885     if (!empty($resources)) {
1886         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1887         $select->set_help_icon('resources');
1888         $output .= $OUTPUT->render($select);
1889     }
1891     if (!empty($activities)) {
1892         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1893         $select->set_help_icon('activities');
1894         $output .= $OUTPUT->render($select);
1895     }
1897     if (!$vertical) {
1898         $output .= '</div>';
1899     }
1901     $output .= '</div>';
1903     if ($return) {
1904         return $output;
1905     } else {
1906         echo $output;
1907     }
1910 /**
1911  * Return the course category context for the category with id $categoryid, except
1912  * that if $categoryid is 0, return the system context.
1913  *
1914  * @param integer $categoryid a category id or 0.
1915  * @return object the corresponding context
1916  */
1917 function get_category_or_system_context($categoryid) {
1918     if ($categoryid) {
1919         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1920     } else {
1921         return get_context_instance(CONTEXT_SYSTEM);
1922     }
1925 /**
1926  * Gets the child categories of a given courses category. Uses a static cache
1927  * to make repeat calls efficient.
1928  *
1929  * @param int $parentid the id of a course category.
1930  * @return array all the child course categories.
1931  */
1932 function get_child_categories($parentid) {
1933     static $allcategories = null;
1935     // only fill in this variable the first time
1936     if (null == $allcategories) {
1937         $allcategories = array();
1939         $categories = get_categories();
1940         foreach ($categories as $category) {
1941             if (empty($allcategories[$category->parent])) {
1942                 $allcategories[$category->parent] = array();
1943             }
1944             $allcategories[$category->parent][] = $category;
1945         }
1946     }
1948     if (empty($allcategories[$parentid])) {
1949         return array();
1950     } else {
1951         return $allcategories[$parentid];
1952     }
1955 /**
1956  * This function recursively travels the categories, building up a nice list
1957  * for display. It also makes an array that list all the parents for each
1958  * category.
1959  *
1960  * For example, if you have a tree of categories like:
1961  *   Miscellaneous (id = 1)
1962  *      Subcategory (id = 2)
1963  *         Sub-subcategory (id = 4)
1964  *   Other category (id = 3)
1965  * Then after calling this function you will have
1966  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1967  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1968  *      3 => 'Other category');
1969  * $parents = array(2 => array(1), 4 => array(1, 2));
1970  *
1971  * If you specify $requiredcapability, then only categories where the current
1972  * user has that capability will be added to $list, although all categories
1973  * will still be added to $parents, and if you only have $requiredcapability
1974  * in a child category, not the parent, then the child catgegory will still be
1975  * included.
1976  *
1977  * If you specify the option $excluded, then that category, and all its children,
1978  * are omitted from the tree. This is useful when you are doing something like
1979  * moving categories, where you do not want to allow people to move a category
1980  * to be the child of itself.
1981  *
1982  * @param array $list For output, accumulates an array categoryid => full category path name
1983  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1984  * @param string/array $requiredcapability if given, only categories where the current
1985  *      user has this capability will be added to $list. Can also be an array of capabilities,
1986  *      in which case they are all required.
1987  * @param integer $excludeid Omit this category and its children from the lists built.
1988  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1989  * @param string $path For internal use, as part of recursive calls.
1990  */
1991 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1992         $excludeid = 0, $category = NULL, $path = "") {
1994     // initialize the arrays if needed
1995     if (!is_array($list)) {
1996         $list = array();
1997     }
1998     if (!is_array($parents)) {
1999         $parents = array();
2000     }
2002     if (empty($category)) {
2003         // Start at the top level.
2004         $category = new stdClass;
2005         $category->id = 0;
2006     } else {
2007         // This is the excluded category, don't include it.
2008         if ($excludeid > 0 && $excludeid == $category->id) {
2009             return;
2010         }
2012         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2013         $categoryname = format_string($category->name, true, array('context' => $context));
2015         // Update $path.
2016         if ($path) {
2017             $path = $path.' / '.$categoryname;
2018         } else {
2019             $path = $categoryname;
2020         }
2022         // Add this category to $list, if the permissions check out.
2023         if (empty($requiredcapability)) {
2024             $list[$category->id] = $path;
2026         } else {
2027             $requiredcapability = (array)$requiredcapability;
2028             if (has_all_capabilities($requiredcapability, $context)) {
2029                 $list[$category->id] = $path;
2030             }
2031         }
2032     }
2034     // Add all the children recursively, while updating the parents array.
2035     if ($categories = get_child_categories($category->id)) {
2036         foreach ($categories as $cat) {
2037             if (!empty($category->id)) {
2038                 if (isset($parents[$category->id])) {
2039                     $parents[$cat->id]   = $parents[$category->id];
2040                 }
2041                 $parents[$cat->id][] = $category->id;
2042             }
2043             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2044         }
2045     }
2048 /**
2049  * This function generates a structured array of courses and categories.
2050  *
2051  * The depth of categories is limited by $CFG->maxcategorydepth however there
2052  * is no limit on the number of courses!
2053  *
2054  * Suitable for use with the course renderers course_category_tree method:
2055  * $renderer = $PAGE->get_renderer('core','course');
2056  * echo $renderer->course_category_tree(get_course_category_tree());
2057  *
2058  * @global moodle_database $DB
2059  * @param int $id
2060  * @param int $depth
2061  */
2062 function get_course_category_tree($id = 0, $depth = 0) {
2063     global $DB, $CFG;
2064     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2065     $categories = get_child_categories($id);
2066     $categoryids = array();
2067     foreach ($categories as $key => &$category) {
2068         if (!$category->visible && !$viewhiddencats) {
2069             unset($categories[$key]);
2070             continue;
2071         }
2072         $categoryids[$category->id] = $category;
2073         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2074             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2075             foreach ($subcategories as $subid=>$subcat) {
2076                 $categoryids[$subid] = $subcat;
2077             }
2078             $category->courses = array();
2079         }
2080     }
2082     if ($depth > 0) {
2083         // This is a recursive call so return the required array
2084         return array($categories, $categoryids);
2085     }
2087     // The depth is 0 this function has just been called so we can finish it off
2089     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2090     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2091     $sql = "SELECT
2092             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2093             $ccselect
2094             FROM {course} c
2095             $ccjoin
2096             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2097     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2098         // loop throught them
2099         foreach ($courses as $course) {
2100             if ($course->id == SITEID) {
2101                 continue;
2102             }
2103             context_instance_preload($course);
2104             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2105                 $categoryids[$course->category]->courses[$course->id] = $course;
2106             }
2107         }
2108     }
2109     return $categories;
2112 /**
2113  * Recursive function to print out all the categories in a nice format
2114  * with or without courses included
2115  */
2116 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2117     global $CFG;
2119     // maxcategorydepth == 0 meant no limit
2120     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2121         return;
2122     }
2124     if (!$displaylist) {
2125         make_categories_list($displaylist, $parentslist);
2126     }
2128     if ($category) {
2129         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2130             print_category_info($category, $depth, $showcourses);
2131         } else {
2132             return;  // Don't bother printing children of invisible categories
2133         }
2135     } else {
2136         $category->id = "0";
2137     }
2139     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2140         $countcats = count($categories);
2141         $count = 0;
2142         $first = true;
2143         $last = false;
2144         foreach ($categories as $cat) {
2145             $count++;
2146             if ($count == $countcats) {
2147                 $last = true;
2148             }
2149             $up = $first ? false : true;
2150             $down = $last ? false : true;
2151             $first = false;
2153             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2154         }
2155     }
2158 /**
2159  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2160  */
2161 function make_categories_options() {
2162     make_categories_list($cats,$parents);
2163     foreach ($cats as $key => $value) {
2164         if (array_key_exists($key,$parents)) {
2165             if ($indent = count($parents[$key])) {
2166                 for ($i = 0; $i < $indent; $i++) {
2167                     $cats[$key] = '&nbsp;'.$cats[$key];
2168                 }
2169             }
2170         }
2171     }
2172     return $cats;
2175 /**
2176  * Prints the category info in indented fashion
2177  * This function is only used by print_whole_category_list() above
2178  */
2179 function print_category_info($category, $depth=0, $showcourses = false) {
2180     global $CFG, $DB, $OUTPUT;
2182     $strsummary = get_string('summary');
2184     $catlinkcss = null;
2185     if (!$category->visible) {
2186         $catlinkcss = array('class'=>'dimmed');
2187     }
2188     static $coursecount = null;
2189     if (null === $coursecount) {
2190         // only need to check this once
2191         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2192     }
2194     if ($showcourses and $coursecount) {
2195         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2196     } else {
2197         $catimage = "&nbsp;";
2198     }
2200     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2201     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2202     $fullname = format_string($category->name, true, array('context' => $context));
2204     if ($showcourses and $coursecount) {
2205         echo '<div class="categorylist clearfix">';
2206         $cat = '';
2207         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2208         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2209         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2211         $html = '';
2212         if ($depth > 0) {
2213             for ($i=0; $i< $depth; $i++) {
2214                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2215                 $cat = '';
2216             }
2217         } else {
2218             $html = $cat;
2219         }
2220         echo html_writer::tag('div', $html, array('class'=>'category'));
2221         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2223         // does the depth exceed maxcategorydepth
2224         // maxcategorydepth == 0 or unset meant no limit
2225         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2226         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2227             foreach ($courses as $course) {
2228                 $linkcss = null;
2229                 if (!$course->visible) {
2230                     $linkcss = array('class'=>'dimmed');
2231                 }
2233                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2235                 // print enrol info
2236                 $courseicon = '';
2237                 if ($icons = enrol_get_course_info_icons($course)) {
2238                     foreach ($icons as $pix_icon) {
2239                         $courseicon = $OUTPUT->render($pix_icon).' ';
2240                     }
2241                 }
2243                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2245                 if ($course->summary) {
2246                     $link = new moodle_url('/course/info.php?id='.$course->id);
2247                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2248                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2249                         array('title'=>$strsummary));
2251                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2252                 }
2254                 $html = '';
2255                 for ($i=0; $i <= $depth; $i++) {
2256                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2257                     $coursecontent = '';
2258                 }
2259                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2260             }
2261         }
2262         echo '</div>';
2263     } else {
2264         echo '<div class="categorylist">';
2265         $html = '';
2266         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2267         $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2269         if ($depth > 0) {
2270             for ($i=0; $i< $depth; $i++) {
2271                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2272                 $cat = '';
2273             }
2274         } else {
2275             $html = $cat;
2276         }
2278         echo html_writer::tag('div', $html, array('class'=>'category'));
2279         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2280         echo '</div>';
2281     }
2284 /**
2285  * Print the buttons relating to course requests.
2286  *
2287  * @param object $systemcontext the system context.
2288  */
2289 function print_course_request_buttons($systemcontext) {
2290     global $CFG, $DB, $OUTPUT;
2291     if (empty($CFG->enablecourserequests)) {
2292         return;
2293     }
2294     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2295     /// Print a button to request a new course
2296         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2297     }
2298     /// Print a button to manage pending requests
2299     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2300         $disabled = !$DB->record_exists('course_request', array());
2301         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2302     }
2305 /**
2306  * Does the user have permission to edit things in this category?
2307  *
2308  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2309  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2310  */
2311 function can_edit_in_category($categoryid = 0) {
2312     $context = get_category_or_system_context($categoryid);
2313     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2316 /**
2317  * Prints the turn editing on/off button on course/index.php or course/category.php.
2318  *
2319  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2320  * @return string HTML of the editing button, or empty string, if this user is not allowed
2321  *      to see it.
2322  */
2323 function update_category_button($categoryid = 0) {
2324     global $CFG, $PAGE, $OUTPUT;
2326     // Check permissions.
2327     if (!can_edit_in_category($categoryid)) {
2328         return '';
2329     }
2331     // Work out the appropriate action.
2332     if ($PAGE->user_is_editing()) {
2333         $label = get_string('turneditingoff');
2334         $edit = 'off';
2335     } else {
2336         $label = get_string('turneditingon');
2337         $edit = 'on';
2338     }
2340     // Generate the button HTML.
2341     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2342     if ($categoryid) {
2343         $options['id'] = $categoryid;
2344         $page = 'category.php';
2345     } else {
2346         $page = 'index.php';
2347     }
2348     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2351 /**
2352  * Category is 0 (for all courses) or an object
2353  */
2354 function print_courses($category) {
2355     global $CFG, $OUTPUT;
2357     if (!is_object($category) && $category==0) {
2358         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2359         if (is_array($categories) && count($categories) == 1) {
2360             $category   = array_shift($categories);
2361             $courses    = get_courses_wmanagers($category->id,
2362                                                 'c.sortorder ASC',
2363                                                 array('summary','summaryformat'));
2364         } else {
2365             $courses    = get_courses_wmanagers('all',
2366                                                 'c.sortorder ASC',
2367                                                 array('summary','summaryformat'));
2368         }
2369         unset($categories);
2370     } else {
2371         $courses    = get_courses_wmanagers($category->id,
2372                                             'c.sortorder ASC',
2373                                             array('summary','summaryformat'));
2374     }
2376     if ($courses) {
2377         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2378         foreach ($courses as $course) {
2379             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2380             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2381                 echo html_writer::start_tag('li');
2382                 print_course($course);
2383                 echo html_writer::end_tag('li');
2384             }
2385         }
2386         echo html_writer::end_tag('ul');
2387     } else {
2388         echo $OUTPUT->heading(get_string("nocoursesyet"));
2389         $context = get_context_instance(CONTEXT_SYSTEM);
2390         if (has_capability('moodle/course:create', $context)) {
2391             $options = array();
2392             if (!empty($category->id)) {
2393                 $options['category'] = $category->id;
2394             } else {
2395                 $options['category'] = $CFG->defaultrequestcategory;
2396             }
2397             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2398             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2399             echo html_writer::end_tag('div');
2400         }
2401     }
2404 /**
2405  * Print a description of a course, suitable for browsing in a list.
2406  *
2407  * @param object $course the course object.
2408  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2409  */
2410 function print_course($course, $highlightterms = '') {
2411     global $CFG, $USER, $DB, $OUTPUT;
2413     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2415     // Rewrite file URLs so that they are correct
2416     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2418     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2419     echo html_writer::start_tag('div', array('class'=>'info'));
2420     echo html_writer::start_tag('h3', array('class'=>'name'));
2422     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2423     $linktext = highlight($highlightterms, format_string($course->fullname));
2424     $linkparams = array('title'=>get_string('entercourse'));
2425     if (empty($course->visible)) {
2426         $linkparams['class'] = 'dimmed';
2427     }
2428     echo html_writer::link($linkhref, $linktext, $linkparams);
2429     echo html_writer::end_tag('h3');
2431     /// first find all roles that are supposed to be displayed
2432     if (!empty($CFG->coursecontact)) {
2433         $managerroles = explode(',', $CFG->coursecontact);
2434         $namesarray = array();
2435         if (isset($course->managers)) {
2436             if (count($course->managers)) {
2437                 $rusers = $course->managers;
2438                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2440                  /// Rename some of the role names if needed
2441                 if (isset($context)) {
2442                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2443                 }
2445                 // keep a note of users displayed to eliminate duplicates
2446                 $usersshown = array();
2447                 foreach ($rusers as $ra) {
2449                     // if we've already displayed user don't again
2450                     if (in_array($ra->user->id,$usersshown)) {
2451                         continue;
2452                     }
2453                     $usersshown[] = $ra->user->id;
2455                     $fullname = fullname($ra->user, $canviewfullnames);
2457                     if (isset($aliasnames[$ra->roleid])) {
2458                         $ra->rolename = $aliasnames[$ra->roleid]->name;
2459                     }
2461                     $namesarray[] = format_string($ra->rolename).': '.
2462                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
2463                 }
2464             }
2465         } else {
2466             $rusers = get_role_users($managerroles, $context,
2467                                      true, '', 'r.sortorder ASC, u.lastname ASC');
2468             if (is_array($rusers) && count($rusers)) {
2469                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2471                 /// Rename some of the role names if needed
2472                 if (isset($context)) {
2473                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2474                 }
2476                 foreach ($rusers as $teacher) {
2477                     $fullname = fullname($teacher, $canviewfullnames);
2479                     /// Apply role names
2480                     if (isset($aliasnames[$teacher->roleid])) {
2481                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2482                     }
2484                     $namesarray[] = format_string($teacher->rolename).': '.
2485                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
2486                 }
2487             }
2488         }
2490         if (!empty($namesarray)) {
2491             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2492             foreach ($namesarray as $name) {
2493                 echo html_writer::tag('li', $name);
2494             }
2495             echo html_writer::end_tag('ul');
2496         }
2497     }
2498     echo html_writer::end_tag('div'); // End of info div
2500     echo html_writer::start_tag('div', array('class'=>'summary'));
2501     $options = NULL;
2502     $options->noclean = true;
2503     $options->para = false;
2504     $options->overflowdiv = true;
2505     if (!isset($course->summaryformat)) {
2506         $course->summaryformat = FORMAT_MOODLE;
2507     }
2508     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2509     if ($icons = enrol_get_course_info_icons($course)) {
2510         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2511         foreach ($icons as $icon) {
2512             echo $OUTPUT->render($icon);
2513         }
2514         echo html_writer::end_tag('div'); // End of enrolmenticons div
2515     }
2516     echo html_writer::end_tag('div'); // End of summary div
2517     echo html_writer::end_tag('div'); // End of coursebox div
2520 /**
2521  * Prints custom user information on the home page.
2522  * Over time this can include all sorts of information
2523  */
2524 function print_my_moodle() {
2525     global $USER, $CFG, $DB, $OUTPUT;
2527     if (!isloggedin() or isguestuser()) {
2528         print_error('nopermissions', '', '', 'See My Moodle');
2529     }
2531     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2532     $rhosts   = array();
2533     $rcourses = array();
2534     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2535         $rcourses = get_my_remotecourses($USER->id);
2536         $rhosts   = get_my_remotehosts();
2537     }
2539     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2541         if (!empty($courses)) {
2542             echo '<ul class="unlist">';
2543             foreach ($courses as $course) {
2544                 if ($course->id == SITEID) {
2545                     continue;
2546                 }
2547                 echo '<li>';
2548                 print_course($course);
2549                 echo "</li>\n";
2550             }
2551             echo "</ul>\n";
2552         }
2554         // MNET
2555         if (!empty($rcourses)) {
2556             // at the IDP, we know of all the remote courses
2557             foreach ($rcourses as $course) {
2558                 print_remote_course($course, "100%");
2559             }
2560         } elseif (!empty($rhosts)) {
2561             // non-IDP, we know of all the remote servers, but not courses
2562             foreach ($rhosts as $host) {
2563                 print_remote_host($host, "100%");
2564             }
2565         }
2566         unset($course);
2567         unset($host);
2569         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2570             echo "<table width=\"100%\"><tr><td align=\"center\">";
2571             print_course_search("", false, "short");
2572             echo "</td><td align=\"center\">";
2573             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2574             echo "</td></tr></table>\n";
2575         }
2577     } else {
2578         if ($DB->count_records("course_categories") > 1) {
2579             echo $OUTPUT->box_start("categorybox");
2580             print_whole_category_list();
2581             echo $OUTPUT->box_end();
2582         } else {
2583             print_courses(0);
2584         }
2585     }
2589 function print_course_search($value="", $return=false, $format="plain") {
2590     global $CFG;
2591     static $count = 0;
2593     $count++;
2595     $id = 'coursesearch';
2597     if ($count > 1) {
2598         $id .= $count;
2599     }
2601     $strsearchcourses= get_string("searchcourses");
2603     if ($format == 'plain') {
2604         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2605         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2606         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2607         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2608         $output .= '<input type="submit" value="'.get_string('go').'" />';
2609         $output .= '</fieldset></form>';
2610     } else if ($format == 'short') {
2611         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2612         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2613         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2614         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2615         $output .= '<input type="submit" value="'.get_string('go').'" />';
2616         $output .= '</fieldset></form>';
2617     } else if ($format == 'navbar') {
2618         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2619         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2620         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2621         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2622         $output .= '<input type="submit" value="'.get_string('go').'" />';
2623         $output .= '</fieldset></form>';
2624     }
2626     if ($return) {
2627         return $output;
2628     }
2629     echo $output;
2632 function print_remote_course($course, $width="100%") {
2633     global $CFG, $USER;
2635     $linkcss = '';
2637     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2639     echo '<div class="coursebox remotecoursebox clearfix">';
2640     echo '<div class="info">';
2641     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2642          $linkcss.' href="'.$url.'">'
2643         .  format_string($course->fullname) .'</a><br />'
2644         . format_string($course->hostname) . ' : '
2645         . format_string($course->cat_name) . ' : '
2646         . format_string($course->shortname). '</div>';
2647     echo '</div><div class="summary">';
2648     $options = NULL;
2649     $options->noclean = true;
2650     $options->para = false;
2651     $options->overflowdiv = true;
2652     echo format_text($course->summary, $course->summaryformat, $options);
2653     echo '</div>';
2654     echo '</div>';
2657 function print_remote_host($host, $width="100%") {
2658     global $OUTPUT;
2660     $linkcss = '';
2662     echo '<div class="coursebox clearfix">';
2663     echo '<div class="info">';
2664     echo '<div class="name">';
2665     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2666     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2667         . s($host['name']).'</a> - ';
2668     echo $host['count'] . ' ' . get_string('courses');
2669     echo '</div>';
2670     echo '</div>';
2671     echo '</div>';
2675 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2677 function add_course_module($mod) {
2678     global $DB;
2680     $mod->added = time();
2681     unset($mod->id);
2683     return $DB->insert_record("course_modules", $mod);
2686 /**
2687  * Returns course section - creates new if does not exist yet.
2688  * @param int $relative section number
2689  * @param int $courseid
2690  * @return object $course_section object
2691  */
2692 function get_course_section($section, $courseid) {
2693     global $DB;
2695     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2696         return $cw;
2697     }
2698     $cw = new stdClass();
2699     $cw->course   = $courseid;
2700     $cw->section  = $section;
2701     $cw->summary  = "";
2702     $cw->summaryformat = FORMAT_HTML;
2703     $cw->sequence = "";
2704     $id = $DB->insert_record("course_sections", $cw);
2705     return $DB->get_record("course_sections", array("id"=>$id));
2707 /**
2708  * Given a full mod object with section and course already defined, adds this module to that section.
2709  *
2710  * @param object $mod
2711  * @param int $beforemod An existing ID which we will insert the new module before
2712  * @return int The course_sections ID where the mod is inserted
2713  */
2714 function add_mod_to_section($mod, $beforemod=NULL) {
2715     global $DB;
2717     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2719         $section->sequence = trim($section->sequence);
2721         if (empty($section->sequence)) {
2722             $newsequence = "$mod->coursemodule";
2724         } else if ($beforemod) {
2725             $modarray = explode(",", $section->sequence);
2727             if ($key = array_keys($modarray, $beforemod->id)) {
2728                 $insertarray = array($mod->id, $beforemod->id);
2729                 array_splice($modarray, $key[0], 1, $insertarray);
2730                 $newsequence = implode(",", $modarray);
2732             } else {  // Just tack it on the end anyway
2733                 $newsequence = "$section->sequence,$mod->coursemodule";
2734             }
2736         } else {
2737             $newsequence = "$section->sequence,$mod->coursemodule";
2738         }
2740         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2741         return $section->id;     // Return course_sections ID that was used.
2743     } else {  // Insert a new record
2744         $section->course   = $mod->course;
2745         $section->section  = $mod->section;
2746         $section->summary  = "";
2747         $section->summaryformat = FORMAT_HTML;
2748         $section->sequence = $mod->coursemodule;
2749         return $DB->insert_record("course_sections", $section);
2750     }
2753 function set_coursemodule_groupmode($id, $groupmode) {
2754     global $DB;
2755     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2758 function set_coursemodule_idnumber($id, $idnumber) {
2759     global $DB;
2760     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2763 /**
2764 * $prevstateoverrides = true will set the visibility of the course module
2765 * to what is defined in visibleold. This enables us to remember the current
2766 * visibility when making a whole section hidden, so that when we toggle
2767 * that section back to visible, we are able to return the visibility of
2768 * the course module back to what it was originally.
2769 */
2770 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2771     global $DB, $CFG;
2772     require_once($CFG->libdir.'/gradelib.php');
2774     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2775         return false;
2776     }
2777     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2778         return false;
2779     }
2780     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2781         foreach($events as $event) {
2782             if ($visible) {
2783                 show_event($event);
2784             } else {
2785                 hide_event($event);
2786             }
2787         }
2788     }
2790     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2791     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2792     if ($grade_items) {
2793         foreach ($grade_items as $grade_item) {
2794             $grade_item->set_hidden(!$visible);
2795         }
2796     }
2798     if ($prevstateoverrides) {
2799         if ($visible == '0') {
2800             // Remember the current visible state so we can toggle this back.
2801             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2802         } else {
2803             // Get the previous saved visible states.
2804             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2805         }
2806     }
2807     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2810 /**
2811  * Delete a course module and any associated data at the course level (events)
2812  * Until 1.5 this function simply marked a deleted flag ... now it
2813  * deletes it completely.
2814  *
2815  */
2816 function delete_course_module($id) {
2817     global $CFG, $DB;
2818     require_once($CFG->libdir.'/gradelib.php');
2819     require_once($CFG->dirroot.'/blog/lib.php');
2821     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2822         return true;
2823     }
2824     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2825     //delete events from calendar
2826     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2827         foreach($events as $event) {
2828             delete_event($event->id);
2829         }
2830     }
2831     //delete grade items, outcome items and grades attached to modules
2832     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2833                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2834         foreach ($grade_items as $grade_item) {
2835             $grade_item->delete('moddelete');
2836         }
2837     }
2838     // Delete completion and availability data; it is better to do this even if the
2839     // features are not turned on, in case they were turned on previously (these will be
2840     // very quick on an empty table)
2841     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2842     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2844     delete_context(CONTEXT_MODULE, $cm->id);
2845     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2848 function delete_mod_from_section($mod, $section) {
2849     global $DB;
2851     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2853         $modarray = explode(",", $section->sequence);
2855         if ($key = array_keys ($modarray, $mod)) {
2856             array_splice($modarray, $key[0], 1);
2857             $newsequence = implode(",", $modarray);
2858             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2859         } else {
2860             return false;
2861         }
2863     }
2864     return false;
2867 /**
2868  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2869  *
2870  * @param object $course
2871  * @param int $section
2872  * @param int $move (-1 or 1)
2873  */
2874 function move_section($course, $section, $move) {
2875 /// Moves a whole course section up and down within the course
2876     global $USER, $DB;
2878     if (!$move) {
2879         return true;
2880     }
2882     $sectiondest = $section + $move;
2884     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2885         return false;
2886     }
2888     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2889         return false;
2890     }
2892     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2893         return false;
2894     }
2896     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2897     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2899     // if the focus is on the section that is being moved, then move the focus along
2900     if (course_get_display($course->id) == $section) {
2901         course_set_display($course->id, $sectiondest);
2902     }
2904     // Check for duplicates and fix order if needed.
2905     // There is a very rare case that some sections in the same course have the same section id.
2906     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2907     $n = 0;
2908     foreach ($sections as $section) {
2909         if ($section->section != $n) {
2910             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2911         }
2912         $n++;
2913     }
2914     return true;
2917 /**
2918  * Moves a section within a course, from a position to another.
2919  * Be very careful: $section and $destination refer to section number,
2920  * not id!.
2921  *
2922  * @param object $course
2923  * @param int $section Section number (not id!!!)
2924  * @param int $destination
2925  * @return boolean Result
2926  */
2927 function move_section_to($course, $section, $destination) {
2928 /// Moves a whole course section up and down within the course
2929     global $USER, $DB;
2931     if (!$destination && $destination != 0) {
2932         return true;
2933     }
2935     if ($destination > $course->numsections) {
2936         return false;
2937     }
2939     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2940     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2941             'section ASC, id ASC', 'id, section')) {
2942         return false;
2943     }
2945     $sections = reorder_sections($sections, $section, $destination);
2947     // Update all sections
2948     foreach ($sections as $id => $position) {
2949         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2950     }
2952     // if the focus is on the section that is being moved, then move the focus along
2953     if (course_get_display($course->id) == $section) {
2954         course_set_display($course->id, $destination);
2955     }
2956     return true;
2959 /**
2960  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2961  * an original position number and a target position number, rebuilds the array so that the
2962  * move is made without any duplication of section positions.
2963  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2964  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2965  *
2966  * @param array $sections
2967  * @param int $origin_position
2968  * @param int $target_position
2969  * @return array
2970  */
2971 function reorder_sections($sections, $origin_position, $target_position) {
2972     if (!is_array($sections)) {
2973         return false;
2974     }
2976     // We can't move section position 0
2977     if ($origin_position < 1) {
2978         echo "We can't move section position 0";
2979         return false;
2980     }
2982     // Locate origin section in sections array
2983     if (!$origin_key = array_search($origin_position, $sections)) {
2984         echo "searched position not in sections array";
2985         return false; // searched position not in sections array
2986     }
2988     // Extract origin section
2989     $origin_section = $sections[$origin_key];
2990     unset($sections[$origin_key]);
2992     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2993     $found = false;
2994     $append_array = array();
2995     foreach ($sections as $id => $position) {
2996         if ($found) {
2997             $append_array[$id] = $position;
2998             unset($sections[$id]);
2999         }
3000         if ($position == $target_position) {
3001             $found = true;
3002         }
3003     }
3005     // Append moved section
3006     $sections[$origin_key] = $origin_section;
3008     // Append rest of array (if applicable)
3009     if (!empty($append_array)) {
3010         foreach ($append_array as $id => $position) {
3011             $sections[$id] = $position;
3012         }
3013     }
3015     // Renumber positions
3016     $position = 0;
3017     foreach ($sections as $id => $p) {
3018         $sections[$id] = $position;
3019         $position++;
3020     }
3022     return $sections;
3026 /**
3027  * Move the module object $mod to the specified $section
3028  * If $beforemod exists then that is the module
3029  * before which $modid should be inserted
3030  * All parameters are objects
3031  */
3032 function moveto_module($mod, $section, $beforemod=NULL) {
3033     global $DB, $OUTPUT;
3035 /// Remove original module from original section
3036     if (! delete_mod_from_section($mod->id, $mod->section)) {
3037         echo $OUTPUT->notification("Could not delete module from existing section");
3038     }
3040 /// Update module itself if necessary
3042     if ($mod->section != $section->id) {
3043         $mod->section = $section->id;
3044         $DB->update_record("course_modules", $mod);
3045         // if moving to a hidden section then hide module
3046         if (!$section->visible) {
3047             set_coursemodule_visible($mod->id, 0);
3048         }
3049     }
3051 /// Add the module into the new section
3053     $mod->course       = $section->course;
3054     $mod->section      = $section->section;  // need relative reference
3055     $mod->coursemodule = $mod->id;
3057     if (! add_mod_to_section($mod, $beforemod)) {
3058         return false;
3059     }
3061     return true;
3064 /**
3065  * Produces the editing buttons for a module
3066  *
3067  * @global core_renderer $OUTPUT
3068  * @staticvar type $str
3069  * @param stdClass $mod The module to produce editing buttons for
3070  * @param bool $absolute If true an absolute link is produced (default true)
3071  * @param bool $moveselect If true a move seleciton process is used (default true)
3072  * @param int $indent The current indenting
3073  * @param int $section The section to link back to
3074  * @return string XHTML for the editing buttons
3075  */
3076 function make_editing_buttons(stdClass $mod, $absolute = true, $moveselect = true, $indent=-1, $section=-1) {
3077     global $CFG, $OUTPUT;
3079     static $str;
3081     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3082     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3084     // no permission to edit
3085     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
3086         return false;
3087     }
3089     if (!isset($str)) {
3090         $str = new stdClass;
3091         $str->assign         = get_string("assignroles", 'role');
3092         $str->delete         = get_string("delete");
3093         $str->move           = get_string("move");
3094         $str->moveup         = get_string("moveup");
3095         $str->movedown       = get_string("movedown");
3096         $str->moveright      = get_string("moveright");
3097         $str->moveleft       = get_string("moveleft");
3098         $str->update         = get_string("update");
3099         $str->duplicate      = get_string("duplicate");
3100         $str->hide           = get_string("hide");
3101         $str->show           = get_string("show");
3102         $str->clicktochange  = get_string("clicktochange");
3103         $str->forcedmode     = get_string("forcedmode");
3104         $str->groupsnone     = get_string("groupsnone");
3105         $str->groupsseparate = get_string("groupsseparate");
3106         $str->groupsvisible  = get_string("groupsvisible");
3107     }
3109     if ($absolute) {
3110         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3111     } else {
3112         $baseurl = new moodle_url('mod.php', array('sesskey' => sesskey()));
3113     }
3115     if ($section >= 0) {
3116         $baseurl->param('sr', $section);
3117     }
3118     $actions = array();
3120     // leftright
3121     if (has_capability('moodle/course:update', $coursecontext)) {
3122         if (right_to_left()) {   // Exchange arrows on RTL
3123             $rightarrow = 't/left';
3124             $leftarrow  = 't/right';
3125         } else {
3126             $rightarrow = 't/right';
3127             $leftarrow  = 't/left';
3128         }
3130         if ($indent > 0) {
3131             $actions[] = new action_link(
3132                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3133                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3134                 null,
3135                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3136             );
3137         }
3138         if ($indent >= 0) {
3139             $actions[] = new action_link(
3140                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3141                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3142                 null,
3143                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3144             );
3145         }
3146     }
3148     // move
3149     if (has_capability('moodle/course:update', $coursecontext)) {
3150         if ($moveselect) {
3151             $actions[] = new action_link(
3152                 new moodle_url($baseurl, array('copy' => $mod->id)),
3153                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3154                 null,
3155                 array('class' => 'editing_move', 'title' => $str->move)
3156             );
3157         } else {
3158             $actions[] = new action_link(
3159                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3160                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3161                 null,
3162                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3163             );
3164             $actions[] = new action_link(
3165                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3166                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3167                 null,
3168                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3169             );
3170         }
3171     }
3173     // Update
3174     $actions[] = new action_link(
3175         new moodle_url($baseurl, array('update' => $mod->id)),
3176         new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3177         null,
3178         array('class' => 'editing_update', 'title' => $str->update)
3179     );
3181     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3182     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3183     if (has_all_capabilities($dupecaps, $coursecontext)) {
3184         $actions[] = new action_link(
3185             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3186             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3187             null,
3188             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3189         );
3190     }
3192     // Delete
3193     $actions[] = new action_link(
3194         new moodle_url($baseurl, array('delete' => $mod->id)),
3195         new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3196         null,
3197         array('class' => 'editing_delete', 'title' => $str->delete)
3198     );
3200     // hideshow
3201     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3202         if ($mod->visible) {
3203             $actions[] = new action_link(
3204                 new moodle_url($baseurl, array('hide' => $mod->id)),
3205                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3206                 null,
3207                 array('class' => 'editing_hide', 'title' => $str->hide)
3208             );
3209         } else {
3210             $actions[] = new action_link(
3211                 new moodle_url($baseurl, array('show' => $mod->id)),
3212                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3213                 null,
3214                 array('class' => 'editing_show', 'title' => $str->show)
3215             );
3216         }
3217     }
3219     // groupmode
3220     if ($mod->groupmode !== false) {
3221         if ($mod->groupmode == SEPARATEGROUPS) {
3222             $groupmode = 0;
3223             $grouptitle = $str->groupsseparate;
3224             $groupclass = 'editing_groupsseparate';
3225             $groupimage = 't/groups';
3226         } else if ($mod->groupmode == VISIBLEGROUPS) {
3227             $groupmode = 1;
3228             $grouptitle = $str->groupsvisible;
3229             $groupclass = 'editing_groupsvisible';
3230             $groupimage = 't/groupv';
3231         } else {
3232             $groupmode = 2;
3233             $grouptitle = $str->groupsnone;
3234             $groupclass = 'editing_groupsnone';
3235             $groupimage = 't/groupn';
3236         }
3237         if ($mod->groupmodelink) {
3238             $actions[] = new action_link(
3239                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3240                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3241                 null,
3242                 array('class' => $groupclass, 'title' => $grouptitle.' ('.$str->clicktochange.')')
3243             );
3244         } else {
3245             $actions[] = new pix_icon($groupimage, $grouptitle, 'moodle', array('title' => $grouptitle.' ('.$str->forcedmode.')', 'class' => 'iconsmall'));
3246         }
3247     }
3249     // Assign
3250     if (has_capability('moodle/course:managegroups', $modcontext)){
3251         $actions[] = new action_link(
3252             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3253             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3254             null,
3255             array('class' => 'editing_assign', 'title' => $str->assign)
3256         );
3257     }
3259     $output = html_writer::start_tag('span', array('class' => 'commands'));
3260     foreach ($actions as $action) {
3261         if ($action instanceof renderable) {
3262             $output .= $OUTPUT->render($action);
3263         } else {
3264             $output .= $action;
3265         }
3266     }
3267     $output .= html_writer::end_tag('span');
3268     return $output;
3271 /**
3272  * given a course object with shortname & fullname, this function will
3273  * truncate the the number of chars allowed and add ... if it was too long
3274  */
3275 function course_format_name ($course,$max=100) {
3277     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3278     $shortname = format_string($course->shortname, true, array('context' => $context));
3280     $str = $shortname.': '. $course->fullname;
3281     if (textlib::strlen($str) <= $max) {
3282         return $str;
3283     }
3284     else {
3285         return textlib::substr($str,0,$max-3).'...';
3286     }
3289 function update_restricted_mods($course, $mods) {
3290     global $DB;
3292 /// Delete all the current restricted list
3293     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3295     if (empty($course->restrictmodules)) {
3296         return;   // We're done
3297     }
3299 /// Insert the new list of restricted mods
3300     foreach ($mods as $mod) {
3301         if ($mod == 0) {
3302             continue; // this is the 'allow none' option
3303         }
3304         $am = new stdClass();
3305         $am->course = $course->id;
3306         $am->module = $mod;
3307         $DB->insert_record('course_allowed_modules',$am);
3308     }
3311 /**
3312  * This function will take an int (module id) or a string (module name)
3313  * and return true or false, whether it's allowed in the given course (object)
3314  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3315  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3316  */
3318 function course_allowed_module($course,$mod) {
3319     global $DB;
3321     if (empty($course->restrictmodules)) {
3322         return true;
3323     }
3325     // Admins and admin-like people who can edit everything can also add anything.
3326     // Originally there was a course:update test only, but it did not match the test in course edit form
3327     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3328         return true;
3329     }
3331     if (is_numeric($mod)) {
3332         $modid = $mod;
3333     } else if (is_string($mod)) {
3334         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3335     }
3336     if (empty($modid)) {
3337         return false;
3338     }
3340     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3343 /**
3344  * Recursively delete category including all subcategories and courses.
3345  * @param stdClass $category
3346  * @param boolean $showfeedback display some notices
3347  * @return array return deleted courses
3348  */
3349 function category_delete_full($category, $showfeedback=true) {
3350     global $CFG, $DB;
3351     require_once($CFG->libdir.'/gradelib.php');
3352     require_once($CFG->libdir.'/questionlib.php');
3353     require_once($CFG->dirroot.'/cohort/lib.php');
3355     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3356         foreach ($children as $childcat) {
3357             category_delete_full($childcat, $showfeedback);
3358         }
3359     }
3361     $deletedcourses = array();
3362     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3363         foreach ($courses as $course) {
3364             if (!delete_course($course, false)) {
3365                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3366             }
3367             $deletedcourses[] = $course;
3368         }
3369     }
3371     // move or delete cohorts in this context
3372     cohort_delete_category($category);
3374     // now delete anything that may depend on course category context
3375     grade_course_category_delete($category->id, 0, $showfeedback);
3376     if (!question_delete_course_category($category, 0, $showfeedback)) {
3377         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3378     }
3380     // finally delete the category and it's context
3381     $DB->delete_records('course_categories', array('id'=>$category->id));
3382     delete_context(CONTEXT_COURSECAT, $category->id);
3384     events_trigger('course_category_deleted', $category);
3386     return $deletedcourses;
3389 /**
3390  * Delete category, but move contents to another category.
3391  * @param object $ccategory
3392  * @param int $newparentid category id
3393  * @return bool status
3394  */
3395 function category_delete_move($category, $newparentid, $showfeedback=true) {
3396     global $CFG, $DB, $OUTPUT;
3397     require_once($CFG->libdir.'/gradelib.php');
3398     require_once($CFG->libdir.'/questionlib.php');
3399     require_once($CFG->dirroot.'/cohort/lib.php');
3401     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3402         return false;
3403     }
3405     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3406         foreach ($children as $childcat) {
3407             move_category($childcat, $newparentcat);
3408         }
3409     }
3411     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3412         if (!move_courses(array_keys($courses), $newparentid)) {
3413             echo $OUTPUT->notification("Error moving courses");
3414             return false;
3415         }
3416         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3417     }
3419     // move or delete cohorts in this context
3420     cohort_delete_category($category);
3422     // now delete anything that may depend on course category context
3423     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3424     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3425         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3426         return false;
3427     }
3429     // finally delete the category and it's context
3430     $DB->delete_records('course_categories', array('id'=>$category->id));
3431     delete_context(CONTEXT_COURSECAT, $category->id);
3433     events_trigger('course_category_deleted', $category);
3435     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3437     return true;
3440 /**
3441  * Efficiently moves many courses around while maintaining
3442  * sortorder in order.
3443  *
3444  * @param array $courseids is an array of course ids
3445  * @param int $categoryid
3446  * @return bool success
3447  */
3448 function move_courses($courseids, $categoryid) {
3449     global $CFG, $DB, $OUTPUT;
3451     if (empty($courseids)) {
3452         // nothing to do
3453         return;
3454     }
3456     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3457         return false;
3458     }
3460     $courseids = array_reverse($courseids);
3461     $newparent = get_context_instance(CONTEXT_COURSECAT, $category->id);
3462     $i = 1;
3464     foreach ($courseids as $courseid) {
3465         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3466             $course = new stdClass();
3467             $course->id = $courseid;
3468             $course->category  = $category->id;
3469             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3470             if ($category->visible == 0) {
3471                 // hide the course when moving into hidden category,
3472                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3473                 $course->visible = 0;
3474             }
3476             $DB->update_record('course', $course);
3478             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3479             context_moved($context, $newparent);
3480         }
3481     }
3482     fix_course_sortorder();
3484     return true;
3487 /**
3488  * Hide course category and child course and subcategories
3489  * @param stdClass $category
3490  * @return void
3491  */
3492 function course_category_hide($category) {
3493     global $DB;
3495     $category->visible = 0;
3496     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3497     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3498     $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
3499     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3500     // get all child categories and hide too
3501     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3502         foreach ($subcats as $cat) {
3503             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3504             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3505             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));