5fb1ae674ac33f42ea1b3fe327f8100c7512497b
[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_LOG_DISPLAY', 150);          // days
33 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
34 define('COURSE_LIVELOG_REFRESH', 60);           // Seconds
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
36 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
37 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
38 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
39 define('FRONTPAGENEWS',           '0');
40 define('FRONTPAGECOURSELIST',     '1');
41 define('FRONTPAGECATEGORYNAMES',  '2');
42 define('FRONTPAGETOPICONLY',      '3');
43 define('FRONTPAGECATEGORYCOMBO',  '4');
44 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
45 define('EXCELROWS', 65535);
46 define('FIRSTUSEDEXCELROW', 3);
48 define('MOD_CLASS_ACTIVITY', 0);
49 define('MOD_CLASS_RESOURCE', 1);
51 function make_log_url($module, $url) {
52     switch ($module) {
53         case 'course':
54         case 'file':
55         case 'login':
56         case 'lib':
57         case 'admin':
58         case 'calendar':
59         case 'mnet course':
60             if (strpos($url, '../') === 0) {
61                 $url = ltrim($url, '.');
62             } else {
63                 $url = "/course/$url";
64             }
65             break;
66         case 'user':
67         case 'blog':
68             $url = "/$module/$url";
69             break;
70         case 'upload':
71             $url = $url;
72             break;
73         case 'coursetags':
74             $url = '/'.$url;
75             break;
76         case 'library':
77         case '':
78             $url = '/';
79             break;
80         case 'message':
81             $url = "/message/$url";
82             break;
83         case 'notes':
84             $url = "/notes/$url";
85             break;
86         case 'tag':
87             $url = "/tag/$url";
88             break;
89         case 'role':
90             $url = '/'.$url;
91             break;
92         default:
93             $url = "/mod/$module/$url";
94             break;
95     }
97     //now let's sanitise urls - there might be some ugly nasties:-(
98     $parts = explode('?', $url);
99     $script = array_shift($parts);
100     if (strpos($script, 'http') === 0) {
101         $script = clean_param($script, PARAM_URL);
102     } else {
103         $script = clean_param($script, PARAM_PATH);
104     }
106     $query = '';
107     if ($parts) {
108         $query = implode('', $parts);
109         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
110         $parts = explode('&', $query);
111         $eq = urlencode('=');
112         foreach ($parts as $key=>$part) {
113             $part = urlencode(urldecode($part));
114             $part = str_replace($eq, '=', $part);
115             $parts[$key] = $part;
116         }
117         $query = '?'.implode('&amp;', $parts);
118     }
120     return $script.$query;
124 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
125                    $modname="", $modid=0, $modaction="", $groupid=0) {
126     global $CFG, $DB;
128     // It is assumed that $date is the GMT time of midnight for that day,
129     // and so the next 86400 seconds worth of logs are printed.
131     /// Setup for group handling.
133     // TODO: I don't understand group/context/etc. enough to be able to do
134     // something interesting with it here
135     // What is the context of a remote course?
137     /// If the group mode is separate, and this user does not have editing privileges,
138     /// then only the user's group can be viewed.
139     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
140     //    $groupid = get_current_group($course->id);
141     //}
142     /// If this course doesn't have groups, no groupid can be specified.
143     //else if (!$course->groupmode) {
144     //    $groupid = 0;
145     //}
147     $groupid = 0;
149     $joins = array();
151     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
152               FROM {mnet_log} l
153                LEFT JOIN {user} u ON l.userid = u.id
154               WHERE ";
155     $params = array();
157     $where .= "l.hostid = :hostid";
158     $params['hostid'] = $hostid;
160     // TODO: Is 1 really a magic number referring to the sitename?
161     if ($course != SITEID || $modid != 0) {
162         $where .= " AND l.course=:courseid";
163         $params['courseid'] = $course;
164     }
166     if ($modname) {
167         $where .= " AND l.module = :modname";
168         $params['modname'] = $modname;
169     }
171     if ('site_errors' === $modid) {
172         $where .= " AND ( l.action='error' OR l.action='infected' )";
173     } else if ($modid) {
174         //TODO: This assumes that modids are the same across sites... probably
175         //not true
176         $where .= " AND l.cmid = :modid";
177         $params['modid'] = $modid;
178     }
180     if ($modaction) {
181         $firstletter = substr($modaction, 0, 1);
182         if ($firstletter == '-') {
183             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
184             $params['modaction'] = '%'.substr($modaction, 1).'%';
185         } else {
186             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
187             $params['modaction'] = '%'.$modaction.'%';
188         }
189     }
191     if ($user) {
192         $where .= " AND l.userid = :user";
193         $params['user'] = $user;
194     }
196     if ($date) {
197         $enddate = $date + 86400;
198         $where .= " AND l.time > :date AND l.time < :enddate";
199         $params['date'] = $date;
200         $params['enddate'] = $enddate;
201     }
203     $result = array();
204     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
205     if(!empty($result['totalcount'])) {
206         $where .= " ORDER BY $order";
207         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
208     } else {
209         $result['logs'] = array();
210     }
211     return $result;
214 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
215                    $modname="", $modid=0, $modaction="", $groupid=0) {
216     global $DB, $SESSION, $USER;
217     // It is assumed that $date is the GMT time of midnight for that day,
218     // and so the next 86400 seconds worth of logs are printed.
220     /// Setup for group handling.
222     /// If the group mode is separate, and this user does not have editing privileges,
223     /// then only the user's group can be viewed.
224     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
225         if (isset($SESSION->currentgroup[$course->id])) {
226             $groupid =  $SESSION->currentgroup[$course->id];
227         } else {
228             $groupid = groups_get_all_groups($course->id, $USER->id);
229             if (is_array($groupid)) {
230                 $groupid = array_shift(array_keys($groupid));
231                 $SESSION->currentgroup[$course->id] = $groupid;
232             } else {
233                 $groupid = 0;
234             }
235         }
236     }
237     /// If this course doesn't have groups, no groupid can be specified.
238     else if (!$course->groupmode) {
239         $groupid = 0;
240     }
242     $joins = array();
243     $params = array();
245     if ($course->id != SITEID || $modid != 0) {
246         $joins[] = "l.course = :courseid";
247         $params['courseid'] = $course->id;
248     }
250     if ($modname) {
251         $joins[] = "l.module = :modname";
252         $params['modname'] = $modname;
253     }
255     if ('site_errors' === $modid) {
256         $joins[] = "( l.action='error' OR l.action='infected' )";
257     } else if ($modid) {
258         $joins[] = "l.cmid = :modid";
259         $params['modid'] = $modid;
260     }
262     if ($modaction) {
263         $firstletter = substr($modaction, 0, 1);
264         if ($firstletter == '-') {
265             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
266             $params['modaction'] = '%'.substr($modaction, 1).'%';
267         } else {
268             $joins[] = $DB->sql_like('l.action', ':modaction', false);
269             $params['modaction'] = '%'.$modaction.'%';
270         }
271     }
274     /// Getting all members of a group.
275     if ($groupid and !$user) {
276         if ($gusers = groups_get_members($groupid)) {
277             $gusers = array_keys($gusers);
278             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
279         } else {
280             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
281         }
282     }
283     else if ($user) {
284         $joins[] = "l.userid = :userid";
285         $params['userid'] = $user;
286     }
288     if ($date) {
289         $enddate = $date + 86400;
290         $joins[] = "l.time > :date AND l.time < :enddate";
291         $params['date'] = $date;
292         $params['enddate'] = $enddate;
293     }
295     $selector = implode(' AND ', $joins);
297     $totalcount = 0;  // Initialise
298     $result = array();
299     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
300     $result['totalcount'] = $totalcount;
301     return $result;
305 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
306                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
308     global $CFG, $DB, $OUTPUT;
310     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
311                        $modname, $modid, $modaction, $groupid)) {
312         echo $OUTPUT->notification("No logs found!");
313         echo $OUTPUT->footer();
314         exit;
315     }
317     $courses = array();
319     if ($course->id == SITEID) {
320         $courses[0] = '';
321         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
322             foreach ($ccc as $cc) {
323                 $courses[$cc->id] = $cc->shortname;
324             }
325         }
326     } else {
327         $courses[$course->id] = $course->shortname;
328     }
330     $totalcount = $logs['totalcount'];
331     $count=0;
332     $ldcache = array();
333     $tt = getdate(time());
334     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
336     $strftimedatetime = get_string("strftimedatetime");
338     echo "<div class=\"info\">\n";
339     print_string("displayingrecords", "", $totalcount);
340     echo "</div>\n";
342     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
344     $table = new html_table();
345     $table->classes = array('logtable','generalbox');
346     $table->align = array('right', 'left', 'left');
347     $table->head = array(
348         get_string('time'),
349         get_string('ip_address'),
350         get_string('fullnameuser'),
351         get_string('action'),
352         get_string('info')
353     );
354     $table->data = array();
356     if ($course->id == SITEID) {
357         array_unshift($table->align, 'left');
358         array_unshift($table->head, get_string('course'));
359     }
361     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
362     if (empty($logs['logs'])) {
363         $logs['logs'] = array();
364     }
366     foreach ($logs['logs'] as $log) {
368         if (isset($ldcache[$log->module][$log->action])) {
369             $ld = $ldcache[$log->module][$log->action];
370         } else {
371             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
372             $ldcache[$log->module][$log->action] = $ld;
373         }
374         if ($ld && is_numeric($log->info)) {
375             // ugly hack to make sure fullname is shown correctly
376             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
377                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
378             } else {
379                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
380             }
381         }
383         //Filter log->info
384         $log->info = format_string($log->info);
386         // If $log->url has been trimmed short by the db size restriction
387         // code in add_to_log, keep a note so we don't add a link to a broken url
388         $tl=textlib_get_instance();
389         $brokenurl=($tl->strlen($log->url)==100 && $tl->substr($log->url,97)=='...');
391         $row = array();
392         if ($course->id == SITEID) {
393             if (empty($log->course)) {
394                 $row[] = get_string('site');
395             } else {
396                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
397             }
398         }
400         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
402         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
403         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
405         $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))));
407         $displayaction="$log->module $log->action";
408         if ($brokenurl) {
409             $row[] = $displayaction;
410         } else {
411             $link = make_log_url($log->module,$log->url);
412             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
413         }
414         $row[] = $log->info;
415         $table->data[] = $row;
416     }
418     echo html_writer::table($table);
419     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
423 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
424                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
426     global $CFG, $DB, $OUTPUT;
428     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
429                        $modname, $modid, $modaction, $groupid)) {
430         echo $OUTPUT->notification("No logs found!");
431         echo $OUTPUT->footer();
432         exit;
433     }
435     if ($course->id == SITEID) {
436         $courses[0] = '';
437         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
438             foreach ($ccc as $cc) {
439                 $courses[$cc->id] = $cc->shortname;
440             }
441         }
442     }
444     $totalcount = $logs['totalcount'];
445     $count=0;
446     $ldcache = array();
447     $tt = getdate(time());
448     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
450     $strftimedatetime = get_string("strftimedatetime");
452     echo "<div class=\"info\">\n";
453     print_string("displayingrecords", "", $totalcount);
454     echo "</div>\n";
456     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
458     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
459     echo "<tr>";
460     if ($course->id == SITEID) {
461         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
462     }
463     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
464     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
465     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
466     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
467     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
468     echo "</tr>\n";
470     if (empty($logs['logs'])) {
471         echo "</table>\n";
472         return;
473     }
475     $row = 1;
476     foreach ($logs['logs'] as $log) {
478         $log->info = $log->coursename;
479         $row = ($row + 1) % 2;
481         if (isset($ldcache[$log->module][$log->action])) {
482             $ld = $ldcache[$log->module][$log->action];
483         } else {
484             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
485             $ldcache[$log->module][$log->action] = $ld;
486         }
487         if (0 && $ld && !empty($log->info)) {
488             // ugly hack to make sure fullname is shown correctly
489             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
490                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
491             } else {
492                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
493             }
494         }
496         //Filter log->info
497         $log->info = format_string($log->info);
499         echo '<tr class="r'.$row.'">';
500         if ($course->id == SITEID) {
501             $courseshortname = format_string($courses[$log->course], true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
502             echo "<td class=\"r$row c0\" >\n";
503             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
504             echo "</td>\n";
505         }
506         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
507              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
508         echo "<td class=\"r$row c2\" >\n";
509         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
510         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
511         echo "</td>\n";
512         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
513         echo "<td class=\"r$row c3\" >\n";
514         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
515         echo "</td>\n";
516         echo "<td class=\"r$row c4\">\n";
517         echo $log->action .': '.$log->module;
518         echo "</td>\n";;
519         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
520         echo "</tr>\n";
521     }
522     echo "</table>\n";
524     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
528 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
529                         $modid, $modaction, $groupid) {
530     global $DB;
532     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
533             get_string('fullnameuser')."\t".get_string('action')."\t".get_string('info');
535     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
536                        $modname, $modid, $modaction, $groupid)) {
537         return false;
538     }
540     $courses = array();
542     if ($course->id == SITEID) {
543         $courses[0] = '';
544         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
545             foreach ($ccc as $cc) {
546                 $courses[$cc->id] = $cc->shortname;
547             }
548         }
549     } else {
550         $courses[$course->id] = $course->shortname;
551     }
553     $count=0;
554     $ldcache = array();
555     $tt = getdate(time());
556     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
558     $strftimedatetime = get_string("strftimedatetime");
560     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
561     $filename .= '.txt';
562     header("Content-Type: application/download\n");
563     header("Content-Disposition: attachment; filename=$filename");
564     header("Expires: 0");
565     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
566     header("Pragma: public");
568     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
569     echo $text."\n";
571     if (empty($logs['logs'])) {
572         return true;
573     }
575     foreach ($logs['logs'] as $log) {
576         if (isset($ldcache[$log->module][$log->action])) {
577             $ld = $ldcache[$log->module][$log->action];
578         } else {
579             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
580             $ldcache[$log->module][$log->action] = $ld;
581         }
582         if ($ld && !empty($log->info)) {
583             // ugly hack to make sure fullname is shown correctly
584             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
585                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
586             } else {
587                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
588             }
589         }
591         //Filter log->info
592         $log->info = format_string($log->info);
593         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
595         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
596         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
597         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
598         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
599         $text = implode("\t", $row);
600         echo $text." \n";
601     }
602     return true;
606 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
607                         $modid, $modaction, $groupid) {
609     global $CFG, $DB;
611     require_once("$CFG->libdir/excellib.class.php");
613     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
614                        $modname, $modid, $modaction, $groupid)) {
615         return false;
616     }
618     $courses = array();
620     if ($course->id == SITEID) {
621         $courses[0] = '';
622         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
623             foreach ($ccc as $cc) {
624                 $courses[$cc->id] = $cc->shortname;
625             }
626         }
627     } else {
628         $courses[$course->id] = $course->shortname;
629     }
631     $count=0;
632     $ldcache = array();
633     $tt = getdate(time());
634     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
636     $strftimedatetime = get_string("strftimedatetime");
638     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
639     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
640     $filename .= '.xls';
642     $workbook = new MoodleExcelWorkbook('-');
643     $workbook->send($filename);
645     $worksheet = array();
646     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
647                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
649     // Creating worksheets
650     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
651         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
652         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
653         $worksheet[$wsnumber]->set_column(1, 1, 30);
654         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
655                                     userdate(time(), $strftimedatetime));
656         $col = 0;
657         foreach ($headers as $item) {
658             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
659             $col++;
660         }
661     }
663     if (empty($logs['logs'])) {
664         $workbook->close();
665         return true;
666     }
668     $formatDate =& $workbook->add_format();
669     $formatDate->set_num_format(get_string('log_excel_date_format'));
671     $row = FIRSTUSEDEXCELROW;
672     $wsnumber = 1;
673     $myxls =& $worksheet[$wsnumber];
674     foreach ($logs['logs'] as $log) {
675         if (isset($ldcache[$log->module][$log->action])) {
676             $ld = $ldcache[$log->module][$log->action];
677         } else {
678             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
679             $ldcache[$log->module][$log->action] = $ld;
680         }
681         if ($ld && !empty($log->info)) {
682             // ugly hack to make sure fullname is shown correctly
683             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
684                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
685             } else {
686                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
687             }
688         }
690         // Filter log->info
691         $log->info = format_string($log->info);
692         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
694         if ($nroPages>1) {
695             if ($row > EXCELROWS) {
696                 $wsnumber++;
697                 $myxls =& $worksheet[$wsnumber];
698                 $row = FIRSTUSEDEXCELROW;
699             }
700         }
702         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
704         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
705         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
706         $myxls->write($row, 2, $log->ip, '');
707         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
708         $myxls->write($row, 3, $fullname, '');
709         $myxls->write($row, 4, $log->module.' '.$log->action, '');
710         $myxls->write($row, 5, $log->info, '');
712         $row++;
713     }
715     $workbook->close();
716     return true;
719 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
720                         $modid, $modaction, $groupid) {
722     global $CFG, $DB;
724     require_once("$CFG->libdir/odslib.class.php");
726     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
727                        $modname, $modid, $modaction, $groupid)) {
728         return false;
729     }
731     $courses = array();
733     if ($course->id == SITEID) {
734         $courses[0] = '';
735         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
736             foreach ($ccc as $cc) {
737                 $courses[$cc->id] = $cc->shortname;
738             }
739         }
740     } else {
741         $courses[$course->id] = $course->shortname;
742     }
744     $count=0;
745     $ldcache = array();
746     $tt = getdate(time());
747     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
749     $strftimedatetime = get_string("strftimedatetime");
751     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
752     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
753     $filename .= '.ods';
755     $workbook = new MoodleODSWorkbook('-');
756     $workbook->send($filename);
758     $worksheet = array();
759     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
760                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
762     // Creating worksheets
763     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
764         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
765         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
766         $worksheet[$wsnumber]->set_column(1, 1, 30);
767         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
768                                     userdate(time(), $strftimedatetime));
769         $col = 0;
770         foreach ($headers as $item) {
771             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
772             $col++;
773         }
774     }
776     if (empty($logs['logs'])) {
777         $workbook->close();
778         return true;
779     }
781     $formatDate =& $workbook->add_format();
782     $formatDate->set_num_format(get_string('log_excel_date_format'));
784     $row = FIRSTUSEDEXCELROW;
785     $wsnumber = 1;
786     $myxls =& $worksheet[$wsnumber];
787     foreach ($logs['logs'] as $log) {
788         if (isset($ldcache[$log->module][$log->action])) {
789             $ld = $ldcache[$log->module][$log->action];
790         } else {
791             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
792             $ldcache[$log->module][$log->action] = $ld;
793         }
794         if ($ld && !empty($log->info)) {
795             // ugly hack to make sure fullname is shown correctly
796             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
797                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
798             } else {
799                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
800             }
801         }
803         // Filter log->info
804         $log->info = format_string($log->info);
805         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
807         if ($nroPages>1) {
808             if ($row > EXCELROWS) {
809                 $wsnumber++;
810                 $myxls =& $worksheet[$wsnumber];
811                 $row = FIRSTUSEDEXCELROW;
812             }
813         }
815         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
817         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $context)));
818         $myxls->write_date($row, 1, $log->time);
819         $myxls->write_string($row, 2, $log->ip);
820         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
821         $myxls->write_string($row, 3, $fullname);
822         $myxls->write_string($row, 4, $log->module.' '.$log->action);
823         $myxls->write_string($row, 5, $log->info);
825         $row++;
826     }
828     $workbook->close();
829     return true;
833 function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
834     global $CFG, $USER;
835     if (empty($CFG->gdversion)) {
836         echo "(".get_string("gdneed").")";
837     } else {
838         // MDL-10818, do not display broken graph when user has no permission to view graph
839         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
840             ($course->showreports and $USER->id == $userid)) {
841             echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
842                  '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
843         }
844     }
848 function print_overview($courses, array $remote_courses=array()) {
849     global $CFG, $USER, $DB, $OUTPUT;
851     $htmlarray = array();
852     if ($modules = $DB->get_records('modules')) {
853         foreach ($modules as $mod) {
854             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
855                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
856                 $fname = $mod->name.'_print_overview';
857                 if (function_exists($fname)) {
858                     $fname($courses,$htmlarray);
859                 }
860             }
861         }
862     }
863     foreach ($courses as $course) {
864         $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
865         echo $OUTPUT->box_start('coursebox');
866         $attributes = array('title' => s($fullname));
867         if (empty($course->visible)) {
868             $attributes['class'] = 'dimmed';
869         }
870         echo $OUTPUT->heading(html_writer::link(
871             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
872         if (array_key_exists($course->id,$htmlarray)) {
873             foreach ($htmlarray[$course->id] as $modname => $html) {
874                 echo $html;
875             }
876         }
877         echo $OUTPUT->box_end();
878     }
880     if (!empty($remote_courses)) {
881         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
882     }
883     foreach ($remote_courses as $course) {
884         echo $OUTPUT->box_start('coursebox');
885         $attributes = array('title' => s($course->fullname));
886         echo $OUTPUT->heading(html_writer::link(
887             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
888             format_string($course->shortname),
889             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
890         echo $OUTPUT->box_end();
891     }
895 /**
896  * This function trawls through the logs looking for
897  * anything new since the user's last login
898  */
899 function print_recent_activity($course) {
900     // $course is an object
901     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
903     $context = get_context_instance(CONTEXT_COURSE, $course->id);
905     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
907     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
909     if (!isguestuser()) {
910         if (!empty($USER->lastcourseaccess[$course->id])) {
911             if ($USER->lastcourseaccess[$course->id] > $timestart) {
912                 $timestart = $USER->lastcourseaccess[$course->id];
913             }
914         }
915     }
917     echo '<div class="activitydate">';
918     echo get_string('activitysince', '', userdate($timestart));
919     echo '</div>';
920     echo '<div class="activityhead">';
922     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
924     echo "</div>\n";
926     $content = false;
928 /// Firstly, have there been any new enrolments?
930     $users = get_recent_enrolments($course->id, $timestart);
932     //Accessibility: new users now appear in an <OL> list.
933     if ($users) {
934         echo '<div class="newusers">';
935         echo $OUTPUT->heading(get_string("newusers").':', 3);
936         $content = true;
937         echo "<ol class=\"list\">\n";
938         foreach ($users as $user) {
939             $fullname = fullname($user, $viewfullnames);
940             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
941         }
942         echo "</ol>\n</div>\n";
943     }
945 /// Next, have there been any modifications to the course structure?
947     $modinfo =& get_fast_modinfo($course);
949     $changelist = array();
951     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
952                                             module = 'course' AND
953                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
954                                     array($timestart, $course->id), "id ASC");
956     if ($logs) {
957         $actions  = array('add mod', 'update mod', 'delete mod');
958         $newgones = array(); // added and later deleted items
959         foreach ($logs as $key => $log) {
960             if (!in_array($log->action, $actions)) {
961                 continue;
962             }
963             $info = explode(' ', $log->info);
965             // note: in most cases I replaced hardcoding of label with use of
966             // $cm->has_view() but it was not possible to do this here because
967             // we don't necessarily have the $cm for it
968             if ($info[0] == 'label') {     // Labels are ignored in recent activity
969                 continue;
970             }
972             if (count($info) != 2) {
973                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
974                 continue;
975             }
977             $modname    = $info[0];
978             $instanceid = $info[1];
980             if ($log->action == 'delete mod') {
981                 // unfortunately we do not know if the mod was visible
982                 if (!array_key_exists($log->info, $newgones)) {
983                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
984                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
985                 }
986             } else {
987                 if (!isset($modinfo->instances[$modname][$instanceid])) {
988                     if ($log->action == 'add mod') {
989                         // do not display added and later deleted activities
990                         $newgones[$log->info] = true;
991                     }
992                     continue;
993                 }
994                 $cm = $modinfo->instances[$modname][$instanceid];
995                 if (!$cm->uservisible) {
996                     continue;
997                 }
999                 if ($log->action == 'add mod') {
1000                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
1001                     $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>");
1003                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
1004                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
1005                     $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>");
1006                 }
1007             }
1008         }
1009     }
1011     if (!empty($changelist)) {
1012         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1013         $content = true;
1014         foreach ($changelist as $changeinfo => $change) {
1015             echo '<p class="activity">'.$change['text'].'</p>';
1016         }
1017     }
1019 /// Now display new things from each module
1021     $usedmodules = array();
1022     foreach($modinfo->cms as $cm) {
1023         if (isset($usedmodules[$cm->modname])) {
1024             continue;
1025         }
1026         if (!$cm->uservisible) {
1027             continue;
1028         }
1029         $usedmodules[$cm->modname] = $cm->modname;
1030     }
1032     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1033         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1034             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1035             $print_recent_activity = $modname.'_print_recent_activity';
1036             if (function_exists($print_recent_activity)) {
1037                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1038                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1039             }
1040         } else {
1041             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1042         }
1043     }
1045     if (! $content) {
1046         echo '<p class="message">'.get_string('nothingnew').'</p>';
1047     }
1050 /**
1051  * For a given course, returns an array of course activity objects
1052  * Each item in the array contains he following properties:
1053  */
1054 function get_array_of_activities($courseid) {
1055 //  cm - course module id
1056 //  mod - name of the module (eg forum)
1057 //  section - the number of the section (eg week or topic)
1058 //  name - the name of the instance
1059 //  visible - is the instance visible or not
1060 //  groupingid - grouping id
1061 //  groupmembersonly - is this instance visible to group members only
1062 //  extra - contains extra string to include in any link
1063     global $CFG, $DB;
1064     if(!empty($CFG->enableavailability)) {
1065         require_once($CFG->libdir.'/conditionlib.php');
1066     }
1068     $course = $DB->get_record('course', array('id'=>$courseid));
1070     if (empty($course)) {
1071         throw new moodle_exception('courseidnotfound');
1072     }
1074     $mod = array();
1076     $rawmods = get_course_mods($courseid);
1077     if (empty($rawmods)) {
1078         return $mod; // always return array
1079     }
1081     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1082        foreach ($sections as $section) {
1083            if (!empty($section->sequence)) {
1084                $sequence = explode(",", $section->sequence);
1085                foreach ($sequence as $seq) {
1086                    if (empty($rawmods[$seq])) {
1087                        continue;
1088                    }
1089                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1090                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1091                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1093                     // Oh dear. Inconsistent names left here for backward compatibility.
1094                    $mod[$seq]->section          = $section->section;
1095                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1097                    $mod[$seq]->module           = $rawmods[$seq]->module;
1098                    $mod[$seq]->added            = $rawmods[$seq]->added;
1099                    $mod[$seq]->score            = $rawmods[$seq]->score;
1100                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1101                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1102                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1103                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1104                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1105                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1106                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1107                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1108                    $mod[$seq]->extra            = "";
1109                    $mod[$seq]->completiongradeitemnumber =
1110                            $rawmods[$seq]->completiongradeitemnumber;
1111                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1112                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1113                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1114                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1115                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1116                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1117                    if (!empty($CFG->enableavailability)) {
1118                        condition_info::fill_availability_conditions($rawmods[$seq]);
1119                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1120                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1121                    }
1123                    $modname = $mod[$seq]->mod;
1124                    $functionname = $modname."_get_coursemodule_info";
1126                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1127                        continue;
1128                    }
1130                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1132                    if ($hasfunction = function_exists($functionname)) {
1133                        if ($info = $functionname($rawmods[$seq])) {
1134                            if (!empty($info->icon)) {
1135                                $mod[$seq]->icon = $info->icon;
1136                            }
1137                            if (!empty($info->iconcomponent)) {
1138                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1139                            }
1140                            if (!empty($info->name)) {
1141                                $mod[$seq]->name = $info->name;
1142                            }
1143                            if ($info instanceof cached_cm_info) {
1144                                // When using cached_cm_info you can include three new fields
1145                                // that aren't available for legacy code
1146                                if (!empty($info->content)) {
1147                                    $mod[$seq]->content = $info->content;
1148                                }
1149                                if (!empty($info->extraclasses)) {
1150                                    $mod[$seq]->extraclasses = $info->extraclasses;
1151                                }
1152                                if (!empty($info->onclick)) {
1153                                    $mod[$seq]->onclick = $info->onclick;
1154                                }
1155                                if (!empty($info->customdata)) {
1156                                    $mod[$seq]->customdata = $info->customdata;
1157                                }
1158                            } else {
1159                                // When using a stdclass, the (horrible) deprecated ->extra field
1160                                // is available for BC
1161                                if (!empty($info->extra)) {
1162                                    $mod[$seq]->extra = $info->extra;
1163                                }
1164                            }
1165                        }
1166                    }
1167                    // When there is no modname_get_coursemodule_info function,
1168                    // but showdescriptions is enabled, then we use the 'intro'
1169                    // and 'introformat' fields in the module table
1170                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1171                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1172                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1173                            // Set content from intro and introformat. Filters are disabled
1174                            // because we  filter it with format_text at display time
1175                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1176                                    $modvalues, $rawmods[$seq]->id, false);
1178                            // To save making another query just below, put name in here
1179                            $mod[$seq]->name = $modvalues->name;
1180                        }
1181                    }
1182                    if (!isset($mod[$seq]->name)) {
1183                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1184                    }
1186                    // Minimise the database size by unsetting default options when they are
1187                    // 'empty'. This list corresponds to code in the cm_info constructor.
1188                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1189                            'indent', 'completion', 'extra', 'extraclasses', 'onclick', 'content',
1190                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1191                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1192                            'completionview', 'completionexpected', 'score', 'showdescription')
1193                            as $property) {
1194                        if (property_exists($mod[$seq], $property) &&
1195                                empty($mod[$seq]->{$property})) {
1196                            unset($mod[$seq]->{$property});
1197                        }
1198                    }
1199                    // Special case: this value is usually set to null, but may be 0
1200                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1201                            is_null($mod[$seq]->completiongradeitemnumber)) {
1202                        unset($mod[$seq]->completiongradeitemnumber);
1203                    }
1204                }
1205             }
1206         }
1207     }
1208     return $mod;
1212 /**
1213  * Returns a number of useful structures for course displays
1214  */
1215 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1216     global $CFG, $DB, $COURSE;
1218     $mods          = array();    // course modules indexed by id
1219     $modnames      = array();    // all course module names (except resource!)
1220     $modnamesplural= array();    // all course module names (plural form)
1221     $modnamesused  = array();    // course module names used
1223     if ($allmods = $DB->get_records("modules")) {
1224         foreach ($allmods as $mod) {
1225             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1226                 continue;
1227             }
1228             if ($mod->visible) {
1229                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1230                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1231             }
1232         }
1233         collatorlib::asort($modnames);
1234     } else {
1235         print_error("nomodules", 'debug');
1236     }
1238     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1239     $modinfo = get_fast_modinfo($course);
1241     if ($rawmods=$modinfo->cms) {
1242         foreach($rawmods as $mod) {    // Index the mods
1243             if (empty($modnames[$mod->modname])) {
1244                 continue;
1245             }
1246             $mods[$mod->id] = $mod;
1247             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1248             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1249                 continue;
1250             }
1251             // Check groupings
1252             if (!groups_course_module_visible($mod)) {
1253                 continue;
1254             }
1255             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1256         }
1257         if ($modnamesused) {
1258             collatorlib::asort($modnamesused);
1259         }
1260     }
1263 /**
1264  * Returns an array of sections for the requested course id
1265  *
1266  * This function stores the sections against the course id within a staticvar encase
1267  * of subsequent requests. This is used all over + in some standard libs and course
1268  * format callbacks so subsequent requests are a reality.
1269  *
1270  * @staticvar array $coursesections
1271  * @param int $courseid
1272  * @return array Array of sections
1273  */
1274 function get_all_sections($courseid) {
1275     global $DB;
1276     static $coursesections = array();
1277     if (!array_key_exists($courseid, $coursesections)) {
1278         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1279                            "section, id, course, name, summary, summaryformat, sequence, visible");
1280     }
1281     return $coursesections[$courseid];
1284 /**
1285  * Returns the course section to display or 0 meaning show all sections. Returns 0 for guests.
1286  * It also sets the $USER->display cache to array($courseid=>return value)
1287  *
1288  * @param int $courseid The course id
1289  * @return int Course section to display, 0 means all
1290  */
1291 function course_get_display($courseid) {
1292     global $USER, $DB;
1294     if (!isloggedin() or isguestuser()) {
1295         //do not get settings in db for guests
1296         return 0; //return the implicit setting
1297     }
1299     if (!isset($USER->display[$courseid])) {
1300         if (!$display = $DB->get_field('course_display', 'display', array('userid' => $USER->id, 'course'=>$courseid))) {
1301             $display = 0; // all sections option is not stored in DB, this makes the table much smaller
1302         }
1303         //use display cache for one course only - we need to keep session small
1304         $USER->display = array($courseid => $display);
1305     }
1307     return $USER->display[$courseid];
1310 /**
1311  * Show one section only or all sections.
1312  *
1313  * @param int $courseid The course id
1314  * @param mixed $display show only this section, 0 or 'all' means show all sections
1315  * @return int Course section to display, 0 means all
1316  */
1317 function course_set_display($courseid, $display) {
1318     global $USER, $DB;
1320     if ($display === 'all' or empty($display)) {
1321         $display = 0;
1322     }
1324     if (!isloggedin() or isguestuser()) {
1325         //do not store settings in db for guests
1326         return 0;
1327     }
1329     if ($display == 0) {
1330         //show all, do not store anything in database
1331         $DB->delete_records('course_display', array('userid' => $USER->id, 'course' => $courseid));
1333     } else {
1334         if ($DB->record_exists('course_display', array('userid' => $USER->id, 'course' => $courseid))) {
1335             $DB->set_field('course_display', 'display', $display, array('userid' => $USER->id, 'course' => $courseid));
1336         } else {
1337             $record = new stdClass();
1338             $record->userid = $USER->id;
1339             $record->course = $courseid;
1340             $record->display = $display;
1341             $DB->insert_record('course_display', $record);
1342         }
1343     }
1345     //use display cache for one course only - we need to keep session small
1346     $USER->display = array($courseid => $display);
1348     return $display;
1351 /**
1352  * For a given course section, marks it visible or hidden,
1353  * and does the same for every activity in that section
1354  */
1355 function set_section_visible($courseid, $sectionnumber, $visibility) {
1356     global $DB;
1358     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1359         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1360         if (!empty($section->sequence)) {
1361             $modules = explode(",", $section->sequence);
1362             foreach ($modules as $moduleid) {
1363                 set_coursemodule_visible($moduleid, $visibility, true);
1364             }
1365         }
1366         rebuild_course_cache($courseid);
1367     }
1370 /**
1371  * Obtains shared data that is used in print_section when displaying a
1372  * course-module entry.
1373  *
1374  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1375  *
1376  * This data is also used in other areas of the code.
1377  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1378  * @param object $course Moodle course object
1379  * @return array An array with the following values in this order:
1380  *   $content (optional extra content for after link),
1381  *   $instancename (text of link)
1382  */
1383 function get_print_section_cm_text(cm_info $cm, $course) {
1384     global $OUTPUT;
1386     // Get content from modinfo if specified. Content displays either
1387     // in addition to the standard link (below), or replaces it if
1388     // the link is turned off by setting ->url to null.
1389     if (($content = $cm->get_content()) !== '') {
1390         // Improve filter performance by preloading filter setttings for all
1391         // activities on the course (this does nothing if called multiple
1392         // times)
1393         filter_preload_activities($cm->get_modinfo());
1395         // Get module context
1396         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1397         $labelformatoptions = new stdClass();
1398         $labelformatoptions->noclean = true;
1399         $labelformatoptions->overflowdiv = true;
1400         $labelformatoptions->context = $modulecontext;
1401         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1402     } else {
1403         $content = '';
1404     }
1406     // Get course context
1407     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1408     $stringoptions = new stdClass;
1409     $stringoptions->context = $coursecontext;
1410     $instancename = format_string($cm->name, true,  $stringoptions);
1411     return array($content, $instancename);
1414 /**
1415  * Prints a section full of activity modules
1416  */
1417 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1418     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1420     static $initialised;
1422     static $groupbuttons;
1423     static $groupbuttonslink;
1424     static $isediting;
1425     static $ismoving;
1426     static $strmovehere;
1427     static $strmovefull;
1428     static $strunreadpostsone;
1429     static $groupings;
1430     static $modulenames;
1432     if (!isset($initialised)) {
1433         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1434         $groupbuttonslink = (!$course->groupmodeforce);
1435         $isediting        = $PAGE->user_is_editing();
1436         $ismoving         = $isediting && ismoving($course->id);
1437         if ($ismoving) {
1438             $strmovehere  = get_string("movehere");
1439             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1440         }
1441         $modulenames      = array();
1442         $initialised = true;
1443     }
1445     $tl = textlib_get_instance();
1447     $modinfo = get_fast_modinfo($course);
1448     $completioninfo = new completion_info($course);
1450     //Accessibility: replace table with list <ul>, but don't output empty list.
1451     if (!empty($section->sequence)) {
1453         // Fix bug #5027, don't want style=\"width:$width\".
1454         echo "<ul class=\"section img-text\">\n";
1455         $sectionmods = explode(",", $section->sequence);
1457         foreach ($sectionmods as $modnumber) {
1458             if (empty($mods[$modnumber])) {
1459                 continue;
1460             }
1462             /**
1463              * @var cm_info
1464              */
1465             $mod = $mods[$modnumber];
1467             if ($ismoving and $mod->id == $USER->activitycopy) {
1468                 // do not display moving mod
1469                 continue;
1470             }
1472             if (isset($modinfo->cms[$modnumber])) {
1473                 // We can continue (because it will not be displayed at all)
1474                 // if:
1475                 // 1) The activity is not visible to users
1476                 // and
1477                 // 2a) The 'showavailability' option is not set (if that is set,
1478                 //     we need to display the activity so we can show
1479                 //     availability info)
1480                 // or
1481                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1482                 //     hidden in a way that leaves no info, such as using the
1483                 //     eye icon.
1484                 if (!$modinfo->cms[$modnumber]->uservisible &&
1485                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1486                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1487                     // visibility shortcut
1488                     continue;
1489                 }
1490             } else {
1491                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1492                     // module not installed
1493                     continue;
1494                 }
1495                 if (!coursemodule_visible_for_user($mod) &&
1496                     empty($mod->showavailability)) {
1497                     // full visibility check
1498                     continue;
1499                 }
1500             }
1502             if (!isset($modulenames[$mod->modname])) {
1503                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1504             }
1505             $modulename = $modulenames[$mod->modname];
1507             // In some cases the activity is visible to user, but it is
1508             // dimmed. This is done if viewhiddenactivities is true and if:
1509             // 1. the activity is not visible, or
1510             // 2. the activity has dates set which do not include current, or
1511             // 3. the activity has any other conditions set (regardless of whether
1512             //    current user meets them)
1513             $canviewhidden = has_capability(
1514                 'moodle/course:viewhiddenactivities',
1515                 get_context_instance(CONTEXT_MODULE, $mod->id));
1516             $accessiblebutdim = false;
1517             if ($canviewhidden) {
1518                 $accessiblebutdim = !$mod->visible;
1519                 if (!empty($CFG->enableavailability)) {
1520                     $accessiblebutdim = $accessiblebutdim ||
1521                         $mod->availablefrom > time() ||
1522                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1523                         count($mod->conditionsgrade) > 0 ||
1524                         count($mod->conditionscompletion) > 0;
1525                 }
1526             }
1528             $liclasses = array();
1529             $liclasses[] = 'activity';
1530             $liclasses[] = $mod->modname;
1531             $liclasses[] = 'modtype_'.$mod->modname;
1532             $extraclasses = $mod->get_extra_classes();
1533             if ($extraclasses) {
1534                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1535             }
1536             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1537             if ($ismoving) {
1538                 echo '<a title="'.$strmovefull.'"'.
1539                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1540                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1541                      ' alt="'.$strmovehere.'" /></a><br />
1542                      ';
1543             }
1545             $classes = array('mod-indent');
1546             if (!empty($mod->indent)) {
1547                 $classes[] = 'mod-indent-'.$mod->indent;
1548                 if ($mod->indent > 15) {
1549                     $classes[] = 'mod-indent-huge';
1550                 }
1551             }
1552             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1554             // Get data about this course-module
1555             list($content, $instancename) =
1556                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1558             //Accessibility: for files get description via icon, this is very ugly hack!
1559             $altname = '';
1560             $altname = $mod->modfullname;
1561             if (!empty($customicon)) {
1562                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1563                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1564                     $mimetype = mimeinfo_from_icon('type', $customicon);
1565                     $altname = get_mimetype_description($mimetype);
1566                 }
1567             }
1568             // Avoid unnecessary duplication: if e.g. a forum name already
1569             // includes the word forum (or Forum, etc) then it is unhelpful
1570             // to include that in the accessible description that is added.
1571             if (false !== strpos($tl->strtolower($instancename),
1572                     $tl->strtolower($altname))) {
1573                 $altname = '';
1574             }
1575             // File type after name, for alphabetic lists (screen reader).
1576             if ($altname) {
1577                 $altname = get_accesshide(' '.$altname);
1578             }
1580             // We may be displaying this just in order to show information
1581             // about visibility, without the actual link
1582             $contentpart = '';
1583             if ($mod->uservisible) {
1584                 // Nope - in this case the link is fully working for user
1585                 $linkclasses = '';
1586                 $textclasses = '';
1587                 if ($accessiblebutdim) {
1588                     $linkclasses .= ' dimmed';
1589                     $textclasses .= ' dimmed_text';
1590                     $accesstext = '<span class="accesshide">'.
1591                         get_string('hiddenfromstudents').': </span>';
1592                 } else {
1593                     $accesstext = '';
1594                 }
1595                 if ($linkclasses) {
1596                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1597                 } else {
1598                     $linkcss = '';
1599                 }
1600                 if ($textclasses) {
1601                     $textcss = 'class="' . trim($textclasses) . '" ';
1602                 } else {
1603                     $textcss = '';
1604                 }
1606                 // Get on-click attribute value if specified
1607                 $onclick = $mod->get_on_click();
1608                 if ($onclick) {
1609                     $onclick = ' onclick="' . $onclick . '"';
1610                 }
1612                 if ($url = $mod->get_url()) {
1613                     // Display link itself
1614                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1615                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1616                             '" class="activityicon" alt="' .
1617                             $modulename . '" /> ' .
1618                             $accesstext . '<span class="instancename">' .
1619                             $instancename . $altname . '</span></a>';
1621                     // If specified, display extra content after link
1622                     if ($content) {
1623                         $contentpart = '<div class="contentafterlink' .
1624                                 trim($textclasses) . '">' . $content . '</div>';
1625                     }
1626                 } else {
1627                     // No link, so display only content
1628                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1629                             $accesstext . $content . '</div>';
1630                 }
1632                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1633                     if (!isset($groupings)) {
1634                         $groupings = groups_get_all_groupings($course->id);
1635                     }
1636                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1637                 }
1638             } else {
1639                 $textclasses = $extraclasses;
1640                 $textclasses .= ' dimmed_text';
1641                 if ($textclasses) {
1642                     $textcss = 'class="' . trim($textclasses) . '" ';
1643                 } else {
1644                     $textcss = '';
1645                 }
1646                 $accesstext = '<span class="accesshide">' .
1647                         get_string('notavailableyet', 'condition') .
1648                         ': </span>';
1650                 if ($url = $mod->get_url()) {
1651                     // Display greyed-out text of link
1652                     echo '<div ' . $textcss . $mod->extra .
1653                             ' >' . '<img src="' . $mod->get_icon_url() .
1654                             '" class="activityicon" alt="' .
1655                             $modulename .
1656                             '" /> <span>'. $instancename . $altname .
1657                             '</span></div>';
1659                     // Do not display content after link when it is greyed out like this.
1660                 } else {
1661                     // No link, so display only content (also greyed)
1662                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1663                             $accesstext . $content . '</div>';
1664                 }
1665             }
1667             // Module can put text after the link (e.g. forum unread)
1668             echo $mod->get_after_link();
1670             // If there is content but NO link (eg label), then display the
1671             // content here (BEFORE any icons). In this case cons must be
1672             // displayed after the content so that it makes more sense visually
1673             // and for accessibility reasons, e.g. if you have a one-line label
1674             // it should work similarly (at least in terms of ordering) to an
1675             // activity.
1676             if (empty($url)) {
1677                 echo $contentpart;
1678             }
1680             if ($isediting) {
1681                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1682                     if (! $mod->groupmodelink = $groupbuttonslink) {
1683                         $mod->groupmode = $course->groupmode;
1684                     }
1686                 } else {
1687                     $mod->groupmode = false;
1688                 }
1689                 echo '&nbsp;&nbsp;';
1690                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1691                 echo $mod->get_after_edit_icons();
1692             }
1694             // Completion
1695             $completion = $hidecompletion
1696                 ? COMPLETION_TRACKING_NONE
1697                 : $completioninfo->is_enabled($mod);
1698             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1699                 !isguestuser() && $mod->uservisible) {
1700                 $completiondata = $completioninfo->get_data($mod,true);
1701                 $completionicon = '';
1702                 if ($isediting) {
1703                     switch ($completion) {
1704                         case COMPLETION_TRACKING_MANUAL :
1705                             $completionicon = 'manual-enabled'; break;
1706                         case COMPLETION_TRACKING_AUTOMATIC :
1707                             $completionicon = 'auto-enabled'; break;
1708                         default: // wtf
1709                     }
1710                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1711                     switch($completiondata->completionstate) {
1712                         case COMPLETION_INCOMPLETE:
1713                             $completionicon = 'manual-n'; break;
1714                         case COMPLETION_COMPLETE:
1715                             $completionicon = 'manual-y'; break;
1716                     }
1717                 } else { // Automatic
1718                     switch($completiondata->completionstate) {
1719                         case COMPLETION_INCOMPLETE:
1720                             $completionicon = 'auto-n'; break;
1721                         case COMPLETION_COMPLETE:
1722                             $completionicon = 'auto-y'; break;
1723                         case COMPLETION_COMPLETE_PASS:
1724                             $completionicon = 'auto-pass'; break;
1725                         case COMPLETION_COMPLETE_FAIL:
1726                             $completionicon = 'auto-fail'; break;
1727                     }
1728                 }
1729                 if ($completionicon) {
1730                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1731                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1732                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1733                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1734                         $newstate =
1735                             $completiondata->completionstate==COMPLETION_COMPLETE
1736                             ? COMPLETION_INCOMPLETE
1737                             : COMPLETION_COMPLETE;
1738                         // In manual mode the icon is a toggle form...
1740                         // If this completion state is used by the
1741                         // conditional activities system, we need to turn
1742                         // off the JS.
1743                         if (!empty($CFG->enableavailability) &&
1744                             condition_info::completion_value_used_as_condition($course, $mod)) {
1745                             $extraclass = ' preventjs';
1746                         } else {
1747                             $extraclass = '';
1748                         }
1749                         echo "
1750 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1751 <input type='hidden' name='id' value='{$mod->id}' />
1752 <input type='hidden' name='sesskey' value='".sesskey()."' />
1753 <input type='hidden' name='completionstate' value='$newstate' />
1754 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1755 </div></form>";
1756                     } else {
1757                         // In auto mode, or when editing, the icon is just an image
1758                         echo "<span class='autocompletion'>";
1759                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1760                     }
1761                 }
1762             }
1764             // If there is content AND a link, then display the content here
1765             // (AFTER any icons). Otherwise it was displayed before
1766             if (!empty($url)) {
1767                 echo $contentpart;
1768             }
1770             // Show availability information (for someone who isn't allowed to
1771             // see the activity itself, or for staff)
1772             if (!$mod->uservisible) {
1773                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1774             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1775                 $ci = new condition_info($mod);
1776                 $fullinfo = $ci->get_full_information();
1777                 if($fullinfo) {
1778                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1779                         ? 'userrestriction_visible'
1780                         : 'userrestriction_hidden','condition',
1781                         $fullinfo).'</div>';
1782                 }
1783             }
1785             echo html_writer::end_tag('div');
1786             echo html_writer::end_tag('li')."\n";
1787         }
1789     } elseif ($ismoving) {
1790         echo "<ul class=\"section\">\n";
1791     }
1793     if ($ismoving) {
1794         echo '<li><a title="'.$strmovefull.'"'.
1795              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1796              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1797              ' alt="'.$strmovehere.'" /></a></li>
1798              ';
1799     }
1800     if (!empty($section->sequence) || $ismoving) {
1801         echo "</ul><!--class='section'-->\n\n";
1802     }
1805 /**
1806  * Prints the menus to add activities and resources.
1807  */
1808 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1809     global $CFG, $OUTPUT;
1811     // check to see if user can add menus
1812     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1813         return false;
1814     }
1816     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1818     $resources = array();
1819     $activities = array();
1821     foreach($modnames as $modname=>$modnamestr) {
1822         if (!course_allowed_module($course, $modname)) {
1823             continue;
1824         }
1826         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1827         if (!file_exists($libfile)) {
1828             continue;
1829         }
1830         include_once($libfile);
1831         $gettypesfunc =  $modname.'_get_types';
1832         if (function_exists($gettypesfunc)) {
1833             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1834             if ($types = $gettypesfunc()) {
1835                 $menu = array();
1836                 $atype = null;
1837                 $groupname = null;
1838                 foreach($types as $type) {
1839                     if ($type->typestr === '--') {
1840                         continue;
1841                     }
1842                     if (strpos($type->typestr, '--') === 0) {
1843                         $groupname = str_replace('--', '', $type->typestr);
1844                         continue;
1845                     }
1846                     $type->type = str_replace('&amp;', '&', $type->type);
1847                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1848                         $atype = MOD_CLASS_RESOURCE;
1849                     }
1850                     $menu[$urlbase.$type->type] = $type->typestr;
1851                 }
1852                 if (!is_null($groupname)) {
1853                     if ($atype == MOD_CLASS_RESOURCE) {
1854                         $resources[] = array($groupname=>$menu);
1855                     } else {
1856                         $activities[] = array($groupname=>$menu);
1857                     }
1858                 } else {
1859                     if ($atype == MOD_CLASS_RESOURCE) {
1860                         $resources = array_merge($resources, $menu);
1861                     } else {
1862                         $activities = array_merge($activities, $menu);
1863                     }
1864                 }
1865             }
1866         } else {
1867             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1868             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1869                 $resources[$urlbase.$modname] = $modnamestr;
1870             } else {
1871                 // all other archetypes are considered activity
1872                 $activities[$urlbase.$modname] = $modnamestr;
1873             }
1874         }
1875     }
1877     $straddactivity = get_string('addactivity');
1878     $straddresource = get_string('addresource');
1880     $output  = '<div class="section_add_menus">';
1882     if (!$vertical) {
1883         $output .= '<div class="horizontal">';
1884     }
1886     if (!empty($resources)) {
1887         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1888         $select->set_help_icon('resources');
1889         $output .= $OUTPUT->render($select);
1890     }
1892     if (!empty($activities)) {
1893         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1894         $select->set_help_icon('activities');
1895         $output .= $OUTPUT->render($select);
1896     }
1898     if (!$vertical) {
1899         $output .= '</div>';
1900     }
1902     $output .= '</div>';
1904     if ($return) {
1905         return $output;
1906     } else {
1907         echo $output;
1908     }
1911 /**
1912  * Return the course category context for the category with id $categoryid, except
1913  * that if $categoryid is 0, return the system context.
1914  *
1915  * @param integer $categoryid a category id or 0.
1916  * @return object the corresponding context
1917  */
1918 function get_category_or_system_context($categoryid) {
1919     if ($categoryid) {
1920         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1921     } else {
1922         return get_context_instance(CONTEXT_SYSTEM);
1923     }
1926 /**
1927  * Gets the child categories of a given courses category. Uses a static cache
1928  * to make repeat calls efficient.
1929  *
1930  * @param int $parentid the id of a course category.
1931  * @return array all the child course categories.
1932  */
1933 function get_child_categories($parentid) {
1934     static $allcategories = null;
1936     // only fill in this variable the first time
1937     if (null == $allcategories) {
1938         $allcategories = array();
1940         $categories = get_categories();
1941         foreach ($categories as $category) {
1942             if (empty($allcategories[$category->parent])) {
1943                 $allcategories[$category->parent] = array();
1944             }
1945             $allcategories[$category->parent][] = $category;
1946         }
1947     }
1949     if (empty($allcategories[$parentid])) {
1950         return array();
1951     } else {
1952         return $allcategories[$parentid];
1953     }
1956 /**
1957  * This function recursively travels the categories, building up a nice list
1958  * for display. It also makes an array that list all the parents for each
1959  * category.
1960  *
1961  * For example, if you have a tree of categories like:
1962  *   Miscellaneous (id = 1)
1963  *      Subcategory (id = 2)
1964  *         Sub-subcategory (id = 4)
1965  *   Other category (id = 3)
1966  * Then after calling this function you will have
1967  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1968  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1969  *      3 => 'Other category');
1970  * $parents = array(2 => array(1), 4 => array(1, 2));
1971  *
1972  * If you specify $requiredcapability, then only categories where the current
1973  * user has that capability will be added to $list, although all categories
1974  * will still be added to $parents, and if you only have $requiredcapability
1975  * in a child category, not the parent, then the child catgegory will still be
1976  * included.
1977  *
1978  * If you specify the option $excluded, then that category, and all its children,
1979  * are omitted from the tree. This is useful when you are doing something like
1980  * moving categories, where you do not want to allow people to move a category
1981  * to be the child of itself.
1982  *
1983  * @param array $list For output, accumulates an array categoryid => full category path name
1984  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1985  * @param string/array $requiredcapability if given, only categories where the current
1986  *      user has this capability will be added to $list. Can also be an array of capabilities,
1987  *      in which case they are all required.
1988  * @param integer $excludeid Omit this category and its children from the lists built.
1989  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1990  * @param string $path For internal use, as part of recursive calls.
1991  */
1992 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1993         $excludeid = 0, $category = NULL, $path = "") {
1995     // initialize the arrays if needed
1996     if (!is_array($list)) {
1997         $list = array();
1998     }
1999     if (!is_array($parents)) {
2000         $parents = array();
2001     }
2003     if (empty($category)) {
2004         // Start at the top level.
2005         $category = new stdClass;
2006         $category->id = 0;
2007     } else {
2008         // This is the excluded category, don't include it.
2009         if ($excludeid > 0 && $excludeid == $category->id) {
2010             return;
2011         }
2013         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2014         $categoryname = format_string($category->name, true, array('context' => $context));
2016         // Update $path.
2017         if ($path) {
2018             $path = $path.' / '.$categoryname;
2019         } else {
2020             $path = $categoryname;
2021         }
2023         // Add this category to $list, if the permissions check out.
2024         if (empty($requiredcapability)) {
2025             $list[$category->id] = $path;
2027         } else {
2028             $requiredcapability = (array)$requiredcapability;
2029             if (has_all_capabilities($requiredcapability, $context)) {
2030                 $list[$category->id] = $path;
2031             }
2032         }
2033     }
2035     // Add all the children recursively, while updating the parents array.
2036     if ($categories = get_child_categories($category->id)) {
2037         foreach ($categories as $cat) {
2038             if (!empty($category->id)) {
2039                 if (isset($parents[$category->id])) {
2040                     $parents[$cat->id]   = $parents[$category->id];
2041                 }
2042                 $parents[$cat->id][] = $category->id;
2043             }
2044             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2045         }
2046     }
2049 /**
2050  * This function generates a structured array of courses and categories.
2051  *
2052  * The depth of categories is limited by $CFG->maxcategorydepth however there
2053  * is no limit on the number of courses!
2054  *
2055  * Suitable for use with the course renderers course_category_tree method:
2056  * $renderer = $PAGE->get_renderer('core','course');
2057  * echo $renderer->course_category_tree(get_course_category_tree());
2058  *
2059  * @global moodle_database $DB
2060  * @param int $id
2061  * @param int $depth
2062  */
2063 function get_course_category_tree($id = 0, $depth = 0) {
2064     global $DB, $CFG;
2065     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2066     $categories = get_child_categories($id);
2067     $categoryids = array();
2068     foreach ($categories as $key => &$category) {
2069         if (!$category->visible && !$viewhiddencats) {
2070             unset($categories[$key]);
2071             continue;
2072         }
2073         $categoryids[$category->id] = $category;
2074         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2075             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2076             foreach ($subcategories as $subid=>$subcat) {
2077                 $categoryids[$subid] = $subcat;
2078             }
2079             $category->courses = array();
2080         }
2081     }
2083     if ($depth > 0) {
2084         // This is a recursive call so return the required array
2085         return array($categories, $categoryids);
2086     }
2088     // The depth is 0 this function has just been called so we can finish it off
2090     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2091     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2092     $sql = "SELECT
2093             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2094             $ccselect
2095             FROM {course} c
2096             $ccjoin
2097             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2098     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2099         // loop throught them
2100         foreach ($courses as $course) {
2101             if ($course->id == SITEID) {
2102                 continue;
2103             }
2104             context_instance_preload($course);
2105             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2106                 $categoryids[$course->category]->courses[$course->id] = $course;
2107             }
2108         }
2109     }
2110     return $categories;
2113 /**
2114  * Recursive function to print out all the categories in a nice format
2115  * with or without courses included
2116  */
2117 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2118     global $CFG;
2120     // maxcategorydepth == 0 meant no limit
2121     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2122         return;
2123     }
2125     if (!$displaylist) {
2126         make_categories_list($displaylist, $parentslist);
2127     }
2129     if ($category) {
2130         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2131             print_category_info($category, $depth, $showcourses);
2132         } else {
2133             return;  // Don't bother printing children of invisible categories
2134         }
2136     } else {
2137         $category->id = "0";
2138     }
2140     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2141         $countcats = count($categories);
2142         $count = 0;
2143         $first = true;
2144         $last = false;
2145         foreach ($categories as $cat) {
2146             $count++;
2147             if ($count == $countcats) {
2148                 $last = true;
2149             }
2150             $up = $first ? false : true;
2151             $down = $last ? false : true;
2152             $first = false;
2154             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2155         }
2156     }
2159 /**
2160  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2161  */
2162 function make_categories_options() {
2163     make_categories_list($cats,$parents);
2164     foreach ($cats as $key => $value) {
2165         if (array_key_exists($key,$parents)) {
2166             if ($indent = count($parents[$key])) {
2167                 for ($i = 0; $i < $indent; $i++) {
2168                     $cats[$key] = '&nbsp;'.$cats[$key];
2169                 }
2170             }
2171         }
2172     }
2173     return $cats;
2176 /**
2177  * Gets the name of a course to be displayed when showing a list of courses.
2178  * By default this is just $course->fullname but user can configure it. The
2179  * result of this function should be passed through print_string.
2180  * @param object $course Moodle course object
2181  * @return string Display name of course (either fullname or short + fullname)
2182  */
2183 function get_course_display_name_for_list($course) {
2184     global $CFG;
2185     if (!empty($CFG->courselistshortnames)) {
2186         return $course->shortname . ' ' .$course->fullname;
2187     } else {
2188         return $course->fullname;
2189     }
2192 /**
2193  * Prints the category info in indented fashion
2194  * This function is only used by print_whole_category_list() above
2195  */
2196 function print_category_info($category, $depth=0, $showcourses = false) {
2197     global $CFG, $DB, $OUTPUT;
2199     $strsummary = get_string('summary');
2201     $catlinkcss = null;
2202     if (!$category->visible) {
2203         $catlinkcss = array('class'=>'dimmed');
2204     }
2205     static $coursecount = null;
2206     if (null === $coursecount) {
2207         // only need to check this once
2208         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2209     }
2211     if ($showcourses and $coursecount) {
2212         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2213     } else {
2214         $catimage = "&nbsp;";
2215     }
2217     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2218     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2219     $fullname = format_string($category->name, true, array('context' => $context));
2221     if ($showcourses and $coursecount) {
2222         echo '<div class="categorylist clearfix">';
2223         $cat = '';
2224         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2225         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2226         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2228         $html = '';
2229         if ($depth > 0) {
2230             for ($i=0; $i< $depth; $i++) {
2231                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2232                 $cat = '';
2233             }
2234         } else {
2235             $html = $cat;
2236         }
2237         echo html_writer::tag('div', $html, array('class'=>'category'));
2238         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2240         // does the depth exceed maxcategorydepth
2241         // maxcategorydepth == 0 or unset meant no limit
2242         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2243         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2244             foreach ($courses as $course) {
2245                 $linkcss = null;
2246                 if (!$course->visible) {
2247                     $linkcss = array('class'=>'dimmed');
2248                 }
2250                 $coursename = get_course_display_name_for_list($course);
2251                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2253                 // print enrol info
2254                 $courseicon = '';
2255                 if ($icons = enrol_get_course_info_icons($course)) {
2256                     foreach ($icons as $pix_icon) {
2257                         $courseicon = $OUTPUT->render($pix_icon).' ';
2258                     }
2259                 }
2261                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2263                 if ($course->summary) {
2264                     $link = new moodle_url('/course/info.php?id='.$course->id);
2265                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2266                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2267                         array('title'=>$strsummary));
2269                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2270                 }
2272                 $html = '';
2273                 for ($i=0; $i <= $depth; $i++) {
2274                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2275                     $coursecontent = '';
2276                 }
2277                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2278             }
2279         }
2280         echo '</div>';
2281     } else {
2282         echo '<div class="categorylist">';
2283         $html = '';
2284         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2285         if (count($courses) > 0) {
2286             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2287         }
2289         if ($depth > 0) {
2290             for ($i=0; $i< $depth; $i++) {
2291                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2292                 $cat = '';
2293             }
2294         } else {
2295             $html = $cat;
2296         }
2298         echo html_writer::tag('div', $html, array('class'=>'category'));
2299         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2300         echo '</div>';
2301     }
2304 /**
2305  * Print the buttons relating to course requests.
2306  *
2307  * @param object $systemcontext the system context.
2308  */
2309 function print_course_request_buttons($systemcontext) {
2310     global $CFG, $DB, $OUTPUT;
2311     if (empty($CFG->enablecourserequests)) {
2312         return;
2313     }
2314     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2315     /// Print a button to request a new course
2316         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2317     }
2318     /// Print a button to manage pending requests
2319     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2320         $disabled = !$DB->record_exists('course_request', array());
2321         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2322     }
2325 /**
2326  * Does the user have permission to edit things in this category?
2327  *
2328  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2329  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2330  */
2331 function can_edit_in_category($categoryid = 0) {
2332     $context = get_category_or_system_context($categoryid);
2333     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2336 /**
2337  * Prints the turn editing on/off button on course/index.php or course/category.php.
2338  *
2339  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2340  * @return string HTML of the editing button, or empty string, if this user is not allowed
2341  *      to see it.
2342  */
2343 function update_category_button($categoryid = 0) {
2344     global $CFG, $PAGE, $OUTPUT;
2346     // Check permissions.
2347     if (!can_edit_in_category($categoryid)) {
2348         return '';
2349     }
2351     // Work out the appropriate action.
2352     if ($PAGE->user_is_editing()) {
2353         $label = get_string('turneditingoff');
2354         $edit = 'off';
2355     } else {
2356         $label = get_string('turneditingon');
2357         $edit = 'on';
2358     }
2360     // Generate the button HTML.
2361     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2362     if ($categoryid) {
2363         $options['id'] = $categoryid;
2364         $page = 'category.php';
2365     } else {
2366         $page = 'index.php';
2367     }
2368     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2371 /**
2372  * Category is 0 (for all courses) or an object
2373  */
2374 function print_courses($category) {
2375     global $CFG, $OUTPUT;
2377     if (!is_object($category) && $category==0) {
2378         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2379         if (is_array($categories) && count($categories) == 1) {
2380             $category   = array_shift($categories);
2381             $courses    = get_courses_wmanagers($category->id,
2382                                                 'c.sortorder ASC',
2383                                                 array('summary','summaryformat'));
2384         } else {
2385             $courses    = get_courses_wmanagers('all',
2386                                                 'c.sortorder ASC',
2387                                                 array('summary','summaryformat'));
2388         }
2389         unset($categories);
2390     } else {
2391         $courses    = get_courses_wmanagers($category->id,
2392                                             'c.sortorder ASC',
2393                                             array('summary','summaryformat'));
2394     }
2396     if ($courses) {
2397         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2398         foreach ($courses as $course) {
2399             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2400             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2401                 echo html_writer::start_tag('li');
2402                 print_course($course);
2403                 echo html_writer::end_tag('li');
2404             }
2405         }
2406         echo html_writer::end_tag('ul');
2407     } else {
2408         echo $OUTPUT->heading(get_string("nocoursesyet"));
2409         $context = get_context_instance(CONTEXT_SYSTEM);
2410         if (has_capability('moodle/course:create', $context)) {
2411             $options = array();
2412             if (!empty($category->id)) {
2413                 $options['category'] = $category->id;
2414             } else {
2415                 $options['category'] = $CFG->defaultrequestcategory;
2416             }
2417             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2418             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2419             echo html_writer::end_tag('div');
2420         }
2421     }
2424 /**
2425  * Print a description of a course, suitable for browsing in a list.
2426  *
2427  * @param object $course the course object.
2428  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2429  */
2430 function print_course($course, $highlightterms = '') {
2431     global $CFG, $USER, $DB, $OUTPUT;
2433     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2435     // Rewrite file URLs so that they are correct
2436     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2438     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2439     echo html_writer::start_tag('div', array('class'=>'info'));
2440     echo html_writer::start_tag('h3', array('class'=>'name'));
2442     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2444     $coursename = get_course_display_name_for_list($course);
2445     $linktext = highlight($highlightterms, format_string($coursename));
2446     $linkparams = array('title'=>get_string('entercourse'));
2447     if (empty($course->visible)) {
2448         $linkparams['class'] = 'dimmed';
2449     }
2450     echo html_writer::link($linkhref, $linktext, $linkparams);
2451     echo html_writer::end_tag('h3');
2453     /// first find all roles that are supposed to be displayed
2454     if (!empty($CFG->coursecontact)) {
2455         $managerroles = explode(',', $CFG->coursecontact);
2456         $namesarray = array();
2457         if (isset($course->managers)) {
2458             if (count($course->managers)) {
2459                 $rusers = $course->managers;
2460                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2462                  /// Rename some of the role names if needed
2463                 if (isset($context)) {
2464                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2465                 }
2467                 // keep a note of users displayed to eliminate duplicates
2468                 $usersshown = array();
2469                 foreach ($rusers as $ra) {
2471                     // if we've already displayed user don't again
2472                     if (in_array($ra->user->id,$usersshown)) {
2473                         continue;
2474                     }
2475                     $usersshown[] = $ra->user->id;
2477                     $fullname = fullname($ra->user, $canviewfullnames);
2479                     if (isset($aliasnames[$ra->roleid])) {
2480                         $ra->rolename = $aliasnames[$ra->roleid]->name;
2481                     }
2483                     $namesarray[] = format_string($ra->rolename).': '.
2484                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
2485                 }
2486             }
2487         } else {
2488             $rusers = get_role_users($managerroles, $context,
2489                                      true, '', 'r.sortorder ASC, u.lastname ASC');
2490             if (is_array($rusers) && count($rusers)) {
2491                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2493                 /// Rename some of the role names if needed
2494                 if (isset($context)) {
2495                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2496                 }
2498                 foreach ($rusers as $teacher) {
2499                     $fullname = fullname($teacher, $canviewfullnames);
2501                     /// Apply role names
2502                     if (isset($aliasnames[$teacher->roleid])) {
2503                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2504                     }
2506                     $namesarray[] = format_string($teacher->rolename).': '.
2507                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
2508                 }
2509             }
2510         }
2512         if (!empty($namesarray)) {
2513             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2514             foreach ($namesarray as $name) {
2515                 echo html_writer::tag('li', $name);
2516             }
2517             echo html_writer::end_tag('ul');
2518         }
2519     }
2520     echo html_writer::end_tag('div'); // End of info div
2522     echo html_writer::start_tag('div', array('class'=>'summary'));
2523     $options = NULL;
2524     $options->noclean = true;
2525     $options->para = false;
2526     $options->overflowdiv = true;
2527     if (!isset($course->summaryformat)) {
2528         $course->summaryformat = FORMAT_MOODLE;
2529     }
2530     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2531     if ($icons = enrol_get_course_info_icons($course)) {
2532         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2533         foreach ($icons as $icon) {
2534             echo $OUTPUT->render($icon);
2535         }
2536         echo html_writer::end_tag('div'); // End of enrolmenticons div
2537     }
2538     echo html_writer::end_tag('div'); // End of summary div
2539     echo html_writer::end_tag('div'); // End of coursebox div
2542 /**
2543  * Prints custom user information on the home page.
2544  * Over time this can include all sorts of information
2545  */
2546 function print_my_moodle() {
2547     global $USER, $CFG, $DB, $OUTPUT;
2549     if (!isloggedin() or isguestuser()) {
2550         print_error('nopermissions', '', '', 'See My Moodle');
2551     }
2553     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2554     $rhosts   = array();
2555     $rcourses = array();
2556     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2557         $rcourses = get_my_remotecourses($USER->id);
2558         $rhosts   = get_my_remotehosts();
2559     }
2561     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2563         if (!empty($courses)) {
2564             echo '<ul class="unlist">';
2565             foreach ($courses as $course) {
2566                 if ($course->id == SITEID) {
2567                     continue;
2568                 }
2569                 echo '<li>';
2570                 print_course($course);
2571                 echo "</li>\n";
2572             }
2573             echo "</ul>\n";
2574         }
2576         // MNET
2577         if (!empty($rcourses)) {
2578             // at the IDP, we know of all the remote courses
2579             foreach ($rcourses as $course) {
2580                 print_remote_course($course, "100%");
2581             }
2582         } elseif (!empty($rhosts)) {
2583             // non-IDP, we know of all the remote servers, but not courses
2584             foreach ($rhosts as $host) {
2585                 print_remote_host($host, "100%");
2586             }
2587         }
2588         unset($course);
2589         unset($host);
2591         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2592             echo "<table width=\"100%\"><tr><td align=\"center\">";
2593             print_course_search("", false, "short");
2594             echo "</td><td align=\"center\">";
2595             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2596             echo "</td></tr></table>\n";
2597         }
2599     } else {
2600         if ($DB->count_records("course_categories") > 1) {
2601             echo $OUTPUT->box_start("categorybox");
2602             print_whole_category_list();
2603             echo $OUTPUT->box_end();
2604         } else {
2605             print_courses(0);
2606         }
2607     }
2611 function print_course_search($value="", $return=false, $format="plain") {
2612     global $CFG;
2613     static $count = 0;
2615     $count++;
2617     $id = 'coursesearch';
2619     if ($count > 1) {
2620         $id .= $count;
2621     }
2623     $strsearchcourses= get_string("searchcourses");
2625     if ($format == 'plain') {
2626         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2627         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2628         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2629         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2630         $output .= '<input type="submit" value="'.get_string('go').'" />';
2631         $output .= '</fieldset></form>';
2632     } else if ($format == 'short') {
2633         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2634         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2635         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2636         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2637         $output .= '<input type="submit" value="'.get_string('go').'" />';
2638         $output .= '</fieldset></form>';
2639     } else if ($format == 'navbar') {
2640         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2641         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2642         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2643         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2644         $output .= '<input type="submit" value="'.get_string('go').'" />';
2645         $output .= '</fieldset></form>';
2646     }
2648     if ($return) {
2649         return $output;
2650     }
2651     echo $output;
2654 function print_remote_course($course, $width="100%") {
2655     global $CFG, $USER;
2657     $linkcss = '';
2659     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2661     echo '<div class="coursebox remotecoursebox clearfix">';
2662     echo '<div class="info">';
2663     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2664          $linkcss.' href="'.$url.'">'
2665         .  format_string($course->fullname) .'</a><br />'
2666         . format_string($course->hostname) . ' : '
2667         . format_string($course->cat_name) . ' : '
2668         . format_string($course->shortname). '</div>';
2669     echo '</div><div class="summary">';
2670     $options = NULL;
2671     $options->noclean = true;
2672     $options->para = false;
2673     $options->overflowdiv = true;
2674     echo format_text($course->summary, $course->summaryformat, $options);
2675     echo '</div>';
2676     echo '</div>';
2679 function print_remote_host($host, $width="100%") {
2680     global $OUTPUT;
2682     $linkcss = '';
2684     echo '<div class="coursebox clearfix">';
2685     echo '<div class="info">';
2686     echo '<div class="name">';
2687     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2688     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2689         . s($host['name']).'</a> - ';
2690     echo $host['count'] . ' ' . get_string('courses');
2691     echo '</div>';
2692     echo '</div>';
2693     echo '</div>';
2697 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2699 function add_course_module($mod) {
2700     global $DB;
2702     $mod->added = time();
2703     unset($mod->id);
2705     return $DB->insert_record("course_modules", $mod);
2708 /**
2709  * Returns course section - creates new if does not exist yet.
2710  * @param int $relative section number
2711  * @param int $courseid
2712  * @return object $course_section object
2713  */
2714 function get_course_section($section, $courseid) {
2715     global $DB;
2717     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2718         return $cw;
2719     }
2720     $cw = new stdClass();
2721     $cw->course   = $courseid;
2722     $cw->section  = $section;
2723     $cw->summary  = "";
2724     $cw->summaryformat = FORMAT_HTML;
2725     $cw->sequence = "";
2726     $id = $DB->insert_record("course_sections", $cw);
2727     return $DB->get_record("course_sections", array("id"=>$id));
2729 /**
2730  * Given a full mod object with section and course already defined, adds this module to that section.
2731  *
2732  * @param object $mod
2733  * @param int $beforemod An existing ID which we will insert the new module before
2734  * @return int The course_sections ID where the mod is inserted
2735  */
2736 function add_mod_to_section($mod, $beforemod=NULL) {
2737     global $DB;
2739     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2741         $section->sequence = trim($section->sequence);
2743         if (empty($section->sequence)) {
2744             $newsequence = "$mod->coursemodule";
2746         } else if ($beforemod) {
2747             $modarray = explode(",", $section->sequence);
2749             if ($key = array_keys($modarray, $beforemod->id)) {
2750                 $insertarray = array($mod->id, $beforemod->id);
2751                 array_splice($modarray, $key[0], 1, $insertarray);
2752                 $newsequence = implode(",", $modarray);
2754             } else {  // Just tack it on the end anyway
2755                 $newsequence = "$section->sequence,$mod->coursemodule";
2756             }
2758         } else {
2759             $newsequence = "$section->sequence,$mod->coursemodule";
2760         }
2762         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2763         return $section->id;     // Return course_sections ID that was used.
2765     } else {  // Insert a new record
2766         $section->course   = $mod->course;
2767         $section->section  = $mod->section;
2768         $section->summary  = "";
2769         $section->summaryformat = FORMAT_HTML;
2770         $section->sequence = $mod->coursemodule;
2771         return $DB->insert_record("course_sections", $section);
2772     }
2775 function set_coursemodule_groupmode($id, $groupmode) {
2776     global $DB;
2777     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2780 function set_coursemodule_idnumber($id, $idnumber) {
2781     global $DB;
2782     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2785 /**
2786 * $prevstateoverrides = true will set the visibility of the course module
2787 * to what is defined in visibleold. This enables us to remember the current
2788 * visibility when making a whole section hidden, so that when we toggle
2789 * that section back to visible, we are able to return the visibility of
2790 * the course module back to what it was originally.
2791 */
2792 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2793     global $DB, $CFG;
2794     require_once($CFG->libdir.'/gradelib.php');
2796     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2797         return false;
2798     }
2799     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2800         return false;
2801     }
2802     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2803         foreach($events as $event) {
2804             if ($visible) {
2805                 show_event($event);
2806             } else {
2807                 hide_event($event);
2808             }
2809         }
2810     }
2812     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2813     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2814     if ($grade_items) {
2815         foreach ($grade_items as $grade_item) {
2816             $grade_item->set_hidden(!$visible);
2817         }
2818     }
2820     if ($prevstateoverrides) {
2821         if ($visible == '0') {
2822             // Remember the current visible state so we can toggle this back.
2823             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2824         } else {
2825             // Get the previous saved visible states.
2826             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2827         }
2828     }
2829     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2832 /**
2833  * Delete a course module and any associated data at the course level (events)
2834  * Until 1.5 this function simply marked a deleted flag ... now it
2835  * deletes it completely.
2836  *
2837  */
2838 function delete_course_module($id) {
2839     global $CFG, $DB;
2840     require_once($CFG->libdir.'/gradelib.php');
2841     require_once($CFG->dirroot.'/blog/lib.php');
2843     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2844         return true;
2845     }
2846     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2847     //delete events from calendar
2848     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2849         foreach($events as $event) {
2850             delete_event($event->id);
2851         }
2852     }
2853     //delete grade items, outcome items and grades attached to modules
2854     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2855                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2856         foreach ($grade_items as $grade_item) {
2857             $grade_item->delete('moddelete');
2858         }
2859     }
2860     // Delete completion and availability data; it is better to do this even if the
2861     // features are not turned on, in case they were turned on previously (these will be
2862     // very quick on an empty table)
2863     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2864     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2866     delete_context(CONTEXT_MODULE, $cm->id);
2867     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2870 function delete_mod_from_section($mod, $section) {
2871     global $DB;
2873     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2875         $modarray = explode(",", $section->sequence);
2877         if ($key = array_keys ($modarray, $mod)) {
2878             array_splice($modarray, $key[0], 1);
2879             $newsequence = implode(",", $modarray);
2880             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2881         } else {
2882             return false;
2883         }
2885     }
2886     return false;
2889 /**
2890  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2891  *
2892  * @param object $course
2893  * @param int $section
2894  * @param int $move (-1 or 1)
2895  */
2896 function move_section($course, $section, $move) {
2897 /// Moves a whole course section up and down within the course
2898     global $USER, $DB;
2900     if (!$move) {
2901         return true;
2902     }
2904     $sectiondest = $section + $move;
2906     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2907         return false;
2908     }
2910     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2911         return false;
2912     }
2914     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2915         return false;
2916     }
2918     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2919     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2921     // if the focus is on the section that is being moved, then move the focus along
2922     if (course_get_display($course->id) == $section) {
2923         course_set_display($course->id, $sectiondest);
2924     }
2926     // Check for duplicates and fix order if needed.
2927     // There is a very rare case that some sections in the same course have the same section id.
2928     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2929     $n = 0;
2930     foreach ($sections as $section) {
2931         if ($section->section != $n) {
2932             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2933         }
2934         $n++;
2935     }
2936     return true;
2939 /**
2940  * Moves a section within a course, from a position to another.
2941  * Be very careful: $section and $destination refer to section number,
2942  * not id!.
2943  *
2944  * @param object $course
2945  * @param int $section Section number (not id!!!)
2946  * @param int $destination
2947  * @return boolean Result
2948  */
2949 function move_section_to($course, $section, $destination) {
2950 /// Moves a whole course section up and down within the course
2951     global $USER, $DB;
2953     if (!$destination && $destination != 0) {
2954         return true;
2955     }
2957     if ($destination > $course->numsections) {
2958         return false;
2959     }
2961     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2962     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2963             'section ASC, id ASC', 'id, section')) {
2964         return false;
2965     }
2967     $sections = reorder_sections($sections, $section, $destination);
2969     // Update all sections
2970     foreach ($sections as $id => $position) {
2971         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2972     }
2974     // if the focus is on the section that is being moved, then move the focus along
2975     if (course_get_display($course->id) == $section) {
2976         course_set_display($course->id, $destination);
2977     }
2978     return true;
2981 /**
2982  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2983  * an original position number and a target position number, rebuilds the array so that the
2984  * move is made without any duplication of section positions.
2985  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2986  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2987  *
2988  * @param array $sections
2989  * @param int $origin_position
2990  * @param int $target_position
2991  * @return array
2992  */
2993 function reorder_sections($sections, $origin_position, $target_position) {
2994     if (!is_array($sections)) {
2995         return false;
2996     }
2998     // We can't move section position 0
2999     if ($origin_position < 1) {
3000         echo "We can't move section position 0";
3001         return false;
3002     }
3004     // Locate origin section in sections array
3005     if (!$origin_key = array_search($origin_position, $sections)) {
3006         echo "searched position not in sections array";
3007         return false; // searched position not in sections array
3008     }
3010     // Extract origin section
3011     $origin_section = $sections[$origin_key];
3012     unset($sections[$origin_key]);
3014     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3015     $found = false;
3016     $append_array = array();
3017     foreach ($sections as $id => $position) {
3018         if ($found) {
3019             $append_array[$id] = $position;
3020             unset($sections[$id]);
3021         }
3022         if ($position == $target_position) {
3023             $found = true;
3024         }
3025     }
3027     // Append moved section
3028     $sections[$origin_key] = $origin_section;
3030     // Append rest of array (if applicable)
3031     if (!empty($append_array)) {
3032         foreach ($append_array as $id => $position) {
3033             $sections[$id] = $position;
3034         }
3035     }
3037     // Renumber positions
3038     $position = 0;
3039     foreach ($sections as $id => $p) {
3040         $sections[$id] = $position;
3041         $position++;
3042     }
3044     return $sections;
3048 /**
3049  * Move the module object $mod to the specified $section
3050  * If $beforemod exists then that is the module
3051  * before which $modid should be inserted
3052  * All parameters are objects
3053  */
3054 function moveto_module($mod, $section, $beforemod=NULL) {
3055     global $DB, $OUTPUT;
3057 /// Remove original module from original section
3058     if (! delete_mod_from_section($mod->id, $mod->section)) {
3059         echo $OUTPUT->notification("Could not delete module from existing section");
3060     }
3062 /// Update module itself if necessary
3064     if ($mod->section != $section->id) {
3065         $mod->section = $section->id;
3066         $DB->update_record("course_modules", $mod);
3067         // if moving to a hidden section then hide module
3068         if (!$section->visible) {
3069             set_coursemodule_visible($mod->id, 0);
3070         }
3071     }
3073 /// Add the module into the new section
3075     $mod->course       = $section->course;
3076     $mod->section      = $section->section;  // need relative reference
3077     $mod->coursemodule = $mod->id;
3079     if (! add_mod_to_section($mod, $beforemod)) {
3080         return false;
3081     }
3083     return true;
3086 /**
3087  * Produces the editing buttons for a module
3088  *
3089  * @global core_renderer $OUTPUT
3090  * @staticvar type $str
3091  * @param stdClass $mod The module to produce editing buttons for
3092  * @param bool $absolute If true an absolute link is produced (default true)
3093  * @param bool $moveselect If true a move seleciton process is used (default true)
3094  * @param int $indent The current indenting
3095  * @param int $section The section to link back to
3096  * @return string XHTML for the editing buttons
3097  */
3098 function make_editing_buttons(stdClass $mod, $absolute = true, $moveselect = true, $indent=-1, $section=-1) {
3099     global $CFG, $OUTPUT;
3101     static $str;
3103     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3104     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3106     // no permission to edit
3107     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
3108         return false;
3109     }
3111     if (!isset($str)) {
3112         $str = new stdClass;
3113         $str->assign         = get_string("assignroles", 'role');
3114         $str->delete         = get_string("delete");
3115         $str->move           = get_string("move");
3116         $str->moveup         = get_string("moveup");
3117         $str->movedown       = get_string("movedown");
3118         $str->moveright      = get_string("moveright");
3119         $str->moveleft       = get_string("moveleft");
3120         $str->update         = get_string("update");
3121         $str->duplicate      = get_string("duplicate");
3122         $str->hide           = get_string("hide");
3123         $str->show           = get_string("show");
3124         $str->clicktochange  = get_string("clicktochange");
3125         $str->forcedmode     = get_string("forcedmode");
3126         $str->groupsnone     = get_string("groupsnone");
3127         $str->groupsseparate = get_string("groupsseparate");
3128         $str->groupsvisible  = get_string("groupsvisible");
3129     }
3131     if ($absolute) {
3132         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3133     } else {
3134         $baseurl = new moodle_url('mod.php', array('sesskey' => sesskey()));
3135     }
3137     if ($section >= 0) {
3138         $baseurl->param('sr', $section);
3139     }
3140     $actions = array();
3142     // leftright
3143     if (has_capability('moodle/course:update', $coursecontext)) {
3144         if (right_to_left()) {   // Exchange arrows on RTL
3145             $rightarrow = 't/left';
3146             $leftarrow  = 't/right';
3147         } else {
3148             $rightarrow = 't/right';
3149             $leftarrow  = 't/left';
3150         }
3152         if ($indent > 0) {
3153             $actions[] = new action_link(
3154                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3155                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3156                 null,
3157                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3158             );
3159         }
3160         if ($indent >= 0) {
3161             $actions[] = new action_link(
3162                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3163                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3164                 null,
3165                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3166             );
3167         }
3168     }
3170     // move
3171     if (has_capability('moodle/course:update', $coursecontext)) {
3172         if ($moveselect) {
3173             $actions[] = new action_link(
3174                 new moodle_url($baseurl, array('copy' => $mod->id)),
3175                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3176                 null,
3177                 array('class' => 'editing_move', 'title' => $str->move)
3178             );
3179         } else {
3180             $actions[] = new action_link(
3181                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3182                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3183                 null,
3184                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3185             );
3186             $actions[] = new action_link(
3187                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3188                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3189                 null,
3190                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3191             );
3192         }
3193     }
3195     // Update
3196     $actions[] = new action_link(
3197         new moodle_url($baseurl, array('update' => $mod->id)),
3198         new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3199         null,
3200         array('class' => 'editing_update', 'title' => $str->update)
3201     );
3203     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3204     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3205     if (has_all_capabilities($dupecaps, $coursecontext)) {
3206         $actions[] = new action_link(
3207             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3208             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3209             null,
3210             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3211         );
3212     }
3214     // Delete
3215     $actions[] = new action_link(
3216         new moodle_url($baseurl, array('delete' => $mod->id)),
3217         new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3218         null,
3219         array('class' => 'editing_delete', 'title' => $str->delete)
3220     );
3222     // hideshow
3223     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3224         if ($mod->visible) {
3225             $actions[] = new action_link(
3226                 new moodle_url($baseurl, array('hide' => $mod->id)),
3227                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3228                 null,
3229                 array('class' => 'editing_hide', 'title' => $str->hide)
3230             );
3231         } else {
3232             $actions[] = new action_link(
3233                 new moodle_url($baseurl, array('show' => $mod->id)),
3234                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3235                 null,
3236                 array('class' => 'editing_show', 'title' => $str->show)
3237             );
3238         }
3239     }
3241     // groupmode
3242     if ($mod->groupmode !== false) {
3243         if ($mod->groupmode == SEPARATEGROUPS) {
3244             $groupmode = 0;
3245             $grouptitle = $str->groupsseparate;
3246             $groupclass = 'editing_groupsseparate';
3247             $groupimage = 't/groups';
3248         } else if ($mod->groupmode == VISIBLEGROUPS) {
3249             $groupmode = 1;
3250             $grouptitle = $str->groupsvisible;
3251             $groupclass = 'editing_groupsvisible';
3252             $groupimage = 't/groupv';
3253         } else {
3254             $groupmode = 2;
3255             $grouptitle = $str->groupsnone;
3256             $groupclass = 'editing_groupsnone';
3257             $groupimage = 't/groupn';
3258         }
3259         if ($mod->groupmodelink) {
3260             $actions[] = new action_link(
3261                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3262                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3263                 null,
3264                 array('class' => $groupclass, 'title' => $grouptitle.' ('.$str->clicktochange.')')
3265             );
3266         } else {
3267             $actions[] = new pix_icon($groupimage, $grouptitle, 'moodle', array('title' => $grouptitle.' ('.$str->forcedmode.')', 'class' => 'iconsmall'));
3268         }
3269     }
3271     // Assign
3272     if (has_capability('moodle/course:managegroups', $modcontext)){
3273         $actions[] = new action_link(
3274             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3275             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3276             null,
3277             array('class' => 'editing_assign', 'title' => $str->assign)
3278         );
3279     }
3281     $output = html_writer::start_tag('span', array('class' => 'commands'));
3282     foreach ($actions as $action) {
3283         if ($action instanceof renderable) {
3284             $output .= $OUTPUT->render($action);
3285         } else {
3286             $output .= $action;
3287         }
3288     }
3289     $output .= html_writer::end_tag('span');
3290     return $output;
3293 /**
3294  * given a course object with shortname & fullname, this function will
3295  * truncate the the number of chars allowed and add ... if it was too long
3296  */
3297 function course_format_name ($course,$max=100) {
3299     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3300     $shortname = format_string($course->shortname, true, array('context' => $context));
3301     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3302     $str = $shortname.': '. $fullname;
3303     if (textlib::strlen($str) <= $max) {
3304         return $str;
3305     }
3306     else {
3307         return textlib::substr($str,0,$max-3).'...';
3308     }
3311 function update_restricted_mods($course, $mods) {
3312     global $DB;
3314 /// Delete all the current restricted list
3315     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3317     if (empty($course->restrictmodules)) {
3318         return;   // We're done
3319     }
3321 /// Insert the new list of restricted mods
3322     foreach ($mods as $mod) {
3323         if ($mod == 0) {
3324             continue; // this is the 'allow none' option
3325         }
3326         $am = new stdClass();
3327         $am->course = $course->id;
3328         $am->module = $mod;
3329         $DB->insert_record('course_allowed_modules',$am);
3330     }
3333 /**
3334  * This function will take an int (module id) or a string (module name)
3335  * and return true or false, whether it's allowed in the given course (object)
3336  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3337  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3338  */
3340 function course_allowed_module($course,$mod) {
3341     global $DB;
3343     if (empty($course->restrictmodules)) {
3344         return true;
3345     }
3347     // Admins and admin-like people who can edit everything can also add anything.
3348     // Originally there was a course:update test only, but it did not match the test in course edit form
3349     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3350         return true;
3351     }
3353     if (is_numeric($mod)) {
3354         $modid = $mod;
3355     } else if (is_string($mod)) {
3356         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3357     }
3358     if (empty($modid)) {
3359         return false;
3360     }
3362     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3365 /**
3366  * Recursively delete category including all subcategories and courses.
3367  * @param stdClass $category
3368  * @param boolean $showfeedback display some notices
3369  * @return array return deleted courses
3370  */
3371 function category_delete_full($category, $showfeedback=true) {
3372     global $CFG, $DB;
3373     require_once($CFG->libdir.'/gradelib.php');
3374     require_once($CFG->libdir.'/questionlib.php');
3375     require_once($CFG->dirroot.'/cohort/lib.php');
3377     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3378         foreach ($children as $childcat) {
3379             category_delete_full($childcat, $showfeedback);
3380         }
3381     }
3383     $deletedcourses = array();
3384     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3385         foreach ($courses as $course) {
3386             if (!delete_course($course, false)) {
3387                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3388             }
3389             $deletedcourses[] = $course;
3390         }
3391     }
3393     // move or delete cohorts in this context
3394     cohort_delete_category($category);
3396     // now delete anything that may depend on course category context
3397     grade_course_category_delete($category->id, 0, $showfeedback);
3398     if (!question_delete_course_category($category, 0, $showfeedback)) {
3399         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3400     }
3402     // finally delete the category and it's context
3403     $DB->delete_records('course_categories', array('id'=>$category->id));
3404     delete_context(CONTEXT_COURSECAT, $category->id);
3406     events_trigger('course_category_deleted', $category);
3408     return $deletedcourses;
3411 /**
3412  * Delete category, but move contents to another category.
3413  * @param object $ccategory
3414  * @param int $newparentid category id
3415  * @return bool status
3416  */
3417 function category_delete_move($category, $newparentid, $showfeedback=true) {
3418     global $CFG, $DB, $OUTPUT;
3419     require_once($CFG->libdir.'/gradelib.php');
3420     require_once($CFG->libdir.'/questionlib.php');
3421     require_once($CFG->dirroot.'/cohort/lib.php');
3423     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3424         return false;
3425     }
3427     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3428         foreach ($children as $childcat) {
3429             move_category($childcat, $newparentcat);
3430         }
3431     }
3433     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3434         if (!move_courses(array_keys($courses), $newparentid)) {
3435             echo $OUTPUT->notification("Error moving courses");
3436             return false;
3437         }
3438         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3439     }
3441     // move or delete cohorts in this context
3442     cohort_delete_category($category);
3444     // now delete anything that may depend on course category context
3445     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3446     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3447         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3448         return false;
3449     }
3451     // finally delete the category and it's context
3452     $DB->delete_records('course_categories', array('id'=>$category->id));
3453     delete_context(CONTEXT_COURSECAT, $category->id);
3455     events_trigger('course_category_deleted', $category);
3457     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3459     return true;
3462 /**
3463  * Efficiently moves many courses around while maintaining
3464  * sortorder in order.
3465  *
3466  * @param array $courseids is an array of course ids
3467  * @param int $categoryid
3468  * @return bool success
3469  */
3470 function move_courses($courseids, $categoryid) {
3471     global $CFG, $DB, $OUTPUT;
3473     if (empty($courseids)) {
3474         // nothing to do
3475         return;
3476     }
3478     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3479         return false;
3480     }
3482     $courseids = array_reverse($courseids);
3483     $newparent = get_context_instance(CONTEXT_COURSECAT, $category->id);
3484     $i = 1;
3486     foreach ($courseids as $courseid) {
3487         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3488             $course = new stdClass();
3489             $course->id = $courseid;
3490             $course->category  = $category->id;
3491             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3492             if ($category->visible == 0) {
3493                 // hide the course when moving into hidden category,
3494                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3495                 $course->visible = 0;
3496             }
3498             $DB->update_record('course', $course);
3500             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3501             context_moved($context, $newparent);
3502         }
3503     }
3504     fix_course_sortorder();
3506     return true;
3509 /**
3510  * Hide course category and child course and subcategories
3511  * @param stdClass $category
3512  * @return void
3513  */
3514 function course_category_hide($category) {
3515     global $DB;
3517     $category->visible = 0;
3518     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3519     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3520     $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($category->id)); // store visible flag so that we can return to it if we immediately unhide
3521     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3522     // get all child categories and hide too
3523     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3524         foreach ($subcats as $cat) {
3525             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3526             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3527             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3528             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3529         }
3530     }
3533 /**
3534  * Show course category and child course and subcategories
3535  * @param stdClass $category
3536  * @return void
3537  */
3538 function course_category_show($category) {
3539     global $DB;
3541     $category->visible = 1;
3542     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3543     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3544     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3545     // get all child categories and unhide too
3546     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3547         foreach ($subcats as $cat) {
3548             if ($cat->visibleold) {
3549                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3550             }
3551             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3552         }
3553     }
3556 /**
3557  * Efficiently moves a category - NOTE that this can have
3558  * a huge impact access-control-wise...
3559  */
3560 function move_category($category, $newparentcat) {
3561     global $CFG, $DB;
3563     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3565     $hidecat = false;
3566     if (empty($newparentcat->id)) {
3567         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3569         $newparent = get_context_instance(CONTEXT_SYSTEM);
3571     } else {
3572         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3573         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3575         if (!$newparentcat->visible and $category->visible) {
3576             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3577             $hidecat = true;
3578         }
3579     }
3581     context_moved($context, $newparent);
3583     // now make it last in new category
3584     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3586     // and fix the sortorders
3587     fix_course_sortorder();
3589     if ($hidecat) {
3590         course_category_hide($category);
3591     }
3594 /**
3595  * Returns the display name of the given section that the course prefers.
3596  *
3597  * This function utilizes a callback that can be implemented within the course
3598  * formats lib.php file to customize the display name that is used to reference
3599  * the section.
3600  *
3601  * By default (if callback is not defined) the method
3602  * {@see get_numeric_section_name} is called instead.
3603  *
3604  * @param stdClass $course The course to get the section name for
3605  * @param stdClass $section Section object from database
3606  * @return Display name that the course format prefers, e.g. "Week 2"
3607  *
3608  * @see get_generic_section_name
3609  */
3610 function get_section_name(stdClass $course, stdClass $section) {
3611     global $CFG;
3613     /// Inelegant hack for bug 3408
3614     if ($course->format == 'site') {
3615         return get_string('site');
3616     }
3618     // Use course formatter callback if it exists
3619     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3620     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3621     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3622         require_once $namingfile;
3623     }
3624     if (function_exists($namingfunction)) {
3625         return $namingfunction($course, $section);
3626     }
3628     // else, default behavior:
3629     return get_generic_section_name($course->format, $section);
3632 /**
3633  * Gets the generic section name for a courses section.
3634  *
3635  * @param string $format Course format ID e.g. 'weeks' $course->format
3636  * @param stdClass $section Section object from database
3637  * @return Display name that the course format prefers, e.g. "Week 2"
3638  */
3639 function get_generic_section_name($format, stdClass $section) {
3640     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3644 function course_format_uses_sections($format) {
3645     global $CFG;
3647     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3648     $featurefunction = 'callback_'.$format.'_uses_sections';
3649     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3650         require_once $featurefile;
3651     }
3652     if (function_exists($featurefunction)) {
3653         return $featurefunction();
3654     }
3656     return false;
3659 /**
3660  * Returns the information about the ajax support in the given source format
3661  *
3662  * The returned object's property (boolean)capable indicates that
3663  * the course format supports Moodle course ajax features.
3664  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3665  *
3666  * @param string $format
3667  * @return stdClass
3668  */
3669 function course_format_ajax_support($format) {
3670     global $CFG;
3672     // set up default values
3673     $ajaxsupport = new stdClass();
3674     $ajaxsupport->capable = false;
3675     $ajaxsupport->testedbrowsers = array();
3677     // get the information from the course format library
3678     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3679     $featurefunction = 'callback_'.$format.'_ajax_support';
3680     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3681         require_once $featurefile;
3682     }
3683     if (function_exists($featurefunction)) {
3684         $formatsupport = $featurefunction();
3685         if (isset($formatsupport->capable)) {
3686             $ajaxsupport->capable = $formatsupport->capable;
3687         }
3688         if (is_array($formatsupport->testedbrowsers)) {
3689             $ajaxsupport->testedbrowsers = $formatsupport->testedbrowsers;
3690         }
3691     }
3693     return $ajaxsupport;
3696 /**
3697  * Can the current user delete this course?
3698  * Course creators have exception,
3699  * 1 day after the creation they can sill delete the course.
3700  * @param int $courseid
3701  * @return boolean
3702  */
3703 function can_delete_course($courseid) {
3704     global $USER, $DB;
3706     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3708     if (has_capability('moodle/course:delete', $context)) {
3709         return true;
3710     }
3712     // hack: now try to find out if creator created this course recently (1 day)
3713     if (!has_capability('moodle/course:create', $context)) {
3714         return false;
3715     }
3717     $since = time() - 60*60*24;
3719     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3720     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3722     return $DB->record_exists_select('log', $select, $params);
3725 /**
3726  * Save the Your name for 'Some role' strings.
3727  *
3728  * @param integer $courseid the id of this course.
3729  * @param array $data the data that came from the course settings form.
3730  */
3731 function save_local_role_names($courseid, $data) {
3732     global $DB;
3733     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3735     foreach ($data as $fieldname => $value) {
3736         if (strpos($fieldname, 'role_') !== 0) {
3737             continue;
3738         }
3739         list($ignored, $roleid) = explode('_', $fieldname);
3741         // make up our mind whether we want to delete, update or insert
3742         if (!$value) {
3743             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3745         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3746             $rolename->name = $value;
3747             $DB->update_record('role_names', $rolename);
3749         } else {
3750             $rolename = new stdClass;
3751             $rolename->contextid = $context->id;
3752             $rolename->roleid = $roleid;
3753             $rolename->name = $value;
3754             $DB->insert_record('role_names', $rolename);
3755         }
3756     }
3759 /**
3760  * Create a course and either return a $course object
3761  *
3762  * Please note this functions does not verify any access control,
3763  * the calling code is responsible for all validation (usually it is the form definition).
3764  *
3765  * @param array $editoroptions course description editor options
3766  * @param object $data  - all the data needed for an entry in the 'course' table
3767  * @return object new course instance
3768  */
3769 function create_course($data, $editoroptions = NULL) {
3770     global $CFG, $DB;
3772     //check the categoryid - must be given for all new courses
3773     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3775     //check if the shortname already exist
3776     if (!empty($data->shortname)) {
3777         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3778             throw new moodle_exception('shortnametaken');
3779         }
3780     }
3782     //check if the id number already exist
3783     if (!empty($data->idnumber)) {
3784         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3785             throw new moodle_exception('idnumbertaken');
3786         }
3787     }
3789     $data->timecreated  = time();
3790     $data->timemodified = $data->timecreated;
3792     // place at beginning of any category
3793     $data->sortorder = 0;
3795     if ($editoroptions) {
3796         // summary text is updated later, we need context to store the files first
3797         $data->summary = '';
3798         $data->summary_format = FORMAT_HTML;
3799     }
3801     if (!isset($data->visible)) {
3802         // data not from form, add missing visibility info
3803         $data->visible = $category->visible;
3804     }
3805     $data->visibleold = $data->visible;
3807     $newcourseid = $DB->insert_record('course', $data);
3808     $context = get_context_instance(CONTEXT_COURSE, $newcourseid, MUST_EXIST);
3810     if ($editoroptions) {
3811         // Save the files used in the summary editor and store
3812         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3813         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3814         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3815     }
3817     $course = $DB->get_record('course', array('id'=>$newcourseid));
3819     // Setup the blocks
3820     blocks_add_default_course_blocks($course);
3822     $section = new stdClass();
3823     $section->course        = $course->id;   // Create a default section.
3824     $section->section       = 0;
3825     $section->summaryformat = FORMAT_HTML;
3826     $DB->insert_record('course_sections', $section);
3828     fix_course_sortorder();
3830     // update module restrictions
3831     if ($course->restrictmodules) {
3832         if (isset($data->allowedmods)) {
3833             update_restricted_mods($course, $data->allowedmods);
3834         } else {
3835             if (!empty($CFG->defaultallowedmodules)) {
3836                 update_restricted_mods($course, explode(',', $CFG->defaultallowedmodules));
3837             }
3838         }
3839     }
3841     // new context created - better mark it as dirty
3842     mark_context_dirty($context->path);
3844     // Save any custom role names.
3845     save_local_role_names($course->id, (array)$data);
3847     // set up enrolments
3848     enrol_course_updated(true, $course, $data);
3850     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3852     // Trigger events
3853     events_trigger('course_created', $course);
3855     return $course;
3858 /**
3859  * Update a course.
3860  *
3861  * Please note this functions does not verify any access control,
3862  * the calling code is responsible for all validation (usually it is the form definition).
3863  *
3864  * @param object $data  - all the data needed for an entry in the 'course' table
3865  * @param array $editoroptions course description editor options
3866  * @return void
3867  */
3868 function update_course($data, $editoroptions = NULL) {
3869     global $CFG, $DB;
3871     $data->timemodified = time();
3873     $oldcourse = $DB->get_record('course', array('id'=>$data->id), '*', MUST_EXIST);
3874     $context   = get_context_instance(CONTEXT_COURSE, $oldcourse->id);
3876     if ($editoroptions) {
3877         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3878     }
3880     if (!isset($data->category) or empty($data->category)) {
3881         // prevent nulls and 0 in category field
3882         unset($data->category);
3883     }
3884     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3886     if (!isset($data->visible)) {
3887         // data not from form, add missing visibility info
3888         $data->visible = $oldcourse->visible;
3889     }
3891     if ($data->visible != $oldcourse->visible) {
3892         // reset the visibleold flag when manually hiding/unhiding course
3893         $data->visibleold = $data->visible;
3894     } else {
3895         if ($movecat) {
3896             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3897             if (empty($newcategory->visible)) {
3898                 // make sure when moving into hidden category the course is hidden automatically
3899                 $data->visible = 0;
3900             }
3901         }
3902     }
3904     // Update with the new data
3905     $DB->update_record('course', $data);
3907     $course = $DB->get_record('course', array('id'=>$data->id));
3909     if ($movecat) {
3910         $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3911         context_moved($context, $newparent);
3912     }
3914     fix_course_sortorder();
3916     // Test for and remove blocks which aren't appropriate anymore
3917     blocks_remove_inappropriate($course);
3919     // update module restrictions
3920     if (isset($data->allowedmods)) {
3921         update_restricted_mods($course, $data->allowedmods);
3922     }
3924     // Save any custom role names.
3925     save_local_role_names($course->id, $data);
3927     // update enrol settings
3928     enrol_course_updated(false, $course, $data);
3930     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3932     // Trigger events
3933     events_trigger('course_updated', $course);
3936 /**
3937  * Average number of participants
3938  * @return integer
3939  */
3940 function average_number_of_participants() {
3941     global $DB, $SITE;
3943     //count total of enrolments for visible course (except front page)
3944     $sql = 'SELECT COUNT(*) FROM (
3945         SELECT DISTINCT ue.userid, e.courseid
3946         FROM {user_enrolments} ue, {enrol} e, {course} c
3947         WHERE ue.enrolid = e.id
3948             AND e.courseid <> :siteid
3949             AND c.id = e.courseid
3950             AND c.visible = 1) as total';
3951     $params = array('siteid' => $SITE->id);
3952     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3955     //count total of visible courses (minus front page)
3956     $coursetotal = $DB->count_records('course', array('visible' => 1));
3957     $coursetotal = $coursetotal - 1 ;
3959     //average of enrolment
3960     if (empty($coursetotal)) {
3961         $participantaverage = 0;
3962     } else {
3963         $participantaverage = $enrolmenttotal / $coursetotal;
3964     }
3966     return $participantaverage;
3969 /**
3970  * Average number of course modules
3971  * @return integer
3972  */
3973 function average_number_of_courses_modules() {
3974     global $DB, $SITE;
3976     //count total of visible course module (except front page)
3977     $sql = 'SELECT COUNT(*) FROM (
3978         SELECT cm.course, cm.module
3979         FROM {course} c, {course_modules} cm
3980         WHERE c.id = cm.course
3981             AND c.id <> :siteid
3982             AND cm.visible = 1
3983             AND c.visible = 1) as total';
3984     $params = array('siteid' => $SITE->id);
3985     $moduletotal = $DB->count_records_sql($sql, $params);
3988     //count total of visible courses (minus front page)
3989     $coursetotal = $DB->count_records('course', array('visible' => 1));
3990     $coursetotal = $coursetotal - 1 ;
3992     //average of course module
3993     if (empty($coursetotal)) {
3994         $coursemoduleaverage = 0;
3995     } else {
3996         $coursemoduleaverage = $moduletotal / $coursetotal;
3997     }
3999     return $coursemoduleaverage;
4002 /**
4003  * This class pertains to course requests and contains methods associated with
4004  * create, approving, and removing course requests.
4005  *
4006  * Please note we do not allow embedded images here because there is no context
4007  * to store them with proper access control.
4008  *
4009  * @copyright 2009 Sam Hemelryk
4010  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4011  * @since Moodle 2.0
4012  *
4013  * @property-read int $id
4014  * @property-read string $fullname
4015  * @property-read string $shortname
4016  * @property-read string $summary
4017  * @property-read int $summaryformat
4018  * @property-read int $summarytrust
4019  * @property-read string $reason
4020  * @property-read int $requester
4021  */
4022 class course_request {
4024     /**
4025      * This is the stdClass that stores the properties for the course request
4026      * and is externally accessed through the __get magic method
4027      * @var stdClass
4028      */
4029     protected $properties;
4031     /**
4032      * An array of options for the summary editor used by course request forms.
4033      * This is initially set by {@link summary_editor_options()}
4034      * @var array
4035      * @static
4036      */
4037     protected static $summaryeditoroptions;
4039     /**
4040      * Static function to prepare the summary editor for working with a course
4041      * request.
4042      *
4043      * @static
4044      * @param null|stdClass $data Optional, an object containing the default values
4045      *                       for the form, these may be modified when preparing the
4046      *                       editor so this should be called before creating the form
4047      * @return stdClass An object that can be used to set the default values for
4048      *                   an mforms form
4049      */
4050     public static function prepare($data=null) {
4051         if ($data === null) {
4052             $data = new stdClass;
4053         }
4054         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
4055         return $data;
4056     }
4058     /**
4059      * Static function to create a new course request when passed an array of properties
4060      * for it.
4061      *
4062      * This function also handles saving any files that may have been used in the editor
4063      *
4064      * @static
4065      * @param stdClass $data
4066      * @return course_request The newly created course request
4067      */
4068     public static function create($data) {
4069         global $USER, $DB, $CFG;
4070         $data->requester = $USER->id;
4072         // Summary is a required field so copy the text over
4073         $data->summary       = $data->summary_editor['text'];
4074         $data->summaryformat = $data->summary_editor['format'];
4076         $data->id = $DB->insert_record('course_request', $data);
4078         // Create a new course_request object and return it
4079         $request = new course_request($data);
4081         // Notify the admin if required.
4082         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
4084             $a = new stdClass;
4085             $a->link = "$CFG->wwwroot/course/pending.php";
4086             $a->user = fullname($USER);
4087             $subject = get_string('courserequest');
4088             $message = get_string('courserequestnotifyemail', 'admin', $a);
4089             foreach ($users as $user) {
4090                 $request->notify($user, $USER, 'courserequested', $subject, $message);
4091             }
4092         }
4094         return $request;
4095     }
4097     /**
4098      * Returns an array of options to use with a summary editor
4099      *
4100      * @uses course_request::$summaryeditoroptions
4101      * @return array An array of options to use with the editor
4102      */
4103     public static function summary_editor_options() {
4104         global $CFG;
4105         if (self::$summaryeditoroptions === null) {
4106             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
4107         }
4108         return self::$summaryeditoroptions;
4109     }
4111     /**
4112      * Loads the properties for this course request object. Id is required and if
4113      * only id is provided then we load the rest of the properties from the database
4114      *
4115      * @param stdClass|int $properties Either an object containing properties
4116      *                      or the course_request id to load
4117      */
4118     public function __construct($properties) {
4119         global $DB;
4120         if (empty($properties->id)) {
4121             if (empty($properties)) {
4122                 throw new coding_exception('You must provide a course request id when creating a course_request object');
4123             }
4124             $id = $properties;
4125             $properties = new stdClass;
4126             $properties->id = (int)$id;
4127             unset($id);
4128         }
4129         if (empty($properties->requester)) {
4130             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
4131                 print_error('unknowncourserequest');
4132             }
4133         } else {
4134             $this->properties = $properties;
4135         }
4136         $this->properties->collision = null;
4137     }
4139     /**
4140      * Returns the requested property
4141      *
4142      * @param string $key
4143      * @return mixed
4144      */
4145     public function __get($key) {
4146         return $this->properties->$key;
4147     }
4149     /**
4150      * Override this to ensure empty($request->blah) calls return a reliable answer...
4151      *
4152      * This is required because we define the __get method
4153      *
4154      * @param mixed $key
4155      * @return bool True is it not empty, false otherwise
4156      */
4157     public function __isset($key) {
4158         return (!empty($this->properties->$key));
4159     }
4161     /**
4162      * Returns the user who requested this course
4163      *
4164      * Uses a static var to cache the results and cut down the number of db queries
4165      *
4166      * @staticvar array $requesters An array of cached users
4167      * @return stdClass The user who requested the course
4168      */
4169     public function get_requester() {
4170         global $DB;
4171         static $requesters= array();
4172         if (!array_key_exists($this->properties->requester, $requesters)) {
4173             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
4174         }
4175         return $requesters[$this->properties->requester];
4176     }
4178     /**
4179      * Checks that the shortname used by the course does not conflict with any other
4180      * courses that exist
4181      *
4182      * @param string|null $shor