MDL-24419 Fix bug with section creation for new courses
[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  * Note: Since Moodle 2.3, it is more efficient to get this data by calling
1266  * get_fast_modinfo, then using $modinfo->get_section_info or get_section_info_all.
1267  *
1268  * @staticvar array $coursesections
1269  * @param int $courseid
1270  * @return array Array of sections
1271  */
1272 function get_all_sections($courseid) {
1273     global $DB;
1274     static $coursesections = array();
1275     if (!array_key_exists($courseid, $coursesections)) {
1276         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1277                 'section, id, course, name, summary, summaryformat, sequence, visible, ' .
1278                 'availablefrom, availableuntil, showavailability, groupingid');
1279     }
1280     return $coursesections[$courseid];
1283 /**
1284  * Set highlighted section. Only one section can be highlighted at the time.
1285  *
1286  * @param int $courseid course id
1287  * @param int $marker highlight section with this number, 0 means remove higlightin
1288  * @return void
1289  */
1290 function course_set_marker($courseid, $marker) {
1291     global $DB;
1292     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1295 /**
1296  * For a given course section, marks it visible or hidden,
1297  * and does the same for every activity in that section
1298  *
1299  * @param int $courseid course id
1300  * @param int $sectionnumber The section number to adjust
1301  * @param int $visibility The new visibility
1302  * @return array A list of resources which were hidden in the section
1303  */
1304 function set_section_visible($courseid, $sectionnumber, $visibility) {
1305     global $DB;
1307     $resourcestotoggle = array();
1308     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1309         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1310         if (!empty($section->sequence)) {
1311             $modules = explode(",", $section->sequence);
1312             foreach ($modules as $moduleid) {
1313                 set_coursemodule_visible($moduleid, $visibility, true);
1314             }
1315         }
1316         rebuild_course_cache($courseid);
1318         // Determine which modules are visible for AJAX update
1319         if (!empty($modules)) {
1320             list($insql, $params) = $DB->get_in_or_equal($modules);
1321             $select = 'id ' . $insql . ' AND visible = ?';
1322             array_push($params, $visibility);
1323             if (!$visibility) {
1324                 $select .= ' AND visibleold = 1';
1325             }
1326             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1327         }
1328     }
1329     return $resourcestotoggle;
1332 /**
1333  * Obtains shared data that is used in print_section when displaying a
1334  * course-module entry.
1335  *
1336  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1337  *
1338  * This data is also used in other areas of the code.
1339  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1340  * @param object $course Moodle course object
1341  * @return array An array with the following values in this order:
1342  *   $content (optional extra content for after link),
1343  *   $instancename (text of link)
1344  */
1345 function get_print_section_cm_text(cm_info $cm, $course) {
1346     global $OUTPUT;
1348     // Get content from modinfo if specified. Content displays either
1349     // in addition to the standard link (below), or replaces it if
1350     // the link is turned off by setting ->url to null.
1351     if (($content = $cm->get_content()) !== '') {
1352         // Improve filter performance by preloading filter setttings for all
1353         // activities on the course (this does nothing if called multiple
1354         // times)
1355         filter_preload_activities($cm->get_modinfo());
1357         // Get module context
1358         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1359         $labelformatoptions = new stdClass();
1360         $labelformatoptions->noclean = true;
1361         $labelformatoptions->overflowdiv = true;
1362         $labelformatoptions->context = $modulecontext;
1363         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1364     } else {
1365         $content = '';
1366     }
1368     // Get course context
1369     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1370     $stringoptions = new stdClass;
1371     $stringoptions->context = $coursecontext;
1372     $instancename = format_string($cm->name, true,  $stringoptions);
1373     return array($content, $instancename);
1376 /**
1377  * Prints a section full of activity modules
1378  */
1379 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn = false) {
1380     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1382     static $initialised;
1384     static $groupbuttons;
1385     static $groupbuttonslink;
1386     static $isediting;
1387     static $ismoving;
1388     static $strmovehere;
1389     static $strmovefull;
1390     static $strunreadpostsone;
1391     static $modulenames;
1393     if (!isset($initialised)) {
1394         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1395         $groupbuttonslink = (!$course->groupmodeforce);
1396         $isediting        = $PAGE->user_is_editing();
1397         $ismoving         = $isediting && ismoving($course->id);
1398         if ($ismoving) {
1399             $strmovehere  = get_string("movehere");
1400             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1401         }
1402         $modulenames      = array();
1403         $initialised = true;
1404     }
1406     $modinfo = get_fast_modinfo($course);
1407     $completioninfo = new completion_info($course);
1409     //Accessibility: replace table with list <ul>, but don't output empty list.
1410     if (!empty($section->sequence)) {
1412         // Fix bug #5027, don't want style=\"width:$width\".
1413         echo "<ul class=\"section img-text\">\n";
1414         $sectionmods = explode(",", $section->sequence);
1416         foreach ($sectionmods as $modnumber) {
1417             if (empty($mods[$modnumber])) {
1418                 continue;
1419             }
1421             /**
1422              * @var cm_info
1423              */
1424             $mod = $mods[$modnumber];
1426             if ($ismoving and $mod->id == $USER->activitycopy) {
1427                 // do not display moving mod
1428                 continue;
1429             }
1431             if (isset($modinfo->cms[$modnumber])) {
1432                 // We can continue (because it will not be displayed at all)
1433                 // if:
1434                 // 1) The activity is not visible to users
1435                 // and
1436                 // 2a) The 'showavailability' option is not set (if that is set,
1437                 //     we need to display the activity so we can show
1438                 //     availability info)
1439                 // or
1440                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1441                 //     hidden in a way that leaves no info, such as using the
1442                 //     eye icon.
1443                 if (!$modinfo->cms[$modnumber]->uservisible &&
1444                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1445                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1446                     // visibility shortcut
1447                     continue;
1448                 }
1449             } else {
1450                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1451                     // module not installed
1452                     continue;
1453                 }
1454                 if (!coursemodule_visible_for_user($mod) &&
1455                     empty($mod->showavailability)) {
1456                     // full visibility check
1457                     continue;
1458                 }
1459             }
1461             if (!isset($modulenames[$mod->modname])) {
1462                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1463             }
1464             $modulename = $modulenames[$mod->modname];
1466             // In some cases the activity is visible to user, but it is
1467             // dimmed. This is done if viewhiddenactivities is true and if:
1468             // 1. the activity is not visible, or
1469             // 2. the activity has dates set which do not include current, or
1470             // 3. the activity has any other conditions set (regardless of whether
1471             //    current user meets them)
1472             $canviewhidden = has_capability(
1473                 'moodle/course:viewhiddenactivities',
1474                 get_context_instance(CONTEXT_MODULE, $mod->id));
1475             $accessiblebutdim = false;
1476             if ($canviewhidden) {
1477                 $accessiblebutdim = !$mod->visible;
1478                 if (!empty($CFG->enableavailability)) {
1479                     $accessiblebutdim = $accessiblebutdim ||
1480                         $mod->availablefrom > time() ||
1481                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1482                         count($mod->conditionsgrade) > 0 ||
1483                         count($mod->conditionscompletion) > 0;
1484                 }
1485             }
1487             $liclasses = array();
1488             $liclasses[] = 'activity';
1489             $liclasses[] = $mod->modname;
1490             $liclasses[] = 'modtype_'.$mod->modname;
1491             $extraclasses = $mod->get_extra_classes();
1492             if ($extraclasses) {
1493                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1494             }
1495             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1496             if ($ismoving) {
1497                 echo '<a title="'.$strmovefull.'"'.
1498                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1499                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1500                      ' alt="'.$strmovehere.'" /></a><br />
1501                      ';
1502             }
1504             $classes = array('mod-indent');
1505             if (!empty($mod->indent)) {
1506                 $classes[] = 'mod-indent-'.$mod->indent;
1507                 if ($mod->indent > 15) {
1508                     $classes[] = 'mod-indent-huge';
1509                 }
1510             }
1511             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1513             // Get data about this course-module
1514             list($content, $instancename) =
1515                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1517             //Accessibility: for files get description via icon, this is very ugly hack!
1518             $altname = '';
1519             $altname = $mod->modfullname;
1520             if (!empty($customicon)) {
1521                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1522                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1523                     $mimetype = mimeinfo_from_icon('type', $customicon);
1524                     $altname = get_mimetype_description($mimetype);
1525                 }
1526             }
1527             // Avoid unnecessary duplication: if e.g. a forum name already
1528             // includes the word forum (or Forum, etc) then it is unhelpful
1529             // to include that in the accessible description that is added.
1530             if (false !== strpos(textlib::strtolower($instancename),
1531                     textlib::strtolower($altname))) {
1532                 $altname = '';
1533             }
1534             // File type after name, for alphabetic lists (screen reader).
1535             if ($altname) {
1536                 $altname = get_accesshide(' '.$altname);
1537             }
1539             // We may be displaying this just in order to show information
1540             // about visibility, without the actual link
1541             $contentpart = '';
1542             if ($mod->uservisible) {
1543                 // Nope - in this case the link is fully working for user
1544                 $linkclasses = '';
1545                 $textclasses = '';
1546                 if ($accessiblebutdim) {
1547                     $linkclasses .= ' dimmed';
1548                     $textclasses .= ' dimmed_text';
1549                     $accesstext = '<span class="accesshide">'.
1550                         get_string('hiddenfromstudents').': </span>';
1551                 } else {
1552                     $accesstext = '';
1553                 }
1554                 if ($linkclasses) {
1555                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1556                 } else {
1557                     $linkcss = '';
1558                 }
1559                 if ($textclasses) {
1560                     $textcss = 'class="' . trim($textclasses) . '" ';
1561                 } else {
1562                     $textcss = '';
1563                 }
1565                 // Get on-click attribute value if specified
1566                 $onclick = $mod->get_on_click();
1567                 if ($onclick) {
1568                     $onclick = ' onclick="' . $onclick . '"';
1569                 }
1571                 if ($url = $mod->get_url()) {
1572                     // Display link itself
1573                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1574                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1575                             '" class="activityicon" alt="' .
1576                             $modulename . '" /> ' .
1577                             $accesstext . '<span class="instancename">' .
1578                             $instancename . $altname . '</span></a>';
1580                     // If specified, display extra content after link
1581                     if ($content) {
1582                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1583                                 '">' . $content . '</div>';
1584                     }
1585                 } else {
1586                     // No link, so display only content
1587                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1588                             $accesstext . $content . '</div>';
1589                 }
1591                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1592                     $groupings = groups_get_all_groupings($course->id);
1593                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1594                 }
1595             } else {
1596                 $textclasses = $extraclasses;
1597                 $textclasses .= ' dimmed_text';
1598                 if ($textclasses) {
1599                     $textcss = 'class="' . trim($textclasses) . '" ';
1600                 } else {
1601                     $textcss = '';
1602                 }
1603                 $accesstext = '<span class="accesshide">' .
1604                         get_string('notavailableyet', 'condition') .
1605                         ': </span>';
1607                 if ($url = $mod->get_url()) {
1608                     // Display greyed-out text of link
1609                     echo '<div ' . $textcss . $mod->extra .
1610                             ' >' . '<img src="' . $mod->get_icon_url() .
1611                             '" class="activityicon" alt="' .
1612                             $modulename .
1613                             '" /> <span>'. $instancename . $altname .
1614                             '</span></div>';
1616                     // Do not display content after link when it is greyed out like this.
1617                 } else {
1618                     // No link, so display only content (also greyed)
1619                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1620                             $accesstext . $content . '</div>';
1621                 }
1622             }
1624             // Module can put text after the link (e.g. forum unread)
1625             echo $mod->get_after_link();
1627             // If there is content but NO link (eg label), then display the
1628             // content here (BEFORE any icons). In this case cons must be
1629             // displayed after the content so that it makes more sense visually
1630             // and for accessibility reasons, e.g. if you have a one-line label
1631             // it should work similarly (at least in terms of ordering) to an
1632             // activity.
1633             if (empty($url)) {
1634                 echo $contentpart;
1635             }
1637             if ($isediting) {
1638                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1639                     if (! $mod->groupmodelink = $groupbuttonslink) {
1640                         $mod->groupmode = $course->groupmode;
1641                     }
1643                 } else {
1644                     $mod->groupmode = false;
1645                 }
1646                 echo '&nbsp;&nbsp;';
1648                 if ($sectionreturn) {
1649                     echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1650                 } else {
1651                     echo make_editing_buttons($mod, $absolute, true, $mod->indent, 0);
1652                 }
1653                 echo $mod->get_after_edit_icons();
1654             }
1656             // Completion
1657             $completion = $hidecompletion
1658                 ? COMPLETION_TRACKING_NONE
1659                 : $completioninfo->is_enabled($mod);
1660             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1661                 !isguestuser() && $mod->uservisible) {
1662                 $completiondata = $completioninfo->get_data($mod,true);
1663                 $completionicon = '';
1664                 if ($isediting) {
1665                     switch ($completion) {
1666                         case COMPLETION_TRACKING_MANUAL :
1667                             $completionicon = 'manual-enabled'; break;
1668                         case COMPLETION_TRACKING_AUTOMATIC :
1669                             $completionicon = 'auto-enabled'; break;
1670                         default: // wtf
1671                     }
1672                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1673                     switch($completiondata->completionstate) {
1674                         case COMPLETION_INCOMPLETE:
1675                             $completionicon = 'manual-n'; break;
1676                         case COMPLETION_COMPLETE:
1677                             $completionicon = 'manual-y'; break;
1678                     }
1679                 } else { // Automatic
1680                     switch($completiondata->completionstate) {
1681                         case COMPLETION_INCOMPLETE:
1682                             $completionicon = 'auto-n'; break;
1683                         case COMPLETION_COMPLETE:
1684                             $completionicon = 'auto-y'; break;
1685                         case COMPLETION_COMPLETE_PASS:
1686                             $completionicon = 'auto-pass'; break;
1687                         case COMPLETION_COMPLETE_FAIL:
1688                             $completionicon = 'auto-fail'; break;
1689                     }
1690                 }
1691                 if ($completionicon) {
1692                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1693                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion', $mod->name));
1694                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1695                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion', $mod->name));
1696                         $newstate =
1697                             $completiondata->completionstate==COMPLETION_COMPLETE
1698                             ? COMPLETION_INCOMPLETE
1699                             : COMPLETION_COMPLETE;
1700                         // In manual mode the icon is a toggle form...
1702                         // If this completion state is used by the
1703                         // conditional activities system, we need to turn
1704                         // off the JS.
1705                         if (!empty($CFG->enableavailability) &&
1706                             condition_info::completion_value_used_as_condition($course, $mod)) {
1707                             $extraclass = ' preventjs';
1708                         } else {
1709                             $extraclass = '';
1710                         }
1711                         echo "
1712 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1713 <input type='hidden' name='id' value='{$mod->id}' />
1714 <input type='hidden' name='modulename' value='".s($mod->name)."' />
1715 <input type='hidden' name='sesskey' value='".sesskey()."' />
1716 <input type='hidden' name='completionstate' value='$newstate' />
1717 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1718 </div></form>";
1719                     } else {
1720                         // In auto mode, or when editing, the icon is just an image
1721                         echo "<span class='autocompletion'>";
1722                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1723                     }
1724                 }
1725             }
1727             // If there is content AND a link, then display the content here
1728             // (AFTER any icons). Otherwise it was displayed before
1729             if (!empty($url)) {
1730                 echo $contentpart;
1731             }
1733             // Show availability information (for someone who isn't allowed to
1734             // see the activity itself, or for staff)
1735             if (!$mod->uservisible) {
1736                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1737             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1738                 $ci = new condition_info($mod);
1739                 $fullinfo = $ci->get_full_information();
1740                 if($fullinfo) {
1741                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1742                         ? 'userrestriction_visible'
1743                         : 'userrestriction_hidden','condition',
1744                         $fullinfo).'</div>';
1745                 }
1746             }
1748             echo html_writer::end_tag('div');
1749             echo html_writer::end_tag('li')."\n";
1750         }
1752     } elseif ($ismoving) {
1753         echo "<ul class=\"section\">\n";
1754     }
1756     if ($ismoving) {
1757         echo '<li><a title="'.$strmovefull.'"'.
1758              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1759              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1760              ' alt="'.$strmovehere.'" /></a></li>
1761              ';
1762     }
1763     if (!empty($section->sequence) || $ismoving) {
1764         echo "</ul><!--class='section'-->\n\n";
1765     }
1768 /**
1769  * Prints the menus to add activities and resources.
1770  */
1771 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1772     global $CFG, $OUTPUT;
1774     // check to see if user can add menus
1775     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1776         return false;
1777     }
1779     // Retrieve all modules with associated metadata
1780     $modules = get_module_metadata($course, $modnames);
1782     // We'll sort resources and activities into two lists
1783     $resources = array();
1784     $activities = array();
1786     // We need to add the section section to the link for each module
1787     $sectionlink = '&section=' . $section;
1789     foreach ($modules as $module) {
1790         if (isset($module->types)) {
1791             // This module has a subtype
1792             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1793             $subtypes = array();
1794             foreach ($module->types as $subtype) {
1795                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1796             }
1798             // Sort module subtypes into the list
1799             if (!empty($module->title)) {
1800                 // This grouping has a name
1801                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1802                     $resources[] = array($module->title=>$subtypes);
1803                 } else {
1804                     $activities[] = array($module->title=>$subtypes);
1805                 }
1806             } else {
1807                 // This grouping does not have a name
1808                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1809                     $resources = array_merge($resources, $subtypes);
1810                 } else {
1811                     $activities = array_merge($activities, $subtypes);
1812                 }
1813             }
1814         } else {
1815             // This module has no subtypes
1816             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1817                 $resources[$module->link . $sectionlink] = $module->title;
1818             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1819                 // System modules cannot be added by user, do not add to dropdown
1820             } else {
1821                 $activities[$module->link . $sectionlink] = $module->title;
1822             }
1823         }
1824     }
1826     $straddactivity = get_string('addactivity');
1827     $straddresource = get_string('addresource');
1829     $output  = '<div class="section_add_menus">';
1831     if (!$vertical) {
1832         $output .= '<div class="horizontal">';
1833     }
1835     if (!empty($resources)) {
1836         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1837         $select->set_help_icon('resources');
1838         $output .= $OUTPUT->render($select);
1839     }
1841     if (!empty($activities)) {
1842         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1843         $select->set_help_icon('activities');
1844         $output .= $OUTPUT->render($select);
1845     }
1847     if (!$vertical) {
1848         $output .= '</div>';
1849     }
1851     $output .= '</div>';
1853     if ($return) {
1854         return $output;
1855     } else {
1856         echo $output;
1857     }
1860 /**
1861  * Retrieve all metadata for the requested modules
1862  *
1863  * @param object $course The Course
1864  * @param array $modnames An array containing the list of modules and their
1865  * names
1866  * @return array A list of stdClass objects containing metadata about each
1867  * module
1868  */
1869 function get_module_metadata($course, $modnames) {
1870     global $CFG, $OUTPUT;
1872     // get_module_metadata will be called once per section on the page and courses may show
1873     // different modules to one another
1874     static $modlist = array();
1875     if (!isset($modlist[$course->id])) {
1876         $modlist[$course->id] = array();
1877     }
1879     $return = array();
1880     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&add=';
1881     foreach($modnames as $modname => $modnamestr) {
1882         if (!course_allowed_module($course, $modname)) {
1883             continue;
1884         }
1885         if (isset($modlist[$modname])) {
1886             // This module is already cached
1887             $return[$modname] = $modlist[$course->id][$modname];
1888             continue;
1889         }
1891         // Include the module lib
1892         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1893         if (!file_exists($libfile)) {
1894             continue;
1895         }
1896         include_once($libfile);
1898         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1899         $gettypesfunc =  $modname.'_get_types';
1900         if (function_exists($gettypesfunc)) {
1901             if ($types = $gettypesfunc()) {
1902                 $group = new stdClass();
1903                 $group->name = $modname;
1904                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1905                 foreach($types as $type) {
1906                     if ($type->typestr === '--') {
1907                         continue;
1908                     }
1909                     if (strpos($type->typestr, '--') === 0) {
1910                         $group->title = str_replace('--', '', $type->typestr);
1911                         continue;
1912                     }
1913                     // Set the Sub Type metadata
1914                     $subtype = new stdClass();
1915                     $subtype->title = $type->typestr;
1916                     $subtype->type = str_replace('&amp;', '&', $type->type);
1917                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1918                     $subtype->archetype = $type->modclass;
1920                     // The group archetype should match the subtype archetypes and all subtypes
1921                     // should have the same archetype
1922                     $group->archetype = $subtype->archetype;
1924                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1925                         $subtype->help = get_string('help' . $subtype->name, $modname);
1926                     }
1927                     $subtype->link = $urlbase . $subtype->type;
1928                     $group->types[] = $subtype;
1929                 }
1930                 $modlist[$course->id][$modname] = $group;
1931             }
1932         } else {
1933             $module = new stdClass();
1934             $module->title = get_string('modulename', $modname);
1935             $module->name = $modname;
1936             $module->link = $urlbase . $modname;
1937             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1938             if (get_string_manager()->string_exists('modulename_help', $modname)) {
1939                 $module->help = get_string('modulename_help', $modname);
1940             }
1941             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1942             $modlist[$course->id][$modname] = $module;
1943         }
1944         $return[$modname] = $modlist[$course->id][$modname];
1945     }
1947     return $return;
1950 /**
1951  * Return the course category context for the category with id $categoryid, except
1952  * that if $categoryid is 0, return the system context.
1953  *
1954  * @param integer $categoryid a category id or 0.
1955  * @return object the corresponding context
1956  */
1957 function get_category_or_system_context($categoryid) {
1958     if ($categoryid) {
1959         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1960     } else {
1961         return get_context_instance(CONTEXT_SYSTEM);
1962     }
1965 /**
1966  * Gets the child categories of a given courses category. Uses a static cache
1967  * to make repeat calls efficient.
1968  *
1969  * @param int $parentid the id of a course category.
1970  * @return array all the child course categories.
1971  */
1972 function get_child_categories($parentid) {
1973     static $allcategories = null;
1975     // only fill in this variable the first time
1976     if (null == $allcategories) {
1977         $allcategories = array();
1979         $categories = get_categories();
1980         foreach ($categories as $category) {
1981             if (empty($allcategories[$category->parent])) {
1982                 $allcategories[$category->parent] = array();
1983             }
1984             $allcategories[$category->parent][] = $category;
1985         }
1986     }
1988     if (empty($allcategories[$parentid])) {
1989         return array();
1990     } else {
1991         return $allcategories[$parentid];
1992     }
1995 /**
1996  * This function recursively travels the categories, building up a nice list
1997  * for display. It also makes an array that list all the parents for each
1998  * category.
1999  *
2000  * For example, if you have a tree of categories like:
2001  *   Miscellaneous (id = 1)
2002  *      Subcategory (id = 2)
2003  *         Sub-subcategory (id = 4)
2004  *   Other category (id = 3)
2005  * Then after calling this function you will have
2006  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2007  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2008  *      3 => 'Other category');
2009  * $parents = array(2 => array(1), 4 => array(1, 2));
2010  *
2011  * If you specify $requiredcapability, then only categories where the current
2012  * user has that capability will be added to $list, although all categories
2013  * will still be added to $parents, and if you only have $requiredcapability
2014  * in a child category, not the parent, then the child catgegory will still be
2015  * included.
2016  *
2017  * If you specify the option $excluded, then that category, and all its children,
2018  * are omitted from the tree. This is useful when you are doing something like
2019  * moving categories, where you do not want to allow people to move a category
2020  * to be the child of itself.
2021  *
2022  * @param array $list For output, accumulates an array categoryid => full category path name
2023  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2024  * @param string/array $requiredcapability if given, only categories where the current
2025  *      user has this capability will be added to $list. Can also be an array of capabilities,
2026  *      in which case they are all required.
2027  * @param integer $excludeid Omit this category and its children from the lists built.
2028  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2029  * @param string $path For internal use, as part of recursive calls.
2030  */
2031 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2032         $excludeid = 0, $category = NULL, $path = "") {
2034     // initialize the arrays if needed
2035     if (!is_array($list)) {
2036         $list = array();
2037     }
2038     if (!is_array($parents)) {
2039         $parents = array();
2040     }
2042     if (empty($category)) {
2043         // Start at the top level.
2044         $category = new stdClass;
2045         $category->id = 0;
2046     } else {
2047         // This is the excluded category, don't include it.
2048         if ($excludeid > 0 && $excludeid == $category->id) {
2049             return;
2050         }
2052         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2053         $categoryname = format_string($category->name, true, array('context' => $context));
2055         // Update $path.
2056         if ($path) {
2057             $path = $path.' / '.$categoryname;
2058         } else {
2059             $path = $categoryname;
2060         }
2062         // Add this category to $list, if the permissions check out.
2063         if (empty($requiredcapability)) {
2064             $list[$category->id] = $path;
2066         } else {
2067             $requiredcapability = (array)$requiredcapability;
2068             if (has_all_capabilities($requiredcapability, $context)) {
2069                 $list[$category->id] = $path;
2070             }
2071         }
2072     }
2074     // Add all the children recursively, while updating the parents array.
2075     if ($categories = get_child_categories($category->id)) {
2076         foreach ($categories as $cat) {
2077             if (!empty($category->id)) {
2078                 if (isset($parents[$category->id])) {
2079                     $parents[$cat->id]   = $parents[$category->id];
2080                 }
2081                 $parents[$cat->id][] = $category->id;
2082             }
2083             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2084         }
2085     }
2088 /**
2089  * This function generates a structured array of courses and categories.
2090  *
2091  * The depth of categories is limited by $CFG->maxcategorydepth however there
2092  * is no limit on the number of courses!
2093  *
2094  * Suitable for use with the course renderers course_category_tree method:
2095  * $renderer = $PAGE->get_renderer('core','course');
2096  * echo $renderer->course_category_tree(get_course_category_tree());
2097  *
2098  * @global moodle_database $DB
2099  * @param int $id
2100  * @param int $depth
2101  */
2102 function get_course_category_tree($id = 0, $depth = 0) {
2103     global $DB, $CFG;
2104     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2105     $categories = get_child_categories($id);
2106     $categoryids = array();
2107     foreach ($categories as $key => &$category) {
2108         if (!$category->visible && !$viewhiddencats) {
2109             unset($categories[$key]);
2110             continue;
2111         }
2112         $categoryids[$category->id] = $category;
2113         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2114             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2115             foreach ($subcategories as $subid=>$subcat) {
2116                 $categoryids[$subid] = $subcat;
2117             }
2118             $category->courses = array();
2119         }
2120     }
2122     if ($depth > 0) {
2123         // This is a recursive call so return the required array
2124         return array($categories, $categoryids);
2125     }
2127     // The depth is 0 this function has just been called so we can finish it off
2129     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2130     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2131     $sql = "SELECT
2132             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2133             $ccselect
2134             FROM {course} c
2135             $ccjoin
2136             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2137     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2138         // loop throught them
2139         foreach ($courses as $course) {
2140             if ($course->id == SITEID) {
2141                 continue;
2142             }
2143             context_instance_preload($course);
2144             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2145                 $categoryids[$course->category]->courses[$course->id] = $course;
2146             }
2147         }
2148     }
2149     return $categories;
2152 /**
2153  * Recursive function to print out all the categories in a nice format
2154  * with or without courses included
2155  */
2156 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2157     global $CFG;
2159     // maxcategorydepth == 0 meant no limit
2160     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2161         return;
2162     }
2164     if (!$displaylist) {
2165         make_categories_list($displaylist, $parentslist);
2166     }
2168     if ($category) {
2169         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2170             print_category_info($category, $depth, $showcourses);
2171         } else {
2172             return;  // Don't bother printing children of invisible categories
2173         }
2175     } else {
2176         $category = new stdClass();
2177         $category->id = "0";
2178     }
2180     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2181         $countcats = count($categories);
2182         $count = 0;
2183         $first = true;
2184         $last = false;
2185         foreach ($categories as $cat) {
2186             $count++;
2187             if ($count == $countcats) {
2188                 $last = true;
2189             }
2190             $up = $first ? false : true;
2191             $down = $last ? false : true;
2192             $first = false;
2194             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2195         }
2196     }
2199 /**
2200  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2201  */
2202 function make_categories_options() {
2203     make_categories_list($cats,$parents);
2204     foreach ($cats as $key => $value) {
2205         if (array_key_exists($key,$parents)) {
2206             if ($indent = count($parents[$key])) {
2207                 for ($i = 0; $i < $indent; $i++) {
2208                     $cats[$key] = '&nbsp;'.$cats[$key];
2209                 }
2210             }
2211         }
2212     }
2213     return $cats;
2216 /**
2217  * Gets the name of a course to be displayed when showing a list of courses.
2218  * By default this is just $course->fullname but user can configure it. The
2219  * result of this function should be passed through print_string.
2220  * @param object $course Moodle course object
2221  * @return string Display name of course (either fullname or short + fullname)
2222  */
2223 function get_course_display_name_for_list($course) {
2224     global $CFG;
2225     if (!empty($CFG->courselistshortnames)) {
2226         return $course->shortname . ' ' .$course->fullname;
2227     } else {
2228         return $course->fullname;
2229     }
2232 /**
2233  * Prints the category info in indented fashion
2234  * This function is only used by print_whole_category_list() above
2235  */
2236 function print_category_info($category, $depth=0, $showcourses = false) {
2237     global $CFG, $DB, $OUTPUT;
2239     $strsummary = get_string('summary');
2241     $catlinkcss = null;
2242     if (!$category->visible) {
2243         $catlinkcss = array('class'=>'dimmed');
2244     }
2245     static $coursecount = null;
2246     if (null === $coursecount) {
2247         // only need to check this once
2248         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2249     }
2251     if ($showcourses and $coursecount) {
2252         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2253     } else {
2254         $catimage = "&nbsp;";
2255     }
2257     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2258     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2259     $fullname = format_string($category->name, true, array('context' => $context));
2261     if ($showcourses and $coursecount) {
2262         echo '<div class="categorylist clearfix">';
2263         $cat = '';
2264         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2265         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2266         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2268         $html = '';
2269         if ($depth > 0) {
2270             for ($i=0; $i< $depth; $i++) {
2271                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2272                 $cat = '';
2273             }
2274         } else {
2275             $html = $cat;
2276         }
2277         echo html_writer::tag('div', $html, array('class'=>'category'));
2278         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2280         // does the depth exceed maxcategorydepth
2281         // maxcategorydepth == 0 or unset meant no limit
2282         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2283         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2284             foreach ($courses as $course) {
2285                 $linkcss = null;
2286                 if (!$course->visible) {
2287                     $linkcss = array('class'=>'dimmed');
2288                 }
2290                 $coursename = get_course_display_name_for_list($course);
2291                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2293                 // print enrol info
2294                 $courseicon = '';
2295                 if ($icons = enrol_get_course_info_icons($course)) {
2296                     foreach ($icons as $pix_icon) {
2297                         $courseicon = $OUTPUT->render($pix_icon).' ';
2298                     }
2299                 }
2301                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2303                 if ($course->summary) {
2304                     $link = new moodle_url('/course/info.php?id='.$course->id);
2305                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2306                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2307                         array('title'=>$strsummary));
2309                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2310                 }
2312                 $html = '';
2313                 for ($i=0; $i <= $depth; $i++) {
2314                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2315                     $coursecontent = '';
2316                 }
2317                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2318             }
2319         }
2320         echo '</div>';
2321     } else {
2322         echo '<div class="categorylist">';
2323         $html = '';
2324         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2325         if (count($courses) > 0) {
2326             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2327         }
2329         if ($depth > 0) {
2330             for ($i=0; $i< $depth; $i++) {
2331                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2332                 $cat = '';
2333             }
2334         } else {
2335             $html = $cat;
2336         }
2338         echo html_writer::tag('div', $html, array('class'=>'category'));
2339         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2340         echo '</div>';
2341     }
2344 /**
2345  * Print the buttons relating to course requests.
2346  *
2347  * @param object $systemcontext the system context.
2348  */
2349 function print_course_request_buttons($systemcontext) {
2350     global $CFG, $DB, $OUTPUT;
2351     if (empty($CFG->enablecourserequests)) {
2352         return;
2353     }
2354     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2355     /// Print a button to request a new course
2356         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2357     }
2358     /// Print a button to manage pending requests
2359     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2360         $disabled = !$DB->record_exists('course_request', array());
2361         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2362     }
2365 /**
2366  * Does the user have permission to edit things in this category?
2367  *
2368  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2369  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2370  */
2371 function can_edit_in_category($categoryid = 0) {
2372     $context = get_category_or_system_context($categoryid);
2373     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2376 /**
2377  * Prints the turn editing on/off button on course/index.php or course/category.php.
2378  *
2379  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2380  * @return string HTML of the editing button, or empty string, if this user is not allowed
2381  *      to see it.
2382  */
2383 function update_category_button($categoryid = 0) {
2384     global $CFG, $PAGE, $OUTPUT;
2386     // Check permissions.
2387     if (!can_edit_in_category($categoryid)) {
2388         return '';
2389     }
2391     // Work out the appropriate action.
2392     if ($PAGE->user_is_editing()) {
2393         $label = get_string('turneditingoff');
2394         $edit = 'off';
2395     } else {
2396         $label = get_string('turneditingon');
2397         $edit = 'on';
2398     }
2400     // Generate the button HTML.
2401     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2402     if ($categoryid) {
2403         $options['id'] = $categoryid;
2404         $page = 'category.php';
2405     } else {
2406         $page = 'index.php';
2407     }
2408     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2411 /**
2412  * Category is 0 (for all courses) or an object
2413  */
2414 function print_courses($category) {
2415     global $CFG, $OUTPUT;
2417     if (!is_object($category) && $category==0) {
2418         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2419         if (is_array($categories) && count($categories) == 1) {
2420             $category   = array_shift($categories);
2421             $courses    = get_courses_wmanagers($category->id,
2422                                                 'c.sortorder ASC',
2423                                                 array('summary','summaryformat'));
2424         } else {
2425             $courses    = get_courses_wmanagers('all',
2426                                                 'c.sortorder ASC',
2427                                                 array('summary','summaryformat'));
2428         }
2429         unset($categories);
2430     } else {
2431         $courses    = get_courses_wmanagers($category->id,
2432                                             'c.sortorder ASC',
2433                                             array('summary','summaryformat'));
2434     }
2436     if ($courses) {
2437         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2438         foreach ($courses as $course) {
2439             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2440             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2441                 echo html_writer::start_tag('li');
2442                 print_course($course);
2443                 echo html_writer::end_tag('li');
2444             }
2445         }
2446         echo html_writer::end_tag('ul');
2447     } else {
2448         echo $OUTPUT->heading(get_string("nocoursesyet"));
2449         $context = get_context_instance(CONTEXT_SYSTEM);
2450         if (has_capability('moodle/course:create', $context)) {
2451             $options = array();
2452             if (!empty($category->id)) {
2453                 $options['category'] = $category->id;
2454             } else {
2455                 $options['category'] = $CFG->defaultrequestcategory;
2456             }
2457             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2458             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2459             echo html_writer::end_tag('div');
2460         }
2461     }
2464 /**
2465  * Print a description of a course, suitable for browsing in a list.
2466  *
2467  * @param object $course the course object.
2468  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2469  */
2470 function print_course($course, $highlightterms = '') {
2471     global $CFG, $USER, $DB, $OUTPUT;
2473     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2475     // Rewrite file URLs so that they are correct
2476     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2478     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2479     echo html_writer::start_tag('div', array('class'=>'info'));
2480     echo html_writer::start_tag('h3', array('class'=>'name'));
2482     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2484     $coursename = get_course_display_name_for_list($course);
2485     $linktext = highlight($highlightterms, format_string($coursename));
2486     $linkparams = array('title'=>get_string('entercourse'));
2487     if (empty($course->visible)) {
2488         $linkparams['class'] = 'dimmed';
2489     }
2490     echo html_writer::link($linkhref, $linktext, $linkparams);
2491     echo html_writer::end_tag('h3');
2493     /// first find all roles that are supposed to be displayed
2494     if (!empty($CFG->coursecontact)) {
2495         $managerroles = explode(',', $CFG->coursecontact);
2496         $namesarray = array();
2497         $rusers = array();
2499         if (!isset($course->managers)) {
2500             $rusers = get_role_users($managerroles, $context, true,
2501                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2502                  r.name AS rolename, r.sortorder, r.id AS roleid',
2503                 'r.sortorder ASC, u.lastname ASC');
2504         } else {
2505             //  use the managers array if we have it for perf reasosn
2506             //  populate the datastructure like output of get_role_users();
2507             foreach ($course->managers as $manager) {
2508                 $u = new stdClass();
2509                 $u = $manager->user;
2510                 $u->roleid = $manager->roleid;
2511                 $u->rolename = $manager->rolename;
2513                 $rusers[] = $u;
2514             }
2515         }
2517         /// Rename some of the role names if needed
2518         if (isset($context)) {
2519             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2520         }
2522         $namesarray = array();
2523         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2524         foreach ($rusers as $ra) {
2525             if (isset($namesarray[$ra->id])) {
2526                 //  only display a user once with the higest sortorder role
2527                 continue;
2528             }
2530             if (isset($aliasnames[$ra->roleid])) {
2531                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2532             }
2534             $fullname = fullname($ra, $canviewfullnames);
2535             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2536                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2537         }
2539         if (!empty($namesarray)) {
2540             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2541             foreach ($namesarray as $name) {
2542                 echo html_writer::tag('li', $name);
2543             }
2544             echo html_writer::end_tag('ul');
2545         }
2546     }
2547     echo html_writer::end_tag('div'); // End of info div
2549     echo html_writer::start_tag('div', array('class'=>'summary'));
2550     $options = new stdClass();
2551     $options->noclean = true;
2552     $options->para = false;
2553     $options->overflowdiv = true;
2554     if (!isset($course->summaryformat)) {
2555         $course->summaryformat = FORMAT_MOODLE;
2556     }
2557     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2558     if ($icons = enrol_get_course_info_icons($course)) {
2559         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2560         foreach ($icons as $icon) {
2561             echo $OUTPUT->render($icon);
2562         }
2563         echo html_writer::end_tag('div'); // End of enrolmenticons div
2564     }
2565     echo html_writer::end_tag('div'); // End of summary div
2566     echo html_writer::end_tag('div'); // End of coursebox div
2569 /**
2570  * Prints custom user information on the home page.
2571  * Over time this can include all sorts of information
2572  */
2573 function print_my_moodle() {
2574     global $USER, $CFG, $DB, $OUTPUT;
2576     if (!isloggedin() or isguestuser()) {
2577         print_error('nopermissions', '', '', 'See My Moodle');
2578     }
2580     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2581     $rhosts   = array();
2582     $rcourses = array();
2583     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2584         $rcourses = get_my_remotecourses($USER->id);
2585         $rhosts   = get_my_remotehosts();
2586     }
2588     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2590         if (!empty($courses)) {
2591             echo '<ul class="unlist">';
2592             foreach ($courses as $course) {
2593                 if ($course->id == SITEID) {
2594                     continue;
2595                 }
2596                 echo '<li>';
2597                 print_course($course);
2598                 echo "</li>\n";
2599             }
2600             echo "</ul>\n";
2601         }
2603         // MNET
2604         if (!empty($rcourses)) {
2605             // at the IDP, we know of all the remote courses
2606             foreach ($rcourses as $course) {
2607                 print_remote_course($course, "100%");
2608             }
2609         } elseif (!empty($rhosts)) {
2610             // non-IDP, we know of all the remote servers, but not courses
2611             foreach ($rhosts as $host) {
2612                 print_remote_host($host, "100%");
2613             }
2614         }
2615         unset($course);
2616         unset($host);
2618         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2619             echo "<table width=\"100%\"><tr><td align=\"center\">";
2620             print_course_search("", false, "short");
2621             echo "</td><td align=\"center\">";
2622             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2623             echo "</td></tr></table>\n";
2624         }
2626     } else {
2627         if ($DB->count_records("course_categories") > 1) {
2628             echo $OUTPUT->box_start("categorybox");
2629             print_whole_category_list();
2630             echo $OUTPUT->box_end();
2631         } else {
2632             print_courses(0);
2633         }
2634     }
2638 function print_course_search($value="", $return=false, $format="plain") {
2639     global $CFG;
2640     static $count = 0;
2642     $count++;
2644     $id = 'coursesearch';
2646     if ($count > 1) {
2647         $id .= $count;
2648     }
2650     $strsearchcourses= get_string("searchcourses");
2652     if ($format == 'plain') {
2653         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2654         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2655         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2656         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2657         $output .= '<input type="submit" value="'.get_string('go').'" />';
2658         $output .= '</fieldset></form>';
2659     } else if ($format == 'short') {
2660         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2661         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2662         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2663         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2664         $output .= '<input type="submit" value="'.get_string('go').'" />';
2665         $output .= '</fieldset></form>';
2666     } else if ($format == 'navbar') {
2667         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2668         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2669         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2670         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2671         $output .= '<input type="submit" value="'.get_string('go').'" />';
2672         $output .= '</fieldset></form>';
2673     }
2675     if ($return) {
2676         return $output;
2677     }
2678     echo $output;
2681 function print_remote_course($course, $width="100%") {
2682     global $CFG, $USER;
2684     $linkcss = '';
2686     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2688     echo '<div class="coursebox remotecoursebox clearfix">';
2689     echo '<div class="info">';
2690     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2691          $linkcss.' href="'.$url.'">'
2692         .  format_string($course->fullname) .'</a><br />'
2693         . format_string($course->hostname) . ' : '
2694         . format_string($course->cat_name) . ' : '
2695         . format_string($course->shortname). '</div>';
2696     echo '</div><div class="summary">';
2697     $options = new stdClass();
2698     $options->noclean = true;
2699     $options->para = false;
2700     $options->overflowdiv = true;
2701     echo format_text($course->summary, $course->summaryformat, $options);
2702     echo '</div>';
2703     echo '</div>';
2706 function print_remote_host($host, $width="100%") {
2707     global $OUTPUT;
2709     $linkcss = '';
2711     echo '<div class="coursebox clearfix">';
2712     echo '<div class="info">';
2713     echo '<div class="name">';
2714     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2715     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2716         . s($host['name']).'</a> - ';
2717     echo $host['count'] . ' ' . get_string('courses');
2718     echo '</div>';
2719     echo '</div>';
2720     echo '</div>';
2724 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2726 function add_course_module($mod) {
2727     global $DB;
2729     $mod->added = time();
2730     unset($mod->id);
2732     return $DB->insert_record("course_modules", $mod);
2735 /**
2736  * Returns course section - creates new if does not exist yet.
2737  * @param int $relative section number
2738  * @param int $courseid
2739  * @return object $course_section object
2740  */
2741 function get_course_section($section, $courseid) {
2742     global $DB;
2744     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2745         return $cw;
2746     }
2747     $cw = new stdClass();
2748     $cw->course   = $courseid;
2749     $cw->section  = $section;
2750     $cw->summary  = "";
2751     $cw->summaryformat = FORMAT_HTML;
2752     $cw->sequence = "";
2753     $id = $DB->insert_record("course_sections", $cw);
2754     rebuild_course_cache($courseid, true);
2755     return $DB->get_record("course_sections", array("id"=>$id));
2758 /**
2759  * Given a full mod object with section and course already defined, adds this module to that section.
2760  *
2761  * @param object $mod
2762  * @param int $beforemod An existing ID which we will insert the new module before
2763  * @return int The course_sections ID where the mod is inserted
2764  */
2765 function add_mod_to_section($mod, $beforemod=NULL) {
2766     global $DB;
2768     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2770         $section->sequence = trim($section->sequence);
2772         if (empty($section->sequence)) {
2773             $newsequence = "$mod->coursemodule";
2775         } else if ($beforemod) {
2776             $modarray = explode(",", $section->sequence);
2778             if ($key = array_keys($modarray, $beforemod->id)) {
2779                 $insertarray = array($mod->id, $beforemod->id);
2780                 array_splice($modarray, $key[0], 1, $insertarray);
2781                 $newsequence = implode(",", $modarray);
2783             } else {  // Just tack it on the end anyway
2784                 $newsequence = "$section->sequence,$mod->coursemodule";
2785             }
2787         } else {
2788             $newsequence = "$section->sequence,$mod->coursemodule";
2789         }
2791         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2792         return $section->id;     // Return course_sections ID that was used.
2794     } else {  // Insert a new record
2795         $section = new stdClass();
2796         $section->course   = $mod->course;
2797         $section->section  = $mod->section;
2798         $section->summary  = "";
2799         $section->summaryformat = FORMAT_HTML;
2800         $section->sequence = $mod->coursemodule;
2801         return $DB->insert_record("course_sections", $section);
2802     }
2805 function set_coursemodule_groupmode($id, $groupmode) {
2806     global $DB;
2807     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2810 function set_coursemodule_idnumber($id, $idnumber) {
2811     global $DB;
2812     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2815 /**
2816 * $prevstateoverrides = true will set the visibility of the course module
2817 * to what is defined in visibleold. This enables us to remember the current
2818 * visibility when making a whole section hidden, so that when we toggle
2819 * that section back to visible, we are able to return the visibility of
2820 * the course module back to what it was originally.
2821 */
2822 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2823     global $DB, $CFG;
2824     require_once($CFG->libdir.'/gradelib.php');
2826     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2827         return false;
2828     }
2829     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2830         return false;
2831     }
2832     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2833         foreach($events as $event) {
2834             if ($visible) {
2835                 show_event($event);
2836             } else {
2837                 hide_event($event);
2838             }
2839         }
2840     }
2842     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2843     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2844     if ($grade_items) {
2845         foreach ($grade_items as $grade_item) {
2846             $grade_item->set_hidden(!$visible);
2847         }
2848     }
2850     if ($prevstateoverrides) {
2851         if ($visible == '0') {
2852             // Remember the current visible state so we can toggle this back.
2853             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2854         } else {
2855             // Get the previous saved visible states.
2856             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2857         }
2858     }
2859     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2862 /**
2863  * Delete a course module and any associated data at the course level (events)
2864  * Until 1.5 this function simply marked a deleted flag ... now it
2865  * deletes it completely.
2866  *
2867  */
2868 function delete_course_module($id) {
2869     global $CFG, $DB;
2870     require_once($CFG->libdir.'/gradelib.php');
2871     require_once($CFG->dirroot.'/blog/lib.php');
2873     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2874         return true;
2875     }
2876     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2877     //delete events from calendar
2878     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2879         foreach($events as $event) {
2880             delete_event($event->id);
2881         }
2882     }
2883     //delete grade items, outcome items and grades attached to modules
2884     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2885                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2886         foreach ($grade_items as $grade_item) {
2887             $grade_item->delete('moddelete');
2888         }
2889     }
2890     // Delete completion and availability data; it is better to do this even if the
2891     // features are not turned on, in case they were turned on previously (these will be
2892     // very quick on an empty table)
2893     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2894     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2895     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2896                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2898     delete_context(CONTEXT_MODULE, $cm->id);
2899     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2902 function delete_mod_from_section($mod, $section) {
2903     global $DB;
2905     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2907         $modarray = explode(",", $section->sequence);
2909         if ($key = array_keys ($modarray, $mod)) {
2910             array_splice($modarray, $key[0], 1);
2911             $newsequence = implode(",", $modarray);
2912             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2913         } else {
2914             return false;
2915         }
2917     }
2918     return false;
2921 /**
2922  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2923  *
2924  * @param object $course course object
2925  * @param int $section Section number (not id!!!)
2926  * @param int $move (-1 or 1)
2927  * @return boolean true if section moved successfully
2928  */
2929 function move_section($course, $section, $move) {
2930 /// Moves a whole course section up and down within the course
2931     global $USER, $DB;
2933     if (!$move) {
2934         return true;
2935     }
2937     $sectiondest = $section + $move;
2939     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2940         return false;
2941     }
2943     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2944         return false;
2945     }
2947     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2948         return false;
2949     }
2951     // Three-step change ensures that the section always remains unique (there is
2952     // a unique index now)
2953     $DB->set_field("course_sections", "section", -$sectiondest, array("id"=>$sectionrecord->id));
2954     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2955     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2957     // Update highlighting if the move affects highlighted section
2958     if ($course->marker == $section) {
2959         course_set_marker($course->id, $sectiondest);
2960     } elseif ($course->marker == $sectiondest) {
2961         course_set_marker($course->id, $section);
2962     }
2965     // Fix order if needed. The database prevents duplicate sections, but it is
2966     // possible there could be a gap in the numbering.
2967     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2968     $n = 0;
2969     foreach ($sections as $section) {
2970         if ($section->section != $n) {
2971             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2972         }
2973         $n++;
2974     }
2975     return true;
2978 /**
2979  * Moves a section within a course, from a position to another.
2980  * Be very careful: $section and $destination refer to section number,
2981  * not id!.
2982  *
2983  * @param object $course
2984  * @param int $section Section number (not id!!!)
2985  * @param int $destination
2986  * @return boolean Result
2987  */
2988 function move_section_to($course, $section, $destination) {
2989 /// Moves a whole course section up and down within the course
2990     global $USER, $DB;
2992     if (!$destination && $destination != 0) {
2993         return true;
2994     }
2996     if ($destination > $course->numsections) {
2997         return false;
2998     }
3000     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3001     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3002             'section ASC, id ASC', 'id, section')) {
3003         return false;
3004     }
3006     $movedsections = reorder_sections($sections, $section, $destination);
3008     // Update all sections. Do this in 2 steps to avoid breaking database
3009     // uniqueness constraint
3010     $transaction = $DB->start_delegated_transaction();
3011     foreach ($movedsections as $id => $position) {
3012         if ($sections[$id] !== $position) {
3013             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3014         }
3015     }
3016     foreach ($movedsections as $id => $position) {
3017         if ($sections[$id] !== $position) {
3018             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3019         }
3020     }
3022     // Adjust destination to reflect the actual section
3023     $moveup = false;
3024     if ($section > $destination) {
3025         $destination++;
3026         $moveup = true;
3027     }
3029     // If we move the highlighted section itself, then just highlight the destination.
3030     // Adjust the higlighted section location if we move something over it either direction.
3031     if ($section == $course->marker) {
3032         course_set_marker($course, $destination);
3033     } elseif ($moveup && $section > $course->marker && $course->marker >= $destination) {
3034         course_set_marker($course, $course->marker+1);
3035     } elseif (!$moveup && $section < $course->marker && $course->marker <= $destination) {
3036         course_set_marker($course, $course->marker-1);
3037     }
3039     $transaction->allow_commit();
3040     return true;
3043 /**
3044  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3045  * an original position number and a target position number, rebuilds the array so that the
3046  * move is made without any duplication of section positions.
3047  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3048  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3049  *
3050  * @param array $sections
3051  * @param int $origin_position
3052  * @param int $target_position
3053  * @return array
3054  */
3055 function reorder_sections($sections, $origin_position, $target_position) {
3056     if (!is_array($sections)) {
3057         return false;
3058     }
3060     // We can't move section position 0
3061     if ($origin_position < 1) {
3062         echo "We can't move section position 0";
3063         return false;
3064     }
3066     // Locate origin section in sections array
3067     if (!$origin_key = array_search($origin_position, $sections)) {
3068         echo "searched position not in sections array";
3069         return false; // searched position not in sections array
3070     }
3072     // Extract origin section
3073     $origin_section = $sections[$origin_key];
3074     unset($sections[$origin_key]);
3076     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3077     $found = false;
3078     $append_array = array();
3079     foreach ($sections as $id => $position) {
3080         if ($found) {
3081             $append_array[$id] = $position;
3082             unset($sections[$id]);
3083         }
3084         if ($position == $target_position) {
3085             $found = true;
3086         }
3087     }
3089     // Append moved section
3090     $sections[$origin_key] = $origin_section;
3092     // Append rest of array (if applicable)
3093     if (!empty($append_array)) {
3094         foreach ($append_array as $id => $position) {
3095             $sections[$id] = $position;
3096         }
3097     }
3099     // Renumber positions
3100     $position = 0;
3101     foreach ($sections as $id => $p) {
3102         $sections[$id] = $position;
3103         $position++;
3104     }
3106     return $sections;
3110 /**
3111  * Move the module object $mod to the specified $section
3112  * If $beforemod exists then that is the module
3113  * before which $modid should be inserted
3114  * All parameters are objects
3115  */
3116 function moveto_module($mod, $section, $beforemod=NULL) {
3117     global $DB, $OUTPUT;
3119 /// Remove original module from original section
3120     if (! delete_mod_from_section($mod->id, $mod->section)) {
3121         echo $OUTPUT->notification("Could not delete module from existing section");
3122     }
3124 /// Update module itself if necessary
3126     if ($mod->section != $section->id) {
3127         $mod->section = $section->id;
3128         $DB->update_record("course_modules", $mod);
3129         // if moving to a hidden section then hide module
3130         if (!$section->visible) {
3131             set_coursemodule_visible($mod->id, 0);
3132         }
3133     }
3135 /// Add the module into the new section
3137     $mod->course       = $section->course;
3138     $mod->section      = $section->section;  // need relative reference
3139     $mod->coursemodule = $mod->id;
3141     if (! add_mod_to_section($mod, $beforemod)) {
3142         return false;
3143     }
3145     return true;
3148 /**
3149  * Produces the editing buttons for a module
3150  *
3151  * @global core_renderer $OUTPUT
3152  * @staticvar type $str
3153  * @param stdClass $mod The module to produce editing buttons for
3154  * @param bool $absolute_ignored ignored - all links are absolute
3155  * @param bool $moveselect If true a move seleciton process is used (default true)
3156  * @param int $indent The current indenting
3157  * @param int $section The section to link back to
3158  * @return string XHTML for the editing buttons
3159  */
3160 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=-1) {
3161     global $CFG, $OUTPUT;
3163     static $str;
3165     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3166     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3168     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3169     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3171     // no permission to edit anything
3172     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3173         return false;
3174     }
3176     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3178     if (!isset($str)) {
3179         $str = new stdClass;
3180         $str->assign         = get_string("assignroles", 'role');
3181         $str->delete         = get_string("delete");
3182         $str->move           = get_string("move");
3183         $str->moveup         = get_string("moveup");
3184         $str->movedown       = get_string("movedown");
3185         $str->moveright      = get_string("moveright");
3186         $str->moveleft       = get_string("moveleft");
3187         $str->update         = get_string("update");
3188         $str->duplicate      = get_string("duplicate");
3189         $str->hide           = get_string("hide");
3190         $str->show           = get_string("show");
3191         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3192         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3193         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3194         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3195         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3196         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3197     }
3199     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3201     if ($section >= 0) {
3202         $baseurl->param('sr', $section);
3203     }
3204     $actions = array();
3206     // leftright
3207     if ($hasmanageactivities) {
3208         if (right_to_left()) {   // Exchange arrows on RTL
3209             $rightarrow = 't/left';
3210             $leftarrow  = 't/right';
3211         } else {
3212             $rightarrow = 't/right';
3213             $leftarrow  = 't/left';
3214         }
3216         if ($indent > 0) {
3217             $actions[] = new action_link(
3218                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3219                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3220                 null,
3221                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3222             );
3223         }
3224         if ($indent >= 0) {
3225             $actions[] = new action_link(
3226                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3227                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3228                 null,
3229                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3230             );
3231         }
3232     }
3234     // move
3235     if ($hasmanageactivities) {
3236         if ($moveselect) {
3237             $actions[] = new action_link(
3238                 new moodle_url($baseurl, array('copy' => $mod->id)),
3239                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3240                 null,
3241                 array('class' => 'editing_move', 'title' => $str->move)
3242             );
3243         } else {
3244             $actions[] = new action_link(
3245                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3246                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3247                 null,
3248                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3249             );
3250             $actions[] = new action_link(
3251                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3252                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3253                 null,
3254                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3255             );
3256         }
3257     }
3259     // Update
3260     if ($hasmanageactivities) {
3261         $actions[] = new action_link(
3262             new moodle_url($baseurl, array('update' => $mod->id)),
3263             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3264             null,
3265             array('class' => 'editing_update', 'title' => $str->update)
3266         );
3267     }
3269     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3270     if (has_all_capabilities($dupecaps, $coursecontext)) {
3271         $actions[] = new action_link(
3272             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3273             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3274             null,
3275             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3276         );
3277     }
3279     // Delete
3280     if ($hasmanageactivities) {
3281         $actions[] = new action_link(
3282             new moodle_url($baseurl, array('delete' => $mod->id)),
3283             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3284             null,
3285             array('class' => 'editing_delete', 'title' => $str->delete)
3286         );
3287     }
3289     // hideshow
3290     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3291         if ($mod->visible) {
3292             $actions[] = new action_link(
3293                 new moodle_url($baseurl, array('hide' => $mod->id)),
3294                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3295                 null,
3296                 array('class' => 'editing_hide', 'title' => $str->hide)
3297             );
3298         } else {
3299             $actions[] = new action_link(
3300                 new moodle_url($baseurl, array('show' => $mod->id)),
3301                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3302                 null,
3303                 array('class' => 'editing_show', 'title' => $str->show)
3304             );
3305         }
3306     }
3308     // groupmode
3309     if ($hasmanageactivities and $mod->groupmode !== false) {
3310         if ($mod->groupmode == SEPARATEGROUPS) {
3311             $groupmode = 0;
3312             $grouptitle = $str->groupsseparate;
3313             $forcedgrouptitle = $str->forcedgroupsseparate;
3314             $groupclass = 'editing_groupsseparate';
3315             $groupimage = 't/groups';
3316         } else if ($mod->groupmode == VISIBLEGROUPS) {
3317             $groupmode = 1;
3318             $grouptitle = $str->groupsvisible;
3319             $forcedgrouptitle = $str->forcedgroupsvisible;
3320             $groupclass = 'editing_groupsvisible';
3321             $groupimage = 't/groupv';
3322         } else {
3323             $groupmode = 2;
3324             $grouptitle = $str->groupsnone;
3325             $forcedgrouptitle = $str->forcedgroupsnone;
3326             $groupclass = 'editing_groupsnone';
3327             $groupimage = 't/groupn';
3328         }
3329         if ($mod->groupmodelink) {
3330             $actions[] = new action_link(
3331                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3332                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3333                 null,
3334                 array('class' => $groupclass, 'title' => $grouptitle)
3335             );
3336         } else {
3337             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3338         }
3339     }
3341     // Assign
3342     if (has_capability('moodle/role:assign', $modcontext)){
3343         $actions[] = new action_link(
3344             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3345             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3346             null,
3347             array('class' => 'editing_assign', 'title' => $str->assign)
3348         );
3349     }
3351     $output = html_writer::start_tag('span', array('class' => 'commands'));
3352     foreach ($actions as $action) {
3353         if ($action instanceof renderable) {
3354             $output .= $OUTPUT->render($action);
3355         } else {
3356             $output .= $action;
3357         }
3358     }
3359     $output .= html_writer::end_tag('span');
3360     return $output;
3363 /**
3364  * given a course object with shortname & fullname, this function will
3365  * truncate the the number of chars allowed and add ... if it was too long
3366  */
3367 function course_format_name ($course,$max=100) {
3369     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3370     $shortname = format_string($course->shortname, true, array('context' => $context));
3371     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3372     $str = $shortname.': '. $fullname;
3373     if (textlib::strlen($str) <= $max) {
3374         return $str;
3375     }
3376     else {
3377         return textlib::substr($str,0,$max-3).'...';
3378     }
3381 /**
3382  * Is the user allowed to add this type of module to this course?
3383  * @param object $course the course settings. Only $course->id is used.
3384  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3385  * @return bool whether the current user is allowed to add this type of module to this course.
3386  */
3387 function course_allowed_module($course, $modname) {
3388     global $DB;
3390     if (is_numeric($modname)) {
3391         throw new coding_exception('Function course_allowed_module no longer
3392                 supports numeric module ids. Please update your code to pass the module name.');
3393     }
3395     $capability = 'mod/' . $modname . ':addinstance';
3396     if (!get_capability_info($capability)) {
3397         // Debug warning that the capability does not exist, but no more than once per page.
3398         static $warned = array();
3399         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3400         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3401             debugging('The module ' . $modname . ' does not define the standard capability ' .
3402                     $capability , DEBUG_DEVELOPER);
3403             $warned[$modname] = 1;
3404         }
3406         // If the capability does not exist, the module can always be added.
3407         return true;
3408     }
3410     $coursecontext = context_course::instance($course->id);
3411     return has_capability($capability, $coursecontext);
3414 /**
3415  * Recursively delete category including all subcategories and courses.
3416  * @param stdClass $category
3417  * @param boolean $showfeedback display some notices
3418  * @return array return deleted courses
3419  */
3420 function category_delete_full($category, $showfeedback=true) {
3421     global $CFG, $DB;
3422     require_once($CFG->libdir.'/gradelib.php');
3423     require_once($CFG->libdir.'/questionlib.php');
3424     require_once($CFG->dirroot.'/cohort/lib.php');
3426     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3427         foreach ($children as $childcat) {
3428             category_delete_full($childcat, $showfeedback);
3429         }
3430     }
3432     $deletedcourses = array();
3433     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3434         foreach ($courses as $course) {
3435             if (!delete_course($course, false)) {
3436                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3437             }
3438             $deletedcourses[] = $course;
3439         }
3440     }
3442     // move or delete cohorts in this context
3443     cohort_delete_category($category);
3445     // now delete anything that may depend on course category context
3446     grade_course_category_delete($category->id, 0, $showfeedback);
3447     if (!question_delete_course_category($category, 0, $showfeedback)) {
3448         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3449     }
3451     // finally delete the category and it's context
3452     $DB->delete_records('course_categories', array('id'=>$category->id));
3453     delete_context(CONTEXT_COURSECAT, $category->id);
3455     events_trigger('course_category_deleted', $category);
3457     return $deletedcourses;
3460 /**
3461  * Delete category, but move contents to another category.
3462  * @param object $ccategory
3463  * @param int $newparentid category id
3464  * @return bool status
3465  */
3466 function category_delete_move($category, $newparentid, $showfeedback=true) {
3467     global $CFG, $DB, $OUTPUT;
3468     require_once($CFG->libdir.'/gradelib.php');
3469     require_once($CFG->libdir.'/questionlib.php');
3470     require_once($CFG->dirroot.'/cohort/lib.php');
3472     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3473         return false;
3474     }
3476     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3477         foreach ($children as $childcat) {
3478             move_category($childcat, $newparentcat);
3479         }
3480     }
3482     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3483         if (!move_courses(array_keys($courses), $newparentid)) {
3484             echo $OUTPUT->notification("Error moving courses");
3485             return false;
3486         }
3487         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3488     }
3490     // move or delete cohorts in this context
3491     cohort_delete_category($category);
3493     // now delete anything that may depend on course category context