eee2e8390407da5f9291e320a84b3affab8d36bb
[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 && is_numeric($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);
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 && is_numeric($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 && is_numeric($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 html_writer::start_tag('form', array(
1714                                 'class' => 'togglecompletion' . $extraclass,
1715                                 'method' => 'post',
1716                                 'action' => $CFG->wwwroot . '/course/togglecompletion.php'));
1717                         echo html_writer::start_tag('div');
1718                         echo html_writer::empty_tag('input', array(
1719                                 'type' => 'hidden', 'name' => 'id', 'value' => $mod->id));
1720                         echo html_writer::empty_tag('input', array(
1721                                 'type' => 'hidden', 'name' => 'modulename',
1722                                 'value' => $mod->name));
1723                         echo html_writer::empty_tag('input', array(
1724                                 'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
1725                         echo html_writer::empty_tag('input', array(
1726                                 'type' => 'hidden', 'name' => 'completionstate',
1727                                 'value' => $newstate));
1728                         echo html_writer::empty_tag('input', array(
1729                                 'type' => 'image', 'src' => $imgsrc, 'alt' => $imgalt, 'title' => $imgtitle));
1730                         echo html_writer::end_tag('div');
1731                         echo html_writer::end_tag('form');
1732                     } else {
1733                         // In auto mode, or when editing, the icon is just an image
1734                         echo "<span class='autocompletion'>";
1735                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1736                     }
1737                 }
1738             }
1740             // If there is content AND a link, then display the content here
1741             // (AFTER any icons). Otherwise it was displayed before
1742             if (!empty($url)) {
1743                 echo $contentpart;
1744             }
1746             // Show availability information (for someone who isn't allowed to
1747             // see the activity itself, or for staff)
1748             if (!$mod->uservisible) {
1749                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1750             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1751                 $visibilityclass = '';
1752                 if (!$mod->visible) {
1753                     $visibilityclass = 'accesshide';
1754                 }
1755                 $ci = new condition_info($mod);
1756                 $fullinfo = $ci->get_full_information();
1757                 if($fullinfo) {
1758                     echo '<div class="availabilityinfo '.$visibilityclass.'">'.get_string($mod->showavailability
1759                         ? 'userrestriction_visible'
1760                         : 'userrestriction_hidden','condition',
1761                         $fullinfo).'</div>';
1762                 }
1763             }
1765             echo html_writer::end_tag('div');
1766             echo html_writer::end_tag('li')."\n";
1767         }
1769     } elseif ($ismoving) {
1770         echo "<ul class=\"section\">\n";
1771     }
1773     if ($ismoving) {
1774         echo '<li><a title="'.$strmovefull.'"'.
1775              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1776              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1777              ' alt="'.$strmovehere.'" /></a></li>
1778              ';
1779     }
1780     if (!empty($section->sequence) || $ismoving) {
1781         echo "</ul><!--class='section'-->\n\n";
1782     }
1785 /**
1786  * Prints the menus to add activities and resources.
1787  *
1788  * @param stdClass $course The course
1789  * @param int $section relative section number (field course_sections.section)
1790  * @param array $modnames An array containing the list of modules and their names
1791  * @param bool $vertical Vertical orientation
1792  * @param bool $return Return the menus or send them to output
1793  * @param int $sectionreturn The section to link back to
1794  * @return void|string depending on $return
1795  */
1796 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false, $sectionreturn=null) {
1797     global $CFG, $OUTPUT;
1799     // check to see if user can add menus
1800     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1801         return false;
1802     }
1804     // Retrieve all modules with associated metadata
1805     $modules = get_module_metadata($course, $modnames, $sectionreturn);
1807     // We'll sort resources and activities into two lists
1808     $resources = array();
1809     $activities = array();
1811     // We need to add the section section to the link for each module
1812     $sectionlink = '&section=' . $section . '&sr=' . $sectionreturn;
1814     foreach ($modules as $module) {
1815         if (isset($module->types)) {
1816             // This module has a subtype
1817             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1818             $subtypes = array();
1819             foreach ($module->types as $subtype) {
1820                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1821             }
1823             // Sort module subtypes into the list
1824             if (!empty($module->title)) {
1825                 // This grouping has a name
1826                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1827                     $resources[] = array($module->title=>$subtypes);
1828                 } else {
1829                     $activities[] = array($module->title=>$subtypes);
1830                 }
1831             } else {
1832                 // This grouping does not have a name
1833                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1834                     $resources = array_merge($resources, $subtypes);
1835                 } else {
1836                     $activities = array_merge($activities, $subtypes);
1837                 }
1838             }
1839         } else {
1840             // This module has no subtypes
1841             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1842                 $resources[$module->link . $sectionlink] = $module->title;
1843             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1844                 // System modules cannot be added by user, do not add to dropdown
1845             } else {
1846                 $activities[$module->link . $sectionlink] = $module->title;
1847             }
1848         }
1849     }
1851     $straddactivity = get_string('addactivity');
1852     $straddresource = get_string('addresource');
1854     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1856     if (!$vertical) {
1857         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1858     }
1860     if (!empty($resources)) {
1861         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1862         $select->set_help_icon('resources');
1863         $output .= $OUTPUT->render($select);
1864     }
1866     if (!empty($activities)) {
1867         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1868         $select->set_help_icon('activities');
1869         $output .= $OUTPUT->render($select);
1870     }
1872     if (!$vertical) {
1873         $output .= html_writer::end_tag('div');
1874     }
1876     $output .= html_writer::end_tag('div');
1878     if (course_ajax_enabled($course)) {
1879         $straddeither = get_string('addresourceoractivity');
1880         // The module chooser link
1881         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1882         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1883         $icon = $OUTPUT->pix_icon('t/add', '');
1884         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1885         $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1886         $modchooser.= html_writer::end_tag('div');
1887         $modchooser.= html_writer::end_tag('div');
1889         // Wrap the normal output in a noscript div
1890         $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1891         if ($usemodchooser) {
1892             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1893             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1894         } else {
1895             // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1896             $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1897             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
1898         }
1899         $output = $modchooser . $output;
1900     }
1902     if ($return) {
1903         return $output;
1904     } else {
1905         echo $output;
1906     }
1909 /**
1910  * Retrieve all metadata for the requested modules
1911  *
1912  * @param object $course The Course
1913  * @param array $modnames An array containing the list of modules and their
1914  * names
1915  * @param int $sectionreturn The section to return to
1916  * @return array A list of stdClass objects containing metadata about each
1917  * module
1918  */
1919 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1920     global $CFG, $OUTPUT;
1922     // get_module_metadata will be called once per section on the page and courses may show
1923     // different modules to one another
1924     static $modlist = array();
1925     if (!isset($modlist[$course->id])) {
1926         $modlist[$course->id] = array();
1927     }
1929     $return = array();
1930     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&sr='.$sectionreturn.'&add=';
1931     foreach($modnames as $modname => $modnamestr) {
1932         if (!course_allowed_module($course, $modname)) {
1933             continue;
1934         }
1935         if (isset($modlist[$course->id][$modname])) {
1936             // This module is already cached
1937             $return[$modname] = $modlist[$course->id][$modname];
1938             continue;
1939         }
1941         // Include the module lib
1942         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1943         if (!file_exists($libfile)) {
1944             continue;
1945         }
1946         include_once($libfile);
1948         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1949         $gettypesfunc =  $modname.'_get_types';
1950         if (function_exists($gettypesfunc)) {
1951             if ($types = $gettypesfunc()) {
1952                 $group = new stdClass();
1953                 $group->name = $modname;
1954                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1955                 foreach($types as $type) {
1956                     if ($type->typestr === '--') {
1957                         continue;
1958                     }
1959                     if (strpos($type->typestr, '--') === 0) {
1960                         $group->title = str_replace('--', '', $type->typestr);
1961                         continue;
1962                     }
1963                     // Set the Sub Type metadata
1964                     $subtype = new stdClass();
1965                     $subtype->title = $type->typestr;
1966                     $subtype->type = str_replace('&amp;', '&', $type->type);
1967                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1968                     $subtype->archetype = $type->modclass;
1970                     // The group archetype should match the subtype archetypes and all subtypes
1971                     // should have the same archetype
1972                     $group->archetype = $subtype->archetype;
1974                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1975                         $subtype->help = get_string('help' . $subtype->name, $modname);
1976                     }
1977                     $subtype->link = $urlbase . $subtype->type;
1978                     $group->types[] = $subtype;
1979                 }
1980                 $modlist[$course->id][$modname] = $group;
1981             }
1982         } else {
1983             $module = new stdClass();
1984             $module->title = get_string('modulename', $modname);
1985             $module->name = $modname;
1986             $module->link = $urlbase . $modname;
1987             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1988             $sm = get_string_manager();
1989             if ($sm->string_exists('modulename_help', $modname)) {
1990                 $module->help = get_string('modulename_help', $modname);
1991                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1992                     $link = get_string('modulename_link', $modname);
1993                     $linktext = get_string('morehelp');
1994                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1995                 }
1996             }
1997             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1998             $modlist[$course->id][$modname] = $module;
1999         }
2000         $return[$modname] = $modlist[$course->id][$modname];
2001     }
2003     return $return;
2006 /**
2007  * Return the course category context for the category with id $categoryid, except
2008  * that if $categoryid is 0, return the system context.
2009  *
2010  * @param integer $categoryid a category id or 0.
2011  * @return object the corresponding context
2012  */
2013 function get_category_or_system_context($categoryid) {
2014     if ($categoryid) {
2015         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
2016     } else {
2017         return get_context_instance(CONTEXT_SYSTEM);
2018     }
2021 /**
2022  * Gets the child categories of a given courses category. Uses a static cache
2023  * to make repeat calls efficient.
2024  *
2025  * @param int $parentid the id of a course category.
2026  * @return array all the child course categories.
2027  */
2028 function get_child_categories($parentid) {
2029     static $allcategories = null;
2031     // only fill in this variable the first time
2032     if (null == $allcategories) {
2033         $allcategories = array();
2035         $categories = get_categories();
2036         foreach ($categories as $category) {
2037             if (empty($allcategories[$category->parent])) {
2038                 $allcategories[$category->parent] = array();
2039             }
2040             $allcategories[$category->parent][] = $category;
2041         }
2042     }
2044     if (empty($allcategories[$parentid])) {
2045         return array();
2046     } else {
2047         return $allcategories[$parentid];
2048     }
2051 /**
2052  * This function recursively travels the categories, building up a nice list
2053  * for display. It also makes an array that list all the parents for each
2054  * category.
2055  *
2056  * For example, if you have a tree of categories like:
2057  *   Miscellaneous (id = 1)
2058  *      Subcategory (id = 2)
2059  *         Sub-subcategory (id = 4)
2060  *   Other category (id = 3)
2061  * Then after calling this function you will have
2062  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2063  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2064  *      3 => 'Other category');
2065  * $parents = array(2 => array(1), 4 => array(1, 2));
2066  *
2067  * If you specify $requiredcapability, then only categories where the current
2068  * user has that capability will be added to $list, although all categories
2069  * will still be added to $parents, and if you only have $requiredcapability
2070  * in a child category, not the parent, then the child catgegory will still be
2071  * included.
2072  *
2073  * If you specify the option $excluded, then that category, and all its children,
2074  * are omitted from the tree. This is useful when you are doing something like
2075  * moving categories, where you do not want to allow people to move a category
2076  * to be the child of itself.
2077  *
2078  * @param array $list For output, accumulates an array categoryid => full category path name
2079  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2080  * @param string/array $requiredcapability if given, only categories where the current
2081  *      user has this capability will be added to $list. Can also be an array of capabilities,
2082  *      in which case they are all required.
2083  * @param integer $excludeid Omit this category and its children from the lists built.
2084  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2085  * @param string $path For internal use, as part of recursive calls.
2086  */
2087 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2088         $excludeid = 0, $category = NULL, $path = "") {
2090     // initialize the arrays if needed
2091     if (!is_array($list)) {
2092         $list = array();
2093     }
2094     if (!is_array($parents)) {
2095         $parents = array();
2096     }
2098     if (empty($category)) {
2099         // Start at the top level.
2100         $category = new stdClass;
2101         $category->id = 0;
2102     } else {
2103         // This is the excluded category, don't include it.
2104         if ($excludeid > 0 && $excludeid == $category->id) {
2105             return;
2106         }
2108         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2109         $categoryname = format_string($category->name, true, array('context' => $context));
2111         // Update $path.
2112         if ($path) {
2113             $path = $path.' / '.$categoryname;
2114         } else {
2115             $path = $categoryname;
2116         }
2118         // Add this category to $list, if the permissions check out.
2119         if (empty($requiredcapability)) {
2120             $list[$category->id] = $path;
2122         } else {
2123             $requiredcapability = (array)$requiredcapability;
2124             if (has_all_capabilities($requiredcapability, $context)) {
2125                 $list[$category->id] = $path;
2126             }
2127         }
2128     }
2130     // Add all the children recursively, while updating the parents array.
2131     if ($categories = get_child_categories($category->id)) {
2132         foreach ($categories as $cat) {
2133             if (!empty($category->id)) {
2134                 if (isset($parents[$category->id])) {
2135                     $parents[$cat->id]   = $parents[$category->id];
2136                 }
2137                 $parents[$cat->id][] = $category->id;
2138             }
2139             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2140         }
2141     }
2144 /**
2145  * This function generates a structured array of courses and categories.
2146  *
2147  * The depth of categories is limited by $CFG->maxcategorydepth however there
2148  * is no limit on the number of courses!
2149  *
2150  * Suitable for use with the course renderers course_category_tree method:
2151  * $renderer = $PAGE->get_renderer('core','course');
2152  * echo $renderer->course_category_tree(get_course_category_tree());
2153  *
2154  * @global moodle_database $DB
2155  * @param int $id
2156  * @param int $depth
2157  */
2158 function get_course_category_tree($id = 0, $depth = 0) {
2159     global $DB, $CFG;
2160     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2161     $categories = get_child_categories($id);
2162     $categoryids = array();
2163     foreach ($categories as $key => &$category) {
2164         if (!$category->visible && !$viewhiddencats) {
2165             unset($categories[$key]);
2166             continue;
2167         }
2168         $categoryids[$category->id] = $category;
2169         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2170             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2171             foreach ($subcategories as $subid=>$subcat) {
2172                 $categoryids[$subid] = $subcat;
2173             }
2174             $category->courses = array();
2175         }
2176     }
2178     if ($depth > 0) {
2179         // This is a recursive call so return the required array
2180         return array($categories, $categoryids);
2181     }
2183     if (empty($categoryids)) {
2184         // No categories available (probably all hidden).
2185         return array();
2186     }
2188     // The depth is 0 this function has just been called so we can finish it off
2190     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2191     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2192     $sql = "SELECT
2193             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2194             $ccselect
2195             FROM {course} c
2196             $ccjoin
2197             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2198     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2199         // loop throught them
2200         foreach ($courses as $course) {
2201             if ($course->id == SITEID) {
2202                 continue;
2203             }
2204             context_instance_preload($course);
2205             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2206                 $categoryids[$course->category]->courses[$course->id] = $course;
2207             }
2208         }
2209     }
2210     return $categories;
2213 /**
2214  * Recursive function to print out all the categories in a nice format
2215  * with or without courses included
2216  */
2217 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2218     global $CFG;
2220     // maxcategorydepth == 0 meant no limit
2221     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2222         return;
2223     }
2225     if (!$displaylist) {
2226         make_categories_list($displaylist, $parentslist);
2227     }
2229     if ($category) {
2230         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2231             print_category_info($category, $depth, $showcourses);
2232         } else {
2233             return;  // Don't bother printing children of invisible categories
2234         }
2236     } else {
2237         $category = new stdClass();
2238         $category->id = "0";
2239     }
2241     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2242         $countcats = count($categories);
2243         $count = 0;
2244         $first = true;
2245         $last = false;
2246         foreach ($categories as $cat) {
2247             $count++;
2248             if ($count == $countcats) {
2249                 $last = true;
2250             }
2251             $up = $first ? false : true;
2252             $down = $last ? false : true;
2253             $first = false;
2255             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2256         }
2257     }
2260 /**
2261  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2262  */
2263 function make_categories_options() {
2264     make_categories_list($cats,$parents);
2265     foreach ($cats as $key => $value) {
2266         if (array_key_exists($key,$parents)) {
2267             if ($indent = count($parents[$key])) {
2268                 for ($i = 0; $i < $indent; $i++) {
2269                     $cats[$key] = '&nbsp;'.$cats[$key];
2270                 }
2271             }
2272         }
2273     }
2274     return $cats;
2277 /**
2278  * Prints the category info in indented fashion
2279  * This function is only used by print_whole_category_list() above
2280  */
2281 function print_category_info($category, $depth=0, $showcourses = false) {
2282     global $CFG, $DB, $OUTPUT;
2284     $strsummary = get_string('summary');
2286     $catlinkcss = null;
2287     if (!$category->visible) {
2288         $catlinkcss = array('class'=>'dimmed');
2289     }
2290     static $coursecount = null;
2291     if (null === $coursecount) {
2292         // only need to check this once
2293         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2294     }
2296     if ($showcourses and $coursecount) {
2297         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2298     } else {
2299         $catimage = "&nbsp;";
2300     }
2302     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2303     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2304     $fullname = format_string($category->name, true, array('context' => $context));
2306     if ($showcourses and $coursecount) {
2307         echo '<div class="categorylist clearfix">';
2308         $cat = '';
2309         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2310         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2311         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2313         $html = '';
2314         if ($depth > 0) {
2315             for ($i=0; $i< $depth; $i++) {
2316                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2317                 $cat = '';
2318             }
2319         } else {
2320             $html = $cat;
2321         }
2322         echo html_writer::tag('div', $html, array('class'=>'category'));
2323         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2325         // does the depth exceed maxcategorydepth
2326         // maxcategorydepth == 0 or unset meant no limit
2327         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2328         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2329             foreach ($courses as $course) {
2330                 $linkcss = null;
2331                 if (!$course->visible) {
2332                     $linkcss = array('class'=>'dimmed');
2333                 }
2335                 $coursename = get_course_display_name_for_list($course);
2336                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2338                 // print enrol info
2339                 $courseicon = '';
2340                 if ($icons = enrol_get_course_info_icons($course)) {
2341                     foreach ($icons as $pix_icon) {
2342                         $courseicon = $OUTPUT->render($pix_icon).' ';
2343                     }
2344                 }
2346                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2348                 if ($course->summary) {
2349                     $link = new moodle_url('/course/info.php?id='.$course->id);
2350                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2351                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2352                         array('title'=>$strsummary));
2354                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2355                 }
2357                 $html = '';
2358                 for ($i=0; $i <= $depth; $i++) {
2359                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2360                     $coursecontent = '';
2361                 }
2362                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2363             }
2364         }
2365         echo '</div>';
2366     } else {
2367         echo '<div class="categorylist">';
2368         $html = '';
2369         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2370         if (count($courses) > 0) {
2371             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2372         }
2374         if ($depth > 0) {
2375             for ($i=0; $i< $depth; $i++) {
2376                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2377                 $cat = '';
2378             }
2379         } else {
2380             $html = $cat;
2381         }
2383         echo html_writer::tag('div', $html, array('class'=>'category'));
2384         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2385         echo '</div>';
2386     }
2389 /**
2390  * Print the buttons relating to course requests.
2391  *
2392  * @param object $systemcontext the system context.
2393  */
2394 function print_course_request_buttons($systemcontext) {
2395     global $CFG, $DB, $OUTPUT;
2396     if (empty($CFG->enablecourserequests)) {
2397         return;
2398     }
2399     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2400     /// Print a button to request a new course
2401         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2402     }
2403     /// Print a button to manage pending requests
2404     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2405         $disabled = !$DB->record_exists('course_request', array());
2406         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2407     }
2410 /**
2411  * Does the user have permission to edit things in this category?
2412  *
2413  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2414  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2415  */
2416 function can_edit_in_category($categoryid = 0) {
2417     $context = get_category_or_system_context($categoryid);
2418     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2421 /**
2422  * Prints the turn editing on/off button on course/index.php or course/category.php.
2423  *
2424  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2425  * @return string HTML of the editing button, or empty string, if this user is not allowed
2426  *      to see it.
2427  */
2428 function update_category_button($categoryid = 0) {
2429     global $CFG, $PAGE, $OUTPUT;
2431     // Check permissions.
2432     if (!can_edit_in_category($categoryid)) {
2433         return '';
2434     }
2436     // Work out the appropriate action.
2437     if ($PAGE->user_is_editing()) {
2438         $label = get_string('turneditingoff');
2439         $edit = 'off';
2440     } else {
2441         $label = get_string('turneditingon');
2442         $edit = 'on';
2443     }
2445     // Generate the button HTML.
2446     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2447     if ($categoryid) {
2448         $options['id'] = $categoryid;
2449         $page = 'category.php';
2450     } else {
2451         $page = 'index.php';
2452     }
2453     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2456 /**
2457  * Category is 0 (for all courses) or an object
2458  */
2459 function print_courses($category) {
2460     global $CFG, $OUTPUT;
2462     if (!is_object($category) && $category==0) {
2463         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2464         if (is_array($categories) && count($categories) == 1) {
2465             $category   = array_shift($categories);
2466             $courses    = get_courses_wmanagers($category->id,
2467                                                 'c.sortorder ASC',
2468                                                 array('summary','summaryformat'));
2469         } else {
2470             $courses    = get_courses_wmanagers('all',
2471                                                 'c.sortorder ASC',
2472                                                 array('summary','summaryformat'));
2473         }
2474         unset($categories);
2475     } else {
2476         $courses    = get_courses_wmanagers($category->id,
2477                                             'c.sortorder ASC',
2478                                             array('summary','summaryformat'));
2479     }
2481     if ($courses) {
2482         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2483         foreach ($courses as $course) {
2484             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2485             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2486                 echo html_writer::start_tag('li');
2487                 print_course($course);
2488                 echo html_writer::end_tag('li');
2489             }
2490         }
2491         echo html_writer::end_tag('ul');
2492     } else {
2493         echo $OUTPUT->heading(get_string("nocoursesyet"));
2494         $context = get_context_instance(CONTEXT_SYSTEM);
2495         if (has_capability('moodle/course:create', $context)) {
2496             $options = array();
2497             if (!empty($category->id)) {
2498                 $options['category'] = $category->id;
2499             } else {
2500                 $options['category'] = $CFG->defaultrequestcategory;
2501             }
2502             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2503             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2504             echo html_writer::end_tag('div');
2505         }
2506     }
2509 /**
2510  * Print a description of a course, suitable for browsing in a list.
2511  *
2512  * @param object $course the course object.
2513  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2514  */
2515 function print_course($course, $highlightterms = '') {
2516     global $CFG, $USER, $DB, $OUTPUT;
2518     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2520     // Rewrite file URLs so that they are correct
2521     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2523     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2524     echo html_writer::start_tag('div', array('class'=>'info'));
2525     echo html_writer::start_tag('h3', array('class'=>'name'));
2527     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2529     $coursename = get_course_display_name_for_list($course);
2530     $linktext = highlight($highlightterms, format_string($coursename));
2531     $linkparams = array('title'=>get_string('entercourse'));
2532     if (empty($course->visible)) {
2533         $linkparams['class'] = 'dimmed';
2534     }
2535     echo html_writer::link($linkhref, $linktext, $linkparams);
2536     echo html_writer::end_tag('h3');
2538     /// first find all roles that are supposed to be displayed
2539     if (!empty($CFG->coursecontact)) {
2540         $managerroles = explode(',', $CFG->coursecontact);
2541         $namesarray = array();
2542         $rusers = array();
2544         if (!isset($course->managers)) {
2545             $rusers = get_role_users($managerroles, $context, true,
2546                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2547                  r.name AS rolename, r.sortorder, r.id AS roleid',
2548                 'r.sortorder ASC, u.lastname ASC');
2549         } else {
2550             //  use the managers array if we have it for perf reasosn
2551             //  populate the datastructure like output of get_role_users();
2552             foreach ($course->managers as $manager) {
2553                 $u = new stdClass();
2554                 $u = $manager->user;
2555                 $u->roleid = $manager->roleid;
2556                 $u->rolename = $manager->rolename;
2558                 $rusers[] = $u;
2559             }
2560         }
2562         /// Rename some of the role names if needed
2563         if (isset($context)) {
2564             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2565         }
2567         $namesarray = array();
2568         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2569         foreach ($rusers as $ra) {
2570             if (isset($namesarray[$ra->id])) {
2571                 //  only display a user once with the higest sortorder role
2572                 continue;
2573             }
2575             if (isset($aliasnames[$ra->roleid])) {
2576                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2577             }
2579             $fullname = fullname($ra, $canviewfullnames);
2580             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2581                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2582         }
2584         if (!empty($namesarray)) {
2585             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2586             foreach ($namesarray as $name) {
2587                 echo html_writer::tag('li', $name);
2588             }
2589             echo html_writer::end_tag('ul');
2590         }
2591     }
2592     echo html_writer::end_tag('div'); // End of info div
2594     echo html_writer::start_tag('div', array('class'=>'summary'));
2595     $options = new stdClass();
2596     $options->noclean = true;
2597     $options->para = false;
2598     $options->overflowdiv = true;
2599     if (!isset($course->summaryformat)) {
2600         $course->summaryformat = FORMAT_MOODLE;
2601     }
2602     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2603     if ($icons = enrol_get_course_info_icons($course)) {
2604         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2605         foreach ($icons as $icon) {
2606             echo $OUTPUT->render($icon);
2607         }
2608         echo html_writer::end_tag('div'); // End of enrolmenticons div
2609     }
2610     echo html_writer::end_tag('div'); // End of summary div
2611     echo html_writer::end_tag('div'); // End of coursebox div
2614 /**
2615  * Prints custom user information on the home page.
2616  * Over time this can include all sorts of information
2617  */
2618 function print_my_moodle() {
2619     global $USER, $CFG, $DB, $OUTPUT;
2621     if (!isloggedin() or isguestuser()) {
2622         print_error('nopermissions', '', '', 'See My Moodle');
2623     }
2625     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2626     $rhosts   = array();
2627     $rcourses = array();
2628     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2629         $rcourses = get_my_remotecourses($USER->id);
2630         $rhosts   = get_my_remotehosts();
2631     }
2633     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2635         if (!empty($courses)) {
2636             echo '<ul class="unlist">';
2637             foreach ($courses as $course) {
2638                 if ($course->id == SITEID) {
2639                     continue;
2640                 }
2641                 echo '<li>';
2642                 print_course($course);
2643                 echo "</li>\n";
2644             }
2645             echo "</ul>\n";
2646         }
2648         // MNET
2649         if (!empty($rcourses)) {
2650             // at the IDP, we know of all the remote courses
2651             foreach ($rcourses as $course) {
2652                 print_remote_course($course, "100%");
2653             }
2654         } elseif (!empty($rhosts)) {
2655             // non-IDP, we know of all the remote servers, but not courses
2656             foreach ($rhosts as $host) {
2657                 print_remote_host($host, "100%");
2658             }
2659         }
2660         unset($course);
2661         unset($host);
2663         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2664             echo "<table width=\"100%\"><tr><td align=\"center\">";
2665             print_course_search("", false, "short");
2666             echo "</td><td align=\"center\">";
2667             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2668             echo "</td></tr></table>\n";
2669         }
2671     } else {
2672         if ($DB->count_records("course_categories") > 1) {
2673             echo $OUTPUT->box_start("categorybox");
2674             print_whole_category_list();
2675             echo $OUTPUT->box_end();
2676         } else {
2677             print_courses(0);
2678         }
2679     }
2683 function print_course_search($value="", $return=false, $format="plain") {
2684     global $CFG;
2685     static $count = 0;
2687     $count++;
2689     $id = 'coursesearch';
2691     if ($count > 1) {
2692         $id .= $count;
2693     }
2695     $strsearchcourses= get_string("searchcourses");
2697     if ($format == 'plain') {
2698         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2699         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2700         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2701         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2702         $output .= '<input type="submit" value="'.get_string('go').'" />';
2703         $output .= '</fieldset></form>';
2704     } else if ($format == 'short') {
2705         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2706         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2707         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2708         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2709         $output .= '<input type="submit" value="'.get_string('go').'" />';
2710         $output .= '</fieldset></form>';
2711     } else if ($format == 'navbar') {
2712         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2713         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2714         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2715         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2716         $output .= '<input type="submit" value="'.get_string('go').'" />';
2717         $output .= '</fieldset></form>';
2718     }
2720     if ($return) {
2721         return $output;
2722     }
2723     echo $output;
2726 function print_remote_course($course, $width="100%") {
2727     global $CFG, $USER;
2729     $linkcss = '';
2731     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2733     echo '<div class="coursebox remotecoursebox clearfix">';
2734     echo '<div class="info">';
2735     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2736          $linkcss.' href="'.$url.'">'
2737         .  format_string($course->fullname) .'</a><br />'
2738         . format_string($course->hostname) . ' : '
2739         . format_string($course->cat_name) . ' : '
2740         . format_string($course->shortname). '</div>';
2741     echo '</div><div class="summary">';
2742     $options = new stdClass();
2743     $options->noclean = true;
2744     $options->para = false;
2745     $options->overflowdiv = true;
2746     echo format_text($course->summary, $course->summaryformat, $options);
2747     echo '</div>';
2748     echo '</div>';
2751 function print_remote_host($host, $width="100%") {
2752     global $OUTPUT;
2754     $linkcss = '';
2756     echo '<div class="coursebox clearfix">';
2757     echo '<div class="info">';
2758     echo '<div class="name">';
2759     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2760     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2761         . s($host['name']).'</a> - ';
2762     echo $host['count'] . ' ' . get_string('courses');
2763     echo '</div>';
2764     echo '</div>';
2765     echo '</div>';
2769 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2771 function add_course_module($mod) {
2772     global $DB;
2774     $mod->added = time();
2775     unset($mod->id);
2777     return $DB->insert_record("course_modules", $mod);
2780 /**
2781  * Returns course section - creates new if does not exist yet.
2782  * @param int $relative section number
2783  * @param int $courseid
2784  * @return object $course_section object
2785  */
2786 function get_course_section($section, $courseid) {
2787     global $DB;
2789     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2790         return $cw;
2791     }
2792     $cw = new stdClass();
2793     $cw->course   = $courseid;
2794     $cw->section  = $section;
2795     $cw->summary  = "";
2796     $cw->summaryformat = FORMAT_HTML;
2797     $cw->sequence = "";
2798     $id = $DB->insert_record("course_sections", $cw);
2799     rebuild_course_cache($courseid, true);
2800     return $DB->get_record("course_sections", array("id"=>$id));
2803 /**
2804  * Given a full mod object with section and course already defined, adds this module to that section.
2805  *
2806  * @param object $mod
2807  * @param int $beforemod An existing ID which we will insert the new module before
2808  * @return int The course_sections ID where the mod is inserted
2809  */
2810 function add_mod_to_section($mod, $beforemod=NULL) {
2811     global $DB;
2813     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2815         $section->sequence = trim($section->sequence);
2817         if (empty($section->sequence)) {
2818             $newsequence = "$mod->coursemodule";
2820         } else if ($beforemod) {
2821             $modarray = explode(",", $section->sequence);
2823             if ($key = array_keys($modarray, $beforemod->id)) {
2824                 $insertarray = array($mod->id, $beforemod->id);
2825                 array_splice($modarray, $key[0], 1, $insertarray);
2826                 $newsequence = implode(",", $modarray);
2828             } else {  // Just tack it on the end anyway
2829                 $newsequence = "$section->sequence,$mod->coursemodule";
2830             }
2832         } else {
2833             $newsequence = "$section->sequence,$mod->coursemodule";
2834         }
2836         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2837         return $section->id;     // Return course_sections ID that was used.
2839     } else {  // Insert a new record
2840         $section = new stdClass();
2841         $section->course   = $mod->course;
2842         $section->section  = $mod->section;
2843         $section->summary  = "";
2844         $section->summaryformat = FORMAT_HTML;
2845         $section->sequence = $mod->coursemodule;
2846         return $DB->insert_record("course_sections", $section);
2847     }
2850 function set_coursemodule_groupmode($id, $groupmode) {
2851     global $DB;
2852     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2855 function set_coursemodule_idnumber($id, $idnumber) {
2856     global $DB;
2857     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2860 /**
2861 * $prevstateoverrides = true will set the visibility of the course module
2862 * to what is defined in visibleold. This enables us to remember the current
2863 * visibility when making a whole section hidden, so that when we toggle
2864 * that section back to visible, we are able to return the visibility of
2865 * the course module back to what it was originally.
2866 */
2867 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2868     global $DB, $CFG;
2869     require_once($CFG->libdir.'/gradelib.php');
2871     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2872         return false;
2873     }
2874     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2875         return false;
2876     }
2877     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2878         foreach($events as $event) {
2879             if ($visible) {
2880                 show_event($event);
2881             } else {
2882                 hide_event($event);
2883             }
2884         }
2885     }
2887     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2888     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2889     if ($grade_items) {
2890         foreach ($grade_items as $grade_item) {
2891             $grade_item->set_hidden(!$visible);
2892         }
2893     }
2895     if ($prevstateoverrides) {
2896         if ($visible == '0') {
2897             // Remember the current visible state so we can toggle this back.
2898             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2899         } else {
2900             // Get the previous saved visible states.
2901             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2902         }
2903     }
2904     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2907 /**
2908  * Delete a course module and any associated data at the course level (events)
2909  * Until 1.5 this function simply marked a deleted flag ... now it
2910  * deletes it completely.
2911  *
2912  */
2913 function delete_course_module($id) {
2914     global $CFG, $DB;
2915     require_once($CFG->libdir.'/gradelib.php');
2916     require_once($CFG->dirroot.'/blog/lib.php');
2918     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2919         return true;
2920     }
2921     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2922     //delete events from calendar
2923     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2924         foreach($events as $event) {
2925             delete_event($event->id);
2926         }
2927     }
2928     //delete grade items, outcome items and grades attached to modules
2929     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2930                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2931         foreach ($grade_items as $grade_item) {
2932             $grade_item->delete('moddelete');
2933         }
2934     }
2935     // Delete completion and availability data; it is better to do this even if the
2936     // features are not turned on, in case they were turned on previously (these will be
2937     // very quick on an empty table)
2938     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2939     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2940     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2941                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2943     delete_context(CONTEXT_MODULE, $cm->id);
2944     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2947 function delete_mod_from_section($mod, $section) {
2948     global $DB;
2950     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2952         $modarray = explode(",", $section->sequence);
2954         if ($key = array_keys ($modarray, $mod)) {
2955             array_splice($modarray, $key[0], 1);
2956             $newsequence = implode(",", $modarray);
2957             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2958         } else {
2959             return false;
2960         }
2962     }
2963     return false;
2966 /**
2967  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2968  *
2969  * @param object $course course object
2970  * @param int $section Section number (not id!!!)
2971  * @param int $move (-1 or 1)
2972  * @return boolean true if section moved successfully
2973  * @todo MDL-33379 remove this function in 2.5
2974  */
2975 function move_section($course, $section, $move) {
2976     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2978 /// Moves a whole course section up and down within the course
2979     global $USER, $DB;
2981     if (!$move) {
2982         return true;
2983     }
2985     $sectiondest = $section + $move;
2987     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2988         return false;
2989     }
2991     $retval = move_section_to($course, $section, $sectiondest);
2992     // If section moved, then rebuild course cache.
2993     if ($retval) {
2994         rebuild_course_cache($course->id, true);
2995     }
2996     return $retval;
2999 /**
3000  * Moves a section within a course, from a position to another.
3001  * Be very careful: $section and $destination refer to section number,
3002  * not id!.
3003  *
3004  * @param object $course
3005  * @param int $section Section number (not id!!!)
3006  * @param int $destination
3007  * @return boolean Result
3008  */
3009 function move_section_to($course, $section, $destination) {
3010 /// Moves a whole course section up and down within the course
3011     global $USER, $DB;
3013     if (!$destination && $destination != 0) {
3014         return true;
3015     }
3017     if (($destination > $course->numsections) || ($destination < 1)) {
3018         return false;
3019     }
3021     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3022     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3023             'section ASC, id ASC', 'id, section')) {
3024         return false;
3025     }
3027     $movedsections = reorder_sections($sections, $section, $destination);
3029     // Update all sections. Do this in 2 steps to avoid breaking database
3030     // uniqueness constraint
3031     $transaction = $DB->start_delegated_transaction();
3032     foreach ($movedsections as $id => $position) {
3033         if ($sections[$id] !== $position) {
3034             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3035         }
3036     }
3037     foreach ($movedsections as $id => $position) {
3038         if ($sections[$id] !== $position) {
3039             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3040         }
3041     }
3043     // If we move the highlighted section itself, then just highlight the destination.
3044     // Adjust the higlighted section location if we move something over it either direction.
3045     if ($section == $course->marker) {
3046         course_set_marker($course->id, $destination);
3047     } elseif ($section > $course->marker && $course->marker >= $destination) {
3048         course_set_marker($course->id, $course->marker+1);
3049     } elseif ($section < $course->marker && $course->marker <= $destination) {
3050         course_set_marker($course->id, $course->marker-1);
3051     }
3053     $transaction->allow_commit();
3054     return true;
3057 /**
3058  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3059  * an original position number and a target position number, rebuilds the array so that the
3060  * move is made without any duplication of section positions.
3061  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3062  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3063  *
3064  * @param array $sections
3065  * @param int $origin_position
3066  * @param int $target_position
3067  * @return array
3068  */
3069 function reorder_sections($sections, $origin_position, $target_position) {
3070     if (!is_array($sections)) {
3071         return false;
3072     }
3074     // We can't move section position 0
3075     if ($origin_position < 1) {
3076         echo "We can't move section position 0";
3077         return false;
3078     }
3080     // Locate origin section in sections array
3081     if (!$origin_key = array_search($origin_position, $sections)) {
3082         echo "searched position not in sections array";
3083         return false; // searched position not in sections array
3084     }
3086     // Extract origin section
3087     $origin_section = $sections[$origin_key];
3088     unset($sections[$origin_key]);
3090     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3091     $found = false;
3092     $append_array = array();
3093     foreach ($sections as $id => $position) {
3094         if ($found) {
3095             $append_array[$id] = $position;
3096             unset($sections[$id]);
3097         }
3098         if ($position == $target_position) {
3099             if ($target_position < $origin_position) {
3100                 $append_array[$id] = $position;
3101                 unset($sections[$id]);
3102             }
3103             $found = true;
3104         }
3105     }
3107     // Append moved section
3108     $sections[$origin_key] = $origin_section;
3110     // Append rest of array (if applicable)
3111     if (!empty($append_array)) {
3112         foreach ($append_array as $id => $position) {
3113             $sections[$id] = $position;
3114         }
3115     }
3117     // Renumber positions
3118     $position = 0;
3119     foreach ($sections as $id => $p) {
3120         $sections[$id] = $position;
3121         $position++;
3122     }
3124     return $sections;
3128 /**
3129  * Move the module object $mod to the specified $section
3130  * If $beforemod exists then that is the module
3131  * before which $modid should be inserted
3132  * All parameters are objects
3133  */
3134 function moveto_module($mod, $section, $beforemod=NULL) {
3135     global $DB, $OUTPUT;
3137 /// Remove original module from original section
3138     if (! delete_mod_from_section($mod->id, $mod->section)) {
3139         echo $OUTPUT->notification("Could not delete module from existing section");
3140     }
3142 /// Update module itself if necessary
3144     if ($mod->section != $section->id) {
3145         $mod->section = $section->id;
3146         $DB->update_record("course_modules", $mod);
3147         // if moving to a hidden section then hide module
3148         if (!$section->visible) {
3149             set_coursemodule_visible($mod->id, 0);
3150         }
3151     }
3153 /// Add the module into the new section
3155     $mod->course       = $section->course;
3156     $mod->section      = $section->section;  // need relative reference
3157     $mod->coursemodule = $mod->id;
3159     if (! add_mod_to_section($mod, $beforemod)) {
3160         return false;
3161     }
3163     return true;
3166 /**
3167  * Produces the editing buttons for a module
3168  *
3169  * @global core_renderer $OUTPUT
3170  * @staticvar type $str
3171  * @param stdClass $mod The module to produce editing buttons for
3172  * @param bool $absolute_ignored ignored - all links are absolute
3173  * @param bool $moveselect If true a move seleciton process is used (default true)
3174  * @param int $indent The current indenting
3175  * @param int $section The section to link back to
3176  * @return string XHTML for the editing buttons
3177  */
3178 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3179     global $CFG, $OUTPUT, $COURSE;
3181     static $str;
3183     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3184     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3186     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3187     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3189     // no permission to edit anything
3190     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3191         return false;
3192     }
3194     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3196     if (!isset($str)) {
3197         $str = new stdClass;
3198         $str->assign         = get_string("assignroles", 'role');
3199         $str->delete         = get_string("delete");
3200         $str->move           = get_string("move");
3201         $str->moveup         = get_string("moveup");
3202         $str->movedown       = get_string("movedown");
3203         $str->moveright      = get_string("moveright");
3204         $str->moveleft       = get_string("moveleft");
3205         $str->update         = get_string("update");
3206         $str->duplicate      = get_string("duplicate");
3207         $str->hide           = get_string("hide");
3208         $str->show           = get_string("show");
3209         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3210         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3211         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3212         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3213         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3214         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3215         $str->edittitle = get_string('edittitle', 'moodle');
3216     }
3218     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3220     if ($section !== null) {
3221         $baseurl->param('sr', $section);
3222     }
3223     $actions = array();
3225     // AJAX edit title
3226     if ($mod->modname !== 'label' && $hasmanageactivities && course_ajax_enabled($COURSE)) {
3227         $actions[] = new action_link(
3228             new moodle_url($baseurl, array('update' => $mod->id)),
3229             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3230             null,
3231             array('class' => 'editing_title', 'title' => $str->edittitle)
3232         );
3233     }
3235     // leftright
3236     if ($hasmanageactivities) {
3237         if (right_to_left()) {   // Exchange arrows on RTL
3238             $rightarrow = 't/left';
3239             $leftarrow  = 't/right';
3240         } else {
3241             $rightarrow = 't/right';
3242             $leftarrow  = 't/left';
3243         }
3245         if ($indent > 0) {
3246             $actions[] = new action_link(
3247                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3248                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3249                 null,
3250                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3251             );
3252         }
3253         if ($indent >= 0) {
3254             $actions[] = new action_link(
3255                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3256                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3257                 null,
3258                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3259             );
3260         }
3261     }
3263     // move
3264     if ($hasmanageactivities) {
3265         if ($moveselect) {
3266             $actions[] = new action_link(
3267                 new moodle_url($baseurl, array('copy' => $mod->id)),
3268                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3269                 null,
3270                 array('class' => 'editing_move', 'title' => $str->move)
3271             );
3272         } else {
3273             $actions[] = new action_link(
3274                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3275                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3276                 null,
3277                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3278             );
3279             $actions[] = new action_link(
3280                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3281                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3282                 null,
3283                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3284             );
3285         }
3286     }
3288     // Update
3289     if ($hasmanageactivities) {
3290         $actions[] = new action_link(
3291             new moodle_url($baseurl, array('update' => $mod->id)),
3292             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3293             null,
3294             array('class' => 'editing_update', 'title' => $str->update)
3295         );
3296     }
3298     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3299     if (has_all_capabilities($dupecaps, $coursecontext) && plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3300         $actions[] = new action_link(
3301             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3302             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3303             null,
3304             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3305         );
3306     }
3308     // Delete
3309     if ($hasmanageactivities) {
3310         $actions[] = new action_link(
3311             new moodle_url($baseurl, array('delete' => $mod->id)),
3312             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3313             null,
3314             array('class' => 'editing_delete', 'title' => $str->delete)
3315         );
3316     }
3318     // hideshow
3319     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3320         if ($mod->visible) {
3321             $actions[] = new action_link(
3322                 new moodle_url($baseurl, array('hide' => $mod->id)),
3323                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3324                 null,
3325                 array('class' => 'editing_hide', 'title' => $str->hide)
3326             );
3327         } else {
3328             $actions[] = new action_link(
3329                 new moodle_url($baseurl, array('show' => $mod->id)),
3330                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3331                 null,
3332                 array('class' => 'editing_show', 'title' => $str->show)
3333             );
3334         }
3335     }
3337     // groupmode
3338     if ($hasmanageactivities and $mod->groupmode !== false) {
3339         if ($mod->groupmode == SEPARATEGROUPS) {
3340             $groupmode = 0;
3341             $grouptitle = $str->groupsseparate;
3342             $forcedgrouptitle = $str->forcedgroupsseparate;
3343             $groupclass = 'editing_groupsseparate';
3344             $groupimage = 't/groups';
3345         } else if ($mod->groupmode == VISIBLEGROUPS) {
3346             $groupmode = 1;
3347             $grouptitle = $str->groupsvisible;
3348             $forcedgrouptitle = $str->forcedgroupsvisible;
3349             $groupclass = 'editing_groupsvisible';
3350             $groupimage = 't/groupv';
3351         } else {
3352             $groupmode = 2;
3353             $grouptitle = $str->groupsnone;
3354             $forcedgrouptitle = $str->forcedgroupsnone;
3355             $groupclass = 'editing_groupsnone';
3356             $groupimage = 't/groupn';
3357         }
3358         if ($mod->groupmodelink) {
3359             $actions[] = new action_link(
3360                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3361                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3362                 null,
3363                 array('class' => $groupclass, 'title' => $grouptitle)
3364             );
3365         } else {
3366             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3367         }
3368     }
3370     // Assign
3371     if (has_capability('moodle/role:assign', $modcontext)){
3372         $actions[] = new action_link(
3373             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3374             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3375             null,
3376             array('class' => 'editing_assign', 'title' => $str->assign)
3377         );
3378     }
3380     $output = html_writer::start_tag('span', array('class' => 'commands'));
3381     foreach ($actions as $action) {
3382         if ($action instanceof renderable) {
3383             $output .= $OUTPUT->render($action);
3384         } else {
3385             $output .= $action;
3386         }
3387     }
3388     $output .= html_writer::end_tag('span');
3389     return $output;
3392 /**
3393  * given a course object with shortname & fullname, this function will
3394  * truncate the the number of chars allowed and add ... if it was too long
3395  */
3396 function course_format_name ($course,$max=100) {
3398     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3399     $shortname = format_string($course->shortname, true, array('context' => $context));
3400     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3401     $str = $shortname.': '. $fullname;
3402     if (textlib::strlen($str) <= $max) {
3403         return $str;
3404     }
3405     else {
3406         return textlib::substr($str,0,$max-3).'...';
3407     }
3410 /**
3411  * Is the user allowed to add this type of module to this course?
3412  * @param object $course the course settings. Only $course->id is used.
3413  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3414  * @return bool whether the current user is allowed to add this type of module to this course.
3415  */
3416 function course_allowed_module($course, $modname) {
3417     global $DB;
3419     if (is_numeric($modname)) {
3420         throw new coding_exception('Function course_allowed_module no longer
3421                 supports numeric module ids. Please update your code to pass the module name.');
3422     }
3424     $capability = 'mod/' . $modname . ':addinstance';
3425     if (!get_capability_info($capability)) {
3426         // Debug warning that the capability does not exist, but no more than once per page.
3427         static $warned = array();
3428         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3429         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3430             debugging('The module ' . $modname . ' does not define the standard capability ' .
3431                     $capability , DEBUG_DEVELOPER);
3432             $warned[$modname] = 1;
3433         }
3435         // If the capability does not exist, the module can always be added.
3436         return true;
3437     }
3439     $coursecontext = context_course::instance($course->id);
3440     return has_capability($capability, $coursecontext);
3443 /**
3444  * Recursively delete category including all subcategories and courses.
3445  * @param stdClass $category
3446  * @param boolean $showfeedback display some notices
3447  * @return array return deleted courses
3448  */
3449 function category_delete_full($category, $showfeedback=true) {
3450     global $CFG, $DB;
3451     require_once($CFG->libdir.'/gradelib.php');
3452     require_once($CFG->libdir.'/questionlib.php');
3453     require_once($CFG->dirroot.'/cohort/lib.php');
3455     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3456         foreach ($children as $childcat) {
3457             category_delete_full($childcat, $showfeedback);
3458         }
3459     }
3461     $deletedcourses = array();
3462     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3463         foreach ($courses as $course) {
3464             if (!delete_course($course, false)) {
3465                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3466             }
3467             $deletedcourses[] = $course;
3468         }
3469     }
3471     // move or delete cohorts in this context