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