33786e18d55ca7d14f5300152c2fa8fb4be06640
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->dirroot.'/course/dnduploadlib.php');
32 require_once($CFG->dirroot.'/course/format/lib.php');
34 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
36 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
37 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
38 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
39 define('FRONTPAGENEWS',           '0');
40 define('FRONTPAGECOURSELIST',     '1');
41 define('FRONTPAGECATEGORYNAMES',  '2');
42 define('FRONTPAGETOPICONLY',      '3');
43 define('FRONTPAGECATEGORYCOMBO',  '4');
44 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
45 define('EXCELROWS', 65535);
46 define('FIRSTUSEDEXCELROW', 3);
48 define('MOD_CLASS_ACTIVITY', 0);
49 define('MOD_CLASS_RESOURCE', 1);
51 function make_log_url($module, $url) {
52     switch ($module) {
53         case 'course':
54             if (strpos($url, 'report/') === 0) {
55                 // there is only one report type, course reports are deprecated
56                 $url = "/$url";
57                 break;
58             }
59         case 'file':
60         case 'login':
61         case 'lib':
62         case 'admin':
63         case 'calendar':
64         case 'mnet course':
65             if (strpos($url, '../') === 0) {
66                 $url = ltrim($url, '.');
67             } else {
68                 $url = "/course/$url";
69             }
70             break;
71         case 'user':
72         case 'blog':
73             $url = "/$module/$url";
74             break;
75         case 'upload':
76             $url = $url;
77             break;
78         case 'coursetags':
79             $url = '/'.$url;
80             break;
81         case 'library':
82         case '':
83             $url = '/';
84             break;
85         case 'message':
86             $url = "/message/$url";
87             break;
88         case 'notes':
89             $url = "/notes/$url";
90             break;
91         case 'tag':
92             $url = "/tag/$url";
93             break;
94         case 'role':
95             $url = '/'.$url;
96             break;
97         default:
98             $url = "/mod/$module/$url";
99             break;
100     }
102     //now let's sanitise urls - there might be some ugly nasties:-(
103     $parts = explode('?', $url);
104     $script = array_shift($parts);
105     if (strpos($script, 'http') === 0) {
106         $script = clean_param($script, PARAM_URL);
107     } else {
108         $script = clean_param($script, PARAM_PATH);
109     }
111     $query = '';
112     if ($parts) {
113         $query = implode('', $parts);
114         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
115         $parts = explode('&', $query);
116         $eq = urlencode('=');
117         foreach ($parts as $key=>$part) {
118             $part = urlencode(urldecode($part));
119             $part = str_replace($eq, '=', $part);
120             $parts[$key] = $part;
121         }
122         $query = '?'.implode('&amp;', $parts);
123     }
125     return $script.$query;
129 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
130                    $modname="", $modid=0, $modaction="", $groupid=0) {
131     global $CFG, $DB;
133     // It is assumed that $date is the GMT time of midnight for that day,
134     // and so the next 86400 seconds worth of logs are printed.
136     /// Setup for group handling.
138     // TODO: I don't understand group/context/etc. enough to be able to do
139     // something interesting with it here
140     // What is the context of a remote course?
142     /// If the group mode is separate, and this user does not have editing privileges,
143     /// then only the user's group can be viewed.
144     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
145     //    $groupid = get_current_group($course->id);
146     //}
147     /// If this course doesn't have groups, no groupid can be specified.
148     //else if (!$course->groupmode) {
149     //    $groupid = 0;
150     //}
152     $groupid = 0;
154     $joins = array();
155     $where = '';
157     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
158               FROM {mnet_log} l
159                LEFT JOIN {user} u ON l.userid = u.id
160               WHERE ";
161     $params = array();
163     $where .= "l.hostid = :hostid";
164     $params['hostid'] = $hostid;
166     // TODO: Is 1 really a magic number referring to the sitename?
167     if ($course != SITEID || $modid != 0) {
168         $where .= " AND l.course=:courseid";
169         $params['courseid'] = $course;
170     }
172     if ($modname) {
173         $where .= " AND l.module = :modname";
174         $params['modname'] = $modname;
175     }
177     if ('site_errors' === $modid) {
178         $where .= " AND ( l.action='error' OR l.action='infected' )";
179     } else if ($modid) {
180         //TODO: This assumes that modids are the same across sites... probably
181         //not true
182         $where .= " AND l.cmid = :modid";
183         $params['modid'] = $modid;
184     }
186     if ($modaction) {
187         $firstletter = substr($modaction, 0, 1);
188         if ($firstletter == '-') {
189             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
190             $params['modaction'] = '%'.substr($modaction, 1).'%';
191         } else {
192             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
193             $params['modaction'] = '%'.$modaction.'%';
194         }
195     }
197     if ($user) {
198         $where .= " AND l.userid = :user";
199         $params['user'] = $user;
200     }
202     if ($date) {
203         $enddate = $date + 86400;
204         $where .= " AND l.time > :date AND l.time < :enddate";
205         $params['date'] = $date;
206         $params['enddate'] = $enddate;
207     }
209     $result = array();
210     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
211     if(!empty($result['totalcount'])) {
212         $where .= " ORDER BY $order";
213         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
214     } else {
215         $result['logs'] = array();
216     }
217     return $result;
220 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
221                    $modname="", $modid=0, $modaction="", $groupid=0) {
222     global $DB, $SESSION, $USER;
223     // It is assumed that $date is the GMT time of midnight for that day,
224     // and so the next 86400 seconds worth of logs are printed.
226     /// Setup for group handling.
228     /// If the group mode is separate, and this user does not have editing privileges,
229     /// then only the user's group can be viewed.
230     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
231         if (isset($SESSION->currentgroup[$course->id])) {
232             $groupid =  $SESSION->currentgroup[$course->id];
233         } else {
234             $groupid = groups_get_all_groups($course->id, $USER->id);
235             if (is_array($groupid)) {
236                 $groupid = array_shift(array_keys($groupid));
237                 $SESSION->currentgroup[$course->id] = $groupid;
238             } else {
239                 $groupid = 0;
240             }
241         }
242     }
243     /// If this course doesn't have groups, no groupid can be specified.
244     else if (!$course->groupmode) {
245         $groupid = 0;
246     }
248     $joins = array();
249     $params = array();
251     if ($course->id != SITEID || $modid != 0) {
252         $joins[] = "l.course = :courseid";
253         $params['courseid'] = $course->id;
254     }
256     if ($modname) {
257         $joins[] = "l.module = :modname";
258         $params['modname'] = $modname;
259     }
261     if ('site_errors' === $modid) {
262         $joins[] = "( l.action='error' OR l.action='infected' )";
263     } else if ($modid) {
264         $joins[] = "l.cmid = :modid";
265         $params['modid'] = $modid;
266     }
268     if ($modaction) {
269         $firstletter = substr($modaction, 0, 1);
270         if ($firstletter == '-') {
271             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
272             $params['modaction'] = '%'.substr($modaction, 1).'%';
273         } else {
274             $joins[] = $DB->sql_like('l.action', ':modaction', false);
275             $params['modaction'] = '%'.$modaction.'%';
276         }
277     }
280     /// Getting all members of a group.
281     if ($groupid and !$user) {
282         if ($gusers = groups_get_members($groupid)) {
283             $gusers = array_keys($gusers);
284             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
285         } else {
286             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
287         }
288     }
289     else if ($user) {
290         $joins[] = "l.userid = :userid";
291         $params['userid'] = $user;
292     }
294     if ($date) {
295         $enddate = $date + 86400;
296         $joins[] = "l.time > :date AND l.time < :enddate";
297         $params['date'] = $date;
298         $params['enddate'] = $enddate;
299     }
301     $selector = implode(' AND ', $joins);
303     $totalcount = 0;  // Initialise
304     $result = array();
305     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
306     $result['totalcount'] = $totalcount;
307     return $result;
311 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
312                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
314     global $CFG, $DB, $OUTPUT;
316     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
317                        $modname, $modid, $modaction, $groupid)) {
318         echo $OUTPUT->notification("No logs found!");
319         echo $OUTPUT->footer();
320         exit;
321     }
323     $courses = array();
325     if ($course->id == SITEID) {
326         $courses[0] = '';
327         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
328             foreach ($ccc as $cc) {
329                 $courses[$cc->id] = $cc->shortname;
330             }
331         }
332     } else {
333         $courses[$course->id] = $course->shortname;
334     }
336     $totalcount = $logs['totalcount'];
337     $count=0;
338     $ldcache = array();
339     $tt = getdate(time());
340     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
342     $strftimedatetime = get_string("strftimedatetime");
344     echo "<div class=\"info\">\n";
345     print_string("displayingrecords", "", $totalcount);
346     echo "</div>\n";
348     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
350     $table = new html_table();
351     $table->classes = array('logtable','generalbox');
352     $table->align = array('right', 'left', 'left');
353     $table->head = array(
354         get_string('time'),
355         get_string('ip_address'),
356         get_string('fullnameuser'),
357         get_string('action'),
358         get_string('info')
359     );
360     $table->data = array();
362     if ($course->id == SITEID) {
363         array_unshift($table->align, 'left');
364         array_unshift($table->head, get_string('course'));
365     }
367     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
368     if (empty($logs['logs'])) {
369         $logs['logs'] = array();
370     }
372     foreach ($logs['logs'] as $log) {
374         if (isset($ldcache[$log->module][$log->action])) {
375             $ld = $ldcache[$log->module][$log->action];
376         } else {
377             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
378             $ldcache[$log->module][$log->action] = $ld;
379         }
380         if ($ld && is_numeric($log->info)) {
381             // ugly hack to make sure fullname is shown correctly
382             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
383                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
384             } else {
385                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
386             }
387         }
389         //Filter log->info
390         $log->info = format_string($log->info);
392         // If $log->url has been trimmed short by the db size restriction
393         // code in add_to_log, keep a note so we don't add a link to a broken url
394         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
396         $row = array();
397         if ($course->id == SITEID) {
398             if (empty($log->course)) {
399                 $row[] = get_string('site');
400             } else {
401                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
402             }
403         }
405         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
407         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
408         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
410         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id))));
412         $displayaction="$log->module $log->action";
413         if ($brokenurl) {
414             $row[] = $displayaction;
415         } else {
416             $link = make_log_url($log->module,$log->url);
417             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
418         }
419         $row[] = $log->info;
420         $table->data[] = $row;
421     }
423     echo html_writer::table($table);
424     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
428 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
429                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
431     global $CFG, $DB, $OUTPUT;
433     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
434                        $modname, $modid, $modaction, $groupid)) {
435         echo $OUTPUT->notification("No logs found!");
436         echo $OUTPUT->footer();
437         exit;
438     }
440     if ($course->id == SITEID) {
441         $courses[0] = '';
442         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
443             foreach ($ccc as $cc) {
444                 $courses[$cc->id] = $cc->shortname;
445             }
446         }
447     }
449     $totalcount = $logs['totalcount'];
450     $count=0;
451     $ldcache = array();
452     $tt = getdate(time());
453     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
455     $strftimedatetime = get_string("strftimedatetime");
457     echo "<div class=\"info\">\n";
458     print_string("displayingrecords", "", $totalcount);
459     echo "</div>\n";
461     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
463     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
464     echo "<tr>";
465     if ($course->id == SITEID) {
466         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
467     }
468     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
469     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
470     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
471     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
472     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
473     echo "</tr>\n";
475     if (empty($logs['logs'])) {
476         echo "</table>\n";
477         return;
478     }
480     $row = 1;
481     foreach ($logs['logs'] as $log) {
483         $log->info = $log->coursename;
484         $row = ($row + 1) % 2;
486         if (isset($ldcache[$log->module][$log->action])) {
487             $ld = $ldcache[$log->module][$log->action];
488         } else {
489             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
490             $ldcache[$log->module][$log->action] = $ld;
491         }
492         if (0 && $ld && !empty($log->info)) {
493             // ugly hack to make sure fullname is shown correctly
494             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
495                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
496             } else {
497                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
498             }
499         }
501         //Filter log->info
502         $log->info = format_string($log->info);
504         echo '<tr class="r'.$row.'">';
505         if ($course->id == SITEID) {
506             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
507             echo "<td class=\"r$row c0\" >\n";
508             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
509             echo "</td>\n";
510         }
511         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
512              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
513         echo "<td class=\"r$row c2\" >\n";
514         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
515         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
516         echo "</td>\n";
517         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
518         echo "<td class=\"r$row c3\" >\n";
519         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
520         echo "</td>\n";
521         echo "<td class=\"r$row c4\">\n";
522         echo $log->action .': '.$log->module;
523         echo "</td>\n";;
524         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
525         echo "</tr>\n";
526     }
527     echo "</table>\n";
529     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
533 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
534                         $modid, $modaction, $groupid) {
535     global $DB, $CFG;
537     require_once($CFG->libdir . '/csvlib.class.php');
539     $csvexporter = new csv_export_writer('tab');
541     $header = array();
542     $header[] = get_string('course');
543     $header[] = get_string('time');
544     $header[] = get_string('ip_address');
545     $header[] = get_string('fullnameuser');
546     $header[] = get_string('action');
547     $header[] = get_string('info');
549     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
550                        $modname, $modid, $modaction, $groupid)) {
551         return false;
552     }
554     $courses = array();
556     if ($course->id == SITEID) {
557         $courses[0] = '';
558         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
559             foreach ($ccc as $cc) {
560                 $courses[$cc->id] = $cc->shortname;
561             }
562         }
563     } else {
564         $courses[$course->id] = $course->shortname;
565     }
567     $count=0;
568     $ldcache = array();
569     $tt = getdate(time());
570     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
572     $strftimedatetime = get_string("strftimedatetime");
574     $csvexporter->set_filename('logs', '.txt');
575     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
576     $csvexporter->add_data($title);
577     $csvexporter->add_data($header);
579     if (empty($logs['logs'])) {
580         return true;
581     }
583     foreach ($logs['logs'] as $log) {
584         if (isset($ldcache[$log->module][$log->action])) {
585             $ld = $ldcache[$log->module][$log->action];
586         } else {
587             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
588             $ldcache[$log->module][$log->action] = $ld;
589         }
590         if ($ld && !empty($log->info)) {
591             // ugly hack to make sure fullname is shown correctly
592             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
593                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
594             } else {
595                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
596             }
597         }
599         //Filter log->info
600         $log->info = format_string($log->info);
601         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
603         $coursecontext = context_course::instance($course->id);
604         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
605         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
606         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);\r
607         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
608         $csvexporter->add_data($row);
609     }
610     $csvexporter->download_file();
611     return true;
615 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
616                         $modid, $modaction, $groupid) {
618     global $CFG, $DB;
620     require_once("$CFG->libdir/excellib.class.php");
622     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
623                        $modname, $modid, $modaction, $groupid)) {
624         return false;
625     }
627     $courses = array();
629     if ($course->id == SITEID) {
630         $courses[0] = '';
631         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
632             foreach ($ccc as $cc) {
633                 $courses[$cc->id] = $cc->shortname;
634             }
635         }
636     } else {
637         $courses[$course->id] = $course->shortname;
638     }
640     $count=0;
641     $ldcache = array();
642     $tt = getdate(time());
643     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
645     $strftimedatetime = get_string("strftimedatetime");
647     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
648     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
649     $filename .= '.xls';
651     $workbook = new MoodleExcelWorkbook('-');
652     $workbook->send($filename);
654     $worksheet = array();
655     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
656                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
658     // Creating worksheets
659     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
660         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
661         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
662         $worksheet[$wsnumber]->set_column(1, 1, 30);
663         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
664                                     userdate(time(), $strftimedatetime));
665         $col = 0;
666         foreach ($headers as $item) {
667             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
668             $col++;
669         }
670     }
672     if (empty($logs['logs'])) {
673         $workbook->close();
674         return true;
675     }
677     $formatDate =& $workbook->add_format();
678     $formatDate->set_num_format(get_string('log_excel_date_format'));
680     $row = FIRSTUSEDEXCELROW;
681     $wsnumber = 1;
682     $myxls =& $worksheet[$wsnumber];
683     foreach ($logs['logs'] as $log) {
684         if (isset($ldcache[$log->module][$log->action])) {
685             $ld = $ldcache[$log->module][$log->action];
686         } else {
687             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
688             $ldcache[$log->module][$log->action] = $ld;
689         }
690         if ($ld && !empty($log->info)) {
691             // ugly hack to make sure fullname is shown correctly
692             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
693                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
694             } else {
695                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
696             }
697         }
699         // Filter log->info
700         $log->info = format_string($log->info);
701         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
703         if ($nroPages>1) {
704             if ($row > EXCELROWS) {
705                 $wsnumber++;
706                 $myxls =& $worksheet[$wsnumber];
707                 $row = FIRSTUSEDEXCELROW;
708             }
709         }
711         $coursecontext = context_course::instance($course->id);
713         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
714         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
715         $myxls->write($row, 2, $log->ip, '');
716         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
717         $myxls->write($row, 3, $fullname, '');
718         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
719         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
720         $myxls->write($row, 5, $log->info, '');
722         $row++;
723     }
725     $workbook->close();
726     return true;
729 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
730                         $modid, $modaction, $groupid) {
732     global $CFG, $DB;
734     require_once("$CFG->libdir/odslib.class.php");
736     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
737                        $modname, $modid, $modaction, $groupid)) {
738         return false;
739     }
741     $courses = array();
743     if ($course->id == SITEID) {
744         $courses[0] = '';
745         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
746             foreach ($ccc as $cc) {
747                 $courses[$cc->id] = $cc->shortname;
748             }
749         }
750     } else {
751         $courses[$course->id] = $course->shortname;
752     }
754     $count=0;
755     $ldcache = array();
756     $tt = getdate(time());
757     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
759     $strftimedatetime = get_string("strftimedatetime");
761     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
762     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
763     $filename .= '.ods';
765     $workbook = new MoodleODSWorkbook('-');
766     $workbook->send($filename);
768     $worksheet = array();
769     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
770                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
772     // Creating worksheets
773     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
774         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
775         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
776         $worksheet[$wsnumber]->set_column(1, 1, 30);
777         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
778                                     userdate(time(), $strftimedatetime));
779         $col = 0;
780         foreach ($headers as $item) {
781             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
782             $col++;
783         }
784     }
786     if (empty($logs['logs'])) {
787         $workbook->close();
788         return true;
789     }
791     $formatDate =& $workbook->add_format();
792     $formatDate->set_num_format(get_string('log_excel_date_format'));
794     $row = FIRSTUSEDEXCELROW;
795     $wsnumber = 1;
796     $myxls =& $worksheet[$wsnumber];
797     foreach ($logs['logs'] as $log) {
798         if (isset($ldcache[$log->module][$log->action])) {
799             $ld = $ldcache[$log->module][$log->action];
800         } else {
801             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
802             $ldcache[$log->module][$log->action] = $ld;
803         }
804         if ($ld && !empty($log->info)) {
805             // ugly hack to make sure fullname is shown correctly
806             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
807                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
808             } else {
809                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
810             }
811         }
813         // Filter log->info
814         $log->info = format_string($log->info);
815         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
817         if ($nroPages>1) {
818             if ($row > EXCELROWS) {
819                 $wsnumber++;
820                 $myxls =& $worksheet[$wsnumber];
821                 $row = FIRSTUSEDEXCELROW;
822             }
823         }
825         $coursecontext = context_course::instance($course->id);
827         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
828         $myxls->write_date($row, 1, $log->time);
829         $myxls->write_string($row, 2, $log->ip);
830         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
831         $myxls->write_string($row, 3, $fullname);
832         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
833         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
834         $myxls->write_string($row, 5, $log->info);
836         $row++;
837     }
839     $workbook->close();
840     return true;
844 function print_overview($courses, array $remote_courses=array()) {
845     global $CFG, $USER, $DB, $OUTPUT;
847     $htmlarray = array();
848     if ($modules = $DB->get_records('modules')) {
849         foreach ($modules as $mod) {
850             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
851                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
852                 $fname = $mod->name.'_print_overview';
853                 if (function_exists($fname)) {
854                     $fname($courses,$htmlarray);
855                 }
856             }
857         }
858     }
859     foreach ($courses as $course) {
860         $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
861         echo $OUTPUT->box_start('coursebox');
862         $attributes = array('title' => s($fullname));
863         if (empty($course->visible)) {
864             $attributes['class'] = 'dimmed';
865         }
866         echo $OUTPUT->heading(html_writer::link(
867             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
868         if (array_key_exists($course->id,$htmlarray)) {
869             foreach ($htmlarray[$course->id] as $modname => $html) {
870                 echo $html;
871             }
872         }
873         echo $OUTPUT->box_end();
874     }
876     if (!empty($remote_courses)) {
877         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
878     }
879     foreach ($remote_courses as $course) {
880         echo $OUTPUT->box_start('coursebox');
881         $attributes = array('title' => s($course->fullname));
882         echo $OUTPUT->heading(html_writer::link(
883             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
884             format_string($course->shortname),
885             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
886         echo $OUTPUT->box_end();
887     }
891 /**
892  * This function trawls through the logs looking for
893  * anything new since the user's last login
894  */
895 function print_recent_activity($course) {
896     // $course is an object
897     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
899     $context = context_course::instance($course->id);
901     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
903     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
905     if (!isguestuser()) {
906         if (!empty($USER->lastcourseaccess[$course->id])) {
907             if ($USER->lastcourseaccess[$course->id] > $timestart) {
908                 $timestart = $USER->lastcourseaccess[$course->id];
909             }
910         }
911     }
913     echo '<div class="activitydate">';
914     echo get_string('activitysince', '', userdate($timestart));
915     echo '</div>';
916     echo '<div class="activityhead">';
918     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
920     echo "</div>\n";
922     $content = false;
924 /// Firstly, have there been any new enrolments?
926     $users = get_recent_enrolments($course->id, $timestart);
928     //Accessibility: new users now appear in an <OL> list.
929     if ($users) {
930         echo '<div class="newusers">';
931         echo $OUTPUT->heading(get_string("newusers").':', 3);
932         $content = true;
933         echo "<ol class=\"list\">\n";
934         foreach ($users as $user) {
935             $fullname = fullname($user, $viewfullnames);
936             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
937         }
938         echo "</ol>\n</div>\n";
939     }
941 /// Next, have there been any modifications to the course structure?
943     $modinfo = get_fast_modinfo($course);
945     $changelist = array();
947     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
948                                             module = 'course' AND
949                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
950                                     array($timestart, $course->id), "id ASC");
952     if ($logs) {
953         $actions  = array('add mod', 'update mod', 'delete mod');
954         $newgones = array(); // added and later deleted items
955         foreach ($logs as $key => $log) {
956             if (!in_array($log->action, $actions)) {
957                 continue;
958             }
959             $info = explode(' ', $log->info);
961             // note: in most cases I replaced hardcoding of label with use of
962             // $cm->has_view() but it was not possible to do this here because
963             // we don't necessarily have the $cm for it
964             if ($info[0] == 'label') {     // Labels are ignored in recent activity
965                 continue;
966             }
968             if (count($info) != 2) {
969                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
970                 continue;
971             }
973             $modname    = $info[0];
974             $instanceid = $info[1];
976             if ($log->action == 'delete mod') {
977                 // unfortunately we do not know if the mod was visible
978                 if (!array_key_exists($log->info, $newgones)) {
979                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
980                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
981                 }
982             } else {
983                 if (!isset($modinfo->instances[$modname][$instanceid])) {
984                     if ($log->action == 'add mod') {
985                         // do not display added and later deleted activities
986                         $newgones[$log->info] = true;
987                     }
988                     continue;
989                 }
990                 $cm = $modinfo->instances[$modname][$instanceid];
991                 if (!$cm->uservisible) {
992                     continue;
993                 }
995                 if ($log->action == 'add mod') {
996                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
997                     $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>");
999                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
1000                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
1001                     $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>");
1002                 }
1003             }
1004         }
1005     }
1007     if (!empty($changelist)) {
1008         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1009         $content = true;
1010         foreach ($changelist as $changeinfo => $change) {
1011             echo '<p class="activity">'.$change['text'].'</p>';
1012         }
1013     }
1015 /// Now display new things from each module
1017     $usedmodules = array();
1018     foreach($modinfo->cms as $cm) {
1019         if (isset($usedmodules[$cm->modname])) {
1020             continue;
1021         }
1022         if (!$cm->uservisible) {
1023             continue;
1024         }
1025         $usedmodules[$cm->modname] = $cm->modname;
1026     }
1028     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1029         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1030             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1031             $print_recent_activity = $modname.'_print_recent_activity';
1032             if (function_exists($print_recent_activity)) {
1033                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1034                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1035             }
1036         } else {
1037             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1038         }
1039     }
1041     if (! $content) {
1042         echo '<p class="message">'.get_string('nothingnew').'</p>';
1043     }
1046 /**
1047  * For a given course, returns an array of course activity objects
1048  * Each item in the array contains he following properties:
1049  */
1050 function get_array_of_activities($courseid) {
1051 //  cm - course module id
1052 //  mod - name of the module (eg forum)
1053 //  section - the number of the section (eg week or topic)
1054 //  name - the name of the instance
1055 //  visible - is the instance visible or not
1056 //  groupingid - grouping id
1057 //  groupmembersonly - is this instance visible to group members only
1058 //  extra - contains extra string to include in any link
1059     global $CFG, $DB;
1060     if(!empty($CFG->enableavailability)) {
1061         require_once($CFG->libdir.'/conditionlib.php');
1062     }
1064     $course = $DB->get_record('course', array('id'=>$courseid));
1066     if (empty($course)) {
1067         throw new moodle_exception('courseidnotfound');
1068     }
1070     $mod = array();
1072     $rawmods = get_course_mods($courseid);
1073     if (empty($rawmods)) {
1074         return $mod; // always return array
1075     }
1077     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1078        foreach ($sections as $section) {
1079            if (!empty($section->sequence)) {
1080                $sequence = explode(",", $section->sequence);
1081                foreach ($sequence as $seq) {
1082                    if (empty($rawmods[$seq])) {
1083                        continue;
1084                    }
1085                    $mod[$seq] = new stdClass();
1086                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1087                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1088                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1090                     // Oh dear. Inconsistent names left here for backward compatibility.
1091                    $mod[$seq]->section          = $section->section;
1092                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1094                    $mod[$seq]->module           = $rawmods[$seq]->module;
1095                    $mod[$seq]->added            = $rawmods[$seq]->added;
1096                    $mod[$seq]->score            = $rawmods[$seq]->score;
1097                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1098                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1099                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1100                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1101                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1102                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1103                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1104                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1105                    $mod[$seq]->extra            = "";
1106                    $mod[$seq]->completiongradeitemnumber =
1107                            $rawmods[$seq]->completiongradeitemnumber;
1108                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1109                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1110                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1111                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1112                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1113                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1114                    if (!empty($CFG->enableavailability)) {
1115                        condition_info::fill_availability_conditions($rawmods[$seq]);
1116                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1117                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1118                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
1119                    }
1121                    $modname = $mod[$seq]->mod;
1122                    $functionname = $modname."_get_coursemodule_info";
1124                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1125                        continue;
1126                    }
1128                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1130                    if ($hasfunction = function_exists($functionname)) {
1131                        if ($info = $functionname($rawmods[$seq])) {
1132                            if (!empty($info->icon)) {
1133                                $mod[$seq]->icon = $info->icon;
1134                            }
1135                            if (!empty($info->iconcomponent)) {
1136                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1137                            }
1138                            if (!empty($info->name)) {
1139                                $mod[$seq]->name = $info->name;
1140                            }
1141                            if ($info instanceof cached_cm_info) {
1142                                // When using cached_cm_info you can include three new fields
1143                                // that aren't available for legacy code
1144                                if (!empty($info->content)) {
1145                                    $mod[$seq]->content = $info->content;
1146                                }
1147                                if (!empty($info->extraclasses)) {
1148                                    $mod[$seq]->extraclasses = $info->extraclasses;
1149                                }
1150                                if (!empty($info->iconurl)) {
1151                                    $mod[$seq]->iconurl = $info->iconurl;
1152                                }
1153                                if (!empty($info->onclick)) {
1154                                    $mod[$seq]->onclick = $info->onclick;
1155                                }
1156                                if (!empty($info->customdata)) {
1157                                    $mod[$seq]->customdata = $info->customdata;
1158                                }
1159                            } else {
1160                                // When using a stdclass, the (horrible) deprecated ->extra field
1161                                // is available for BC
1162                                if (!empty($info->extra)) {
1163                                    $mod[$seq]->extra = $info->extra;
1164                                }
1165                            }
1166                        }
1167                    }
1168                    // When there is no modname_get_coursemodule_info function,
1169                    // but showdescriptions is enabled, then we use the 'intro'
1170                    // and 'introformat' fields in the module table
1171                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1172                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1173                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1174                            // Set content from intro and introformat. Filters are disabled
1175                            // because we  filter it with format_text at display time
1176                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1177                                    $modvalues, $rawmods[$seq]->id, false);
1179                            // To save making another query just below, put name in here
1180                            $mod[$seq]->name = $modvalues->name;
1181                        }
1182                    }
1183                    if (!isset($mod[$seq]->name)) {
1184                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1185                    }
1187                    // Minimise the database size by unsetting default options when they are
1188                    // 'empty'. This list corresponds to code in the cm_info constructor.
1189                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1190                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1191                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1192                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1193                            'completionview', 'completionexpected', 'score', 'showdescription')
1194                            as $property) {
1195                        if (property_exists($mod[$seq], $property) &&
1196                                empty($mod[$seq]->{$property})) {
1197                            unset($mod[$seq]->{$property});
1198                        }
1199                    }
1200                    // Special case: this value is usually set to null, but may be 0
1201                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1202                            is_null($mod[$seq]->completiongradeitemnumber)) {
1203                        unset($mod[$seq]->completiongradeitemnumber);
1204                    }
1205                }
1206             }
1207         }
1208     }
1209     return $mod;
1212 /**
1213  * Returns the localised human-readable names of all used modules
1214  *
1215  * @param bool $plural if true returns the plural forms of the names
1216  * @return array where key is the module name (component name without 'mod_') and
1217  *     the value is the human-readable string. Array sorted alphabetically by value
1218  */
1219 function get_module_types_names($plural = false) {
1220     static $modnames = null;
1221     global $DB, $CFG;
1222     if ($modnames === null) {
1223         $modnames = array(0 => array(), 1 => array());
1224         if ($allmods = $DB->get_records("modules")) {
1225             foreach ($allmods as $mod) {
1226                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1227                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1228                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1229                 }
1230             }
1231             collatorlib::asort($modnames[0]);
1232             collatorlib::asort($modnames[1]);
1233         }
1234     }
1235     return $modnames[(int)$plural];
1238 /**
1239  * Set highlighted section. Only one section can be highlighted at the time.
1240  *
1241  * @param int $courseid course id
1242  * @param int $marker highlight section with this number, 0 means remove higlightin
1243  * @return void
1244  */
1245 function course_set_marker($courseid, $marker) {
1246     global $DB;
1247     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1250 /**
1251  * For a given course section, marks it visible or hidden,
1252  * and does the same for every activity in that section
1253  *
1254  * @param int $courseid course id
1255  * @param int $sectionnumber The section number to adjust
1256  * @param int $visibility The new visibility
1257  * @return array A list of resources which were hidden in the section
1258  */
1259 function set_section_visible($courseid, $sectionnumber, $visibility) {
1260     global $DB;
1262     $resourcestotoggle = array();
1263     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1264         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1265         if (!empty($section->sequence)) {
1266             $modules = explode(",", $section->sequence);
1267             foreach ($modules as $moduleid) {
1268                 set_coursemodule_visible($moduleid, $visibility, true);
1269             }
1270         }
1271         rebuild_course_cache($courseid, true);
1273         // Determine which modules are visible for AJAX update
1274         if (!empty($modules)) {
1275             list($insql, $params) = $DB->get_in_or_equal($modules);
1276             $select = 'id ' . $insql . ' AND visible = ?';
1277             array_push($params, $visibility);
1278             if (!$visibility) {
1279                 $select .= ' AND visibleold = 1';
1280             }
1281             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1282         }
1283     }
1284     return $resourcestotoggle;
1287 /**
1288  * Obtains shared data that is used in print_section when displaying a
1289  * course-module entry.
1290  *
1291  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1292  *
1293  * This data is also used in other areas of the code.
1294  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1295  * @param object $course Moodle course object
1296  * @return array An array with the following values in this order:
1297  *   $content (optional extra content for after link),
1298  *   $instancename (text of link)
1299  */
1300 function get_print_section_cm_text(cm_info $cm, $course) {
1301     global $OUTPUT;
1303     // Get content from modinfo if specified. Content displays either
1304     // in addition to the standard link (below), or replaces it if
1305     // the link is turned off by setting ->url to null.
1306     if (($content = $cm->get_content()) !== '') {
1307         // Improve filter performance by preloading filter setttings for all
1308         // activities on the course (this does nothing if called multiple
1309         // times)
1310         filter_preload_activities($cm->get_modinfo());
1312         // Get module context
1313         $modulecontext = context_module::instance($cm->id);
1314         $labelformatoptions = new stdClass();
1315         $labelformatoptions->noclean = true;
1316         $labelformatoptions->overflowdiv = true;
1317         $labelformatoptions->context = $modulecontext;
1318         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1319     } else {
1320         $content = '';
1321     }
1323     // Get course context
1324     $coursecontext = context_course::instance($course->id);
1325     $stringoptions = new stdClass;
1326     $stringoptions->context = $coursecontext;
1327     $instancename = format_string($cm->name, true,  $stringoptions);
1328     return array($content, $instancename);
1331 /**
1332  * Prints a section full of activity modules
1333  *
1334  * @param stdClass $course The course
1335  * @param stdClass|section_info $section The section object containing properties id and section
1336  * @param array $mods (argument not used)
1337  * @param array $modnamesused (argument not used)
1338  * @param bool $absolute All links are absolute
1339  * @param string $width Width of the container
1340  * @param bool $hidecompletion Hide completion status
1341  * @param int $sectionreturn The section to return to
1342  * @return void
1343  */
1344 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1345     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1347     static $initialised;
1349     static $groupbuttons;
1350     static $groupbuttonslink;
1351     static $isediting;
1352     static $ismoving;
1353     static $strmovehere;
1354     static $strmovefull;
1355     static $strunreadpostsone;
1357     if (!isset($initialised)) {
1358         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1359         $groupbuttonslink = (!$course->groupmodeforce);
1360         $isediting        = $PAGE->user_is_editing();
1361         $ismoving         = $isediting && ismoving($course->id);
1362         if ($ismoving) {
1363             $strmovehere  = get_string("movehere");
1364             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1365         }
1366         $initialised = true;
1367     }
1369     $modinfo = get_fast_modinfo($course);
1370     $completioninfo = new completion_info($course);
1372     //Accessibility: replace table with list <ul>, but don't output empty list.
1373     if (!empty($modinfo->sections[$section->section])) {
1375         // Fix bug #5027, don't want style=\"width:$width\".
1376         echo "<ul class=\"section img-text\">\n";
1378         foreach ($modinfo->sections[$section->section] as $modnumber) {
1379             $mod = $modinfo->cms[$modnumber];
1381             if ($ismoving and $mod->id == $USER->activitycopy) {
1382                 // do not display moving mod
1383                 continue;
1384             }
1386             // We can continue (because it will not be displayed at all)
1387             // if:
1388             // 1) The activity is not visible to users
1389             // and
1390             // 2a) The 'showavailability' option is not set (if that is set,
1391             //     we need to display the activity so we can show
1392             //     availability info)
1393             // or
1394             // 2b) The 'availableinfo' is empty, i.e. the activity was
1395             //     hidden in a way that leaves no info, such as using the
1396             //     eye icon.
1397             if (!$mod->uservisible &&
1398                 (empty($mod->showavailability) ||
1399                   empty($mod->availableinfo))) {
1400                 // visibility shortcut
1401                 continue;
1402             }
1404             // In some cases the activity is visible to user, but it is
1405             // dimmed. This is done if viewhiddenactivities is true and if:
1406             // 1. the activity is not visible, or
1407             // 2. the activity has dates set which do not include current, or
1408             // 3. the activity has any other conditions set (regardless of whether
1409             //    current user meets them)
1410             $modcontext = context_module::instance($mod->id);
1411             $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
1412             $accessiblebutdim = false;
1413             if ($canviewhidden) {
1414                 $accessiblebutdim = !$mod->visible;
1415                 if (!empty($CFG->enableavailability)) {
1416                     $accessiblebutdim = $accessiblebutdim ||
1417                         $mod->availablefrom > time() ||
1418                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1419                         count($mod->conditionsgrade) > 0 ||
1420                         count($mod->conditionscompletion) > 0;
1421                 }
1422             }
1424             $liclasses = array();
1425             $liclasses[] = 'activity';
1426             $liclasses[] = $mod->modname;
1427             $liclasses[] = 'modtype_'.$mod->modname;
1428             $extraclasses = $mod->get_extra_classes();
1429             if ($extraclasses) {
1430                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1431             }
1432             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1433             if ($ismoving) {
1434                 echo '<a title="'.$strmovefull.'"'.
1435                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1436                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1437                      ' alt="'.$strmovehere.'" /></a><br />
1438                      ';
1439             }
1441             $classes = array('mod-indent');
1442             if (!empty($mod->indent)) {
1443                 $classes[] = 'mod-indent-'.$mod->indent;
1444                 if ($mod->indent > 15) {
1445                     $classes[] = 'mod-indent-huge';
1446                 }
1447             }
1448             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1450             // Get data about this course-module
1451             list($content, $instancename) =
1452                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1454             //Accessibility: for files get description via icon, this is very ugly hack!
1455             $altname = '';
1456             $altname = $mod->modfullname;
1457             // Avoid unnecessary duplication: if e.g. a forum name already
1458             // includes the word forum (or Forum, etc) then it is unhelpful
1459             // to include that in the accessible description that is added.
1460             if (false !== strpos(textlib::strtolower($instancename),
1461                     textlib::strtolower($altname))) {
1462                 $altname = '';
1463             }
1464             // File type after name, for alphabetic lists (screen reader).
1465             if ($altname) {
1466                 $altname = get_accesshide(' '.$altname);
1467             }
1469             // We may be displaying this just in order to show information
1470             // about visibility, without the actual link
1471             $contentpart = '';
1472             if ($mod->uservisible) {
1473                 // Nope - in this case the link is fully working for user
1474                 $linkclasses = '';
1475                 $textclasses = '';
1476                 if ($accessiblebutdim) {
1477                     $linkclasses .= ' dimmed';
1478                     $textclasses .= ' dimmed_text';
1479                     $accesstext = '<span class="accesshide">'.
1480                         get_string('hiddenfromstudents').': </span>';
1481                 } else {
1482                     $accesstext = '';
1483                 }
1484                 if ($linkclasses) {
1485                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1486                 } else {
1487                     $linkcss = '';
1488                 }
1489                 if ($textclasses) {
1490                     $textcss = 'class="' . trim($textclasses) . '" ';
1491                 } else {
1492                     $textcss = '';
1493                 }
1495                 // Get on-click attribute value if specified
1496                 $onclick = $mod->get_on_click();
1497                 if ($onclick) {
1498                     $onclick = ' onclick="' . $onclick . '"';
1499                 }
1501                 if ($url = $mod->get_url()) {
1502                     // Display link itself
1503                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1504                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1505                             '" class="activityicon" alt="' . $modulename . '" /> ' .
1506                             $accesstext . '<span class="instancename">' .
1507                             $instancename . $altname . '</span></a>';
1509                     // If specified, display extra content after link
1510                     if ($content) {
1511                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1512                                 '">' . $content . '</div>';
1513                     }
1514                 } else {
1515                     // No link, so display only content
1516                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1517                             $accesstext . $content . '</div>';
1518                 }
1520                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
1521                     $groupings = groups_get_all_groupings($course->id);
1522                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1523                 }
1524             } else {
1525                 $textclasses = $extraclasses;
1526                 $textclasses .= ' dimmed_text';
1527                 if ($textclasses) {
1528                     $textcss = 'class="' . trim($textclasses) . '" ';
1529                 } else {
1530                     $textcss = '';
1531                 }
1532                 $accesstext = '<span class="accesshide">' .
1533                         get_string('notavailableyet', 'condition') .
1534                         ': </span>';
1536                 if ($url = $mod->get_url()) {
1537                     // Display greyed-out text of link
1538                     echo '<div ' . $textcss . $mod->extra .
1539                             ' >' . '<img src="' . $mod->get_icon_url() .
1540                             '" class="activityicon" alt="" /> <span>'. $instancename . $altname .
1541                             '</span></div>';
1543                     // Do not display content after link when it is greyed out like this.
1544                 } else {
1545                     // No link, so display only content (also greyed)
1546                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1547                             $accesstext . $content . '</div>';
1548                 }
1549             }
1551             // Module can put text after the link (e.g. forum unread)
1552             echo $mod->get_after_link();
1554             // If there is content but NO link (eg label), then display the
1555             // content here (BEFORE any icons). In this case cons must be
1556             // displayed after the content so that it makes more sense visually
1557             // and for accessibility reasons, e.g. if you have a one-line label
1558             // it should work similarly (at least in terms of ordering) to an
1559             // activity.
1560             if (empty($url)) {
1561                 echo $contentpart;
1562             }
1564             if ($isediting) {
1565                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1566                     if (! $mod->groupmodelink = $groupbuttonslink) {
1567                         $mod->groupmode = $course->groupmode;
1568                     }
1570                 } else {
1571                     $mod->groupmode = false;
1572                 }
1573                 echo '&nbsp;&nbsp;';
1574                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $sectionreturn);
1575                 echo $mod->get_after_edit_icons();
1576             }
1578             // Completion
1579             $completion = $hidecompletion
1580                 ? COMPLETION_TRACKING_NONE
1581                 : $completioninfo->is_enabled($mod);
1582             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1583                 !isguestuser() && $mod->uservisible) {
1584                 $completiondata = $completioninfo->get_data($mod,true);
1585                 $completionicon = '';
1586                 if ($isediting) {
1587                     switch ($completion) {
1588                         case COMPLETION_TRACKING_MANUAL :
1589                             $completionicon = 'manual-enabled'; break;
1590                         case COMPLETION_TRACKING_AUTOMATIC :
1591                             $completionicon = 'auto-enabled'; break;
1592                         default: // wtf
1593                     }
1594                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1595                     switch($completiondata->completionstate) {
1596                         case COMPLETION_INCOMPLETE:
1597                             $completionicon = 'manual-n'; break;
1598                         case COMPLETION_COMPLETE:
1599                             $completionicon = 'manual-y'; break;
1600                     }
1601                 } else { // Automatic
1602                     switch($completiondata->completionstate) {
1603                         case COMPLETION_INCOMPLETE:
1604                             $completionicon = 'auto-n'; break;
1605                         case COMPLETION_COMPLETE:
1606                             $completionicon = 'auto-y'; break;
1607                         case COMPLETION_COMPLETE_PASS:
1608                             $completionicon = 'auto-pass'; break;
1609                         case COMPLETION_COMPLETE_FAIL:
1610                             $completionicon = 'auto-fail'; break;
1611                     }
1612                 }
1613                 if ($completionicon) {
1614                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1615                     $formattedname = format_string($mod->name, true, array('context' => $modcontext));
1616                     $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
1617                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1618                         $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
1619                         $newstate =
1620                             $completiondata->completionstate==COMPLETION_COMPLETE
1621                             ? COMPLETION_INCOMPLETE
1622                             : COMPLETION_COMPLETE;
1623                         // In manual mode the icon is a toggle form...
1625                         // If this completion state is used by the
1626                         // conditional activities system, we need to turn
1627                         // off the JS.
1628                         if (!empty($CFG->enableavailability) &&
1629                             condition_info::completion_value_used_as_condition($course, $mod)) {
1630                             $extraclass = ' preventjs';
1631                         } else {
1632                             $extraclass = '';
1633                         }
1634                         echo "
1635 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1636 <input type='hidden' name='id' value='{$mod->id}' />
1637 <input type='hidden' name='modulename' value='".s($mod->name)."' />
1638 <input type='hidden' name='sesskey' value='".sesskey()."' />
1639 <input type='hidden' name='completionstate' value='$newstate' />
1640 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1641 </div></form>";
1642                     } else {
1643                         // In auto mode, or when editing, the icon is just an image
1644                         echo "<span class='autocompletion'>";
1645                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1646                     }
1647                 }
1648             }
1650             // If there is content AND a link, then display the content here
1651             // (AFTER any icons). Otherwise it was displayed before
1652             if (!empty($url)) {
1653                 echo $contentpart;
1654             }
1656             // Show availability information (for someone who isn't allowed to
1657             // see the activity itself, or for staff)
1658             if (!$mod->uservisible) {
1659                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1660             } else if ($canviewhidden && !empty($CFG->enableavailability) && $mod->visible) {
1661                 $ci = new condition_info($mod);
1662                 $fullinfo = $ci->get_full_information();
1663                 if($fullinfo) {
1664                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1665                         ? 'userrestriction_visible'
1666                         : 'userrestriction_hidden','condition',
1667                         $fullinfo).'</div>';
1668                 }
1669             }
1671             echo html_writer::end_tag('div');
1672             echo html_writer::end_tag('li')."\n";
1673         }
1675     } elseif ($ismoving) {
1676         echo "<ul class=\"section\">\n";
1677     }
1679     if ($ismoving) {
1680         echo '<li><a title="'.$strmovefull.'"'.
1681              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1682              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1683              ' alt="'.$strmovehere.'" /></a></li>
1684              ';
1685     }
1686     if (!empty($modinfo->sections[$section->section]) || $ismoving) {
1687         echo "</ul><!--class='section'-->\n\n";
1688     }
1691 /**
1692  * Prints the menus to add activities and resources.
1693  *
1694  * @param stdClass $course The course
1695  * @param int $section relative section number (field course_sections.section)
1696  * @param null|array $modnames An array containing the list of modules and their names
1697  *     if omitted will be taken from get_module_types_names()
1698  * @param bool $vertical Vertical orientation
1699  * @param bool $return Return the menus or send them to output
1700  * @param int $sectionreturn The section to link back to
1701  * @return void|string depending on $return
1702  */
1703 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1704     global $CFG, $OUTPUT;
1706     if ($modnames === null) {
1707         $modnames = get_module_types_names();
1708     }
1710     // check to see if user can add menus and there are modules to add
1711     if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
1712             || empty($modnames)) {
1713         if ($return) {
1714             return '';
1715         } else {
1716             return false;
1717         }
1718     }
1720     // Retrieve all modules with associated metadata
1721     $modules = get_module_metadata($course, $modnames, $sectionreturn);
1723     // We'll sort resources and activities into two lists
1724     $resources = array();
1725     $activities = array();
1727     // We need to add the section section to the link for each module
1728     $sectionlink = '&section=' . $section . '&sr=' . $sectionreturn;
1730     foreach ($modules as $module) {
1731         if (isset($module->types)) {
1732             // This module has a subtype
1733             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1734             $subtypes = array();
1735             foreach ($module->types as $subtype) {
1736                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1737             }
1739             // Sort module subtypes into the list
1740             if (!empty($module->title)) {
1741                 // This grouping has a name
1742                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1743                     $resources[] = array($module->title=>$subtypes);
1744                 } else {
1745                     $activities[] = array($module->title=>$subtypes);
1746                 }
1747             } else {
1748                 // This grouping does not have a name
1749                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1750                     $resources = array_merge($resources, $subtypes);
1751                 } else {
1752                     $activities = array_merge($activities, $subtypes);
1753                 }
1754             }
1755         } else {
1756             // This module has no subtypes
1757             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1758                 $resources[$module->link . $sectionlink] = $module->title;
1759             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1760                 // System modules cannot be added by user, do not add to dropdown
1761             } else {
1762                 $activities[$module->link . $sectionlink] = $module->title;
1763             }
1764         }
1765     }
1767     $straddactivity = get_string('addactivity');
1768     $straddresource = get_string('addresource');
1770     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1772     if (!$vertical) {
1773         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1774     }
1776     if (!empty($resources)) {
1777         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1778         $select->set_help_icon('resources');
1779         $output .= $OUTPUT->render($select);
1780     }
1782     if (!empty($activities)) {
1783         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1784         $select->set_help_icon('activities');
1785         $output .= $OUTPUT->render($select);
1786     }
1788     if (!$vertical) {
1789         $output .= html_writer::end_tag('div');
1790     }
1792     $output .= html_writer::end_tag('div');
1794     if (course_ajax_enabled($course)) {
1795         $straddeither = get_string('addresourceoractivity');
1796         // The module chooser link
1797         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1798         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1799         $icon = $OUTPUT->pix_icon('t/add', $straddeither);
1800         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1801         $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1802         $modchooser.= html_writer::end_tag('div');
1803         $modchooser.= html_writer::end_tag('div');
1805         // Wrap the normal output in a noscript div
1806         $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1807         if ($usemodchooser) {
1808             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1809             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1810         } else {
1811             $output = html_writer::tag('div', $output, array('class' => 'visibleifjs addresourcedropdown'));
1812             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hiddenifjs addresourcemodchooser'));
1813         }
1814         $output = $modchooser . $output;
1815     }
1817     if ($return) {
1818         return $output;
1819     } else {
1820         echo $output;
1821     }
1824 /**
1825  * Retrieve all metadata for the requested modules
1826  *
1827  * @param object $course The Course
1828  * @param array $modnames An array containing the list of modules and their
1829  * names
1830  * @param int $sectionreturn The section to return to
1831  * @return array A list of stdClass objects containing metadata about each
1832  * module
1833  */
1834 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1835     global $CFG, $OUTPUT;
1837     // get_module_metadata will be called once per section on the page and courses may show
1838     // different modules to one another
1839     static $modlist = array();
1840     if (!isset($modlist[$course->id])) {
1841         $modlist[$course->id] = array();
1842     }
1844     $return = array();
1845     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&sr='.$sectionreturn.'&add=';
1846     foreach($modnames as $modname => $modnamestr) {
1847         if (!course_allowed_module($course, $modname)) {
1848             continue;
1849         }
1850         if (isset($modlist[$modname])) {
1851             // This module is already cached
1852             $return[$modname] = $modlist[$course->id][$modname];
1853             continue;
1854         }
1856         // Include the module lib
1857         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1858         if (!file_exists($libfile)) {
1859             continue;
1860         }
1861         include_once($libfile);
1863         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1864         $gettypesfunc =  $modname.'_get_types';
1865         if (function_exists($gettypesfunc)) {
1866             if ($types = $gettypesfunc()) {
1867                 $group = new stdClass();
1868                 $group->name = $modname;
1869                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1870                 foreach($types as $type) {
1871                     if ($type->typestr === '--') {
1872                         continue;
1873                     }
1874                     if (strpos($type->typestr, '--') === 0) {
1875                         $group->title = str_replace('--', '', $type->typestr);
1876                         continue;
1877                     }
1878                     // Set the Sub Type metadata
1879                     $subtype = new stdClass();
1880                     $subtype->title = $type->typestr;
1881                     $subtype->type = str_replace('&amp;', '&', $type->type);
1882                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1883                     $subtype->archetype = $type->modclass;
1885                     // The group archetype should match the subtype archetypes and all subtypes
1886                     // should have the same archetype
1887                     $group->archetype = $subtype->archetype;
1889                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1890                         $subtype->help = get_string('help' . $subtype->name, $modname);
1891                     }
1892                     $subtype->link = $urlbase . $subtype->type;
1893                     $group->types[] = $subtype;
1894                 }
1895                 $modlist[$course->id][$modname] = $group;
1896             }
1897         } else {
1898             $module = new stdClass();
1899             $module->title = get_string('modulename', $modname);
1900             $module->name = $modname;
1901             $module->link = $urlbase . $modname;
1902             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1903             $sm = get_string_manager();
1904             if ($sm->string_exists('modulename_help', $modname)) {
1905                 $module->help = get_string('modulename_help', $modname);
1906                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1907                     $link = get_string('modulename_link', $modname);
1908                     $linktext = get_string('morehelp');
1909                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext), array('class' => 'helpdoclink'));
1910                 }
1911             }
1912             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1913             $modlist[$course->id][$modname] = $module;
1914         }
1915         $return[$modname] = $modlist[$course->id][$modname];
1916     }
1918     return $return;
1921 /**
1922  * Return the course category context for the category with id $categoryid, except
1923  * that if $categoryid is 0, return the system context.
1924  *
1925  * @param integer $categoryid a category id or 0.
1926  * @return object the corresponding context
1927  */
1928 function get_category_or_system_context($categoryid) {
1929     if ($categoryid) {
1930         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1931     } else {
1932         return context_system::instance();
1933     }
1936 /**
1937  * Gets the child categories of a given courses category. Uses a static cache
1938  * to make repeat calls efficient.
1939  *
1940  * @param int $parentid the id of a course category.
1941  * @return array all the child course categories.
1942  */
1943 function get_child_categories($parentid) {
1944     static $allcategories = null;
1946     // only fill in this variable the first time
1947     if (null == $allcategories) {
1948         $allcategories = array();
1950         $categories = get_categories();
1951         foreach ($categories as $category) {
1952             if (empty($allcategories[$category->parent])) {
1953                 $allcategories[$category->parent] = array();
1954             }
1955             $allcategories[$category->parent][] = $category;
1956         }
1957     }
1959     if (empty($allcategories[$parentid])) {
1960         return array();
1961     } else {
1962         return $allcategories[$parentid];
1963     }
1966 /**
1967  * This function recursively travels the categories, building up a nice list
1968  * for display. It also makes an array that list all the parents for each
1969  * category.
1970  *
1971  * For example, if you have a tree of categories like:
1972  *   Miscellaneous (id = 1)
1973  *      Subcategory (id = 2)
1974  *         Sub-subcategory (id = 4)
1975  *   Other category (id = 3)
1976  * Then after calling this function you will have
1977  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1978  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1979  *      3 => 'Other category');
1980  * $parents = array(2 => array(1), 4 => array(1, 2));
1981  *
1982  * If you specify $requiredcapability, then only categories where the current
1983  * user has that capability will be added to $list, although all categories
1984  * will still be added to $parents, and if you only have $requiredcapability
1985  * in a child category, not the parent, then the child catgegory will still be
1986  * included.
1987  *
1988  * If you specify the option $excluded, then that category, and all its children,
1989  * are omitted from the tree. This is useful when you are doing something like
1990  * moving categories, where you do not want to allow people to move a category
1991  * to be the child of itself.
1992  *
1993  * @param array $list For output, accumulates an array categoryid => full category path name
1994  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1995  * @param string/array $requiredcapability if given, only categories where the current
1996  *      user has this capability will be added to $list. Can also be an array of capabilities,
1997  *      in which case they are all required.
1998  * @param integer $excludeid Omit this category and its children from the lists built.
1999  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2000  * @param string $path For internal use, as part of recursive calls.
2001  */
2002 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2003         $excludeid = 0, $category = NULL, $path = "") {
2005     // initialize the arrays if needed
2006     if (!is_array($list)) {
2007         $list = array();
2008     }
2009     if (!is_array($parents)) {
2010         $parents = array();
2011     }
2013     if (empty($category)) {
2014         // Start at the top level.
2015         $category = new stdClass;
2016         $category->id = 0;
2017     } else {
2018         // This is the excluded category, don't include it.
2019         if ($excludeid > 0 && $excludeid == $category->id) {
2020             return;
2021         }
2023         $context = context_coursecat::instance($category->id);
2024         $categoryname = format_string($category->name, true, array('context' => $context));
2026         // Update $path.
2027         if ($path) {
2028             $path = $path.' / '.$categoryname;
2029         } else {
2030             $path = $categoryname;
2031         }
2033         // Add this category to $list, if the permissions check out.
2034         if (empty($requiredcapability)) {
2035             $list[$category->id] = $path;
2037         } else {
2038             $requiredcapability = (array)$requiredcapability;
2039             if (has_all_capabilities($requiredcapability, $context)) {
2040                 $list[$category->id] = $path;
2041             }
2042         }
2043     }
2045     // Add all the children recursively, while updating the parents array.
2046     if ($categories = get_child_categories($category->id)) {
2047         foreach ($categories as $cat) {
2048             if (!empty($category->id)) {
2049                 if (isset($parents[$category->id])) {
2050                     $parents[$cat->id]   = $parents[$category->id];
2051                 }
2052                 $parents[$cat->id][] = $category->id;
2053             }
2054             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2055         }
2056     }
2059 /**
2060  * This function generates a structured array of courses and categories.
2061  *
2062  * The depth of categories is limited by $CFG->maxcategorydepth however there
2063  * is no limit on the number of courses!
2064  *
2065  * Suitable for use with the course renderers course_category_tree method:
2066  * $renderer = $PAGE->get_renderer('core','course');
2067  * echo $renderer->course_category_tree(get_course_category_tree());
2068  *
2069  * @global moodle_database $DB
2070  * @param int $id
2071  * @param int $depth
2072  */
2073 function get_course_category_tree($id = 0, $depth = 0) {
2074     global $DB, $CFG;
2075     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
2076     $categories = get_child_categories($id);
2077     $categoryids = array();
2078     foreach ($categories as $key => &$category) {
2079         if (!$category->visible && !$viewhiddencats) {
2080             unset($categories[$key]);
2081             continue;
2082         }
2083         $categoryids[$category->id] = $category;
2084         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2085             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2086             foreach ($subcategories as $subid=>$subcat) {
2087                 $categoryids[$subid] = $subcat;
2088             }
2089             $category->courses = array();
2090         }
2091     }
2093     if ($depth > 0) {
2094         // This is a recursive call so return the required array
2095         return array($categories, $categoryids);
2096     }
2098     if (empty($categoryids)) {
2099         // No categories available (probably all hidden).
2100         return array();
2101     }
2103     // The depth is 0 this function has just been called so we can finish it off
2105     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2106     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2107     $sql = "SELECT
2108             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2109             $ccselect
2110             FROM {course} c
2111             $ccjoin
2112             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2113     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2114         // loop throught them
2115         foreach ($courses as $course) {
2116             if ($course->id == SITEID) {
2117                 continue;
2118             }
2119             context_instance_preload($course);
2120             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2121                 $categoryids[$course->category]->courses[$course->id] = $course;
2122             }
2123         }
2124     }
2125     return $categories;
2128 /**
2129  * Recursive function to print out all the categories in a nice format
2130  * with or without courses included
2131  */
2132 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2133     global $CFG;
2135     // maxcategorydepth == 0 meant no limit
2136     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2137         return;
2138     }
2140     if (!$displaylist) {
2141         make_categories_list($displaylist, $parentslist);
2142     }
2144     if ($category) {
2145         if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
2146             print_category_info($category, $depth, $showcourses);
2147         } else {
2148             return;  // Don't bother printing children of invisible categories
2149         }
2151     } else {
2152         $category = new stdClass();
2153         $category->id = "0";
2154     }
2156     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2157         $countcats = count($categories);
2158         $count = 0;
2159         $first = true;
2160         $last = false;
2161         foreach ($categories as $cat) {
2162             $count++;
2163             if ($count == $countcats) {
2164                 $last = true;
2165             }
2166             $up = $first ? false : true;
2167             $down = $last ? false : true;
2168             $first = false;
2170             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2171         }
2172     }
2175 /**
2176  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2177  */
2178 function make_categories_options() {
2179     make_categories_list($cats,$parents);
2180     foreach ($cats as $key => $value) {
2181         if (array_key_exists($key,$parents)) {
2182             if ($indent = count($parents[$key])) {
2183                 for ($i = 0; $i < $indent; $i++) {
2184                     $cats[$key] = '&nbsp;'.$cats[$key];
2185                 }
2186             }
2187         }
2188     }
2189     return $cats;
2192 /**
2193  * Prints the category info in indented fashion
2194  * This function is only used by print_whole_category_list() above
2195  */
2196 function print_category_info($category, $depth=0, $showcourses = false) {
2197     global $CFG, $DB, $OUTPUT;
2199     $strsummary = get_string('summary');
2201     $catlinkcss = null;
2202     if (!$category->visible) {
2203         $catlinkcss = array('class'=>'dimmed');
2204     }
2205     static $coursecount = null;
2206     if (null === $coursecount) {
2207         // only need to check this once
2208         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2209     }
2211     if ($showcourses and $coursecount) {
2212         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2213     } else {
2214         $catimage = "&nbsp;";
2215     }
2217     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2218     $context = context_coursecat::instance($category->id);
2219     $fullname = format_string($category->name, true, array('context' => $context));
2221     if ($showcourses and $coursecount) {
2222         echo '<div class="categorylist clearfix">';
2223         $cat = '';
2224         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2225         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2226         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2228         $html = '';
2229         if ($depth > 0) {
2230             for ($i=0; $i< $depth; $i++) {
2231                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2232                 $cat = '';
2233             }
2234         } else {
2235             $html = $cat;
2236         }
2237         echo html_writer::tag('div', $html, array('class'=>'category'));
2238         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2240         // does the depth exceed maxcategorydepth
2241         // maxcategorydepth == 0 or unset meant no limit
2242         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2243         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2244             foreach ($courses as $course) {
2245                 $linkcss = null;
2246                 if (!$course->visible) {
2247                     $linkcss = array('class'=>'dimmed');
2248                 }
2250                 $coursename = get_course_display_name_for_list($course);
2251                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2253                 // print enrol info
2254                 $courseicon = '';
2255                 if ($icons = enrol_get_course_info_icons($course)) {
2256                     foreach ($icons as $pix_icon) {
2257                         $courseicon = $OUTPUT->render($pix_icon).' ';
2258                     }
2259                 }
2261                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2263                 if ($course->summary) {
2264                     $link = new moodle_url('/course/info.php?id='.$course->id);
2265                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2266                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2267                         array('title'=>$strsummary));
2269                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2270                 }
2272                 $html = '';
2273                 for ($i=0; $i <= $depth; $i++) {
2274                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2275                     $coursecontent = '';
2276                 }
2277                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2278             }
2279         }
2280         echo '</div>';
2281     } else {
2282         echo '<div class="categorylist">';
2283         $html = '';
2284         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2285         if (count($courses) > 0) {
2286             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2287         }
2289         if ($depth > 0) {
2290             for ($i=0; $i< $depth; $i++) {
2291                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2292                 $cat = '';
2293             }
2294         } else {
2295             $html = $cat;
2296         }
2298         echo html_writer::tag('div', $html, array('class'=>'category'));
2299         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2300         echo '</div>';
2301     }
2304 /**
2305  * Print the buttons relating to course requests.
2306  *
2307  * @param object $systemcontext the system context.
2308  */
2309 function print_course_request_buttons($systemcontext) {
2310     global $CFG, $DB, $OUTPUT;
2311     if (empty($CFG->enablecourserequests)) {
2312         return;
2313     }
2314     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2315     /// Print a button to request a new course
2316         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2317     }
2318     /// Print a button to manage pending requests
2319     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2320         $disabled = !$DB->record_exists('course_request', array());
2321         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2322     }
2325 /**
2326  * Does the user have permission to edit things in this category?
2327  *
2328  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2329  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2330  */
2331 function can_edit_in_category($categoryid = 0) {
2332     $context = get_category_or_system_context($categoryid);
2333     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2336 /**
2337  * Prints the turn editing on/off button on course/index.php or course/category.php.
2338  *
2339  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2340  * @return string HTML of the editing button, or empty string, if this user is not allowed
2341  *      to see it.
2342  */
2343 function update_category_button($categoryid = 0) {
2344     global $CFG, $PAGE, $OUTPUT;
2346     // Check permissions.
2347     if (!can_edit_in_category($categoryid)) {
2348         return '';
2349     }
2351     // Work out the appropriate action.
2352     if ($PAGE->user_is_editing()) {
2353         $label = get_string('turneditingoff');
2354         $edit = 'off';
2355     } else {
2356         $label = get_string('turneditingon');
2357         $edit = 'on';
2358     }
2360     // Generate the button HTML.
2361     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2362     if ($categoryid) {
2363         $options['id'] = $categoryid;
2364         $page = 'category.php';
2365     } else {
2366         $page = 'index.php';
2367     }
2368     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2371 /**
2372  * Category is 0 (for all courses) or an object
2373  */
2374 function print_courses($category) {
2375     global $CFG, $OUTPUT;
2377     if (!is_object($category) && $category==0) {
2378         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2379         if (is_array($categories) && count($categories) == 1) {
2380             $category   = array_shift($categories);
2381             $courses    = get_courses_wmanagers($category->id,
2382                                                 'c.sortorder ASC',
2383                                                 array('summary','summaryformat'));
2384         } else {
2385             $courses    = get_courses_wmanagers('all',
2386                                                 'c.sortorder ASC',
2387                                                 array('summary','summaryformat'));
2388         }
2389         unset($categories);
2390     } else {
2391         $courses    = get_courses_wmanagers($category->id,
2392                                             'c.sortorder ASC',
2393                                             array('summary','summaryformat'));
2394     }
2396     if ($courses) {
2397         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2398         foreach ($courses as $course) {
2399             $coursecontext = context_course::instance($course->id);
2400             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2401                 echo html_writer::start_tag('li');
2402                 print_course($course);
2403                 echo html_writer::end_tag('li');
2404             }
2405         }
2406         echo html_writer::end_tag('ul');
2407     } else {
2408         echo $OUTPUT->heading(get_string("nocoursesyet"));
2409         $context = context_system::instance();
2410         if (has_capability('moodle/course:create', $context)) {
2411             $options = array();
2412             if (!empty($category->id)) {
2413                 $options['category'] = $category->id;
2414             } else {
2415                 $options['category'] = $CFG->defaultrequestcategory;
2416             }
2417             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2418             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2419             echo html_writer::end_tag('div');
2420         }
2421     }
2424 /**
2425  * Print a description of a course, suitable for browsing in a list.
2426  *
2427  * @param object $course the course object.
2428  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2429  */
2430 function print_course($course, $highlightterms = '') {
2431     global $CFG, $USER, $DB, $OUTPUT;
2433     $context = context_course::instance($course->id);
2435     // Rewrite file URLs so that they are correct
2436     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2438     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2439     echo html_writer::start_tag('div', array('class'=>'info'));
2440     echo html_writer::start_tag('h3', array('class'=>'name'));
2442     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2444     $coursename = get_course_display_name_for_list($course);
2445     $linktext = highlight($highlightterms, format_string($coursename));
2446     $linkparams = array('title'=>get_string('entercourse'));
2447     if (empty($course->visible)) {
2448         $linkparams['class'] = 'dimmed';
2449     }
2450     echo html_writer::link($linkhref, $linktext, $linkparams);
2451     echo html_writer::end_tag('h3');
2453     /// first find all roles that are supposed to be displayed
2454     if (!empty($CFG->coursecontact)) {
2455         $managerroles = explode(',', $CFG->coursecontact);
2456         $rusers = array();
2458         if (!isset($course->managers)) {
2459             list($sort, $sortparams) = users_order_by_sql('u');
2460             $rusers = get_role_users($managerroles, $context, true,
2461                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
2462                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
2463                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
2464         } else {
2465             //  use the managers array if we have it for perf reasosn
2466             //  populate the datastructure like output of get_role_users();
2467             foreach ($course->managers as $manager) {
2468                 $user = clone($manager->user);
2469                 $user->roleid = $manager->roleid;
2470                 $user->rolename = $manager->rolename;
2471                 $user->roleshortname = $manager->roleshortname;
2472                 $user->rolecoursealias = $manager->rolecoursealias;
2473                 $rusers[$user->id] = $user;
2474             }
2475         }
2477         $namesarray = array();
2478         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2479         foreach ($rusers as $ra) {
2480             if (isset($namesarray[$ra->id])) {
2481                 //  only display a user once with the higest sortorder role
2482                 continue;
2483             }
2485             $role = new stdClass();
2486             $role->id = $ra->roleid;
2487             $role->name = $ra->rolename;
2488             $role->shortname = $ra->roleshortname;
2489             $role->coursealias = $ra->rolecoursealias;
2490             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
2492             $fullname = fullname($ra, $canviewfullnames);
2493             $namesarray[$ra->id] = $rolename.': '.
2494                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2495         }
2497         if (!empty($namesarray)) {
2498             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2499             foreach ($namesarray as $name) {
2500                 echo html_writer::tag('li', $name);
2501             }
2502             echo html_writer::end_tag('ul');
2503         }
2504     }
2505     echo html_writer::end_tag('div'); // End of info div
2507     echo html_writer::start_tag('div', array('class'=>'summary'));
2508     $options = new stdClass();
2509     $options->noclean = true;
2510     $options->para = false;
2511     $options->overflowdiv = true;
2512     if (!isset($course->summaryformat)) {
2513         $course->summaryformat = FORMAT_MOODLE;
2514     }
2515     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2516     if ($icons = enrol_get_course_info_icons($course)) {
2517         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2518         foreach ($icons as $icon) {
2519             echo $OUTPUT->render($icon);
2520         }
2521         echo html_writer::end_tag('div'); // End of enrolmenticons div
2522     }
2523     echo html_writer::end_tag('div'); // End of summary div
2524     echo html_writer::end_tag('div'); // End of coursebox div
2527 /**
2528  * Prints custom user information on the home page.
2529  * Over time this can include all sorts of information
2530  */
2531 function print_my_moodle() {
2532     global $USER, $CFG, $DB, $OUTPUT;
2534     if (!isloggedin() or isguestuser()) {
2535         print_error('nopermissions', '', '', 'See My Moodle');
2536     }
2538     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2539     $rhosts   = array();
2540     $rcourses = array();
2541     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2542         $rcourses = get_my_remotecourses($USER->id);
2543         $rhosts   = get_my_remotehosts();
2544     }
2546     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2548         if (!empty($courses)) {
2549             echo '<ul class="unlist">';
2550             foreach ($courses as $course) {
2551                 if ($course->id == SITEID) {
2552                     continue;
2553                 }
2554                 echo '<li>';
2555                 print_course($course);
2556                 echo "</li>\n";
2557             }
2558             echo "</ul>\n";
2559         }
2561         // MNET
2562         if (!empty($rcourses)) {
2563             // at the IDP, we know of all the remote courses
2564             foreach ($rcourses as $course) {
2565                 print_remote_course($course, "100%");
2566             }
2567         } elseif (!empty($rhosts)) {
2568             // non-IDP, we know of all the remote servers, but not courses
2569             foreach ($rhosts as $host) {
2570                 print_remote_host($host, "100%");
2571             }
2572         }
2573         unset($course);
2574         unset($host);
2576         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2577             echo "<table width=\"100%\"><tr><td align=\"center\">";
2578             print_course_search("", false, "short");
2579             echo "</td><td align=\"center\">";
2580             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2581             echo "</td></tr></table>\n";
2582         }
2584     } else {
2585         if ($DB->count_records("course_categories") > 1) {
2586             echo $OUTPUT->box_start("categorybox");
2587             print_whole_category_list();
2588             echo $OUTPUT->box_end();
2589         } else {
2590             print_courses(0);
2591         }
2592     }
2596 function print_course_search($value="", $return=false, $format="plain") {
2597     global $CFG;
2598     static $count = 0;
2600     $count++;
2602     $id = 'coursesearch';
2604     if ($count > 1) {
2605         $id .= $count;
2606     }
2608     $strsearchcourses= get_string("searchcourses");
2610     if ($format == 'plain') {
2611         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2612         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2613         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2614         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2615         $output .= '<input type="submit" value="'.get_string('go').'" />';
2616         $output .= '</fieldset></form>';
2617     } else if ($format == 'short') {
2618         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2619         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2620         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2621         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2622         $output .= '<input type="submit" value="'.get_string('go').'" />';
2623         $output .= '</fieldset></form>';
2624     } else if ($format == 'navbar') {
2625         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2626         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2627         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2628         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2629         $output .= '<input type="submit" value="'.get_string('go').'" />';
2630         $output .= '</fieldset></form>';
2631     }
2633     if ($return) {
2634         return $output;
2635     }
2636     echo $output;
2639 function print_remote_course($course, $width="100%") {
2640     global $CFG, $USER;
2642     $linkcss = '';
2644     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2646     echo '<div class="coursebox remotecoursebox clearfix">';
2647     echo '<div class="info">';
2648     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2649          $linkcss.' href="'.$url.'">'
2650         .  format_string($course->fullname) .'</a><br />'
2651         . format_string($course->hostname) . ' : '
2652         . format_string($course->cat_name) . ' : '
2653         . format_string($course->shortname). '</div>';
2654     echo '</div><div class="summary">';
2655     $options = new stdClass();
2656     $options->noclean = true;
2657     $options->para = false;
2658     $options->overflowdiv = true;
2659     echo format_text($course->summary, $course->summaryformat, $options);
2660     echo '</div>';
2661     echo '</div>';
2664 function print_remote_host($host, $width="100%") {
2665     global $OUTPUT;
2667     $linkcss = '';
2669     echo '<div class="coursebox clearfix">';
2670     echo '<div class="info">';
2671     echo '<div class="name">';
2672     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2673     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2674         . s($host['name']).'</a> - ';
2675     echo $host['count'] . ' ' . get_string('courses');
2676     echo '</div>';
2677     echo '</div>';
2678     echo '</div>';
2682 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2684 function add_course_module($mod) {
2685     global $DB;
2687     $mod->added = time();
2688     unset($mod->id);
2690     $cmid = $DB->insert_record("course_modules", $mod);
2691     rebuild_course_cache($mod->course, true);
2692     return $cmid;
2695 /**
2696  * Creates missing course section(s) and rebuilds course cache
2697  *
2698  * @param stdClass $course course object
2699  * @param int|array $sections list of relative section numbers to create
2700  * @return bool if there were any sections created
2701  */
2702 function course_create_sections_if_missing(&$course, $sections) {
2703     global $DB;
2704     if (!is_array($sections)) {
2705         $sections = array($sections);
2706     }
2707     $existing = array_keys(get_fast_modinfo($course)->get_section_info_all());
2708     $coursechanged = false;
2709     foreach ($sections as $sectionnum) {
2710         if (!in_array($sectionnum, $existing)) {
2711             $cw = new stdClass();
2712             $cw->course   = $course->id;
2713             $cw->section  = $sectionnum;
2714             $cw->summary  = '';
2715             $cw->summaryformat = FORMAT_HTML;
2716             $cw->sequence = '';
2717             $id = $DB->insert_record("course_sections", $cw);
2718             $coursechanged = true;
2719         }
2720     }
2721     if ($coursechanged) {
2722         rebuild_course_cache($course->id, true);
2723         $course->modinfo = null;
2724         $course->sectioncache = null;
2725     }
2726     return $coursechanged;
2729 /**
2730  * Adds an existing module to the section
2731  *
2732  * Updates both tables {course_sections} and {course_modules}
2733  *
2734  * @param int|stdClass $courseorid course id or course object
2735  * @param int $modid id of the module already existing in course_modules table
2736  * @param int $sectionnum relative number of the section (field course_sections.section)
2737  *     If section does not exist it will be created
2738  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2739  *     before which the module needs to be included. Null for inserting in the
2740  *     end of the section
2741  * @return int The course_sections ID where the module is inserted
2742  */
2743 function course_add_cm_to_section($courseorid, $modid, $sectionnum, $beforemod = NULL) {
2744     global $DB, $COURSE;
2745     if (is_object($beforemod)) {
2746         $beforemod = $beforemod->id;
2747     }
2748     if (is_object($courseorid)) {
2749         $course = &$courseorid;
2750     } else {
2751         if (isset($COURSE->id) && $COURSE->id == $courseorid) {
2752             $course = &$COURSE;
2753         } else {
2754             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2755         }
2756     }
2757     course_create_sections_if_missing($course, $sectionnum);
2758     $section = get_fast_modinfo($course)->get_section_info($sectionnum);
2759     $modarray = explode(",", trim($section->sequence));
2760     if (empty($modarray)) {
2761         $newsequence = "$modid";
2762     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2763         $insertarray = array($modid, $beforemod);
2764         array_splice($modarray, $key[0], 1, $insertarray);
2765         $newsequence = implode(",", $modarray);
2766     } else {
2767         $newsequence = "$section->sequence,$modid";
2768     }
2769     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2770     $DB->set_field('course_modules', 'section', $section->id, array('id' => $modid));
2771     rebuild_course_cache($course->id, true);
2772     $course->modinfo = null;
2773     $course->sectioncache = null;
2774     return $section->id;     // Return course_sections ID that was used.
2777 function set_coursemodule_groupmode($id, $groupmode) {
2778     global $DB;
2779     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2780     if ($cm->groupmode != $groupmode) {
2781         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2782         rebuild_course_cache($cm->course, true);
2783     }
2784     return ($cm->groupmode != $groupmode);
2787 function set_coursemodule_idnumber($id, $idnumber) {
2788     global $DB;
2789     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2790     if ($cm->idnumber != $idnumber) {
2791         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2792         rebuild_course_cache($cm->course, true);
2793     }
2794     return ($cm->idnumber != $idnumber);
2797 /**
2798 * $prevstateoverrides = true will set the visibility of the course module
2799 * to what is defined in visibleold. This enables us to remember the current
2800 * visibility when making a whole section hidden, so that when we toggle
2801 * that section back to visible, we are able to return the visibility of
2802 * the course module back to what it was originally.
2803 */
2804 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2805     global $DB, $CFG;
2806     require_once($CFG->libdir.'/gradelib.php');
2808     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2809         return false;
2810     }
2811     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2812         return false;
2813     }
2814     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2815         foreach($events as $event) {
2816             if ($visible) {
2817                 show_event($event);
2818             } else {
2819                 hide_event($event);
2820             }
2821         }
2822     }
2824     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2825     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2826     if ($grade_items) {
2827         foreach ($grade_items as $grade_item) {
2828             $grade_item->set_hidden(!$visible);
2829         }
2830     }
2832     if ($prevstateoverrides) {
2833         if ($visible == '0') {
2834             // Remember the current visible state so we can toggle this back.
2835             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2836         } else {
2837             // Get the previous saved visible states.
2838             $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2839         }
2840     } else {
2841         $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2842     }
2843     rebuild_course_cache($cm->course, true);
2844     return true;
2847 /**
2848  * Delete a course module and any associated data at the course level (events)
2849  * Until 1.5 this function simply marked a deleted flag ... now it
2850  * deletes it completely.
2851  *
2852  */
2853 function delete_course_module($id) {
2854     global $CFG, $DB;
2855     require_once($CFG->libdir.'/gradelib.php');
2856     require_once($CFG->dirroot.'/blog/lib.php');
2858     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2859         return true;
2860     }
2861     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2862     //delete events from calendar
2863     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2864         foreach($events as $event) {
2865             delete_event($event->id);
2866         }
2867     }
2868     //delete grade items, outcome items and grades attached to modules
2869     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2870                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2871         foreach ($grade_items as $grade_item) {
2872             $grade_item->delete('moddelete');
2873         }
2874     }
2875     // Delete completion and availability data; it is better to do this even if the
2876     // features are not turned on, in case they were turned on previously (these will be
2877     // very quick on an empty table)
2878     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2879     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2880     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2881     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2882                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2884     delete_context(CONTEXT_MODULE, $cm->id);
2885     $DB->delete_records('course_modules', array('id'=>$cm->id));
2886     rebuild_course_cache($cm->course, true);
2887     return true;
2890 function delete_mod_from_section($modid, $sectionid) {
2891     global $DB;
2893     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2895         $modarray = explode(",", $section->sequence);
2897         if ($key = array_keys ($modarray, $modid)) {
2898             array_splice($modarray, $key[0], 1);
2899             $newsequence = implode(",", $modarray);
2900             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2901             rebuild_course_cache($section->course, true);
2902             return true;
2903         } else {
2904             return false;
2905         }
2907     }
2908     return false;
2911 /**
2912  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2913  *
2914  * @param object $course course object
2915  * @param int $section Section number (not id!!!)
2916  * @param int $move (-1 or 1)
2917  * @return boolean true if section moved successfully
2918  * @todo MDL-33379 remove this function in 2.5
2919  */
2920 function move_section($course, $section, $move) {
2921     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2923 /// Moves a whole course section up and down within the course
2924     global $USER;
2926     if (!$move) {
2927         return true;
2928     }
2930     $sectiondest = $section + $move;
2932     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2933         return false;
2934     }
2936     $retval = move_section_to($course, $section, $sectiondest);
2937     return $retval;
2940 /**
2941  * Moves a section within a course, from a position to another.
2942  * Be very careful: $section and $destination refer to section number,
2943  * not id!.
2944  *
2945  * @param object $course
2946  * @param int $section Section number (not id!!!)
2947  * @param int $destination
2948  * @return boolean Result
2949  */
2950 function move_section_to($course, $section, $destination) {
2951 /// Moves a whole course section up and down within the course
2952     global $USER, $DB;
2954     if (!$destination && $destination != 0) {
2955         return true;
2956     }
2958     if (($destination > $course->numsections) || ($destination < 1)) {
2959         return false;
2960     }
2962     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2963     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2964             'section ASC, id ASC', 'id, section')) {
2965         return false;
2966     }
2968     $movedsections = reorder_sections($sections, $section, $destination);
2970     // Update all sections. Do this in 2 steps to avoid breaking database
2971     // uniqueness constraint
2972     $transaction = $DB->start_delegated_transaction();
2973     foreach ($movedsections as $id => $position) {
2974         if ($sections[$id] !== $position) {
2975             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2976         }
2977     }
2978     foreach ($movedsections as $id => $position) {
2979         if ($sections[$id] !== $position) {
2980             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2981         }
2982     }
2984     // If we move the highlighted section itself, then just highlight the destination.
2985     // Adjust the higlighted section location if we move something over it either direction.
2986     if ($section == $course->marker) {
2987         course_set_marker($course->id, $destination);
2988     } elseif ($section > $course->marker && $course->marker >= $destination) {
2989         course_set_marker($course->id, $course->marker+1);
2990     } elseif ($section < $course->marker && $course->marker <= $destination) {
2991         course_set_marker($course->id, $course->marker-1);
2992     }
2994     $transaction->allow_commit();
2995     rebuild_course_cache($course->id, true);
2996     return true;
2999 /**
3000  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3001  * an original position number and a target position number, rebuilds the array so that the
3002  * move is made without any duplication of section positions.
3003  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3004  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3005  *
3006  * @param array $sections
3007  * @param int $origin_position
3008  * @param int $target_position
3009  * @return array
3010  */
3011 function reorder_sections($sections, $origin_position, $target_position) {
3012     if (!is_array($sections)) {
3013         return false;
3014     }
3016     // We can't move section position 0
3017     if ($origin_position < 1) {
3018         echo "We can't move section position 0";
3019         return false;
3020     }
3022     // Locate origin section in sections array
3023     if (!$origin_key = array_search($origin_position, $sections)) {
3024         echo "searched position not in sections array";
3025         return false; // searched position not in sections array
3026     }
3028     // Extract origin section
3029     $origin_section = $sections[$origin_key];
3030     unset($sections[$origin_key]);
3032     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3033     $found = false;
3034     $append_array = array();
3035     foreach ($sections as $id => $position) {
3036         if ($found) {
3037             $append_array[$id] = $position;
3038             unset($sections[$id]);
3039         }
3040         if ($position == $target_position) {
3041             if ($target_position < $origin_position) {
3042                 $append_array[$id] = $position;
3043                 unset($sections[$id]);
3044             }
3045             $found = true;
3046         }
3047     }
3049     // Append moved section
3050     $sections[$origin_key] = $origin_section;
3052     // Append rest of array (if applicable)
3053     if (!empty($append_array)) {
3054         foreach ($append_array as $id => $position) {
3055             $sections[$id] = $position;
3056         }
3057     }
3059     // Renumber positions
3060     $position = 0;
3061     foreach ($sections as $id => $p) {
3062         $sections[$id] = $position;
3063         $position++;
3064     }
3066     return $sections;
3070 /**
3071  * Move the module object $mod to the specified $section
3072  * If $beforemod exists then that is the module
3073  * before which $modid should be inserted
3074  * All parameters are objects
3075  */
3076 function moveto_module($mod, $section, $beforemod=NULL) {
3077     global $OUTPUT;
3079 /// Remove original module from original section
3080     if (! delete_mod_from_section($mod->id, $mod->section)) {
3081         echo $OUTPUT->notification("Could not delete module from existing section");
3082     }
3084     // if moving to a hidden section then hide module
3085     if (!$section->visible && $mod->visible) {
3086         set_coursemodule_visible($mod->id, 0);
3087     }
3089 /// Add the module into the new section
3090     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
3091     return true;
3094 /**
3095  * Produces the editing buttons for a module
3096  *
3097  * @global core_renderer $OUTPUT
3098  * @staticvar type $str
3099  * @param stdClass $mod The module to produce editing buttons for
3100  * @param bool $absolute_ignored ignored - all links are absolute
3101  * @param bool $moveselect If true a move seleciton process is used (default true)
3102  * @param int $indent The current indenting
3103  * @param int $section The section to link back to
3104  * @return string XHTML for the editing buttons
3105  */
3106 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3107     global $CFG, $OUTPUT, $COURSE;
3109     static $str;
3111     $coursecontext = context_course::instance($mod->course);
3112     $modcontext = context_module::instance($mod->id);
3114     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3115     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3117     // no permission to edit anything
3118     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3119         return false;
3120     }
3122     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3124     if (!isset($str)) {
3125         $str = new stdClass;
3126         $str->assign         = get_string("assignroles", 'role');
3127         $str->delete         = get_string("delete");
3128         $str->move           = get_string("move");
3129         $str->moveup         = get_string("moveup");
3130         $str->movedown       = get_string("movedown");
3131         $str->moveright      = get_string("moveright");
3132         $str->moveleft       = get_string("moveleft");
3133         $str->update         = get_string("update");
3134         $str->duplicate      = get_string("duplicate");
3135         $str->hide           = get_string("hide");
3136         $str->show           = get_string("show");
3137         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3138         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3139         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3140         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3141         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3142         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3143         $str->edittitle = get_string('edittitle', 'moodle');
3144     }
3146     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3148     if ($section !== null) {
3149         $baseurl->param('sr', $section);
3150     }
3151     $actions = array();
3153     // AJAX edit title
3154     if ($mod->modname !== 'label' && $hasmanageactivities && course_ajax_enabled($COURSE)) {
3155         $actions[] = new action_link(
3156             new moodle_url($baseurl, array('update' => $mod->id)),
3157             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3158             null,
3159             array('class' => 'editing_title', 'title' => $str->edittitle)
3160         );
3161     }
3163     // leftright
3164     if ($hasmanageactivities) {
3165         if (right_to_left()) {   // Exchange arrows on RTL
3166             $rightarrow = 't/left';
3167             $leftarrow  = 't/right';
3168         } else {
3169             $rightarrow = 't/right';
3170             $leftarrow  = 't/left';
3171         }
3173         if ($indent > 0) {
3174             $actions[] = new action_link(
3175                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3176                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3177                 null,
3178                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3179             );
3180         }
3181         if ($indent >= 0) {
3182             $actions[] = new action_link(
3183                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3184                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3185                 null,
3186                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3187             );
3188         }
3189     }
3191     // move
3192     if ($hasmanageactivities) {
3193         if ($moveselect) {
3194             $actions[] = new action_link(
3195                 new moodle_url($baseurl, array('copy' => $mod->id)),
3196                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3197                 null,
3198                 array('class' => 'editing_move', 'title' => $str->move)
3199             );
3200         } else {
3201             $actions[] = new action_link(
3202                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3203                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3204                 null,
3205                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3206             );
3207             $actions[] = new action_link(
3208                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3209                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3210                 null,
3211                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3212             );
3213         }
3214     }
3216     // Update
3217     if ($hasmanageactivities) {
3218         $actions[] = new action_link(
3219             new moodle_url($baseurl, array('update' => $mod->id)),
3220             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3221             null,
3222             array('class' => 'editing_update', 'title' => $str->update)
3223         );
3224     }
3226     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3227     if (has_all_capabilities($dupecaps, $coursecontext) && plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3228         $actions[] = new action_link(
3229             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3230             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3231             null,
3232             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3233         );
3234     }
3236     // Delete
3237     if ($hasmanageactivities) {
3238         $actions[] = new action_link(
3239             new moodle_url($baseurl, array('delete' => $mod->id)),
3240             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3241             null,
3242             array('class' => 'editing_delete', 'title' => $str->delete)
3243         );
3244     }
3246     // hideshow
3247     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3248         if ($mod->visible) {
3249             $actions[] = new action_link(
3250                 new moodle_url($baseurl, array('hide' => $mod->id)),
3251                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3252                 null,
3253                 array('class' => 'editing_hide', 'title' => $str->hide)
3254             );
3255         } else {
3256             $actions[] = new action_link(
3257                 new moodle_url($baseurl, array('show' => $mod->id)),
3258                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3259                 null,
3260                 array('class' => 'editing_show', 'title' => $str->show)
3261             );
3262         }
3263     }
3265     // groupmode
3266     if ($hasmanageactivities and $mod->groupmode !== false) {
3267         if ($mod->groupmode == SEPARATEGROUPS) {
3268             $groupmode = 0;
3269             $grouptitle = $str->groupsseparate;
3270             $forcedgrouptitle = $str->forcedgroupsseparate;
3271             $groupclass = 'editing_groupsseparate';
3272             $groupimage = 't/groups';
3273         } else if ($mod->groupmode == VISIBLEGROUPS) {
3274             $groupmode = 1;
3275             $grouptitle = $str->groupsvisible;
3276             $forcedgrouptitle = $str->forcedgroupsvisible;
3277             $groupclass = 'editing_groupsvisible';
3278             $groupimage = 't/groupv';
3279         } else {
3280             $groupmode = 2;
3281             $grouptitle = $str->groupsnone;
3282             $forcedgrouptitle = $str->forcedgroupsnone;
3283             $groupclass = 'editing_groupsnone';
3284             $groupimage = 't/groupn';
3285         }
3286         if ($mod->groupmodelink) {
3287             $actions[] = new action_link(
3288                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3289                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3290                 null,
3291                 array('class' => $groupclass, 'title' => $grouptitle)
3292             );
3293         } else {
3294             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3295         }
3296     }
3298     // Assign
3299     if (has_capability('moodle/role:assign', $modcontext)){
3300         $actions[] = new action_link(
3301             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3302             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3303             null,
3304             array('class' => 'editing_assign', 'title' => $str->assign)
3305         );
3306     }
3308     $output = html_writer::start_tag('span', array('class' => 'commands'));
3309     foreach ($actions as $action) {
3310         if ($action instanceof renderable) {
3311             $output .= $OUTPUT->render($action);
3312         } else {
3313             $output .= $action;
3314         }
3315     }
3316     $output .= html_writer::end_tag('span');
3317     return $output;
3320 /**
3321  * given a course object with shortname & fullname, this function will
3322  * truncate the the number of chars allowed and add ... if it was too long
3323  */
3324 function course_format_name ($course,$max=100) {
3326     $context = context_course::instance($course->id);
3327     $shortname = format_string($course->shortname, true, array('context' => $context));
3328     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3329     $str = $shortname.': '. $fullname;
3330     if (textlib::strlen($str) <= $max) {
3331         return $str;
3332     }
3333     else {
3334         return textlib::substr($str,0,$max-3).'...';
3335     }
3338 /**
3339  * Is the user allowed to add this type of module to this course?
3340  * @param object $course the course settings. Only $course->id is used.
3341  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3342  * @return bool whether the current user is allowed to add this type of module to this course.
3343  */
3344 function course_allowed_module($course, $modname) {
3345     if (is_numeric($modname)) {
3346         throw new coding_exception('Function course_allowed_module no longer
3347                 supports numeric module ids. Please update your code to pass the module name.');
3348     }
3350     $capability = 'mod/' . $modname . ':addinstance';
3351     if (!get_capability_info($capability)) {
3352         // Debug warning that the capability does not exist, but no more than once per page.
3353         static $warned = array();
3354         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3355         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3356             debugging('The module ' . $modname . ' does not define the standard capability ' .
3357                     $capability , DEBUG_DEVELOPER);
3358             $warned[$modname] = 1;
3359         }
3361         // If the capability does not exist, the module can always be added.
3362         return true;
3363     }
3365     $coursecontext = context_course::instance($course->id);
3366     return has_capability($capability, $coursecontext);
3369 /**
3370  * Recursively delete category including all subcategories and courses.
3371  * @param stdClass $category
3372  * @param boolean $showfeedback display some notices
3373  * @return array return deleted courses
3374  */
3375 function category_delete_full($category, $showfeedback=true) {
3376     global $CFG, $DB;
3377     require_once($CFG->libdir.'/gradelib.php');
3378     require_once($CFG->libdir.'/questionlib.php');
3379     require_once($CFG->dirroot.'/cohort/lib.php');
3381     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3382         foreach ($children as $childcat) {
3383             category_delete_full($childcat, $showfeedback);
3384         }
3385     }
3387     $deletedcourses = array();
3388     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3389         foreach ($courses as $course) {
3390             if (!delete_course($course, false)) {
3391                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3392             }
3393             $deletedcourses[] = $course;
3394         }
3395     }
3397     // move or delete cohorts in this context
3398     cohort_delete_category($category);
3400     // now delete anything that may depend on course category context
3401     grade_course_category_delete($category->id, 0, $showfeedback);
3402     if (!question_delete_course_category($category, 0, $showfeedback)) {
3403         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3404     }
3406     // finally delete the category and it's context
3407     $DB->delete_records('course_categories', array('id'=>$category->id));
3408     delete_context(CONTEXT_COURSECAT, $category->id);
3410     events_trigger('course_category_deleted', $category);
3412     return $deletedcourses;
3415 /**
3416  * Delete category, but move contents to another category.
3417  * @param object $ccategory
3418  * @param int $newparentid category id
3419  * @return bool status
3420  */
3421 function category_delete_move($category, $newparentid, $showfeedback=true) {
3422     global $CFG, $DB, $OUTPUT;
3423     require_once($CFG->libdir.'/gradelib.php');
3424     require_once($CFG->libdir.'/questionlib.php');
3425     require_once($CFG->dirroot.'/cohort/lib.php');
3427     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3428         return false;
3429     }
3431     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3432         foreach ($children as $childcat) {
3433             move_category($childcat, $newparentcat);
3434         }
3435     }
3437     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3438         if (!move_courses(array_keys($courses), $newparentid)) {
3439             if ($showfeedback) {
3440                 echo $OUTPUT->notification("Error moving courses");
3441             }
3442             return false;
3443         }
3444         if ($showfeedback) {
3445             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3446         }
3447     }
3449     // move or delete cohorts in this context
3450     cohort_delete_category($category);
3452     // now delete anything that may depend on course category context
3453     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3454     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3455         if ($showfeedback) {
3456             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3457         }
3458         return false;
3459     }
3461     // finally delete the category and it's context
3462     $DB->delete_records('course_categories', array('id'=>$category->id));
3463     delete_context(CONTEXT_COURSECAT, $category->id);
3465     events_trigger('course_category_deleted', $category);
3467     if ($showfeedback) {
3468         echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3469     }
3470     return true;
3473 /**
3474  * Efficiently moves many courses around while maintaining
3475  * sortorder in order.
3476  *
3477  * @param array $courseids is an array of course ids
3478  * @param int $categoryid
3479  * @return bool success
3480  */
3481 function move_courses($courseids, $categoryid) {
3482     global $CFG, $DB, $OUTPUT;
3484     if (empty($courseids)) {
3485         // nothing to do
3486         return;
3487     }
3489     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3490         return false;
3491     }
3493     $courseids = array_reverse($courseids);
3494     $newparent = context_coursecat::instance($category->id);
3495     $i = 1;
3497     foreach ($courseids as $courseid) {
3498         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3499             $course = new stdClass();
3500             $course->id = $courseid;
3501             $course->category  = $category->id;
3502             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3503             if ($category->visible == 0) {
3504                 // hide the course when moving into hidden category,
3505                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3506                 $course->visible = 0;
3507             }
3509             $DB->update_record('course', $course);
3511             $context   = context_course::instance($course->id);
3512             context_moved($context, $newparent);
3513         }
3514     }
3515     fix_course_sortorder();
3517     return true;
3520 /**
3521  * Hide course category and child course and subcategories
3522  * @param stdClass $category
3523  * @return void
3524  */
3525 function course_category_hide($category) {
3526     global $DB;
3528     $category->visible = 0;
3529     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3530     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3531     $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
3532     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3533     // get all child categories and hide too
3534     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3535         foreach ($subcats as $cat) {
3536             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3537             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3538             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3539             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3540         }
3541     }
3544 /**
3545  * Show course category and child course and subcategories
3546  * @param stdClass $category
3547  * @return void
3548  */
3549 function course_category_show($category) {
3550     global $DB;
3552     $category->visible = 1;
3553     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3554     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3555     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3556     // get all child categories and unhide too
3557     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3558         foreach ($subcats as $cat) {
3559             if ($cat->visibleold) {
3560                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3561             }
3562             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3563         }
3564     }
3567 /**
3568  * Efficiently moves a category - NOTE that this can have
3569  * a huge impact access-control-wise...
3570  */
3571 function move_category($category, $newparentcat) {
3572     global $CFG, $DB;
3574     $context = context_coursecat::instance($category->id);
3576     $hidecat = false;
3577     if (empty($newparentcat->id)) {
3578         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3580         $newparent = context_system::instance();
3582     } else {
3583         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3584         $newparent = context_coursecat::instance($newparentcat->id);
3586         if (!$newparentcat->visible and $category->visible) {
3587             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3588             $hidecat = true;
3589         }
3590     }
3592     context_moved($context, $newparent);
3594     // now make it last in new category
3595     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3597     // and fix the sortorders
3598     fix_course_sortorder();
3600     if ($hidecat) {
3601         course_category_hide($category);
3602     }
3605 /**
3606  * Returns the display name of the given section that the course prefers
3607  *
3608  * Implementation of this function is provided by course format
3609  * @see format_base::get_section_name()
3610  *
3611  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
3612  * @param int|stdClass $section Section object from database or just field course_sections.section
3613  * @return string Display name that the course format prefers, e.g. "Week 2"
3614  */
3615 function get_section_name($courseorid, $section) {
3616     return course_get_format($courseorid)->get_section_name($section);
3619 /**
3620  * Tells if current course format uses sections
3621  *
3622  * @param string $format Course format ID e.g. 'weeks' $course->format
3623  * @return bool
3624  */
3625 function course_format_uses_sections($format) {
3626     $course = new stdClass();
3627     $course->format = $format;
3628     return course_get_format($course)->uses_sections();
3631 /**
3632  * Returns the information about the ajax support in the given source format
3633  *
3634  * The returned object's property (boolean)capable indicates that
3635  * the course format supports Moodle course ajax features.
3636  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3637  *
3638  * @param string $format
3639  * @return stdClass
3640  */
3641 function course_format_ajax_support($format) {
3642     $course = new stdClass();
3643     $course->format = $format;
3644     return course_get_format($course)->supports_ajax();
3647 /**
3648  * Can the current user delete this course?
3649  * Course creators have exception,
3650  * 1 day after the creation they can sill delete the course.
3651  * @param int $courseid
3652  * @return boolean
3653  */
3654 function can_delete_course($courseid) {
3655     global $USER, $DB;
3657     $context = context_course::instance($courseid);
3659     if (has_capability('moodle/course:delete', $context)) {
3660         return true;
3661     }
3663     // hack: now try to find out if creator created this course recently (1 day)
3664     if (!has_capability('moodle/course:create', $context)) {
3665         return false;
3666     }
3668     $since = time() - 60*60*24;
3670     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3671     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3673     return $DB->record_exists_select('log', $select, $params);
3676 /**
3677  * Save the Your name for 'Some role' strings.
3678  *
3679  * @param integer $courseid the id of this course.
3680  * @param array $data the data that came from the course settings form.
3681  */
3682 function save_local_role_names($courseid, $data) {
3683     global $DB;
3684     $context = context_course::instance($courseid);
3686     foreach ($data as $fieldname => $value) {
3687         if (strpos($fieldname, 'role_') !== 0) {
3688             continue;
3689         }
3690         list($ignored, $roleid) = explode('_', $fieldname);
3692         // make up our mind whether we want to delete, update or insert
3693         if (!$value) {
3694             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3696         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3697             $rolename->name = $value;
3698             $DB->update_record('role_names', $rolename);
3700         } else {
3701             $rolename = new stdClass;
3702             $rolename->contextid = $context->id;
3703             $rolename->roleid = $roleid;
3704             $rolename->name = $value;
3705             $DB->insert_record('role_names', $rolename);
3706         }
3707     }
3710 /**
3711  * Create a course and either return a $course object
3712  *
3713  * Please note this functions does not verify any access control,
3714  * the calling code is responsible for all validation (usually it is the form definition).
3715  *
3716  * @param array $editoroptions course description editor options
3717  * @param object $data  - all the data needed for an entry in the 'course' table
3718  * @return object new course instance
3719  */
3720 function create_course($data, $editoroptions = NULL) {
3721     global $CFG, $DB;
3723     //check the categoryid - must be given for all new courses
3724     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3726     //check if the shortname already exist
3727     if (!empty($data->shortname)) {
3728         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3729             throw new moodle_exception('shortnametaken');
3730         }
3731     }
3733     //check if the id number already exist
3734     if (!empty($data->idnumber)) {
3735         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3736             throw new moodle_exception('idnumbertaken');
3737         }
3738     }
3740     $data->timecreated  = time();
3741     $data->timemodified = $data->timecreated;
3743     // place at beginning of any category
3744     $data->sortorder = 0;
3746     if ($editoroptions) {
3747         // summary text is updated later, we need context to store the files first
3748         $data->summary = '';
3749         $data->summary_format = FORMAT_HTML;
3750     }
3752     if (!isset($data->visible)) {
3753         // data not from form, add missing visibility info
3754         $data->visible = $category->visible;
3755     }
3756     $data->visibleold = $data->visible;
3758     $newcourseid = $DB->insert_record('course', $data);
3759     $context = context_course::instance($newcourseid, MUST_EXIST);
3761     if ($editoroptions) {
3762         // Save the files used in the summary editor and store
3763         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3764         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3765         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3766     }
3768     $course = $DB->get_record('course', array('id'=>$newcourseid));
3770     // Setup the blocks
3771     blocks_add_default_course_blocks($course);
3773     // Create a default section.
3774     course_create_sections_if_missing($course, 0);
3776     fix_course_sortorder();
3778     // new context created - better mark it as dirty
3779     mark_context_dirty($context->path);
3781     // Save any custom role names.
3782     save_local_role_names($course->id, (array)$data);
3784     // set up enrolments
3785     enrol_course_updated(true, $course, $data);
3787     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3789     // Trigger events
3790     events_trigger('course_created', $course);
3792     return $course;
3795 /**
3796  * Create a new course category and marks the context as dirty
3797  *
3798  * This function does not set the sortorder for the new category and
3799  * @see{fix_course_sortorder} should be called after creating a new course
3800  * category
3801  *
3802  * Please note that this function does not verify access control.
3803  *
3804  * @param object $category All of the data required for an entry in the course_categories table
3805  * @return object new course category
3806  */
3807 function create_course_category($category) {
3808     global $DB;
3810     $category->timemodified = time();
3811     $category->id = $DB->insert_record('course_categories', $category);
3812     $category = $DB->get_record('course_categories', array('id' => $category->id));
3814     // We should mark the context as dirty
3815     $category->context = context_coursecat::instance($category->id);
3816     $category->context->mark_dirty();
3818     return $category;
3821 /**
3822  * Update a course.
3823  *
3824  * Please note this functions does not verify any access control,
3825  * the calling code is responsible for all validation (usually it is the form definition).
3826  *
3827  * @param object $data  - all the data needed for an entry in the 'course' table
3828  * @param array $editoroptions course description editor options
3829  * @return void
3830  */
3831 function update_course($data, $editoroptions = NULL) {
3832     global $CFG, $DB;
3834     $data->timemodified = time();
3836     $oldcourse = $DB->get_record('course', array('id'=>$data->id), '*', MUST_EXIST);
3837     $context   = context_course::instance($oldcourse->id);
3839     if ($editoroptions) {
3840         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3841     }
3843     if (!isset($data->category) or empty($data->category)) {
3844         // prevent nulls and 0 in category field
3845         unset($data->category);
3846     }
3847     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3849     if (!isset($data->visible)) {
3850         // data not from form, add missing visibility info
3851         $data->visible = $oldcourse->visible;
3852     }
3854     if ($data->visible != $oldcourse->visible) {
3855         // reset the visibleold flag when manually hiding/unhiding course
3856         $data->visibleold = $data->visible;
3857     } else {
3858         if ($movecat) {
3859             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3860             if (empty($newcategory->visible)) {
3861                 // make sure when moving into hidden category the course is hidden automatically
3862                 $data->visible = 0;
3863             }
3864         }
3865     }
3867     // Update with the new data
3868     $DB->update_record('course', $data);
3869     // make sure the modinfo cache is reset
3870     rebuild_course_cache($data->id);
3872     $course = $DB->get_record('course', array('id'=>$data->id));
3874     if ($movecat) {
3875         $newparent = context_coursecat::instance($course->category);
3876         context_moved($context, $newparent);
3877     }
3879     fix_course_sortorder();
3881     // Test for and remove blocks which aren't appropriate anymore
3882     blocks_remove_inappropriate($course);
3884     // Save any custom role names.
3885     save_local_role_names($course->id, $data);
3887     // update enrol settings
3888     enrol_course_updated(false, $course, $data);
3890     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3892     // Trigger events
3893     events_trigger('course_updated', $course);
3896 /**
3897  * Average number of participants
3898  * @return integer
3899  */
3900 function average_number_of_participants() {
3901     global $DB, $SITE;
3903     //count total of enrolments for visible course (except front page)
3904     $sql = 'SELECT COUNT(*) FROM (
3905         SELECT DISTINCT ue.userid, e.courseid
3906         FROM {user_enrolments} ue, {enrol} e, {course} c
3907         WHERE ue.enrolid = e.id
3908             AND e.courseid <> :siteid
3909             AND c.id = e.courseid
3910             AND c.visible = 1) total';
3911     $params = array('siteid' => $SITE->id);
3912     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3915     //count total of visible courses (minus front page)
3916     $coursetotal = $DB->count_records('course', array('visible' => 1));
3917     $coursetotal = $coursetotal - 1 ;
3919     //average of enrolment
3920     if (empty($coursetotal)) {
3921         $participantaverage = 0;
3922     } else {
3923         $participantaverage = $enrolmenttotal / $coursetotal;
3924     }
3926     return $participantaverage;
3929 /**
3930  * Average number of course modules
3931  * @return integer
3932  */
3933 function average_number_of_courses_modules() {
3934     global $DB, $SITE;
3936     //count total of visible course module (except front page)
3937     $sql = 'SELECT COUNT(*) FROM (
3938         SELECT cm.course, cm.module
3939         FROM {course} c, {course_modules} cm
3940         WHERE c.id = cm.course
3941             AND c.id <> :siteid
3942             AND cm.visible = 1
3943             AND c.visible = 1) total';
3944     $params = array('siteid' => $SITE->id);
3945     $moduletotal = $DB->count_records_sql($sql, $params);
3948     //count total of visible courses (minus front page)
3949     $coursetotal = $DB->count_records('course', array('visible' => 1));
3950     $coursetotal = $coursetotal - 1 ;
3952     //average of course module
3953     if (empty($coursetotal)) {
3954         $coursemoduleaverage = 0;
3955     } else {
3956         $coursemoduleaverage = $moduletotal / $coursetotal;
3957     }
3959     return $coursemoduleaverage;
3962 /**
3963  * This class pertains to course requests and contains methods associated with
3964  * create, approving, and removing course requests.
3965  *
3966  * Please note we do not allow embedded images here because there is no context
3967  * to store them with proper access control.
3968  *
3969  * @copyright 2009 Sam Hemelryk
3970  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3971  * @since Moodle 2.0
3972  *
3973  * @property-read int $id
3974  * @property-read string $fullname
3975  * @property-read string $shortname
3976  * @property-read string $summary
3977  * @property-read int $summaryformat
3978  * @property-read int $summarytrust
3979  * @property-read string $reason
3980  * @property-read int $requester
3981  */
3982 class course_request {
3984     /**
3985      * This is the stdClass that stores the properties for the course request
3986      * and is externally accessed through the __get magic method
3987      * @var stdClass
3988      */
3989     protected $properties;
3991     /**
3992      * An array of options for the summary editor used by course request forms.
3993      * This is initially set by {@link summary_editor_options()}
3994      * @var array
3995      * @static
3996      */
3997     protected static $summaryeditoroptions;
3999     /**
4000      * Static function to prepare the summary editor for working with a course
4001      * request.
4002      *
4003      * @static
4004      * @param null|stdClass $data Optional, an object containing the default values
4005      *                       for the form, these may be modified when preparing the
4006      *                       editor so this should be called before creating the form
4007      * @return stdClass An object that can be used to set the default values for
4008      *                   an mforms form
4009      */
4010     public static function prepare($data=null) {
4011         if ($data === null) {
4012             $data = new stdClass;
4013         }
4014         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
4015         return $data;
4016     }
4018     /**
4019      * Static function to create a new course request when passed an array of properties
4020      * for it.
4021      *
4022      * This function also handles saving any files that may have been used in the editor
4023      *
4024      * @static
4025      * @param stdClass $data
4026      * @return course_request The newly created course request
4027      */
4028     public static function create($data) {
4029         global $USER, $DB, $CFG;
4030         $data->requester = $USER->id;
4032         // Setting the default category if none set.
4033         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
4034             $data->category = $CFG->defaultrequestcategory;
4035         }
4037         // Summary is a required field so copy the text over
4038         $data->summary       = $data->summary_editor['text'];
4039         $data->summaryformat = $data->summary_editor['format'];
4041         $data->id = $DB->insert_record('course_request', $data);
4043         // Create a new course_request object and return it
4044         $request = new course_request($data);
4046         // Notify the admin if required.
4047         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
4049             $a = new stdClass;
4050             $a->link = "$CFG->wwwroot/course/pending.php";
4051             $a->user = fullname($USER);
4052             $subject = get_string('courserequest');
4053             $message = get_string('courserequestnotifyemail', 'admin', $a);
4054             foreach ($users as $user) {
4055                 $request->notify($user, $USER, 'courserequested', $subject, $message);
4056             }
4057         }
4059         return $request;
4060     }
4062     /**
4063      * Returns an array of options to use with a summary editor
4064      *
4065      * @uses course_request::$summaryeditoroptions
4066      * @return array An array of options to use with the editor
4067      */
4068     public static function summary_editor_options() {
4069         global $CFG;
4070         if (self::$summaryeditoroptions === null) {
4071             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
4072         }
4073         return self::$summaryeditoroptions;
4074     }
4076     /**
4077      * Loads the properties for this course request object. Id is required and if
4078      * only id is provided then we load the rest of the properties from the database
4079      *
4080      * @param stdClass|int $properties Either an object containing properties
4081      *                      or the course_request id to load
4082      */
4083     public function __construct($properties) {
4084         global $DB;
4085         if (empty($properties->id)) {
4086             if (empty($properties)) {
4087                 throw new coding_exception('You must provide a course request id when creating a course_request object');
4088             }
4089             $id = $properties;
4090             $properties = new stdClass;
4091             $properties->id = (int)$id;
4092             unset($id);
4093         }
4094         if (empty($properties->requester)) {
4095             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
4096                 print_error('unknowncourserequest');
4097             }
4098         } else {
4099             $this->properties = $properties;
4100         }
4101         $this->properties->collision = null;
4102     }
4104     /**
4105      * Returns the requested property
4106      *
4107      * @param string $key
4108      * @return mixed
4109      */
4110     public function __get($key) {
4111         return $this->properties->$key;
4112     }
4114     /**
4115      * Override this to ensure empty($request->blah) calls return a reliable answer...
4116      *
4117      * This is required because we define the __get method
4118      *
4119      * @param mixed $key
4120      * @return bool True is it not empty, false otherwise
4121      */
4122     public function __isset($key) {
4123         return (!empty($this->properties->$key));
4124     }
4126     /**
4127      * Returns the user who requested this course
4128      *
4129      * Uses a static var to cache the results and cut down the number of db queries
4130      *
4131      * @staticvar array $requesters An array of cached users
4132      * @return stdClass The user who requested the course
4133      */
4134     public function get_requester() {
4135         global $DB;
4136         static $requesters= array();
4137         if (!array_key_exists($this->properties->requester, $requesters)) {
4138             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
4139         }
4140         return $requesters[$this->properties->requester];
4141     }
4143     /**
4144      * Checks that the shortname used by the course does not conflict with any other
4145      * courses that exist
4146      *
4147      * @param string|null $shortnamemark The string to append to the requests shortname
4148      *                     should a conflict be found
4149      * @return bool true is there is a conflict, false otherwise
4150      */
4151     public function check_shortname_collision($shortnamemark = '[*]') {
4152         global $DB;
4154         if ($this->properties->collision !== null) {
4155             return $this->properties->collision;