772dd41e712edc884c386fd981a4bd9d1c11e614
[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');
32 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
33 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
34 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
35 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
36 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
37 define('FRONTPAGENEWS',           '0');
38 define('FRONTPAGECOURSELIST',     '1');
39 define('FRONTPAGECATEGORYNAMES',  '2');
40 define('FRONTPAGETOPICONLY',      '3');
41 define('FRONTPAGECATEGORYCOMBO',  '4');
42 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
43 define('EXCELROWS', 65535);
44 define('FIRSTUSEDEXCELROW', 3);
46 define('MOD_CLASS_ACTIVITY', 0);
47 define('MOD_CLASS_RESOURCE', 1);
49 function make_log_url($module, $url) {
50     switch ($module) {
51         case 'course':
52             if (strpos($url, 'report/') === 0) {
53                 // there is only one report type, course reports are deprecated
54                 $url = "/$url";
55                 break;
56             }
57         case 'file':
58         case 'login':
59         case 'lib':
60         case 'admin':
61         case 'calendar':
62         case 'mnet course':
63             if (strpos($url, '../') === 0) {
64                 $url = ltrim($url, '.');
65             } else {
66                 $url = "/course/$url";
67             }
68             break;
69         case 'user':
70         case 'blog':
71             $url = "/$module/$url";
72             break;
73         case 'upload':
74             $url = $url;
75             break;
76         case 'coursetags':
77             $url = '/'.$url;
78             break;
79         case 'library':
80         case '':
81             $url = '/';
82             break;
83         case 'message':
84             $url = "/message/$url";
85             break;
86         case 'notes':
87             $url = "/notes/$url";
88             break;
89         case 'tag':
90             $url = "/tag/$url";
91             break;
92         case 'role':
93             $url = '/'.$url;
94             break;
95         default:
96             $url = "/mod/$module/$url";
97             break;
98     }
100     //now let's sanitise urls - there might be some ugly nasties:-(
101     $parts = explode('?', $url);
102     $script = array_shift($parts);
103     if (strpos($script, 'http') === 0) {
104         $script = clean_param($script, PARAM_URL);
105     } else {
106         $script = clean_param($script, PARAM_PATH);
107     }
109     $query = '';
110     if ($parts) {
111         $query = implode('', $parts);
112         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
113         $parts = explode('&', $query);
114         $eq = urlencode('=');
115         foreach ($parts as $key=>$part) {
116             $part = urlencode(urldecode($part));
117             $part = str_replace($eq, '=', $part);
118             $parts[$key] = $part;
119         }
120         $query = '?'.implode('&amp;', $parts);
121     }
123     return $script.$query;
127 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
128                    $modname="", $modid=0, $modaction="", $groupid=0) {
129     global $CFG, $DB;
131     // It is assumed that $date is the GMT time of midnight for that day,
132     // and so the next 86400 seconds worth of logs are printed.
134     /// Setup for group handling.
136     // TODO: I don't understand group/context/etc. enough to be able to do
137     // something interesting with it here
138     // What is the context of a remote course?
140     /// If the group mode is separate, and this user does not have editing privileges,
141     /// then only the user's group can be viewed.
142     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
143     //    $groupid = get_current_group($course->id);
144     //}
145     /// If this course doesn't have groups, no groupid can be specified.
146     //else if (!$course->groupmode) {
147     //    $groupid = 0;
148     //}
150     $groupid = 0;
152     $joins = array();
153     $where = '';
155     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
156               FROM {mnet_log} l
157                LEFT JOIN {user} u ON l.userid = u.id
158               WHERE ";
159     $params = array();
161     $where .= "l.hostid = :hostid";
162     $params['hostid'] = $hostid;
164     // TODO: Is 1 really a magic number referring to the sitename?
165     if ($course != SITEID || $modid != 0) {
166         $where .= " AND l.course=:courseid";
167         $params['courseid'] = $course;
168     }
170     if ($modname) {
171         $where .= " AND l.module = :modname";
172         $params['modname'] = $modname;
173     }
175     if ('site_errors' === $modid) {
176         $where .= " AND ( l.action='error' OR l.action='infected' )";
177     } else if ($modid) {
178         //TODO: This assumes that modids are the same across sites... probably
179         //not true
180         $where .= " AND l.cmid = :modid";
181         $params['modid'] = $modid;
182     }
184     if ($modaction) {
185         $firstletter = substr($modaction, 0, 1);
186         if ($firstletter == '-') {
187             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
188             $params['modaction'] = '%'.substr($modaction, 1).'%';
189         } else {
190             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
191             $params['modaction'] = '%'.$modaction.'%';
192         }
193     }
195     if ($user) {
196         $where .= " AND l.userid = :user";
197         $params['user'] = $user;
198     }
200     if ($date) {
201         $enddate = $date + 86400;
202         $where .= " AND l.time > :date AND l.time < :enddate";
203         $params['date'] = $date;
204         $params['enddate'] = $enddate;
205     }
207     $result = array();
208     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
209     if(!empty($result['totalcount'])) {
210         $where .= " ORDER BY $order";
211         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
212     } else {
213         $result['logs'] = array();
214     }
215     return $result;
218 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
219                    $modname="", $modid=0, $modaction="", $groupid=0) {
220     global $DB, $SESSION, $USER;
221     // It is assumed that $date is the GMT time of midnight for that day,
222     // and so the next 86400 seconds worth of logs are printed.
224     /// Setup for group handling.
226     /// If the group mode is separate, and this user does not have editing privileges,
227     /// then only the user's group can be viewed.
228     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
229         if (isset($SESSION->currentgroup[$course->id])) {
230             $groupid =  $SESSION->currentgroup[$course->id];
231         } else {
232             $groupid = groups_get_all_groups($course->id, $USER->id);
233             if (is_array($groupid)) {
234                 $groupid = array_shift(array_keys($groupid));
235                 $SESSION->currentgroup[$course->id] = $groupid;
236             } else {
237                 $groupid = 0;
238             }
239         }
240     }
241     /// If this course doesn't have groups, no groupid can be specified.
242     else if (!$course->groupmode) {
243         $groupid = 0;
244     }
246     $joins = array();
247     $params = array();
249     if ($course->id != SITEID || $modid != 0) {
250         $joins[] = "l.course = :courseid";
251         $params['courseid'] = $course->id;
252     }
254     if ($modname) {
255         $joins[] = "l.module = :modname";
256         $params['modname'] = $modname;
257     }
259     if ('site_errors' === $modid) {
260         $joins[] = "( l.action='error' OR l.action='infected' )";
261     } else if ($modid) {
262         $joins[] = "l.cmid = :modid";
263         $params['modid'] = $modid;
264     }
266     if ($modaction) {
267         $firstletter = substr($modaction, 0, 1);
268         if ($firstletter == '-') {
269             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
270             $params['modaction'] = '%'.substr($modaction, 1).'%';
271         } else {
272             $joins[] = $DB->sql_like('l.action', ':modaction', false);
273             $params['modaction'] = '%'.$modaction.'%';
274         }
275     }
278     /// Getting all members of a group.
279     if ($groupid and !$user) {
280         if ($gusers = groups_get_members($groupid)) {
281             $gusers = array_keys($gusers);
282             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
283         } else {
284             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
285         }
286     }
287     else if ($user) {
288         $joins[] = "l.userid = :userid";
289         $params['userid'] = $user;
290     }
292     if ($date) {
293         $enddate = $date + 86400;
294         $joins[] = "l.time > :date AND l.time < :enddate";
295         $params['date'] = $date;
296         $params['enddate'] = $enddate;
297     }
299     $selector = implode(' AND ', $joins);
301     $totalcount = 0;  // Initialise
302     $result = array();
303     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
304     $result['totalcount'] = $totalcount;
305     return $result;
309 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
310                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
312     global $CFG, $DB, $OUTPUT;
314     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
315                        $modname, $modid, $modaction, $groupid)) {
316         echo $OUTPUT->notification("No logs found!");
317         echo $OUTPUT->footer();
318         exit;
319     }
321     $courses = array();
323     if ($course->id == SITEID) {
324         $courses[0] = '';
325         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
326             foreach ($ccc as $cc) {
327                 $courses[$cc->id] = $cc->shortname;
328             }
329         }
330     } else {
331         $courses[$course->id] = $course->shortname;
332     }
334     $totalcount = $logs['totalcount'];
335     $count=0;
336     $ldcache = array();
337     $tt = getdate(time());
338     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
340     $strftimedatetime = get_string("strftimedatetime");
342     echo "<div class=\"info\">\n";
343     print_string("displayingrecords", "", $totalcount);
344     echo "</div>\n";
346     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
348     $table = new html_table();
349     $table->classes = array('logtable','generalbox');
350     $table->align = array('right', 'left', 'left');
351     $table->head = array(
352         get_string('time'),
353         get_string('ip_address'),
354         get_string('fullnameuser'),
355         get_string('action'),
356         get_string('info')
357     );
358     $table->data = array();
360     if ($course->id == SITEID) {
361         array_unshift($table->align, 'left');
362         array_unshift($table->head, get_string('course'));
363     }
365     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
366     if (empty($logs['logs'])) {
367         $logs['logs'] = array();
368     }
370     foreach ($logs['logs'] as $log) {
372         if (isset($ldcache[$log->module][$log->action])) {
373             $ld = $ldcache[$log->module][$log->action];
374         } else {
375             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
376             $ldcache[$log->module][$log->action] = $ld;
377         }
378         if ($ld && is_numeric($log->info)) {
379             // ugly hack to make sure fullname is shown correctly
380             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
381                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
382             } else {
383                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
384             }
385         }
387         //Filter log->info
388         $log->info = format_string($log->info);
390         // If $log->url has been trimmed short by the db size restriction
391         // code in add_to_log, keep a note so we don't add a link to a broken url
392         $tl=textlib_get_instance();
393         $brokenurl=($tl->strlen($log->url)==100 && $tl->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;
536     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
537             get_string('fullnameuser')."\t".get_string('action')."\t".get_string('info');
539     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
540                        $modname, $modid, $modaction, $groupid)) {
541         return false;
542     }
544     $courses = array();
546     if ($course->id == SITEID) {
547         $courses[0] = '';
548         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
549             foreach ($ccc as $cc) {
550                 $courses[$cc->id] = $cc->shortname;
551             }
552         }
553     } else {
554         $courses[$course->id] = $course->shortname;
555     }
557     $count=0;
558     $ldcache = array();
559     $tt = getdate(time());
560     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
562     $strftimedatetime = get_string("strftimedatetime");
564     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
565     $filename .= '.txt';
566     header("Content-Type: application/download\n");
567     header("Content-Disposition: attachment; filename=$filename");
568     header("Expires: 0");
569     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
570     header("Pragma: public");
572     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
573     echo $text."\n";
575     if (empty($logs['logs'])) {
576         return true;
577     }
579     foreach ($logs['logs'] as $log) {
580         if (isset($ldcache[$log->module][$log->action])) {
581             $ld = $ldcache[$log->module][$log->action];
582         } else {
583             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
584             $ldcache[$log->module][$log->action] = $ld;
585         }
586         if ($ld && !empty($log->info)) {
587             // ugly hack to make sure fullname is shown correctly
588             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
589                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
590             } else {
591                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
592             }
593         }
595         //Filter log->info
596         $log->info = format_string($log->info);
597         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
599         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
600         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
601         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
602         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
603         $text = implode("\t", $row);
604         echo $text." \n";
605     }
606     return true;
610 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
611                         $modid, $modaction, $groupid) {
613     global $CFG, $DB;
615     require_once("$CFG->libdir/excellib.class.php");
617     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
618                        $modname, $modid, $modaction, $groupid)) {
619         return false;
620     }
622     $courses = array();
624     if ($course->id == SITEID) {
625         $courses[0] = '';
626         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
627             foreach ($ccc as $cc) {
628                 $courses[$cc->id] = $cc->shortname;
629             }
630         }
631     } else {
632         $courses[$course->id] = $course->shortname;
633     }
635     $count=0;
636     $ldcache = array();
637     $tt = getdate(time());
638     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
640     $strftimedatetime = get_string("strftimedatetime");
642     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
643     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
644     $filename .= '.xls';
646     $workbook = new MoodleExcelWorkbook('-');
647     $workbook->send($filename);
649     $worksheet = array();
650     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
651                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
653     // Creating worksheets
654     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
655         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
656         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
657         $worksheet[$wsnumber]->set_column(1, 1, 30);
658         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
659                                     userdate(time(), $strftimedatetime));
660         $col = 0;
661         foreach ($headers as $item) {
662             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
663             $col++;
664         }
665     }
667     if (empty($logs['logs'])) {
668         $workbook->close();
669         return true;
670     }
672     $formatDate =& $workbook->add_format();
673     $formatDate->set_num_format(get_string('log_excel_date_format'));
675     $row = FIRSTUSEDEXCELROW;
676     $wsnumber = 1;
677     $myxls =& $worksheet[$wsnumber];
678     foreach ($logs['logs'] as $log) {
679         if (isset($ldcache[$log->module][$log->action])) {
680             $ld = $ldcache[$log->module][$log->action];
681         } else {
682             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
683             $ldcache[$log->module][$log->action] = $ld;
684         }
685         if ($ld && !empty($log->info)) {
686             // ugly hack to make sure fullname is shown correctly
687             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
688                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
689             } else {
690                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
691             }
692         }
694         // Filter log->info
695         $log->info = format_string($log->info);
696         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
698         if ($nroPages>1) {
699             if ($row > EXCELROWS) {
700                 $wsnumber++;
701                 $myxls =& $worksheet[$wsnumber];
702                 $row = FIRSTUSEDEXCELROW;
703             }
704         }
706         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
708         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
709         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
710         $myxls->write($row, 2, $log->ip, '');
711         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
712         $myxls->write($row, 3, $fullname, '');
713         $myxls->write($row, 4, $log->module.' '.$log->action, '');
714         $myxls->write($row, 5, $log->info, '');
716         $row++;
717     }
719     $workbook->close();
720     return true;
723 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
724                         $modid, $modaction, $groupid) {
726     global $CFG, $DB;
728     require_once("$CFG->libdir/odslib.class.php");
730     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
731                        $modname, $modid, $modaction, $groupid)) {
732         return false;
733     }
735     $courses = array();
737     if ($course->id == SITEID) {
738         $courses[0] = '';
739         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
740             foreach ($ccc as $cc) {
741                 $courses[$cc->id] = $cc->shortname;
742             }
743         }
744     } else {
745         $courses[$course->id] = $course->shortname;
746     }
748     $count=0;
749     $ldcache = array();
750     $tt = getdate(time());
751     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
753     $strftimedatetime = get_string("strftimedatetime");
755     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
756     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
757     $filename .= '.ods';
759     $workbook = new MoodleODSWorkbook('-');
760     $workbook->send($filename);
762     $worksheet = array();
763     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
764                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
766     // Creating worksheets
767     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
768         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
769         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
770         $worksheet[$wsnumber]->set_column(1, 1, 30);
771         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
772                                     userdate(time(), $strftimedatetime));
773         $col = 0;
774         foreach ($headers as $item) {
775             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
776             $col++;
777         }
778     }
780     if (empty($logs['logs'])) {
781         $workbook->close();
782         return true;
783     }
785     $formatDate =& $workbook->add_format();
786     $formatDate->set_num_format(get_string('log_excel_date_format'));
788     $row = FIRSTUSEDEXCELROW;
789     $wsnumber = 1;
790     $myxls =& $worksheet[$wsnumber];
791     foreach ($logs['logs'] as $log) {
792         if (isset($ldcache[$log->module][$log->action])) {
793             $ld = $ldcache[$log->module][$log->action];
794         } else {
795             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
796             $ldcache[$log->module][$log->action] = $ld;
797         }
798         if ($ld && !empty($log->info)) {
799             // ugly hack to make sure fullname is shown correctly
800             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
801                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
802             } else {
803                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
804             }
805         }
807         // Filter log->info
808         $log->info = format_string($log->info);
809         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
811         if ($nroPages>1) {
812             if ($row > EXCELROWS) {
813                 $wsnumber++;
814                 $myxls =& $worksheet[$wsnumber];
815                 $row = FIRSTUSEDEXCELROW;
816             }
817         }
819         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
821         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
822         $myxls->write_date($row, 1, $log->time);
823         $myxls->write_string($row, 2, $log->ip);
824         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
825         $myxls->write_string($row, 3, $fullname);
826         $myxls->write_string($row, 4, $log->module.' '.$log->action);
827         $myxls->write_string($row, 5, $log->info);
829         $row++;
830     }
832     $workbook->close();
833     return true;
837 function print_overview($courses, array $remote_courses=array()) {
838     global $CFG, $USER, $DB, $OUTPUT;
840     $htmlarray = array();
841     if ($modules = $DB->get_records('modules')) {
842         foreach ($modules as $mod) {
843             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
844                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
845                 $fname = $mod->name.'_print_overview';
846                 if (function_exists($fname)) {
847                     $fname($courses,$htmlarray);
848                 }
849             }
850         }
851     }
852     foreach ($courses as $course) {
853         $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
854         echo $OUTPUT->box_start('coursebox');
855         $attributes = array('title' => s($fullname));
856         if (empty($course->visible)) {
857             $attributes['class'] = 'dimmed';
858         }
859         echo $OUTPUT->heading(html_writer::link(
860             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
861         if (array_key_exists($course->id,$htmlarray)) {
862             foreach ($htmlarray[$course->id] as $modname => $html) {
863                 echo $html;
864             }
865         }
866         echo $OUTPUT->box_end();
867     }
869     if (!empty($remote_courses)) {
870         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
871     }
872     foreach ($remote_courses as $course) {
873         echo $OUTPUT->box_start('coursebox');
874         $attributes = array('title' => s($course->fullname));
875         echo $OUTPUT->heading(html_writer::link(
876             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
877             format_string($course->shortname),
878             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
879         echo $OUTPUT->box_end();
880     }
884 /**
885  * This function trawls through the logs looking for
886  * anything new since the user's last login
887  */
888 function print_recent_activity($course) {
889     // $course is an object
890     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
892     $context = get_context_instance(CONTEXT_COURSE, $course->id);
894     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
896     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
898     if (!isguestuser()) {
899         if (!empty($USER->lastcourseaccess[$course->id])) {
900             if ($USER->lastcourseaccess[$course->id] > $timestart) {
901                 $timestart = $USER->lastcourseaccess[$course->id];
902             }
903         }
904     }
906     echo '<div class="activitydate">';
907     echo get_string('activitysince', '', userdate($timestart));
908     echo '</div>';
909     echo '<div class="activityhead">';
911     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
913     echo "</div>\n";
915     $content = false;
917 /// Firstly, have there been any new enrolments?
919     $users = get_recent_enrolments($course->id, $timestart);
921     //Accessibility: new users now appear in an <OL> list.
922     if ($users) {
923         echo '<div class="newusers">';
924         echo $OUTPUT->heading(get_string("newusers").':', 3);
925         $content = true;
926         echo "<ol class=\"list\">\n";
927         foreach ($users as $user) {
928             $fullname = fullname($user, $viewfullnames);
929             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
930         }
931         echo "</ol>\n</div>\n";
932     }
934 /// Next, have there been any modifications to the course structure?
936     $modinfo =& get_fast_modinfo($course);
938     $changelist = array();
940     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
941                                             module = 'course' AND
942                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
943                                     array($timestart, $course->id), "id ASC");
945     if ($logs) {
946         $actions  = array('add mod', 'update mod', 'delete mod');
947         $newgones = array(); // added and later deleted items
948         foreach ($logs as $key => $log) {
949             if (!in_array($log->action, $actions)) {
950                 continue;
951             }
952             $info = explode(' ', $log->info);
954             // note: in most cases I replaced hardcoding of label with use of
955             // $cm->has_view() but it was not possible to do this here because
956             // we don't necessarily have the $cm for it
957             if ($info[0] == 'label') {     // Labels are ignored in recent activity
958                 continue;
959             }
961             if (count($info) != 2) {
962                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
963                 continue;
964             }
966             $modname    = $info[0];
967             $instanceid = $info[1];
969             if ($log->action == 'delete mod') {
970                 // unfortunately we do not know if the mod was visible
971                 if (!array_key_exists($log->info, $newgones)) {
972                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
973                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
974                 }
975             } else {
976                 if (!isset($modinfo->instances[$modname][$instanceid])) {
977                     if ($log->action == 'add mod') {
978                         // do not display added and later deleted activities
979                         $newgones[$log->info] = true;
980                     }
981                     continue;
982                 }
983                 $cm = $modinfo->instances[$modname][$instanceid];
984                 if (!$cm->uservisible) {
985                     continue;
986                 }
988                 if ($log->action == 'add mod') {
989                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
990                     $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>");
992                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
993                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
994                     $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>");
995                 }
996             }
997         }
998     }
1000     if (!empty($changelist)) {
1001         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1002         $content = true;
1003         foreach ($changelist as $changeinfo => $change) {
1004             echo '<p class="activity">'.$change['text'].'</p>';
1005         }
1006     }
1008 /// Now display new things from each module
1010     $usedmodules = array();
1011     foreach($modinfo->cms as $cm) {
1012         if (isset($usedmodules[$cm->modname])) {
1013             continue;
1014         }
1015         if (!$cm->uservisible) {
1016             continue;
1017         }
1018         $usedmodules[$cm->modname] = $cm->modname;
1019     }
1021     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1022         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1023             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1024             $print_recent_activity = $modname.'_print_recent_activity';
1025             if (function_exists($print_recent_activity)) {
1026                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1027                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1028             }
1029         } else {
1030             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1031         }
1032     }
1034     if (! $content) {
1035         echo '<p class="message">'.get_string('nothingnew').'</p>';
1036     }
1039 /**
1040  * For a given course, returns an array of course activity objects
1041  * Each item in the array contains he following properties:
1042  */
1043 function get_array_of_activities($courseid) {
1044 //  cm - course module id
1045 //  mod - name of the module (eg forum)
1046 //  section - the number of the section (eg week or topic)
1047 //  name - the name of the instance
1048 //  visible - is the instance visible or not
1049 //  groupingid - grouping id
1050 //  groupmembersonly - is this instance visible to group members only
1051 //  extra - contains extra string to include in any link
1052     global $CFG, $DB;
1053     if(!empty($CFG->enableavailability)) {
1054         require_once($CFG->libdir.'/conditionlib.php');
1055     }
1057     $course = $DB->get_record('course', array('id'=>$courseid));
1059     if (empty($course)) {
1060         throw new moodle_exception('courseidnotfound');
1061     }
1063     $mod = array();
1065     $rawmods = get_course_mods($courseid);
1066     if (empty($rawmods)) {
1067         return $mod; // always return array
1068     }
1070     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1071        foreach ($sections as $section) {
1072            if (!empty($section->sequence)) {
1073                $sequence = explode(",", $section->sequence);
1074                foreach ($sequence as $seq) {
1075                    if (empty($rawmods[$seq])) {
1076                        continue;
1077                    }
1078                    $mod[$seq] = new stdClass();
1079                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1080                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1081                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1083                     // Oh dear. Inconsistent names left here for backward compatibility.
1084                    $mod[$seq]->section          = $section->section;
1085                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1087                    $mod[$seq]->module           = $rawmods[$seq]->module;
1088                    $mod[$seq]->added            = $rawmods[$seq]->added;
1089                    $mod[$seq]->score            = $rawmods[$seq]->score;
1090                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1091                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1092                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1093                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1094                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1095                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1096                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1097                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1098                    $mod[$seq]->extra            = "";
1099                    $mod[$seq]->completiongradeitemnumber =
1100                            $rawmods[$seq]->completiongradeitemnumber;
1101                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1102                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1103                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1104                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1105                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1106                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1107                    if (!empty($CFG->enableavailability)) {
1108                        condition_info::fill_availability_conditions($rawmods[$seq]);
1109                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1110                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1111                    }
1113                    $modname = $mod[$seq]->mod;
1114                    $functionname = $modname."_get_coursemodule_info";
1116                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1117                        continue;
1118                    }
1120                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1122                    if ($hasfunction = function_exists($functionname)) {
1123                        if ($info = $functionname($rawmods[$seq])) {
1124                            if (!empty($info->icon)) {
1125                                $mod[$seq]->icon = $info->icon;
1126                            }
1127                            if (!empty($info->iconcomponent)) {
1128                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1129                            }
1130                            if (!empty($info->name)) {
1131                                $mod[$seq]->name = $info->name;
1132                            }
1133                            if ($info instanceof cached_cm_info) {
1134                                // When using cached_cm_info you can include three new fields
1135                                // that aren't available for legacy code
1136                                if (!empty($info->content)) {
1137                                    $mod[$seq]->content = $info->content;
1138                                }
1139                                if (!empty($info->extraclasses)) {
1140                                    $mod[$seq]->extraclasses = $info->extraclasses;
1141                                }
1142                                if (!empty($info->iconurl)) {
1143                                    $mod[$seq]->iconurl = $info->iconurl;
1144                                }
1145                                if (!empty($info->onclick)) {
1146                                    $mod[$seq]->onclick = $info->onclick;
1147                                }
1148                                if (!empty($info->customdata)) {
1149                                    $mod[$seq]->customdata = $info->customdata;
1150                                }
1151                            } else {
1152                                // When using a stdclass, the (horrible) deprecated ->extra field
1153                                // is available for BC
1154                                if (!empty($info->extra)) {
1155                                    $mod[$seq]->extra = $info->extra;
1156                                }
1157                            }
1158                        }
1159                    }
1160                    // When there is no modname_get_coursemodule_info function,
1161                    // but showdescriptions is enabled, then we use the 'intro'
1162                    // and 'introformat' fields in the module table
1163                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1164                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1165                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1166                            // Set content from intro and introformat. Filters are disabled
1167                            // because we  filter it with format_text at display time
1168                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1169                                    $modvalues, $rawmods[$seq]->id, false);
1171                            // To save making another query just below, put name in here
1172                            $mod[$seq]->name = $modvalues->name;
1173                        }
1174                    }
1175                    if (!isset($mod[$seq]->name)) {
1176                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1177                    }
1179                    // Minimise the database size by unsetting default options when they are
1180                    // 'empty'. This list corresponds to code in the cm_info constructor.
1181                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1182                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1183                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1184                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1185                            'completionview', 'completionexpected', 'score', 'showdescription')
1186                            as $property) {
1187                        if (property_exists($mod[$seq], $property) &&
1188                                empty($mod[$seq]->{$property})) {
1189                            unset($mod[$seq]->{$property});
1190                        }
1191                    }
1192                    // Special case: this value is usually set to null, but may be 0
1193                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1194                            is_null($mod[$seq]->completiongradeitemnumber)) {
1195                        unset($mod[$seq]->completiongradeitemnumber);
1196                    }
1197                }
1198             }
1199         }
1200     }
1201     return $mod;
1205 /**
1206  * Returns a number of useful structures for course displays
1207  */
1208 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1209     global $CFG, $DB, $COURSE;
1211     $mods          = array();    // course modules indexed by id
1212     $modnames      = array();    // all course module names (except resource!)
1213     $modnamesplural= array();    // all course module names (plural form)
1214     $modnamesused  = array();    // course module names used
1216     if ($allmods = $DB->get_records("modules")) {
1217         foreach ($allmods as $mod) {
1218             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1219                 continue;
1220             }
1221             if ($mod->visible) {
1222                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1223                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1224             }
1225         }
1226         collatorlib::asort($modnames);
1227     } else {
1228         print_error("nomodules", 'debug');
1229     }
1231     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1232     $modinfo = get_fast_modinfo($course);
1234     if ($rawmods=$modinfo->cms) {
1235         foreach($rawmods as $mod) {    // Index the mods
1236             if (empty($modnames[$mod->modname])) {
1237                 continue;
1238             }
1239             $mods[$mod->id] = $mod;
1240             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1241             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1242                 continue;
1243             }
1244             // Check groupings
1245             if (!groups_course_module_visible($mod)) {
1246                 continue;
1247             }
1248             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1249         }
1250         if ($modnamesused) {
1251             collatorlib::asort($modnamesused);
1252         }
1253     }
1256 /**
1257  * Returns an array of sections for the requested course id
1258  *
1259  * This function stores the sections against the course id within a staticvar encase
1260  * of subsequent requests. This is used all over + in some standard libs and course
1261  * format callbacks so subsequent requests are a reality.
1262  *
1263  * @staticvar array $coursesections
1264  * @param int $courseid
1265  * @return array Array of sections
1266  */
1267 function get_all_sections($courseid) {
1268     global $DB;
1269     static $coursesections = array();
1270     if (!array_key_exists($courseid, $coursesections)) {
1271         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1272                            "section, id, course, name, summary, summaryformat, sequence, visible");
1273     }
1274     return $coursesections[$courseid];
1277 /**
1278  * Returns the course section to display or 0 meaning show all sections. Returns 0 for guests.
1279  * It also sets the $USER->display cache to array($courseid=>return value)
1280  *
1281  * @param int $courseid The course id
1282  * @return int Course section to display, 0 means all
1283  */
1284 function course_get_display($courseid) {
1285     global $USER, $DB;
1287     if (!isloggedin() or isguestuser()) {
1288         //do not get settings in db for guests
1289         return 0; //return the implicit setting
1290     }
1292     if (!isset($USER->display[$courseid])) {
1293         if (!$display = $DB->get_field('course_display', 'display', array('userid' => $USER->id, 'course'=>$courseid))) {
1294             $display = 0; // all sections option is not stored in DB, this makes the table much smaller
1295         }
1296         //use display cache for one course only - we need to keep session small
1297         $USER->display = array($courseid => $display);
1298     }
1300     return $USER->display[$courseid];
1303 /**
1304  * Show one section only or all sections.
1305  *
1306  * @param int $courseid The course id
1307  * @param mixed $display show only this section, 0 or 'all' means show all sections
1308  * @return int Course section to display, 0 means all
1309  */
1310 function course_set_display($courseid, $display) {
1311     global $USER, $DB;
1313     if ($display === 'all' or empty($display)) {
1314         $display = 0;
1315     }
1317     if (!isloggedin() or isguestuser()) {
1318         //do not store settings in db for guests
1319         return 0;
1320     }
1322     if ($display == 0) {
1323         //show all, do not store anything in database
1324         $DB->delete_records('course_display', array('userid' => $USER->id, 'course' => $courseid));
1326     } else {
1327         if ($DB->record_exists('course_display', array('userid' => $USER->id, 'course' => $courseid))) {
1328             $DB->set_field('course_display', 'display', $display, array('userid' => $USER->id, 'course' => $courseid));
1329         } else {
1330             $record = new stdClass();
1331             $record->userid = $USER->id;
1332             $record->course = $courseid;
1333             $record->display = $display;
1334             $DB->insert_record('course_display', $record);
1335         }
1336     }
1338     //use display cache for one course only - we need to keep session small
1339     $USER->display = array($courseid => $display);
1341     return $display;
1344 /**
1345  * For a given course section, marks it visible or hidden,
1346  * and does the same for every activity in that section
1347  */
1348 function set_section_visible($courseid, $sectionnumber, $visibility) {
1349     global $DB;
1351     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1352         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1353         if (!empty($section->sequence)) {
1354             $modules = explode(",", $section->sequence);
1355             foreach ($modules as $moduleid) {
1356                 set_coursemodule_visible($moduleid, $visibility, true);
1357             }
1358         }
1359         rebuild_course_cache($courseid);
1360     }
1363 /**
1364  * Obtains shared data that is used in print_section when displaying a
1365  * course-module entry.
1366  *
1367  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1368  *
1369  * This data is also used in other areas of the code.
1370  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1371  * @param object $course Moodle course object
1372  * @return array An array with the following values in this order:
1373  *   $content (optional extra content for after link),
1374  *   $instancename (text of link)
1375  */
1376 function get_print_section_cm_text(cm_info $cm, $course) {
1377     global $OUTPUT;
1379     // Get content from modinfo if specified. Content displays either
1380     // in addition to the standard link (below), or replaces it if
1381     // the link is turned off by setting ->url to null.
1382     if (($content = $cm->get_content()) !== '') {
1383         // Improve filter performance by preloading filter setttings for all
1384         // activities on the course (this does nothing if called multiple
1385         // times)
1386         filter_preload_activities($cm->get_modinfo());
1388         // Get module context
1389         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1390         $labelformatoptions = new stdClass();
1391         $labelformatoptions->noclean = true;
1392         $labelformatoptions->overflowdiv = true;
1393         $labelformatoptions->context = $modulecontext;
1394         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1395     } else {
1396         $content = '';
1397     }
1399     // Get course context
1400     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1401     $stringoptions = new stdClass;
1402     $stringoptions->context = $coursecontext;
1403     $instancename = format_string($cm->name, true,  $stringoptions);
1404     return array($content, $instancename);
1407 /**
1408  * Prints a section full of activity modules
1409  */
1410 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1411     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1413     static $initialised;
1415     static $groupbuttons;
1416     static $groupbuttonslink;
1417     static $isediting;
1418     static $ismoving;
1419     static $strmovehere;
1420     static $strmovefull;
1421     static $strunreadpostsone;
1422     static $groupings;
1423     static $modulenames;
1425     if (!isset($initialised)) {
1426         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1427         $groupbuttonslink = (!$course->groupmodeforce);
1428         $isediting        = $PAGE->user_is_editing();
1429         $ismoving         = $isediting && ismoving($course->id);
1430         if ($ismoving) {
1431             $strmovehere  = get_string("movehere");
1432             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1433         }
1434         $modulenames      = array();
1435         $initialised = true;
1436     }
1438     $tl = textlib_get_instance();
1440     $modinfo = get_fast_modinfo($course);
1441     $completioninfo = new completion_info($course);
1443     //Accessibility: replace table with list <ul>, but don't output empty list.
1444     if (!empty($section->sequence)) {
1446         // Fix bug #5027, don't want style=\"width:$width\".
1447         echo "<ul class=\"section img-text\">\n";
1448         $sectionmods = explode(",", $section->sequence);
1450         foreach ($sectionmods as $modnumber) {
1451             if (empty($mods[$modnumber])) {
1452                 continue;
1453             }
1455             /**
1456              * @var cm_info
1457              */
1458             $mod = $mods[$modnumber];
1460             if ($ismoving and $mod->id == $USER->activitycopy) {
1461                 // do not display moving mod
1462                 continue;
1463             }
1465             if (isset($modinfo->cms[$modnumber])) {
1466                 // We can continue (because it will not be displayed at all)
1467                 // if:
1468                 // 1) The activity is not visible to users
1469                 // and
1470                 // 2a) The 'showavailability' option is not set (if that is set,
1471                 //     we need to display the activity so we can show
1472                 //     availability info)
1473                 // or
1474                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1475                 //     hidden in a way that leaves no info, such as using the
1476                 //     eye icon.
1477                 if (!$modinfo->cms[$modnumber]->uservisible &&
1478                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1479                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1480                     // visibility shortcut
1481                     continue;
1482                 }
1483             } else {
1484                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1485                     // module not installed
1486                     continue;
1487                 }
1488                 if (!coursemodule_visible_for_user($mod) &&
1489                     empty($mod->showavailability)) {
1490                     // full visibility check
1491                     continue;
1492                 }
1493             }
1495             if (!isset($modulenames[$mod->modname])) {
1496                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1497             }
1498             $modulename = $modulenames[$mod->modname];
1500             // In some cases the activity is visible to user, but it is
1501             // dimmed. This is done if viewhiddenactivities is true and if:
1502             // 1. the activity is not visible, or
1503             // 2. the activity has dates set which do not include current, or
1504             // 3. the activity has any other conditions set (regardless of whether
1505             //    current user meets them)
1506             $canviewhidden = has_capability(
1507                 'moodle/course:viewhiddenactivities',
1508                 get_context_instance(CONTEXT_MODULE, $mod->id));
1509             $accessiblebutdim = false;
1510             if ($canviewhidden) {
1511                 $accessiblebutdim = !$mod->visible;
1512                 if (!empty($CFG->enableavailability)) {
1513                     $accessiblebutdim = $accessiblebutdim ||
1514                         $mod->availablefrom > time() ||
1515                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1516                         count($mod->conditionsgrade) > 0 ||
1517                         count($mod->conditionscompletion) > 0;
1518                 }
1519             }
1521             $liclasses = array();
1522             $liclasses[] = 'activity';
1523             $liclasses[] = $mod->modname;
1524             $liclasses[] = 'modtype_'.$mod->modname;
1525             $extraclasses = $mod->get_extra_classes();
1526             if ($extraclasses) {
1527                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1528             }
1529             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1530             if ($ismoving) {
1531                 echo '<a title="'.$strmovefull.'"'.
1532                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1533                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1534                      ' alt="'.$strmovehere.'" /></a><br />
1535                      ';
1536             }
1538             $classes = array('mod-indent');
1539             if (!empty($mod->indent)) {
1540                 $classes[] = 'mod-indent-'.$mod->indent;
1541                 if ($mod->indent > 15) {
1542                     $classes[] = 'mod-indent-huge';
1543                 }
1544             }
1545             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1547             // Get data about this course-module
1548             list($content, $instancename) =
1549                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1551             //Accessibility: for files get description via icon, this is very ugly hack!
1552             $altname = '';
1553             $altname = $mod->modfullname;
1554             if (!empty($customicon)) {
1555                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1556                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1557                     $mimetype = mimeinfo_from_icon('type', $customicon);
1558                     $altname = get_mimetype_description($mimetype);
1559                 }
1560             }
1561             // Avoid unnecessary duplication: if e.g. a forum name already
1562             // includes the word forum (or Forum, etc) then it is unhelpful
1563             // to include that in the accessible description that is added.
1564             if (false !== strpos($tl->strtolower($instancename),
1565                     $tl->strtolower($altname))) {
1566                 $altname = '';
1567             }
1568             // File type after name, for alphabetic lists (screen reader).
1569             if ($altname) {
1570                 $altname = get_accesshide(' '.$altname);
1571             }
1573             // We may be displaying this just in order to show information
1574             // about visibility, without the actual link
1575             $contentpart = '';
1576             if ($mod->uservisible) {
1577                 // Nope - in this case the link is fully working for user
1578                 $linkclasses = '';
1579                 $textclasses = '';
1580                 if ($accessiblebutdim) {
1581                     $linkclasses .= ' dimmed';
1582                     $textclasses .= ' dimmed_text';
1583                     $accesstext = '<span class="accesshide">'.
1584                         get_string('hiddenfromstudents').': </span>';
1585                 } else {
1586                     $accesstext = '';
1587                 }
1588                 if ($linkclasses) {
1589                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1590                 } else {
1591                     $linkcss = '';
1592                 }
1593                 if ($textclasses) {
1594                     $textcss = 'class="' . trim($textclasses) . '" ';
1595                 } else {
1596                     $textcss = '';
1597                 }
1599                 // Get on-click attribute value if specified
1600                 $onclick = $mod->get_on_click();
1601                 if ($onclick) {
1602                     $onclick = ' onclick="' . $onclick . '"';
1603                 }
1605                 if ($url = $mod->get_url()) {
1606                     // Display link itself
1607                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1608                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1609                             '" class="activityicon" alt="' .
1610                             $modulename . '" /> ' .
1611                             $accesstext . '<span class="instancename">' .
1612                             $instancename . $altname . '</span></a>';
1614                     // If specified, display extra content after link
1615                     if ($content) {
1616                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1617                                 '">' . $content . '</div>';
1618                     }
1619                 } else {
1620                     // No link, so display only content
1621                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1622                             $accesstext . $content . '</div>';
1623                 }
1625                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1626                     if (!isset($groupings)) {
1627                         $groupings = groups_get_all_groupings($course->id);
1628                     }
1629                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1630                 }
1631             } else {
1632                 $textclasses = $extraclasses;
1633                 $textclasses .= ' dimmed_text';
1634                 if ($textclasses) {
1635                     $textcss = 'class="' . trim($textclasses) . '" ';
1636                 } else {
1637                     $textcss = '';
1638                 }
1639                 $accesstext = '<span class="accesshide">' .
1640                         get_string('notavailableyet', 'condition') .
1641                         ': </span>';
1643                 if ($url = $mod->get_url()) {
1644                     // Display greyed-out text of link
1645                     echo '<div ' . $textcss . $mod->extra .
1646                             ' >' . '<img src="' . $mod->get_icon_url() .
1647                             '" class="activityicon" alt="' .
1648                             $modulename .
1649                             '" /> <span>'. $instancename . $altname .
1650                             '</span></div>';
1652                     // Do not display content after link when it is greyed out like this.
1653                 } else {
1654                     // No link, so display only content (also greyed)
1655                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1656                             $accesstext . $content . '</div>';
1657                 }
1658             }
1660             // Module can put text after the link (e.g. forum unread)
1661             echo $mod->get_after_link();
1663             // If there is content but NO link (eg label), then display the
1664             // content here (BEFORE any icons). In this case cons must be
1665             // displayed after the content so that it makes more sense visually
1666             // and for accessibility reasons, e.g. if you have a one-line label
1667             // it should work similarly (at least in terms of ordering) to an
1668             // activity.
1669             if (empty($url)) {
1670                 echo $contentpart;
1671             }
1673             if ($isediting) {
1674                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1675                     if (! $mod->groupmodelink = $groupbuttonslink) {
1676                         $mod->groupmode = $course->groupmode;
1677                     }
1679                 } else {
1680                     $mod->groupmode = false;
1681                 }
1682                 echo '&nbsp;&nbsp;';
1683                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1684                 echo $mod->get_after_edit_icons();
1685             }
1687             // Completion
1688             $completion = $hidecompletion
1689                 ? COMPLETION_TRACKING_NONE
1690                 : $completioninfo->is_enabled($mod);
1691             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1692                 !isguestuser() && $mod->uservisible) {
1693                 $completiondata = $completioninfo->get_data($mod,true);
1694                 $completionicon = '';
1695                 if ($isediting) {
1696                     switch ($completion) {
1697                         case COMPLETION_TRACKING_MANUAL :
1698                             $completionicon = 'manual-enabled'; break;
1699                         case COMPLETION_TRACKING_AUTOMATIC :
1700                             $completionicon = 'auto-enabled'; break;
1701                         default: // wtf
1702                     }
1703                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1704                     switch($completiondata->completionstate) {
1705                         case COMPLETION_INCOMPLETE:
1706                             $completionicon = 'manual-n'; break;
1707                         case COMPLETION_COMPLETE:
1708                             $completionicon = 'manual-y'; break;
1709                     }
1710                 } else { // Automatic
1711                     switch($completiondata->completionstate) {
1712                         case COMPLETION_INCOMPLETE:
1713                             $completionicon = 'auto-n'; break;
1714                         case COMPLETION_COMPLETE:
1715                             $completionicon = 'auto-y'; break;
1716                         case COMPLETION_COMPLETE_PASS:
1717                             $completionicon = 'auto-pass'; break;
1718                         case COMPLETION_COMPLETE_FAIL:
1719                             $completionicon = 'auto-fail'; break;
1720                     }
1721                 }
1722                 if ($completionicon) {
1723                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1724                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1725                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1726                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1727                         $newstate =
1728                             $completiondata->completionstate==COMPLETION_COMPLETE
1729                             ? COMPLETION_INCOMPLETE
1730                             : COMPLETION_COMPLETE;
1731                         // In manual mode the icon is a toggle form...
1733                         // If this completion state is used by the
1734                         // conditional activities system, we need to turn
1735                         // off the JS.
1736                         if (!empty($CFG->enableavailability) &&
1737                             condition_info::completion_value_used_as_condition($course, $mod)) {
1738                             $extraclass = ' preventjs';
1739                         } else {
1740                             $extraclass = '';
1741                         }
1742                         echo "
1743 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1744 <input type='hidden' name='id' value='{$mod->id}' />
1745 <input type='hidden' name='sesskey' value='".sesskey()."' />
1746 <input type='hidden' name='completionstate' value='$newstate' />
1747 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1748 </div></form>";
1749                     } else {
1750                         // In auto mode, or when editing, the icon is just an image
1751                         echo "<span class='autocompletion'>";
1752                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1753                     }
1754                 }
1755             }
1757             // If there is content AND a link, then display the content here
1758             // (AFTER any icons). Otherwise it was displayed before
1759             if (!empty($url)) {
1760                 echo $contentpart;
1761             }
1763             // Show availability information (for someone who isn't allowed to
1764             // see the activity itself, or for staff)
1765             if (!$mod->uservisible) {
1766                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1767             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1768                 $ci = new condition_info($mod);
1769                 $fullinfo = $ci->get_full_information();
1770                 if($fullinfo) {
1771                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1772                         ? 'userrestriction_visible'
1773                         : 'userrestriction_hidden','condition',
1774                         $fullinfo).'</div>';
1775                 }
1776             }
1778             echo html_writer::end_tag('div');
1779             echo html_writer::end_tag('li')."\n";
1780         }
1782     } elseif ($ismoving) {
1783         echo "<ul class=\"section\">\n";
1784     }
1786     if ($ismoving) {
1787         echo '<li><a title="'.$strmovefull.'"'.
1788              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1789              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1790              ' alt="'.$strmovehere.'" /></a></li>
1791              ';
1792     }
1793     if (!empty($section->sequence) || $ismoving) {
1794         echo "</ul><!--class='section'-->\n\n";
1795     }
1798 /**
1799  * Prints the menus to add activities and resources.
1800  */
1801 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1802     global $CFG, $OUTPUT;
1804     // check to see if user can add menus
1805     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1806         return false;
1807     }
1809     // Retrieve all modules with associated metadata
1810     $modules = get_module_metadata($course, $modnames);
1812     // We'll sort resources and activities into two lists
1813     $resources = array();
1814     $activities = array();
1816     // We need to add the section section to the link for each module
1817     $sectionlink = '&section=' . $section;
1819     foreach ($modules as $module) {
1820         if (isset($module->types)) {
1821             // This module has a subtype
1822             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1823             $subtypes = array();
1824             foreach ($module->types as $subtype) {
1825                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1826             }
1828             // Sort module subtypes into the list
1829             if (!empty($module->title)) {
1830                 // This grouping has a name
1831                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1832                     $resources[] = array($module->title=>$subtypes);
1833                 } else {
1834                     $activities[] = array($module->title=>$subtypes);
1835                 }
1836             } else {
1837                 // This grouping does not have a name
1838                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1839                     $resources = array_merge($resources, $subtypes);
1840                 } else {
1841                     $activities = array_merge($activities, $subtypes);
1842                 }
1843             }
1844         } else {
1845             // This module has no subtypes
1846             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1847                 $resources[$module->link . $sectionlink] = $module->title;
1848             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1849                 // System modules cannot be added by user, do not add to dropdown
1850             } else {
1851                 $activities[$module->link . $sectionlink] = $module->title;
1852             }
1853         }
1854     }
1856     $straddactivity = get_string('addactivity');
1857     $straddresource = get_string('addresource');
1859     $output  = '<div class="section_add_menus">';
1861     if (!$vertical) {
1862         $output .= '<div class="horizontal">';
1863     }
1865     if (!empty($resources)) {
1866         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1867         $select->set_help_icon('resources');
1868         $output .= $OUTPUT->render($select);
1869     }
1871     if (!empty($activities)) {
1872         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1873         $select->set_help_icon('activities');
1874         $output .= $OUTPUT->render($select);
1875     }
1877     if (!$vertical) {
1878         $output .= '</div>';
1879     }
1881     $output .= '</div>';
1883     if ($return) {
1884         return $output;
1885     } else {
1886         echo $output;
1887     }
1890 /**
1891  * Retrieve all metadata for the requested modules
1892  *
1893  * @param object $course The Course
1894  * @param array $modnames An array containing the list of modules and their
1895  * names
1896  * @return array A list of stdClass objects containing metadata about each
1897  * module
1898  */
1899 function get_module_metadata($course, $modnames) {
1900     global $CFG, $OUTPUT;
1902     // get_module_metadata will be called once per section on the page and courses may show
1903     // different modules to one another
1904     static $modlist = array();
1905     if (!isset($modlist[$course->id])) {
1906         $modlist[$course->id] = array();
1907     }
1909     $return = array();
1910     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&add=';
1911     foreach($modnames as $modname => $modnamestr) {
1912         if (!course_allowed_module($course, $modname)) {
1913             continue;
1914         }
1915         if (isset($modlist[$modname])) {
1916             // This module is already cached
1917             $return[$modname] = $modlist[$course->id][$modname];
1918             continue;
1919         }
1921         // Include the module lib
1922         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1923         if (!file_exists($libfile)) {
1924             continue;
1925         }
1926         include_once($libfile);
1928         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1929         $gettypesfunc =  $modname.'_get_types';
1930         if (function_exists($gettypesfunc)) {
1931             if ($types = $gettypesfunc()) {
1932                 $group = new stdClass();
1933                 $group->name = $modname;
1934                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1935                 foreach($types as $type) {
1936                     if ($type->typestr === '--') {
1937                         continue;
1938                     }
1939                     if (strpos($type->typestr, '--') === 0) {
1940                         $group->title = str_replace('--', '', $type->typestr);
1941                         continue;
1942                     }
1943                     // Set the Sub Type metadata
1944                     $subtype = new stdClass();
1945                     $subtype->title = $type->typestr;
1946                     $subtype->type = str_replace('&amp;', '&', $type->type);
1947                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1948                     $subtype->archetype = $type->modclass;
1950                     // The group archetype should match the subtype archetypes and all subtypes
1951                     // should have the same archetype
1952                     $group->archetype = $subtype->archetype;
1954                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1955                         $subtype->help = get_string('help' . $subtype->name, $modname);
1956                     }
1957                     $subtype->link = $urlbase . $type->type;
1958                     $group->types[] = $subtype;
1959                 }
1960                 $modlist[$course->id][$modname] = $group;
1961             }
1962         } else {
1963             $module = new stdClass();
1964             $module->title = get_string('modulename', $modname);
1965             $module->name = $modname;
1966             $module->link = $urlbase . $modname;
1967             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1968             if (get_string_manager()->string_exists('modulename_help', $modname)) {
1969                 $module->help = get_string('modulename_help', $modname);
1970             }
1971             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1972             $modlist[$course->id][$modname] = $module;
1973         }
1974         $return[$modname] = $modlist[$course->id][$modname];
1975     }
1977     return $return;
1980 /**
1981  * Return the course category context for the category with id $categoryid, except
1982  * that if $categoryid is 0, return the system context.
1983  *
1984  * @param integer $categoryid a category id or 0.
1985  * @return object the corresponding context
1986  */
1987 function get_category_or_system_context($categoryid) {
1988     if ($categoryid) {
1989         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1990     } else {
1991         return get_context_instance(CONTEXT_SYSTEM);
1992     }
1995 /**
1996  * Gets the child categories of a given courses category. Uses a static cache
1997  * to make repeat calls efficient.
1998  *
1999  * @param int $parentid the id of a course category.
2000  * @return array all the child course categories.
2001  */
2002 function get_child_categories($parentid) {
2003     static $allcategories = null;
2005     // only fill in this variable the first time
2006     if (null == $allcategories) {
2007         $allcategories = array();
2009         $categories = get_categories();
2010         foreach ($categories as $category) {
2011             if (empty($allcategories[$category->parent])) {
2012                 $allcategories[$category->parent] = array();
2013             }
2014             $allcategories[$category->parent][] = $category;
2015         }
2016     }
2018     if (empty($allcategories[$parentid])) {
2019         return array();
2020     } else {
2021         return $allcategories[$parentid];
2022     }
2025 /**
2026  * This function recursively travels the categories, building up a nice list
2027  * for display. It also makes an array that list all the parents for each
2028  * category.
2029  *
2030  * For example, if you have a tree of categories like:
2031  *   Miscellaneous (id = 1)
2032  *      Subcategory (id = 2)
2033  *         Sub-subcategory (id = 4)
2034  *   Other category (id = 3)
2035  * Then after calling this function you will have
2036  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2037  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2038  *      3 => 'Other category');
2039  * $parents = array(2 => array(1), 4 => array(1, 2));
2040  *
2041  * If you specify $requiredcapability, then only categories where the current
2042  * user has that capability will be added to $list, although all categories
2043  * will still be added to $parents, and if you only have $requiredcapability
2044  * in a child category, not the parent, then the child catgegory will still be
2045  * included.
2046  *
2047  * If you specify the option $excluded, then that category, and all its children,
2048  * are omitted from the tree. This is useful when you are doing something like
2049  * moving categories, where you do not want to allow people to move a category
2050  * to be the child of itself.
2051  *
2052  * @param array $list For output, accumulates an array categoryid => full category path name
2053  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2054  * @param string/array $requiredcapability if given, only categories where the current
2055  *      user has this capability will be added to $list. Can also be an array of capabilities,
2056  *      in which case they are all required.
2057  * @param integer $excludeid Omit this category and its children from the lists built.
2058  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2059  * @param string $path For internal use, as part of recursive calls.
2060  */
2061 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2062         $excludeid = 0, $category = NULL, $path = "") {
2064     // initialize the arrays if needed
2065     if (!is_array($list)) {
2066         $list = array();
2067     }
2068     if (!is_array($parents)) {
2069         $parents = array();
2070     }
2072     if (empty($category)) {
2073         // Start at the top level.
2074         $category = new stdClass;
2075         $category->id = 0;
2076     } else {
2077         // This is the excluded category, don't include it.
2078         if ($excludeid > 0 && $excludeid == $category->id) {
2079             return;
2080         }
2082         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2083         $categoryname = format_string($category->name, true, array('context' => $context));
2085         // Update $path.
2086         if ($path) {
2087             $path = $path.' / '.$categoryname;
2088         } else {
2089             $path = $categoryname;
2090         }
2092         // Add this category to $list, if the permissions check out.
2093         if (empty($requiredcapability)) {
2094             $list[$category->id] = $path;
2096         } else {
2097             $requiredcapability = (array)$requiredcapability;
2098             if (has_all_capabilities($requiredcapability, $context)) {
2099                 $list[$category->id] = $path;
2100             }
2101         }
2102     }
2104     // Add all the children recursively, while updating the parents array.
2105     if ($categories = get_child_categories($category->id)) {
2106         foreach ($categories as $cat) {
2107             if (!empty($category->id)) {
2108                 if (isset($parents[$category->id])) {
2109                     $parents[$cat->id]   = $parents[$category->id];
2110                 }
2111                 $parents[$cat->id][] = $category->id;
2112             }
2113             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2114         }
2115     }
2118 /**
2119  * This function generates a structured array of courses and categories.
2120  *
2121  * The depth of categories is limited by $CFG->maxcategorydepth however there
2122  * is no limit on the number of courses!
2123  *
2124  * Suitable for use with the course renderers course_category_tree method:
2125  * $renderer = $PAGE->get_renderer('core','course');
2126  * echo $renderer->course_category_tree(get_course_category_tree());
2127  *
2128  * @global moodle_database $DB
2129  * @param int $id
2130  * @param int $depth
2131  */
2132 function get_course_category_tree($id = 0, $depth = 0) {
2133     global $DB, $CFG;
2134     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2135     $categories = get_child_categories($id);
2136     $categoryids = array();
2137     foreach ($categories as $key => &$category) {
2138         if (!$category->visible && !$viewhiddencats) {
2139             unset($categories[$key]);
2140             continue;
2141         }
2142         $categoryids[$category->id] = $category;
2143         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2144             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2145             foreach ($subcategories as $subid=>$subcat) {
2146                 $categoryids[$subid] = $subcat;
2147             }
2148             $category->courses = array();
2149         }
2150     }
2152     if ($depth > 0) {
2153         // This is a recursive call so return the required array
2154         return array($categories, $categoryids);
2155     }
2157     // The depth is 0 this function has just been called so we can finish it off
2159     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2160     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2161     $sql = "SELECT
2162             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2163             $ccselect
2164             FROM {course} c
2165             $ccjoin
2166             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2167     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2168         // loop throught them
2169         foreach ($courses as $course) {
2170             if ($course->id == SITEID) {
2171                 continue;
2172             }
2173             context_instance_preload($course);
2174             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2175                 $categoryids[$course->category]->courses[$course->id] = $course;
2176             }
2177         }
2178     }
2179     return $categories;
2182 /**
2183  * Recursive function to print out all the categories in a nice format
2184  * with or without courses included
2185  */
2186 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2187     global $CFG;
2189     // maxcategorydepth == 0 meant no limit
2190     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2191         return;
2192     }
2194     if (!$displaylist) {
2195         make_categories_list($displaylist, $parentslist);
2196     }
2198     if ($category) {
2199         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2200             print_category_info($category, $depth, $showcourses);
2201         } else {
2202             return;  // Don't bother printing children of invisible categories
2203         }
2205     } else {
2206         $category = new stdClass();
2207         $category->id = "0";
2208     }
2210     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2211         $countcats = count($categories);
2212         $count = 0;
2213         $first = true;
2214         $last = false;
2215         foreach ($categories as $cat) {
2216             $count++;
2217             if ($count == $countcats) {
2218                 $last = true;
2219             }
2220             $up = $first ? false : true;
2221             $down = $last ? false : true;
2222             $first = false;
2224             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2225         }
2226     }
2229 /**
2230  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2231  */
2232 function make_categories_options() {
2233     make_categories_list($cats,$parents);
2234     foreach ($cats as $key => $value) {
2235         if (array_key_exists($key,$parents)) {
2236             if ($indent = count($parents[$key])) {
2237                 for ($i = 0; $i < $indent; $i++) {
2238                     $cats[$key] = '&nbsp;'.$cats[$key];
2239                 }
2240             }
2241         }
2242     }
2243     return $cats;
2246 /**
2247  * Gets the name of a course to be displayed when showing a list of courses.
2248  * By default this is just $course->fullname but user can configure it. The
2249  * result of this function should be passed through print_string.
2250  * @param object $course Moodle course object
2251  * @return string Display name of course (either fullname or short + fullname)
2252  */
2253 function get_course_display_name_for_list($course) {
2254     global $CFG;
2255     if (!empty($CFG->courselistshortnames)) {
2256         return $course->shortname . ' ' .$course->fullname;
2257     } else {
2258         return $course->fullname;
2259     }
2262 /**
2263  * Prints the category info in indented fashion
2264  * This function is only used by print_whole_category_list() above
2265  */
2266 function print_category_info($category, $depth=0, $showcourses = false) {
2267     global $CFG, $DB, $OUTPUT;
2269     $strsummary = get_string('summary');
2271     $catlinkcss = null;
2272     if (!$category->visible) {
2273         $catlinkcss = array('class'=>'dimmed');
2274     }
2275     static $coursecount = null;
2276     if (null === $coursecount) {
2277         // only need to check this once
2278         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2279     }
2281     if ($showcourses and $coursecount) {
2282         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2283     } else {
2284         $catimage = "&nbsp;";
2285     }
2287     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2288     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2289     $fullname = format_string($category->name, true, array('context' => $context));
2291     if ($showcourses and $coursecount) {
2292         echo '<div class="categorylist clearfix">';
2293         $cat = '';
2294         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2295         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2296         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2298         $html = '';
2299         if ($depth > 0) {
2300             for ($i=0; $i< $depth; $i++) {
2301                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2302                 $cat = '';
2303             }
2304         } else {
2305             $html = $cat;
2306         }
2307         echo html_writer::tag('div', $html, array('class'=>'category'));
2308         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2310         // does the depth exceed maxcategorydepth
2311         // maxcategorydepth == 0 or unset meant no limit
2312         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2313         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2314             foreach ($courses as $course) {
2315                 $linkcss = null;
2316                 if (!$course->visible) {
2317                     $linkcss = array('class'=>'dimmed');
2318                 }
2320                 $coursename = get_course_display_name_for_list($course);
2321                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2323                 // print enrol info
2324                 $courseicon = '';
2325                 if ($icons = enrol_get_course_info_icons($course)) {
2326                     foreach ($icons as $pix_icon) {
2327                         $courseicon = $OUTPUT->render($pix_icon).' ';
2328                     }
2329                 }
2331                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2333                 if ($course->summary) {
2334                     $link = new moodle_url('/course/info.php?id='.$course->id);
2335                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2336                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2337                         array('title'=>$strsummary));
2339                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2340                 }
2342                 $html = '';
2343                 for ($i=0; $i <= $depth; $i++) {
2344                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2345                     $coursecontent = '';
2346                 }
2347                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2348             }
2349         }
2350         echo '</div>';
2351     } else {
2352         echo '<div class="categorylist">';
2353         $html = '';
2354         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2355         if (count($courses) > 0) {
2356             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2357         }
2359         if ($depth > 0) {
2360             for ($i=0; $i< $depth; $i++) {
2361                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2362                 $cat = '';
2363             }
2364         } else {
2365             $html = $cat;
2366         }
2368         echo html_writer::tag('div', $html, array('class'=>'category'));
2369         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2370         echo '</div>';
2371     }
2374 /**
2375  * Print the buttons relating to course requests.
2376  *
2377  * @param object $systemcontext the system context.
2378  */
2379 function print_course_request_buttons($systemcontext) {
2380     global $CFG, $DB, $OUTPUT;
2381     if (empty($CFG->enablecourserequests)) {
2382         return;
2383     }
2384     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2385     /// Print a button to request a new course
2386         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2387     }
2388     /// Print a button to manage pending requests
2389     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2390         $disabled = !$DB->record_exists('course_request', array());
2391         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2392     }
2395 /**
2396  * Does the user have permission to edit things in this category?
2397  *
2398  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2399  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2400  */
2401 function can_edit_in_category($categoryid = 0) {
2402     $context = get_category_or_system_context($categoryid);
2403     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2406 /**
2407  * Prints the turn editing on/off button on course/index.php or course/category.php.
2408  *
2409  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2410  * @return string HTML of the editing button, or empty string, if this user is not allowed
2411  *      to see it.
2412  */
2413 function update_category_button($categoryid = 0) {
2414     global $CFG, $PAGE, $OUTPUT;
2416     // Check permissions.
2417     if (!can_edit_in_category($categoryid)) {
2418         return '';
2419     }
2421     // Work out the appropriate action.
2422     if ($PAGE->user_is_editing()) {
2423         $label = get_string('turneditingoff');
2424         $edit = 'off';
2425     } else {
2426         $label = get_string('turneditingon');
2427         $edit = 'on';
2428     }
2430     // Generate the button HTML.
2431     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2432     if ($categoryid) {
2433         $options['id'] = $categoryid;
2434         $page = 'category.php';
2435     } else {
2436         $page = 'index.php';
2437     }
2438     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2441 /**
2442  * Category is 0 (for all courses) or an object
2443  */
2444 function print_courses($category) {
2445     global $CFG, $OUTPUT;
2447     if (!is_object($category) && $category==0) {
2448         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2449         if (is_array($categories) && count($categories) == 1) {
2450             $category   = array_shift($categories);
2451             $courses    = get_courses_wmanagers($category->id,
2452                                                 'c.sortorder ASC',
2453                                                 array('summary','summaryformat'));
2454         } else {
2455             $courses    = get_courses_wmanagers('all',
2456                                                 'c.sortorder ASC',
2457                                                 array('summary','summaryformat'));
2458         }
2459         unset($categories);
2460     } else {
2461         $courses    = get_courses_wmanagers($category->id,
2462                                             'c.sortorder ASC',
2463                                             array('summary','summaryformat'));
2464     }
2466     if ($courses) {
2467         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2468         foreach ($courses as $course) {
2469             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2470             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2471                 echo html_writer::start_tag('li');
2472                 print_course($course);
2473                 echo html_writer::end_tag('li');
2474             }
2475         }
2476         echo html_writer::end_tag('ul');
2477     } else {
2478         echo $OUTPUT->heading(get_string("nocoursesyet"));
2479         $context = get_context_instance(CONTEXT_SYSTEM);
2480         if (has_capability('moodle/course:create', $context)) {
2481             $options = array();
2482             if (!empty($category->id)) {
2483                 $options['category'] = $category->id;
2484             } else {
2485                 $options['category'] = $CFG->defaultrequestcategory;
2486             }
2487             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2488             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2489             echo html_writer::end_tag('div');
2490         }
2491     }
2494 /**
2495  * Print a description of a course, suitable for browsing in a list.
2496  *
2497  * @param object $course the course object.
2498  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2499  */
2500 function print_course($course, $highlightterms = '') {
2501     global $CFG, $USER, $DB, $OUTPUT;
2503     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2505     // Rewrite file URLs so that they are correct
2506     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2508     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2509     echo html_writer::start_tag('div', array('class'=>'info'));
2510     echo html_writer::start_tag('h3', array('class'=>'name'));
2512     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2514     $coursename = get_course_display_name_for_list($course);
2515     $linktext = highlight($highlightterms, format_string($coursename));
2516     $linkparams = array('title'=>get_string('entercourse'));
2517     if (empty($course->visible)) {
2518         $linkparams['class'] = 'dimmed';
2519     }
2520     echo html_writer::link($linkhref, $linktext, $linkparams);
2521     echo html_writer::end_tag('h3');
2523     /// first find all roles that are supposed to be displayed
2524     if (!empty($CFG->coursecontact)) {
2525         $managerroles = explode(',', $CFG->coursecontact);
2526         $namesarray = array();
2527         $rusers = array();
2529         if (!isset($course->managers)) {
2530             $rusers = get_role_users($managerroles, $context, true,
2531                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2532                  r.name AS rolename, r.sortorder, r.id AS roleid',
2533                 'r.sortorder ASC, u.lastname ASC');
2534         } else {
2535             //  use the managers array if we have it for perf reasosn
2536             //  populate the datastructure like output of get_role_users();
2537             foreach ($course->managers as $manager) {
2538                 $u = new stdClass();
2539                 $u = $manager->user;
2540                 $u->roleid = $manager->roleid;
2541                 $u->rolename = $manager->rolename;
2543                 $rusers[] = $u;
2544             }
2545         }
2547         /// Rename some of the role names if needed
2548         if (isset($context)) {
2549             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2550         }
2552         $namesarray = array();
2553         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2554         foreach ($rusers as $ra) {
2555             if (isset($namesarray[$ra->id])) {
2556                 //  only display a user once with the higest sortorder role
2557                 continue;
2558             }
2560             if (isset($aliasnames[$ra->roleid])) {
2561                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2562             }
2564             $fullname = fullname($ra, $canviewfullnames);
2565             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2566                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2567         }
2569         if (!empty($namesarray)) {
2570             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2571             foreach ($namesarray as $name) {
2572                 echo html_writer::tag('li', $name);
2573             }
2574             echo html_writer::end_tag('ul');
2575         }
2576     }
2577     echo html_writer::end_tag('div'); // End of info div
2579     echo html_writer::start_tag('div', array('class'=>'summary'));
2580     $options = new stdClass();
2581     $options->noclean = true;
2582     $options->para = false;
2583     $options->overflowdiv = true;
2584     if (!isset($course->summaryformat)) {
2585         $course->summaryformat = FORMAT_MOODLE;
2586     }
2587     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2588     if ($icons = enrol_get_course_info_icons($course)) {
2589         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2590         foreach ($icons as $icon) {
2591             echo $OUTPUT->render($icon);
2592         }
2593         echo html_writer::end_tag('div'); // End of enrolmenticons div
2594     }
2595     echo html_writer::end_tag('div'); // End of summary div
2596     echo html_writer::end_tag('div'); // End of coursebox div
2599 /**
2600  * Prints custom user information on the home page.
2601  * Over time this can include all sorts of information
2602  */
2603 function print_my_moodle() {
2604     global $USER, $CFG, $DB, $OUTPUT;
2606     if (!isloggedin() or isguestuser()) {
2607         print_error('nopermissions', '', '', 'See My Moodle');
2608     }
2610     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2611     $rhosts   = array();
2612     $rcourses = array();
2613     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2614         $rcourses = get_my_remotecourses($USER->id);
2615         $rhosts   = get_my_remotehosts();
2616     }
2618     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2620         if (!empty($courses)) {
2621             echo '<ul class="unlist">';
2622             foreach ($courses as $course) {
2623                 if ($course->id == SITEID) {
2624                     continue;
2625                 }
2626                 echo '<li>';
2627                 print_course($course);
2628                 echo "</li>\n";
2629             }
2630             echo "</ul>\n";
2631         }
2633         // MNET
2634         if (!empty($rcourses)) {
2635             // at the IDP, we know of all the remote courses
2636             foreach ($rcourses as $course) {
2637                 print_remote_course($course, "100%");
2638             }
2639         } elseif (!empty($rhosts)) {
2640             // non-IDP, we know of all the remote servers, but not courses
2641             foreach ($rhosts as $host) {
2642                 print_remote_host($host, "100%");
2643             }
2644         }
2645         unset($course);
2646         unset($host);
2648         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2649             echo "<table width=\"100%\"><tr><td align=\"center\">";
2650             print_course_search("", false, "short");
2651             echo "</td><td align=\"center\">";
2652             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2653             echo "</td></tr></table>\n";
2654         }
2656     } else {
2657         if ($DB->count_records("course_categories") > 1) {
2658             echo $OUTPUT->box_start("categorybox");
2659             print_whole_category_list();
2660             echo $OUTPUT->box_end();
2661         } else {
2662             print_courses(0);
2663         }
2664     }
2668 function print_course_search($value="", $return=false, $format="plain") {
2669     global $CFG;
2670     static $count = 0;
2672     $count++;
2674     $id = 'coursesearch';
2676     if ($count > 1) {
2677         $id .= $count;
2678     }
2680     $strsearchcourses= get_string("searchcourses");
2682     if ($format == 'plain') {
2683         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2684         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2685         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2686         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2687         $output .= '<input type="submit" value="'.get_string('go').'" />';
2688         $output .= '</fieldset></form>';
2689     } else if ($format == 'short') {
2690         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2691         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2692         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2693         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2694         $output .= '<input type="submit" value="'.get_string('go').'" />';
2695         $output .= '</fieldset></form>';
2696     } else if ($format == 'navbar') {
2697         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2698         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2699         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2700         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2701         $output .= '<input type="submit" value="'.get_string('go').'" />';
2702         $output .= '</fieldset></form>';
2703     }
2705     if ($return) {
2706         return $output;
2707     }
2708     echo $output;
2711 function print_remote_course($course, $width="100%") {
2712     global $CFG, $USER;
2714     $linkcss = '';
2716     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2718     echo '<div class="coursebox remotecoursebox clearfix">';
2719     echo '<div class="info">';
2720     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2721          $linkcss.' href="'.$url.'">'
2722         .  format_string($course->fullname) .'</a><br />'
2723         . format_string($course->hostname) . ' : '
2724         . format_string($course->cat_name) . ' : '
2725         . format_string($course->shortname). '</div>';
2726     echo '</div><div class="summary">';
2727     $options = new stdClass();
2728     $options->noclean = true;
2729     $options->para = false;
2730     $options->overflowdiv = true;
2731     echo format_text($course->summary, $course->summaryformat, $options);
2732     echo '</div>';
2733     echo '</div>';
2736 function print_remote_host($host, $width="100%") {
2737     global $OUTPUT;
2739     $linkcss = '';
2741     echo '<div class="coursebox clearfix">';
2742     echo '<div class="info">';
2743     echo '<div class="name">';
2744     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2745     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2746         . s($host['name']).'</a> - ';
2747     echo $host['count'] . ' ' . get_string('courses');
2748     echo '</div>';
2749     echo '</div>';
2750     echo '</div>';
2754 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2756 function add_course_module($mod) {
2757     global $DB;
2759     $mod->added = time();
2760     unset($mod->id);
2762     return $DB->insert_record("course_modules", $mod);
2765 /**
2766  * Returns course section - creates new if does not exist yet.
2767  * @param int $relative section number
2768  * @param int $courseid
2769  * @return object $course_section object
2770  */
2771 function get_course_section($section, $courseid) {
2772     global $DB;
2774     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2775         return $cw;
2776     }
2777     $cw = new stdClass();
2778     $cw->course   = $courseid;
2779     $cw->section  = $section;
2780     $cw->summary  = "";
2781     $cw->summaryformat = FORMAT_HTML;
2782     $cw->sequence = "";
2783     $id = $DB->insert_record("course_sections", $cw);
2784     return $DB->get_record("course_sections", array("id"=>$id));
2786 /**
2787  * Given a full mod object with section and course already defined, adds this module to that section.
2788  *
2789  * @param object $mod
2790  * @param int $beforemod An existing ID which we will insert the new module before
2791  * @return int The course_sections ID where the mod is inserted
2792  */
2793 function add_mod_to_section($mod, $beforemod=NULL) {
2794     global $DB;
2796     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2798         $section->sequence = trim($section->sequence);
2800         if (empty($section->sequence)) {
2801             $newsequence = "$mod->coursemodule";
2803         } else if ($beforemod) {
2804             $modarray = explode(",", $section->sequence);
2806             if ($key = array_keys($modarray, $beforemod->id)) {
2807                 $insertarray = array($mod->id, $beforemod->id);
2808                 array_splice($modarray, $key[0], 1, $insertarray);
2809                 $newsequence = implode(",", $modarray);
2811             } else {  // Just tack it on the end anyway
2812                 $newsequence = "$section->sequence,$mod->coursemodule";
2813             }
2815         } else {
2816             $newsequence = "$section->sequence,$mod->coursemodule";
2817         }
2819         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2820         return $section->id;     // Return course_sections ID that was used.
2822     } else {  // Insert a new record
2823         $section->course   = $mod->course;
2824         $section->section  = $mod->section;
2825         $section->summary  = "";
2826         $section->summaryformat = FORMAT_HTML;
2827         $section->sequence = $mod->coursemodule;
2828         return $DB->insert_record("course_sections", $section);
2829     }
2832 function set_coursemodule_groupmode($id, $groupmode) {
2833     global $DB;
2834     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2837 function set_coursemodule_idnumber($id, $idnumber) {
2838     global $DB;
2839     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2842 /**
2843 * $prevstateoverrides = true will set the visibility of the course module
2844 * to what is defined in visibleold. This enables us to remember the current
2845 * visibility when making a whole section hidden, so that when we toggle
2846 * that section back to visible, we are able to return the visibility of
2847 * the course module back to what it was originally.
2848 */
2849 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2850     global $DB, $CFG;
2851     require_once($CFG->libdir.'/gradelib.php');
2853     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2854         return false;
2855     }
2856     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2857         return false;
2858     }
2859     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2860         foreach($events as $event) {
2861             if ($visible) {
2862                 show_event($event);
2863             } else {
2864                 hide_event($event);
2865             }
2866         }
2867     }
2869     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2870     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2871     if ($grade_items) {
2872         foreach ($grade_items as $grade_item) {
2873             $grade_item->set_hidden(!$visible);
2874         }
2875     }
2877     if ($prevstateoverrides) {
2878         if ($visible == '0') {
2879             // Remember the current visible state so we can toggle this back.
2880             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2881         } else {
2882             // Get the previous saved visible states.
2883             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2884         }
2885     }
2886     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2889 /**
2890  * Delete a course module and any associated data at the course level (events)
2891  * Until 1.5 this function simply marked a deleted flag ... now it
2892  * deletes it completely.
2893  *
2894  */
2895 function delete_course_module($id) {
2896     global $CFG, $DB;
2897     require_once($CFG->libdir.'/gradelib.php');
2898     require_once($CFG->dirroot.'/blog/lib.php');
2900     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2901         return true;
2902     }
2903     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2904     //delete events from calendar
2905     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2906         foreach($events as $event) {
2907             delete_event($event->id);
2908         }
2909     }
2910     //delete grade items, outcome items and grades attached to modules
2911     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2912                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2913         foreach ($grade_items as $grade_item) {
2914             $grade_item->delete('moddelete');
2915         }
2916     }
2917     // Delete completion and availability data; it is better to do this even if the
2918     // features are not turned on, in case they were turned on previously (these will be
2919     // very quick on an empty table)
2920     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2921     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2923     delete_context(CONTEXT_MODULE, $cm->id);
2924     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2927 function delete_mod_from_section($mod, $section) {
2928     global $DB;
2930     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2932         $modarray = explode(",", $section->sequence);
2934         if ($key = array_keys ($modarray, $mod)) {
2935             array_splice($modarray, $key[0], 1);
2936             $newsequence = implode(",", $modarray);
2937             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2938         } else {
2939             return false;
2940         }
2942     }
2943     return false;
2946 /**
2947  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2948  *
2949  * @param object $course
2950  * @param int $section
2951  * @param int $move (-1 or 1)
2952  */
2953 function move_section($course, $section, $move) {
2954 /// Moves a whole course section up and down within the course
2955     global $USER, $DB;
2957     if (!$move) {
2958         return true;
2959     }
2961     $sectiondest = $section + $move;
2963     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2964         return false;
2965     }
2967     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2968         return false;
2969     }
2971     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2972         return false;
2973     }
2975     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2976     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2978     // if the focus is on the section that is being moved, then move the focus along
2979     if (course_get_display($course->id) == $section) {
2980         course_set_display($course->id, $sectiondest);
2981     }
2983     // Check for duplicates and fix order if needed.
2984     // There is a very rare case that some sections in the same course have the same section id.
2985     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2986     $n = 0;
2987     foreach ($sections as $section) {
2988         if ($section->section != $n) {
2989             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2990         }
2991         $n++;
2992     }
2993     return true;
2996 /**
2997  * Moves a section within a course, from a position to another.
2998  * Be very careful: $section and $destination refer to section number,
2999  * not id!.
3000  *
3001  * @param object $course
3002  * @param int $section Section number (not id!!!)
3003  * @param int $destination
3004  * @return boolean Result
3005  */
3006 function move_section_to($course, $section, $destination) {
3007 /// Moves a whole course section up and down within the course
3008     global $USER, $DB;
3010     if (!$destination && $destination != 0) {
3011         return true;
3012     }
3014     if ($destination > $course->numsections) {
3015         return false;
3016     }
3018     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3019     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3020             'section ASC, id ASC', 'id, section')) {
3021         return false;
3022     }
3024     $sections = reorder_sections($sections, $section, $destination);
3026     // Update all sections
3027     foreach ($sections as $id => $position) {
3028         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3029     }
3031     // if the focus is on the section that is being moved, then move the focus along
3032     if (course_get_display($course->id) == $section) {
3033         course_set_display($course->id, $destination);
3034     }
3035     return true;
3038 /**
3039  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3040  * an original position number and a target position number, rebuilds the array so that the
3041  * move is made without any duplication of section positions.
3042  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3043  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3044  *
3045  * @param array $sections
3046  * @param int $origin_position
3047  * @param int $target_position
3048  * @return array
3049  */
3050 function reorder_sections($sections, $origin_position, $target_position) {
3051     if (!is_array($sections)) {
3052         return false;
3053     }
3055     // We can't move section position 0
3056     if ($origin_position < 1) {
3057         echo "We can't move section position 0";
3058         return false;
3059     }
3061     // Locate origin section in sections array
3062     if (!$origin_key = array_search($origin_position, $sections)) {
3063         echo "searched position not in sections array";
3064         return false; // searched position not in sections array
3065     }
3067     // Extract origin section
3068     $origin_section = $sections[$origin_key];
3069     unset($sections[$origin_key]);
3071     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3072     $found = false;
3073     $append_array = array();
3074     foreach ($sections as $id => $position) {
3075         if ($found) {
3076             $append_array[$id] = $position;
3077             unset($sections[$id]);
3078         }
3079         if ($position == $target_position) {
3080             $found = true;
3081         }
3082     }
3084     // Append moved section
3085     $sections[$origin_key] = $origin_section;
3087     // Append rest of array (if applicable)
3088     if (!empty($append_array)) {
3089         foreach ($append_array as $id => $position) {
3090             $sections[$id] = $position;
3091         }
3092     }
3094     // Renumber positions
3095     $position = 0;
3096     foreach ($sections as $id => $p) {
3097         $sections[$id] = $position;
3098         $position++;
3099     }
3101     return $sections;
3105 /**
3106  * Move the module object $mod to the specified $section
3107  * If $beforemod exists then that is the module
3108  * before which $modid should be inserted
3109  * All parameters are objects
3110  */
3111 function moveto_module($mod, $section, $beforemod=NULL) {
3112     global $DB, $OUTPUT;
3114 /// Remove original module from original section
3115     if (! delete_mod_from_section($mod->id, $mod->section)) {
3116         echo $OUTPUT->notification("Could not delete module from existing section");
3117     }
3119 /// Update module itself if necessary
3121     if ($mod->section != $section->id) {
3122         $mod->section = $section->id;
3123         $DB->update_record("course_modules", $mod);
3124         // if moving to a hidden section then hide module
3125         if (!$section->visible) {
3126             set_coursemodule_visible($mod->id, 0);
3127         }
3128     }
3130 /// Add the module into the new section
3132     $mod->course       = $section->course;
3133     $mod->section      = $section->section;  // need relative reference
3134     $mod->coursemodule = $mod->id;
3136     if (! add_mod_to_section($mod, $beforemod)) {
3137         return false;
3138     }
3140     return true;
3143 /**
3144  * Produces the editing buttons for a module
3145  *
3146  * @global core_renderer $OUTPUT
3147  * @staticvar type $str
3148  * @param stdClass $mod The module to produce editing buttons for
3149  * @param bool $absolute_ignored ignored - all links are absolute
3150  * @param bool $moveselect If true a move seleciton process is used (default true)
3151  * @param int $indent The current indenting
3152  * @param int $section The section to link back to
3153  * @return string XHTML for the editing buttons
3154  */
3155 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=-1) {
3156     global $CFG, $OUTPUT;
3158     static $str;
3160     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3161     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3163     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3164     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3166     // no permission to edit anything
3167     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3168         return false;
3169     }
3171     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3173     if (!isset($str)) {
3174         $str = new stdClass;
3175         $str->assign         = get_string("assignroles", 'role');
3176         $str->delete         = get_string("delete");
3177         $str->move           = get_string("move");
3178         $str->moveup         = get_string("moveup");
3179         $str->movedown       = get_string("movedown");
3180         $str->moveright      = get_string("moveright");
3181         $str->moveleft       = get_string("moveleft");
3182         $str->update         = get_string("update");
3183         $str->duplicate      = get_string("duplicate");
3184         $str->hide           = get_string("hide");
3185         $str->show           = get_string("show");
3186         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3187         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3188         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3189         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3190         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3191         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3192     }
3194     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3196     if ($section >= 0) {
3197         $baseurl->param('sr', $section);
3198     }
3199     $actions = array();
3201     // leftright
3202     if ($hasmanageactivities) {
3203         if (right_to_left()) {   // Exchange arrows on RTL
3204             $rightarrow = 't/left';
3205             $leftarrow  = 't/right';
3206         } else {
3207             $rightarrow = 't/right';
3208             $leftarrow  = 't/left';
3209         }
3211         if ($indent > 0) {
3212             $actions[] = new action_link(
3213                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3214                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3215                 null,
3216                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3217             );
3218         }
3219         if ($indent >= 0) {
3220             $actions[] = new action_link(
3221                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3222                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3223                 null,
3224                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3225             );
3226         }
3227     }
3229     // move
3230     if ($hasmanageactivities) {
3231         if ($moveselect) {
3232             $actions[] = new action_link(
3233                 new moodle_url($baseurl, array('copy' => $mod->id)),
3234                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3235                 null,
3236                 array('class' => 'editing_move', 'title' => $str->move)
3237             );
3238         } else {
3239             $actions[] = new action_link(
3240                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3241                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3242                 null,
3243                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3244             );
3245             $actions[] = new action_link(
3246                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3247                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3248                 null,
3249                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3250             );
3251         }
3252     }
3254     // Update
3255     if ($hasmanageactivities) {
3256         $actions[] = new action_link(
3257             new moodle_url($baseurl, array('update' => $mod->id)),
3258             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3259             null,
3260             array('class' => 'editing_update', 'title' => $str->update)
3261         );
3262     }
3264     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3265     if (has_all_capabilities($dupecaps, $coursecontext)) {
3266         $actions[] = new action_link(
3267             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3268             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3269             null,
3270             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3271         );
3272     }
3274     // Delete
3275     if ($hasmanageactivities) {
3276         $actions[] = new action_link(
3277             new moodle_url($baseurl, array('delete' => $mod->id)),
3278             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3279             null,
3280             array('class' => 'editing_delete', 'title' => $str->delete)
3281         );
3282     }
3284     // hideshow
3285     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3286         if ($mod->visible) {
3287             $actions[] = new action_link(
3288                 new moodle_url($baseurl, array('hide' => $mod->id)),
3289                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3290                 null,
3291                 array('class' => 'editing_hide', 'title' => $str->hide)
3292             );
3293         } else {
3294             $actions[] = new action_link(
3295                 new moodle_url($baseurl, array('show' => $mod->id)),
3296                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3297                 null,
3298                 array('class' => 'editing_show', 'title' => $str->show)
3299             );
3300         }
3301     }
3303     // groupmode
3304     if ($hasmanageactivities and $mod->groupmode !== false) {
3305         if ($mod->groupmode == SEPARATEGROUPS) {
3306             $groupmode = 0;
3307             $grouptitle = $str->groupsseparate;
3308             $forcedgrouptitle = $str->forcedgroupsseparate;
3309             $groupclass = 'editing_groupsseparate';
3310             $groupimage = 't/groups';
3311         } else if ($mod->groupmode == VISIBLEGROUPS) {
3312             $groupmode = 1;
3313             $grouptitle = $str->groupsvisible;
3314             $forcedgrouptitle = $str->forcedgroupsvisible;
3315             $groupclass = 'editing_groupsvisible';
3316             $groupimage = 't/groupv';
3317         } else {
3318             $groupmode = 2;
3319             $grouptitle = $str->groupsnone;
3320             $forcedgrouptitle = $str->forcedgroupsnone;
3321             $groupclass = 'editing_groupsnone';
3322             $groupimage = 't/groupn';
3323         }
3324         if ($mod->groupmodelink) {
3325             $actions[] = new action_link(
3326                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3327                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3328                 null,
3329                 array('class' => $groupclass, 'title' => $grouptitle)
3330             );
3331         } else {
3332             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3333         }
3334     }
3336     // Assign
3337     if (has_capability('moodle/role:assign', $modcontext)){
3338         $actions[] = new action_link(
3339             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3340             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3341             null,
3342             array('class' => 'editing_assign', 'title' => $str->assign)
3343         );
3344     }
3346     $output = html_writer::start_tag('span', array('class' => 'commands'));
3347     foreach ($actions as $action) {
3348         if ($action instanceof renderable) {
3349             $output .= $OUTPUT->render($action);
3350         } else {
3351             $output .= $action;
3352         }
3353     }
3354     $output .= html_writer::end_tag('span');
3355     return $output;
3358 /**
3359  * given a course object with shortname & fullname, this function will
3360  * truncate the the number of chars allowed and add ... if it was too long
3361  */
3362 function course_format_name ($course,$max=100) {
3364     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3365     $shortname = format_string($course->shortname, true, array('context' => $context));
3366     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3367     $str = $shortname.': '. $fullname;
3368     if (textlib::strlen($str) <= $max) {
3369         return $str;
3370     }
3371     else {
3372         return textlib::substr($str,0,$max-3).'...';
3373     }
3376 function update_restricted_mods($course, $mods) {
3377     global $DB;
3379 /// Delete all the current restricted list
3380     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3382     if (empty($course->restrictmodules)) {
3383         return;   // We're done
3384     }
3386 /// Insert the new list of restricted mods
3387     foreach ($mods as $mod) {
3388         if ($mod == 0) {
3389             continue; // this is the 'allow none' option
3390         }
3391         $am = new stdClass();
3392         $am->course = $course->id;
3393         $am->module = $mod;
3394         $DB->insert_record('course_allowed_modules',$am);
3395     }
3398 /**
3399  * This function will take an int (module id) or a string (module name)
3400  * and return true or false, whether it's allowed in the given course (object)
3401  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3402  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3403  */
3405 function course_allowed_module($course,$mod) {
3406     global $DB;
3408     if (empty($course->restrictmodules)) {
3409         return true;
3410     }
3412     // Admins and admin-like people who can edit everything can also add anything.
3413     // Originally there was a course:update test only, but it did not match the test in course edit form
3414     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3415         return true;
3416     }
3418     if (is_numeric($mod)) {
3419         $modid = $mod;
3420     } else if (is_string($mod)) {
3421         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3422     }
3423     if (empty($modid)) {
3424         return false;
3425     }
3427     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3430 /**
3431  * Recursively delete category including all subcategories and courses.
3432  * @param stdClass $category
3433  * @param boolean $showfeedback display some notices
3434  * @return array return deleted courses
3435  */
3436 function category_delete_full($category, $showfeedback=true) {
3437     global $CFG, $DB;
3438     require_once($CFG->libdir.'/gradelib.php');
3439     require_once($CFG->libdir.'/questionlib.php');
3440     require_once($CFG->dirroot.'/cohort/lib.php');
3442     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3443         foreach ($children as $childcat) {
3444             category_delete_full($childcat, $showfeedback);
3445         }
3446     }
3448     $deletedcourses = array();
3449     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3450         foreach ($courses as $course) {
3451             if (!delete_course($course, false)) {
3452                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3453             }
3454             $deletedcourses[] = $course;
3455         }
3456     }
3458     // move or delete cohorts in this context
3459     cohort_delete_category($category);
3461     // now delete anything that may depend on course category context
3462     grade_course_category_delete($category->id, 0, $showfeedback);
3463     if (!question_delete_course_category($category, 0, $showfeedback)) {
3464         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3465     }
3467     // finally delete the category and it's context
3468     $DB->delete_records('course_categories', array('id'=>$category->id));
3469     delete_context(CONTEXT_COURSECAT, $category->id);
3471     events_trigger('course_category_deleted', $category);
3473     return $deletedcourses;
3476 /**
3477  * Delete category, but move contents to another category.
3478  * @param object $ccategory
3479  * @param int $newparentid category id
3480  * @return bool status
3481  */
3482 function category_delete_move($category, $newparentid, $showfeedback=true) {
3483     global $CFG, $DB, $OUTPUT;
3484     require_once($CFG->libdir.'/gradelib.php');
3485     require_once($CFG->libdir.'/questionlib.php');
3486     require_once($CFG->dirroot.'/cohort/lib.php');
3488     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3489         return false;
3490     }
3492     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3493         foreach ($children as $childcat) {
3494             move_category($childcat, $newparentcat);
3495         }
3496     }
3498     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3499         if (!move_courses(array_keys($courses), $newparentid)) {
3500             echo $OUTPUT->notification("Error moving courses");
3501             return false;
3502         }
3503         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3504     }
3506     // move or delete cohorts in this context