MDL-34435 reports: Log category actions
[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');
31 require_once($CFG->dirroot.'/course/dnduploadlib.php');
33 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
34 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
35 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
36 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
37 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
38 define('FRONTPAGENEWS',           '0');
39 define('FRONTPAGECOURSELIST',     '1');
40 define('FRONTPAGECATEGORYNAMES',  '2');
41 define('FRONTPAGETOPICONLY',      '3');
42 define('FRONTPAGECATEGORYCOMBO',  '4');
43 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
44 define('EXCELROWS', 65535);
45 define('FIRSTUSEDEXCELROW', 3);
47 define('MOD_CLASS_ACTIVITY', 0);
48 define('MOD_CLASS_RESOURCE', 1);
50 function make_log_url($module, $url) {
51     switch ($module) {
52         case 'course':
53             if (strpos($url, 'report/') === 0) {
54                 // there is only one report type, course reports are deprecated
55                 $url = "/$url";
56                 break;
57             }
58         case 'file':
59         case 'login':
60         case 'lib':
61         case 'admin':
62         case 'calendar':
63         case 'category':
64         case 'mnet course':
65             if (strpos($url, '../') === 0) {
66                 $url = ltrim($url, '.');
67             } else {
68                 $url = "/course/$url";
69             }
70             break;
71         case 'user':
72         case 'blog':
73             $url = "/$module/$url";
74             break;
75         case 'upload':
76             $url = $url;
77             break;
78         case 'coursetags':
79             $url = '/'.$url;
80             break;
81         case 'library':
82         case '':
83             $url = '/';
84             break;
85         case 'message':
86             $url = "/message/$url";
87             break;
88         case 'notes':
89             $url = "/notes/$url";
90             break;
91         case 'tag':
92             $url = "/tag/$url";
93             break;
94         case 'role':
95             $url = '/'.$url;
96             break;
97         default:
98             $url = "/mod/$module/$url";
99             break;
100     }
102     //now let's sanitise urls - there might be some ugly nasties:-(
103     $parts = explode('?', $url);
104     $script = array_shift($parts);
105     if (strpos($script, 'http') === 0) {
106         $script = clean_param($script, PARAM_URL);
107     } else {
108         $script = clean_param($script, PARAM_PATH);
109     }
111     $query = '';
112     if ($parts) {
113         $query = implode('', $parts);
114         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
115         $parts = explode('&', $query);
116         $eq = urlencode('=');
117         foreach ($parts as $key=>$part) {
118             $part = urlencode(urldecode($part));
119             $part = str_replace($eq, '=', $part);
120             $parts[$key] = $part;
121         }
122         $query = '?'.implode('&amp;', $parts);
123     }
125     return $script.$query;
129 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
130                    $modname="", $modid=0, $modaction="", $groupid=0) {
131     global $CFG, $DB;
133     // It is assumed that $date is the GMT time of midnight for that day,
134     // and so the next 86400 seconds worth of logs are printed.
136     /// Setup for group handling.
138     // TODO: I don't understand group/context/etc. enough to be able to do
139     // something interesting with it here
140     // What is the context of a remote course?
142     /// If the group mode is separate, and this user does not have editing privileges,
143     /// then only the user's group can be viewed.
144     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
145     //    $groupid = get_current_group($course->id);
146     //}
147     /// If this course doesn't have groups, no groupid can be specified.
148     //else if (!$course->groupmode) {
149     //    $groupid = 0;
150     //}
152     $groupid = 0;
154     $joins = array();
155     $where = '';
157     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
158               FROM {mnet_log} l
159                LEFT JOIN {user} u ON l.userid = u.id
160               WHERE ";
161     $params = array();
163     $where .= "l.hostid = :hostid";
164     $params['hostid'] = $hostid;
166     // TODO: Is 1 really a magic number referring to the sitename?
167     if ($course != SITEID || $modid != 0) {
168         $where .= " AND l.course=:courseid";
169         $params['courseid'] = $course;
170     }
172     if ($modname) {
173         $where .= " AND l.module = :modname";
174         $params['modname'] = $modname;
175     }
177     if ('site_errors' === $modid) {
178         $where .= " AND ( l.action='error' OR l.action='infected' )";
179     } else if ($modid) {
180         //TODO: This assumes that modids are the same across sites... probably
181         //not true
182         $where .= " AND l.cmid = :modid";
183         $params['modid'] = $modid;
184     }
186     if ($modaction) {
187         $firstletter = substr($modaction, 0, 1);
188         if ($firstletter == '-') {
189             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
190             $params['modaction'] = '%'.substr($modaction, 1).'%';
191         } else {
192             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
193             $params['modaction'] = '%'.$modaction.'%';
194         }
195     }
197     if ($user) {
198         $where .= " AND l.userid = :user";
199         $params['user'] = $user;
200     }
202     if ($date) {
203         $enddate = $date + 86400;
204         $where .= " AND l.time > :date AND l.time < :enddate";
205         $params['date'] = $date;
206         $params['enddate'] = $enddate;
207     }
209     $result = array();
210     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
211     if(!empty($result['totalcount'])) {
212         $where .= " ORDER BY $order";
213         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
214     } else {
215         $result['logs'] = array();
216     }
217     return $result;
220 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
221                    $modname="", $modid=0, $modaction="", $groupid=0) {
222     global $DB, $SESSION, $USER;
223     // It is assumed that $date is the GMT time of midnight for that day,
224     // and so the next 86400 seconds worth of logs are printed.
226     /// Setup for group handling.
228     /// If the group mode is separate, and this user does not have editing privileges,
229     /// then only the user's group can be viewed.
230     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
231         if (isset($SESSION->currentgroup[$course->id])) {
232             $groupid =  $SESSION->currentgroup[$course->id];
233         } else {
234             $groupid = groups_get_all_groups($course->id, $USER->id);
235             if (is_array($groupid)) {
236                 $groupid = array_shift(array_keys($groupid));
237                 $SESSION->currentgroup[$course->id] = $groupid;
238             } else {
239                 $groupid = 0;
240             }
241         }
242     }
243     /// If this course doesn't have groups, no groupid can be specified.
244     else if (!$course->groupmode) {
245         $groupid = 0;
246     }
248     $joins = array();
249     $params = array();
251     if ($course->id != SITEID || $modid != 0) {
252         $joins[] = "l.course = :courseid";
253         $params['courseid'] = $course->id;
254     }
256     if ($modname) {
257         $joins[] = "l.module = :modname";
258         $params['modname'] = $modname;
259     }
261     if ('site_errors' === $modid) {
262         $joins[] = "( l.action='error' OR l.action='infected' )";
263     } else if ($modid) {
264         $joins[] = "l.cmid = :modid";
265         $params['modid'] = $modid;
266     }
268     if ($modaction) {
269         $firstletter = substr($modaction, 0, 1);
270         if ($firstletter == '-') {
271             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
272             $params['modaction'] = '%'.substr($modaction, 1).'%';
273         } else {
274             $joins[] = $DB->sql_like('l.action', ':modaction', false);
275             $params['modaction'] = '%'.$modaction.'%';
276         }
277     }
280     /// Getting all members of a group.
281     if ($groupid and !$user) {
282         if ($gusers = groups_get_members($groupid)) {
283             $gusers = array_keys($gusers);
284             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
285         } else {
286             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
287         }
288     }
289     else if ($user) {
290         $joins[] = "l.userid = :userid";
291         $params['userid'] = $user;
292     }
294     if ($date) {
295         $enddate = $date + 86400;
296         $joins[] = "l.time > :date AND l.time < :enddate";
297         $params['date'] = $date;
298         $params['enddate'] = $enddate;
299     }
301     $selector = implode(' AND ', $joins);
303     $totalcount = 0;  // Initialise
304     $result = array();
305     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
306     $result['totalcount'] = $totalcount;
307     return $result;
311 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
312                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
314     global $CFG, $DB, $OUTPUT;
316     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
317                        $modname, $modid, $modaction, $groupid)) {
318         echo $OUTPUT->notification("No logs found!");
319         echo $OUTPUT->footer();
320         exit;
321     }
323     $courses = array();
325     if ($course->id == SITEID) {
326         $courses[0] = '';
327         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
328             foreach ($ccc as $cc) {
329                 $courses[$cc->id] = $cc->shortname;
330             }
331         }
332     } else {
333         $courses[$course->id] = $course->shortname;
334     }
336     $totalcount = $logs['totalcount'];
337     $count=0;
338     $ldcache = array();
339     $tt = getdate(time());
340     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
342     $strftimedatetime = get_string("strftimedatetime");
344     echo "<div class=\"info\">\n";
345     print_string("displayingrecords", "", $totalcount);
346     echo "</div>\n";
348     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
350     $table = new html_table();
351     $table->classes = array('logtable','generalbox');
352     $table->align = array('right', 'left', 'left');
353     $table->head = array(
354         get_string('time'),
355         get_string('ip_address'),
356         get_string('fullnameuser'),
357         get_string('action'),
358         get_string('info')
359     );
360     $table->data = array();
362     if ($course->id == SITEID) {
363         array_unshift($table->align, 'left');
364         array_unshift($table->head, get_string('course'));
365     }
367     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
368     if (empty($logs['logs'])) {
369         $logs['logs'] = array();
370     }
372     foreach ($logs['logs'] as $log) {
374         if (isset($ldcache[$log->module][$log->action])) {
375             $ld = $ldcache[$log->module][$log->action];
376         } else {
377             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
378             $ldcache[$log->module][$log->action] = $ld;
379         }
380         if ($ld && is_numeric($log->info)) {
381             // ugly hack to make sure fullname is shown correctly
382             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
383                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
384             } else {
385                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
386             }
387         }
389         //Filter log->info
390         $log->info = format_string($log->info);
392         // If $log->url has been trimmed short by the db size restriction
393         // code in add_to_log, keep a note so we don't add a link to a broken url
394         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
396         $row = array();
397         if ($course->id == SITEID) {
398             if (empty($log->course)) {
399                 $row[] = get_string('site');
400             } else {
401                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
402             }
403         }
405         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
407         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
408         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
410         $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))));
412         $displayaction="$log->module $log->action";
413         if ($brokenurl) {
414             $row[] = $displayaction;
415         } else {
416             $link = make_log_url($log->module,$log->url);
417             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
418         }
419         $row[] = $log->info;
420         $table->data[] = $row;
421     }
423     echo html_writer::table($table);
424     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
428 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
429                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
431     global $CFG, $DB, $OUTPUT;
433     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
434                        $modname, $modid, $modaction, $groupid)) {
435         echo $OUTPUT->notification("No logs found!");
436         echo $OUTPUT->footer();
437         exit;
438     }
440     if ($course->id == SITEID) {
441         $courses[0] = '';
442         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
443             foreach ($ccc as $cc) {
444                 $courses[$cc->id] = $cc->shortname;
445             }
446         }
447     }
449     $totalcount = $logs['totalcount'];
450     $count=0;
451     $ldcache = array();
452     $tt = getdate(time());
453     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
455     $strftimedatetime = get_string("strftimedatetime");
457     echo "<div class=\"info\">\n";
458     print_string("displayingrecords", "", $totalcount);
459     echo "</div>\n";
461     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
463     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
464     echo "<tr>";
465     if ($course->id == SITEID) {
466         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
467     }
468     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
469     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
470     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
471     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
472     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
473     echo "</tr>\n";
475     if (empty($logs['logs'])) {
476         echo "</table>\n";
477         return;
478     }
480     $row = 1;
481     foreach ($logs['logs'] as $log) {
483         $log->info = $log->coursename;
484         $row = ($row + 1) % 2;
486         if (isset($ldcache[$log->module][$log->action])) {
487             $ld = $ldcache[$log->module][$log->action];
488         } else {
489             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
490             $ldcache[$log->module][$log->action] = $ld;
491         }
492         if (0 && $ld && !empty($log->info)) {
493             // ugly hack to make sure fullname is shown correctly
494             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
495                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
496             } else {
497                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
498             }
499         }
501         //Filter log->info
502         $log->info = format_string($log->info);
504         echo '<tr class="r'.$row.'">';
505         if ($course->id == SITEID) {
506             $courseshortname = format_string($courses[$log->course], true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
507             echo "<td class=\"r$row c0\" >\n";
508             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
509             echo "</td>\n";
510         }
511         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
512              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
513         echo "<td class=\"r$row c2\" >\n";
514         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
515         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
516         echo "</td>\n";
517         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
518         echo "<td class=\"r$row c3\" >\n";
519         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
520         echo "</td>\n";
521         echo "<td class=\"r$row c4\">\n";
522         echo $log->action .': '.$log->module;
523         echo "</td>\n";;
524         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
525         echo "</tr>\n";
526     }
527     echo "</table>\n";
529     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
533 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
534                         $modid, $modaction, $groupid) {
535     global $DB, $CFG;
537     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
538             get_string('fullnameuser')."\t".get_string('action')."\t".get_string('info');
540     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
541                        $modname, $modid, $modaction, $groupid)) {
542         return false;
543     }
545     $courses = array();
547     if ($course->id == SITEID) {
548         $courses[0] = '';
549         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
550             foreach ($ccc as $cc) {
551                 $courses[$cc->id] = $cc->shortname;
552             }
553         }
554     } else {
555         $courses[$course->id] = $course->shortname;
556     }
558     $count=0;
559     $ldcache = array();
560     $tt = getdate(time());
561     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
563     $strftimedatetime = get_string("strftimedatetime");
565     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
566     $filename .= '.txt';
567     header("Content-Type: application/download\n");
568     header("Content-Disposition: attachment; filename=\"$filename\"");
569     header("Expires: 0");
570     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
571     header("Pragma: public");
573     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
574     echo $text."\n";
576     if (empty($logs['logs'])) {
577         return true;
578     }
580     foreach ($logs['logs'] as $log) {
581         if (isset($ldcache[$log->module][$log->action])) {
582             $ld = $ldcache[$log->module][$log->action];
583         } else {
584             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
585             $ldcache[$log->module][$log->action] = $ld;
586         }
587         if ($ld && is_numeric($log->info)) {
588             // ugly hack to make sure fullname is shown correctly
589             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
590                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
591             } else {
592                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
593             }
594         }
596         //Filter log->info
597         $log->info = format_string($log->info);
598         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
600         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
601         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
602         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
603         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
604         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
605         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
606         $text = implode("\t", $row);
607         echo $text." \n";
608     }
609     return true;
613 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
614                         $modid, $modaction, $groupid) {
616     global $CFG, $DB;
618     require_once("$CFG->libdir/excellib.class.php");
620     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
621                        $modname, $modid, $modaction, $groupid)) {
622         return false;
623     }
625     $courses = array();
627     if ($course->id == SITEID) {
628         $courses[0] = '';
629         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
630             foreach ($ccc as $cc) {
631                 $courses[$cc->id] = $cc->shortname;
632             }
633         }
634     } else {
635         $courses[$course->id] = $course->shortname;
636     }
638     $count=0;
639     $ldcache = array();
640     $tt = getdate(time());
641     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
643     $strftimedatetime = get_string("strftimedatetime");
645     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
646     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
647     $filename .= '.xls';
649     $workbook = new MoodleExcelWorkbook('-');
650     $workbook->send($filename);
652     $worksheet = array();
653     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
654                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
656     // Creating worksheets
657     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
658         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
659         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
660         $worksheet[$wsnumber]->set_column(1, 1, 30);
661         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
662                                     userdate(time(), $strftimedatetime));
663         $col = 0;
664         foreach ($headers as $item) {
665             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
666             $col++;
667         }
668     }
670     if (empty($logs['logs'])) {
671         $workbook->close();
672         return true;
673     }
675     $formatDate =& $workbook->add_format();
676     $formatDate->set_num_format(get_string('log_excel_date_format'));
678     $row = FIRSTUSEDEXCELROW;
679     $wsnumber = 1;
680     $myxls =& $worksheet[$wsnumber];
681     foreach ($logs['logs'] as $log) {
682         if (isset($ldcache[$log->module][$log->action])) {
683             $ld = $ldcache[$log->module][$log->action];
684         } else {
685             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
686             $ldcache[$log->module][$log->action] = $ld;
687         }
688         if ($ld && is_numeric($log->info)) {
689             // ugly hack to make sure fullname is shown correctly
690             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
691                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
692             } else {
693                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
694             }
695         }
697         // Filter log->info
698         $log->info = format_string($log->info);
699         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
701         if ($nroPages>1) {
702             if ($row > EXCELROWS) {
703                 $wsnumber++;
704                 $myxls =& $worksheet[$wsnumber];
705                 $row = FIRSTUSEDEXCELROW;
706             }
707         }
709         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
711         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
712         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
713         $myxls->write($row, 2, $log->ip, '');
714         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
715         $myxls->write($row, 3, $fullname, '');
716         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
717         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
718         $myxls->write($row, 5, $log->info, '');
720         $row++;
721     }
723     $workbook->close();
724     return true;
727 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
728                         $modid, $modaction, $groupid) {
730     global $CFG, $DB;
732     require_once("$CFG->libdir/odslib.class.php");
734     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
735                        $modname, $modid, $modaction, $groupid)) {
736         return false;
737     }
739     $courses = array();
741     if ($course->id == SITEID) {
742         $courses[0] = '';
743         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
744             foreach ($ccc as $cc) {
745                 $courses[$cc->id] = $cc->shortname;
746             }
747         }
748     } else {
749         $courses[$course->id] = $course->shortname;
750     }
752     $count=0;
753     $ldcache = array();
754     $tt = getdate(time());
755     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
757     $strftimedatetime = get_string("strftimedatetime");
759     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
760     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
761     $filename .= '.ods';
763     $workbook = new MoodleODSWorkbook('-');
764     $workbook->send($filename);
766     $worksheet = array();
767     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
768                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
770     // Creating worksheets
771     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
772         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
773         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
774         $worksheet[$wsnumber]->set_column(1, 1, 30);
775         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
776                                     userdate(time(), $strftimedatetime));
777         $col = 0;
778         foreach ($headers as $item) {
779             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
780             $col++;
781         }
782     }
784     if (empty($logs['logs'])) {
785         $workbook->close();
786         return true;
787     }
789     $formatDate =& $workbook->add_format();
790     $formatDate->set_num_format(get_string('log_excel_date_format'));
792     $row = FIRSTUSEDEXCELROW;
793     $wsnumber = 1;
794     $myxls =& $worksheet[$wsnumber];
795     foreach ($logs['logs'] as $log) {
796         if (isset($ldcache[$log->module][$log->action])) {
797             $ld = $ldcache[$log->module][$log->action];
798         } else {
799             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
800             $ldcache[$log->module][$log->action] = $ld;
801         }
802         if ($ld && is_numeric($log->info)) {
803             // ugly hack to make sure fullname is shown correctly
804             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
805                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
806             } else {
807                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
808             }
809         }
811         // Filter log->info
812         $log->info = format_string($log->info);
813         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
815         if ($nroPages>1) {
816             if ($row > EXCELROWS) {
817                 $wsnumber++;
818                 $myxls =& $worksheet[$wsnumber];
819                 $row = FIRSTUSEDEXCELROW;
820             }
821         }
823         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
825         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
826         $myxls->write_date($row, 1, $log->time);
827         $myxls->write_string($row, 2, $log->ip);
828         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
829         $myxls->write_string($row, 3, $fullname);
830         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
831         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
832         $myxls->write_string($row, 5, $log->info);
834         $row++;
835     }
837     $workbook->close();
838     return true;
842 function print_overview($courses, array $remote_courses=array()) {
843     global $CFG, $USER, $DB, $OUTPUT;
845     $htmlarray = array();
846     if ($modules = $DB->get_records('modules')) {
847         foreach ($modules as $mod) {
848             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
849                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
850                 $fname = $mod->name.'_print_overview';
851                 if (function_exists($fname)) {
852                     $fname($courses,$htmlarray);
853                 }
854             }
855         }
856     }
857     foreach ($courses as $course) {
858         $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
859         echo $OUTPUT->box_start('coursebox');
860         $attributes = array('title' => s($fullname));
861         if (empty($course->visible)) {
862             $attributes['class'] = 'dimmed';
863         }
864         echo $OUTPUT->heading(html_writer::link(
865             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
866         if (array_key_exists($course->id,$htmlarray)) {
867             foreach ($htmlarray[$course->id] as $modname => $html) {
868                 echo $html;
869             }
870         }
871         echo $OUTPUT->box_end();
872     }
874     if (!empty($remote_courses)) {
875         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
876     }
877     foreach ($remote_courses as $course) {
878         echo $OUTPUT->box_start('coursebox');
879         $attributes = array('title' => s($course->fullname));
880         echo $OUTPUT->heading(html_writer::link(
881             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
882             format_string($course->shortname),
883             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
884         echo $OUTPUT->box_end();
885     }
889 /**
890  * This function trawls through the logs looking for
891  * anything new since the user's last login
892  */
893 function print_recent_activity($course) {
894     // $course is an object
895     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
897     $context = get_context_instance(CONTEXT_COURSE, $course->id);
899     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
901     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
903     if (!isguestuser()) {
904         if (!empty($USER->lastcourseaccess[$course->id])) {
905             if ($USER->lastcourseaccess[$course->id] > $timestart) {
906                 $timestart = $USER->lastcourseaccess[$course->id];
907             }
908         }
909     }
911     echo '<div class="activitydate">';
912     echo get_string('activitysince', '', userdate($timestart));
913     echo '</div>';
914     echo '<div class="activityhead">';
916     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
918     echo "</div>\n";
920     $content = false;
922 /// Firstly, have there been any new enrolments?
924     $users = get_recent_enrolments($course->id, $timestart);
926     //Accessibility: new users now appear in an <OL> list.
927     if ($users) {
928         echo '<div class="newusers">';
929         echo $OUTPUT->heading(get_string("newusers").':', 3);
930         $content = true;
931         echo "<ol class=\"list\">\n";
932         foreach ($users as $user) {
933             $fullname = fullname($user, $viewfullnames);
934             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
935         }
936         echo "</ol>\n</div>\n";
937     }
939 /// Next, have there been any modifications to the course structure?
941     $modinfo = get_fast_modinfo($course);
943     $changelist = array();
945     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
946                                             module = 'course' AND
947                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
948                                     array($timestart, $course->id), "id ASC");
950     if ($logs) {
951         $actions  = array('add mod', 'update mod', 'delete mod');
952         $newgones = array(); // added and later deleted items
953         foreach ($logs as $key => $log) {
954             if (!in_array($log->action, $actions)) {
955                 continue;
956             }
957             $info = explode(' ', $log->info);
959             // note: in most cases I replaced hardcoding of label with use of
960             // $cm->has_view() but it was not possible to do this here because
961             // we don't necessarily have the $cm for it
962             if ($info[0] == 'label') {     // Labels are ignored in recent activity
963                 continue;
964             }
966             if (count($info) != 2) {
967                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
968                 continue;
969             }
971             $modname    = $info[0];
972             $instanceid = $info[1];
974             if ($log->action == 'delete mod') {
975                 // unfortunately we do not know if the mod was visible
976                 if (!array_key_exists($log->info, $newgones)) {
977                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
978                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
979                 }
980             } else {
981                 if (!isset($modinfo->instances[$modname][$instanceid])) {
982                     if ($log->action == 'add mod') {
983                         // do not display added and later deleted activities
984                         $newgones[$log->info] = true;
985                     }
986                     continue;
987                 }
988                 $cm = $modinfo->instances[$modname][$instanceid];
989                 if (!$cm->uservisible) {
990                     continue;
991                 }
993                 if ($log->action == 'add mod') {
994                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
995                     $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
997                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
998                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
999                     $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
1000                 }
1001             }
1002         }
1003     }
1005     if (!empty($changelist)) {
1006         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1007         $content = true;
1008         foreach ($changelist as $changeinfo => $change) {
1009             echo '<p class="activity">'.$change['text'].'</p>';
1010         }
1011     }
1013 /// Now display new things from each module
1015     $usedmodules = array();
1016     foreach($modinfo->cms as $cm) {
1017         if (isset($usedmodules[$cm->modname])) {
1018             continue;
1019         }
1020         if (!$cm->uservisible) {
1021             continue;
1022         }
1023         $usedmodules[$cm->modname] = $cm->modname;
1024     }
1026     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1027         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1028             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1029             $print_recent_activity = $modname.'_print_recent_activity';
1030             if (function_exists($print_recent_activity)) {
1031                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1032                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1033             }
1034         } else {
1035             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1036         }
1037     }
1039     if (! $content) {
1040         echo '<p class="message">'.get_string('nothingnew').'</p>';
1041     }
1044 /**
1045  * For a given course, returns an array of course activity objects
1046  * Each item in the array contains he following properties:
1047  */
1048 function get_array_of_activities($courseid) {
1049 //  cm - course module id
1050 //  mod - name of the module (eg forum)
1051 //  section - the number of the section (eg week or topic)
1052 //  name - the name of the instance
1053 //  visible - is the instance visible or not
1054 //  groupingid - grouping id
1055 //  groupmembersonly - is this instance visible to group members only
1056 //  extra - contains extra string to include in any link
1057     global $CFG, $DB;
1058     if(!empty($CFG->enableavailability)) {
1059         require_once($CFG->libdir.'/conditionlib.php');
1060     }
1062     $course = $DB->get_record('course', array('id'=>$courseid));
1064     if (empty($course)) {
1065         throw new moodle_exception('courseidnotfound');
1066     }
1068     $mod = array();
1070     $rawmods = get_course_mods($courseid);
1071     if (empty($rawmods)) {
1072         return $mod; // always return array
1073     }
1075     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1076        foreach ($sections as $section) {
1077            if (!empty($section->sequence)) {
1078                $sequence = explode(",", $section->sequence);
1079                foreach ($sequence as $seq) {
1080                    if (empty($rawmods[$seq])) {
1081                        continue;
1082                    }
1083                    $mod[$seq] = new stdClass();
1084                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1085                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1086                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1088                     // Oh dear. Inconsistent names left here for backward compatibility.
1089                    $mod[$seq]->section          = $section->section;
1090                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1092                    $mod[$seq]->module           = $rawmods[$seq]->module;
1093                    $mod[$seq]->added            = $rawmods[$seq]->added;
1094                    $mod[$seq]->score            = $rawmods[$seq]->score;
1095                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1096                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1097                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1098                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1099                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1100                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1101                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1102                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1103                    $mod[$seq]->extra            = "";
1104                    $mod[$seq]->completiongradeitemnumber =
1105                            $rawmods[$seq]->completiongradeitemnumber;
1106                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1107                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1108                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1109                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1110                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1111                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1112                    if (!empty($CFG->enableavailability)) {
1113                        condition_info::fill_availability_conditions($rawmods[$seq]);
1114                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1115                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1116                    }
1118                    $modname = $mod[$seq]->mod;
1119                    $functionname = $modname."_get_coursemodule_info";
1121                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1122                        continue;
1123                    }
1125                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1127                    if ($hasfunction = function_exists($functionname)) {
1128                        if ($info = $functionname($rawmods[$seq])) {
1129                            if (!empty($info->icon)) {
1130                                $mod[$seq]->icon = $info->icon;
1131                            }
1132                            if (!empty($info->iconcomponent)) {
1133                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1134                            }
1135                            if (!empty($info->name)) {
1136                                $mod[$seq]->name = $info->name;
1137                            }
1138                            if ($info instanceof cached_cm_info) {
1139                                // When using cached_cm_info you can include three new fields
1140                                // that aren't available for legacy code
1141                                if (!empty($info->content)) {
1142                                    $mod[$seq]->content = $info->content;
1143                                }
1144                                if (!empty($info->extraclasses)) {
1145                                    $mod[$seq]->extraclasses = $info->extraclasses;
1146                                }
1147                                if (!empty($info->iconurl)) {
1148                                    $mod[$seq]->iconurl = $info->iconurl;
1149                                }
1150                                if (!empty($info->onclick)) {
1151                                    $mod[$seq]->onclick = $info->onclick;
1152                                }
1153                                if (!empty($info->customdata)) {
1154                                    $mod[$seq]->customdata = $info->customdata;
1155                                }
1156                            } else {
1157                                // When using a stdclass, the (horrible) deprecated ->extra field
1158                                // is available for BC
1159                                if (!empty($info->extra)) {
1160                                    $mod[$seq]->extra = $info->extra;
1161                                }
1162                            }
1163                        }
1164                    }
1165                    // When there is no modname_get_coursemodule_info function,
1166                    // but showdescriptions is enabled, then we use the 'intro'
1167                    // and 'introformat' fields in the module table
1168                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1169                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1170                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1171                            // Set content from intro and introformat. Filters are disabled
1172                            // because we  filter it with format_text at display time
1173                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1174                                    $modvalues, $rawmods[$seq]->id, false);
1176                            // To save making another query just below, put name in here
1177                            $mod[$seq]->name = $modvalues->name;
1178                        }
1179                    }
1180                    if (!isset($mod[$seq]->name)) {
1181                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1182                    }
1184                    // Minimise the database size by unsetting default options when they are
1185                    // 'empty'. This list corresponds to code in the cm_info constructor.
1186                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1187                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1188                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1189                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1190                            'completionview', 'completionexpected', 'score', 'showdescription')
1191                            as $property) {
1192                        if (property_exists($mod[$seq], $property) &&
1193                                empty($mod[$seq]->{$property})) {
1194                            unset($mod[$seq]->{$property});
1195                        }
1196                    }
1197                    // Special case: this value is usually set to null, but may be 0
1198                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1199                            is_null($mod[$seq]->completiongradeitemnumber)) {
1200                        unset($mod[$seq]->completiongradeitemnumber);
1201                    }
1202                }
1203             }
1204         }
1205     }
1206     return $mod;
1210 /**
1211  * Returns a number of useful structures for course displays
1212  */
1213 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1214     global $CFG, $DB, $COURSE;
1216     $mods          = array();    // course modules indexed by id
1217     $modnames      = array();    // all course module names (except resource!)
1218     $modnamesplural= array();    // all course module names (plural form)
1219     $modnamesused  = array();    // course module names used
1221     if ($allmods = $DB->get_records("modules")) {
1222         foreach ($allmods as $mod) {
1223             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1224                 continue;
1225             }
1226             if ($mod->visible) {
1227                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1228                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1229             }
1230         }
1231         collatorlib::asort($modnames);
1232     } else {
1233         print_error("nomodules", 'debug');
1234     }
1236     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1237     $modinfo = get_fast_modinfo($course);
1239     if ($rawmods=$modinfo->cms) {
1240         foreach($rawmods as $mod) {    // Index the mods
1241             if (empty($modnames[$mod->modname])) {
1242                 continue;
1243             }
1244             $mods[$mod->id] = $mod;
1245             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1246             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1247                 continue;
1248             }
1249             // Check groupings
1250             if (!groups_course_module_visible($mod)) {
1251                 continue;
1252             }
1253             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1254         }
1255         if ($modnamesused) {
1256             collatorlib::asort($modnamesused);
1257         }
1258     }
1261 /**
1262  * Returns an array of sections for the requested course id
1263  *
1264  * This function stores the sections against the course id within a staticvar encase
1265  * of subsequent requests. This is used all over + in some standard libs and course
1266  * format callbacks so subsequent requests are a reality.
1267  *
1268  * Note: Since Moodle 2.3, it is more efficient to get this data by calling
1269  * get_fast_modinfo, then using $modinfo->get_section_info or get_section_info_all.
1270  *
1271  * @staticvar array $coursesections
1272  * @param int $courseid
1273  * @return array Array of sections
1274  */
1275 function get_all_sections($courseid) {
1276     global $DB;
1277     static $coursesections = array();
1278     if (!array_key_exists($courseid, $coursesections)) {
1279         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1280                 'section, id, course, name, summary, summaryformat, sequence, visible, ' .
1281                 'availablefrom, availableuntil, showavailability, groupingid');
1282     }
1283     return $coursesections[$courseid];
1286 /**
1287  * Set highlighted section. Only one section can be highlighted at the time.
1288  *
1289  * @param int $courseid course id
1290  * @param int $marker highlight section with this number, 0 means remove higlightin
1291  * @return void
1292  */
1293 function course_set_marker($courseid, $marker) {
1294     global $DB;
1295     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1298 /**
1299  * For a given course section, marks it visible or hidden,
1300  * and does the same for every activity in that section
1301  *
1302  * @param int $courseid course id
1303  * @param int $sectionnumber The section number to adjust
1304  * @param int $visibility The new visibility
1305  * @return array A list of resources which were hidden in the section
1306  */
1307 function set_section_visible($courseid, $sectionnumber, $visibility) {
1308     global $DB;
1310     $resourcestotoggle = array();
1311     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1312         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1313         if (!empty($section->sequence)) {
1314             $modules = explode(",", $section->sequence);
1315             foreach ($modules as $moduleid) {
1316                 set_coursemodule_visible($moduleid, $visibility, true);
1317             }
1318         }
1319         rebuild_course_cache($courseid);
1321         // Determine which modules are visible for AJAX update
1322         if (!empty($modules)) {
1323             list($insql, $params) = $DB->get_in_or_equal($modules);
1324             $select = 'id ' . $insql . ' AND visible = ?';
1325             array_push($params, $visibility);
1326             if (!$visibility) {
1327                 $select .= ' AND visibleold = 1';
1328             }
1329             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1330         }
1331     }
1332     return $resourcestotoggle;
1335 /**
1336  * Obtains shared data that is used in print_section when displaying a
1337  * course-module entry.
1338  *
1339  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1340  *
1341  * This data is also used in other areas of the code.
1342  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1343  * @param object $course Moodle course object
1344  * @return array An array with the following values in this order:
1345  *   $content (optional extra content for after link),
1346  *   $instancename (text of link)
1347  */
1348 function get_print_section_cm_text(cm_info $cm, $course) {
1349     global $OUTPUT;
1351     // Get content from modinfo if specified. Content displays either
1352     // in addition to the standard link (below), or replaces it if
1353     // the link is turned off by setting ->url to null.
1354     if (($content = $cm->get_content()) !== '') {
1355         // Improve filter performance by preloading filter setttings for all
1356         // activities on the course (this does nothing if called multiple
1357         // times)
1358         filter_preload_activities($cm->get_modinfo());
1360         // Get module context
1361         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1362         $labelformatoptions = new stdClass();
1363         $labelformatoptions->noclean = true;
1364         $labelformatoptions->overflowdiv = true;
1365         $labelformatoptions->context = $modulecontext;
1366         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1367     } else {
1368         $content = '';
1369     }
1371     // Get course context
1372     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1373     $stringoptions = new stdClass;
1374     $stringoptions->context = $coursecontext;
1375     $instancename = format_string($cm->name, true,  $stringoptions);
1376     return array($content, $instancename);
1379 /**
1380  * Prints a section full of activity modules
1381  *
1382  * @param stdClass $course The course
1383  * @param stdClass $section The section
1384  * @param array $mods The modules in the section
1385  * @param array $modnamesused An array containing the list of modules and their names
1386  * @param bool $absolute All links are absolute
1387  * @param string $width Width of the container
1388  * @param bool $hidecompletion Hide completion status
1389  * @param int $sectionreturn The section to return to
1390  * @return void
1391  */
1392 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1393     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1395     static $initialised;
1397     static $groupbuttons;
1398     static $groupbuttonslink;
1399     static $isediting;
1400     static $ismoving;
1401     static $strmovehere;
1402     static $strmovefull;
1403     static $strunreadpostsone;
1404     static $modulenames;
1406     if (!isset($initialised)) {
1407         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1408         $groupbuttonslink = (!$course->groupmodeforce);
1409         $isediting        = $PAGE->user_is_editing();
1410         $ismoving         = $isediting && ismoving($course->id);
1411         if ($ismoving) {
1412             $strmovehere  = get_string("movehere");
1413             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1414         }
1415         $modulenames      = array();
1416         $initialised = true;
1417     }
1419     $modinfo = get_fast_modinfo($course);
1420     $completioninfo = new completion_info($course);
1422     //Accessibility: replace table with list <ul>, but don't output empty list.
1423     if (!empty($section->sequence)) {
1425         // Fix bug #5027, don't want style=\"width:$width\".
1426         echo "<ul class=\"section img-text\">\n";
1427         $sectionmods = explode(",", $section->sequence);
1429         foreach ($sectionmods as $modnumber) {
1430             if (empty($mods[$modnumber])) {
1431                 continue;
1432             }
1434             /**
1435              * @var cm_info
1436              */
1437             $mod = $mods[$modnumber];
1439             if ($ismoving and $mod->id == $USER->activitycopy) {
1440                 // do not display moving mod
1441                 continue;
1442             }
1444             if (isset($modinfo->cms[$modnumber])) {
1445                 // We can continue (because it will not be displayed at all)
1446                 // if:
1447                 // 1) The activity is not visible to users
1448                 // and
1449                 // 2a) The 'showavailability' option is not set (if that is set,
1450                 //     we need to display the activity so we can show
1451                 //     availability info)
1452                 // or
1453                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1454                 //     hidden in a way that leaves no info, such as using the
1455                 //     eye icon.
1456                 if (!$modinfo->cms[$modnumber]->uservisible &&
1457                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1458                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1459                     // visibility shortcut
1460                     continue;
1461                 }
1462             } else {
1463                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1464                     // module not installed
1465                     continue;
1466                 }
1467                 if (!coursemodule_visible_for_user($mod) &&
1468                     empty($mod->showavailability)) {
1469                     // full visibility check
1470                     continue;
1471                 }
1472             }
1474             if (!isset($modulenames[$mod->modname])) {
1475                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1476             }
1477             $modulename = $modulenames[$mod->modname];
1479             // In some cases the activity is visible to user, but it is
1480             // dimmed. This is done if viewhiddenactivities is true and if:
1481             // 1. the activity is not visible, or
1482             // 2. the activity has dates set which do not include current, or
1483             // 3. the activity has any other conditions set (regardless of whether
1484             //    current user meets them)
1485             $modcontext = context_module::instance($mod->id);
1486             $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
1487             $accessiblebutdim = false;
1488             $conditionalhidden = false;
1489             if ($canviewhidden) {
1490                 $accessiblebutdim = !$mod->visible;
1491                 if (!empty($CFG->enableavailability)) {
1492                     $conditionalhidden = $mod->availablefrom > time() ||
1493                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1494                         count($mod->conditionsgrade) > 0 ||
1495                         count($mod->conditionscompletion) > 0;
1496                 }
1497                 $accessiblebutdim = $conditionalhidden || $accessiblebutdim;
1498             }
1500             $liclasses = array();
1501             $liclasses[] = 'activity';
1502             $liclasses[] = $mod->modname;
1503             $liclasses[] = 'modtype_'.$mod->modname;
1504             $extraclasses = $mod->get_extra_classes();
1505             if ($extraclasses) {
1506                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1507             }
1508             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1509             if ($ismoving) {
1510                 echo '<a title="'.$strmovefull.'"'.
1511                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1512                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1513                      ' alt="'.$strmovehere.'" /></a><br />
1514                      ';
1515             }
1517             $classes = array('mod-indent');
1518             if (!empty($mod->indent)) {
1519                 $classes[] = 'mod-indent-'.$mod->indent;
1520                 if ($mod->indent > 15) {
1521                     $classes[] = 'mod-indent-huge';
1522                 }
1523             }
1524             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1526             // Get data about this course-module
1527             list($content, $instancename) =
1528                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1530             //Accessibility: for files get description via icon, this is very ugly hack!
1531             $altname = '';
1532             $altname = $mod->modfullname;
1533             // Avoid unnecessary duplication: if e.g. a forum name already
1534             // includes the word forum (or Forum, etc) then it is unhelpful
1535             // to include that in the accessible description that is added.
1536             if (false !== strpos(textlib::strtolower($instancename),
1537                     textlib::strtolower($altname))) {
1538                 $altname = '';
1539             }
1540             // File type after name, for alphabetic lists (screen reader).
1541             if ($altname) {
1542                 $altname = get_accesshide(' '.$altname);
1543             }
1545             // We may be displaying this just in order to show information
1546             // about visibility, without the actual link
1547             $contentpart = '';
1548             if ($mod->uservisible) {
1549                 // Nope - in this case the link is fully working for user
1550                 $linkclasses = '';
1551                 $textclasses = '';
1552                 if ($accessiblebutdim) {
1553                     $linkclasses .= ' dimmed';
1554                     $textclasses .= ' dimmed_text';
1555                     if ($conditionalhidden) {
1556                         $linkclasses .= ' conditionalhidden';
1557                         $textclasses .= ' conditionalhidden';
1558                     }
1559                     $accesstext = '<span class="accesshide">'.
1560                         get_string('hiddenfromstudents').': </span>';
1561                 } else {
1562                     $accesstext = '';
1563                 }
1564                 if ($linkclasses) {
1565                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1566                 } else {
1567                     $linkcss = '';
1568                 }
1569                 if ($textclasses) {
1570                     $textcss = 'class="' . trim($textclasses) . '" ';
1571                 } else {
1572                     $textcss = '';
1573                 }
1575                 // Get on-click attribute value if specified
1576                 $onclick = $mod->get_on_click();
1577                 if ($onclick) {
1578                     $onclick = ' onclick="' . $onclick . '"';
1579                 }
1581                 if ($url = $mod->get_url()) {
1582                     // Display link itself
1583                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1584                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1585                             '" class="activityicon" alt="' . $modulename . '" /> ' .
1586                             $accesstext . '<span class="instancename">' .
1587                             $instancename . $altname . '</span></a>';
1589                     // If specified, display extra content after link
1590                     if ($content) {
1591                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1592                                 '">' . $content . '</div>';
1593                     }
1594                 } else {
1595                     // No link, so display only content
1596                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1597                             $accesstext . $content . '</div>';
1598                 }
1600                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1601                     $groupings = groups_get_all_groupings($course->id);
1602                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1603                 }
1604             } else {
1605                 $textclasses = $extraclasses;
1606                 $textclasses .= ' dimmed_text';
1607                 if ($textclasses) {
1608                     $textcss = 'class="' . trim($textclasses) . '" ';
1609                 } else {
1610                     $textcss = '';
1611                 }
1612                 $accesstext = '<span class="accesshide">' .
1613                         get_string('notavailableyet', 'condition') .
1614                         ': </span>';
1616                 if ($url = $mod->get_url()) {
1617                     // Display greyed-out text of link
1618                     echo '<div ' . $textcss . $mod->extra .
1619                             ' >' . '<img src="' . $mod->get_icon_url() .
1620                             '" class="activityicon" alt="" /> <span>'. $instancename . $altname .
1621                             '</span></div>';
1623                     // Do not display content after link when it is greyed out like this.
1624                 } else {
1625                     // No link, so display only content (also greyed)
1626                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1627                             $accesstext . $content . '</div>';
1628                 }
1629             }
1631             // Module can put text after the link (e.g. forum unread)
1632             echo $mod->get_after_link();
1634             // If there is content but NO link (eg label), then display the
1635             // content here (BEFORE any icons). In this case cons must be
1636             // displayed after the content so that it makes more sense visually
1637             // and for accessibility reasons, e.g. if you have a one-line label
1638             // it should work similarly (at least in terms of ordering) to an
1639             // activity.
1640             if (empty($url)) {
1641                 echo $contentpart;
1642             }
1644             if ($isediting) {
1645                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1646                     if (! $mod->groupmodelink = $groupbuttonslink) {
1647                         $mod->groupmode = $course->groupmode;
1648                     }
1650                 } else {
1651                     $mod->groupmode = false;
1652                 }
1653                 echo '&nbsp;&nbsp;';
1654                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $sectionreturn);
1655                 echo $mod->get_after_edit_icons();
1656             }
1658             // Completion
1659             $completion = $hidecompletion
1660                 ? COMPLETION_TRACKING_NONE
1661                 : $completioninfo->is_enabled($mod);
1662             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1663                 !isguestuser() && $mod->uservisible) {
1664                 $completiondata = $completioninfo->get_data($mod,true);
1665                 $completionicon = '';
1666                 if ($isediting) {
1667                     switch ($completion) {
1668                         case COMPLETION_TRACKING_MANUAL :
1669                             $completionicon = 'manual-enabled'; break;
1670                         case COMPLETION_TRACKING_AUTOMATIC :
1671                             $completionicon = 'auto-enabled'; break;
1672                         default: // wtf
1673                     }
1674                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1675                     switch($completiondata->completionstate) {
1676                         case COMPLETION_INCOMPLETE:
1677                             $completionicon = 'manual-n'; break;
1678                         case COMPLETION_COMPLETE:
1679                             $completionicon = 'manual-y'; break;
1680                     }
1681                 } else { // Automatic
1682                     switch($completiondata->completionstate) {
1683                         case COMPLETION_INCOMPLETE:
1684                             $completionicon = 'auto-n'; break;
1685                         case COMPLETION_COMPLETE:
1686                             $completionicon = 'auto-y'; break;
1687                         case COMPLETION_COMPLETE_PASS:
1688                             $completionicon = 'auto-pass'; break;
1689                         case COMPLETION_COMPLETE_FAIL:
1690                             $completionicon = 'auto-fail'; break;
1691                     }
1692                 }
1693                 if ($completionicon) {
1694                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1695                     $formattedname = format_string($mod->name, true, array('context' => $modcontext));
1696                     $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
1697                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1698                         $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
1699                         $newstate =
1700                             $completiondata->completionstate==COMPLETION_COMPLETE
1701                             ? COMPLETION_INCOMPLETE
1702                             : COMPLETION_COMPLETE;
1703                         // In manual mode the icon is a toggle form...
1705                         // If this completion state is used by the
1706                         // conditional activities system, we need to turn
1707                         // off the JS.
1708                         if (!empty($CFG->enableavailability) &&
1709                             condition_info::completion_value_used_as_condition($course, $mod)) {
1710                             $extraclass = ' preventjs';
1711                         } else {
1712                             $extraclass = '';
1713                         }
1714                         echo html_writer::start_tag('form', array(
1715                                 'class' => 'togglecompletion' . $extraclass,
1716                                 'method' => 'post',
1717                                 'action' => $CFG->wwwroot . '/course/togglecompletion.php'));
1718                         echo html_writer::start_tag('div');
1719                         echo html_writer::empty_tag('input', array(
1720                                 'type' => 'hidden', 'name' => 'id', 'value' => $mod->id));
1721                         echo html_writer::empty_tag('input', array(
1722                                 'type' => 'hidden', 'name' => 'modulename',
1723                                 'value' => $mod->name));
1724                         echo html_writer::empty_tag('input', array(
1725                                 'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
1726                         echo html_writer::empty_tag('input', array(
1727                                 'type' => 'hidden', 'name' => 'completionstate',
1728                                 'value' => $newstate));
1729                         echo html_writer::empty_tag('input', array(
1730                                 'type' => 'image', 'src' => $imgsrc, 'alt' => $imgalt, 'title' => $imgtitle));
1731                         echo html_writer::end_tag('div');
1732                         echo html_writer::end_tag('form');
1733                     } else {
1734                         // In auto mode, or when editing, the icon is just an image
1735                         echo "<span class='autocompletion'>";
1736                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1737                     }
1738                 }
1739             }
1741             // If there is content AND a link, then display the content here
1742             // (AFTER any icons). Otherwise it was displayed before
1743             if (!empty($url)) {
1744                 echo $contentpart;
1745             }
1747             // Show availability information (for someone who isn't allowed to
1748             // see the activity itself, or for staff)
1749             if (!$mod->uservisible) {
1750                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1751             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1752                 // Don't add availability information if user is not editing and activity is hidden.
1753                 if ($mod->visible || $PAGE->user_is_editing()) {
1754                     $hidinfoclass = '';
1755                     if (!$mod->visible) {
1756                         $hidinfoclass = 'hide';
1757                     }
1758                     $ci = new condition_info($mod);
1759                     $fullinfo = $ci->get_full_information();
1760                     if($fullinfo) {
1761                         echo '<div class="availabilityinfo '.$hidinfoclass.'">'.get_string($mod->showavailability
1762                             ? 'userrestriction_visible'
1763                             : 'userrestriction_hidden','condition',
1764                             $fullinfo).'</div>';
1765                     }
1766                 }
1767             }
1769             echo html_writer::end_tag('div');
1770             echo html_writer::end_tag('li')."\n";
1771         }
1773     } elseif ($ismoving) {
1774         echo "<ul class=\"section\">\n";
1775     }
1777     if ($ismoving) {
1778         echo '<li><a title="'.$strmovefull.'"'.
1779              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1780              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1781              ' alt="'.$strmovehere.'" /></a></li>
1782              ';
1783     }
1784     if (!empty($section->sequence) || $ismoving) {
1785         echo "</ul><!--class='section'-->\n\n";
1786     }
1789 /**
1790  * Prints the menus to add activities and resources.
1791  *
1792  * @param stdClass $course The course
1793  * @param int $section relative section number (field course_sections.section)
1794  * @param array $modnames An array containing the list of modules and their names
1795  * @param bool $vertical Vertical orientation
1796  * @param bool $return Return the menus or send them to output
1797  * @param int $sectionreturn The section to link back to
1798  * @return void|string depending on $return
1799  */
1800 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false, $sectionreturn=null) {
1801     global $CFG, $OUTPUT;
1803     // check to see if user can add menus
1804     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1805         return false;
1806     }
1808     // Retrieve all modules with associated metadata
1809     $modules = get_module_metadata($course, $modnames, $sectionreturn);
1811     // We'll sort resources and activities into two lists
1812     $resources = array();
1813     $activities = array();
1815     // We need to add the section section to the link for each module
1816     $sectionlink = '&section=' . $section . '&sr=' . $sectionreturn;
1818     foreach ($modules as $module) {
1819         if (isset($module->types)) {
1820             // This module has a subtype
1821             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1822             $subtypes = array();
1823             foreach ($module->types as $subtype) {
1824                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1825             }
1827             // Sort module subtypes into the list
1828             if (!empty($module->title)) {
1829                 // This grouping has a name
1830                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1831                     $resources[] = array($module->title=>$subtypes);
1832                 } else {
1833                     $activities[] = array($module->title=>$subtypes);
1834                 }
1835             } else {
1836                 // This grouping does not have a name
1837                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1838                     $resources = array_merge($resources, $subtypes);
1839                 } else {
1840                     $activities = array_merge($activities, $subtypes);
1841                 }
1842             }
1843         } else {
1844             // This module has no subtypes
1845             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1846                 $resources[$module->link . $sectionlink] = $module->title;
1847             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1848                 // System modules cannot be added by user, do not add to dropdown
1849             } else {
1850                 $activities[$module->link . $sectionlink] = $module->title;
1851             }
1852         }
1853     }
1855     $straddactivity = get_string('addactivity');
1856     $straddresource = get_string('addresource');
1858     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1860     if (!$vertical) {
1861         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1862     }
1864     if (!empty($resources)) {
1865         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1866         $select->set_help_icon('resources');
1867         $output .= $OUTPUT->render($select);
1868     }
1870     if (!empty($activities)) {
1871         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1872         $select->set_help_icon('activities');
1873         $output .= $OUTPUT->render($select);
1874     }
1876     if (!$vertical) {
1877         $output .= html_writer::end_tag('div');
1878     }
1880     $output .= html_writer::end_tag('div');
1882     if (course_ajax_enabled($course)) {
1883         $straddeither = get_string('addresourceoractivity');
1884         // The module chooser link
1885         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1886         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1887         $icon = $OUTPUT->pix_icon('t/add', '');
1888         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1889         $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1890         $modchooser.= html_writer::end_tag('div');
1891         $modchooser.= html_writer::end_tag('div');
1893         // Wrap the normal output in a noscript div
1894         $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1895         if ($usemodchooser) {
1896             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1897             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1898         } else {
1899             // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1900             $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1901             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
1902         }
1903         $output = $modchooser . $output;
1904     }
1906     if ($return) {
1907         return $output;
1908     } else {
1909         echo $output;
1910     }
1913 /**
1914  * Retrieve all metadata for the requested modules
1915  *
1916  * @param object $course The Course
1917  * @param array $modnames An array containing the list of modules and their
1918  * names
1919  * @param int $sectionreturn The section to return to
1920  * @return array A list of stdClass objects containing metadata about each
1921  * module
1922  */
1923 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1924     global $CFG, $OUTPUT;
1926     // get_module_metadata will be called once per section on the page and courses may show
1927     // different modules to one another
1928     static $modlist = array();
1929     if (!isset($modlist[$course->id])) {
1930         $modlist[$course->id] = array();
1931     }
1933     $return = array();
1934     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&sr='.$sectionreturn.'&add=';
1935     foreach($modnames as $modname => $modnamestr) {
1936         if (!course_allowed_module($course, $modname)) {
1937             continue;
1938         }
1939         if (isset($modlist[$course->id][$modname])) {
1940             // This module is already cached
1941             $return[$modname] = $modlist[$course->id][$modname];
1942             continue;
1943         }
1945         // Include the module lib
1946         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1947         if (!file_exists($libfile)) {
1948             continue;
1949         }
1950         include_once($libfile);
1952         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1953         $gettypesfunc =  $modname.'_get_types';
1954         if (function_exists($gettypesfunc)) {
1955             if ($types = $gettypesfunc()) {
1956                 $group = new stdClass();
1957                 $group->name = $modname;
1958                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1959                 foreach($types as $type) {
1960                     if ($type->typestr === '--') {
1961                         continue;
1962                     }
1963                     if (strpos($type->typestr, '--') === 0) {
1964                         $group->title = str_replace('--', '', $type->typestr);
1965                         continue;
1966                     }
1967                     // Set the Sub Type metadata
1968                     $subtype = new stdClass();
1969                     $subtype->title = $type->typestr;
1970                     $subtype->type = str_replace('&amp;', '&', $type->type);
1971                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1972                     $subtype->archetype = $type->modclass;
1974                     // The group archetype should match the subtype archetypes and all subtypes
1975                     // should have the same archetype
1976                     $group->archetype = $subtype->archetype;
1978                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1979                         $subtype->help = get_string('help' . $subtype->name, $modname);
1980                     }
1981                     $subtype->link = $urlbase . $subtype->type;
1982                     $group->types[] = $subtype;
1983                 }
1984                 $modlist[$course->id][$modname] = $group;
1985             }
1986         } else {
1987             $module = new stdClass();
1988             $module->title = get_string('modulename', $modname);
1989             $module->name = $modname;
1990             $module->link = $urlbase . $modname;
1991             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1992             $sm = get_string_manager();
1993             if ($sm->string_exists('modulename_help', $modname)) {
1994                 $module->help = get_string('modulename_help', $modname);
1995                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1996                     $link = get_string('modulename_link', $modname);
1997                     $linktext = get_string('morehelp');
1998                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1999                 }
2000             }
2001             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2002             $modlist[$course->id][$modname] = $module;
2003         }
2004         $return[$modname] = $modlist[$course->id][$modname];
2005     }
2007     return $return;
2010 /**
2011  * Return the course category context for the category with id $categoryid, except
2012  * that if $categoryid is 0, return the system context.
2013  *
2014  * @param integer $categoryid a category id or 0.
2015  * @return object the corresponding context
2016  */
2017 function get_category_or_system_context($categoryid) {
2018     if ($categoryid) {
2019         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
2020     } else {
2021         return get_context_instance(CONTEXT_SYSTEM);
2022     }
2025 /**
2026  * Gets the child categories of a given courses category. Uses a static cache
2027  * to make repeat calls efficient.
2028  *
2029  * @param int $parentid the id of a course category.
2030  * @return array all the child course categories.
2031  */
2032 function get_child_categories($parentid) {
2033     static $allcategories = null;
2035     // only fill in this variable the first time
2036     if (null == $allcategories) {
2037         $allcategories = array();
2039         $categories = get_categories();
2040         foreach ($categories as $category) {
2041             if (empty($allcategories[$category->parent])) {
2042                 $allcategories[$category->parent] = array();
2043             }
2044             $allcategories[$category->parent][] = $category;
2045         }
2046     }
2048     if (empty($allcategories[$parentid])) {
2049         return array();
2050     } else {
2051         return $allcategories[$parentid];
2052     }
2055 /**
2056  * This function recursively travels the categories, building up a nice list
2057  * for display. It also makes an array that list all the parents for each
2058  * category.
2059  *
2060  * For example, if you have a tree of categories like:
2061  *   Miscellaneous (id = 1)
2062  *      Subcategory (id = 2)
2063  *         Sub-subcategory (id = 4)
2064  *   Other category (id = 3)
2065  * Then after calling this function you will have
2066  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2067  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2068  *      3 => 'Other category');
2069  * $parents = array(2 => array(1), 4 => array(1, 2));
2070  *
2071  * If you specify $requiredcapability, then only categories where the current
2072  * user has that capability will be added to $list, although all categories
2073  * will still be added to $parents, and if you only have $requiredcapability
2074  * in a child category, not the parent, then the child catgegory will still be
2075  * included.
2076  *
2077  * If you specify the option $excluded, then that category, and all its children,
2078  * are omitted from the tree. This is useful when you are doing something like
2079  * moving categories, where you do not want to allow people to move a category
2080  * to be the child of itself.
2081  *
2082  * @param array $list For output, accumulates an array categoryid => full category path name
2083  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2084  * @param string/array $requiredcapability if given, only categories where the current
2085  *      user has this capability will be added to $list. Can also be an array of capabilities,
2086  *      in which case they are all required.
2087  * @param integer $excludeid Omit this category and its children from the lists built.
2088  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2089  * @param string $path For internal use, as part of recursive calls.
2090  */
2091 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2092         $excludeid = 0, $category = NULL, $path = "") {
2094     // initialize the arrays if needed
2095     if (!is_array($list)) {
2096         $list = array();
2097     }
2098     if (!is_array($parents)) {
2099         $parents = array();
2100     }
2102     if (empty($category)) {
2103         // Start at the top level.
2104         $category = new stdClass;
2105         $category->id = 0;
2106     } else {
2107         // This is the excluded category, don't include it.
2108         if ($excludeid > 0 && $excludeid == $category->id) {
2109             return;
2110         }
2112         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2113         $categoryname = format_string($category->name, true, array('context' => $context));
2115         // Update $path.
2116         if ($path) {
2117             $path = $path.' / '.$categoryname;
2118         } else {
2119             $path = $categoryname;
2120         }
2122         // Add this category to $list, if the permissions check out.
2123         if (empty($requiredcapability)) {
2124             $list[$category->id] = $path;
2126         } else {
2127             $requiredcapability = (array)$requiredcapability;
2128             if (has_all_capabilities($requiredcapability, $context)) {
2129                 $list[$category->id] = $path;
2130             }
2131         }
2132     }
2134     // Add all the children recursively, while updating the parents array.
2135     if ($categories = get_child_categories($category->id)) {
2136         foreach ($categories as $cat) {
2137             if (!empty($category->id)) {
2138                 if (isset($parents[$category->id])) {
2139                     $parents[$cat->id]   = $parents[$category->id];
2140                 }
2141                 $parents[$cat->id][] = $category->id;
2142             }
2143             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2144         }
2145     }
2148 /**
2149  * This function generates a structured array of courses and categories.
2150  *
2151  * The depth of categories is limited by $CFG->maxcategorydepth however there
2152  * is no limit on the number of courses!
2153  *
2154  * Suitable for use with the course renderers course_category_tree method:
2155  * $renderer = $PAGE->get_renderer('core','course');
2156  * echo $renderer->course_category_tree(get_course_category_tree());
2157  *
2158  * @global moodle_database $DB
2159  * @param int $id
2160  * @param int $depth
2161  */
2162 function get_course_category_tree($id = 0, $depth = 0) {
2163     global $DB, $CFG;
2164     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2165     $categories = get_child_categories($id);
2166     $categoryids = array();
2167     foreach ($categories as $key => &$category) {
2168         if (!$category->visible && !$viewhiddencats) {
2169             unset($categories[$key]);
2170             continue;
2171         }
2172         $categoryids[$category->id] = $category;
2173         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2174             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2175             foreach ($subcategories as $subid=>$subcat) {
2176                 $categoryids[$subid] = $subcat;
2177             }
2178             $category->courses = array();
2179         }
2180     }
2182     if ($depth > 0) {
2183         // This is a recursive call so return the required array
2184         return array($categories, $categoryids);
2185     }
2187     if (empty($categoryids)) {
2188         // No categories available (probably all hidden).
2189         return array();
2190     }
2192     // The depth is 0 this function has just been called so we can finish it off
2194     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2195     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2196     $sql = "SELECT
2197             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2198             $ccselect
2199             FROM {course} c
2200             $ccjoin
2201             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2202     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2203         // loop throught them
2204         foreach ($courses as $course) {
2205             if ($course->id == SITEID) {
2206                 continue;
2207             }
2208             context_instance_preload($course);
2209             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2210                 $categoryids[$course->category]->courses[$course->id] = $course;
2211             }
2212         }
2213     }
2214     return $categories;
2217 /**
2218  * Recursive function to print out all the categories in a nice format
2219  * with or without courses included
2220  */
2221 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2222     global $CFG;
2224     // maxcategorydepth == 0 meant no limit
2225     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2226         return;
2227     }
2229     if (!$displaylist) {
2230         make_categories_list($displaylist, $parentslist);
2231     }
2233     if ($category) {
2234         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2235             print_category_info($category, $depth, $showcourses);
2236         } else {
2237             return;  // Don't bother printing children of invisible categories
2238         }
2240     } else {
2241         $category = new stdClass();
2242         $category->id = "0";
2243     }
2245     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2246         $countcats = count($categories);
2247         $count = 0;
2248         $first = true;
2249         $last = false;
2250         foreach ($categories as $cat) {
2251             $count++;
2252             if ($count == $countcats) {
2253                 $last = true;
2254             }
2255             $up = $first ? false : true;
2256             $down = $last ? false : true;
2257             $first = false;
2259             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2260         }
2261     }
2264 /**
2265  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2266  */
2267 function make_categories_options() {
2268     make_categories_list($cats,$parents);
2269     foreach ($cats as $key => $value) {
2270         if (array_key_exists($key,$parents)) {
2271             if ($indent = count($parents[$key])) {
2272                 for ($i = 0; $i < $indent; $i++) {
2273                     $cats[$key] = '&nbsp;'.$cats[$key];
2274                 }
2275             }
2276         }
2277     }
2278     return $cats;
2281 /**
2282  * Prints the category info in indented fashion
2283  * This function is only used by print_whole_category_list() above
2284  */
2285 function print_category_info($category, $depth=0, $showcourses = false) {
2286     global $CFG, $DB, $OUTPUT;
2288     $strsummary = get_string('summary');
2290     $catlinkcss = null;
2291     if (!$category->visible) {
2292         $catlinkcss = array('class'=>'dimmed');
2293     }
2294     static $coursecount = null;
2295     if (null === $coursecount) {
2296         // only need to check this once
2297         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2298     }
2300     if ($showcourses and $coursecount) {
2301         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2302     } else {
2303         $catimage = "&nbsp;";
2304     }
2306     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2307     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2308     $fullname = format_string($category->name, true, array('context' => $context));
2310     if ($showcourses and $coursecount) {
2311         echo '<div class="categorylist clearfix">';
2312         $cat = '';
2313         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2314         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2315         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2317         $html = '';
2318         if ($depth > 0) {
2319             for ($i=0; $i< $depth; $i++) {
2320                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2321                 $cat = '';
2322             }
2323         } else {
2324             $html = $cat;
2325         }
2326         echo html_writer::tag('div', $html, array('class'=>'category'));
2327         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2329         // does the depth exceed maxcategorydepth
2330         // maxcategorydepth == 0 or unset meant no limit
2331         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2332         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2333             foreach ($courses as $course) {
2334                 $linkcss = null;
2335                 if (!$course->visible) {
2336                     $linkcss = array('class'=>'dimmed');
2337                 }
2339                 $coursename = get_course_display_name_for_list($course);
2340                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2342                 // print enrol info
2343                 $courseicon = '';
2344                 if ($icons = enrol_get_course_info_icons($course)) {
2345                     foreach ($icons as $pix_icon) {
2346                         $courseicon = $OUTPUT->render($pix_icon).' ';
2347                     }
2348                 }
2350                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2352                 if ($course->summary) {
2353                     $link = new moodle_url('/course/info.php?id='.$course->id);
2354                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2355                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2356                         array('title'=>$strsummary));
2358                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2359                 }
2361                 $html = '';
2362                 for ($i=0; $i <= $depth; $i++) {
2363                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2364                     $coursecontent = '';
2365                 }
2366                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2367             }
2368         }
2369         echo '</div>';
2370     } else {
2371         echo '<div class="categorylist">';
2372         $html = '';
2373         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2374         if (count($courses) > 0) {
2375             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2376         }
2378         if ($depth > 0) {
2379             for ($i=0; $i< $depth; $i++) {
2380                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2381                 $cat = '';
2382             }
2383         } else {
2384             $html = $cat;
2385         }
2387         echo html_writer::tag('div', $html, array('class'=>'category'));
2388         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2389         echo '</div>';
2390     }
2393 /**
2394  * Print the buttons relating to course requests.
2395  *
2396  * @param object $systemcontext the system context.
2397  */
2398 function print_course_request_buttons($systemcontext) {
2399     global $CFG, $DB, $OUTPUT;
2400     if (empty($CFG->enablecourserequests)) {
2401         return;
2402     }
2403     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2404     /// Print a button to request a new course
2405         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2406     }
2407     /// Print a button to manage pending requests
2408     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2409         $disabled = !$DB->record_exists('course_request', array());
2410         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2411     }
2414 /**
2415  * Does the user have permission to edit things in this category?
2416  *
2417  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2418  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2419  */
2420 function can_edit_in_category($categoryid = 0) {
2421     $context = get_category_or_system_context($categoryid);
2422     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2425 /**
2426  * Prints the turn editing on/off button on course/index.php or course/category.php.
2427  *
2428  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2429  * @return string HTML of the editing button, or empty string, if this user is not allowed
2430  *      to see it.
2431  */
2432 function update_category_button($categoryid = 0) {
2433     global $CFG, $PAGE, $OUTPUT;
2435     // Check permissions.
2436     if (!can_edit_in_category($categoryid)) {
2437         return '';
2438     }
2440     // Work out the appropriate action.
2441     if ($PAGE->user_is_editing()) {
2442         $label = get_string('turneditingoff');
2443         $edit = 'off';
2444     } else {
2445         $label = get_string('turneditingon');
2446         $edit = 'on';
2447     }
2449     // Generate the button HTML.
2450     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2451     if ($categoryid) {
2452         $options['id'] = $categoryid;
2453         $page = 'category.php';
2454     } else {
2455         $page = 'index.php';
2456     }
2457     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2460 /**
2461  * Category is 0 (for all courses) or an object
2462  */
2463 function print_courses($category) {
2464     global $CFG, $OUTPUT;
2466     if (!is_object($category) && $category==0) {
2467         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2468         if (is_array($categories) && count($categories) == 1) {
2469             $category   = array_shift($categories);
2470             $courses    = get_courses_wmanagers($category->id,
2471                                                 'c.sortorder ASC',
2472                                                 array('summary','summaryformat'));
2473         } else {
2474             $courses    = get_courses_wmanagers('all',
2475                                                 'c.sortorder ASC',
2476                                                 array('summary','summaryformat'));
2477         }
2478         unset($categories);
2479     } else {
2480         $courses    = get_courses_wmanagers($category->id,
2481                                             'c.sortorder ASC',
2482                                             array('summary','summaryformat'));
2483     }
2485     if ($courses) {
2486         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2487         foreach ($courses as $course) {
2488             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2489             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2490                 echo html_writer::start_tag('li');
2491                 print_course($course);
2492                 echo html_writer::end_tag('li');
2493             }
2494         }
2495         echo html_writer::end_tag('ul');
2496     } else {
2497         echo $OUTPUT->heading(get_string("nocoursesyet"));
2498         $context = get_context_instance(CONTEXT_SYSTEM);
2499         if (has_capability('moodle/course:create', $context)) {
2500             $options = array();
2501             if (!empty($category->id)) {
2502                 $options['category'] = $category->id;
2503             } else {
2504                 $options['category'] = $CFG->defaultrequestcategory;
2505             }
2506             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2507             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2508             echo html_writer::end_tag('div');
2509         }
2510     }
2513 /**
2514  * Print a description of a course, suitable for browsing in a list.
2515  *
2516  * @param object $course the course object.
2517  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2518  */
2519 function print_course($course, $highlightterms = '') {
2520     global $CFG, $USER, $DB, $OUTPUT;
2522     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2524     // Rewrite file URLs so that they are correct
2525     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2527     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2528     echo html_writer::start_tag('div', array('class'=>'info'));
2529     echo html_writer::start_tag('h3', array('class'=>'name'));
2531     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2533     $coursename = get_course_display_name_for_list($course);
2534     $linktext = highlight($highlightterms, format_string($coursename));
2535     $linkparams = array('title'=>get_string('entercourse'));
2536     if (empty($course->visible)) {
2537         $linkparams['class'] = 'dimmed';
2538     }
2539     echo html_writer::link($linkhref, $linktext, $linkparams);
2540     echo html_writer::end_tag('h3');
2542     /// first find all roles that are supposed to be displayed
2543     if (!empty($CFG->coursecontact)) {
2544         $managerroles = explode(',', $CFG->coursecontact);
2545         $namesarray = array();
2546         $rusers = array();
2548         if (!isset($course->managers)) {
2549             $rusers = get_role_users($managerroles, $context, true,
2550                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2551                  r.name AS rolename, r.sortorder, r.id AS roleid',
2552                 'r.sortorder ASC, u.lastname ASC');
2553         } else {
2554             //  use the managers array if we have it for perf reasosn
2555             //  populate the datastructure like output of get_role_users();
2556             foreach ($course->managers as $manager) {
2557                 $u = new stdClass();
2558                 $u = $manager->user;
2559                 $u->roleid = $manager->roleid;
2560                 $u->rolename = $manager->rolename;
2562                 $rusers[] = $u;
2563             }
2564         }
2566         /// Rename some of the role names if needed
2567         if (isset($context)) {
2568             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2569         }
2571         $namesarray = array();
2572         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2573         foreach ($rusers as $ra) {
2574             if (isset($namesarray[$ra->id])) {
2575                 //  only display a user once with the higest sortorder role
2576                 continue;
2577             }
2579             if (isset($aliasnames[$ra->roleid])) {
2580                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2581             }
2583             $fullname = fullname($ra, $canviewfullnames);
2584             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2585                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2586         }
2588         if (!empty($namesarray)) {
2589             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2590             foreach ($namesarray as $name) {
2591                 echo html_writer::tag('li', $name);
2592             }
2593             echo html_writer::end_tag('ul');
2594         }
2595     }
2596     echo html_writer::end_tag('div'); // End of info div
2598     echo html_writer::start_tag('div', array('class'=>'summary'));
2599     $options = new stdClass();
2600     $options->noclean = true;
2601     $options->para = false;
2602     $options->overflowdiv = true;
2603     if (!isset($course->summaryformat)) {
2604         $course->summaryformat = FORMAT_MOODLE;
2605     }
2606     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2607     if ($icons = enrol_get_course_info_icons($course)) {
2608         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2609         foreach ($icons as $icon) {
2610             echo $OUTPUT->render($icon);
2611         }
2612         echo html_writer::end_tag('div'); // End of enrolmenticons div
2613     }
2614     echo html_writer::end_tag('div'); // End of summary div
2615     echo html_writer::end_tag('div'); // End of coursebox div
2618 /**
2619  * Prints custom user information on the home page.
2620  * Over time this can include all sorts of information
2621  */
2622 function print_my_moodle() {
2623     global $USER, $CFG, $DB, $OUTPUT;
2625     if (!isloggedin() or isguestuser()) {
2626         print_error('nopermissions', '', '', 'See My Moodle');
2627     }
2629     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2630     $rhosts   = array();
2631     $rcourses = array();
2632     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2633         $rcourses = get_my_remotecourses($USER->id);
2634         $rhosts   = get_my_remotehosts();
2635     }
2637     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2639         if (!empty($courses)) {
2640             echo '<ul class="unlist">';
2641             foreach ($courses as $course) {
2642                 if ($course->id == SITEID) {
2643                     continue;
2644                 }
2645                 echo '<li>';
2646                 print_course($course);
2647                 echo "</li>\n";
2648             }
2649             echo "</ul>\n";
2650         }
2652         // MNET
2653         if (!empty($rcourses)) {
2654             // at the IDP, we know of all the remote courses
2655             foreach ($rcourses as $course) {
2656                 print_remote_course($course, "100%");
2657             }
2658         } elseif (!empty($rhosts)) {
2659             // non-IDP, we know of all the remote servers, but not courses
2660             foreach ($rhosts as $host) {
2661                 print_remote_host($host, "100%");
2662             }
2663         }
2664         unset($course);
2665         unset($host);
2667         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2668             echo "<table width=\"100%\"><tr><td align=\"center\">";
2669             print_course_search("", false, "short");
2670             echo "</td><td align=\"center\">";
2671             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2672             echo "</td></tr></table>\n";
2673         }
2675     } else {
2676         if ($DB->count_records("course_categories") > 1) {
2677             echo $OUTPUT->box_start("categorybox");
2678             print_whole_category_list();
2679             echo $OUTPUT->box_end();
2680         } else {
2681             print_courses(0);
2682         }
2683     }
2687 function print_course_search($value="", $return=false, $format="plain") {
2688     global $CFG;
2689     static $count = 0;
2691     $count++;
2693     $id = 'coursesearch';
2695     if ($count > 1) {
2696         $id .= $count;
2697     }
2699     $strsearchcourses= get_string("searchcourses");
2701     if ($format == 'plain') {
2702         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2703         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2704         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2705         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2706         $output .= '<input type="submit" value="'.get_string('go').'" />';
2707         $output .= '</fieldset></form>';
2708     } else if ($format == 'short') {
2709         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2710         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2711         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2712         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2713         $output .= '<input type="submit" value="'.get_string('go').'" />';
2714         $output .= '</fieldset></form>';
2715     } else if ($format == 'navbar') {
2716         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2717         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2718         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2719         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2720         $output .= '<input type="submit" value="'.get_string('go').'" />';
2721         $output .= '</fieldset></form>';
2722     }
2724     if ($return) {
2725         return $output;
2726     }
2727     echo $output;
2730 function print_remote_course($course, $width="100%") {
2731     global $CFG, $USER;
2733     $linkcss = '';
2735     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2737     echo '<div class="coursebox remotecoursebox clearfix">';
2738     echo '<div class="info">';
2739     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2740          $linkcss.' href="'.$url.'">'
2741         .  format_string($course->fullname) .'</a><br />'
2742         . format_string($course->hostname) . ' : '
2743         . format_string($course->cat_name) . ' : '
2744         . format_string($course->shortname). '</div>';
2745     echo '</div><div class="summary">';
2746     $options = new stdClass();
2747     $options->noclean = true;
2748     $options->para = false;
2749     $options->overflowdiv = true;
2750     echo format_text($course->summary, $course->summaryformat, $options);
2751     echo '</div>';
2752     echo '</div>';
2755 function print_remote_host($host, $width="100%") {
2756     global $OUTPUT;
2758     $linkcss = '';
2760     echo '<div class="coursebox clearfix">';
2761     echo '<div class="info">';
2762     echo '<div class="name">';
2763     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2764     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2765         . s($host['name']).'</a> - ';
2766     echo $host['count'] . ' ' . get_string('courses');
2767     echo '</div>';
2768     echo '</div>';
2769     echo '</div>';
2773 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2775 function add_course_module($mod) {
2776     global $DB;
2778     $mod->added = time();
2779     unset($mod->id);
2781     return $DB->insert_record("course_modules", $mod);
2784 /**
2785  * Returns course section - creates new if does not exist yet.
2786  * @param int $relative section number
2787  * @param int $courseid
2788  * @return object $course_section object
2789  */
2790 function get_course_section($section, $courseid) {
2791     global $DB;
2793     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2794         return $cw;
2795     }
2796     $cw = new stdClass();
2797     $cw->course   = $courseid;
2798     $cw->section  = $section;
2799     $cw->summary  = "";
2800     $cw->summaryformat = FORMAT_HTML;
2801     $cw->sequence = "";
2802     $id = $DB->insert_record("course_sections", $cw);
2803     rebuild_course_cache($courseid, true);
2804     return $DB->get_record("course_sections", array("id"=>$id));
2807 /**
2808  * Given a full mod object with section and course already defined, adds this module to that section.
2809  *
2810  * @param object $mod
2811  * @param int $beforemod An existing ID which we will insert the new module before
2812  * @return int The course_sections ID where the mod is inserted
2813  */
2814 function add_mod_to_section($mod, $beforemod=NULL) {
2815     global $DB;
2817     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2819         $section->sequence = trim($section->sequence);
2821         if (empty($section->sequence)) {
2822             $newsequence = "$mod->coursemodule";
2824         } else if ($beforemod) {
2825             $modarray = explode(",", $section->sequence);
2827             if ($key = array_keys($modarray, $beforemod->id)) {
2828                 $insertarray = array($mod->id, $beforemod->id);
2829                 array_splice($modarray, $key[0], 1, $insertarray);
2830                 $newsequence = implode(",", $modarray);
2832             } else {  // Just tack it on the end anyway
2833                 $newsequence = "$section->sequence,$mod->coursemodule";
2834             }
2836         } else {
2837             $newsequence = "$section->sequence,$mod->coursemodule";
2838         }
2840         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2841         return $section->id;     // Return course_sections ID that was used.
2843     } else {  // Insert a new record
2844         $section = new stdClass();
2845         $section->course   = $mod->course;
2846         $section->section  = $mod->section;
2847         $section->summary  = "";
2848         $section->summaryformat = FORMAT_HTML;
2849         $section->sequence = $mod->coursemodule;
2850         return $DB->insert_record("course_sections", $section);
2851     }
2854 function set_coursemodule_groupmode($id, $groupmode) {
2855     global $DB;
2856     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2859 function set_coursemodule_idnumber($id, $idnumber) {
2860     global $DB;
2861     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2864 /**
2865 * $prevstateoverrides = true will set the visibility of the course module
2866 * to what is defined in visibleold. This enables us to remember the current
2867 * visibility when making a whole section hidden, so that when we toggle
2868 * that section back to visible, we are able to return the visibility of
2869 * the course module back to what it was originally.
2870 */
2871 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2872     global $DB, $CFG;
2873     require_once($CFG->libdir.'/gradelib.php');
2875     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2876         return false;
2877     }
2878     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2879         return false;
2880     }
2881     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2882         foreach($events as $event) {
2883             if ($visible) {
2884                 show_event($event);
2885             } else {
2886                 hide_event($event);
2887             }
2888         }
2889     }
2891     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2892     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2893     if ($grade_items) {
2894         foreach ($grade_items as $grade_item) {
2895             $grade_item->set_hidden(!$visible);
2896         }
2897     }
2899     if ($prevstateoverrides) {
2900         if ($visible == '0') {
2901             // Remember the current visible state so we can toggle this back.
2902             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2903         } else {
2904             // Get the previous saved visible states.
2905             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2906         }
2907     }
2908     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2911 /**
2912  * Delete a course module and any associated data at the course level (events)
2913  * Until 1.5 this function simply marked a deleted flag ... now it
2914  * deletes it completely.
2915  *
2916  */
2917 function delete_course_module($id) {
2918     global $CFG, $DB;
2919     require_once($CFG->libdir.'/gradelib.php');
2920     require_once($CFG->dirroot.'/blog/lib.php');
2922     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2923         return true;
2924     }
2925     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2926     //delete events from calendar
2927     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2928         foreach($events as $event) {
2929             delete_event($event->id);
2930         }
2931     }
2932     //delete grade items, outcome items and grades attached to modules
2933     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2934                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2935         foreach ($grade_items as $grade_item) {
2936             $grade_item->delete('moddelete');
2937         }
2938     }
2939     // Delete completion and availability data; it is better to do this even if the
2940     // features are not turned on, in case they were turned on previously (these will be
2941     // very quick on an empty table)
2942     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2943     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2944     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2945                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2947     delete_context(CONTEXT_MODULE, $cm->id);
2948     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2951 function delete_mod_from_section($mod, $section) {
2952     global $DB;
2954     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2956         $modarray = explode(",", $section->sequence);
2958         if ($key = array_keys ($modarray, $mod)) {
2959             array_splice($modarray, $key[0], 1);
2960             $newsequence = implode(",", $modarray);
2961             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2962         } else {
2963             return false;
2964         }
2966     }
2967     return false;
2970 /**
2971  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2972  *
2973  * @param object $course course object
2974  * @param int $section Section number (not id!!!)
2975  * @param int $move (-1 or 1)
2976  * @return boolean true if section moved successfully
2977  * @todo MDL-33379 remove this function in 2.5
2978  */
2979 function move_section($course, $section, $move) {
2980     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2982 /// Moves a whole course section up and down within the course
2983     global $USER, $DB;
2985     if (!$move) {
2986         return true;
2987     }
2989     $sectiondest = $section + $move;
2991     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2992         return false;
2993     }
2995     $retval = move_section_to($course, $section, $sectiondest);
2996     // If section moved, then rebuild course cache.
2997     if ($retval) {
2998         rebuild_course_cache($course->id, true);
2999     }
3000     return $retval;
3003 /**
3004  * Moves a section within a course, from a position to another.
3005  * Be very careful: $section and $destination refer to section number,
3006  * not id!.
3007  *
3008  * @param object $course
3009  * @param int $section Section number (not id!!!)
3010  * @param int $destination
3011  * @return boolean Result
3012  */
3013 function move_section_to($course, $section, $destination) {
3014 /// Moves a whole course section up and down within the course
3015     global $USER, $DB;
3017     if (!$destination && $destination != 0) {
3018         return true;
3019     }
3021     if (($destination > $course->numsections) || ($destination < 1)) {
3022         return false;
3023     }
3025     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3026     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3027             'section ASC, id ASC', 'id, section')) {
3028         return false;
3029     }
3031     $movedsections = reorder_sections($sections, $section, $destination);
3033     // Update all sections. Do this in 2 steps to avoid breaking database
3034     // uniqueness constraint
3035     $transaction = $DB->start_delegated_transaction();
3036     foreach ($movedsections as $id => $position) {
3037         if ($sections[$id] !== $position) {
3038             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3039         }
3040     }
3041     foreach ($movedsections as $id => $position) {
3042         if ($sections[$id] !== $position) {
3043             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3044         }
3045     }
3047     // If we move the highlighted section itself, then just highlight the destination.
3048     // Adjust the higlighted section location if we move something over it either direction.
3049     if ($section == $course->marker) {
3050         course_set_marker($course->id, $destination);
3051     } elseif ($section > $course->marker && $course->marker >= $destination) {
3052         course_set_marker($course->id, $course->marker+1);
3053     } elseif ($section < $course->marker && $course->marker <= $destination) {
3054         course_set_marker($course->id, $course->marker-1);
3055     }
3057     $transaction->allow_commit();
3058     return true;
3061 /**
3062  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3063  * an original position number and a target position number, rebuilds the array so that the
3064  * move is made without any duplication of section positions.
3065  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3066  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3067  *
3068  * @param array $sections
3069  * @param int $origin_position
3070  * @param int $target_position
3071  * @return array
3072  */
3073 function reorder_sections($sections, $origin_position, $target_position) {
3074     if (!is_array($sections)) {
3075         return false;
3076     }
3078     // We can't move section position 0
3079     if ($origin_position < 1) {
3080         echo "We can't move section position 0";
3081         return false;
3082     }
3084     // Locate origin section in sections array
3085     if (!$origin_key = array_search($origin_position, $sections)) {
3086         echo "searched position not in sections array";
3087         return false; // searched position not in sections array
3088     }
3090     // Extract origin section
3091     $origin_section = $sections[$origin_key];
3092     unset($sections[$origin_key]);
3094     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3095     $found = false;
3096     $append_array = array();
3097     foreach ($sections as $id => $position) {
3098         if ($found) {
3099             $append_array[$id] = $position;
3100             unset($sections[$id]);
3101         }
3102         if ($position == $target_position) {
3103             if ($target_position < $origin_position) {
3104                 $append_array[$id] = $position;
3105                 unset($sections[$id]);
3106             }
3107             $found = true;
3108         }
3109     }
3111     // Append moved section
3112     $sections[$origin_key] = $origin_section;
3114     // Append rest of array (if applicable)
3115     if (!empty($append_array)) {
3116         foreach ($append_array as $id => $position) {
3117             $sections[$id] = $position;
3118         }
3119     }
3121     // Renumber positions
3122     $position = 0;
3123     foreach ($sections as $id => $p) {
3124         $sections[$id] = $position;
3125         $position++;
3126     }
3128     return $sections;
3132 /**
3133  * Move the module object $mod to the specified $section
3134  * If $beforemod exists then that is the module
3135  * before which $modid should be inserted
3136  * All parameters are objects
3137  */
3138 function moveto_module($mod, $section, $beforemod=NULL) {
3139     global $DB, $OUTPUT;
3141 /// Remove original module from original section
3142     if (! delete_mod_from_section($mod->id, $mod->section)) {
3143         echo $OUTPUT->notification("Could not delete module from existing section");
3144     }
3146 /// Update module itself if necessary
3148     if ($mod->section != $section->id) {
3149         $mod->section = $section->id;
3150         $DB->update_record("course_modules", $mod);
3151         // if moving to a hidden section then hide module
3152         if (!$section->visible) {
3153             set_coursemodule_visible($mod->id, 0);
3154         }
3155     }
3157 /// Add the module into the new section
3159     $mod->course       = $section->course;
3160     $mod->section      = $section->section;  // need relative reference
3161     $mod->coursemodule = $mod->id;
3163     if (! add_mod_to_section($mod, $beforemod)) {
3164         return false;
3165     }
3167     return true;
3170 /**
3171  * Produces the editing buttons for a module
3172  *
3173  * @global core_renderer $OUTPUT
3174  * @staticvar type $str
3175  * @param stdClass $mod The module to produce editing buttons for
3176  * @param bool $absolute_ignored ignored - all links are absolute
3177  * @param bool $moveselect If true a move seleciton process is used (default true)
3178  * @param int $indent The current indenting
3179  * @param int $section The section to link back to
3180  * @return string XHTML for the editing buttons
3181  */
3182 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3183     global $CFG, $OUTPUT, $COURSE;
3185     static $str;
3187     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3188     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3190     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3191     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3193     // no permission to edit anything
3194     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3195         return false;
3196     }
3198     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3200     if (!isset($str)) {
3201         $str = new stdClass;
3202         $str->assign         = get_string("assignroles", 'role');
3203         $str->delete         = get_string("delete");
3204         $str->move           = get_string("move");
3205         $str->moveup         = get_string("moveup");
3206         $str->movedown       = get_string("movedown");
3207         $str->moveright      = get_string("moveright");
3208         $str->moveleft       = get_string("moveleft");
3209         $str->update         = get_string("update");
3210         $str->duplicate      = get_string("duplicate");
3211         $str->hide           = get_string("hide");
3212         $str->show           = get_string("show");
3213         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3214         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3215         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3216         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3217         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3218         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3219         $str->edittitle = get_string('edittitle', 'moodle');
3220     }
3222     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3224     if ($section !== null) {
3225         $baseurl->param('sr', $section);
3226     }
3227     $actions = array();
3229     // AJAX edit title
3230     if ($mod->modname !== 'label' && $hasmanageactivities && course_ajax_enabled($COURSE)) {
3231         $actions[] = new action_link(
3232             new moodle_url($baseurl, array('update' => $mod->id)),
3233             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3234             null,
3235             array('class' => 'editing_title', 'title' => $str->edittitle)
3236         );
3237     }
3239     // leftright
3240     if ($hasmanageactivities) {
3241         if (right_to_left()) {   // Exchange arrows on RTL
3242             $rightarrow = 't/left';
3243             $leftarrow  = 't/right';
3244         } else {
3245             $rightarrow = 't/right';
3246             $leftarrow  = 't/left';
3247         }
3249         if ($indent > 0) {
3250             $actions[] = new action_link(
3251                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3252                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3253                 null,
3254                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3255             );
3256         }
3257         if ($indent >= 0) {
3258             $actions[] = new action_link(
3259                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3260                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3261                 null,
3262                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3263             );
3264         }
3265     }
3267     // move
3268     if ($hasmanageactivities) {
3269         if ($moveselect) {
3270             $actions[] = new action_link(
3271                 new moodle_url($baseurl, array('copy' => $mod->id)),
3272                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3273                 null,
3274                 array('class' => 'editing_move', 'title' => $str->move)
3275             );
3276         } else {
3277             $actions[] = new action_link(
3278                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3279                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3280                 null,
3281                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3282             );
3283             $actions[] = new action_link(
3284                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3285                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3286                 null,
3287                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3288             );
3289         }
3290     }
3292     // Update
3293     if ($hasmanageactivities) {
3294         $actions[] = new action_link(
3295             new moodle_url($baseurl, array('update' => $mod->id)),
3296             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3297             null,
3298             array('class' => 'editing_update', 'title' => $str->update)
3299         );
3300     }
3302     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3303     if (has_all_capabilities($dupecaps, $coursecontext) && plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3304         $actions[] = new action_link(
3305             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3306             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3307             null,
3308             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3309         );
3310     }
3312     // Delete
3313     if ($hasmanageactivities) {
3314         $actions[] = new action_link(
3315             new moodle_url($baseurl, array('delete' => $mod->id)),
3316             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3317             null,
3318             array('class' => 'editing_delete', 'title' => $str->delete)
3319         );
3320     }
3322     // hideshow
3323     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3324         if ($mod->visible) {
3325             $actions[] = new action_link(
3326                 new moodle_url($baseurl, array('hide' => $mod->id)),
3327                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3328                 null,
3329                 array('class' => 'editing_hide', 'title' => $str->hide)
3330             );
3331         } else {
3332             $actions[] = new action_link(
3333                 new moodle_url($baseurl, array('show' => $mod->id)),
3334                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3335                 null,
3336                 array('class' => 'editing_show', 'title' => $str->show)
3337             );
3338         }
3339     }
3341     // groupmode
3342     if ($hasmanageactivities and $mod->groupmode !== false) {
3343         if ($mod->groupmode == SEPARATEGROUPS) {
3344             $groupmode = 0;
3345             $grouptitle = $str->groupsseparate;
3346             $forcedgrouptitle = $str->forcedgroupsseparate;
3347             $groupclass = 'editing_groupsseparate';
3348             $groupimage = 't/groups';
3349         } else if ($mod->groupmode == VISIBLEGROUPS) {
3350             $groupmode = 1;
3351             $grouptitle = $str->groupsvisible;
3352             $forcedgrouptitle = $str->forcedgroupsvisible;
3353             $groupclass = 'editing_groupsvisible';
3354             $groupimage = 't/groupv';
3355         } else {
3356             $groupmode = 2;
3357             $grouptitle = $str->groupsnone;
3358             $forcedgrouptitle = $str->forcedgroupsnone;
3359             $groupclass = 'editing_groupsnone';
3360             $groupimage = 't/groupn';
3361         }
3362         if ($mod->groupmodelink) {
3363             $actions[] = new action_link(
3364                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3365                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3366                 null,
3367                 array('class' => $groupclass, 'title' => $grouptitle)
3368             );
3369         } else {
3370             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3371         }
3372     }
3374     // Assign
3375     if (has_capability('moodle/role:assign', $modcontext)){
3376         $actions[] = new action_link(
3377             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3378             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3379             null,
3380             array('class' => 'editing_assign', 'title' => $str->assign)
3381         );
3382     }
3384     $output = html_writer::start_tag('span', array('class' => 'commands'));
3385     foreach ($actions as $action) {
3386         if ($action instanceof renderable) {
3387             $output .= $OUTPUT->render($action);
3388         } else {
3389             $output .= $action;
3390         }
3391     }
3392     $output .= html_writer::end_tag('span');
3393     return $output;
3396 /**
3397  * given a course object with shortname & fullname, this function will
3398  * truncate the the number of chars allowed and add ... if it was too long
3399  */
3400 function course_format_name ($course,$max=100) {
3402     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3403     $shortname = format_string($course->shortname, true, array('context' => $context));
3404     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3405     $str = $shortname.': '. $fullname;
3406     if (textlib::strlen($str) <= $max) {
3407         return $str;
3408     }
3409     else {
3410         return textlib::substr($str,0,$max-3).'...';
3411     }
3414 /**
3415  * Is the user allowed to add this type of module to this course?
3416  * @param object $course the course settings. Only $course->id is used.
3417  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3418  * @return bool whether the current user is allowed to add this type of module to this course.
3419  */
3420 function course_allowed_module($course, $modname) {
3421     global $DB;
3423     if (is_numeric($modname)) {
3424         throw new coding_exception('Function course_allowed_module no longer
3425                 supports numeric module ids. Please update your code to pass the module name.');
3426     }
3428     $capability = 'mod/' . $modname . ':addinstance';
3429     if (!get_capability_info($capability)) {
3430         // Debug warning that the capability does not exist, but no more than once per page.
3431         static $warned = array();
3432         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3433         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3434             debugging('The module ' . $modname . ' does not define the standard capability ' .
3435                     $capability , DEBUG_DEVELOPER);
3436             $warned[$modname] = 1;
3437         }
3439         // If the capability does not exist, the module can always be added.
3440         return true;
3441     }
3443     $coursecontext = context_course::instance($course->id);
3444     return has_capability($capability, $coursecontext);
3447 /**
3448  * Recursively delete category including all subcategories and courses.
3449  * @param stdClass $category
3450  * @param boolean $showfeedback display some notices
3451  * @return array return deleted courses
3452  */
3453 function category_delete_full($category, $showfeedback=true) {
3454     global $CFG, $DB;
3455     require_once($CFG->libdir.'/gradelib.php');
3456     require_once($CFG->libdir.'/questionlib.php');
3457     require_once($CFG->dirroot.'/cohort/lib.php');
3459     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3460         foreach ($children as $childcat) {
3461             category_delete_full($childcat, $showfeedback);
3462         }
3463     }
3465     $deletedcourses = array();
3466     if ($courses = $DB->get_records('course', array('category'=>$category-