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