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