8f7d6351f3a840a79d29a5fe8e6719517504a82f
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
32 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
33 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
34 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
35 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
36 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
37 define('FRONTPAGENEWS',           '0');
38 define('FRONTPAGECOURSELIST',     '1');
39 define('FRONTPAGECATEGORYNAMES',  '2');
40 define('FRONTPAGETOPICONLY',      '3');
41 define('FRONTPAGECATEGORYCOMBO',  '4');
42 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
43 define('EXCELROWS', 65535);
44 define('FIRSTUSEDEXCELROW', 3);
46 define('MOD_CLASS_ACTIVITY', 0);
47 define('MOD_CLASS_RESOURCE', 1);
49 define('COURSE_DISPLAY_SINGLEPAGE', 0); // display all sections on one page
50 define('COURSE_DISPLAY_MULTIPAGE', 1); // split pages into a page per section
52 function make_log_url($module, $url) {
53     switch ($module) {
54         case 'course':
55             if (strpos($url, 'report/') === 0) {
56                 // there is only one report type, course reports are deprecated
57                 $url = "/$url";
58                 break;
59             }
60         case 'file':
61         case 'login':
62         case 'lib':
63         case 'admin':
64         case 'calendar':
65         case 'mnet course':
66             if (strpos($url, '../') === 0) {
67                 $url = ltrim($url, '.');
68             } else {
69                 $url = "/course/$url";
70             }
71             break;
72         case 'user':
73         case 'blog':
74             $url = "/$module/$url";
75             break;
76         case 'upload':
77             $url = $url;
78             break;
79         case 'coursetags':
80             $url = '/'.$url;
81             break;
82         case 'library':
83         case '':
84             $url = '/';
85             break;
86         case 'message':
87             $url = "/message/$url";
88             break;
89         case 'notes':
90             $url = "/notes/$url";
91             break;
92         case 'tag':
93             $url = "/tag/$url";
94             break;
95         case 'role':
96             $url = '/'.$url;
97             break;
98         default:
99             $url = "/mod/$module/$url";
100             break;
101     }
103     //now let's sanitise urls - there might be some ugly nasties:-(
104     $parts = explode('?', $url);
105     $script = array_shift($parts);
106     if (strpos($script, 'http') === 0) {
107         $script = clean_param($script, PARAM_URL);
108     } else {
109         $script = clean_param($script, PARAM_PATH);
110     }
112     $query = '';
113     if ($parts) {
114         $query = implode('', $parts);
115         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
116         $parts = explode('&', $query);
117         $eq = urlencode('=');
118         foreach ($parts as $key=>$part) {
119             $part = urlencode(urldecode($part));
120             $part = str_replace($eq, '=', $part);
121             $parts[$key] = $part;
122         }
123         $query = '?'.implode('&amp;', $parts);
124     }
126     return $script.$query;
130 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
131                    $modname="", $modid=0, $modaction="", $groupid=0) {
132     global $CFG, $DB;
134     // It is assumed that $date is the GMT time of midnight for that day,
135     // and so the next 86400 seconds worth of logs are printed.
137     /// Setup for group handling.
139     // TODO: I don't understand group/context/etc. enough to be able to do
140     // something interesting with it here
141     // What is the context of a remote course?
143     /// If the group mode is separate, and this user does not have editing privileges,
144     /// then only the user's group can be viewed.
145     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
146     //    $groupid = get_current_group($course->id);
147     //}
148     /// If this course doesn't have groups, no groupid can be specified.
149     //else if (!$course->groupmode) {
150     //    $groupid = 0;
151     //}
153     $groupid = 0;
155     $joins = array();
156     $where = '';
158     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
159               FROM {mnet_log} l
160                LEFT JOIN {user} u ON l.userid = u.id
161               WHERE ";
162     $params = array();
164     $where .= "l.hostid = :hostid";
165     $params['hostid'] = $hostid;
167     // TODO: Is 1 really a magic number referring to the sitename?
168     if ($course != SITEID || $modid != 0) {
169         $where .= " AND l.course=:courseid";
170         $params['courseid'] = $course;
171     }
173     if ($modname) {
174         $where .= " AND l.module = :modname";
175         $params['modname'] = $modname;
176     }
178     if ('site_errors' === $modid) {
179         $where .= " AND ( l.action='error' OR l.action='infected' )";
180     } else if ($modid) {
181         //TODO: This assumes that modids are the same across sites... probably
182         //not true
183         $where .= " AND l.cmid = :modid";
184         $params['modid'] = $modid;
185     }
187     if ($modaction) {
188         $firstletter = substr($modaction, 0, 1);
189         if ($firstletter == '-') {
190             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
191             $params['modaction'] = '%'.substr($modaction, 1).'%';
192         } else {
193             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
194             $params['modaction'] = '%'.$modaction.'%';
195         }
196     }
198     if ($user) {
199         $where .= " AND l.userid = :user";
200         $params['user'] = $user;
201     }
203     if ($date) {
204         $enddate = $date + 86400;
205         $where .= " AND l.time > :date AND l.time < :enddate";
206         $params['date'] = $date;
207         $params['enddate'] = $enddate;
208     }
210     $result = array();
211     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
212     if(!empty($result['totalcount'])) {
213         $where .= " ORDER BY $order";
214         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
215     } else {
216         $result['logs'] = array();
217     }
218     return $result;
221 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
222                    $modname="", $modid=0, $modaction="", $groupid=0) {
223     global $DB, $SESSION, $USER;
224     // It is assumed that $date is the GMT time of midnight for that day,
225     // and so the next 86400 seconds worth of logs are printed.
227     /// Setup for group handling.
229     /// If the group mode is separate, and this user does not have editing privileges,
230     /// then only the user's group can be viewed.
231     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
232         if (isset($SESSION->currentgroup[$course->id])) {
233             $groupid =  $SESSION->currentgroup[$course->id];
234         } else {
235             $groupid = groups_get_all_groups($course->id, $USER->id);
236             if (is_array($groupid)) {
237                 $groupid = array_shift(array_keys($groupid));
238                 $SESSION->currentgroup[$course->id] = $groupid;
239             } else {
240                 $groupid = 0;
241             }
242         }
243     }
244     /// If this course doesn't have groups, no groupid can be specified.
245     else if (!$course->groupmode) {
246         $groupid = 0;
247     }
249     $joins = array();
250     $params = array();
252     if ($course->id != SITEID || $modid != 0) {
253         $joins[] = "l.course = :courseid";
254         $params['courseid'] = $course->id;
255     }
257     if ($modname) {
258         $joins[] = "l.module = :modname";
259         $params['modname'] = $modname;
260     }
262     if ('site_errors' === $modid) {
263         $joins[] = "( l.action='error' OR l.action='infected' )";
264     } else if ($modid) {
265         $joins[] = "l.cmid = :modid";
266         $params['modid'] = $modid;
267     }
269     if ($modaction) {
270         $firstletter = substr($modaction, 0, 1);
271         if ($firstletter == '-') {
272             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
273             $params['modaction'] = '%'.substr($modaction, 1).'%';
274         } else {
275             $joins[] = $DB->sql_like('l.action', ':modaction', false);
276             $params['modaction'] = '%'.$modaction.'%';
277         }
278     }
281     /// Getting all members of a group.
282     if ($groupid and !$user) {
283         if ($gusers = groups_get_members($groupid)) {
284             $gusers = array_keys($gusers);
285             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
286         } else {
287             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
288         }
289     }
290     else if ($user) {
291         $joins[] = "l.userid = :userid";
292         $params['userid'] = $user;
293     }
295     if ($date) {
296         $enddate = $date + 86400;
297         $joins[] = "l.time > :date AND l.time < :enddate";
298         $params['date'] = $date;
299         $params['enddate'] = $enddate;
300     }
302     $selector = implode(' AND ', $joins);
304     $totalcount = 0;  // Initialise
305     $result = array();
306     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
307     $result['totalcount'] = $totalcount;
308     return $result;
312 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
313                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
315     global $CFG, $DB, $OUTPUT;
317     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
318                        $modname, $modid, $modaction, $groupid)) {
319         echo $OUTPUT->notification("No logs found!");
320         echo $OUTPUT->footer();
321         exit;
322     }
324     $courses = array();
326     if ($course->id == SITEID) {
327         $courses[0] = '';
328         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
329             foreach ($ccc as $cc) {
330                 $courses[$cc->id] = $cc->shortname;
331             }
332         }
333     } else {
334         $courses[$course->id] = $course->shortname;
335     }
337     $totalcount = $logs['totalcount'];
338     $count=0;
339     $ldcache = array();
340     $tt = getdate(time());
341     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
343     $strftimedatetime = get_string("strftimedatetime");
345     echo "<div class=\"info\">\n";
346     print_string("displayingrecords", "", $totalcount);
347     echo "</div>\n";
349     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
351     $table = new html_table();
352     $table->classes = array('logtable','generalbox');
353     $table->align = array('right', 'left', 'left');
354     $table->head = array(
355         get_string('time'),
356         get_string('ip_address'),
357         get_string('fullnameuser'),
358         get_string('action'),
359         get_string('info')
360     );
361     $table->data = array();
363     if ($course->id == SITEID) {
364         array_unshift($table->align, 'left');
365         array_unshift($table->head, get_string('course'));
366     }
368     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
369     if (empty($logs['logs'])) {
370         $logs['logs'] = array();
371     }
373     foreach ($logs['logs'] as $log) {
375         if (isset($ldcache[$log->module][$log->action])) {
376             $ld = $ldcache[$log->module][$log->action];
377         } else {
378             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
379             $ldcache[$log->module][$log->action] = $ld;
380         }
381         if ($ld && is_numeric($log->info)) {
382             // ugly hack to make sure fullname is shown correctly
383             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
384                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
385             } else {
386                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
387             }
388         }
390         //Filter log->info
391         $log->info = format_string($log->info);
393         // If $log->url has been trimmed short by the db size restriction
394         // code in add_to_log, keep a note so we don't add a link to a broken url
395         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
397         $row = array();
398         if ($course->id == SITEID) {
399             if (empty($log->course)) {
400                 $row[] = get_string('site');
401             } else {
402                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
403             }
404         }
406         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
408         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
409         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
411         $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))));
413         $displayaction="$log->module $log->action";
414         if ($brokenurl) {
415             $row[] = $displayaction;
416         } else {
417             $link = make_log_url($log->module,$log->url);
418             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
419         }
420         $row[] = $log->info;
421         $table->data[] = $row;
422     }
424     echo html_writer::table($table);
425     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
429 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
430                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
432     global $CFG, $DB, $OUTPUT;
434     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
435                        $modname, $modid, $modaction, $groupid)) {
436         echo $OUTPUT->notification("No logs found!");
437         echo $OUTPUT->footer();
438         exit;
439     }
441     if ($course->id == SITEID) {
442         $courses[0] = '';
443         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
444             foreach ($ccc as $cc) {
445                 $courses[$cc->id] = $cc->shortname;
446             }
447         }
448     }
450     $totalcount = $logs['totalcount'];
451     $count=0;
452     $ldcache = array();
453     $tt = getdate(time());
454     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
456     $strftimedatetime = get_string("strftimedatetime");
458     echo "<div class=\"info\">\n";
459     print_string("displayingrecords", "", $totalcount);
460     echo "</div>\n";
462     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
464     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
465     echo "<tr>";
466     if ($course->id == SITEID) {
467         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
468     }
469     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
470     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
471     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
472     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
473     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
474     echo "</tr>\n";
476     if (empty($logs['logs'])) {
477         echo "</table>\n";
478         return;
479     }
481     $row = 1;
482     foreach ($logs['logs'] as $log) {
484         $log->info = $log->coursename;
485         $row = ($row + 1) % 2;
487         if (isset($ldcache[$log->module][$log->action])) {
488             $ld = $ldcache[$log->module][$log->action];
489         } else {
490             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
491             $ldcache[$log->module][$log->action] = $ld;
492         }
493         if (0 && $ld && !empty($log->info)) {
494             // ugly hack to make sure fullname is shown correctly
495             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
496                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
497             } else {
498                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
499             }
500         }
502         //Filter log->info
503         $log->info = format_string($log->info);
505         echo '<tr class="r'.$row.'">';
506         if ($course->id == SITEID) {
507             $courseshortname = format_string($courses[$log->course], true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
508             echo "<td class=\"r$row c0\" >\n";
509             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
510             echo "</td>\n";
511         }
512         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
513              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
514         echo "<td class=\"r$row c2\" >\n";
515         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
516         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
517         echo "</td>\n";
518         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
519         echo "<td class=\"r$row c3\" >\n";
520         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
521         echo "</td>\n";
522         echo "<td class=\"r$row c4\">\n";
523         echo $log->action .': '.$log->module;
524         echo "</td>\n";;
525         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
526         echo "</tr>\n";
527     }
528     echo "</table>\n";
530     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
534 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
535                         $modid, $modaction, $groupid) {
536     global $DB;
538     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
539             get_string('fullnameuser')."\t".get_string('action')."\t".get_string('info');
541     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
542                        $modname, $modid, $modaction, $groupid)) {
543         return false;
544     }
546     $courses = array();
548     if ($course->id == SITEID) {
549         $courses[0] = '';
550         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
551             foreach ($ccc as $cc) {
552                 $courses[$cc->id] = $cc->shortname;
553             }
554         }
555     } else {
556         $courses[$course->id] = $course->shortname;
557     }
559     $count=0;
560     $ldcache = array();
561     $tt = getdate(time());
562     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
564     $strftimedatetime = get_string("strftimedatetime");
566     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
567     $filename .= '.txt';
568     header("Content-Type: application/download\n");
569     header("Content-Disposition: attachment; filename=$filename");
570     header("Expires: 0");
571     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
572     header("Pragma: public");
574     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
575     echo $text."\n";
577     if (empty($logs['logs'])) {
578         return true;
579     }
581     foreach ($logs['logs'] as $log) {
582         if (isset($ldcache[$log->module][$log->action])) {
583             $ld = $ldcache[$log->module][$log->action];
584         } else {
585             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
586             $ldcache[$log->module][$log->action] = $ld;
587         }
588         if ($ld && !empty($log->info)) {
589             // ugly hack to make sure fullname is shown correctly
590             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
591                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
592             } else {
593                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
594             }
595         }
597         //Filter log->info
598         $log->info = format_string($log->info);
599         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
601         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
602         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
603         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
604         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
605         $text = implode("\t", $row);
606         echo $text." \n";
607     }
608     return true;
612 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
613                         $modid, $modaction, $groupid) {
615     global $CFG, $DB;
617     require_once("$CFG->libdir/excellib.class.php");
619     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
620                        $modname, $modid, $modaction, $groupid)) {
621         return false;
622     }
624     $courses = array();
626     if ($course->id == SITEID) {
627         $courses[0] = '';
628         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
629             foreach ($ccc as $cc) {
630                 $courses[$cc->id] = $cc->shortname;
631             }
632         }
633     } else {
634         $courses[$course->id] = $course->shortname;
635     }
637     $count=0;
638     $ldcache = array();
639     $tt = getdate(time());
640     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
642     $strftimedatetime = get_string("strftimedatetime");
644     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
645     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
646     $filename .= '.xls';
648     $workbook = new MoodleExcelWorkbook('-');
649     $workbook->send($filename);
651     $worksheet = array();
652     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
653                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
655     // Creating worksheets
656     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
657         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
658         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
659         $worksheet[$wsnumber]->set_column(1, 1, 30);
660         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
661                                     userdate(time(), $strftimedatetime));
662         $col = 0;
663         foreach ($headers as $item) {
664             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
665             $col++;
666         }
667     }
669     if (empty($logs['logs'])) {
670         $workbook->close();
671         return true;
672     }
674     $formatDate =& $workbook->add_format();
675     $formatDate->set_num_format(get_string('log_excel_date_format'));
677     $row = FIRSTUSEDEXCELROW;
678     $wsnumber = 1;
679     $myxls =& $worksheet[$wsnumber];
680     foreach ($logs['logs'] as $log) {
681         if (isset($ldcache[$log->module][$log->action])) {
682             $ld = $ldcache[$log->module][$log->action];
683         } else {
684             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
685             $ldcache[$log->module][$log->action] = $ld;
686         }
687         if ($ld && !empty($log->info)) {
688             // ugly hack to make sure fullname is shown correctly
689             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
690                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
691             } else {
692                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
693             }
694         }
696         // Filter log->info
697         $log->info = format_string($log->info);
698         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
700         if ($nroPages>1) {
701             if ($row > EXCELROWS) {
702                 $wsnumber++;
703                 $myxls =& $worksheet[$wsnumber];
704                 $row = FIRSTUSEDEXCELROW;
705             }
706         }
708         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
710         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
711         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
712         $myxls->write($row, 2, $log->ip, '');
713         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
714         $myxls->write($row, 3, $fullname, '');
715         $myxls->write($row, 4, $log->module.' '.$log->action, '');
716         $myxls->write($row, 5, $log->info, '');
718         $row++;
719     }
721     $workbook->close();
722     return true;
725 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
726                         $modid, $modaction, $groupid) {
728     global $CFG, $DB;
730     require_once("$CFG->libdir/odslib.class.php");
732     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
733                        $modname, $modid, $modaction, $groupid)) {
734         return false;
735     }
737     $courses = array();
739     if ($course->id == SITEID) {
740         $courses[0] = '';
741         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
742             foreach ($ccc as $cc) {
743                 $courses[$cc->id] = $cc->shortname;
744             }
745         }
746     } else {
747         $courses[$course->id] = $course->shortname;
748     }
750     $count=0;
751     $ldcache = array();
752     $tt = getdate(time());
753     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
755     $strftimedatetime = get_string("strftimedatetime");
757     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
758     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
759     $filename .= '.ods';
761     $workbook = new MoodleODSWorkbook('-');
762     $workbook->send($filename);
764     $worksheet = array();
765     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
766                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
768     // Creating worksheets
769     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
770         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
771         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
772         $worksheet[$wsnumber]->set_column(1, 1, 30);
773         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
774                                     userdate(time(), $strftimedatetime));
775         $col = 0;
776         foreach ($headers as $item) {
777             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
778             $col++;
779         }
780     }
782     if (empty($logs['logs'])) {
783         $workbook->close();
784         return true;
785     }
787     $formatDate =& $workbook->add_format();
788     $formatDate->set_num_format(get_string('log_excel_date_format'));
790     $row = FIRSTUSEDEXCELROW;
791     $wsnumber = 1;
792     $myxls =& $worksheet[$wsnumber];
793     foreach ($logs['logs'] as $log) {
794         if (isset($ldcache[$log->module][$log->action])) {
795             $ld = $ldcache[$log->module][$log->action];
796         } else {
797             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
798             $ldcache[$log->module][$log->action] = $ld;
799         }
800         if ($ld && !empty($log->info)) {
801             // ugly hack to make sure fullname is shown correctly
802             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
803                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
804             } else {
805                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
806             }
807         }
809         // Filter log->info
810         $log->info = format_string($log->info);
811         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
813         if ($nroPages>1) {
814             if ($row > EXCELROWS) {
815                 $wsnumber++;
816                 $myxls =& $worksheet[$wsnumber];
817                 $row = FIRSTUSEDEXCELROW;
818             }
819         }
821         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
823         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
824         $myxls->write_date($row, 1, $log->time);
825         $myxls->write_string($row, 2, $log->ip);
826         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
827         $myxls->write_string($row, 3, $fullname);
828         $myxls->write_string($row, 4, $log->module.' '.$log->action);
829         $myxls->write_string($row, 5, $log->info);
831         $row++;
832     }
834     $workbook->close();
835     return true;
839 function print_overview($courses, array $remote_courses=array()) {
840     global $CFG, $USER, $DB, $OUTPUT;
842     $htmlarray = array();
843     if ($modules = $DB->get_records('modules')) {
844         foreach ($modules as $mod) {
845             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
846                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
847                 $fname = $mod->name.'_print_overview';
848                 if (function_exists($fname)) {
849                     $fname($courses,$htmlarray);
850                 }
851             }
852         }
853     }
854     foreach ($courses as $course) {
855         $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
856         echo $OUTPUT->box_start('coursebox');
857         $attributes = array('title' => s($fullname));
858         if (empty($course->visible)) {
859             $attributes['class'] = 'dimmed';
860         }
861         echo $OUTPUT->heading(html_writer::link(
862             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
863         if (array_key_exists($course->id,$htmlarray)) {
864             foreach ($htmlarray[$course->id] as $modname => $html) {
865                 echo $html;
866             }
867         }
868         echo $OUTPUT->box_end();
869     }
871     if (!empty($remote_courses)) {
872         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
873     }
874     foreach ($remote_courses as $course) {
875         echo $OUTPUT->box_start('coursebox');
876         $attributes = array('title' => s($course->fullname));
877         echo $OUTPUT->heading(html_writer::link(
878             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
879             format_string($course->shortname),
880             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
881         echo $OUTPUT->box_end();
882     }
886 /**
887  * This function trawls through the logs looking for
888  * anything new since the user's last login
889  */
890 function print_recent_activity($course) {
891     // $course is an object
892     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
894     $context = get_context_instance(CONTEXT_COURSE, $course->id);
896     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
898     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
900     if (!isguestuser()) {
901         if (!empty($USER->lastcourseaccess[$course->id])) {
902             if ($USER->lastcourseaccess[$course->id] > $timestart) {
903                 $timestart = $USER->lastcourseaccess[$course->id];
904             }
905         }
906     }
908     echo '<div class="activitydate">';
909     echo get_string('activitysince', '', userdate($timestart));
910     echo '</div>';
911     echo '<div class="activityhead">';
913     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
915     echo "</div>\n";
917     $content = false;
919 /// Firstly, have there been any new enrolments?
921     $users = get_recent_enrolments($course->id, $timestart);
923     //Accessibility: new users now appear in an <OL> list.
924     if ($users) {
925         echo '<div class="newusers">';
926         echo $OUTPUT->heading(get_string("newusers").':', 3);
927         $content = true;
928         echo "<ol class=\"list\">\n";
929         foreach ($users as $user) {
930             $fullname = fullname($user, $viewfullnames);
931             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
932         }
933         echo "</ol>\n</div>\n";
934     }
936 /// Next, have there been any modifications to the course structure?
938     $modinfo = get_fast_modinfo($course);
940     $changelist = array();
942     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
943                                             module = 'course' AND
944                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
945                                     array($timestart, $course->id), "id ASC");
947     if ($logs) {
948         $actions  = array('add mod', 'update mod', 'delete mod');
949         $newgones = array(); // added and later deleted items
950         foreach ($logs as $key => $log) {
951             if (!in_array($log->action, $actions)) {
952                 continue;
953             }
954             $info = explode(' ', $log->info);
956             // note: in most cases I replaced hardcoding of label with use of
957             // $cm->has_view() but it was not possible to do this here because
958             // we don't necessarily have the $cm for it
959             if ($info[0] == 'label') {     // Labels are ignored in recent activity
960                 continue;
961             }
963             if (count($info) != 2) {
964                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
965                 continue;
966             }
968             $modname    = $info[0];
969             $instanceid = $info[1];
971             if ($log->action == 'delete mod') {
972                 // unfortunately we do not know if the mod was visible
973                 if (!array_key_exists($log->info, $newgones)) {
974                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
975                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
976                 }
977             } else {
978                 if (!isset($modinfo->instances[$modname][$instanceid])) {
979                     if ($log->action == 'add mod') {
980                         // do not display added and later deleted activities
981                         $newgones[$log->info] = true;
982                     }
983                     continue;
984                 }
985                 $cm = $modinfo->instances[$modname][$instanceid];
986                 if (!$cm->uservisible) {
987                     continue;
988                 }
990                 if ($log->action == 'add mod') {
991                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
992                     $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>");
994                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
995                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
996                     $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>");
997                 }
998             }
999         }
1000     }
1002     if (!empty($changelist)) {
1003         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1004         $content = true;
1005         foreach ($changelist as $changeinfo => $change) {
1006             echo '<p class="activity">'.$change['text'].'</p>';
1007         }
1008     }
1010 /// Now display new things from each module
1012     $usedmodules = array();
1013     foreach($modinfo->cms as $cm) {
1014         if (isset($usedmodules[$cm->modname])) {
1015             continue;
1016         }
1017         if (!$cm->uservisible) {
1018             continue;
1019         }
1020         $usedmodules[$cm->modname] = $cm->modname;
1021     }
1023     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1024         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1025             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1026             $print_recent_activity = $modname.'_print_recent_activity';
1027             if (function_exists($print_recent_activity)) {
1028                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1029                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1030             }
1031         } else {
1032             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1033         }
1034     }
1036     if (! $content) {
1037         echo '<p class="message">'.get_string('nothingnew').'</p>';
1038     }
1041 /**
1042  * For a given course, returns an array of course activity objects
1043  * Each item in the array contains he following properties:
1044  */
1045 function get_array_of_activities($courseid) {
1046 //  cm - course module id
1047 //  mod - name of the module (eg forum)
1048 //  section - the number of the section (eg week or topic)
1049 //  name - the name of the instance
1050 //  visible - is the instance visible or not
1051 //  groupingid - grouping id
1052 //  groupmembersonly - is this instance visible to group members only
1053 //  extra - contains extra string to include in any link
1054     global $CFG, $DB;
1055     if(!empty($CFG->enableavailability)) {
1056         require_once($CFG->libdir.'/conditionlib.php');
1057     }
1059     $course = $DB->get_record('course', array('id'=>$courseid));
1061     if (empty($course)) {
1062         throw new moodle_exception('courseidnotfound');
1063     }
1065     $mod = array();
1067     $rawmods = get_course_mods($courseid);
1068     if (empty($rawmods)) {
1069         return $mod; // always return array
1070     }
1072     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1073        foreach ($sections as $section) {
1074            if (!empty($section->sequence)) {
1075                $sequence = explode(",", $section->sequence);
1076                foreach ($sequence as $seq) {
1077                    if (empty($rawmods[$seq])) {
1078                        continue;
1079                    }
1080                    $mod[$seq] = new stdClass();
1081                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1082                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1083                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1085                     // Oh dear. Inconsistent names left here for backward compatibility.
1086                    $mod[$seq]->section          = $section->section;
1087                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1089                    $mod[$seq]->module           = $rawmods[$seq]->module;
1090                    $mod[$seq]->added            = $rawmods[$seq]->added;
1091                    $mod[$seq]->score            = $rawmods[$seq]->score;
1092                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1093                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1094                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1095                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1096                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1097                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1098                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1099                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1100                    $mod[$seq]->extra            = "";
1101                    $mod[$seq]->completiongradeitemnumber =
1102                            $rawmods[$seq]->completiongradeitemnumber;
1103                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1104                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1105                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1106                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1107                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1108                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1109                    if (!empty($CFG->enableavailability)) {
1110                        condition_info::fill_availability_conditions($rawmods[$seq]);
1111                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1112                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1113                    }
1115                    $modname = $mod[$seq]->mod;
1116                    $functionname = $modname."_get_coursemodule_info";
1118                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1119                        continue;
1120                    }
1122                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1124                    if ($hasfunction = function_exists($functionname)) {
1125                        if ($info = $functionname($rawmods[$seq])) {
1126                            if (!empty($info->icon)) {
1127                                $mod[$seq]->icon = $info->icon;
1128                            }
1129                            if (!empty($info->iconcomponent)) {
1130                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1131                            }
1132                            if (!empty($info->name)) {
1133                                $mod[$seq]->name = $info->name;
1134                            }
1135                            if ($info instanceof cached_cm_info) {
1136                                // When using cached_cm_info you can include three new fields
1137                                // that aren't available for legacy code
1138                                if (!empty($info->content)) {
1139                                    $mod[$seq]->content = $info->content;
1140                                }
1141                                if (!empty($info->extraclasses)) {
1142                                    $mod[$seq]->extraclasses = $info->extraclasses;
1143                                }
1144                                if (!empty($info->iconurl)) {
1145                                    $mod[$seq]->iconurl = $info->iconurl;
1146                                }
1147                                if (!empty($info->onclick)) {
1148                                    $mod[$seq]->onclick = $info->onclick;
1149                                }
1150                                if (!empty($info->customdata)) {
1151                                    $mod[$seq]->customdata = $info->customdata;
1152                                }
1153                            } else {
1154                                // When using a stdclass, the (horrible) deprecated ->extra field
1155                                // is available for BC
1156                                if (!empty($info->extra)) {
1157                                    $mod[$seq]->extra = $info->extra;
1158                                }
1159                            }
1160                        }
1161                    }
1162                    // When there is no modname_get_coursemodule_info function,
1163                    // but showdescriptions is enabled, then we use the 'intro'
1164                    // and 'introformat' fields in the module table
1165                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1166                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1167                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1168                            // Set content from intro and introformat. Filters are disabled
1169                            // because we  filter it with format_text at display time
1170                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1171                                    $modvalues, $rawmods[$seq]->id, false);
1173                            // To save making another query just below, put name in here
1174                            $mod[$seq]->name = $modvalues->name;
1175                        }
1176                    }
1177                    if (!isset($mod[$seq]->name)) {
1178                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1179                    }
1181                    // Minimise the database size by unsetting default options when they are
1182                    // 'empty'. This list corresponds to code in the cm_info constructor.
1183                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1184                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1185                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1186                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1187                            'completionview', 'completionexpected', 'score', 'showdescription')
1188                            as $property) {
1189                        if (property_exists($mod[$seq], $property) &&
1190                                empty($mod[$seq]->{$property})) {
1191                            unset($mod[$seq]->{$property});
1192                        }
1193                    }
1194                    // Special case: this value is usually set to null, but may be 0
1195                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1196                            is_null($mod[$seq]->completiongradeitemnumber)) {
1197                        unset($mod[$seq]->completiongradeitemnumber);
1198                    }
1199                }
1200             }
1201         }
1202     }
1203     return $mod;
1207 /**
1208  * Returns a number of useful structures for course displays
1209  */
1210 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1211     global $CFG, $DB, $COURSE;
1213     $mods          = array();    // course modules indexed by id
1214     $modnames      = array();    // all course module names (except resource!)
1215     $modnamesplural= array();    // all course module names (plural form)
1216     $modnamesused  = array();    // course module names used
1218     if ($allmods = $DB->get_records("modules")) {
1219         foreach ($allmods as $mod) {
1220             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1221                 continue;
1222             }
1223             if ($mod->visible) {
1224                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1225                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1226             }
1227         }
1228         collatorlib::asort($modnames);
1229     } else {
1230         print_error("nomodules", 'debug');
1231     }
1233     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1234     $modinfo = get_fast_modinfo($course);
1236     if ($rawmods=$modinfo->cms) {
1237         foreach($rawmods as $mod) {    // Index the mods
1238             if (empty($modnames[$mod->modname])) {
1239                 continue;
1240             }
1241             $mods[$mod->id] = $mod;
1242             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1243             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1244                 continue;
1245             }
1246             // Check groupings
1247             if (!groups_course_module_visible($mod)) {
1248                 continue;
1249             }
1250             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1251         }
1252         if ($modnamesused) {
1253             collatorlib::asort($modnamesused);
1254         }
1255     }
1258 /**
1259  * Returns an array of sections for the requested course id
1260  *
1261  * This function stores the sections against the course id within a staticvar encase
1262  * of subsequent requests. This is used all over + in some standard libs and course
1263  * format callbacks so subsequent requests are a reality.
1264  *
1265  * @staticvar array $coursesections
1266  * @param int $courseid
1267  * @return array Array of sections
1268  */
1269 function get_all_sections($courseid) {
1270     global $DB;
1271     static $coursesections = array();
1272     if (!array_key_exists($courseid, $coursesections)) {
1273         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1274                            "section, id, course, name, summary, summaryformat, sequence, visible");
1275     }
1276     return $coursesections[$courseid];
1279 /**
1280  * Returns the course section to display or 0 meaning show all sections. Returns 0 for guests.
1281  * It also sets the $USER->display cache to array($courseid=>return value)
1282  *
1283  * @param int $courseid The course id
1284  * @return int Course section to display, 0 means all
1285  */
1286 function course_get_display($courseid) {
1287     global $USER, $DB;
1289     if (!isloggedin() or isguestuser()) {
1290         //do not get settings in db for guests
1291         return 0; //return the implicit setting
1292     }
1294     if (!isset($USER->display[$courseid])) {
1295         if (!$display = $DB->get_field('course_display', 'display', array('userid' => $USER->id, 'course'=>$courseid))) {
1296             $display = 0; // all sections option is not stored in DB, this makes the table much smaller
1297         }
1298         //use display cache for one course only - we need to keep session small
1299         $USER->display = array($courseid => $display);
1300     }
1302     return $USER->display[$courseid];
1305 /**
1306  * Show one section only or all sections.
1307  *
1308  * @param int $courseid The course id
1309  * @param mixed $display show only this section, 0 or 'all' means show all sections
1310  * @return int Course section to display, 0 means all
1311  */
1312 function course_set_display($courseid, $display) {
1313     global $USER, $DB;
1315     if ($display === 'all' or empty($display)) {
1316         $display = 0;
1317     }
1319     if (!isloggedin() or isguestuser()) {
1320         //do not store settings in db for guests
1321         return 0;
1322     }
1324     if ($display == 0) {
1325         //show all, do not store anything in database
1326         $DB->delete_records('course_display', array('userid' => $USER->id, 'course' => $courseid));
1328     } else {
1329         if ($DB->record_exists('course_display', array('userid' => $USER->id, 'course' => $courseid))) {
1330             $DB->set_field('course_display', 'display', $display, array('userid' => $USER->id, 'course' => $courseid));
1331         } else {
1332             $record = new stdClass();
1333             $record->userid = $USER->id;
1334             $record->course = $courseid;
1335             $record->display = $display;
1336             $DB->insert_record('course_display', $record);
1337         }
1338     }
1340     //use display cache for one course only - we need to keep session small
1341     $USER->display = array($courseid => $display);
1343     return $display;
1346 /**
1347  * Set highlighted section. Only one section can be highlighted at the time.
1348  *
1349  * @param int $courseid course id
1350  * @param int $marker highlight section with this number, 0 means remove higlightin
1351  * @return void
1352  */
1353 function course_set_marker($courseid, $marker) {
1354     global $DB;
1355     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1358 /**
1359  * For a given course section, marks it visible or hidden,
1360  * and does the same for every activity in that section
1361  *
1362  * @param int $courseid course id
1363  * @param int $sectionnumber The section number to adjust
1364  * @param int $visibility The new visibility
1365  * @return array A list of resources which were hidden in the section
1366  */
1367 function set_section_visible($courseid, $sectionnumber, $visibility) {
1368     global $DB;
1370     $resourcestotoggle = array();
1371     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1372         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1373         if (!empty($section->sequence)) {
1374             $modules = explode(",", $section->sequence);
1375             foreach ($modules as $moduleid) {
1376                 set_coursemodule_visible($moduleid, $visibility, true);
1377             }
1378         }
1379         rebuild_course_cache($courseid);
1381         // Determine which modules are visible for AJAX update
1382         if (!empty($modules)) {
1383             list($insql, $params) = $DB->get_in_or_equal($modules);
1384             $select = 'id ' . $insql . ' AND visible = ?';
1385             array_push($params, $visibility);
1386             if (!$visibility) {
1387                 $select .= ' AND visibleold = 1';
1388             }
1389             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1390         }
1391     }
1392     return $resourcestotoggle;
1395 /**
1396  * Obtains shared data that is used in print_section when displaying a
1397  * course-module entry.
1398  *
1399  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1400  *
1401  * This data is also used in other areas of the code.
1402  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1403  * @param object $course Moodle course object
1404  * @return array An array with the following values in this order:
1405  *   $content (optional extra content for after link),
1406  *   $instancename (text of link)
1407  */
1408 function get_print_section_cm_text(cm_info $cm, $course) {
1409     global $OUTPUT;
1411     // Get content from modinfo if specified. Content displays either
1412     // in addition to the standard link (below), or replaces it if
1413     // the link is turned off by setting ->url to null.
1414     if (($content = $cm->get_content()) !== '') {
1415         // Improve filter performance by preloading filter setttings for all
1416         // activities on the course (this does nothing if called multiple
1417         // times)
1418         filter_preload_activities($cm->get_modinfo());
1420         // Get module context
1421         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1422         $labelformatoptions = new stdClass();
1423         $labelformatoptions->noclean = true;
1424         $labelformatoptions->overflowdiv = true;
1425         $labelformatoptions->context = $modulecontext;
1426         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1427     } else {
1428         $content = '';
1429     }
1431     // Get course context
1432     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1433     $stringoptions = new stdClass;
1434     $stringoptions->context = $coursecontext;
1435     $instancename = format_string($cm->name, true,  $stringoptions);
1436     return array($content, $instancename);
1439 /**
1440  * Prints a section full of activity modules
1441  */
1442 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1443     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1445     static $initialised;
1447     static $groupbuttons;
1448     static $groupbuttonslink;
1449     static $isediting;
1450     static $ismoving;
1451     static $strmovehere;
1452     static $strmovefull;
1453     static $strunreadpostsone;
1454     static $groupings;
1455     static $modulenames;
1457     if (!isset($initialised)) {
1458         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1459         $groupbuttonslink = (!$course->groupmodeforce);
1460         $isediting        = $PAGE->user_is_editing();
1461         $ismoving         = $isediting && ismoving($course->id);
1462         if ($ismoving) {
1463             $strmovehere  = get_string("movehere");
1464             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1465         }
1466         $modulenames      = array();
1467         $initialised = true;
1468     }
1470     $modinfo = get_fast_modinfo($course);
1471     $completioninfo = new completion_info($course);
1473     //Accessibility: replace table with list <ul>, but don't output empty list.
1474     if (!empty($section->sequence)) {
1476         // Fix bug #5027, don't want style=\"width:$width\".
1477         echo "<ul class=\"section img-text\">\n";
1478         $sectionmods = explode(",", $section->sequence);
1480         foreach ($sectionmods as $modnumber) {
1481             if (empty($mods[$modnumber])) {
1482                 continue;
1483             }
1485             /**
1486              * @var cm_info
1487              */
1488             $mod = $mods[$modnumber];
1490             if ($ismoving and $mod->id == $USER->activitycopy) {
1491                 // do not display moving mod
1492                 continue;
1493             }
1495             if (isset($modinfo->cms[$modnumber])) {
1496                 // We can continue (because it will not be displayed at all)
1497                 // if:
1498                 // 1) The activity is not visible to users
1499                 // and
1500                 // 2a) The 'showavailability' option is not set (if that is set,
1501                 //     we need to display the activity so we can show
1502                 //     availability info)
1503                 // or
1504                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1505                 //     hidden in a way that leaves no info, such as using the
1506                 //     eye icon.
1507                 if (!$modinfo->cms[$modnumber]->uservisible &&
1508                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1509                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1510                     // visibility shortcut
1511                     continue;
1512                 }
1513             } else {
1514                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1515                     // module not installed
1516                     continue;
1517                 }
1518                 if (!coursemodule_visible_for_user($mod) &&
1519                     empty($mod->showavailability)) {
1520                     // full visibility check
1521                     continue;
1522                 }
1523             }
1525             if (!isset($modulenames[$mod->modname])) {
1526                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1527             }
1528             $modulename = $modulenames[$mod->modname];
1530             // In some cases the activity is visible to user, but it is
1531             // dimmed. This is done if viewhiddenactivities is true and if:
1532             // 1. the activity is not visible, or
1533             // 2. the activity has dates set which do not include current, or
1534             // 3. the activity has any other conditions set (regardless of whether
1535             //    current user meets them)
1536             $canviewhidden = has_capability(
1537                 'moodle/course:viewhiddenactivities',
1538                 get_context_instance(CONTEXT_MODULE, $mod->id));
1539             $accessiblebutdim = false;
1540             if ($canviewhidden) {
1541                 $accessiblebutdim = !$mod->visible;
1542                 if (!empty($CFG->enableavailability)) {
1543                     $accessiblebutdim = $accessiblebutdim ||
1544                         $mod->availablefrom > time() ||
1545                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1546                         count($mod->conditionsgrade) > 0 ||
1547                         count($mod->conditionscompletion) > 0;
1548                 }
1549             }
1551             $liclasses = array();
1552             $liclasses[] = 'activity';
1553             $liclasses[] = $mod->modname;
1554             $liclasses[] = 'modtype_'.$mod->modname;
1555             $extraclasses = $mod->get_extra_classes();
1556             if ($extraclasses) {
1557                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1558             }
1559             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1560             if ($ismoving) {
1561                 echo '<a title="'.$strmovefull.'"'.
1562                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1563                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1564                      ' alt="'.$strmovehere.'" /></a><br />
1565                      ';
1566             }
1568             $classes = array('mod-indent');
1569             if (!empty($mod->indent)) {
1570                 $classes[] = 'mod-indent-'.$mod->indent;
1571                 if ($mod->indent > 15) {
1572                     $classes[] = 'mod-indent-huge';
1573                 }
1574             }
1575             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1577             // Get data about this course-module
1578             list($content, $instancename) =
1579                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1581             //Accessibility: for files get description via icon, this is very ugly hack!
1582             $altname = '';
1583             $altname = $mod->modfullname;
1584             if (!empty($customicon)) {
1585                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1586                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1587                     $mimetype = mimeinfo_from_icon('type', $customicon);
1588                     $altname = get_mimetype_description($mimetype);
1589                 }
1590             }
1591             // Avoid unnecessary duplication: if e.g. a forum name already
1592             // includes the word forum (or Forum, etc) then it is unhelpful
1593             // to include that in the accessible description that is added.
1594             if (false !== strpos(textlib::strtolower($instancename),
1595                     textlib::strtolower($altname))) {
1596                 $altname = '';
1597             }
1598             // File type after name, for alphabetic lists (screen reader).
1599             if ($altname) {
1600                 $altname = get_accesshide(' '.$altname);
1601             }
1603             // We may be displaying this just in order to show information
1604             // about visibility, without the actual link
1605             $contentpart = '';
1606             if ($mod->uservisible) {
1607                 // Nope - in this case the link is fully working for user
1608                 $linkclasses = '';
1609                 $textclasses = '';
1610                 if ($accessiblebutdim) {
1611                     $linkclasses .= ' dimmed';
1612                     $textclasses .= ' dimmed_text';
1613                     $accesstext = '<span class="accesshide">'.
1614                         get_string('hiddenfromstudents').': </span>';
1615                 } else {
1616                     $accesstext = '';
1617                 }
1618                 if ($linkclasses) {
1619                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1620                 } else {
1621                     $linkcss = '';
1622                 }
1623                 if ($textclasses) {
1624                     $textcss = 'class="' . trim($textclasses) . '" ';
1625                 } else {
1626                     $textcss = '';
1627                 }
1629                 // Get on-click attribute value if specified
1630                 $onclick = $mod->get_on_click();
1631                 if ($onclick) {
1632                     $onclick = ' onclick="' . $onclick . '"';
1633                 }
1635                 if ($url = $mod->get_url()) {
1636                     // Display link itself
1637                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1638                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1639                             '" class="activityicon" alt="' .
1640                             $modulename . '" /> ' .
1641                             $accesstext . '<span class="instancename">' .
1642                             $instancename . $altname . '</span></a>';
1644                     // If specified, display extra content after link
1645                     if ($content) {
1646                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1647                                 '">' . $content . '</div>';
1648                     }
1649                 } else {
1650                     // No link, so display only content
1651                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1652                             $accesstext . $content . '</div>';
1653                 }
1655                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1656                     if (!isset($groupings)) {
1657                         $groupings = groups_get_all_groupings($course->id);
1658                     }
1659                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1660                 }
1661             } else {
1662                 $textclasses = $extraclasses;
1663                 $textclasses .= ' dimmed_text';
1664                 if ($textclasses) {
1665                     $textcss = 'class="' . trim($textclasses) . '" ';
1666                 } else {
1667                     $textcss = '';
1668                 }
1669                 $accesstext = '<span class="accesshide">' .
1670                         get_string('notavailableyet', 'condition') .
1671                         ': </span>';
1673                 if ($url = $mod->get_url()) {
1674                     // Display greyed-out text of link
1675                     echo '<div ' . $textcss . $mod->extra .
1676                             ' >' . '<img src="' . $mod->get_icon_url() .
1677                             '" class="activityicon" alt="' .
1678                             $modulename .
1679                             '" /> <span>'. $instancename . $altname .
1680                             '</span></div>';
1682                     // Do not display content after link when it is greyed out like this.
1683                 } else {
1684                     // No link, so display only content (also greyed)
1685                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1686                             $accesstext . $content . '</div>';
1687                 }
1688             }
1690             // Module can put text after the link (e.g. forum unread)
1691             echo $mod->get_after_link();
1693             // If there is content but NO link (eg label), then display the
1694             // content here (BEFORE any icons). In this case cons must be
1695             // displayed after the content so that it makes more sense visually
1696             // and for accessibility reasons, e.g. if you have a one-line label
1697             // it should work similarly (at least in terms of ordering) to an
1698             // activity.
1699             if (empty($url)) {
1700                 echo $contentpart;
1701             }
1703             if ($isediting) {
1704                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1705                     if (! $mod->groupmodelink = $groupbuttonslink) {
1706                         $mod->groupmode = $course->groupmode;
1707                     }
1709                 } else {
1710                     $mod->groupmode = false;
1711                 }
1712                 echo '&nbsp;&nbsp;';
1713                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1714                 echo $mod->get_after_edit_icons();
1715             }
1717             // Completion
1718             $completion = $hidecompletion
1719                 ? COMPLETION_TRACKING_NONE
1720                 : $completioninfo->is_enabled($mod);
1721             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1722                 !isguestuser() && $mod->uservisible) {
1723                 $completiondata = $completioninfo->get_data($mod,true);
1724                 $completionicon = '';
1725                 if ($isediting) {
1726                     switch ($completion) {
1727                         case COMPLETION_TRACKING_MANUAL :
1728                             $completionicon = 'manual-enabled'; break;
1729                         case COMPLETION_TRACKING_AUTOMATIC :
1730                             $completionicon = 'auto-enabled'; break;
1731                         default: // wtf
1732                     }
1733                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1734                     switch($completiondata->completionstate) {
1735                         case COMPLETION_INCOMPLETE:
1736                             $completionicon = 'manual-n'; break;
1737                         case COMPLETION_COMPLETE:
1738                             $completionicon = 'manual-y'; break;
1739                     }
1740                 } else { // Automatic
1741                     switch($completiondata->completionstate) {
1742                         case COMPLETION_INCOMPLETE:
1743                             $completionicon = 'auto-n'; break;
1744                         case COMPLETION_COMPLETE:
1745                             $completionicon = 'auto-y'; break;
1746                         case COMPLETION_COMPLETE_PASS:
1747                             $completionicon = 'auto-pass'; break;
1748                         case COMPLETION_COMPLETE_FAIL:
1749                             $completionicon = 'auto-fail'; break;
1750                     }
1751                 }
1752                 if ($completionicon) {
1753                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1754                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion', $mod->name));
1755                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1756                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion', $mod->name));
1757                         $newstate =
1758                             $completiondata->completionstate==COMPLETION_COMPLETE
1759                             ? COMPLETION_INCOMPLETE
1760                             : COMPLETION_COMPLETE;
1761                         // In manual mode the icon is a toggle form...
1763                         // If this completion state is used by the
1764                         // conditional activities system, we need to turn
1765                         // off the JS.
1766                         if (!empty($CFG->enableavailability) &&
1767                             condition_info::completion_value_used_as_condition($course, $mod)) {
1768                             $extraclass = ' preventjs';
1769                         } else {
1770                             $extraclass = '';
1771                         }
1772                         echo "
1773 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1774 <input type='hidden' name='id' value='{$mod->id}' />
1775 <input type='hidden' name='modulename' value='".s($mod->name)."' />
1776 <input type='hidden' name='sesskey' value='".sesskey()."' />
1777 <input type='hidden' name='completionstate' value='$newstate' />
1778 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1779 </div></form>";
1780                     } else {
1781                         // In auto mode, or when editing, the icon is just an image
1782                         echo "<span class='autocompletion'>";
1783                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1784                     }
1785                 }
1786             }
1788             // If there is content AND a link, then display the content here
1789             // (AFTER any icons). Otherwise it was displayed before
1790             if (!empty($url)) {
1791                 echo $contentpart;
1792             }
1794             // Show availability information (for someone who isn't allowed to
1795             // see the activity itself, or for staff)
1796             if (!$mod->uservisible) {
1797                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1798             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1799                 $ci = new condition_info($mod);
1800                 $fullinfo = $ci->get_full_information();
1801                 if($fullinfo) {
1802                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1803                         ? 'userrestriction_visible'
1804                         : 'userrestriction_hidden','condition',
1805                         $fullinfo).'</div>';
1806                 }
1807             }
1809             echo html_writer::end_tag('div');
1810             echo html_writer::end_tag('li')."\n";
1811         }
1813     } elseif ($ismoving) {
1814         echo "<ul class=\"section\">\n";
1815     }
1817     if ($ismoving) {
1818         echo '<li><a title="'.$strmovefull.'"'.
1819              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1820              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1821              ' alt="'.$strmovehere.'" /></a></li>
1822              ';
1823     }
1824     if (!empty($section->sequence) || $ismoving) {
1825         echo "</ul><!--class='section'-->\n\n";
1826     }
1829 /**
1830  * Prints the menus to add activities and resources.
1831  */
1832 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1833     global $CFG, $OUTPUT;
1835     // check to see if user can add menus
1836     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1837         return false;
1838     }
1840     // Retrieve all modules with associated metadata
1841     $modules = get_module_metadata($course, $modnames);
1843     // We'll sort resources and activities into two lists
1844     $resources = array();
1845     $activities = array();
1847     // We need to add the section section to the link for each module
1848     $sectionlink = '&section=' . $section;
1850     foreach ($modules as $module) {
1851         if (isset($module->types)) {
1852             // This module has a subtype
1853             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1854             $subtypes = array();
1855             foreach ($module->types as $subtype) {
1856                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1857             }
1859             // Sort module subtypes into the list
1860             if (!empty($module->title)) {
1861                 // This grouping has a name
1862                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1863                     $resources[] = array($module->title=>$subtypes);
1864                 } else {
1865                     $activities[] = array($module->title=>$subtypes);
1866                 }
1867             } else {
1868                 // This grouping does not have a name
1869                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1870                     $resources = array_merge($resources, $subtypes);
1871                 } else {
1872                     $activities = array_merge($activities, $subtypes);
1873                 }
1874             }
1875         } else {
1876             // This module has no subtypes
1877             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1878                 $resources[$module->link . $sectionlink] = $module->title;
1879             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1880                 // System modules cannot be added by user, do not add to dropdown
1881             } else {
1882                 $activities[$module->link . $sectionlink] = $module->title;
1883             }
1884         }
1885     }
1887     $straddactivity = get_string('addactivity');
1888     $straddresource = get_string('addresource');
1890     $output  = '<div class="section_add_menus">';
1892     if (!$vertical) {
1893         $output .= '<div class="horizontal">';
1894     }
1896     if (!empty($resources)) {
1897         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1898         $select->set_help_icon('resources');
1899         $output .= $OUTPUT->render($select);
1900     }
1902     if (!empty($activities)) {
1903         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1904         $select->set_help_icon('activities');
1905         $output .= $OUTPUT->render($select);
1906     }
1908     if (!$vertical) {
1909         $output .= '</div>';
1910     }
1912     $output .= '</div>';
1914     if ($return) {
1915         return $output;
1916     } else {
1917         echo $output;
1918     }
1921 /**
1922  * Retrieve all metadata for the requested modules
1923  *
1924  * @param object $course The Course
1925  * @param array $modnames An array containing the list of modules and their
1926  * names
1927  * @return array A list of stdClass objects containing metadata about each
1928  * module
1929  */
1930 function get_module_metadata($course, $modnames) {
1931     global $CFG, $OUTPUT;
1933     // get_module_metadata will be called once per section on the page and courses may show
1934     // different modules to one another
1935     static $modlist = array();
1936     if (!isset($modlist[$course->id])) {
1937         $modlist[$course->id] = array();
1938     }
1940     $return = array();
1941     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&add=';
1942     foreach($modnames as $modname => $modnamestr) {
1943         if (!course_allowed_module($course, $modname)) {
1944             continue;
1945         }
1946         if (isset($modlist[$modname])) {
1947             // This module is already cached
1948             $return[$modname] = $modlist[$course->id][$modname];
1949             continue;
1950         }
1952         // Include the module lib
1953         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1954         if (!file_exists($libfile)) {
1955             continue;
1956         }
1957         include_once($libfile);
1959         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1960         $gettypesfunc =  $modname.'_get_types';
1961         if (function_exists($gettypesfunc)) {
1962             if ($types = $gettypesfunc()) {
1963                 $group = new stdClass();
1964                 $group->name = $modname;
1965                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1966                 foreach($types as $type) {
1967                     if ($type->typestr === '--') {
1968                         continue;
1969                     }
1970                     if (strpos($type->typestr, '--') === 0) {
1971                         $group->title = str_replace('--', '', $type->typestr);
1972                         continue;
1973                     }
1974                     // Set the Sub Type metadata
1975                     $subtype = new stdClass();
1976                     $subtype->title = $type->typestr;
1977                     $subtype->type = str_replace('&amp;', '&', $type->type);
1978                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1979                     $subtype->archetype = $type->modclass;
1981                     // The group archetype should match the subtype archetypes and all subtypes
1982                     // should have the same archetype
1983                     $group->archetype = $subtype->archetype;
1985                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1986                         $subtype->help = get_string('help' . $subtype->name, $modname);
1987                     }
1988                     $subtype->link = $urlbase . $subtype->type;
1989                     $group->types[] = $subtype;
1990                 }
1991                 $modlist[$course->id][$modname] = $group;
1992             }
1993         } else {
1994             $module = new stdClass();
1995             $module->title = get_string('modulename', $modname);
1996             $module->name = $modname;
1997             $module->link = $urlbase . $modname;
1998             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1999             if (get_string_manager()->string_exists('modulename_help', $modname)) {
2000                 $module->help = get_string('modulename_help', $modname);
2001             }
2002             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2003             $modlist[$course->id][$modname] = $module;
2004         }
2005         $return[$modname] = $modlist[$course->id][$modname];
2006     }
2008     return $return;
2011 /**
2012  * Return the course category context for the category with id $categoryid, except
2013  * that if $categoryid is 0, return the system context.
2014  *
2015  * @param integer $categoryid a category id or 0.
2016  * @return object the corresponding context
2017  */
2018 function get_category_or_system_context($categoryid) {
2019     if ($categoryid) {
2020         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
2021     } else {
2022         return get_context_instance(CONTEXT_SYSTEM);
2023     }
2026 /**
2027  * Gets the child categories of a given courses category. Uses a static cache
2028  * to make repeat calls efficient.
2029  *
2030  * @param int $parentid the id of a course category.
2031  * @return array all the child course categories.
2032  */
2033 function get_child_categories($parentid) {
2034     static $allcategories = null;
2036     // only fill in this variable the first time
2037     if (null == $allcategories) {
2038         $allcategories = array();
2040         $categories = get_categories();
2041         foreach ($categories as $category) {
2042             if (empty($allcategories[$category->parent])) {
2043                 $allcategories[$category->parent] = array();
2044             }
2045             $allcategories[$category->parent][] = $category;
2046         }
2047     }
2049     if (empty($allcategories[$parentid])) {
2050         return array();
2051     } else {
2052         return $allcategories[$parentid];
2053     }
2056 /**
2057  * This function recursively travels the categories, building up a nice list
2058  * for display. It also makes an array that list all the parents for each
2059  * category.
2060  *
2061  * For example, if you have a tree of categories like:
2062  *   Miscellaneous (id = 1)
2063  *      Subcategory (id = 2)
2064  *         Sub-subcategory (id = 4)
2065  *   Other category (id = 3)
2066  * Then after calling this function you will have
2067  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2068  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2069  *      3 => 'Other category');
2070  * $parents = array(2 => array(1), 4 => array(1, 2));
2071  *
2072  * If you specify $requiredcapability, then only categories where the current
2073  * user has that capability will be added to $list, although all categories
2074  * will still be added to $parents, and if you only have $requiredcapability
2075  * in a child category, not the parent, then the child catgegory will still be
2076  * included.
2077  *
2078  * If you specify the option $excluded, then that category, and all its children,
2079  * are omitted from the tree. This is useful when you are doing something like
2080  * moving categories, where you do not want to allow people to move a category
2081  * to be the child of itself.
2082  *
2083  * @param array $list For output, accumulates an array categoryid => full category path name
2084  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2085  * @param string/array $requiredcapability if given, only categories where the current
2086  *      user has this capability will be added to $list. Can also be an array of capabilities,
2087  *      in which case they are all required.
2088  * @param integer $excludeid Omit this category and its children from the lists built.
2089  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2090  * @param string $path For internal use, as part of recursive calls.
2091  */
2092 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2093         $excludeid = 0, $category = NULL, $path = "") {
2095     // initialize the arrays if needed
2096     if (!is_array($list)) {
2097         $list = array();
2098     }
2099     if (!is_array($parents)) {
2100         $parents = array();
2101     }
2103     if (empty($category)) {
2104         // Start at the top level.
2105         $category = new stdClass;
2106         $category->id = 0;
2107     } else {
2108         // This is the excluded category, don't include it.
2109         if ($excludeid > 0 && $excludeid == $category->id) {
2110             return;
2111         }
2113         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2114         $categoryname = format_string($category->name, true, array('context' => $context));
2116         // Update $path.
2117         if ($path) {
2118             $path = $path.' / '.$categoryname;
2119         } else {
2120             $path = $categoryname;
2121         }
2123         // Add this category to $list, if the permissions check out.
2124         if (empty($requiredcapability)) {
2125             $list[$category->id] = $path;
2127         } else {
2128             $requiredcapability = (array)$requiredcapability;
2129             if (has_all_capabilities($requiredcapability, $context)) {
2130                 $list[$category->id] = $path;
2131             }
2132         }
2133     }
2135     // Add all the children recursively, while updating the parents array.
2136     if ($categories = get_child_categories($category->id)) {
2137         foreach ($categories as $cat) {
2138             if (!empty($category->id)) {
2139                 if (isset($parents[$category->id])) {
2140                     $parents[$cat->id]   = $parents[$category->id];
2141                 }
2142                 $parents[$cat->id][] = $category->id;
2143             }
2144             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2145         }
2146     }
2149 /**
2150  * This function generates a structured array of courses and categories.
2151  *
2152  * The depth of categories is limited by $CFG->maxcategorydepth however there
2153  * is no limit on the number of courses!
2154  *
2155  * Suitable for use with the course renderers course_category_tree method:
2156  * $renderer = $PAGE->get_renderer('core','course');
2157  * echo $renderer->course_category_tree(get_course_category_tree());
2158  *
2159  * @global moodle_database $DB
2160  * @param int $id
2161  * @param int $depth
2162  */
2163 function get_course_category_tree($id = 0, $depth = 0) {
2164     global $DB, $CFG;
2165     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2166     $categories = get_child_categories($id);
2167     $categoryids = array();
2168     foreach ($categories as $key => &$category) {
2169         if (!$category->visible && !$viewhiddencats) {
2170             unset($categories[$key]);
2171             continue;
2172         }
2173         $categoryids[$category->id] = $category;
2174         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2175             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2176             foreach ($subcategories as $subid=>$subcat) {
2177                 $categoryids[$subid] = $subcat;
2178             }
2179             $category->courses = array();
2180         }
2181     }
2183     if ($depth > 0) {
2184         // This is a recursive call so return the required array
2185         return array($categories, $categoryids);
2186     }
2188     // The depth is 0 this function has just been called so we can finish it off
2190     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2191     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2192     $sql = "SELECT
2193             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2194             $ccselect
2195             FROM {course} c
2196             $ccjoin
2197             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2198     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2199         // loop throught them
2200         foreach ($courses as $course) {
2201             if ($course->id == SITEID) {
2202                 continue;
2203             }
2204             context_instance_preload($course);
2205             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2206                 $categoryids[$course->category]->courses[$course->id] = $course;
2207             }
2208         }
2209     }
2210     return $categories;
2213 /**
2214  * Recursive function to print out all the categories in a nice format
2215  * with or without courses included
2216  */
2217 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2218     global $CFG;
2220     // maxcategorydepth == 0 meant no limit
2221     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2222         return;
2223     }
2225     if (!$displaylist) {
2226         make_categories_list($displaylist, $parentslist);
2227     }
2229     if ($category) {
2230         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2231             print_category_info($category, $depth, $showcourses);
2232         } else {
2233             return;  // Don't bother printing children of invisible categories
2234         }
2236     } else {
2237         $category = new stdClass();
2238         $category->id = "0";
2239     }
2241     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2242         $countcats = count($categories);
2243         $count = 0;
2244         $first = true;
2245         $last = false;
2246         foreach ($categories as $cat) {
2247             $count++;
2248             if ($count == $countcats) {
2249                 $last = true;
2250             }
2251             $up = $first ? false : true;
2252             $down = $last ? false : true;
2253             $first = false;
2255             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2256         }
2257     }
2260 /**
2261  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2262  */
2263 function make_categories_options() {
2264     make_categories_list($cats,$parents);
2265     foreach ($cats as $key => $value) {
2266         if (array_key_exists($key,$parents)) {
2267             if ($indent = count($parents[$key])) {
2268                 for ($i = 0; $i < $indent; $i++) {
2269                     $cats[$key] = '&nbsp;'.$cats[$key];
2270                 }
2271             }
2272         }
2273     }
2274     return $cats;
2277 /**
2278  * Gets the name of a course to be displayed when showing a list of courses.
2279  * By default this is just $course->fullname but user can configure it. The
2280  * result of this function should be passed through print_string.
2281  * @param object $course Moodle course object
2282  * @return string Display name of course (either fullname or short + fullname)
2283  */
2284 function get_course_display_name_for_list($course) {
2285     global $CFG;
2286     if (!empty($CFG->courselistshortnames)) {
2287         return $course->shortname . ' ' .$course->fullname;
2288     } else {
2289         return $course->fullname;
2290     }
2293 /**
2294  * Prints the category info in indented fashion
2295  * This function is only used by print_whole_category_list() above
2296  */
2297 function print_category_info($category, $depth=0, $showcourses = false) {
2298     global $CFG, $DB, $OUTPUT;
2300     $strsummary = get_string('summary');
2302     $catlinkcss = null;
2303     if (!$category->visible) {
2304         $catlinkcss = array('class'=>'dimmed');
2305     }
2306     static $coursecount = null;
2307     if (null === $coursecount) {
2308         // only need to check this once
2309         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2310     }
2312     if ($showcourses and $coursecount) {
2313         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2314     } else {
2315         $catimage = "&nbsp;";
2316     }
2318     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2319     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2320     $fullname = format_string($category->name, true, array('context' => $context));
2322     if ($showcourses and $coursecount) {
2323         echo '<div class="categorylist clearfix">';
2324         $cat = '';
2325         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2326         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2327         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2329         $html = '';
2330         if ($depth > 0) {
2331             for ($i=0; $i< $depth; $i++) {
2332                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2333                 $cat = '';
2334             }
2335         } else {
2336             $html = $cat;
2337         }
2338         echo html_writer::tag('div', $html, array('class'=>'category'));
2339         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2341         // does the depth exceed maxcategorydepth
2342         // maxcategorydepth == 0 or unset meant no limit
2343         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2344         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2345             foreach ($courses as $course) {
2346                 $linkcss = null;
2347                 if (!$course->visible) {
2348                     $linkcss = array('class'=>'dimmed');
2349                 }
2351                 $coursename = get_course_display_name_for_list($course);
2352                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2354                 // print enrol info
2355                 $courseicon = '';
2356                 if ($icons = enrol_get_course_info_icons($course)) {
2357                     foreach ($icons as $pix_icon) {
2358                         $courseicon = $OUTPUT->render($pix_icon).' ';
2359                     }
2360                 }
2362                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2364                 if ($course->summary) {
2365                     $link = new moodle_url('/course/info.php?id='.$course->id);
2366                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2367                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2368                         array('title'=>$strsummary));
2370                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2371                 }
2373                 $html = '';
2374                 for ($i=0; $i <= $depth; $i++) {
2375                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2376                     $coursecontent = '';
2377                 }
2378                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2379             }
2380         }
2381         echo '</div>';
2382     } else {
2383         echo '<div class="categorylist">';
2384         $html = '';
2385         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2386         if (count($courses) > 0) {
2387             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2388         }
2390         if ($depth > 0) {
2391             for ($i=0; $i< $depth; $i++) {
2392                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2393                 $cat = '';
2394             }
2395         } else {
2396             $html = $cat;
2397         }
2399         echo html_writer::tag('div', $html, array('class'=>'category'));
2400         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2401         echo '</div>';
2402     }
2405 /**
2406  * Print the buttons relating to course requests.
2407  *
2408  * @param object $systemcontext the system context.
2409  */
2410 function print_course_request_buttons($systemcontext) {
2411     global $CFG, $DB, $OUTPUT;
2412     if (empty($CFG->enablecourserequests)) {
2413         return;
2414     }
2415     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2416     /// Print a button to request a new course
2417         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2418     }
2419     /// Print a button to manage pending requests
2420     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2421         $disabled = !$DB->record_exists('course_request', array());
2422         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2423     }
2426 /**
2427  * Does the user have permission to edit things in this category?
2428  *
2429  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2430  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2431  */
2432 function can_edit_in_category($categoryid = 0) {
2433     $context = get_category_or_system_context($categoryid);
2434     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2437 /**
2438  * Prints the turn editing on/off button on course/index.php or course/category.php.
2439  *
2440  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2441  * @return string HTML of the editing button, or empty string, if this user is not allowed
2442  *      to see it.
2443  */
2444 function update_category_button($categoryid = 0) {
2445     global $CFG, $PAGE, $OUTPUT;
2447     // Check permissions.
2448     if (!can_edit_in_category($categoryid)) {
2449         return '';
2450     }
2452     // Work out the appropriate action.
2453     if ($PAGE->user_is_editing()) {
2454         $label = get_string('turneditingoff');
2455         $edit = 'off';
2456     } else {
2457         $label = get_string('turneditingon');
2458         $edit = 'on';
2459     }
2461     // Generate the button HTML.
2462     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2463     if ($categoryid) {
2464         $options['id'] = $categoryid;
2465         $page = 'category.php';
2466     } else {
2467         $page = 'index.php';
2468     }
2469     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2472 /**
2473  * Category is 0 (for all courses) or an object
2474  */
2475 function print_courses($category) {
2476     global $CFG, $OUTPUT;
2478     if (!is_object($category) && $category==0) {
2479         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2480         if (is_array($categories) && count($categories) == 1) {
2481             $category   = array_shift($categories);
2482             $courses    = get_courses_wmanagers($category->id,
2483                                                 'c.sortorder ASC',
2484                                                 array('summary','summaryformat'));
2485         } else {
2486             $courses    = get_courses_wmanagers('all',
2487                                                 'c.sortorder ASC',
2488                                                 array('summary','summaryformat'));
2489         }
2490         unset($categories);
2491     } else {
2492         $courses    = get_courses_wmanagers($category->id,
2493                                             'c.sortorder ASC',
2494                                             array('summary','summaryformat'));
2495     }
2497     if ($courses) {
2498         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2499         foreach ($courses as $course) {
2500             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2501             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2502                 echo html_writer::start_tag('li');
2503                 print_course($course);
2504                 echo html_writer::end_tag('li');
2505             }
2506         }
2507         echo html_writer::end_tag('ul');
2508     } else {
2509         echo $OUTPUT->heading(get_string("nocoursesyet"));
2510         $context = get_context_instance(CONTEXT_SYSTEM);
2511         if (has_capability('moodle/course:create', $context)) {
2512             $options = array();
2513             if (!empty($category->id)) {
2514                 $options['category'] = $category->id;
2515             } else {
2516                 $options['category'] = $CFG->defaultrequestcategory;
2517             }
2518             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2519             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2520             echo html_writer::end_tag('div');
2521         }
2522     }
2525 /**
2526  * Print a description of a course, suitable for browsing in a list.
2527  *
2528  * @param object $course the course object.
2529  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2530  */
2531 function print_course($course, $highlightterms = '') {
2532     global $CFG, $USER, $DB, $OUTPUT;
2534     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2536     // Rewrite file URLs so that they are correct
2537     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2539     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2540     echo html_writer::start_tag('div', array('class'=>'info'));
2541     echo html_writer::start_tag('h3', array('class'=>'name'));
2543     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2545     $coursename = get_course_display_name_for_list($course);
2546     $linktext = highlight($highlightterms, format_string($coursename));
2547     $linkparams = array('title'=>get_string('entercourse'));
2548     if (empty($course->visible)) {
2549         $linkparams['class'] = 'dimmed';
2550     }
2551     echo html_writer::link($linkhref, $linktext, $linkparams);
2552     echo html_writer::end_tag('h3');
2554     /// first find all roles that are supposed to be displayed
2555     if (!empty($CFG->coursecontact)) {
2556         $managerroles = explode(',', $CFG->coursecontact);
2557         $namesarray = array();
2558         $rusers = array();
2560         if (!isset($course->managers)) {
2561             $rusers = get_role_users($managerroles, $context, true,
2562                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2563                  r.name AS rolename, r.sortorder, r.id AS roleid',
2564                 'r.sortorder ASC, u.lastname ASC');
2565         } else {
2566             //  use the managers array if we have it for perf reasosn
2567             //  populate the datastructure like output of get_role_users();
2568             foreach ($course->managers as $manager) {
2569                 $u = new stdClass();
2570                 $u = $manager->user;
2571                 $u->roleid = $manager->roleid;
2572                 $u->rolename = $manager->rolename;
2574                 $rusers[] = $u;
2575             }
2576         }
2578         /// Rename some of the role names if needed
2579         if (isset($context)) {
2580             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2581         }
2583         $namesarray = array();
2584         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2585         foreach ($rusers as $ra) {
2586             if (isset($namesarray[$ra->id])) {
2587                 //  only display a user once with the higest sortorder role
2588                 continue;
2589             }
2591             if (isset($aliasnames[$ra->roleid])) {
2592                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2593             }
2595             $fullname = fullname($ra, $canviewfullnames);
2596             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2597                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2598         }
2600         if (!empty($namesarray)) {
2601             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2602             foreach ($namesarray as $name) {
2603                 echo html_writer::tag('li', $name);
2604             }
2605             echo html_writer::end_tag('ul');
2606         }
2607     }
2608     echo html_writer::end_tag('div'); // End of info div
2610     echo html_writer::start_tag('div', array('class'=>'summary'));
2611     $options = new stdClass();
2612     $options->noclean = true;
2613     $options->para = false;
2614     $options->overflowdiv = true;
2615     if (!isset($course->summaryformat)) {
2616         $course->summaryformat = FORMAT_MOODLE;
2617     }
2618     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2619     if ($icons = enrol_get_course_info_icons($course)) {
2620         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2621         foreach ($icons as $icon) {
2622             echo $OUTPUT->render($icon);
2623         }
2624         echo html_writer::end_tag('div'); // End of enrolmenticons div
2625     }
2626     echo html_writer::end_tag('div'); // End of summary div
2627     echo html_writer::end_tag('div'); // End of coursebox div
2630 /**
2631  * Prints custom user information on the home page.
2632  * Over time this can include all sorts of information
2633  */
2634 function print_my_moodle() {
2635     global $USER, $CFG, $DB, $OUTPUT;
2637     if (!isloggedin() or isguestuser()) {
2638         print_error('nopermissions', '', '', 'See My Moodle');
2639     }
2641     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2642     $rhosts   = array();
2643     $rcourses = array();
2644     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2645         $rcourses = get_my_remotecourses($USER->id);
2646         $rhosts   = get_my_remotehosts();
2647     }
2649     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2651         if (!empty($courses)) {
2652             echo '<ul class="unlist">';
2653             foreach ($courses as $course) {
2654                 if ($course->id == SITEID) {
2655                     continue;
2656                 }
2657                 echo '<li>';
2658                 print_course($course);
2659                 echo "</li>\n";
2660             }
2661             echo "</ul>\n";
2662         }
2664         // MNET
2665         if (!empty($rcourses)) {
2666             // at the IDP, we know of all the remote courses
2667             foreach ($rcourses as $course) {
2668                 print_remote_course($course, "100%");
2669             }
2670         } elseif (!empty($rhosts)) {
2671             // non-IDP, we know of all the remote servers, but not courses
2672             foreach ($rhosts as $host) {
2673                 print_remote_host($host, "100%");
2674             }
2675         }
2676         unset($course);
2677         unset($host);
2679         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2680             echo "<table width=\"100%\"><tr><td align=\"center\">";
2681             print_course_search("", false, "short");
2682             echo "</td><td align=\"center\">";
2683             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2684             echo "</td></tr></table>\n";
2685         }
2687     } else {
2688         if ($DB->count_records("course_categories") > 1) {
2689             echo $OUTPUT->box_start("categorybox");
2690             print_whole_category_list();
2691             echo $OUTPUT->box_end();
2692         } else {
2693             print_courses(0);
2694         }
2695     }
2699 function print_course_search($value="", $return=false, $format="plain") {
2700     global $CFG;
2701     static $count = 0;
2703     $count++;
2705     $id = 'coursesearch';
2707     if ($count > 1) {
2708         $id .= $count;
2709     }
2711     $strsearchcourses= get_string("searchcourses");
2713     if ($format == 'plain') {
2714         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2715         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2716         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2717         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2718         $output .= '<input type="submit" value="'.get_string('go').'" />';
2719         $output .= '</fieldset></form>';
2720     } else if ($format == 'short') {
2721         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2722         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2723         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2724         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2725         $output .= '<input type="submit" value="'.get_string('go').'" />';
2726         $output .= '</fieldset></form>';
2727     } else if ($format == 'navbar') {
2728         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2729         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2730         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2731         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2732         $output .= '<input type="submit" value="'.get_string('go').'" />';
2733         $output .= '</fieldset></form>';
2734     }
2736     if ($return) {
2737         return $output;
2738     }
2739     echo $output;
2742 function print_remote_course($course, $width="100%") {
2743     global $CFG, $USER;
2745     $linkcss = '';
2747     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2749     echo '<div class="coursebox remotecoursebox clearfix">';
2750     echo '<div class="info">';
2751     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2752          $linkcss.' href="'.$url.'">'
2753         .  format_string($course->fullname) .'</a><br />'
2754         . format_string($course->hostname) . ' : '
2755         . format_string($course->cat_name) . ' : '
2756         . format_string($course->shortname). '</div>';
2757     echo '</div><div class="summary">';
2758     $options = new stdClass();
2759     $options->noclean = true;
2760     $options->para = false;
2761     $options->overflowdiv = true;
2762     echo format_text($course->summary, $course->summaryformat, $options);
2763     echo '</div>';
2764     echo '</div>';
2767 function print_remote_host($host, $width="100%") {
2768     global $OUTPUT;
2770     $linkcss = '';
2772     echo '<div class="coursebox clearfix">';
2773     echo '<div class="info">';
2774     echo '<div class="name">';
2775     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2776     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2777         . s($host['name']).'</a> - ';
2778     echo $host['count'] . ' ' . get_string('courses');
2779     echo '</div>';
2780     echo '</div>';
2781     echo '</div>';
2785 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2787 function add_course_module($mod) {
2788     global $DB;
2790     $mod->added = time();
2791     unset($mod->id);
2793     return $DB->insert_record("course_modules", $mod);
2796 /**
2797  * Returns course section - creates new if does not exist yet.
2798  * @param int $relative section number
2799  * @param int $courseid
2800  * @return object $course_section object
2801  */
2802 function get_course_section($section, $courseid) {
2803     global $DB;
2805     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2806         return $cw;
2807     }
2808     $cw = new stdClass();
2809     $cw->course   = $courseid;
2810     $cw->section  = $section;
2811     $cw->summary  = "";
2812     $cw->summaryformat = FORMAT_HTML;
2813     $cw->sequence = "";
2814     $id = $DB->insert_record("course_sections", $cw);
2815     return $DB->get_record("course_sections", array("id"=>$id));
2817 /**
2818  * Given a full mod object with section and course already defined, adds this module to that section.
2819  *
2820  * @param object $mod
2821  * @param int $beforemod An existing ID which we will insert the new module before
2822  * @return int The course_sections ID where the mod is inserted
2823  */
2824 function add_mod_to_section($mod, $beforemod=NULL) {
2825     global $DB;
2827     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2829         $section->sequence = trim($section->sequence);
2831         if (empty($section->sequence)) {
2832             $newsequence = "$mod->coursemodule";
2834         } else if ($beforemod) {
2835             $modarray = explode(",", $section->sequence);
2837             if ($key = array_keys($modarray, $beforemod->id)) {
2838                 $insertarray = array($mod->id, $beforemod->id);
2839                 array_splice($modarray, $key[0], 1, $insertarray);
2840                 $newsequence = implode(",", $modarray);
2842             } else {  // Just tack it on the end anyway
2843                 $newsequence = "$section->sequence,$mod->coursemodule";
2844             }
2846         } else {
2847             $newsequence = "$section->sequence,$mod->coursemodule";
2848         }
2850         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2851         return $section->id;     // Return course_sections ID that was used.
2853     } else {  // Insert a new record
2854         $section = new stdClass();
2855         $section->course   = $mod->course;
2856         $section->section  = $mod->section;
2857         $section->summary  = "";
2858         $section->summaryformat = FORMAT_HTML;
2859         $section->sequence = $mod->coursemodule;
2860         return $DB->insert_record("course_sections", $section);
2861     }
2864 function set_coursemodule_groupmode($id, $groupmode) {
2865     global $DB;
2866     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2869 function set_coursemodule_idnumber($id, $idnumber) {
2870     global $DB;
2871     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2874 /**
2875 * $prevstateoverrides = true will set the visibility of the course module
2876 * to what is defined in visibleold. This enables us to remember the current
2877 * visibility when making a whole section hidden, so that when we toggle
2878 * that section back to visible, we are able to return the visibility of
2879 * the course module back to what it was originally.
2880 */
2881 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2882     global $DB, $CFG;
2883     require_once($CFG->libdir.'/gradelib.php');
2885     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2886         return false;
2887     }
2888     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2889         return false;
2890     }
2891     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2892         foreach($events as $event) {
2893             if ($visible) {
2894                 show_event($event);
2895             } else {
2896                 hide_event($event);
2897             }
2898         }
2899     }
2901     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2902     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2903     if ($grade_items) {
2904         foreach ($grade_items as $grade_item) {
2905             $grade_item->set_hidden(!$visible);
2906         }
2907     }
2909     if ($prevstateoverrides) {
2910         if ($visible == '0') {
2911             // Remember the current visible state so we can toggle this back.
2912             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2913         } else {
2914             // Get the previous saved visible states.
2915             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2916         }
2917     }
2918     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2921 /**
2922  * Delete a course module and any associated data at the course level (events)
2923  * Until 1.5 this function simply marked a deleted flag ... now it
2924  * deletes it completely.
2925  *
2926  */
2927 function delete_course_module($id) {
2928     global $CFG, $DB;
2929     require_once($CFG->libdir.'/gradelib.php');
2930     require_once($CFG->dirroot.'/blog/lib.php');
2932     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2933         return true;
2934     }
2935     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2936     //delete events from calendar
2937     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2938         foreach($events as $event) {
2939             delete_event($event->id);
2940         }
2941     }
2942     //delete grade items, outcome items and grades attached to modules
2943     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2944                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2945         foreach ($grade_items as $grade_item) {
2946             $grade_item->delete('moddelete');
2947         }
2948     }
2949     // Delete completion and availability data; it is better to do this even if the
2950     // features are not turned on, in case they were turned on previously (these will be
2951     // very quick on an empty table)
2952     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2953     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2954     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2955                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2957     delete_context(CONTEXT_MODULE, $cm->id);
2958     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2961 function delete_mod_from_section($mod, $section) {
2962     global $DB;
2964     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2966         $modarray = explode(",", $section->sequence);
2968         if ($key = array_keys ($modarray, $mod)) {
2969             array_splice($modarray, $key[0], 1);
2970             $newsequence = implode(",", $modarray);
2971             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2972         } else {
2973             return false;
2974         }
2976     }
2977     return false;
2980 /**
2981  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2982  *
2983  * @param object $course course object
2984  * @param int $section Section number (not id!!!)
2985  * @param int $move (-1 or 1)
2986  * @return boolean true if section moved successfully
2987  */
2988 function move_section($course, $section, $move) {
2989 /// Moves a whole course section up and down within the course
2990     global $USER, $DB;
2992     if (!$move) {
2993         return true;
2994     }
2996     $sectiondest = $section + $move;
2998     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2999         return false;
3000     }
3002     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
3003         return false;
3004     }
3006     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
3007         return false;
3008     }
3010     // Three-step change ensures that the section always remains unique (there is
3011     // a unique index now)
3012     $DB->set_field("course_sections", "section", -$sectiondest, array("id"=>$sectionrecord->id));
3013     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
3014     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
3016     // Update highlighting if the move affects highlighted section
3017     if ($course->marker == $section) {
3018         course_set_marker($course->id, $sectiondest);
3019     } elseif ($course->marker == $sectiondest) {
3020         course_set_marker($course->id, $section);
3021     }
3023     // if the focus is on the section that is being moved, then move the focus along
3024     if (course_get_display($course->id) == $section) {
3025         course_set_display($course->id, $sectiondest);
3026     }
3028     // Fix order if needed. The database prevents duplicate sections, but it is
3029     // possible there could be a gap in the numbering.
3030     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
3031     $n = 0;
3032     foreach ($sections as $section) {
3033         if ($section->section != $n) {
3034             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
3035         }
3036         $n++;
3037     }
3038     return true;
3041 /**
3042  * Moves a section within a course, from a position to another.
3043  * Be very careful: $section and $destination refer to section number,
3044  * not id!.
3045  *
3046  * @param object $course
3047  * @param int $section Section number (not id!!!)
3048  * @param int $destination
3049  * @return boolean Result
3050  */
3051 function move_section_to($course, $section, $destination) {
3052 /// Moves a whole course section up and down within the course
3053     global $USER, $DB;
3055     if (!$destination && $destination != 0) {
3056         return true;
3057     }
3059     if ($destination > $course->numsections) {
3060         return false;
3061     }
3063     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3064     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3065             'section ASC, id ASC', 'id, section')) {
3066         return false;
3067     }
3069     $movedsections = reorder_sections($sections, $section, $destination);
3071     // Update all sections. Do this in 2 steps to avoid breaking database
3072     // uniqueness constraint
3073     $transaction = $DB->start_delegated_transaction();
3074     foreach ($movedsections as $id => $position) {
3075         if ($sections[$id] !== $position) {
3076             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3077         }
3078     }
3079     foreach ($movedsections as $id => $position) {
3080         if ($sections[$id] !== $position) {
3081             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3082         }
3083     }
3085     // Adjust destination to reflect the actual section
3086     $moveup = false;
3087     if ($section > $destination) {
3088         $destination++;
3089         $moveup = true;
3090     }
3092     // If we move the highlighted section itself, then just highlight the destination.
3093     // Adjust the higlighted section location if we move something over it either direction.
3094     if ($section == $course->marker) {
3095         course_set_marker($course, $destination);
3096     } elseif ($moveup && $section > $course->marker && $course->marker >= $destination) {
3097         course_set_marker($course, $course->marker+1);
3098     } elseif (!$moveup && $section < $course->marker && $course->marker <= $destination) {
3099         course_set_marker($course, $course->marker-1);
3100     }
3102     // if the focus is on the section that is being moved, then move the focus along
3103     if (course_get_display($course->id) == $section) {
3104         course_set_display($course->id, $destination);
3105     }
3106     $transaction->allow_commit();
3107     return true;
3110 /**
3111  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3112  * an original position number and a target position number, rebuilds the array so that the
3113  * move is made without any duplication of section positions.
3114  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3115  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3116  *
3117  * @param array $sections
3118  * @param int $origin_position
3119  * @param int $target_position
3120  * @return array
3121  */
3122 function reorder_sections($sections, $origin_position, $target_position) {
3123     if (!is_array($sections)) {
3124         return false;
3125     }
3127     // We can't move section position 0
3128     if ($origin_position < 1) {
3129         echo "We can't move section position 0";
3130         return false;
3131     }
3133     // Locate origin section in sections array
3134     if (!$origin_key = array_search($origin_position, $sections)) {
3135         echo "searched position not in sections array";
3136         return false; // searched position not in sections array
3137     }
3139     // Extract origin section
3140     $origin_section = $sections[$origin_key];
3141     unset($sections[$origin_key]);
3143     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3144     $found = false;
3145     $append_array = array();
3146     foreach ($sections as $id => $position) {
3147         if ($found) {
3148             $append_array[$id] = $position;
3149             unset($sections[$id]);
3150         }
3151         if ($position == $target_position) {
3152             $found = true;
3153         }
3154     }
3156     // Append moved section
3157     $sections[$origin_key] = $origin_section;
3159     // Append rest of array (if applicable)
3160     if (!empty($append_array)) {
3161         foreach ($append_array as $id => $position) {
3162             $sections[$id] = $position;
3163         }
3164     }
3166     // Renumber positions
3167     $position = 0;
3168     foreach ($sections as $id => $p) {
3169         $sections[$id] = $position;
3170         $position++;
3171     }
3173     return $sections;
3177 /**
3178  * Move the module object $mod to the specified $section
3179  * If $beforemod exists then that is the module
3180  * before which $modid should be inserted
3181  * All parameters are objects
3182  */
3183 function moveto_module($mod, $section, $beforemod=NULL) {
3184     global $DB, $OUTPUT;
3186 /// Remove original module from original section
3187     if (! delete_mod_from_section($mod->id, $mod->section)) {
3188         echo $OUTPUT->notification("Could not delete module from existing section");
3189     }
3191 /// Update module itself if necessary
3193     if ($mod->section != $section->id) {
3194         $mod->section = $section->id;
3195         $DB->update_record("course_modules", $mod);
3196         // if moving to a hidden section then hide module
3197         if (!$section->visible) {
3198             set_coursemodule_visible($mod->id, 0);
3199         }
3200     }
3202 /// Add the module into the new section
3204     $mod->course       = $section->course;
3205     $mod->section      = $section->section;  // need relative reference
3206     $mod->coursemodule = $mod->id;
3208     if (! add_mod_to_section($mod, $beforemod)) {
3209         return false;
3210     }
3212     return true;
3215 /**
3216  * Produces the editing buttons for a module
3217  *
3218  * @global core_renderer $OUTPUT
3219  * @staticvar type $str
3220  * @param stdClass $mod The module to produce editing buttons for
3221  * @param bool $absolute_ignored ignored - all links are absolute
3222  * @param bool $moveselect If true a move seleciton process is used (default true)
3223  * @param int $indent The current indenting
3224  * @param int $section The section to link back to
3225  * @return string XHTML for the editing buttons
3226  */
3227 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=-1) {
3228     global $CFG, $OUTPUT;
3230     static $str;
3232     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3233     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3235     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3236     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3238     // no permission to edit anything
3239     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3240         return false;
3241     }
3243     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3245     if (!isset($str)) {
3246         $str = new stdClass;
3247         $str->assign         = get_string("assignroles", 'role');
3248         $str->delete         = get_string("delete");
3249         $str->move           = get_string("move");
3250         $str->moveup         = get_string("moveup");
3251         $str->movedown       = get_string("movedown");
3252         $str->moveright      = get_string("moveright");
3253         $str->moveleft       = get_string("moveleft");
3254         $str->update         = get_string("update");
3255         $str->duplicate      = get_string("duplicate");
3256         $str->hide           = get_string("hide");
3257         $str->show           = get_string("show");
3258         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3259         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3260         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3261         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3262         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3263         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3264     }
3266     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3268     if ($section >= 0) {
3269         $baseurl->param('sr', $section);
3270     }
3271     $actions = array();
3273     // leftright
3274     if ($hasmanageactivities) {
3275         if (right_to_left()) {   // Exchange arrows on RTL
3276             $rightarrow = 't/left';
3277             $leftarrow  = 't/right';
3278         } else {
3279             $rightarrow = 't/right';
3280             $leftarrow  = 't/left';
3281         }
3283         if ($indent > 0) {
3284             $actions[] = new action_link(
3285                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3286                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3287                 null,
3288                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3289             );
3290         }
3291         if ($indent >= 0) {
3292             $actions[] = new action_link(
3293                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3294                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3295                 null,
3296                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3297             );
3298         }
3299     }
3301     // move
3302     if ($hasmanageactivities) {
3303         if ($moveselect) {
3304             $actions[] = new action_link(
3305                 new moodle_url($baseurl, array('copy' => $mod->id)),
3306                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3307                 null,
3308                 array('class' => 'editing_move', 'title' => $str->move)
3309             );
3310         } else {
3311             $actions[] = new action_link(
3312                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3313                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3314                 null,
3315                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3316             );
3317             $actions[] = new action_link(
3318                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3319                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3320                 null,
3321                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3322             );
3323         }
3324     }
3326     // Update
3327     if ($hasmanageactivities) {
3328         $actions[] = new action_link(
3329             new moodle_url($baseurl, array('update' => $mod->id)),
3330             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3331             null,
3332             array('class' => 'editing_update', 'title' => $str->update)
3333         );
3334     }
3336     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3337     if (has_all_capabilities($dupecaps, $coursecontext)) {
3338         $actions[] = new action_link(
3339             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3340             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3341             null,
3342             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3343         );
3344     }
3346     // Delete
3347     if ($hasmanageactivities) {
3348         $actions[] = new action_link(
3349             new moodle_url($baseurl, array('delete' => $mod->id)),
3350             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3351             null,
3352             array('class' => 'editing_delete', 'title' => $str->delete)
3353         );
3354     }
3356     // hideshow
3357     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3358         if ($mod->visible) {
3359             $actions[] = new action_link(
3360                 new moodle_url($baseurl, array('hide' => $mod->id)),
3361                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3362                 null,
3363                 array('class' => 'editing_hide', 'title' => $str->hide)
3364             );
3365         } else {
3366             $actions[] = new action_link(
3367                 new moodle_url($baseurl, array('show' => $mod->id)),
3368                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3369                 null,
3370                 array('class' => 'editing_show', 'title' => $str->show)
3371             );
3372         }
3373     }
3375     // groupmode
3376     if ($hasmanageactivities and $mod->groupmode !== false) {
3377         if ($mod->groupmode == SEPARATEGROUPS) {
3378             $groupmode = 0;
3379             $grouptitle = $str->groupsseparate;
3380             $forcedgrouptitle = $str->forcedgroupsseparate;
3381             $groupclass = 'editing_groupsseparate';
3382             $groupimage = 't/groups';
3383         } else if ($mod->groupmode == VISIBLEGROUPS) {
3384             $groupmode = 1;
3385             $grouptitle = $str->groupsvisible;
3386             $forcedgrouptitle = $str->forcedgroupsvisible;
3387             $groupclass = 'editing_groupsvisible';
3388             $groupimage = 't/groupv';
3389         } else {
3390             $groupmode = 2;
3391             $grouptitle = $str->groupsnone;
3392             $forcedgrouptitle = $str->forcedgroupsnone;
3393             $groupclass = 'editing_groupsnone';
3394             $groupimage = 't/groupn';
3395         }
3396         if ($mod->groupmodelink) {
3397             $actions[] = new action_link(
3398                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3399                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3400                 null,
3401                 array('class' => $groupclass, 'title' => $grouptitle)
3402             );
3403         } else {
3404             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3405         }
3406     }
3408     // Assign
3409     if (has_capability('moodle/role:assign', $modcontext)){
3410         $actions[] = new action_link(
3411             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3412             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3413             null,
3414             array('class' => 'editing_assign', 'title' => $str->assign)
3415         );
3416     }
3418     $output = html_writer::start_tag('span', array('class' => 'commands'));
3419     foreach ($actions as $action) {
3420         if ($action instanceof renderable) {
3421             $output .= $OUTPUT->render($action);
3422         } else {
3423             $output .= $action;
3424         }
3425     }
3426     $output .= html_writer::end_tag('span');
3427     return $output;
3430 /**
3431  * given a course object with shortname & fullname, this function will
3432  * truncate the the number of chars allowed and add ... if it was too long
3433  */
3434 function course_format_name ($course,$max=100) {
3436     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3437     $shortname = format_string($course->shortname, true, array('context' => $context));
3438     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3439     $str = $shortname.': '. $fullname;
3440     if (textlib::strlen($str) <= $max) {
3441         return $str;
3442     }
3443     else {
3444         return textlib::substr($str,0,$max-3).'...';
3445     }
3448 /**
3449  * Is the user allowed to add this type of module to this course?
3450  * @param object $course the course settings. Only $course->id is used.
3451  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3452  * @return bool whether the current user is allowed to add this type of module to this course.
3453  */
3454 function course_allowed_module($course, $modname) {
3455     global $DB;
3457     if (is_numeric($modname)) {
3458         throw new coding_exception('Function course_allowed_module no longer
3459                 supports numeric module ids. Please update your code to pass the module name.');
3460     }
3462     $capability = 'mod/' . $modname . ':addinstance';
3463     if (!get_capability_info($capability)) {
3464         // Debug warning that the capability does not exist, but no more than once per page.
3465         static $warned = array();
3466         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3467         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3468             debugging('The module ' . $modname . ' does not define the standard capability ' .
3469                     $capability , DEBUG_DEVELOPER);
3470             $warned[$modname] = 1;
3471         }
3473         // If the capability does not exist, the module can always be added.
3474         return true;
3475     }
3477     $coursecontext = context_course::instance($course->id);
3478     return has_capability($capability, $coursecontext);
3481 /**
3482  * Recursively delete category including all subcategories and courses.
3483  * @param stdClass $category
3484  * @param boolean $showfeedback display some notices
3485  * @return array return deleted courses
3486  */
3487 function category_delete_full($category, $showfeedback=true) {
3488     global $CFG, $DB;
3489     require_once($CFG->libdir.'/gradelib.php');
3490     require_once($CFG->libdir.'/questionlib.php');
3491     require_once($CFG->dirroot.'/cohort/lib.php');
3493     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3494         foreach ($children as $childcat) {
3495             category_delete_full($childcat, $showfeedback);
3496         }
3497     }
3499     $deletedcourses = array();
3500     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3501         foreach ($courses as $course) {
3502             if (!delete_course($course, false)) {
3503                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3504             }
3505             $deletedcourses[] = $course;
3506         }
3507     }
3509     // move or delete cohorts in this context
3510     cohort_delete_category($category);
3512     // now delete anything that may depend on course category context
3513     grade_course_category_delete($category->id, 0, $showfeedback);
3514     if (!question_delete_course_category($category, 0, $showfeedback)) {
3515         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3516     }
3518     // finally delete the category and it's context
3519     $DB->delete_records('course_categories', array('id'=>$category->id));
3520     delete_context(CONTEXT_COURSECAT, $category->id);
3522     events_trigger('course_category_deleted', $category);
3524     return $deletedcourses;
3527 /**
3528  * Delete category, but move contents to another category.
3529  * @param object $ccategory
3530  * @param int $newparentid category id
3531  * @return bool status
3532  */
3533 function category_delete_move($category, $newparentid, $showfeedback=true) {
3534     global $CFG, $DB, $OUTPUT;
3535     require_once($CFG->libdir.'/gradelib.php');
3536     require_once($CFG->libdir.'/questionlib.php');
3537     require_once($CFG->dirroot.'/cohort/lib.php');
3539     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3540         return false;
3541     }
3543     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3544         foreach ($children as $childcat) {
3545             move_category($childcat, $newparentcat);
3546         }
3547     }
3549     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3550         if (!move_courses(array_keys($courses), $newparentid)) {
3551             echo $OUTPUT->notification("Error moving courses");
3552             return false;
3553         }
3554         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3555     }
3557     // move or delete cohorts in this context
3558     cohort_delete_category($category);
3560     // now delete anything that may depend on course category context
3561     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3562     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3563         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3564         return false;
3565     }
3567     // finally delete the category and it's context
3568     $DB->delete_records('course_categories', array('id'=>$category->id));
3569     delete_context(CONTEXT_COURSECAT, $category->id);
3571     events_trigger('course_category_deleted', $category);
3573     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3575     return true;
3578 /**
3579  * Efficiently moves many courses around while maintaining
3580  * sortorder in order.
3581  *
3582  * @param array $courseids is an array of course ids
3583  * @param int $categoryid
3584  * @return bool success
3585  */
3586 function move_courses($courseids, $categoryid) {
3587     global $CFG, $DB, $OUTPUT;
3589     if (empty($courseids)) {
3590         // nothing to do
3591         return;
3592     }
3594     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3595         return false;
3596     }
3598     $courseids = array_reverse($courseids);
3599     $newparent = get_context_instance(CONTEXT_COURSECAT, $category->id);
3600     $i = 1;
3602     foreach ($courseids as $courseid) {
3603         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3604             $course = new stdClass();
3605             $course->id = $courseid;
3606             $course->category  = $category->id;
3607             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3608             if ($category->visible == 0) {
3609                 // hide the course when moving into hidden category,
3610                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3611                 $course->visible = 0;
3612             }
3614             $DB->update_record('course', $course);
3616             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3617             context_moved($context, $newparent);
3618         }
3619     }
3620     fix_course_sortorder();
3622     return true;
3625 /**
3626  * Hide course category and child course and subcategories
3627  * @param stdClass $category
3628  * @return void
3629  */
3630 function course_category_hide($category) {
3631     global $DB;
3633     $category->visible = 0;
3634     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3635     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3636     $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
3637     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3638     // get all child categories and hide too
3639     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3640         foreach ($subcats as $cat) {
3641             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3642             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3643             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3644             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3645         }
3646     }
3649 /**
3650  * Show course category and child course and subcategories
3651  * @param stdClass $category
3652  * @return void
3653  */
3654 function course_category_show($category) {
3655     global $DB;
3657     $category->visible = 1;
3658     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3659     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3660     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3661     // get all child categories and unhide too
3662     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3663         foreach ($subcats as $cat) {
3664             if ($cat->visibleold) {
3665                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3666             }
3667             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3668         }
3669     }
3672 /**
3673  * Efficiently moves a category - NOTE that this can have
3674  * a huge impact access-control-wise...
3675  */
3676 function move_category($category, $newparentcat) {
3677     global $CFG, $DB;
3679     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3681     $hidecat = false;
3682     if (empty($newparentcat->id)) {
3683         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3685         $newparent = get_context_instance(CONTEXT_SYSTEM);
3687     } else {
3688         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3689         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3691         if (!$newparentcat->visible and $category->visible) {
3692             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3693             $hidecat = true;
3694         }
3695     }
3697     context_moved($context, $newparent);
3699     // now make it last in new category
3700     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3702     // and fix the sortorders
3703     fix_course_sortorder();
3705     if ($hidecat) {
3706         course_category_hide($category);
3707     }
3710 /**
3711  * Returns the display name of the given section that the course prefers.
3712  *
3713  * This function utilizes a callback that can be implemented within the course
3714  * formats lib.php file to customize the display name that is used to reference
3715  * the section.
3716  *
3717  * By default (if callback is not defined) the method
3718  * {@see get_numeric_section_name} is called instead.
3719  *
3720  * @param stdClass $course The course to get the section name for
3721  * @param stdClass $section Section object from database
3722  * @return Display name that the course format prefers, e.g. "Week 2"
3723  *
3724  * @see get_generic_section_name
3725  */
3726 function get_section_name(stdClass $course, stdClass $section) {
3727     global $CFG;
3729     /// Inelegant hack for bug 3408
3730     if ($course->format == 'site') {
3731         return get_string('site');
3732     }
3734     // Use course formatter callback if it exists
3735     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3736     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3737     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3738         require_once $namingfile;
3739     }
3740     if (function_exists($namingfunction)) {
3741         return $namingfunction($course, $section);
3742     }
3744     // else, default behavior:
3745     return get_generic_section_name($course->format, $section);
3748 /**
3749  * Gets the generic section name for a courses section.
3750  *
3751  * @param string $format Course format ID e.g. 'weeks' $course->format
3752  * @param stdClass $section Section object from database
3753  * @return Display name that the course format prefers, e.g. "Week 2"
3754  */
3755 function get_generic_section_name($format, stdClass $section) {
3756     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3760 function course_format_uses_sections($format) {
3761     global $CFG;
3763     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3764     $featurefunction = 'callback_'.$format.'_uses_sections';
3765     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3766         require_once $featurefile;
3767     }
3768     if (function_exists($featurefunction)) {
3769         return $featurefunction();
3770     }
3772     return false;
3775 /**
3776  * Returns the information about the ajax support in the given source format
3777  *
3778  * The returned object's property (boolean)capable indicates that
3779  * the course format supports Moodle course ajax features.
3780  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3781  *
3782  * @param string $format
3783  * @return stdClass
3784  */
3785 function course_format_ajax_support($format) {
3786     global $CFG;
3788     // set up default values
3789     $ajaxsupport = new stdClass();
3790     $ajaxsupport->capable = false;
3791     $ajaxsupport->testedbrowsers = array();
3793     // get the information from the course format library
3794     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3795     $featurefunction = 'callback_'.$format.'_ajax_support';
3796     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3797         require_once $featurefile;
3798     }
3799     if (function_exists($featurefunction)) {
3800         $formatsupport = $featurefunction();
3801         if (isset($formatsupport->capable)) {
3802             $ajaxsupport->capable = $formatsupport->capable;
3803         }
3804         if (is_array($formatsupport->testedbrowsers)) {
3805             $ajaxsupport->testedbrowsers = $formatsupport->testedbrowsers;
3806         }
3807     }
3809     return $ajaxsupport;
3812 /**
3813  * Can the current user delete this course?
3814  * Course creators have exception,
3815  * 1 day after the creation they can sill delete the course.
3816  * @param int $courseid
3817  * @return boolean
3818  */
3819 function can_delete_course($courseid) {
3820     global $USER, $DB;
3822     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3824     if (has_capability('moodle/course:delete', $context)) {
3825         return true;
3826     }
3828     // hack: now try to find out if creator created this course recently (1 day)
3829     if (!has_capability('moodle/course:create', $context)) {
3830         return false;
3831     }
3833     $since = time() - 60*60*24;
3835     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3836     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3838     return $DB->record_exists_select('log', $select, $params);
3841 /**
3842  * Save the Your name for 'Some role' strings.
3843  *
3844  * @param integer $courseid the id of this course.
3845  * @param array $data the data that came from the course settings form.
3846  */
3847 function save_local_role_names($courseid, $data) {
3848     global $DB;
3849     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3851     foreach ($data as $fieldname => $value) {
3852         if (strpos($fieldname, 'role_') !== 0) {
3853             continue;
3854         }
3855         list($ignored, $roleid) = explode('_', $fieldname);
3857         // make up our mind whether we want to delete, update or insert
3858         if (!$value) {
3859             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3861         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3862             $rolename->name = $value;
3863             $DB->update_record('role_names', $rolename);
3865         } else {
3866             $rolename = new stdClass;
3867             $rolename->contextid = $context->id;
3868             $rolename->roleid = $roleid;
3869             $rolename->name = $value;
3870             $DB->insert_record('role_names', $rolename);
3871         }
3872     }
3875 /**
3876  * Create a course and either return a $course object
3877  *
3878  * Please note this functions does not verify any access control,
3879  * the calling code is responsible for all validation (usually it is the form definition).
3880  *
3881  * @param array $editoroptions course description editor options
3882  * @param object $data  - all the data needed for an entry in the 'course' table
3883  * @return object new course instance
3884  */
3885 function create_course($data, $editoroptions = NULL) {
3886     global $CFG, $DB;
3888     //check the categoryid - must be given for all new courses
3889     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3891     //check if the shortname already exist
3892     if (!empty($data->shortname)) {
3893         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3894             throw new moodle_exception('shortnametaken');
3895         }
3896     }
3898     //check if the id number already exist
3899     if (!empty($data->idnumber)) {
3900         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3901             throw new moodle_exception('idnumbertaken');
3902         }
3903     }
3905     $data->timecreated  = time();
3906     $data->timemodified = $data->timecreated;
3908     // place at beginning of any category
3909     $data->sortorder = 0;
3911     if ($editoroptions) {
3912         // summary text is updated later, we need context to store the files first
3913         $data->summary = '';
3914         $data->summary_format = FORMAT_HTML;
3915     }
3917     if (!isset($data->visible)) {
3918         // data not from form, add missing visibility info
3919         $data->visible = $category->visible;
3920     }
3921     $data->visibleold = $data->visible;
3923     $newcourseid = $DB->insert_record('course', $data);
3924     $context = get_context_instance(CONTEXT_COURSE, $newcourseid, MUST_EXIST);
3926     if ($editoroptions) {
3927         // Save the files used in the summary editor and store
3928         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3929         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3930         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3931     }
3933     $course = $DB->get_record('course', array('id'=>$newcourseid));
3935     // Setup the blocks
3936     blocks_add_default_course_blocks($course);
3938     $section = new stdClass();
3939     $section->course        = $course->id;   // Create a default section.
3940     $section->section       = 0;
3941     $section->summaryformat = FORMAT_HTML;
3942     $DB->insert_record('course_sections', $section);
3944     fix_course_sortorder();
3946     // new context created - better mark it as dirty
3947     mark_context_dirty($context->path);
3949     // Save any custom role names.
3950     save_local_role_names($course->id, (array)$data);
3952     // set up enrolments
3953     enrol_course_updated(true, $course, $data);
3955     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3957     // Trigger events
3958     events_trigger('course_created', $course);
3960     return $course;
3963 /**
3964  * Create a new course category and marks the context as dirty
3965  *
3966  * This function does not set the sortorder for the new category and
3967  * @see{fix_course_sortorder} should be called after creating a new course
3968  * category
3969  *
3970  * Please note that this function does not verify access control.
3971  *
3972  * @param object $category All of the data required for an entry in the course_categories table
3973  * @return object new course category
3974  */
3975 function create_course_category($category) {
3976     global $DB;
3978     $category->timemodified = time();
3979     $category->id = $DB->insert_record('course_categories', $category);
3980     $category = $DB->get_record('course_categories', array('id' => $category->id));
3982     // We should mark the context as dirty
3983     $category->context = context_coursecat::instance($category->id);
3984     $category->context->mark_dirty();
3986     return $category;
3989 /**
3990  * Update a course.
3991  *
3992  * Please note this functions does not verify any access control,
3993  * the calling code is responsible for all validation (usually it is the form definition).
3994  *
3995  * @param object $data  - all the data needed for an entry in the 'course' table
3996  * @param array $editoroptions course description editor options
3997  * @return void
3998  */
3999 function update_course($data, $editoroptions = NULL) {
4000     global $CFG, $DB;
4002     $data->timemodified = time();
4004     $oldcourse = $DB->get_record('course', array('id'=>$data->id), '*', MUST_EXIST);
4005     $context   = get_context_instance(CONTEXT_COURSE, $oldcourse->id);
4007     if ($editoroptions) {
4008         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
4009     }
4011     if (!isset($data->category) or empty($data->category)) {
4012         // prevent nulls and 0 in category field
4013         unset($data->category);
4014     }
4015     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
4017     if (!isset($data->visible)) {
4018         // data not from form, add missing visibility info
4019         $data->visible = $oldcourse->visible;
4020     }
4022     if ($data->visible != $oldcourse->visible) {
4023         // reset the visibleold flag when manually hiding/unhiding course
4024         $data->visibleold = $data->visible;
4025     } else {
4026         if ($movecat) {
4027             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
4028             if (empty($newcategory->visible)) {
4029                 // make sure when moving into hidden category the course is hidden automatically
4030                 $data->visible = 0;
4031             }
4032         }
4033     }
4035     // Update with the new data
4036     $DB->update_record('course', $data);
4038     $course = $DB->get_record('course', array('id'=>$data->id));
4040     if ($movecat) {
4041         $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
4042         context_moved($context, $newparent);
4043     }
4045     fix_course_sortorder();
4047     // Test for and remove blocks which aren't appropriate anymore
4048     blocks_remove_inappropriate($course);
4050     // Save any custom role names.
4051     save_local_role_names($course->id, $data);
4053     // update enrol settings
4054     enrol_course_updated(false, $course, $data);
4056     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
4058     // Trigger events
4059     events_trigger('course_updated', $course);
4062 /**
4063  * Average number of participants
4064  * @return integer
4065  */
4066 function average_number_of_participants() {
4067     global $DB, $SITE;
4069     //count total of enrolments for visible course (except front page)
4070     $sql = 'SELECT COUNT(*) FROM (
4071         SELECT DISTINCT ue.userid, e.courseid
4072         FROM {user_enrolments} ue, {enrol} e, {course} c
4073         WHERE ue.enrolid = e.id
4074             AND e.courseid <> :siteid
4075             AND c.id = e.courseid
4076             AND c.visible = 1) as total';
4077     $params = array('siteid' => $SITE->id);
4078     $enrolmenttotal = $DB->count_records_sql($sql, $params);
4081     //count total of visible courses (minus front page)
4082     $coursetotal = $DB->count_records('course', array('visible' => 1));
4083     $coursetotal = $coursetotal - 1 ;
4085     //average of enrolment
4086     if (empty($coursetotal)) {
4087         $participantaverage = 0;
4088     } else {
4089         $participantaverage = $enrolmenttotal / $coursetotal;
4090     }
4092     return $participantaverage;
4095 /**
4096  * Average number of course modules
4097  * @return integer
4098  */
4099 function average_number_of_courses_modules() {
4100     global $DB, $SITE;
4102     //count total of visible course module (except front page)
4103     $sql = 'SELECT COUNT(*) FROM (
4104         SELECT cm.course, cm.module
4105         FROM {course} c, {course_modules} cm
4106         WHERE c.id = cm.course
4107             AND c.id <> :siteid
4108             AND cm.visible = 1
4109             AND c.visible = 1) as total';
4110     $params = array('siteid' => $SITE->id);
4111     $moduletotal = $DB->count_records_sql($sql, $params);
4114     //count total of visible courses (minus front page)
4115     $coursetotal = $DB->count_records('course', array('visible' => 1));
4116     $coursetotal = $coursetotal - 1 ;
4118     //average of course module
4119     if (empty($coursetotal)) {
4120         $coursemoduleaverage = 0;
4121     } else {
4122         $coursemoduleaverage = $moduletotal / $coursetotal;
4123     }
4125     return $coursemoduleaverage;
4128 /**
4129  * This class pertains to course requests and contains methods associated with
4130  * create, approving, and removing course requests.
4131  *
4132  * Please note we do not allow embedded images here because there is no context
4133  * to store them with proper access control.
4134  *
4135  * @copyright 2009 Sam Hemelryk
4136  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4137  * @since Moodle 2.0
4138  *
4139  * @property-read int $id
4140  * @property-read string $fullname
4141  * @property-read string $shortname
4142  * @property-read string $summary
4143  * @property-read int $summaryformat
4144  * @property-read int $summarytrust
4145  * @property-read string $reason
4146  * @property-read int $requester
4147  */
4148 class course_request {
4150     /**
4151      * This is the stdClass that stores the properties for the course request
4152      * and is externally accessed through the __get magic method
4153      * @var stdClass
4154      */
4155     protected $properties;
4157     /**
4158      * An array of options for the summary editor used by course request forms.
4159      * This is initially set by {@link summary_editor_options()}
4160      * @var array
4161      * @static
4162      */
4163     protected static $summaryeditoroptions;
4165     /**
4166      * Static function to prepare the summary editor for working with a course
4167      * request.
4168      *
4169      * @static
4170      * @param null|stdClass $data Optional, an object containing the default values
4171      *                       for the form, these may be modified when preparing the
4172      *                       editor so this should be called before creating the form