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