MDL-30175 cm_info - add support to external url icon images
[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         $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
865         echo $OUTPUT->box_start('coursebox');
866         $attributes = array('title' => s($fullname));
867         if (empty($course->visible)) {
868             $attributes['class'] = 'dimmed';
869         }
870         echo $OUTPUT->heading(html_writer::link(
871             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
872         if (array_key_exists($course->id,$htmlarray)) {
873             foreach ($htmlarray[$course->id] as $modname => $html) {
874                 echo $html;
875             }
876         }
877         echo $OUTPUT->box_end();
878     }
880     if (!empty($remote_courses)) {
881         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
882     }
883     foreach ($remote_courses as $course) {
884         echo $OUTPUT->box_start('coursebox');
885         $attributes = array('title' => s($course->fullname));
886         echo $OUTPUT->heading(html_writer::link(
887             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
888             format_string($course->shortname),
889             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
890         echo $OUTPUT->box_end();
891     }
895 /**
896  * This function trawls through the logs looking for
897  * anything new since the user's last login
898  */
899 function print_recent_activity($course) {
900     // $course is an object
901     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
903     $context = get_context_instance(CONTEXT_COURSE, $course->id);
905     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
907     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
909     if (!isguestuser()) {
910         if (!empty($USER->lastcourseaccess[$course->id])) {
911             if ($USER->lastcourseaccess[$course->id] > $timestart) {
912                 $timestart = $USER->lastcourseaccess[$course->id];
913             }
914         }
915     }
917     echo '<div class="activitydate">';
918     echo get_string('activitysince', '', userdate($timestart));
919     echo '</div>';
920     echo '<div class="activityhead">';
922     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
924     echo "</div>\n";
926     $content = false;
928 /// Firstly, have there been any new enrolments?
930     $users = get_recent_enrolments($course->id, $timestart);
932     //Accessibility: new users now appear in an <OL> list.
933     if ($users) {
934         echo '<div class="newusers">';
935         echo $OUTPUT->heading(get_string("newusers").':', 3);
936         $content = true;
937         echo "<ol class=\"list\">\n";
938         foreach ($users as $user) {
939             $fullname = fullname($user, $viewfullnames);
940             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
941         }
942         echo "</ol>\n</div>\n";
943     }
945 /// Next, have there been any modifications to the course structure?
947     $modinfo =& get_fast_modinfo($course);
949     $changelist = array();
951     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
952                                             module = 'course' AND
953                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
954                                     array($timestart, $course->id), "id ASC");
956     if ($logs) {
957         $actions  = array('add mod', 'update mod', 'delete mod');
958         $newgones = array(); // added and later deleted items
959         foreach ($logs as $key => $log) {
960             if (!in_array($log->action, $actions)) {
961                 continue;
962             }
963             $info = explode(' ', $log->info);
965             // note: in most cases I replaced hardcoding of label with use of
966             // $cm->has_view() but it was not possible to do this here because
967             // we don't necessarily have the $cm for it
968             if ($info[0] == 'label') {     // Labels are ignored in recent activity
969                 continue;
970             }
972             if (count($info) != 2) {
973                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
974                 continue;
975             }
977             $modname    = $info[0];
978             $instanceid = $info[1];
980             if ($log->action == 'delete mod') {
981                 // unfortunately we do not know if the mod was visible
982                 if (!array_key_exists($log->info, $newgones)) {
983                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
984                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
985                 }
986             } else {
987                 if (!isset($modinfo->instances[$modname][$instanceid])) {
988                     if ($log->action == 'add mod') {
989                         // do not display added and later deleted activities
990                         $newgones[$log->info] = true;
991                     }
992                     continue;
993                 }
994                 $cm = $modinfo->instances[$modname][$instanceid];
995                 if (!$cm->uservisible) {
996                     continue;
997                 }
999                 if ($log->action == 'add mod') {
1000                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
1001                     $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>");
1003                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
1004                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
1005                     $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>");
1006                 }
1007             }
1008         }
1009     }
1011     if (!empty($changelist)) {
1012         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1013         $content = true;
1014         foreach ($changelist as $changeinfo => $change) {
1015             echo '<p class="activity">'.$change['text'].'</p>';
1016         }
1017     }
1019 /// Now display new things from each module
1021     $usedmodules = array();
1022     foreach($modinfo->cms as $cm) {
1023         if (isset($usedmodules[$cm->modname])) {
1024             continue;
1025         }
1026         if (!$cm->uservisible) {
1027             continue;
1028         }
1029         $usedmodules[$cm->modname] = $cm->modname;
1030     }
1032     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1033         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1034             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1035             $print_recent_activity = $modname.'_print_recent_activity';
1036             if (function_exists($print_recent_activity)) {
1037                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1038                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1039             }
1040         } else {
1041             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1042         }
1043     }
1045     if (! $content) {
1046         echo '<p class="message">'.get_string('nothingnew').'</p>';
1047     }
1050 /**
1051  * For a given course, returns an array of course activity objects
1052  * Each item in the array contains he following properties:
1053  */
1054 function get_array_of_activities($courseid) {
1055 //  cm - course module id
1056 //  mod - name of the module (eg forum)
1057 //  section - the number of the section (eg week or topic)
1058 //  name - the name of the instance
1059 //  visible - is the instance visible or not
1060 //  groupingid - grouping id
1061 //  groupmembersonly - is this instance visible to group members only
1062 //  extra - contains extra string to include in any link
1063     global $CFG, $DB;
1064     if(!empty($CFG->enableavailability)) {
1065         require_once($CFG->libdir.'/conditionlib.php');
1066     }
1068     $course = $DB->get_record('course', array('id'=>$courseid));
1070     if (empty($course)) {
1071         throw new moodle_exception('courseidnotfound');
1072     }
1074     $mod = array();
1076     $rawmods = get_course_mods($courseid);
1077     if (empty($rawmods)) {
1078         return $mod; // always return array
1079     }
1081     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1082        foreach ($sections as $section) {
1083            if (!empty($section->sequence)) {
1084                $sequence = explode(",", $section->sequence);
1085                foreach ($sequence as $seq) {
1086                    if (empty($rawmods[$seq])) {
1087                        continue;
1088                    }
1089                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1090                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1091                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1093                     // Oh dear. Inconsistent names left here for backward compatibility.
1094                    $mod[$seq]->section          = $section->section;
1095                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1097                    $mod[$seq]->module           = $rawmods[$seq]->module;
1098                    $mod[$seq]->added            = $rawmods[$seq]->added;
1099                    $mod[$seq]->score            = $rawmods[$seq]->score;
1100                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1101                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1102                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1103                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1104                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1105                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1106                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1107                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1108                    $mod[$seq]->extra            = "";
1109                    $mod[$seq]->completiongradeitemnumber =
1110                            $rawmods[$seq]->completiongradeitemnumber;
1111                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1112                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1113                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1114                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1115                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1116                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1117                    if (!empty($CFG->enableavailability)) {
1118                        condition_info::fill_availability_conditions($rawmods[$seq]);
1119                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1120                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1121                    }
1123                    $modname = $mod[$seq]->mod;
1124                    $functionname = $modname."_get_coursemodule_info";
1126                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1127                        continue;
1128                    }
1130                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1132                    if ($hasfunction = function_exists($functionname)) {
1133                        if ($info = $functionname($rawmods[$seq])) {
1134                            if (!empty($info->icon)) {
1135                                $mod[$seq]->icon = $info->icon;
1136                            }
1137                            if (!empty($info->iconcomponent)) {
1138                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1139                            }
1140                            if (!empty($info->name)) {
1141                                $mod[$seq]->name = $info->name;
1142                            }
1143                            if ($info instanceof cached_cm_info) {
1144                                // When using cached_cm_info you can include three new fields
1145                                // that aren't available for legacy code
1146                                if (!empty($info->content)) {
1147                                    $mod[$seq]->content = $info->content;
1148                                }
1149                                if (!empty($info->extraclasses)) {
1150                                    $mod[$seq]->extraclasses = $info->extraclasses;
1151                                }
1152                                if (!empty($info->iconurl)) {
1153                                    $mod[$seq]->iconurl = $info->iconurl;
1154                                }
1155                                if (!empty($info->onclick)) {
1156                                    $mod[$seq]->onclick = $info->onclick;
1157                                }
1158                                if (!empty($info->customdata)) {
1159                                    $mod[$seq]->customdata = $info->customdata;
1160                                }
1161                            } else {
1162                                // When using a stdclass, the (horrible) deprecated ->extra field
1163                                // is available for BC
1164                                if (!empty($info->extra)) {
1165                                    $mod[$seq]->extra = $info->extra;
1166                                }
1167                            }
1168                        }
1169                    }
1170                    // When there is no modname_get_coursemodule_info function,
1171                    // but showdescriptions is enabled, then we use the 'intro'
1172                    // and 'introformat' fields in the module table
1173                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1174                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1175                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1176                            // Set content from intro and introformat. Filters are disabled
1177                            // because we  filter it with format_text at display time
1178                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1179                                    $modvalues, $rawmods[$seq]->id, false);
1181                            // To save making another query just below, put name in here
1182                            $mod[$seq]->name = $modvalues->name;
1183                        }
1184                    }
1185                    if (!isset($mod[$seq]->name)) {
1186                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1187                    }
1189                    // Minimise the database size by unsetting default options when they are
1190                    // 'empty'. This list corresponds to code in the cm_info constructor.
1191                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1192                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1193                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1194                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1195                            'completionview', 'completionexpected', 'score', 'showdescription')
1196                            as $property) {
1197                        if (property_exists($mod[$seq], $property) &&
1198                                empty($mod[$seq]->{$property})) {
1199                            unset($mod[$seq]->{$property});
1200                        }
1201                    }
1202                    // Special case: this value is usually set to null, but may be 0
1203                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1204                            is_null($mod[$seq]->completiongradeitemnumber)) {
1205                        unset($mod[$seq]->completiongradeitemnumber);
1206                    }
1207                }
1208             }
1209         }
1210     }
1211     return $mod;
1215 /**
1216  * Returns a number of useful structures for course displays
1217  */
1218 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1219     global $CFG, $DB, $COURSE;
1221     $mods          = array();    // course modules indexed by id
1222     $modnames      = array();    // all course module names (except resource!)
1223     $modnamesplural= array();    // all course module names (plural form)
1224     $modnamesused  = array();    // course module names used
1226     if ($allmods = $DB->get_records("modules")) {
1227         foreach ($allmods as $mod) {
1228             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1229                 continue;
1230             }
1231             if ($mod->visible) {
1232                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1233                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1234             }
1235         }
1236         collatorlib::asort($modnames);
1237     } else {
1238         print_error("nomodules", 'debug');
1239     }
1241     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1242     $modinfo = get_fast_modinfo($course);
1244     if ($rawmods=$modinfo->cms) {
1245         foreach($rawmods as $mod) {    // Index the mods
1246             if (empty($modnames[$mod->modname])) {
1247                 continue;
1248             }
1249             $mods[$mod->id] = $mod;
1250             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1251             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1252                 continue;
1253             }
1254             // Check groupings
1255             if (!groups_course_module_visible($mod)) {
1256                 continue;
1257             }
1258             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1259         }
1260         if ($modnamesused) {
1261             collatorlib::asort($modnamesused);
1262         }
1263     }
1266 /**
1267  * Returns an array of sections for the requested course id
1268  *
1269  * This function stores the sections against the course id within a staticvar encase
1270  * of subsequent requests. This is used all over + in some standard libs and course
1271  * format callbacks so subsequent requests are a reality.
1272  *
1273  * @staticvar array $coursesections
1274  * @param int $courseid
1275  * @return array Array of sections
1276  */
1277 function get_all_sections($courseid) {
1278     global $DB;
1279     static $coursesections = array();
1280     if (!array_key_exists($courseid, $coursesections)) {
1281         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1282                            "section, id, course, name, summary, summaryformat, sequence, visible");
1283     }
1284     return $coursesections[$courseid];
1287 /**
1288  * Returns the course section to display or 0 meaning show all sections. Returns 0 for guests.
1289  * It also sets the $USER->display cache to array($courseid=>return value)
1290  *
1291  * @param int $courseid The course id
1292  * @return int Course section to display, 0 means all
1293  */
1294 function course_get_display($courseid) {
1295     global $USER, $DB;
1297     if (!isloggedin() or isguestuser()) {
1298         //do not get settings in db for guests
1299         return 0; //return the implicit setting
1300     }
1302     if (!isset($USER->display[$courseid])) {
1303         if (!$display = $DB->get_field('course_display', 'display', array('userid' => $USER->id, 'course'=>$courseid))) {
1304             $display = 0; // all sections option is not stored in DB, this makes the table much smaller
1305         }
1306         //use display cache for one course only - we need to keep session small
1307         $USER->display = array($courseid => $display);
1308     }
1310     return $USER->display[$courseid];
1313 /**
1314  * Show one section only or all sections.
1315  *
1316  * @param int $courseid The course id
1317  * @param mixed $display show only this section, 0 or 'all' means show all sections
1318  * @return int Course section to display, 0 means all
1319  */
1320 function course_set_display($courseid, $display) {
1321     global $USER, $DB;
1323     if ($display === 'all' or empty($display)) {
1324         $display = 0;
1325     }
1327     if (!isloggedin() or isguestuser()) {
1328         //do not store settings in db for guests
1329         return 0;
1330     }
1332     if ($display == 0) {
1333         //show all, do not store anything in database
1334         $DB->delete_records('course_display', array('userid' => $USER->id, 'course' => $courseid));
1336     } else {
1337         if ($DB->record_exists('course_display', array('userid' => $USER->id, 'course' => $courseid))) {
1338             $DB->set_field('course_display', 'display', $display, array('userid' => $USER->id, 'course' => $courseid));
1339         } else {
1340             $record = new stdClass();
1341             $record->userid = $USER->id;
1342             $record->course = $courseid;
1343             $record->display = $display;
1344             $DB->insert_record('course_display', $record);
1345         }
1346     }
1348     //use display cache for one course only - we need to keep session small
1349     $USER->display = array($courseid => $display);
1351     return $display;
1354 /**
1355  * For a given course section, marks it visible or hidden,
1356  * and does the same for every activity in that section
1357  */
1358 function set_section_visible($courseid, $sectionnumber, $visibility) {
1359     global $DB;
1361     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1362         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1363         if (!empty($section->sequence)) {
1364             $modules = explode(",", $section->sequence);
1365             foreach ($modules as $moduleid) {
1366                 set_coursemodule_visible($moduleid, $visibility, true);
1367             }
1368         }
1369         rebuild_course_cache($courseid);
1370     }
1373 /**
1374  * Obtains shared data that is used in print_section when displaying a
1375  * course-module entry.
1376  *
1377  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1378  *
1379  * This data is also used in other areas of the code.
1380  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1381  * @param object $course Moodle course object
1382  * @return array An array with the following values in this order:
1383  *   $content (optional extra content for after link),
1384  *   $instancename (text of link)
1385  */
1386 function get_print_section_cm_text(cm_info $cm, $course) {
1387     global $OUTPUT;
1389     // Get content from modinfo if specified. Content displays either
1390     // in addition to the standard link (below), or replaces it if
1391     // the link is turned off by setting ->url to null.
1392     if (($content = $cm->get_content()) !== '') {
1393         // Improve filter performance by preloading filter setttings for all
1394         // activities on the course (this does nothing if called multiple
1395         // times)
1396         filter_preload_activities($cm->get_modinfo());
1398         // Get module context
1399         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1400         $labelformatoptions = new stdClass();
1401         $labelformatoptions->noclean = true;
1402         $labelformatoptions->overflowdiv = true;
1403         $labelformatoptions->context = $modulecontext;
1404         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1405     } else {
1406         $content = '';
1407     }
1409     // Get course context
1410     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1411     $stringoptions = new stdClass;
1412     $stringoptions->context = $coursecontext;
1413     $instancename = format_string($cm->name, true,  $stringoptions);
1414     return array($content, $instancename);
1417 /**
1418  * Prints a section full of activity modules
1419  */
1420 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1421     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1423     static $initialised;
1425     static $groupbuttons;
1426     static $groupbuttonslink;
1427     static $isediting;
1428     static $ismoving;
1429     static $strmovehere;
1430     static $strmovefull;
1431     static $strunreadpostsone;
1432     static $groupings;
1433     static $modulenames;
1435     if (!isset($initialised)) {
1436         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1437         $groupbuttonslink = (!$course->groupmodeforce);
1438         $isediting        = $PAGE->user_is_editing();
1439         $ismoving         = $isediting && ismoving($course->id);
1440         if ($ismoving) {
1441             $strmovehere  = get_string("movehere");
1442             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1443         }
1444         $modulenames      = array();
1445         $initialised = true;
1446     }
1448     $tl = textlib_get_instance();
1450     $modinfo = get_fast_modinfo($course);
1451     $completioninfo = new completion_info($course);
1453     //Accessibility: replace table with list <ul>, but don't output empty list.
1454     if (!empty($section->sequence)) {
1456         // Fix bug #5027, don't want style=\"width:$width\".
1457         echo "<ul class=\"section img-text\">\n";
1458         $sectionmods = explode(",", $section->sequence);
1460         foreach ($sectionmods as $modnumber) {
1461             if (empty($mods[$modnumber])) {
1462                 continue;
1463             }
1465             /**
1466              * @var cm_info
1467              */
1468             $mod = $mods[$modnumber];
1470             if ($ismoving and $mod->id == $USER->activitycopy) {
1471                 // do not display moving mod
1472                 continue;
1473             }
1475             if (isset($modinfo->cms[$modnumber])) {
1476                 // We can continue (because it will not be displayed at all)
1477                 // if:
1478                 // 1) The activity is not visible to users
1479                 // and
1480                 // 2a) The 'showavailability' option is not set (if that is set,
1481                 //     we need to display the activity so we can show
1482                 //     availability info)
1483                 // or
1484                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1485                 //     hidden in a way that leaves no info, such as using the
1486                 //     eye icon.
1487                 if (!$modinfo->cms[$modnumber]->uservisible &&
1488                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1489                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1490                     // visibility shortcut
1491                     continue;
1492                 }
1493             } else {
1494                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1495                     // module not installed
1496                     continue;
1497                 }
1498                 if (!coursemodule_visible_for_user($mod) &&
1499                     empty($mod->showavailability)) {
1500                     // full visibility check
1501                     continue;
1502                 }
1503             }
1505             if (!isset($modulenames[$mod->modname])) {
1506                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1507             }
1508             $modulename = $modulenames[$mod->modname];
1510             // In some cases the activity is visible to user, but it is
1511             // dimmed. This is done if viewhiddenactivities is true and if:
1512             // 1. the activity is not visible, or
1513             // 2. the activity has dates set which do not include current, or
1514             // 3. the activity has any other conditions set (regardless of whether
1515             //    current user meets them)
1516             $canviewhidden = has_capability(
1517                 'moodle/course:viewhiddenactivities',
1518                 get_context_instance(CONTEXT_MODULE, $mod->id));
1519             $accessiblebutdim = false;
1520             if ($canviewhidden) {
1521                 $accessiblebutdim = !$mod->visible;
1522                 if (!empty($CFG->enableavailability)) {
1523                     $accessiblebutdim = $accessiblebutdim ||
1524                         $mod->availablefrom > time() ||
1525                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1526                         count($mod->conditionsgrade) > 0 ||
1527                         count($mod->conditionscompletion) > 0;
1528                 }
1529             }
1531             $liclasses = array();
1532             $liclasses[] = 'activity';
1533             $liclasses[] = $mod->modname;
1534             $liclasses[] = 'modtype_'.$mod->modname;
1535             $extraclasses = $mod->get_extra_classes();
1536             if ($extraclasses) {
1537                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1538             }
1539             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1540             if ($ismoving) {
1541                 echo '<a title="'.$strmovefull.'"'.
1542                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1543                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1544                      ' alt="'.$strmovehere.'" /></a><br />
1545                      ';
1546             }
1548             $classes = array('mod-indent');
1549             if (!empty($mod->indent)) {
1550                 $classes[] = 'mod-indent-'.$mod->indent;
1551                 if ($mod->indent > 15) {
1552                     $classes[] = 'mod-indent-huge';
1553                 }
1554             }
1555             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1557             // Get data about this course-module
1558             list($content, $instancename) =
1559                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1561             //Accessibility: for files get description via icon, this is very ugly hack!
1562             $altname = '';
1563             $altname = $mod->modfullname;
1564             if (!empty($customicon)) {
1565                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1566                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1567                     $mimetype = mimeinfo_from_icon('type', $customicon);
1568                     $altname = get_mimetype_description($mimetype);
1569                 }
1570             }
1571             // Avoid unnecessary duplication: if e.g. a forum name already
1572             // includes the word forum (or Forum, etc) then it is unhelpful
1573             // to include that in the accessible description that is added.
1574             if (false !== strpos($tl->strtolower($instancename),
1575                     $tl->strtolower($altname))) {
1576                 $altname = '';
1577             }
1578             // File type after name, for alphabetic lists (screen reader).
1579             if ($altname) {
1580                 $altname = get_accesshide(' '.$altname);
1581             }
1583             // We may be displaying this just in order to show information
1584             // about visibility, without the actual link
1585             $contentpart = '';
1586             if ($mod->uservisible) {
1587                 // Nope - in this case the link is fully working for user
1588                 $linkclasses = '';
1589                 $textclasses = '';
1590                 if ($accessiblebutdim) {
1591                     $linkclasses .= ' dimmed';
1592                     $textclasses .= ' dimmed_text';
1593                     $accesstext = '<span class="accesshide">'.
1594                         get_string('hiddenfromstudents').': </span>';
1595                 } else {
1596                     $accesstext = '';
1597                 }
1598                 if ($linkclasses) {
1599                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1600                 } else {
1601                     $linkcss = '';
1602                 }
1603                 if ($textclasses) {
1604                     $textcss = 'class="' . trim($textclasses) . '" ';
1605                 } else {
1606                     $textcss = '';
1607                 }
1609                 // Get on-click attribute value if specified
1610                 $onclick = $mod->get_on_click();
1611                 if ($onclick) {
1612                     $onclick = ' onclick="' . $onclick . '"';
1613                 }
1615                 if ($url = $mod->get_url()) {
1616                     // Display link itself
1617                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1618                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1619                             '" class="activityicon" alt="' .
1620                             $modulename . '" /> ' .
1621                             $accesstext . '<span class="instancename">' .
1622                             $instancename . $altname . '</span></a>';
1624                     // If specified, display extra content after link
1625                     if ($content) {
1626                         $contentpart = '<div class="contentafterlink' .
1627                                 trim($textclasses) . '">' . $content . '</div>';
1628                     }
1629                 } else {
1630                     // No link, so display only content
1631                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1632                             $accesstext . $content . '</div>';
1633                 }
1635                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1636                     if (!isset($groupings)) {
1637                         $groupings = groups_get_all_groupings($course->id);
1638                     }
1639                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1640                 }
1641             } else {
1642                 $textclasses = $extraclasses;
1643                 $textclasses .= ' dimmed_text';
1644                 if ($textclasses) {
1645                     $textcss = 'class="' . trim($textclasses) . '" ';
1646                 } else {
1647                     $textcss = '';
1648                 }
1649                 $accesstext = '<span class="accesshide">' .
1650                         get_string('notavailableyet', 'condition') .
1651                         ': </span>';
1653                 if ($url = $mod->get_url()) {
1654                     // Display greyed-out text of link
1655                     echo '<div ' . $textcss . $mod->extra .
1656                             ' >' . '<img src="' . $mod->get_icon_url() .
1657                             '" class="activityicon" alt="' .
1658                             $modulename .
1659                             '" /> <span>'. $instancename . $altname .
1660                             '</span></div>';
1662                     // Do not display content after link when it is greyed out like this.
1663                 } else {
1664                     // No link, so display only content (also greyed)
1665                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1666                             $accesstext . $content . '</div>';
1667                 }
1668             }
1670             // Module can put text after the link (e.g. forum unread)
1671             echo $mod->get_after_link();
1673             // If there is content but NO link (eg label), then display the
1674             // content here (BEFORE any icons). In this case cons must be
1675             // displayed after the content so that it makes more sense visually
1676             // and for accessibility reasons, e.g. if you have a one-line label
1677             // it should work similarly (at least in terms of ordering) to an
1678             // activity.
1679             if (empty($url)) {
1680                 echo $contentpart;
1681             }
1683             if ($isediting) {
1684                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1685                     if (! $mod->groupmodelink = $groupbuttonslink) {
1686                         $mod->groupmode = $course->groupmode;
1687                     }
1689                 } else {
1690                     $mod->groupmode = false;
1691                 }
1692                 echo '&nbsp;&nbsp;';
1693                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1694                 echo $mod->get_after_edit_icons();
1695             }
1697             // Completion
1698             $completion = $hidecompletion
1699                 ? COMPLETION_TRACKING_NONE
1700                 : $completioninfo->is_enabled($mod);
1701             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1702                 !isguestuser() && $mod->uservisible) {
1703                 $completiondata = $completioninfo->get_data($mod,true);
1704                 $completionicon = '';
1705                 if ($isediting) {
1706                     switch ($completion) {
1707                         case COMPLETION_TRACKING_MANUAL :
1708                             $completionicon = 'manual-enabled'; break;
1709                         case COMPLETION_TRACKING_AUTOMATIC :
1710                             $completionicon = 'auto-enabled'; break;
1711                         default: // wtf
1712                     }
1713                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1714                     switch($completiondata->completionstate) {
1715                         case COMPLETION_INCOMPLETE:
1716                             $completionicon = 'manual-n'; break;
1717                         case COMPLETION_COMPLETE:
1718                             $completionicon = 'manual-y'; break;
1719                     }
1720                 } else { // Automatic
1721                     switch($completiondata->completionstate) {
1722                         case COMPLETION_INCOMPLETE:
1723                             $completionicon = 'auto-n'; break;
1724                         case COMPLETION_COMPLETE:
1725                             $completionicon = 'auto-y'; break;
1726                         case COMPLETION_COMPLETE_PASS:
1727                             $completionicon = 'auto-pass'; break;
1728                         case COMPLETION_COMPLETE_FAIL:
1729                             $completionicon = 'auto-fail'; break;
1730                     }
1731                 }
1732                 if ($completionicon) {
1733                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1734                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1735                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1736                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1737                         $newstate =
1738                             $completiondata->completionstate==COMPLETION_COMPLETE
1739                             ? COMPLETION_INCOMPLETE
1740                             : COMPLETION_COMPLETE;
1741                         // In manual mode the icon is a toggle form...
1743                         // If this completion state is used by the
1744                         // conditional activities system, we need to turn
1745                         // off the JS.
1746                         if (!empty($CFG->enableavailability) &&
1747                             condition_info::completion_value_used_as_condition($course, $mod)) {
1748                             $extraclass = ' preventjs';
1749                         } else {
1750                             $extraclass = '';
1751                         }
1752                         echo "
1753 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1754 <input type='hidden' name='id' value='{$mod->id}' />
1755 <input type='hidden' name='sesskey' value='".sesskey()."' />
1756 <input type='hidden' name='completionstate' value='$newstate' />
1757 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1758 </div></form>";
1759                     } else {
1760                         // In auto mode, or when editing, the icon is just an image
1761                         echo "<span class='autocompletion'>";
1762                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1763                     }
1764                 }
1765             }
1767             // If there is content AND a link, then display the content here
1768             // (AFTER any icons). Otherwise it was displayed before
1769             if (!empty($url)) {
1770                 echo $contentpart;
1771             }
1773             // Show availability information (for someone who isn't allowed to
1774             // see the activity itself, or for staff)
1775             if (!$mod->uservisible) {
1776                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1777             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1778                 $ci = new condition_info($mod);
1779                 $fullinfo = $ci->get_full_information();
1780                 if($fullinfo) {
1781                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1782                         ? 'userrestriction_visible'
1783                         : 'userrestriction_hidden','condition',
1784                         $fullinfo).'</div>';
1785                 }
1786             }
1788             echo html_writer::end_tag('div');
1789             echo html_writer::end_tag('li')."\n";
1790         }
1792     } elseif ($ismoving) {
1793         echo "<ul class=\"section\">\n";
1794     }
1796     if ($ismoving) {
1797         echo '<li><a title="'.$strmovefull.'"'.
1798              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1799              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1800              ' alt="'.$strmovehere.'" /></a></li>
1801              ';
1802     }
1803     if (!empty($section->sequence) || $ismoving) {
1804         echo "</ul><!--class='section'-->\n\n";
1805     }
1808 /**
1809  * Prints the menus to add activities and resources.
1810  */
1811 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1812     global $CFG, $OUTPUT;
1814     // check to see if user can add menus
1815     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1816         return false;
1817     }
1819     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1821     $resources = array();
1822     $activities = array();
1824     foreach($modnames as $modname=>$modnamestr) {
1825         if (!course_allowed_module($course, $modname)) {
1826             continue;
1827         }
1829         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1830         if (!file_exists($libfile)) {
1831             continue;
1832         }
1833         include_once($libfile);
1834         $gettypesfunc =  $modname.'_get_types';
1835         if (function_exists($gettypesfunc)) {
1836             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1837             if ($types = $gettypesfunc()) {
1838                 $menu = array();
1839                 $atype = null;
1840                 $groupname = null;
1841                 foreach($types as $type) {
1842                     if ($type->typestr === '--') {
1843                         continue;
1844                     }
1845                     if (strpos($type->typestr, '--') === 0) {
1846                         $groupname = str_replace('--', '', $type->typestr);
1847                         continue;
1848                     }
1849                     $type->type = str_replace('&amp;', '&', $type->type);
1850                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1851                         $atype = MOD_CLASS_RESOURCE;
1852                     }
1853                     $menu[$urlbase.$type->type] = $type->typestr;
1854                 }
1855                 if (!is_null($groupname)) {
1856                     if ($atype == MOD_CLASS_RESOURCE) {
1857                         $resources[] = array($groupname=>$menu);
1858                     } else {
1859                         $activities[] = array($groupname=>$menu);
1860                     }
1861                 } else {
1862                     if ($atype == MOD_CLASS_RESOURCE) {
1863                         $resources = array_merge($resources, $menu);
1864                     } else {
1865                         $activities = array_merge($activities, $menu);
1866                     }
1867                 }
1868             }
1869         } else {
1870             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1871             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1872                 $resources[$urlbase.$modname] = $modnamestr;
1873             } else {
1874                 // all other archetypes are considered activity
1875                 $activities[$urlbase.$modname] = $modnamestr;
1876             }
1877         }
1878     }
1880     $straddactivity = get_string('addactivity');
1881     $straddresource = get_string('addresource');
1883     $output  = '<div class="section_add_menus">';
1885     if (!$vertical) {
1886         $output .= '<div class="horizontal">';
1887     }
1889     if (!empty($resources)) {
1890         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1891         $select->set_help_icon('resources');
1892         $output .= $OUTPUT->render($select);
1893     }
1895     if (!empty($activities)) {
1896         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1897         $select->set_help_icon('activities');
1898         $output .= $OUTPUT->render($select);
1899     }
1901     if (!$vertical) {
1902         $output .= '</div>';
1903     }
1905     $output .= '</div>';
1907     if ($return) {
1908         return $output;
1909     } else {
1910         echo $output;
1911     }
1914 /**
1915  * Return the course category context for the category with id $categoryid, except
1916  * that if $categoryid is 0, return the system context.
1917  *
1918  * @param integer $categoryid a category id or 0.
1919  * @return object the corresponding context
1920  */
1921 function get_category_or_system_context($categoryid) {
1922     if ($categoryid) {
1923         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1924     } else {
1925         return get_context_instance(CONTEXT_SYSTEM);
1926     }
1929 /**
1930  * Gets the child categories of a given courses category. Uses a static cache
1931  * to make repeat calls efficient.
1932  *
1933  * @param int $parentid the id of a course category.
1934  * @return array all the child course categories.
1935  */
1936 function get_child_categories($parentid) {
1937     static $allcategories = null;
1939     // only fill in this variable the first time
1940     if (null == $allcategories) {
1941         $allcategories = array();
1943         $categories = get_categories();
1944         foreach ($categories as $category) {
1945             if (empty($allcategories[$category->parent])) {
1946                 $allcategories[$category->parent] = array();
1947             }
1948             $allcategories[$category->parent][] = $category;
1949         }
1950     }
1952     if (empty($allcategories[$parentid])) {
1953         return array();
1954     } else {
1955         return $allcategories[$parentid];
1956     }
1959 /**
1960  * This function recursively travels the categories, building up a nice list
1961  * for display. It also makes an array that list all the parents for each
1962  * category.
1963  *
1964  * For example, if you have a tree of categories like:
1965  *   Miscellaneous (id = 1)
1966  *      Subcategory (id = 2)
1967  *         Sub-subcategory (id = 4)
1968  *   Other category (id = 3)
1969  * Then after calling this function you will have
1970  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1971  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1972  *      3 => 'Other category');
1973  * $parents = array(2 => array(1), 4 => array(1, 2));
1974  *
1975  * If you specify $requiredcapability, then only categories where the current
1976  * user has that capability will be added to $list, although all categories
1977  * will still be added to $parents, and if you only have $requiredcapability
1978  * in a child category, not the parent, then the child catgegory will still be
1979  * included.
1980  *
1981  * If you specify the option $excluded, then that category, and all its children,
1982  * are omitted from the tree. This is useful when you are doing something like
1983  * moving categories, where you do not want to allow people to move a category
1984  * to be the child of itself.
1985  *
1986  * @param array $list For output, accumulates an array categoryid => full category path name
1987  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1988  * @param string/array $requiredcapability if given, only categories where the current
1989  *      user has this capability will be added to $list. Can also be an array of capabilities,
1990  *      in which case they are all required.
1991  * @param integer $excludeid Omit this category and its children from the lists built.
1992  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1993  * @param string $path For internal use, as part of recursive calls.
1994  */
1995 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1996         $excludeid = 0, $category = NULL, $path = "") {
1998     // initialize the arrays if needed
1999     if (!is_array($list)) {
2000         $list = array();
2001     }
2002     if (!is_array($parents)) {
2003         $parents = array();
2004     }
2006     if (empty($category)) {
2007         // Start at the top level.
2008         $category = new stdClass;
2009         $category->id = 0;
2010     } else {
2011         // This is the excluded category, don't include it.
2012         if ($excludeid > 0 && $excludeid == $category->id) {
2013             return;
2014         }
2016         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2017         $categoryname = format_string($category->name, true, array('context' => $context));
2019         // Update $path.
2020         if ($path) {
2021             $path = $path.' / '.$categoryname;
2022         } else {
2023             $path = $categoryname;
2024         }
2026         // Add this category to $list, if the permissions check out.
2027         if (empty($requiredcapability)) {
2028             $list[$category->id] = $path;
2030         } else {
2031             $requiredcapability = (array)$requiredcapability;
2032             if (has_all_capabilities($requiredcapability, $context)) {
2033                 $list[$category->id] = $path;
2034             }
2035         }
2036     }
2038     // Add all the children recursively, while updating the parents array.
2039     if ($categories = get_child_categories($category->id)) {
2040         foreach ($categories as $cat) {
2041             if (!empty($category->id)) {
2042                 if (isset($parents[$category->id])) {
2043                     $parents[$cat->id]   = $parents[$category->id];
2044                 }
2045                 $parents[$cat->id][] = $category->id;
2046             }
2047             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2048         }
2049     }
2052 /**
2053  * This function generates a structured array of courses and categories.
2054  *
2055  * The depth of categories is limited by $CFG->maxcategorydepth however there
2056  * is no limit on the number of courses!
2057  *
2058  * Suitable for use with the course renderers course_category_tree method:
2059  * $renderer = $PAGE->get_renderer('core','course');
2060  * echo $renderer->course_category_tree(get_course_category_tree());
2061  *
2062  * @global moodle_database $DB
2063  * @param int $id
2064  * @param int $depth
2065  */
2066 function get_course_category_tree($id = 0, $depth = 0) {
2067     global $DB, $CFG;
2068     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2069     $categories = get_child_categories($id);
2070     $categoryids = array();
2071     foreach ($categories as $key => &$category) {
2072         if (!$category->visible && !$viewhiddencats) {
2073             unset($categories[$key]);
2074             continue;
2075         }
2076         $categoryids[$category->id] = $category;
2077         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2078             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2079             foreach ($subcategories as $subid=>$subcat) {
2080                 $categoryids[$subid] = $subcat;
2081             }
2082             $category->courses = array();
2083         }
2084     }
2086     if ($depth > 0) {
2087         // This is a recursive call so return the required array
2088         return array($categories, $categoryids);
2089     }
2091     // The depth is 0 this function has just been called so we can finish it off
2093     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2094     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2095     $sql = "SELECT
2096             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2097             $ccselect
2098             FROM {course} c
2099             $ccjoin
2100             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2101     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2102         // loop throught them
2103         foreach ($courses as $course) {
2104             if ($course->id == SITEID) {
2105                 continue;
2106             }
2107             context_instance_preload($course);
2108             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2109                 $categoryids[$course->category]->courses[$course->id] = $course;
2110             }
2111         }
2112     }
2113     return $categories;
2116 /**
2117  * Recursive function to print out all the categories in a nice format
2118  * with or without courses included
2119  */
2120 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2121     global $CFG;
2123     // maxcategorydepth == 0 meant no limit
2124     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2125         return;
2126     }
2128     if (!$displaylist) {
2129         make_categories_list($displaylist, $parentslist);
2130     }
2132     if ($category) {
2133         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2134             print_category_info($category, $depth, $showcourses);
2135         } else {
2136             return;  // Don't bother printing children of invisible categories
2137         }
2139     } else {
2140         $category->id = "0";
2141     }
2143     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2144         $countcats = count($categories);
2145         $count = 0;
2146         $first = true;
2147         $last = false;
2148         foreach ($categories as $cat) {
2149             $count++;
2150             if ($count == $countcats) {
2151                 $last = true;
2152             }
2153             $up = $first ? false : true;
2154             $down = $last ? false : true;
2155             $first = false;
2157             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2158         }
2159     }
2162 /**
2163  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2164  */
2165 function make_categories_options() {
2166     make_categories_list($cats,$parents);
2167     foreach ($cats as $key => $value) {
2168         if (array_key_exists($key,$parents)) {
2169             if ($indent = count($parents[$key])) {
2170                 for ($i = 0; $i < $indent; $i++) {
2171                     $cats[$key] = '&nbsp;'.$cats[$key];
2172                 }
2173             }
2174         }
2175     }
2176     return $cats;
2179 /**
2180  * Gets the name of a course to be displayed when showing a list of courses.
2181  * By default this is just $course->fullname but user can configure it. The
2182  * result of this function should be passed through print_string.
2183  * @param object $course Moodle course object
2184  * @return string Display name of course (either fullname or short + fullname)
2185  */
2186 function get_course_display_name_for_list($course) {
2187     global $CFG;
2188     if (!empty($CFG->courselistshortnames)) {
2189         return $course->shortname . ' ' .$course->fullname;
2190     } else {
2191         return $course->fullname;
2192     }
2195 /**
2196  * Prints the category info in indented fashion
2197  * This function is only used by print_whole_category_list() above
2198  */
2199 function print_category_info($category, $depth=0, $showcourses = false) {
2200     global $CFG, $DB, $OUTPUT;
2202     $strsummary = get_string('summary');
2204     $catlinkcss = null;
2205     if (!$category->visible) {
2206         $catlinkcss = array('class'=>'dimmed');
2207     }
2208     static $coursecount = null;
2209     if (null === $coursecount) {
2210         // only need to check this once
2211         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2212     }
2214     if ($showcourses and $coursecount) {
2215         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2216     } else {
2217         $catimage = "&nbsp;";
2218     }
2220     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2221     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2222     $fullname = format_string($category->name, true, array('context' => $context));
2224     if ($showcourses and $coursecount) {
2225         echo '<div class="categorylist clearfix">';
2226         $cat = '';
2227         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2228         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2229         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2231         $html = '';
2232         if ($depth > 0) {
2233             for ($i=0; $i< $depth; $i++) {
2234                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2235                 $cat = '';
2236             }
2237         } else {
2238             $html = $cat;
2239         }
2240         echo html_writer::tag('div', $html, array('class'=>'category'));
2241         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2243         // does the depth exceed maxcategorydepth
2244         // maxcategorydepth == 0 or unset meant no limit
2245         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2246         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2247             foreach ($courses as $course) {
2248                 $linkcss = null;
2249                 if (!$course->visible) {
2250                     $linkcss = array('class'=>'dimmed');
2251                 }
2253                 $coursename = get_course_display_name_for_list($course);
2254                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2256                 // print enrol info
2257                 $courseicon = '';
2258                 if ($icons = enrol_get_course_info_icons($course)) {
2259                     foreach ($icons as $pix_icon) {
2260                         $courseicon = $OUTPUT->render($pix_icon).' ';
2261                     }
2262                 }
2264                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2266                 if ($course->summary) {
2267                     $link = new moodle_url('/course/info.php?id='.$course->id);
2268                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2269                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2270                         array('title'=>$strsummary));
2272                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2273                 }
2275                 $html = '';
2276                 for ($i=0; $i <= $depth; $i++) {
2277                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2278                     $coursecontent = '';
2279                 }
2280                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2281             }
2282         }
2283         echo '</div>';
2284     } else {
2285         echo '<div class="categorylist">';
2286         $html = '';
2287         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2288         if (count($courses) > 0) {
2289             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2290         }
2292         if ($depth > 0) {
2293             for ($i=0; $i< $depth; $i++) {
2294                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2295                 $cat = '';
2296             }
2297         } else {
2298             $html = $cat;
2299         }
2301         echo html_writer::tag('div', $html, array('class'=>'category'));
2302         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2303         echo '</div>';
2304     }
2307 /**
2308  * Print the buttons relating to course requests.
2309  *
2310  * @param object $systemcontext the system context.
2311  */
2312 function print_course_request_buttons($systemcontext) {
2313     global $CFG, $DB, $OUTPUT;
2314     if (empty($CFG->enablecourserequests)) {
2315         return;
2316     }
2317     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2318     /// Print a button to request a new course
2319         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2320     }
2321     /// Print a button to manage pending requests
2322     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2323         $disabled = !$DB->record_exists('course_request', array());
2324         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2325     }
2328 /**
2329  * Does the user have permission to edit things in this category?
2330  *
2331  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2332  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2333  */
2334 function can_edit_in_category($categoryid = 0) {
2335     $context = get_category_or_system_context($categoryid);
2336     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2339 /**
2340  * Prints the turn editing on/off button on course/index.php or course/category.php.
2341  *
2342  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2343  * @return string HTML of the editing button, or empty string, if this user is not allowed
2344  *      to see it.
2345  */
2346 function update_category_button($categoryid = 0) {
2347     global $CFG, $PAGE, $OUTPUT;
2349     // Check permissions.
2350     if (!can_edit_in_category($categoryid)) {
2351         return '';
2352     }
2354     // Work out the appropriate action.
2355     if ($PAGE->user_is_editing()) {
2356         $label = get_string('turneditingoff');
2357         $edit = 'off';
2358     } else {
2359         $label = get_string('turneditingon');
2360         $edit = 'on';
2361     }
2363     // Generate the button HTML.
2364     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2365     if ($categoryid) {
2366         $options['id'] = $categoryid;
2367         $page = 'category.php';
2368     } else {
2369         $page = 'index.php';
2370     }
2371     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2374 /**
2375  * Category is 0 (for all courses) or an object
2376  */
2377 function print_courses($category) {
2378     global $CFG, $OUTPUT;
2380     if (!is_object($category) && $category==0) {
2381         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2382         if (is_array($categories) && count($categories) == 1) {
2383             $category   = array_shift($categories);
2384             $courses    = get_courses_wmanagers($category->id,
2385                                                 'c.sortorder ASC',
2386                                                 array('summary','summaryformat'));
2387         } else {
2388             $courses    = get_courses_wmanagers('all',
2389                                                 'c.sortorder ASC',
2390                                                 array('summary','summaryformat'));
2391         }
2392         unset($categories);
2393     } else {
2394         $courses    = get_courses_wmanagers($category->id,
2395                                             'c.sortorder ASC',
2396                                             array('summary','summaryformat'));
2397     }
2399     if ($courses) {
2400         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2401         foreach ($courses as $course) {
2402             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2403             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2404                 echo html_writer::start_tag('li');
2405                 print_course($course);
2406                 echo html_writer::end_tag('li');
2407             }
2408         }
2409         echo html_writer::end_tag('ul');
2410     } else {
2411         echo $OUTPUT->heading(get_string("nocoursesyet"));
2412         $context = get_context_instance(CONTEXT_SYSTEM);
2413         if (has_capability('moodle/course:create', $context)) {
2414             $options = array();
2415             if (!empty($category->id)) {
2416                 $options['category'] = $category->id;
2417             } else {
2418                 $options['category'] = $CFG->defaultrequestcategory;
2419             }
2420             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2421             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2422             echo html_writer::end_tag('div');
2423         }
2424     }
2427 /**
2428  * Print a description of a course, suitable for browsing in a list.
2429  *
2430  * @param object $course the course object.
2431  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2432  */
2433 function print_course($course, $highlightterms = '') {
2434     global $CFG, $USER, $DB, $OUTPUT;
2436     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2438     // Rewrite file URLs so that they are correct
2439     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2441     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2442     echo html_writer::start_tag('div', array('class'=>'info'));
2443     echo html_writer::start_tag('h3', array('class'=>'name'));
2445     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2447     $coursename = get_course_display_name_for_list($course);
2448     $linktext = highlight($highlightterms, format_string($coursename));
2449     $linkparams = array('title'=>get_string('entercourse'));
2450     if (empty($course->visible)) {
2451         $linkparams['class'] = 'dimmed';
2452     }
2453     echo html_writer::link($linkhref, $linktext, $linkparams);
2454     echo html_writer::end_tag('h3');
2456     /// first find all roles that are supposed to be displayed
2457     if (!empty($CFG->coursecontact)) {
2458         $managerroles = explode(',', $CFG->coursecontact);
2459         $namesarray = array();
2460         $rusers = array();
2462         if (!isset($course->managers)) {
2463             $rusers = get_role_users($managerroles, $context, true,
2464                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2465                  r.name AS rolename, r.sortorder, r.id AS roleid',
2466                 'r.sortorder ASC, u.lastname ASC');
2467         } else {
2468             //  use the managers array if we have it for perf reasosn
2469             //  populate the datastructure like output of get_role_users();
2470             foreach ($course->managers as $manager) {
2471                 $u = new stdClass();
2472                 $u = $manager->user;
2473                 $u->roleid = $manager->roleid;
2474                 $u->rolename = $manager->rolename;
2476                 $rusers[] = $u;
2477             }
2478         }
2480         /// Rename some of the role names if needed
2481         if (isset($context)) {
2482             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2483         }
2485         $namesarray = array();
2486         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2487         foreach ($rusers as $ra) {
2488             if (isset($namesarray[$ra->id])) {
2489                 //  only display a user once with the higest sortorder role
2490                 continue;
2491             }
2493             if (isset($aliasnames[$ra->roleid])) {
2494                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2495             }
2497             $fullname = fullname($ra, $canviewfullnames);
2498             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2499                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2500         }
2502         if (!empty($namesarray)) {
2503             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2504             foreach ($namesarray as $name) {
2505                 echo html_writer::tag('li', $name);
2506             }
2507             echo html_writer::end_tag('ul');
2508         }
2509     }
2510     echo html_writer::end_tag('div'); // End of info div
2512     echo html_writer::start_tag('div', array('class'=>'summary'));
2513     $options = NULL;
2514     $options->noclean = true;
2515     $options->para = false;
2516     $options->overflowdiv = true;
2517     if (!isset($course->summaryformat)) {
2518         $course->summaryformat = FORMAT_MOODLE;
2519     }
2520     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2521     if ($icons = enrol_get_course_info_icons($course)) {
2522         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2523         foreach ($icons as $icon) {
2524             echo $OUTPUT->render($icon);
2525         }
2526         echo html_writer::end_tag('div'); // End of enrolmenticons div
2527     }
2528     echo html_writer::end_tag('div'); // End of summary div
2529     echo html_writer::end_tag('div'); // End of coursebox div
2532 /**
2533  * Prints custom user information on the home page.
2534  * Over time this can include all sorts of information
2535  */
2536 function print_my_moodle() {
2537     global $USER, $CFG, $DB, $OUTPUT;
2539     if (!isloggedin() or isguestuser()) {
2540         print_error('nopermissions', '', '', 'See My Moodle');
2541     }
2543     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2544     $rhosts   = array();
2545     $rcourses = array();
2546     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2547         $rcourses = get_my_remotecourses($USER->id);
2548         $rhosts   = get_my_remotehosts();
2549     }
2551     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2553         if (!empty($courses)) {
2554             echo '<ul class="unlist">';
2555             foreach ($courses as $course) {
2556                 if ($course->id == SITEID) {
2557                     continue;
2558                 }
2559                 echo '<li>';
2560                 print_course($course);
2561                 echo "</li>\n";
2562             }
2563             echo "</ul>\n";
2564         }
2566         // MNET
2567         if (!empty($rcourses)) {
2568             // at the IDP, we know of all the remote courses
2569             foreach ($rcourses as $course) {
2570                 print_remote_course($course, "100%");
2571             }
2572         } elseif (!empty($rhosts)) {
2573             // non-IDP, we know of all the remote servers, but not courses
2574             foreach ($rhosts as $host) {
2575                 print_remote_host($host, "100%");
2576             }
2577         }
2578         unset($course);
2579         unset($host);
2581         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2582             echo "<table width=\"100%\"><tr><td align=\"center\">";
2583             print_course_search("", false, "short");
2584             echo "</td><td align=\"center\">";
2585             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2586             echo "</td></tr></table>\n";
2587         }
2589     } else {
2590         if ($DB->count_records("course_categories") > 1) {
2591             echo $OUTPUT->box_start("categorybox");
2592             print_whole_category_list();
2593             echo $OUTPUT->box_end();
2594         } else {
2595             print_courses(0);
2596         }
2597     }
2601 function print_course_search($value="", $return=false, $format="plain") {
2602     global $CFG;
2603     static $count = 0;
2605     $count++;
2607     $id = 'coursesearch';
2609     if ($count > 1) {
2610         $id .= $count;
2611     }
2613     $strsearchcourses= get_string("searchcourses");
2615     if ($format == 'plain') {
2616         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2617         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2618         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2619         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2620         $output .= '<input type="submit" value="'.get_string('go').'" />';
2621         $output .= '</fieldset></form>';
2622     } else if ($format == 'short') {
2623         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2624         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2625         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2626         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2627         $output .= '<input type="submit" value="'.get_string('go').'" />';
2628         $output .= '</fieldset></form>';
2629     } else if ($format == 'navbar') {
2630         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2631         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2632         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2633         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2634         $output .= '<input type="submit" value="'.get_string('go').'" />';
2635         $output .= '</fieldset></form>';
2636     }
2638     if ($return) {
2639         return $output;
2640     }
2641     echo $output;
2644 function print_remote_course($course, $width="100%") {
2645     global $CFG, $USER;
2647     $linkcss = '';
2649     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2651     echo '<div class="coursebox remotecoursebox clearfix">';
2652     echo '<div class="info">';
2653     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2654          $linkcss.' href="'.$url.'">'
2655         .  format_string($course->fullname) .'</a><br />'
2656         . format_string($course->hostname) . ' : '
2657         . format_string($course->cat_name) . ' : '
2658         . format_string($course->shortname). '</div>';
2659     echo '</div><div class="summary">';
2660     $options = NULL;
2661     $options->noclean = true;
2662     $options->para = false;
2663     $options->overflowdiv = true;
2664     echo format_text($course->summary, $course->summaryformat, $options);
2665     echo '</div>';
2666     echo '</div>';
2669 function print_remote_host($host, $width="100%") {
2670     global $OUTPUT;
2672     $linkcss = '';
2674     echo '<div class="coursebox clearfix">';
2675     echo '<div class="info">';
2676     echo '<div class="name">';
2677     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2678     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2679         . s($host['name']).'</a> - ';
2680     echo $host['count'] . ' ' . get_string('courses');
2681     echo '</div>';
2682     echo '</div>';
2683     echo '</div>';
2687 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2689 function add_course_module($mod) {
2690     global $DB;
2692     $mod->added = time();
2693     unset($mod->id);
2695     return $DB->insert_record("course_modules", $mod);
2698 /**
2699  * Returns course section - creates new if does not exist yet.
2700  * @param int $relative section number
2701  * @param int $courseid
2702  * @return object $course_section object
2703  */
2704 function get_course_section($section, $courseid) {
2705     global $DB;
2707     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2708         return $cw;
2709     }
2710     $cw = new stdClass();
2711     $cw->course   = $courseid;
2712     $cw->section  = $section;
2713     $cw->summary  = "";
2714     $cw->summaryformat = FORMAT_HTML;
2715     $cw->sequence = "";
2716     $id = $DB->insert_record("course_sections", $cw);
2717     return $DB->get_record("course_sections", array("id"=>$id));
2719 /**
2720  * Given a full mod object with section and course already defined, adds this module to that section.
2721  *
2722  * @param object $mod
2723  * @param int $beforemod An existing ID which we will insert the new module before
2724  * @return int The course_sections ID where the mod is inserted
2725  */
2726 function add_mod_to_section($mod, $beforemod=NULL) {
2727     global $DB;
2729     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2731         $section->sequence = trim($section->sequence);
2733         if (empty($section->sequence)) {
2734             $newsequence = "$mod->coursemodule";
2736         } else if ($beforemod) {
2737             $modarray = explode(",", $section->sequence);
2739             if ($key = array_keys($modarray, $beforemod->id)) {
2740                 $insertarray = array($mod->id, $beforemod->id);
2741                 array_splice($modarray, $key[0], 1, $insertarray);
2742                 $newsequence = implode(",", $modarray);
2744             } else {  // Just tack it on the end anyway
2745                 $newsequence = "$section->sequence,$mod->coursemodule";
2746             }
2748         } else {
2749             $newsequence = "$section->sequence,$mod->coursemodule";
2750         }
2752         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2753         return $section->id;     // Return course_sections ID that was used.
2755     } else {  // Insert a new record
2756         $section->course   = $mod->course;
2757         $section->section  = $mod->section;
2758         $section->summary  = "";
2759         $section->summaryformat = FORMAT_HTML;
2760         $section->sequence = $mod->coursemodule;
2761         return $DB->insert_record("course_sections", $section);
2762     }
2765 function set_coursemodule_groupmode($id, $groupmode) {
2766     global $DB;
2767     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2770 function set_coursemodule_idnumber($id, $idnumber) {
2771     global $DB;
2772     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2775 /**
2776 * $prevstateoverrides = true will set the visibility of the course module
2777 * to what is defined in visibleold. This enables us to remember the current
2778 * visibility when making a whole section hidden, so that when we toggle
2779 * that section back to visible, we are able to return the visibility of
2780 * the course module back to what it was originally.
2781 */
2782 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2783     global $DB, $CFG;
2784     require_once($CFG->libdir.'/gradelib.php');
2786     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2787         return false;
2788     }
2789     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2790         return false;
2791     }
2792     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2793         foreach($events as $event) {
2794             if ($visible) {
2795                 show_event($event);
2796             } else {
2797                 hide_event($event);
2798             }
2799         }
2800     }
2802     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2803     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2804     if ($grade_items) {
2805         foreach ($grade_items as $grade_item) {
2806             $grade_item->set_hidden(!$visible);
2807         }
2808     }
2810     if ($prevstateoverrides) {
2811         if ($visible == '0') {
2812             // Remember the current visible state so we can toggle this back.
2813             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2814         } else {
2815             // Get the previous saved visible states.
2816             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2817         }
2818     }
2819     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2822 /**
2823  * Delete a course module and any associated data at the course level (events)
2824  * Until 1.5 this function simply marked a deleted flag ... now it
2825  * deletes it completely.
2826  *
2827  */
2828 function delete_course_module($id) {
2829     global $CFG, $DB;
2830     require_once($CFG->libdir.'/gradelib.php');
2831     require_once($CFG->dirroot.'/blog/lib.php');
2833     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2834         return true;
2835     }
2836     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2837     //delete events from calendar
2838     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2839         foreach($events as $event) {
2840             delete_event($event->id);
2841         }
2842     }
2843     //delete grade items, outcome items and grades attached to modules
2844     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2845                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2846         foreach ($grade_items as $grade_item) {
2847             $grade_item->delete('moddelete');
2848         }
2849     }
2850     // Delete completion and availability data; it is better to do this even if the
2851     // features are not turned on, in case they were turned on previously (these will be
2852     // very quick on an empty table)
2853     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2854     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2856     delete_context(CONTEXT_MODULE, $cm->id);
2857     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2860 function delete_mod_from_section($mod, $section) {
2861     global $DB;
2863     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2865         $modarray = explode(",", $section->sequence);
2867         if ($key = array_keys ($modarray, $mod)) {
2868             array_splice($modarray, $key[0], 1);
2869             $newsequence = implode(",", $modarray);
2870             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2871         } else {
2872             return false;
2873         }
2875     }
2876     return false;
2879 /**
2880  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2881  *
2882  * @param object $course
2883  * @param int $section
2884  * @param int $move (-1 or 1)
2885  */
2886 function move_section($course, $section, $move) {
2887 /// Moves a whole course section up and down within the course
2888     global $USER, $DB;
2890     if (!$move) {
2891         return true;
2892     }
2894     $sectiondest = $section + $move;
2896     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2897         return false;
2898     }
2900     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2901         return false;
2902     }
2904     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2905         return false;
2906     }
2908     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2909     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2911     // if the focus is on the section that is being moved, then move the focus along
2912     if (course_get_display($course->id) == $section) {
2913         course_set_display($course->id, $sectiondest);
2914     }
2916     // Check for duplicates and fix order if needed.
2917     // There is a very rare case that some sections in the same course have the same section id.
2918     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2919     $n = 0;
2920     foreach ($sections as $section) {
2921         if ($section->section != $n) {
2922             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2923         }
2924         $n++;
2925     }
2926     return true;
2929 /**
2930  * Moves a section within a course, from a position to another.
2931  * Be very careful: $section and $destination refer to section number,
2932  * not id!.
2933  *
2934  * @param object $course
2935  * @param int $section Section number (not id!!!)
2936  * @param int $destination
2937  * @return boolean Result
2938  */
2939 function move_section_to($course, $section, $destination) {
2940 /// Moves a whole course section up and down within the course
2941     global $USER, $DB;
2943     if (!$destination && $destination != 0) {
2944         return true;
2945     }
2947     if ($destination > $course->numsections) {
2948         return false;
2949     }
2951     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2952     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2953             'section ASC, id ASC', 'id, section')) {
2954         return false;
2955     }
2957     $sections = reorder_sections($sections, $section, $destination);
2959     // Update all sections
2960     foreach ($sections as $id => $position) {
2961         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2962     }
2964     // if the focus is on the section that is being moved, then move the focus along
2965     if (course_get_display($course->id) == $section) {
2966         course_set_display($course->id, $destination);
2967     }
2968     return true;
2971 /**
2972  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2973  * an original position number and a target position number, rebuilds the array so that the
2974  * move is made without any duplication of section positions.
2975  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2976  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2977  *
2978  * @param array $sections
2979  * @param int $origin_position
2980  * @param int $target_position
2981  * @return array
2982  */
2983 function reorder_sections($sections, $origin_position, $target_position) {
2984     if (!is_array($sections)) {
2985         return false;
2986     }
2988     // We can't move section position 0
2989     if ($origin_position < 1) {
2990         echo "We can't move section position 0";
2991         return false;
2992     }
2994     // Locate origin section in sections array
2995     if (!$origin_key = array_search($origin_position, $sections)) {
2996         echo "searched position not in sections array";
2997         return false; // searched position not in sections array
2998     }
3000     // Extract origin section
3001     $origin_section = $sections[$origin_key];
3002     unset($sections[$origin_key]);
3004     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3005     $found = false;
3006     $append_array = array();
3007     foreach ($sections as $id => $position) {
3008         if ($found) {
3009             $append_array[$id] = $position;
3010             unset($sections[$id]);
3011         }
3012         if ($position == $target_position) {
3013             $found = true;
3014         }
3015     }
3017     // Append moved section
3018     $sections[$origin_key] = $origin_section;
3020     // Append rest of array (if applicable)
3021     if (!empty($append_array)) {
3022         foreach ($append_array as $id => $position) {
3023             $sections[$id] = $position;
3024         }
3025     }
3027     // Renumber positions
3028     $position = 0;
3029     foreach ($sections as $id => $p) {
3030         $sections[$id] = $position;
3031         $position++;
3032     }
3034     return $sections;
3038 /**
3039  * Move the module object $mod to the specified $section
3040  * If $beforemod exists then that is the module
3041  * before which $modid should be inserted
3042  * All parameters are objects
3043  */
3044 function moveto_module($mod, $section, $beforemod=NULL) {
3045     global $DB, $OUTPUT;
3047 /// Remove original module from original section
3048     if (! delete_mod_from_section($mod->id, $mod->section)) {
3049         echo $OUTPUT->notification("Could not delete module from existing section");
3050     }
3052 /// Update module itself if necessary
3054     if ($mod->section != $section->id) {
3055         $mod->section = $section->id;
3056         $DB->update_record("course_modules", $mod);
3057         // if moving to a hidden section then hide module
3058         if (!$section->visible) {
3059             set_coursemodule_visible($mod->id, 0);
3060         }
3061     }
3063 /// Add the module into the new section
3065     $mod->course       = $section->course;
3066     $mod->section      = $section->section;  // need relative reference
3067     $mod->coursemodule = $mod->id;
3069     if (! add_mod_to_section($mod, $beforemod)) {
3070         return false;
3071     }
3073     return true;
3076 /**
3077  * Produces the editing buttons for a module
3078  *
3079  * @global core_renderer $OUTPUT
3080  * @staticvar type $str
3081  * @param stdClass $mod The module to produce editing buttons for
3082  * @param bool $absolute If true an absolute link is produced (default true)
3083  * @param bool $moveselect If true a move seleciton process is used (default true)
3084  * @param int $indent The current indenting
3085  * @param int $section The section to link back to
3086  * @return string XHTML for the editing buttons
3087  */
3088 function make_editing_buttons(stdClass $mod, $absolute = true, $moveselect = true, $indent=-1, $section=-1) {
3089     global $CFG, $OUTPUT;
3091     static $str;
3093     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3094     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3096     // no permission to edit
3097     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
3098         return false;
3099     }
3101     if (!isset($str)) {
3102         $str = new stdClass;
3103         $str->assign         = get_string("assignroles", 'role');
3104         $str->delete         = get_string("delete");
3105         $str->move           = get_string("move");
3106         $str->moveup         = get_string("moveup");
3107         $str->movedown       = get_string("movedown");
3108         $str->moveright      = get_string("moveright");
3109         $str->moveleft       = get_string("moveleft");
3110         $str->update         = get_string("update");
3111         $str->duplicate      = get_string("duplicate");
3112         $str->hide           = get_string("hide");
3113         $str->show           = get_string("show");
3114         $str->clicktochange  = get_string("clicktochange");
3115         $str->forcedmode     = get_string("forcedmode");
3116         $str->groupsnone     = get_string("groupsnone");
3117         $str->groupsseparate = get_string("groupsseparate");
3118         $str->groupsvisible  = get_string("groupsvisible");
3119     }
3121     if ($absolute) {
3122         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3123     } else {
3124         $baseurl = new moodle_url('mod.php', array('sesskey' => sesskey()));
3125     }
3127     if ($section >= 0) {
3128         $baseurl->param('sr', $section);
3129     }
3130     $actions = array();
3132     // leftright
3133     if (has_capability('moodle/course:update', $coursecontext)) {
3134         if (right_to_left()) {   // Exchange arrows on RTL
3135             $rightarrow = 't/left';
3136             $leftarrow  = 't/right';
3137         } else {
3138             $rightarrow = 't/right';
3139             $leftarrow  = 't/left';
3140         }
3142         if ($indent > 0) {
3143             $actions[] = new action_link(
3144                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3145                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3146                 null,
3147                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3148             );
3149         }
3150         if ($indent >= 0) {
3151             $actions[] = new action_link(
3152                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3153                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3154                 null,
3155                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3156             );
3157         }
3158     }
3160     // move
3161     if (has_capability('moodle/course:update', $coursecontext)) {
3162         if ($moveselect) {
3163             $actions[] = new action_link(
3164                 new moodle_url($baseurl, array('copy' => $mod->id)),
3165                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3166                 null,
3167                 array('class' => 'editing_move', 'title' => $str->move)
3168             );
3169         } else {
3170             $actions[] = new action_link(
3171                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3172                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3173                 null,
3174                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3175             );
3176             $actions[] = new action_link(
3177                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3178                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3179                 null,
3180                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3181             );
3182         }
3183     }
3185     // Update
3186     $actions[] = new action_link(
3187         new moodle_url($baseurl, array('update' => $mod->id)),
3188         new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3189         null,
3190         array('class' => 'editing_update', 'title' => $str->update)
3191     );
3193     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3194     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3195     if (has_all_capabilities($dupecaps, $coursecontext)) {
3196         $actions[] = new action_link(
3197             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3198             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3199             null,
3200             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3201         );
3202     }
3204     // Delete
3205     $actions[] = new action_link(
3206         new moodle_url($baseurl, array('delete' => $mod->id)),
3207         new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3208         null,
3209         array('class' => 'editing_delete', 'title' => $str->delete)
3210     );
3212     // hideshow
3213     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3214         if ($mod->visible) {
3215             $actions[] = new action_link(
3216                 new moodle_url($baseurl, array('hide' => $mod->id)),
3217                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3218                 null,
3219                 array('class' => 'editing_hide', 'title' => $str->hide)
3220             );
3221         } else {
3222             $actions[] = new action_link(
3223                 new moodle_url($baseurl, array('show' => $mod->id)),
3224                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3225                 null,
3226                 array('class' => 'editing_show', 'title' => $str->show)
3227             );
3228         }
3229     }
3231     // groupmode
3232     if ($mod->groupmode !== false) {
3233         if ($mod->groupmode == SEPARATEGROUPS) {
3234             $groupmode = 0;
3235             $grouptitle = $str->groupsseparate;
3236             $groupclass = 'editing_groupsseparate';
3237             $groupimage = 't/groups';
3238         } else if ($mod->groupmode == VISIBLEGROUPS) {
3239             $groupmode = 1;
3240             $grouptitle = $str->groupsvisible;
3241             $groupclass = 'editing_groupsvisible';
3242             $groupimage = 't/groupv';
3243         } else {
3244             $groupmode = 2;
3245             $grouptitle = $str->groupsnone;
3246             $groupclass = 'editing_groupsnone';
3247             $groupimage = 't/groupn';
3248         }
3249         if ($mod->groupmodelink) {
3250             $actions[] = new action_link(
3251                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3252                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3253                 null,
3254                 array('class' => $groupclass, 'title' => $grouptitle.' ('.$str->clicktochange.')')
3255             );
3256         } else {
3257             $actions[] = new pix_icon($groupimage, $grouptitle, 'moodle', array('title' => $grouptitle.' ('.$str->forcedmode.')', 'class' => 'iconsmall'));
3258         }
3259     }
3261     // Assign
3262     if (has_capability('moodle/course:managegroups', $modcontext)){
3263         $actions[] = new action_link(
3264             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3265             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3266             null,
3267             array('class' => 'editing_assign', 'title' => $str->assign)
3268         );
3269     }
3271     $output = html_writer::start_tag('span', array('class' => 'commands'));
3272     foreach ($actions as $action) {
3273         if ($action instanceof renderable) {
3274             $output .= $OUTPUT->render($action);
3275         } else {
3276             $output .= $action;
3277         }
3278     }
3279     $output .= html_writer::end_tag('span');
3280     return $output;
3283 /**
3284  * given a course object with shortname & fullname, this function will
3285  * truncate the the number of chars allowed and add ... if it was too long
3286  */
3287 function course_format_name ($course,$max=100) {
3289     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3290     $shortname = format_string($course->shortname, true, array('context' => $context));
3291     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3292     $str = $shortname.': '. $fullname;
3293     if (textlib::strlen($str) <= $max) {
3294         return $str;
3295     }
3296     else {
3297         return textlib::substr($str,0,$max-3).'...';
3298     }
3301 function update_restricted_mods($course, $mods) {
3302     global $DB;
3304 /// Delete all the current restricted list
3305     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3307     if (empty($course->restrictmodules)) {
3308         return;   // We're done
3309     }
3311 /// Insert the new list of restricted mods
3312     foreach ($mods as $mod) {
3313         if ($mod == 0) {
3314             continue; // this is the 'allow none' option
3315         }
3316         $am = new stdClass();
3317         $am->course = $course->id;
3318         $am->module = $mod;
3319         $DB->insert_record('course_allowed_modules',$am);
3320     }
3323 /**
3324  * This function will take an int (module id) or a string (module name)
3325  * and return true or false, whether it's allowed in the given course (object)
3326  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3327  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3328  */
3330 function course_allowed_module($course,$mod) {
3331     global $DB;
3333     if (empty($course->restrictmodules)) {
3334         return true;
3335     }
3337     // Admins and admin-like people who can edit everything can also add anything.
3338     // Originally there was a course:update test only, but it did not match the test in course edit form
3339     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3340         return true;
3341     }
3343     if (is_numeric($mod)) {
3344         $modid = $mod;
3345     } else if (is_string($mod)) {
3346         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3347     }
3348     if (empty($modid)) {
3349         return false;
3350     }
3352     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3355 /**
3356  * Recursively delete category including all subcategories and courses.
3357  * @param stdClass $category
3358  * @param boolean $showfeedback display some notices
3359  * @return array return deleted courses
3360  */
3361 function category_delete_full($category, $showfeedback=true) {
3362     global $CFG, $DB;
3363     require_once($CFG->libdir.'/gradelib.php');
3364     require_once($CFG->libdir.'/questionlib.php');
3365     require_once($CFG->dirroot.'/cohort/lib.php');
3367     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3368         foreach ($children as $childcat) {
3369             category_delete_full($childcat, $showfeedback);
3370         }
3371     }
3373     $deletedcourses = array();
3374     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3375         foreach ($courses as $course) {
3376             if (!delete_course($course, false)) {
3377                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3378             }
3379             $deletedcourses[] = $course;
3380         }
3381     }
3383     // move or delete cohorts in this context
3384     cohort_delete_category($category);
3386     // now delete anything that may depend on course category context
3387     grade_course_category_delete($category->id, 0, $showfeedback);
3388     if (!question_delete_course_category($category, 0, $showfeedback)) {
3389         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3390     }
3392     // finally delete the category and it's context
3393     $DB->delete_records('course_categories', array('id'=>$category->id));
3394     delete_context(CONTEXT_COURSECAT, $category->id);
3396     events_trigger('course_category_deleted', $category);
3398     return $deletedcourses;
3401 /**
3402  * Delete category, but move contents to another category.
3403  * @param object $ccategory
3404  * @param int $newparentid category id
3405  * @return bool status
3406  */
3407 function category_delete_move($category, $newparentid, $showfeedback=true) {
3408     global $CFG, $DB, $OUTPUT;
3409     require_once($CFG->libdir.'/gradelib.php');
3410     require_once($CFG->libdir.'/questionlib.php');
3411     require_once($CFG->dirroot.'/cohort/lib.php');
3413     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3414         return false;
3415     }
3417     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3418         foreach ($children as $childcat) {
3419             move_category($childcat, $newparentcat);
3420         }
3421     }
3423     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3424         if (!move_courses(array_keys($courses), $newparentid)) {
3425             echo $OUTPUT->notification("Error moving courses");
3426             return false;
3427         }
3428         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3429     }
3431     // move or delete cohorts in this context
3432     cohort_delete_category($category);
3434     // now delete anything that may depend on course category context
3435     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3436     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3437         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3438         return false;
3439     }
3441     // finally delete the category and it's context
3442     $DB->delete_records('course_categories', array('id'=>$category->id));
3443     delete_context(CONTEXT_COURSECAT, $category->id);
3445     events_trigger('course_category_deleted', $category);
3447     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3449     return true;
3452 /**
3453  * Efficiently moves many courses around while maintaining
3454  * sortorder in order.
3455  *
3456  * @param array $courseids is an array of course ids
3457  * @param int $categoryid
3458  * @return bool success
3459  */
3460 function move_courses($courseids, $categoryid) {
3461     global $CFG, $DB, $OUTPUT;
3463     if (empty($courseids)) {
3464         // nothing to do
3465         return;
3466     }
3468     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3469         return false;
3470     }
3472     $courseids = array_reverse($courseids);
3473     $newparent = get_context_instance(CONTEXT_COURSECAT, $category->id);
3474     $i = 1;
3476     foreach ($courseids as $courseid) {
3477         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3478             $course = new stdClass();
3479             $course->id = $courseid;
3480             $course->category  = $category->id;
3481             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3482             if ($category->visible == 0) {
3483                 // hide the course when moving into hidden category,
3484                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3485                 $course->visible = 0;
3486             }
3488             $DB->update_record('course', $course);
3490             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3491             context_moved($context, $newparent);
3492         }
3493     }
3494     fix_course_sortorder();
3496     return true;
3499 /**
3500  * Hide course category and child course and subcategories
3501  * @param stdClass $category
3502  * @return void
3503  */
3504 function course_category_hide($category) {
3505     global $DB;
3507     $category->visible = 0;
3508     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3509     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3510     $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
3511     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3512     // get all child categori