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