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