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