Merge branch 'MDL-33212-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             // Avoid unnecessary duplication: if e.g. a forum name already
1522             // includes the word forum (or Forum, etc) then it is unhelpful
1523             // to include that in the accessible description that is added.
1524             if (false !== strpos(textlib::strtolower($instancename),
1525                     textlib::strtolower($altname))) {
1526                 $altname = '';
1527             }
1528             // File type after name, for alphabetic lists (screen reader).
1529             if ($altname) {
1530                 $altname = get_accesshide(' '.$altname);
1531             }
1533             // We may be displaying this just in order to show information
1534             // about visibility, without the actual link
1535             $contentpart = '';
1536             if ($mod->uservisible) {
1537                 // Nope - in this case the link is fully working for user
1538                 $linkclasses = '';
1539                 $textclasses = '';
1540                 if ($accessiblebutdim) {
1541                     $linkclasses .= ' dimmed';
1542                     $textclasses .= ' dimmed_text';
1543                     $accesstext = '<span class="accesshide">'.
1544                         get_string('hiddenfromstudents').': </span>';
1545                 } else {
1546                     $accesstext = '';
1547                 }
1548                 if ($linkclasses) {
1549                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1550                 } else {
1551                     $linkcss = '';
1552                 }
1553                 if ($textclasses) {
1554                     $textcss = 'class="' . trim($textclasses) . '" ';
1555                 } else {
1556                     $textcss = '';
1557                 }
1559                 // Get on-click attribute value if specified
1560                 $onclick = $mod->get_on_click();
1561                 if ($onclick) {
1562                     $onclick = ' onclick="' . $onclick . '"';
1563                 }
1565                 if ($url = $mod->get_url()) {
1566                     // Display link itself
1567                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1568                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1569                             '" class="activityicon" alt="' .
1570                             $modulename . '" /> ' .
1571                             $accesstext . '<span class="instancename">' .
1572                             $instancename . $altname . '</span></a>';
1574                     // If specified, display extra content after link
1575                     if ($content) {
1576                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1577                                 '">' . $content . '</div>';
1578                     }
1579                 } else {
1580                     // No link, so display only content
1581                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1582                             $accesstext . $content . '</div>';
1583                 }
1585                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1586                     $groupings = groups_get_all_groupings($course->id);
1587                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1588                 }
1589             } else {
1590                 $textclasses = $extraclasses;
1591                 $textclasses .= ' dimmed_text';
1592                 if ($textclasses) {
1593                     $textcss = 'class="' . trim($textclasses) . '" ';
1594                 } else {
1595                     $textcss = '';
1596                 }
1597                 $accesstext = '<span class="accesshide">' .
1598                         get_string('notavailableyet', 'condition') .
1599                         ': </span>';
1601                 if ($url = $mod->get_url()) {
1602                     // Display greyed-out text of link
1603                     echo '<div ' . $textcss . $mod->extra .
1604                             ' >' . '<img src="' . $mod->get_icon_url() .
1605                             '" class="activityicon" alt="' .
1606                             $modulename .
1607                             '" /> <span>'. $instancename . $altname .
1608                             '</span></div>';
1610                     // Do not display content after link when it is greyed out like this.
1611                 } else {
1612                     // No link, so display only content (also greyed)
1613                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1614                             $accesstext . $content . '</div>';
1615                 }
1616             }
1618             // Module can put text after the link (e.g. forum unread)
1619             echo $mod->get_after_link();
1621             // If there is content but NO link (eg label), then display the
1622             // content here (BEFORE any icons). In this case cons must be
1623             // displayed after the content so that it makes more sense visually
1624             // and for accessibility reasons, e.g. if you have a one-line label
1625             // it should work similarly (at least in terms of ordering) to an
1626             // activity.
1627             if (empty($url)) {
1628                 echo $contentpart;
1629             }
1631             if ($isediting) {
1632                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1633                     if (! $mod->groupmodelink = $groupbuttonslink) {
1634                         $mod->groupmode = $course->groupmode;
1635                     }
1637                 } else {
1638                     $mod->groupmode = false;
1639                 }
1640                 echo '&nbsp;&nbsp;';
1642                 if ($sectionreturn) {
1643                     echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1644                 } else {
1645                     echo make_editing_buttons($mod, $absolute, true, $mod->indent, 0);
1646                 }
1647                 echo $mod->get_after_edit_icons();
1648             }
1650             // Completion
1651             $completion = $hidecompletion
1652                 ? COMPLETION_TRACKING_NONE
1653                 : $completioninfo->is_enabled($mod);
1654             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1655                 !isguestuser() && $mod->uservisible) {
1656                 $completiondata = $completioninfo->get_data($mod,true);
1657                 $completionicon = '';
1658                 if ($isediting) {
1659                     switch ($completion) {
1660                         case COMPLETION_TRACKING_MANUAL :
1661                             $completionicon = 'manual-enabled'; break;
1662                         case COMPLETION_TRACKING_AUTOMATIC :
1663                             $completionicon = 'auto-enabled'; break;
1664                         default: // wtf
1665                     }
1666                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1667                     switch($completiondata->completionstate) {
1668                         case COMPLETION_INCOMPLETE:
1669                             $completionicon = 'manual-n'; break;
1670                         case COMPLETION_COMPLETE:
1671                             $completionicon = 'manual-y'; break;
1672                     }
1673                 } else { // Automatic
1674                     switch($completiondata->completionstate) {
1675                         case COMPLETION_INCOMPLETE:
1676                             $completionicon = 'auto-n'; break;
1677                         case COMPLETION_COMPLETE:
1678                             $completionicon = 'auto-y'; break;
1679                         case COMPLETION_COMPLETE_PASS:
1680                             $completionicon = 'auto-pass'; break;
1681                         case COMPLETION_COMPLETE_FAIL:
1682                             $completionicon = 'auto-fail'; break;
1683                     }
1684                 }
1685                 if ($completionicon) {
1686                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1687                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion', $mod->name));
1688                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1689                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion', $mod->name));
1690                         $newstate =
1691                             $completiondata->completionstate==COMPLETION_COMPLETE
1692                             ? COMPLETION_INCOMPLETE
1693                             : COMPLETION_COMPLETE;
1694                         // In manual mode the icon is a toggle form...
1696                         // If this completion state is used by the
1697                         // conditional activities system, we need to turn
1698                         // off the JS.
1699                         if (!empty($CFG->enableavailability) &&
1700                             condition_info::completion_value_used_as_condition($course, $mod)) {
1701                             $extraclass = ' preventjs';
1702                         } else {
1703                             $extraclass = '';
1704                         }
1705                         echo "
1706 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1707 <input type='hidden' name='id' value='{$mod->id}' />
1708 <input type='hidden' name='modulename' value='".s($mod->name)."' />
1709 <input type='hidden' name='sesskey' value='".sesskey()."' />
1710 <input type='hidden' name='completionstate' value='$newstate' />
1711 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1712 </div></form>";
1713                     } else {
1714                         // In auto mode, or when editing, the icon is just an image
1715                         echo "<span class='autocompletion'>";
1716                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1717                     }
1718                 }
1719             }
1721             // If there is content AND a link, then display the content here
1722             // (AFTER any icons). Otherwise it was displayed before
1723             if (!empty($url)) {
1724                 echo $contentpart;
1725             }
1727             // Show availability information (for someone who isn't allowed to
1728             // see the activity itself, or for staff)
1729             if (!$mod->uservisible) {
1730                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1731             } else if ($canviewhidden && !empty($CFG->enableavailability) && $mod->visible) {
1732                 $ci = new condition_info($mod);
1733                 $fullinfo = $ci->get_full_information();
1734                 if($fullinfo) {
1735                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1736                         ? 'userrestriction_visible'
1737                         : 'userrestriction_hidden','condition',
1738                         $fullinfo).'</div>';
1739                 }
1740             }
1742             echo html_writer::end_tag('div');
1743             echo html_writer::end_tag('li')."\n";
1744         }
1746     } elseif ($ismoving) {
1747         echo "<ul class=\"section\">\n";
1748     }
1750     if ($ismoving) {
1751         echo '<li><a title="'.$strmovefull.'"'.
1752              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1753              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1754              ' alt="'.$strmovehere.'" /></a></li>
1755              ';
1756     }
1757     if (!empty($section->sequence) || $ismoving) {
1758         echo "</ul><!--class='section'-->\n\n";
1759     }
1762 /**
1763  * Prints the menus to add activities and resources.
1764  */
1765 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1766     global $CFG, $OUTPUT;
1768     // check to see if user can add menus
1769     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1770         return false;
1771     }
1773     // Retrieve all modules with associated metadata
1774     $modules = get_module_metadata($course, $modnames);
1776     // We'll sort resources and activities into two lists
1777     $resources = array();
1778     $activities = array();
1780     // We need to add the section section to the link for each module
1781     $sectionlink = '&section=' . $section;
1783     foreach ($modules as $module) {
1784         if (isset($module->types)) {
1785             // This module has a subtype
1786             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1787             $subtypes = array();
1788             foreach ($module->types as $subtype) {
1789                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1790             }
1792             // Sort module subtypes into the list
1793             if (!empty($module->title)) {
1794                 // This grouping has a name
1795                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1796                     $resources[] = array($module->title=>$subtypes);
1797                 } else {
1798                     $activities[] = array($module->title=>$subtypes);
1799                 }
1800             } else {
1801                 // This grouping does not have a name
1802                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1803                     $resources = array_merge($resources, $subtypes);
1804                 } else {
1805                     $activities = array_merge($activities, $subtypes);
1806                 }
1807             }
1808         } else {
1809             // This module has no subtypes
1810             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1811                 $resources[$module->link . $sectionlink] = $module->title;
1812             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1813                 // System modules cannot be added by user, do not add to dropdown
1814             } else {
1815                 $activities[$module->link . $sectionlink] = $module->title;
1816             }
1817         }
1818     }
1820     $straddactivity = get_string('addactivity');
1821     $straddresource = get_string('addresource');
1823     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1825     if (!$vertical) {
1826         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1827     }
1829     if (!empty($resources)) {
1830         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1831         $select->set_help_icon('resources');
1832         $output .= $OUTPUT->render($select);
1833     }
1835     if (!empty($activities)) {
1836         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1837         $select->set_help_icon('activities');
1838         $output .= $OUTPUT->render($select);
1839     }
1841     if (!$vertical) {
1842         $output .= html_writer::end_tag('div');
1843     }
1845     $output .= html_writer::end_tag('div');
1847     if (course_ajax_enabled($course)) {
1848         $straddeither = get_string('addresourceoractivity');
1849         // The module chooser link
1850         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1851         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1852         $icon = $OUTPUT->pix_icon('t/add', $straddeither);
1853         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1854         $modchooser.= html_writer::link('#', $icon.$span, array('class' => 'section-modchooser-link'));
1855         $modchooser.= html_writer::end_tag('div');
1856         $modchooser.= html_writer::end_tag('div');
1858         // Wrap the normal output in a noscript div
1859         $usemodchooser = get_user_preferences('usemodchooser', 1);
1860         if ($usemodchooser) {
1861             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1862             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1863         } else {
1864             $output = html_writer::tag('div', $output, array('class' => 'visibleifjs addresourcedropdown'));
1865             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hiddenifjs addresourcemodchooser'));
1866         }
1867         $output = $modchooser . $output;
1868     }
1870     if ($return) {
1871         return $output;
1872     } else {
1873         echo $output;
1874     }
1877 /**
1878  * Retrieve all metadata for the requested modules
1879  *
1880  * @param object $course The Course
1881  * @param array $modnames An array containing the list of modules and their
1882  * names
1883  * @return array A list of stdClass objects containing metadata about each
1884  * module
1885  */
1886 function get_module_metadata($course, $modnames) {
1887     global $CFG, $OUTPUT;
1889     // get_module_metadata will be called once per section on the page and courses may show
1890     // different modules to one another
1891     static $modlist = array();
1892     if (!isset($modlist[$course->id])) {
1893         $modlist[$course->id] = array();
1894     }
1896     $return = array();
1897     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&add=';
1898     foreach($modnames as $modname => $modnamestr) {
1899         if (!course_allowed_module($course, $modname)) {
1900             continue;
1901         }
1902         if (isset($modlist[$modname])) {
1903             // This module is already cached
1904             $return[$modname] = $modlist[$course->id][$modname];
1905             continue;
1906         }
1908         // Include the module lib
1909         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1910         if (!file_exists($libfile)) {
1911             continue;
1912         }
1913         include_once($libfile);
1915         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1916         $gettypesfunc =  $modname.'_get_types';
1917         if (function_exists($gettypesfunc)) {
1918             if ($types = $gettypesfunc()) {
1919                 $group = new stdClass();
1920                 $group->name = $modname;
1921                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1922                 foreach($types as $type) {
1923                     if ($type->typestr === '--') {
1924                         continue;
1925                     }
1926                     if (strpos($type->typestr, '--') === 0) {
1927                         $group->title = str_replace('--', '', $type->typestr);
1928                         continue;
1929                     }
1930                     // Set the Sub Type metadata
1931                     $subtype = new stdClass();
1932                     $subtype->title = $type->typestr;
1933                     $subtype->type = str_replace('&amp;', '&', $type->type);
1934                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1935                     $subtype->archetype = $type->modclass;
1937                     // The group archetype should match the subtype archetypes and all subtypes
1938                     // should have the same archetype
1939                     $group->archetype = $subtype->archetype;
1941                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1942                         $subtype->help = get_string('help' . $subtype->name, $modname);
1943                     }
1944                     $subtype->link = $urlbase . $subtype->type;
1945                     $group->types[] = $subtype;
1946                 }
1947                 $modlist[$course->id][$modname] = $group;
1948             }
1949         } else {
1950             $module = new stdClass();
1951             $module->title = get_string('modulename', $modname);
1952             $module->name = $modname;
1953             $module->link = $urlbase . $modname;
1954             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1955             $sm = get_string_manager();
1956             if ($sm->string_exists('modulename_help', $modname)) {
1957                 $module->help = get_string('modulename_help', $modname);
1958                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1959                     $link = get_string('modulename_link', $modname);
1960                     $linktext = get_string('morehelp');
1961                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext), array('class' => 'helpdoclink'));
1962                 }
1963             }
1964             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1965             $modlist[$course->id][$modname] = $module;
1966         }
1967         $return[$modname] = $modlist[$course->id][$modname];
1968     }
1970     return $return;
1973 /**
1974  * Return the course category context for the category with id $categoryid, except
1975  * that if $categoryid is 0, return the system context.
1976  *
1977  * @param integer $categoryid a category id or 0.
1978  * @return object the corresponding context
1979  */
1980 function get_category_or_system_context($categoryid) {
1981     if ($categoryid) {
1982         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1983     } else {
1984         return get_context_instance(CONTEXT_SYSTEM);
1985     }
1988 /**
1989  * Gets the child categories of a given courses category. Uses a static cache
1990  * to make repeat calls efficient.
1991  *
1992  * @param int $parentid the id of a course category.
1993  * @return array all the child course categories.
1994  */
1995 function get_child_categories($parentid) {
1996     static $allcategories = null;
1998     // only fill in this variable the first time
1999     if (null == $allcategories) {
2000         $allcategories = array();
2002         $categories = get_categories();
2003         foreach ($categories as $category) {
2004             if (empty($allcategories[$category->parent])) {
2005                 $allcategories[$category->parent] = array();
2006             }
2007             $allcategories[$category->parent][] = $category;
2008         }
2009     }
2011     if (empty($allcategories[$parentid])) {
2012         return array();
2013     } else {
2014         return $allcategories[$parentid];
2015     }
2018 /**
2019  * This function recursively travels the categories, building up a nice list
2020  * for display. It also makes an array that list all the parents for each
2021  * category.
2022  *
2023  * For example, if you have a tree of categories like:
2024  *   Miscellaneous (id = 1)
2025  *      Subcategory (id = 2)
2026  *         Sub-subcategory (id = 4)
2027  *   Other category (id = 3)
2028  * Then after calling this function you will have
2029  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2030  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2031  *      3 => 'Other category');
2032  * $parents = array(2 => array(1), 4 => array(1, 2));
2033  *
2034  * If you specify $requiredcapability, then only categories where the current
2035  * user has that capability will be added to $list, although all categories
2036  * will still be added to $parents, and if you only have $requiredcapability
2037  * in a child category, not the parent, then the child catgegory will still be
2038  * included.
2039  *
2040  * If you specify the option $excluded, then that category, and all its children,
2041  * are omitted from the tree. This is useful when you are doing something like
2042  * moving categories, where you do not want to allow people to move a category
2043  * to be the child of itself.
2044  *
2045  * @param array $list For output, accumulates an array categoryid => full category path name
2046  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2047  * @param string/array $requiredcapability if given, only categories where the current
2048  *      user has this capability will be added to $list. Can also be an array of capabilities,
2049  *      in which case they are all required.
2050  * @param integer $excludeid Omit this category and its children from the lists built.
2051  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2052  * @param string $path For internal use, as part of recursive calls.
2053  */
2054 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2055         $excludeid = 0, $category = NULL, $path = "") {
2057     // initialize the arrays if needed
2058     if (!is_array($list)) {
2059         $list = array();
2060     }
2061     if (!is_array($parents)) {
2062         $parents = array();
2063     }
2065     if (empty($category)) {
2066         // Start at the top level.
2067         $category = new stdClass;
2068         $category->id = 0;
2069     } else {
2070         // This is the excluded category, don't include it.
2071         if ($excludeid > 0 && $excludeid == $category->id) {
2072             return;
2073         }
2075         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2076         $categoryname = format_string($category->name, true, array('context' => $context));
2078         // Update $path.
2079         if ($path) {
2080             $path = $path.' / '.$categoryname;
2081         } else {
2082             $path = $categoryname;
2083         }
2085         // Add this category to $list, if the permissions check out.
2086         if (empty($requiredcapability)) {
2087             $list[$category->id] = $path;
2089         } else {
2090             $requiredcapability = (array)$requiredcapability;
2091             if (has_all_capabilities($requiredcapability, $context)) {
2092                 $list[$category->id] = $path;
2093             }
2094         }
2095     }
2097     // Add all the children recursively, while updating the parents array.
2098     if ($categories = get_child_categories($category->id)) {
2099         foreach ($categories as $cat) {
2100             if (!empty($category->id)) {
2101                 if (isset($parents[$category->id])) {
2102                     $parents[$cat->id]   = $parents[$category->id];
2103                 }
2104                 $parents[$cat->id][] = $category->id;
2105             }
2106             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2107         }
2108     }
2111 /**
2112  * This function generates a structured array of courses and categories.
2113  *
2114  * The depth of categories is limited by $CFG->maxcategorydepth however there
2115  * is no limit on the number of courses!
2116  *
2117  * Suitable for use with the course renderers course_category_tree method:
2118  * $renderer = $PAGE->get_renderer('core','course');
2119  * echo $renderer->course_category_tree(get_course_category_tree());
2120  *
2121  * @global moodle_database $DB
2122  * @param int $id
2123  * @param int $depth
2124  */
2125 function get_course_category_tree($id = 0, $depth = 0) {
2126     global $DB, $CFG;
2127     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2128     $categories = get_child_categories($id);
2129     $categoryids = array();
2130     foreach ($categories as $key => &$category) {
2131         if (!$category->visible && !$viewhiddencats) {
2132             unset($categories[$key]);
2133             continue;
2134         }
2135         $categoryids[$category->id] = $category;
2136         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2137             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2138             foreach ($subcategories as $subid=>$subcat) {
2139                 $categoryids[$subid] = $subcat;
2140             }
2141             $category->courses = array();
2142         }
2143     }
2145     if ($depth > 0) {
2146         // This is a recursive call so return the required array
2147         return array($categories, $categoryids);
2148     }
2150     // The depth is 0 this function has just been called so we can finish it off
2152     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2153     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2154     $sql = "SELECT
2155             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2156             $ccselect
2157             FROM {course} c
2158             $ccjoin
2159             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2160     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2161         // loop throught them
2162         foreach ($courses as $course) {
2163             if ($course->id == SITEID) {
2164                 continue;
2165             }
2166             context_instance_preload($course);
2167             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2168                 $categoryids[$course->category]->courses[$course->id] = $course;
2169             }
2170         }
2171     }
2172     return $categories;
2175 /**
2176  * Recursive function to print out all the categories in a nice format
2177  * with or without courses included
2178  */
2179 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2180     global $CFG;
2182     // maxcategorydepth == 0 meant no limit
2183     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2184         return;
2185     }
2187     if (!$displaylist) {
2188         make_categories_list($displaylist, $parentslist);
2189     }
2191     if ($category) {
2192         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2193             print_category_info($category, $depth, $showcourses);
2194         } else {
2195             return;  // Don't bother printing children of invisible categories
2196         }
2198     } else {
2199         $category = new stdClass();
2200         $category->id = "0";
2201     }
2203     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2204         $countcats = count($categories);
2205         $count = 0;
2206         $first = true;
2207         $last = false;
2208         foreach ($categories as $cat) {
2209             $count++;
2210             if ($count == $countcats) {
2211                 $last = true;
2212             }
2213             $up = $first ? false : true;
2214             $down = $last ? false : true;
2215             $first = false;
2217             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2218         }
2219     }
2222 /**
2223  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2224  */
2225 function make_categories_options() {
2226     make_categories_list($cats,$parents);
2227     foreach ($cats as $key => $value) {
2228         if (array_key_exists($key,$parents)) {
2229             if ($indent = count($parents[$key])) {
2230                 for ($i = 0; $i < $indent; $i++) {
2231                     $cats[$key] = '&nbsp;'.$cats[$key];
2232                 }
2233             }
2234         }
2235     }
2236     return $cats;
2239 /**
2240  * Gets the name of a course to be displayed when showing a list of courses.
2241  * By default this is just $course->fullname but user can configure it. The
2242  * result of this function should be passed through print_string.
2243  * @param object $course Moodle course object
2244  * @return string Display name of course (either fullname or short + fullname)
2245  */
2246 function get_course_display_name_for_list($course) {
2247     global $CFG;
2248     if (!empty($CFG->courselistshortnames)) {
2249         return $course->shortname . ' ' .$course->fullname;
2250     } else {
2251         return $course->fullname;
2252     }
2255 /**
2256  * Prints the category info in indented fashion
2257  * This function is only used by print_whole_category_list() above
2258  */
2259 function print_category_info($category, $depth=0, $showcourses = false) {
2260     global $CFG, $DB, $OUTPUT;
2262     $strsummary = get_string('summary');
2264     $catlinkcss = null;
2265     if (!$category->visible) {
2266         $catlinkcss = array('class'=>'dimmed');
2267     }
2268     static $coursecount = null;
2269     if (null === $coursecount) {
2270         // only need to check this once
2271         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2272     }
2274     if ($showcourses and $coursecount) {
2275         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2276     } else {
2277         $catimage = "&nbsp;";
2278     }
2280     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2281     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2282     $fullname = format_string($category->name, true, array('context' => $context));
2284     if ($showcourses and $coursecount) {
2285         echo '<div class="categorylist clearfix">';
2286         $cat = '';
2287         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2288         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2289         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2291         $html = '';
2292         if ($depth > 0) {
2293             for ($i=0; $i< $depth; $i++) {
2294                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2295                 $cat = '';
2296             }
2297         } else {
2298             $html = $cat;
2299         }
2300         echo html_writer::tag('div', $html, array('class'=>'category'));
2301         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2303         // does the depth exceed maxcategorydepth
2304         // maxcategorydepth == 0 or unset meant no limit
2305         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2306         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2307             foreach ($courses as $course) {
2308                 $linkcss = null;
2309                 if (!$course->visible) {
2310                     $linkcss = array('class'=>'dimmed');
2311                 }
2313                 $coursename = get_course_display_name_for_list($course);
2314                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2316                 // print enrol info
2317                 $courseicon = '';
2318                 if ($icons = enrol_get_course_info_icons($course)) {
2319                     foreach ($icons as $pix_icon) {
2320                         $courseicon = $OUTPUT->render($pix_icon).' ';
2321                     }
2322                 }
2324                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2326                 if ($course->summary) {
2327                     $link = new moodle_url('/course/info.php?id='.$course->id);
2328                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2329                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2330                         array('title'=>$strsummary));
2332                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2333                 }
2335                 $html = '';
2336                 for ($i=0; $i <= $depth; $i++) {
2337                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2338                     $coursecontent = '';
2339                 }
2340                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2341             }
2342         }
2343         echo '</div>';
2344     } else {
2345         echo '<div class="categorylist">';
2346         $html = '';
2347         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2348         if (count($courses) > 0) {
2349             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2350         }
2352         if ($depth > 0) {
2353             for ($i=0; $i< $depth; $i++) {
2354                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2355                 $cat = '';
2356             }
2357         } else {
2358             $html = $cat;
2359         }
2361         echo html_writer::tag('div', $html, array('class'=>'category'));
2362         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2363         echo '</div>';
2364     }
2367 /**
2368  * Print the buttons relating to course requests.
2369  *
2370  * @param object $systemcontext the system context.
2371  */
2372 function print_course_request_buttons($systemcontext) {
2373     global $CFG, $DB, $OUTPUT;
2374     if (empty($CFG->enablecourserequests)) {
2375         return;
2376     }
2377     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2378     /// Print a button to request a new course
2379         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2380     }
2381     /// Print a button to manage pending requests
2382     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2383         $disabled = !$DB->record_exists('course_request', array());
2384         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2385     }
2388 /**
2389  * Does the user have permission to edit things in this category?
2390  *
2391  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2392  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2393  */
2394 function can_edit_in_category($categoryid = 0) {
2395     $context = get_category_or_system_context($categoryid);
2396     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2399 /**
2400  * Prints the turn editing on/off button on course/index.php or course/category.php.
2401  *
2402  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2403  * @return string HTML of the editing button, or empty string, if this user is not allowed
2404  *      to see it.
2405  */
2406 function update_category_button($categoryid = 0) {
2407     global $CFG, $PAGE, $OUTPUT;
2409     // Check permissions.
2410     if (!can_edit_in_category($categoryid)) {
2411         return '';
2412     }
2414     // Work out the appropriate action.
2415     if ($PAGE->user_is_editing()) {
2416         $label = get_string('turneditingoff');
2417         $edit = 'off';
2418     } else {
2419         $label = get_string('turneditingon');
2420         $edit = 'on';
2421     }
2423     // Generate the button HTML.
2424     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2425     if ($categoryid) {
2426         $options['id'] = $categoryid;
2427         $page = 'category.php';
2428     } else {
2429         $page = 'index.php';
2430     }
2431     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2434 /**
2435  * Category is 0 (for all courses) or an object
2436  */
2437 function print_courses($category) {
2438     global $CFG, $OUTPUT;
2440     if (!is_object($category) && $category==0) {
2441         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2442         if (is_array($categories) && count($categories) == 1) {
2443             $category   = array_shift($categories);
2444             $courses    = get_courses_wmanagers($category->id,
2445                                                 'c.sortorder ASC',
2446                                                 array('summary','summaryformat'));
2447         } else {
2448             $courses    = get_courses_wmanagers('all',
2449                                                 'c.sortorder ASC',
2450                                                 array('summary','summaryformat'));
2451         }
2452         unset($categories);
2453     } else {
2454         $courses    = get_courses_wmanagers($category->id,
2455                                             'c.sortorder ASC',
2456                                             array('summary','summaryformat'));
2457     }
2459     if ($courses) {
2460         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2461         foreach ($courses as $course) {
2462             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2463             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2464                 echo html_writer::start_tag('li');
2465                 print_course($course);
2466                 echo html_writer::end_tag('li');
2467             }
2468         }
2469         echo html_writer::end_tag('ul');
2470     } else {
2471         echo $OUTPUT->heading(get_string("nocoursesyet"));
2472         $context = get_context_instance(CONTEXT_SYSTEM);
2473         if (has_capability('moodle/course:create', $context)) {
2474             $options = array();
2475             if (!empty($category->id)) {
2476                 $options['category'] = $category->id;
2477             } else {
2478                 $options['category'] = $CFG->defaultrequestcategory;
2479             }
2480             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2481             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2482             echo html_writer::end_tag('div');
2483         }
2484     }
2487 /**
2488  * Print a description of a course, suitable for browsing in a list.
2489  *
2490  * @param object $course the course object.
2491  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2492  */
2493 function print_course($course, $highlightterms = '') {
2494     global $CFG, $USER, $DB, $OUTPUT;
2496     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2498     // Rewrite file URLs so that they are correct
2499     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2501     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2502     echo html_writer::start_tag('div', array('class'=>'info'));
2503     echo html_writer::start_tag('h3', array('class'=>'name'));
2505     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2507     $coursename = get_course_display_name_for_list($course);
2508     $linktext = highlight($highlightterms, format_string($coursename));
2509     $linkparams = array('title'=>get_string('entercourse'));
2510     if (empty($course->visible)) {
2511         $linkparams['class'] = 'dimmed';
2512     }
2513     echo html_writer::link($linkhref, $linktext, $linkparams);
2514     echo html_writer::end_tag('h3');
2516     /// first find all roles that are supposed to be displayed
2517     if (!empty($CFG->coursecontact)) {
2518         $managerroles = explode(',', $CFG->coursecontact);
2519         $namesarray = array();
2520         $rusers = array();
2522         if (!isset($course->managers)) {
2523             $rusers = get_role_users($managerroles, $context, true,
2524                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2525                  r.name AS rolename, r.sortorder, r.id AS roleid',
2526                 'r.sortorder ASC, u.lastname ASC');
2527         } else {
2528             //  use the managers array if we have it for perf reasosn
2529             //  populate the datastructure like output of get_role_users();
2530             foreach ($course->managers as $manager) {
2531                 $u = new stdClass();
2532                 $u = $manager->user;
2533                 $u->roleid = $manager->roleid;
2534                 $u->rolename = $manager->rolename;
2536                 $rusers[] = $u;
2537             }
2538         }
2540         /// Rename some of the role names if needed
2541         if (isset($context)) {
2542             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2543         }
2545         $namesarray = array();
2546         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2547         foreach ($rusers as $ra) {
2548             if (isset($namesarray[$ra->id])) {
2549                 //  only display a user once with the higest sortorder role
2550                 continue;
2551             }
2553             if (isset($aliasnames[$ra->roleid])) {
2554                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2555             }
2557             $fullname = fullname($ra, $canviewfullnames);
2558             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2559                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2560         }
2562         if (!empty($namesarray)) {
2563             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2564             foreach ($namesarray as $name) {
2565                 echo html_writer::tag('li', $name);
2566             }
2567             echo html_writer::end_tag('ul');
2568         }
2569     }
2570     echo html_writer::end_tag('div'); // End of info div
2572     echo html_writer::start_tag('div', array('class'=>'summary'));
2573     $options = new stdClass();
2574     $options->noclean = true;
2575     $options->para = false;
2576     $options->overflowdiv = true;
2577     if (!isset($course->summaryformat)) {
2578         $course->summaryformat = FORMAT_MOODLE;
2579     }
2580     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2581     if ($icons = enrol_get_course_info_icons($course)) {
2582         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2583         foreach ($icons as $icon) {
2584             echo $OUTPUT->render($icon);
2585         }
2586         echo html_writer::end_tag('div'); // End of enrolmenticons div
2587     }
2588     echo html_writer::end_tag('div'); // End of summary div
2589     echo html_writer::end_tag('div'); // End of coursebox div
2592 /**
2593  * Prints custom user information on the home page.
2594  * Over time this can include all sorts of information
2595  */
2596 function print_my_moodle() {
2597     global $USER, $CFG, $DB, $OUTPUT;
2599     if (!isloggedin() or isguestuser()) {
2600         print_error('nopermissions', '', '', 'See My Moodle');
2601     }
2603     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2604     $rhosts   = array();
2605     $rcourses = array();
2606     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2607         $rcourses = get_my_remotecourses($USER->id);
2608         $rhosts   = get_my_remotehosts();
2609     }
2611     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2613         if (!empty($courses)) {
2614             echo '<ul class="unlist">';
2615             foreach ($courses as $course) {
2616                 if ($course->id == SITEID) {
2617                     continue;
2618                 }
2619                 echo '<li>';
2620                 print_course($course);
2621                 echo "</li>\n";
2622             }
2623             echo "</ul>\n";
2624         }
2626         // MNET
2627         if (!empty($rcourses)) {
2628             // at the IDP, we know of all the remote courses
2629             foreach ($rcourses as $course) {
2630                 print_remote_course($course, "100%");
2631             }
2632         } elseif (!empty($rhosts)) {
2633             // non-IDP, we know of all the remote servers, but not courses
2634             foreach ($rhosts as $host) {
2635                 print_remote_host($host, "100%");
2636             }
2637         }
2638         unset($course);
2639         unset($host);
2641         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2642             echo "<table width=\"100%\"><tr><td align=\"center\">";
2643             print_course_search("", false, "short");
2644             echo "</td><td align=\"center\">";
2645             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2646             echo "</td></tr></table>\n";
2647         }
2649     } else {
2650         if ($DB->count_records("course_categories") > 1) {
2651             echo $OUTPUT->box_start("categorybox");
2652             print_whole_category_list();
2653             echo $OUTPUT->box_end();
2654         } else {
2655             print_courses(0);
2656         }
2657     }
2661 function print_course_search($value="", $return=false, $format="plain") {
2662     global $CFG;
2663     static $count = 0;
2665     $count++;
2667     $id = 'coursesearch';
2669     if ($count > 1) {
2670         $id .= $count;
2671     }
2673     $strsearchcourses= get_string("searchcourses");
2675     if ($format == 'plain') {
2676         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2677         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2678         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2679         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2680         $output .= '<input type="submit" value="'.get_string('go').'" />';
2681         $output .= '</fieldset></form>';
2682     } else if ($format == 'short') {
2683         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2684         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2685         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2686         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2687         $output .= '<input type="submit" value="'.get_string('go').'" />';
2688         $output .= '</fieldset></form>';
2689     } else if ($format == 'navbar') {
2690         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2691         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2692         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2693         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2694         $output .= '<input type="submit" value="'.get_string('go').'" />';
2695         $output .= '</fieldset></form>';
2696     }
2698     if ($return) {
2699         return $output;
2700     }
2701     echo $output;
2704 function print_remote_course($course, $width="100%") {
2705     global $CFG, $USER;
2707     $linkcss = '';
2709     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2711     echo '<div class="coursebox remotecoursebox clearfix">';
2712     echo '<div class="info">';
2713     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2714          $linkcss.' href="'.$url.'">'
2715         .  format_string($course->fullname) .'</a><br />'
2716         . format_string($course->hostname) . ' : '
2717         . format_string($course->cat_name) . ' : '
2718         . format_string($course->shortname). '</div>';
2719     echo '</div><div class="summary">';
2720     $options = new stdClass();
2721     $options->noclean = true;
2722     $options->para = false;
2723     $options->overflowdiv = true;
2724     echo format_text($course->summary, $course->summaryformat, $options);
2725     echo '</div>';
2726     echo '</div>';
2729 function print_remote_host($host, $width="100%") {
2730     global $OUTPUT;
2732     $linkcss = '';
2734     echo '<div class="coursebox clearfix">';
2735     echo '<div class="info">';
2736     echo '<div class="name">';
2737     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2738     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2739         . s($host['name']).'</a> - ';
2740     echo $host['count'] . ' ' . get_string('courses');
2741     echo '</div>';
2742     echo '</div>';
2743     echo '</div>';
2747 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2749 function add_course_module($mod) {
2750     global $DB;
2752     $mod->added = time();
2753     unset($mod->id);
2755     return $DB->insert_record("course_modules", $mod);
2758 /**
2759  * Returns course section - creates new if does not exist yet.
2760  * @param int $relative section number
2761  * @param int $courseid
2762  * @return object $course_section object
2763  */
2764 function get_course_section($section, $courseid) {
2765     global $DB;
2767     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2768         return $cw;
2769     }
2770     $cw = new stdClass();
2771     $cw->course   = $courseid;
2772     $cw->section  = $section;
2773     $cw->summary  = "";
2774     $cw->summaryformat = FORMAT_HTML;
2775     $cw->sequence = "";
2776     $id = $DB->insert_record("course_sections", $cw);
2777     rebuild_course_cache($courseid, true);
2778     return $DB->get_record("course_sections", array("id"=>$id));
2781 /**
2782  * Given a full mod object with section and course already defined, adds this module to that section.
2783  *
2784  * @param object $mod
2785  * @param int $beforemod An existing ID which we will insert the new module before
2786  * @return int The course_sections ID where the mod is inserted
2787  */
2788 function add_mod_to_section($mod, $beforemod=NULL) {
2789     global $DB;
2791     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2793         $section->sequence = trim($section->sequence);
2795         if (empty($section->sequence)) {
2796             $newsequence = "$mod->coursemodule";
2798         } else if ($beforemod) {
2799             $modarray = explode(",", $section->sequence);
2801             if ($key = array_keys($modarray, $beforemod->id)) {
2802                 $insertarray = array($mod->id, $beforemod->id);
2803                 array_splice($modarray, $key[0], 1, $insertarray);
2804                 $newsequence = implode(",", $modarray);
2806             } else {  // Just tack it on the end anyway
2807                 $newsequence = "$section->sequence,$mod->coursemodule";
2808             }
2810         } else {
2811             $newsequence = "$section->sequence,$mod->coursemodule";
2812         }
2814         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2815         return $section->id;     // Return course_sections ID that was used.
2817     } else {  // Insert a new record
2818         $section = new stdClass();
2819         $section->course   = $mod->course;
2820         $section->section  = $mod->section;
2821         $section->summary  = "";
2822         $section->summaryformat = FORMAT_HTML;
2823         $section->sequence = $mod->coursemodule;
2824         return $DB->insert_record("course_sections", $section);
2825     }
2828 function set_coursemodule_groupmode($id, $groupmode) {
2829     global $DB;
2830     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2833 function set_coursemodule_idnumber($id, $idnumber) {
2834     global $DB;
2835     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2838 /**
2839 * $prevstateoverrides = true will set the visibility of the course module
2840 * to what is defined in visibleold. This enables us to remember the current
2841 * visibility when making a whole section hidden, so that when we toggle
2842 * that section back to visible, we are able to return the visibility of
2843 * the course module back to what it was originally.
2844 */
2845 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2846     global $DB, $CFG;
2847     require_once($CFG->libdir.'/gradelib.php');
2849     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2850         return false;
2851     }
2852     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2853         return false;
2854     }
2855     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2856         foreach($events as $event) {
2857             if ($visible) {
2858                 show_event($event);
2859             } else {
2860                 hide_event($event);
2861             }
2862         }
2863     }
2865     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2866     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2867     if ($grade_items) {
2868         foreach ($grade_items as $grade_item) {
2869             $grade_item->set_hidden(!$visible);
2870         }
2871     }
2873     if ($prevstateoverrides) {
2874         if ($visible == '0') {
2875             // Remember the current visible state so we can toggle this back.
2876             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2877         } else {
2878             // Get the previous saved visible states.
2879             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2880         }
2881     }
2882     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2885 /**
2886  * Delete a course module and any associated data at the course level (events)
2887  * Until 1.5 this function simply marked a deleted flag ... now it
2888  * deletes it completely.
2889  *
2890  */
2891 function delete_course_module($id) {
2892     global $CFG, $DB;
2893     require_once($CFG->libdir.'/gradelib.php');
2894     require_once($CFG->dirroot.'/blog/lib.php');
2896     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2897         return true;
2898     }
2899     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2900     //delete events from calendar
2901     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2902         foreach($events as $event) {
2903             delete_event($event->id);
2904         }
2905     }
2906     //delete grade items, outcome items and grades attached to modules
2907     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2908                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2909         foreach ($grade_items as $grade_item) {
2910             $grade_item->delete('moddelete');
2911         }
2912     }
2913     // Delete completion and availability data; it is better to do this even if the
2914     // features are not turned on, in case they were turned on previously (these will be
2915     // very quick on an empty table)
2916     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2917     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2918     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2919                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2921     delete_context(CONTEXT_MODULE, $cm->id);
2922     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2925 function delete_mod_from_section($mod, $section) {
2926     global $DB;
2928     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2930         $modarray = explode(",", $section->sequence);
2932         if ($key = array_keys ($modarray, $mod)) {
2933             array_splice($modarray, $key[0], 1);
2934             $newsequence = implode(",", $modarray);
2935             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2936         } else {
2937             return false;
2938         }
2940     }
2941     return false;
2944 /**
2945  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2946  *
2947  * @param object $course course object
2948  * @param int $section Section number (not id!!!)
2949  * @param int $move (-1 or 1)
2950  * @return boolean true if section moved successfully
2951  */
2952 function move_section($course, $section, $move) {
2953 /// Moves a whole course section up and down within the course
2954     global $USER, $DB;
2956     if (!$move) {
2957         return true;
2958     }
2960     $sectiondest = $section + $move;
2962     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2963         return false;
2964     }
2966     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2967         return false;
2968     }
2970     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2971         return false;
2972     }
2974     // Three-step change ensures that the section always remains unique (there is
2975     // a unique index now)
2976     $DB->set_field("course_sections", "section", -$sectiondest, array("id"=>$sectionrecord->id));
2977     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2978     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2980     // Update highlighting if the move affects highlighted section
2981     if ($course->marker == $section) {
2982         course_set_marker($course->id, $sectiondest);
2983     } elseif ($course->marker == $sectiondest) {
2984         course_set_marker($course->id, $section);
2985     }
2988     // Fix order if needed. The database prevents duplicate sections, but it is
2989     // possible there could be a gap in the numbering.
2990     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2991     $n = 0;
2992     foreach ($sections as $section) {
2993         if ($section->section != $n) {
2994             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2995         }
2996         $n++;
2997     }
2998     // After moving section, rebuild course cache.
2999     rebuild_course_cache($course->id, true);
3000     return true;
3003 /**
3004  * Moves a section within a course, from a position to another.
3005  * Be very careful: $section and $destination refer to section number,
3006  * not id!.
3007  *
3008  * @param object $course
3009  * @param int $section Section number (not id!!!)
3010  * @param int $destination
3011  * @return boolean Result
3012  */
3013 function move_section_to($course, $section, $destination) {
3014 /// Moves a whole course section up and down within the course
3015     global $USER, $DB;
3017     if (!$destination && $destination != 0) {
3018         return true;
3019     }
3021     if ($destination > $course->numsections) {
3022         return false;
3023     }
3025     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3026     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3027             'section ASC, id ASC', 'id, section')) {
3028         return false;
3029     }
3031     $movedsections = reorder_sections($sections, $section, $destination);
3033     // Update all sections. Do this in 2 steps to avoid breaking database
3034     // uniqueness constraint
3035     $transaction = $DB->start_delegated_transaction();
3036     foreach ($movedsections as $id => $position) {
3037         if ($sections[$id] !== $position) {
3038             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3039         }
3040     }
3041     foreach ($movedsections as $id => $position) {
3042         if ($sections[$id] !== $position) {
3043             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3044         }
3045     }
3047     // Adjust destination to reflect the actual section
3048     $moveup = false;
3049     if ($section > $destination) {
3050         $destination++;
3051         $moveup = true;
3052     }
3054     // If we move the highlighted section itself, then just highlight the destination.
3055     // Adjust the higlighted section location if we move something over it either direction.
3056     if ($section == $course->marker) {
3057         course_set_marker($course->id, $destination);
3058     } elseif ($moveup && $section > $course->marker && $course->marker >= $destination) {
3059         course_set_marker($course->id, $course->marker+1);
3060     } elseif (!$moveup && $section < $course->marker && $course->marker <= $destination) {
3061         course_set_marker($course->id, $course->marker-1);
3062     }
3064     $transaction->allow_commit();
3065     return true;
3068 /**
3069  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3070  * an original position number and a target position number, rebuilds the array so that the
3071  * move is made without any duplication of section positions.
3072  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3073  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3074  *
3075  * @param array $sections
3076  * @param int $origin_position
3077  * @param int $target_position
3078  * @return array
3079  */
3080 function reorder_sections($sections, $origin_position, $target_position) {
3081     if (!is_array($sections)) {
3082         return false;
3083     }
3085     // We can't move section position 0
3086     if ($origin_position < 1) {
3087         echo "We can't move section position 0";
3088         return false;
3089     }
3091     // Locate origin section in sections array
3092     if (!$origin_key = array_search($origin_position, $sections)) {
3093         echo "searched position not in sections array";
3094         return false; // searched position not in sections array
3095     }
3097     // Extract origin section
3098     $origin_section = $sections[$origin_key];
3099     unset($sections[$origin_key]);
3101     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3102     $found = false;
3103     $append_array = array();
3104     foreach ($sections as $id => $position) {
3105         if ($found) {
3106             $append_array[$id] = $position;
3107             unset($sections[$id]);
3108         }
3109         if ($position == $target_position) {
3110             $found = true;
3111         }
3112     }
3114     // Append moved section
3115     $sections[$origin_key] = $origin_section;
3117     // Append rest of array (if applicable)
3118     if (!empty($append_array)) {
3119         foreach ($append_array as $id => $position) {
3120             $sections[$id] = $position;
3121         }
3122     }
3124     // Renumber positions
3125     $position = 0;
3126     foreach ($sections as $id => $p) {
3127         $sections[$id] = $position;
3128         $position++;
3129     }
3131     return $sections;
3135 /**
3136  * Move the module object $mod to the specified $section
3137  * If $beforemod exists then that is the module
3138  * before which $modid should be inserted
3139  * All parameters are objects
3140  */
3141 function moveto_module($mod, $section, $beforemod=NULL) {
3142     global $DB, $OUTPUT;
3144 /// Remove original module from original section
3145     if (! delete_mod_from_section($mod->id, $mod->section)) {
3146         echo $OUTPUT->notification("Could not delete module from existing section");
3147     }
3149 /// Update module itself if necessary
3151     if ($mod->section != $section->id) {
3152         $mod->section = $section->id;
3153         $DB->update_record("course_modules", $mod);
3154         // if moving to a hidden section then hide module
3155         if (!$section->visible) {
3156             set_coursemodule_visible($mod->id, 0);
3157         }
3158     }
3160 /// Add the module into the new section
3162     $mod->course       = $section->course;
3163     $mod->section      = $section->section;  // need relative reference
3164     $mod->coursemodule = $mod->id;
3166     if (! add_mod_to_section($mod, $beforemod)) {
3167         return false;
3168     }
3170     return true;
3173 /**
3174  * Produces the editing buttons for a module
3175  *
3176  * @global core_renderer $OUTPUT
3177  * @staticvar type $str
3178  * @param stdClass $mod The module to produce editing buttons for
3179  * @param bool $absolute_ignored ignored - all links are absolute
3180  * @param bool $moveselect If true a move seleciton process is used (default true)
3181  * @param int $indent The current indenting
3182  * @param int $section The section to link back to
3183  * @return string XHTML for the editing buttons
3184  */
3185 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=-1) {
3186     global $CFG, $OUTPUT, $COURSE;
3188     static $str;
3190     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3191     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3193     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3194     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3196     // no permission to edit anything
3197     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3198         return false;
3199     }
3201     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3203     if (!isset($str)) {
3204         $str = new stdClass;
3205         $str->assign         = get_string("assignroles", 'role');
3206         $str->delete         = get_string("delete");
3207         $str->move           = get_string("move");
3208         $str->moveup         = get_string("moveup");
3209         $str->movedown       = get_string("movedown");
3210         $str->moveright      = get_string("moveright");
3211         $str->moveleft       = get_string("moveleft");
3212         $str->update         = get_string("update");
3213         $str->duplicate      = get_string("duplicate");
3214         $str->hide           = get_string("hide");
3215         $str->show           = get_string("show");
3216         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3217         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3218         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3219         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3220         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3221         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3222         $str->edittitle = get_string('edittitle', 'moodle');
3223     }
3225     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3227     if ($section >= 0) {
3228         $baseurl->param('sr', $section);
3229     }
3230     $actions = array();
3232     // AJAX edit title
3233     if ($mod->modname !== 'label' && $hasmanageactivities && course_ajax_enabled($COURSE)) {
3234         $actions[] = new action_link(
3235             new moodle_url($baseurl, array('update' => $mod->id)),
3236             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs')),
3237             null,
3238             array('class' => 'editing_title', 'title' => $str->edittitle)
3239         );
3240     }
3242     // leftright
3243     if ($hasmanageactivities) {
3244         if (right_to_left()) {   // Exchange arrows on RTL
3245             $rightarrow = 't/left';
3246             $leftarrow  = 't/right';
3247         } else {
3248             $rightarrow = 't/right';
3249             $leftarrow  = 't/left';
3250         }
3252         if ($indent > 0) {
3253             $actions[] = new action_link(
3254                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3255                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3256                 null,
3257                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3258             );
3259         }
3260         if ($indent >= 0) {
3261             $actions[] = new action_link(
3262                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3263                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3264                 null,
3265                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3266             );
3267         }
3268     }
3270     // move
3271     if ($hasmanageactivities) {
3272         if ($moveselect) {
3273             $actions[] = new action_link(
3274                 new moodle_url($baseurl, array('copy' => $mod->id)),
3275                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3276                 null,
3277                 array('class' => 'editing_move', 'title' => $str->move)
3278             );
3279         } else {
3280             $actions[] = new action_link(
3281                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3282                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3283                 null,
3284                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3285             );
3286             $actions[] = new action_link(
3287                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3288                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3289                 null,
3290                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3291             );
3292         }
3293     }
3295     // Update
3296     if ($hasmanageactivities) {
3297         $actions[] = new action_link(
3298             new moodle_url($baseurl, array('update' => $mod->id)),
3299             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3300             null,
3301             array('class' => 'editing_update', 'title' => $str->update)
3302         );
3303     }
3305     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3306     if (has_all_capabilities($dupecaps, $coursecontext)) {
3307         $actions[] = new action_link(
3308             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3309             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3310             null,
3311             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3312         );
3313     }
3315     // Delete
3316     if ($hasmanageactivities) {
3317         $actions[] = new action_link(
3318             new moodle_url($baseurl, array('delete' => $mod->id)),
3319             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3320             null,
3321             array('class' => 'editing_delete', 'title' => $str->delete)
3322         );
3323     }
3325     // hideshow
3326     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3327         if ($mod->visible) {
3328             $actions[] = new action_link(
3329                 new moodle_url($baseurl, array('hide' => $mod->id)),
3330                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3331                 null,
3332                 array('class' => 'editing_hide', 'title' => $str->hide)
3333             );
3334         } else {
3335             $actions[] = new action_link(
3336                 new moodle_url($baseurl, array('show' => $mod->id)),
3337                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3338                 null,
3339                 array('class' => 'editing_show', 'title' => $str->show)
3340             );
3341         }
3342     }
3344     // groupmode
3345     if ($hasmanageactivities and $mod->groupmode !== false) {
3346         if ($mod->groupmode == SEPARATEGROUPS) {
3347             $groupmode = 0;
3348             $grouptitle = $str->groupsseparate;
3349             $forcedgrouptitle = $str->forcedgroupsseparate;
3350             $groupclass = 'editing_groupsseparate';
3351             $groupimage = 't/groups';
3352         } else if ($mod->groupmode == VISIBLEGROUPS) {
3353             $groupmode = 1;
3354             $grouptitle = $str->groupsvisible;
3355             $forcedgrouptitle = $str->forcedgroupsvisible;
3356             $groupclass = 'editing_groupsvisible';
3357             $groupimage = 't/groupv';
3358         } else {
3359             $groupmode = 2;
3360             $grouptitle = $str->groupsnone;
3361             $forcedgrouptitle = $str->forcedgroupsnone;
3362             $groupclass = 'editing_groupsnone';
3363             $groupimage = 't/groupn';
3364         }
3365         if ($mod->groupmodelink) {
3366             $actions[] = new action_link(
3367                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3368                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3369                 null,
3370                 array('class' => $groupclass, 'title' => $grouptitle)
3371             );
3372         } else {
3373             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3374         }
3375     }
3377     // Assign
3378     if (has_capability('moodle/role:assign', $modcontext)){
3379         $actions[] = new action_link(
3380             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3381             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3382             null,
3383             array('class' => 'editing_assign', 'title' => $str->assign)
3384         );
3385     }
3387     $output = html_writer::start_tag('span', array('class' => 'commands'));
3388     foreach ($actions as $action) {
3389         if ($action instanceof renderable) {
3390             $output .= $OUTPUT->render($action);
3391         } else {
3392             $output .= $action;
3393         }
3394     }
3395     $output .= html_writer::end_tag('span');
3396     return $output;
3399 /**
3400  * given a course object with shortname & fullname, this function will
3401  * truncate the the number of chars allowed and add ... if it was too long
3402  */
3403 function course_format_name ($course,$max=100) {
3405     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3406     $shortname = format_string($course->shortname, true, array('context' => $context));
3407     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3408     $str = $shortname.': '. $fullname;
3409     if (textlib::strlen($str) <= $max) {
3410         return $str;
3411     }
3412     else {
3413         return textlib::substr($str,0,$max-3).'...';
3414     }
3417 /**
3418  * Is the user allowed to add this type of module to this course?
3419  * @param object $course the course settings. Only $course->id is used.
3420  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3421  * @return bool whether the current user is allowed to add this type of module to this course.
3422  */
3423 function course_allowed_module($course, $modname) {
3424     global $DB;
3426     if (is_numeric($modname)) {
3427         throw new coding_exception('Function course_allowed_module no longer
3428                 supports numeric module ids. Please update your code to pass the module name.');
3429     }
3431     $capability = 'mod/' . $modname . ':addinstance';
3432     if (!get_capability_info($capability)) {
3433         // Debug warning that the capability does not exist, but no more than once per page.
3434         static $warned = array();
3435         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3436         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3437             debugging('The module ' . $modname . ' does not define the standard capability ' .
3438                     $capability , DEBUG_DEVELOPER);
3439             $warned[$modname] = 1;
3440         }
3442         // If the capability does not exist, the module can always be added.
3443         return true;
3444     }
3446     $coursecontext = context_course::instance($course->id);
3447     return has_capability($capability, $coursecontext);
3450 /**
3451  * Recursively delete category including all subcategories and courses.
3452  * @param stdClass $category
3453  * @param boolean $showfeedback display some notices
3454  * @return array return deleted courses
3455  */
3456 function category_delete_full($category, $showfeedback=true) {
3457     global $CFG, $DB;
3458     require_once($CFG->libdir.'/gradelib.php');
3459     require_once($CFG->libdir.'/questionlib.php');
3460     require_once($CFG->dirroot.'/cohort/lib.php');
3462     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3463         foreach ($children as $childcat) {
3464             category_delete_full($childcat, $showfeedback);
3465         }
3466     }
3468     $deletedcourses = array();
3469     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3470         foreach ($courses as $course) {
3471             if (!delete_course($course, false)) {
3472                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3473             }
3474             $deletedcourses[] = $course;
3475         }
3476     }
3478     // move or delete cohorts in this context
3479     cohort_delete_category($category);
3481     // now delete anything that may depend on course category context
3482     grade_course_category_delete($category->id, 0, $showfeedback);
3483     if (!question_delete_course_category($category, 0, $showfeedback)) {
3484         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3485 &nb