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