MDL-37654 core_course: ensure exceptions return static error codes for debugging...
[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
37 /**
38  * Number of courses to display when summaries are included.
39  * @var int
40  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
41  */
42 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
44 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
45 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
46 define('FRONTPAGENEWS',           '0');
47 define('FRONTPAGECOURSELIST',     '1');
48 define('FRONTPAGECATEGORYNAMES',  '2');
49 define('FRONTPAGETOPICONLY',      '3');
50 define('FRONTPAGECATEGORYCOMBO',  '4');
51 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 function make_log_url($module, $url) {
59     switch ($module) {
60         case 'course':
61             if (strpos($url, 'report/') === 0) {
62                 // there is only one report type, course reports are deprecated
63                 $url = "/$url";
64                 break;
65             }
66         case 'file':
67         case 'login':
68         case 'lib':
69         case 'admin':
70         case 'calendar':
71         case 'category':
72         case 'mnet course':
73             if (strpos($url, '../') === 0) {
74                 $url = ltrim($url, '.');
75             } else {
76                 $url = "/course/$url";
77             }
78             break;
79         case 'user':
80         case 'blog':
81             $url = "/$module/$url";
82             break;
83         case 'upload':
84             $url = $url;
85             break;
86         case 'coursetags':
87             $url = '/'.$url;
88             break;
89         case 'library':
90         case '':
91             $url = '/';
92             break;
93         case 'message':
94             $url = "/message/$url";
95             break;
96         case 'notes':
97             $url = "/notes/$url";
98             break;
99         case 'tag':
100             $url = "/tag/$url";
101             break;
102         case 'role':
103             $url = '/'.$url;
104             break;
105         default:
106             $url = "/mod/$module/$url";
107             break;
108     }
110     //now let's sanitise urls - there might be some ugly nasties:-(
111     $parts = explode('?', $url);
112     $script = array_shift($parts);
113     if (strpos($script, 'http') === 0) {
114         $script = clean_param($script, PARAM_URL);
115     } else {
116         $script = clean_param($script, PARAM_PATH);
117     }
119     $query = '';
120     if ($parts) {
121         $query = implode('', $parts);
122         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
123         $parts = explode('&', $query);
124         $eq = urlencode('=');
125         foreach ($parts as $key=>$part) {
126             $part = urlencode(urldecode($part));
127             $part = str_replace($eq, '=', $part);
128             $parts[$key] = $part;
129         }
130         $query = '?'.implode('&amp;', $parts);
131     }
133     return $script.$query;
137 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
138                    $modname="", $modid=0, $modaction="", $groupid=0) {
139     global $CFG, $DB;
141     // It is assumed that $date is the GMT time of midnight for that day,
142     // and so the next 86400 seconds worth of logs are printed.
144     /// Setup for group handling.
146     // TODO: I don't understand group/context/etc. enough to be able to do
147     // something interesting with it here
148     // What is the context of a remote course?
150     /// If the group mode is separate, and this user does not have editing privileges,
151     /// then only the user's group can be viewed.
152     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
153     //    $groupid = get_current_group($course->id);
154     //}
155     /// If this course doesn't have groups, no groupid can be specified.
156     //else if (!$course->groupmode) {
157     //    $groupid = 0;
158     //}
160     $groupid = 0;
162     $joins = array();
163     $where = '';
165     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
166               FROM {mnet_log} l
167                LEFT JOIN {user} u ON l.userid = u.id
168               WHERE ";
169     $params = array();
171     $where .= "l.hostid = :hostid";
172     $params['hostid'] = $hostid;
174     // TODO: Is 1 really a magic number referring to the sitename?
175     if ($course != SITEID || $modid != 0) {
176         $where .= " AND l.course=:courseid";
177         $params['courseid'] = $course;
178     }
180     if ($modname) {
181         $where .= " AND l.module = :modname";
182         $params['modname'] = $modname;
183     }
185     if ('site_errors' === $modid) {
186         $where .= " AND ( l.action='error' OR l.action='infected' )";
187     } else if ($modid) {
188         //TODO: This assumes that modids are the same across sites... probably
189         //not true
190         $where .= " AND l.cmid = :modid";
191         $params['modid'] = $modid;
192     }
194     if ($modaction) {
195         $firstletter = substr($modaction, 0, 1);
196         if ($firstletter == '-') {
197             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
198             $params['modaction'] = '%'.substr($modaction, 1).'%';
199         } else {
200             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
201             $params['modaction'] = '%'.$modaction.'%';
202         }
203     }
205     if ($user) {
206         $where .= " AND l.userid = :user";
207         $params['user'] = $user;
208     }
210     if ($date) {
211         $enddate = $date + 86400;
212         $where .= " AND l.time > :date AND l.time < :enddate";
213         $params['date'] = $date;
214         $params['enddate'] = $enddate;
215     }
217     $result = array();
218     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
219     if(!empty($result['totalcount'])) {
220         $where .= " ORDER BY $order";
221         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
222     } else {
223         $result['logs'] = array();
224     }
225     return $result;
228 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
229                    $modname="", $modid=0, $modaction="", $groupid=0) {
230     global $DB, $SESSION, $USER;
231     // It is assumed that $date is the GMT time of midnight for that day,
232     // and so the next 86400 seconds worth of logs are printed.
234     /// Setup for group handling.
236     /// If the group mode is separate, and this user does not have editing privileges,
237     /// then only the user's group can be viewed.
238     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
239         if (isset($SESSION->currentgroup[$course->id])) {
240             $groupid =  $SESSION->currentgroup[$course->id];
241         } else {
242             $groupid = groups_get_all_groups($course->id, $USER->id);
243             if (is_array($groupid)) {
244                 $groupid = array_shift(array_keys($groupid));
245                 $SESSION->currentgroup[$course->id] = $groupid;
246             } else {
247                 $groupid = 0;
248             }
249         }
250     }
251     /// If this course doesn't have groups, no groupid can be specified.
252     else if (!$course->groupmode) {
253         $groupid = 0;
254     }
256     $joins = array();
257     $params = array();
259     if ($course->id != SITEID || $modid != 0) {
260         $joins[] = "l.course = :courseid";
261         $params['courseid'] = $course->id;
262     }
264     if ($modname) {
265         $joins[] = "l.module = :modname";
266         $params['modname'] = $modname;
267     }
269     if ('site_errors' === $modid) {
270         $joins[] = "( l.action='error' OR l.action='infected' )";
271     } else if ($modid) {
272         $joins[] = "l.cmid = :modid";
273         $params['modid'] = $modid;
274     }
276     if ($modaction) {
277         $firstletter = substr($modaction, 0, 1);
278         if ($firstletter == '-') {
279             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
280             $params['modaction'] = '%'.substr($modaction, 1).'%';
281         } else {
282             $joins[] = $DB->sql_like('l.action', ':modaction', false);
283             $params['modaction'] = '%'.$modaction.'%';
284         }
285     }
288     /// Getting all members of a group.
289     if ($groupid and !$user) {
290         if ($gusers = groups_get_members($groupid)) {
291             $gusers = array_keys($gusers);
292             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
293         } else {
294             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
295         }
296     }
297     else if ($user) {
298         $joins[] = "l.userid = :userid";
299         $params['userid'] = $user;
300     }
302     if ($date) {
303         $enddate = $date + 86400;
304         $joins[] = "l.time > :date AND l.time < :enddate";
305         $params['date'] = $date;
306         $params['enddate'] = $enddate;
307     }
309     $selector = implode(' AND ', $joins);
311     $totalcount = 0;  // Initialise
312     $result = array();
313     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
314     $result['totalcount'] = $totalcount;
315     return $result;
319 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
320                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
322     global $CFG, $DB, $OUTPUT;
324     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
325                        $modname, $modid, $modaction, $groupid)) {
326         echo $OUTPUT->notification("No logs found!");
327         echo $OUTPUT->footer();
328         exit;
329     }
331     $courses = array();
333     if ($course->id == SITEID) {
334         $courses[0] = '';
335         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
336             foreach ($ccc as $cc) {
337                 $courses[$cc->id] = $cc->shortname;
338             }
339         }
340     } else {
341         $courses[$course->id] = $course->shortname;
342     }
344     $totalcount = $logs['totalcount'];
345     $count=0;
346     $ldcache = array();
347     $tt = getdate(time());
348     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
350     $strftimedatetime = get_string("strftimedatetime");
352     echo "<div class=\"info\">\n";
353     print_string("displayingrecords", "", $totalcount);
354     echo "</div>\n";
356     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
358     $table = new html_table();
359     $table->classes = array('logtable','generalbox');
360     $table->align = array('right', 'left', 'left');
361     $table->head = array(
362         get_string('time'),
363         get_string('ip_address'),
364         get_string('fullnameuser'),
365         get_string('action'),
366         get_string('info')
367     );
368     $table->data = array();
370     if ($course->id == SITEID) {
371         array_unshift($table->align, 'left');
372         array_unshift($table->head, get_string('course'));
373     }
375     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
376     if (empty($logs['logs'])) {
377         $logs['logs'] = array();
378     }
380     foreach ($logs['logs'] as $log) {
382         if (isset($ldcache[$log->module][$log->action])) {
383             $ld = $ldcache[$log->module][$log->action];
384         } else {
385             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
386             $ldcache[$log->module][$log->action] = $ld;
387         }
388         if ($ld && is_numeric($log->info)) {
389             // ugly hack to make sure fullname is shown correctly
390             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
391                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
392             } else {
393                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
394             }
395         }
397         //Filter log->info
398         $log->info = format_string($log->info);
400         // If $log->url has been trimmed short by the db size restriction
401         // code in add_to_log, keep a note so we don't add a link to a broken url
402         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
404         $row = array();
405         if ($course->id == SITEID) {
406             if (empty($log->course)) {
407                 $row[] = get_string('site');
408             } else {
409                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
410             }
411         }
413         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
415         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
416         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
418         $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))));
420         $displayaction="$log->module $log->action";
421         if ($brokenurl) {
422             $row[] = $displayaction;
423         } else {
424             $link = make_log_url($log->module,$log->url);
425             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
426         }
427         $row[] = $log->info;
428         $table->data[] = $row;
429     }
431     echo html_writer::table($table);
432     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
436 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
437                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
439     global $CFG, $DB, $OUTPUT;
441     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
442                        $modname, $modid, $modaction, $groupid)) {
443         echo $OUTPUT->notification("No logs found!");
444         echo $OUTPUT->footer();
445         exit;
446     }
448     if ($course->id == SITEID) {
449         $courses[0] = '';
450         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
451             foreach ($ccc as $cc) {
452                 $courses[$cc->id] = $cc->shortname;
453             }
454         }
455     }
457     $totalcount = $logs['totalcount'];
458     $count=0;
459     $ldcache = array();
460     $tt = getdate(time());
461     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
463     $strftimedatetime = get_string("strftimedatetime");
465     echo "<div class=\"info\">\n";
466     print_string("displayingrecords", "", $totalcount);
467     echo "</div>\n";
469     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
471     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
472     echo "<tr>";
473     if ($course->id == SITEID) {
474         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
475     }
476     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
477     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
478     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
479     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
480     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
481     echo "</tr>\n";
483     if (empty($logs['logs'])) {
484         echo "</table>\n";
485         return;
486     }
488     $row = 1;
489     foreach ($logs['logs'] as $log) {
491         $log->info = $log->coursename;
492         $row = ($row + 1) % 2;
494         if (isset($ldcache[$log->module][$log->action])) {
495             $ld = $ldcache[$log->module][$log->action];
496         } else {
497             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
498             $ldcache[$log->module][$log->action] = $ld;
499         }
500         if (0 && $ld && !empty($log->info)) {
501             // ugly hack to make sure fullname is shown correctly
502             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
503                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
504             } else {
505                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
506             }
507         }
509         //Filter log->info
510         $log->info = format_string($log->info);
512         echo '<tr class="r'.$row.'">';
513         if ($course->id == SITEID) {
514             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
515             echo "<td class=\"r$row c0\" >\n";
516             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
517             echo "</td>\n";
518         }
519         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
520              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
521         echo "<td class=\"r$row c2\" >\n";
522         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
523         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
524         echo "</td>\n";
525         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
526         echo "<td class=\"r$row c3\" >\n";
527         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
528         echo "</td>\n";
529         echo "<td class=\"r$row c4\">\n";
530         echo $log->action .': '.$log->module;
531         echo "</td>\n";
532         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
533         echo "</tr>\n";
534     }
535     echo "</table>\n";
537     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
541 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
542                         $modid, $modaction, $groupid) {
543     global $DB, $CFG;
545     require_once($CFG->libdir . '/csvlib.class.php');
547     $csvexporter = new csv_export_writer('tab');
549     $header = array();
550     $header[] = get_string('course');
551     $header[] = get_string('time');
552     $header[] = get_string('ip_address');
553     $header[] = get_string('fullnameuser');
554     $header[] = get_string('action');
555     $header[] = get_string('info');
557     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
558                        $modname, $modid, $modaction, $groupid)) {
559         return false;
560     }
562     $courses = array();
564     if ($course->id == SITEID) {
565         $courses[0] = '';
566         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
567             foreach ($ccc as $cc) {
568                 $courses[$cc->id] = $cc->shortname;
569             }
570         }
571     } else {
572         $courses[$course->id] = $course->shortname;
573     }
575     $count=0;
576     $ldcache = array();
577     $tt = getdate(time());
578     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
580     $strftimedatetime = get_string("strftimedatetime");
582     $csvexporter->set_filename('logs', '.txt');
583     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
584     $csvexporter->add_data($title);
585     $csvexporter->add_data($header);
587     if (empty($logs['logs'])) {
588         return true;
589     }
591     foreach ($logs['logs'] as $log) {
592         if (isset($ldcache[$log->module][$log->action])) {
593             $ld = $ldcache[$log->module][$log->action];
594         } else {
595             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
596             $ldcache[$log->module][$log->action] = $ld;
597         }
598         if ($ld && is_numeric($log->info)) {
599             // ugly hack to make sure fullname is shown correctly
600             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
601                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
602             } else {
603                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
604             }
605         }
607         //Filter log->info
608         $log->info = format_string($log->info);
609         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
611         $coursecontext = context_course::instance($course->id);
612         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
613         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
614         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
615         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
616         $csvexporter->add_data($row);
617     }
618     $csvexporter->download_file();
619     return true;
623 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
624                         $modid, $modaction, $groupid) {
626     global $CFG, $DB;
628     require_once("$CFG->libdir/excellib.class.php");
630     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
631                        $modname, $modid, $modaction, $groupid)) {
632         return false;
633     }
635     $courses = array();
637     if ($course->id == SITEID) {
638         $courses[0] = '';
639         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
640             foreach ($ccc as $cc) {
641                 $courses[$cc->id] = $cc->shortname;
642             }
643         }
644     } else {
645         $courses[$course->id] = $course->shortname;
646     }
648     $count=0;
649     $ldcache = array();
650     $tt = getdate(time());
651     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
653     $strftimedatetime = get_string("strftimedatetime");
655     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
656     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
657     $filename .= '.xls';
659     $workbook = new MoodleExcelWorkbook('-');
660     $workbook->send($filename);
662     $worksheet = array();
663     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
664                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
666     // Creating worksheets
667     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
668         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
669         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
670         $worksheet[$wsnumber]->set_column(1, 1, 30);
671         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
672                                     userdate(time(), $strftimedatetime));
673         $col = 0;
674         foreach ($headers as $item) {
675             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
676             $col++;
677         }
678     }
680     if (empty($logs['logs'])) {
681         $workbook->close();
682         return true;
683     }
685     $formatDate =& $workbook->add_format();
686     $formatDate->set_num_format(get_string('log_excel_date_format'));
688     $row = FIRSTUSEDEXCELROW;
689     $wsnumber = 1;
690     $myxls =& $worksheet[$wsnumber];
691     foreach ($logs['logs'] as $log) {
692         if (isset($ldcache[$log->module][$log->action])) {
693             $ld = $ldcache[$log->module][$log->action];
694         } else {
695             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
696             $ldcache[$log->module][$log->action] = $ld;
697         }
698         if ($ld && is_numeric($log->info)) {
699             // ugly hack to make sure fullname is shown correctly
700             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
701                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
702             } else {
703                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
704             }
705         }
707         // Filter log->info
708         $log->info = format_string($log->info);
709         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
711         if ($nroPages>1) {
712             if ($row > EXCELROWS) {
713                 $wsnumber++;
714                 $myxls =& $worksheet[$wsnumber];
715                 $row = FIRSTUSEDEXCELROW;
716             }
717         }
719         $coursecontext = context_course::instance($course->id);
721         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
722         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
723         $myxls->write($row, 2, $log->ip, '');
724         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
725         $myxls->write($row, 3, $fullname, '');
726         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
727         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
728         $myxls->write($row, 5, $log->info, '');
730         $row++;
731     }
733     $workbook->close();
734     return true;
737 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
738                         $modid, $modaction, $groupid) {
740     global $CFG, $DB;
742     require_once("$CFG->libdir/odslib.class.php");
744     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
745                        $modname, $modid, $modaction, $groupid)) {
746         return false;
747     }
749     $courses = array();
751     if ($course->id == SITEID) {
752         $courses[0] = '';
753         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
754             foreach ($ccc as $cc) {
755                 $courses[$cc->id] = $cc->shortname;
756             }
757         }
758     } else {
759         $courses[$course->id] = $course->shortname;
760     }
762     $count=0;
763     $ldcache = array();
764     $tt = getdate(time());
765     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
767     $strftimedatetime = get_string("strftimedatetime");
769     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
770     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
771     $filename .= '.ods';
773     $workbook = new MoodleODSWorkbook('-');
774     $workbook->send($filename);
776     $worksheet = array();
777     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
778                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
780     // Creating worksheets
781     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
782         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
783         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
784         $worksheet[$wsnumber]->set_column(1, 1, 30);
785         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
786                                     userdate(time(), $strftimedatetime));
787         $col = 0;
788         foreach ($headers as $item) {
789             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
790             $col++;
791         }
792     }
794     if (empty($logs['logs'])) {
795         $workbook->close();
796         return true;
797     }
799     $formatDate =& $workbook->add_format();
800     $formatDate->set_num_format(get_string('log_excel_date_format'));
802     $row = FIRSTUSEDEXCELROW;
803     $wsnumber = 1;
804     $myxls =& $worksheet[$wsnumber];
805     foreach ($logs['logs'] as $log) {
806         if (isset($ldcache[$log->module][$log->action])) {
807             $ld = $ldcache[$log->module][$log->action];
808         } else {
809             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
810             $ldcache[$log->module][$log->action] = $ld;
811         }
812         if ($ld && is_numeric($log->info)) {
813             // ugly hack to make sure fullname is shown correctly
814             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
815                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
816             } else {
817                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
818             }
819         }
821         // Filter log->info
822         $log->info = format_string($log->info);
823         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
825         if ($nroPages>1) {
826             if ($row > EXCELROWS) {
827                 $wsnumber++;
828                 $myxls =& $worksheet[$wsnumber];
829                 $row = FIRSTUSEDEXCELROW;
830             }
831         }
833         $coursecontext = context_course::instance($course->id);
835         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
836         $myxls->write_date($row, 1, $log->time);
837         $myxls->write_string($row, 2, $log->ip);
838         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
839         $myxls->write_string($row, 3, $fullname);
840         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
841         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
842         $myxls->write_string($row, 5, $log->info);
844         $row++;
845     }
847     $workbook->close();
848     return true;
851 /**
852  * For a given course, returns an array of course activity objects
853  * Each item in the array contains he following properties:
854  */
855 function get_array_of_activities($courseid) {
856 //  cm - course module id
857 //  mod - name of the module (eg forum)
858 //  section - the number of the section (eg week or topic)
859 //  name - the name of the instance
860 //  visible - is the instance visible or not
861 //  groupingid - grouping id
862 //  groupmembersonly - is this instance visible to group members only
863 //  extra - contains extra string to include in any link
864     global $CFG, $DB;
865     if(!empty($CFG->enableavailability)) {
866         require_once($CFG->libdir.'/conditionlib.php');
867     }
869     $course = $DB->get_record('course', array('id'=>$courseid));
871     if (empty($course)) {
872         throw new moodle_exception('courseidnotfound');
873     }
875     $mod = array();
877     $rawmods = get_course_mods($courseid);
878     if (empty($rawmods)) {
879         return $mod; // always return array
880     }
882     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
883        foreach ($sections as $section) {
884            if (!empty($section->sequence)) {
885                $sequence = explode(",", $section->sequence);
886                foreach ($sequence as $seq) {
887                    if (empty($rawmods[$seq])) {
888                        continue;
889                    }
890                    $mod[$seq] = new stdClass();
891                    $mod[$seq]->id               = $rawmods[$seq]->instance;
892                    $mod[$seq]->cm               = $rawmods[$seq]->id;
893                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
895                     // Oh dear. Inconsistent names left here for backward compatibility.
896                    $mod[$seq]->section          = $section->section;
897                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
899                    $mod[$seq]->module           = $rawmods[$seq]->module;
900                    $mod[$seq]->added            = $rawmods[$seq]->added;
901                    $mod[$seq]->score            = $rawmods[$seq]->score;
902                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
903                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
904                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
905                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
906                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
907                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
908                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
909                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
910                    $mod[$seq]->extra            = "";
911                    $mod[$seq]->completiongradeitemnumber =
912                            $rawmods[$seq]->completiongradeitemnumber;
913                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
914                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
915                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
916                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
917                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
918                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
919                    if (!empty($CFG->enableavailability)) {
920                        condition_info::fill_availability_conditions($rawmods[$seq]);
921                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
922                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
923                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
924                    }
926                    $modname = $mod[$seq]->mod;
927                    $functionname = $modname."_get_coursemodule_info";
929                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
930                        continue;
931                    }
933                    include_once("$CFG->dirroot/mod/$modname/lib.php");
935                    if ($hasfunction = function_exists($functionname)) {
936                        if ($info = $functionname($rawmods[$seq])) {
937                            if (!empty($info->icon)) {
938                                $mod[$seq]->icon = $info->icon;
939                            }
940                            if (!empty($info->iconcomponent)) {
941                                $mod[$seq]->iconcomponent = $info->iconcomponent;
942                            }
943                            if (!empty($info->name)) {
944                                $mod[$seq]->name = $info->name;
945                            }
946                            if ($info instanceof cached_cm_info) {
947                                // When using cached_cm_info you can include three new fields
948                                // that aren't available for legacy code
949                                if (!empty($info->content)) {
950                                    $mod[$seq]->content = $info->content;
951                                }
952                                if (!empty($info->extraclasses)) {
953                                    $mod[$seq]->extraclasses = $info->extraclasses;
954                                }
955                                if (!empty($info->iconurl)) {
956                                    $mod[$seq]->iconurl = $info->iconurl;
957                                }
958                                if (!empty($info->onclick)) {
959                                    $mod[$seq]->onclick = $info->onclick;
960                                }
961                                if (!empty($info->customdata)) {
962                                    $mod[$seq]->customdata = $info->customdata;
963                                }
964                            } else {
965                                // When using a stdclass, the (horrible) deprecated ->extra field
966                                // is available for BC
967                                if (!empty($info->extra)) {
968                                    $mod[$seq]->extra = $info->extra;
969                                }
970                            }
971                        }
972                    }
973                    // When there is no modname_get_coursemodule_info function,
974                    // but showdescriptions is enabled, then we use the 'intro'
975                    // and 'introformat' fields in the module table
976                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
977                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
978                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
979                            // Set content from intro and introformat. Filters are disabled
980                            // because we  filter it with format_text at display time
981                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
982                                    $modvalues, $rawmods[$seq]->id, false);
984                            // To save making another query just below, put name in here
985                            $mod[$seq]->name = $modvalues->name;
986                        }
987                    }
988                    if (!isset($mod[$seq]->name)) {
989                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
990                    }
992                    // Minimise the database size by unsetting default options when they are
993                    // 'empty'. This list corresponds to code in the cm_info constructor.
994                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
995                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
996                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
997                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
998                            'completionview', 'completionexpected', 'score', 'showdescription')
999                            as $property) {
1000                        if (property_exists($mod[$seq], $property) &&
1001                                empty($mod[$seq]->{$property})) {
1002                            unset($mod[$seq]->{$property});
1003                        }
1004                    }
1005                    // Special case: this value is usually set to null, but may be 0
1006                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1007                            is_null($mod[$seq]->completiongradeitemnumber)) {
1008                        unset($mod[$seq]->completiongradeitemnumber);
1009                    }
1010                }
1011             }
1012         }
1013     }
1014     return $mod;
1017 /**
1018  * Returns the localised human-readable names of all used modules
1019  *
1020  * @param bool $plural if true returns the plural forms of the names
1021  * @return array where key is the module name (component name without 'mod_') and
1022  *     the value is the human-readable string. Array sorted alphabetically by value
1023  */
1024 function get_module_types_names($plural = false) {
1025     static $modnames = null;
1026     global $DB, $CFG;
1027     if ($modnames === null) {
1028         $modnames = array(0 => array(), 1 => array());
1029         if ($allmods = $DB->get_records("modules")) {
1030             foreach ($allmods as $mod) {
1031                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1032                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1033                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1034                 }
1035             }
1036             collatorlib::asort($modnames[0]);
1037             collatorlib::asort($modnames[1]);
1038         }
1039     }
1040     return $modnames[(int)$plural];
1043 /**
1044  * Set highlighted section. Only one section can be highlighted at the time.
1045  *
1046  * @param int $courseid course id
1047  * @param int $marker highlight section with this number, 0 means remove higlightin
1048  * @return void
1049  */
1050 function course_set_marker($courseid, $marker) {
1051     global $DB;
1052     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1053     format_base::reset_course_cache($courseid);
1056 /**
1057  * For a given course section, marks it visible or hidden,
1058  * and does the same for every activity in that section
1059  *
1060  * @param int $courseid course id
1061  * @param int $sectionnumber The section number to adjust
1062  * @param int $visibility The new visibility
1063  * @return array A list of resources which were hidden in the section
1064  */
1065 function set_section_visible($courseid, $sectionnumber, $visibility) {
1066     global $DB;
1068     $resourcestotoggle = array();
1069     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1070         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1071         if (!empty($section->sequence)) {
1072             $modules = explode(",", $section->sequence);
1073             foreach ($modules as $moduleid) {
1074                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1075                     if ($visibility) {
1076                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1077                         set_coursemodule_visible($moduleid, $cm->visibleold);
1078                     } else {
1079                         // We hide the section, so we hide the module but we store the original state in visibleold.
1080                         set_coursemodule_visible($moduleid, 0);
1081                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1082                     }
1083                 }
1084             }
1085         }
1086         rebuild_course_cache($courseid, true);
1088         // Determine which modules are visible for AJAX update
1089         if (!empty($modules)) {
1090             list($insql, $params) = $DB->get_in_or_equal($modules);
1091             $select = 'id ' . $insql . ' AND visible = ?';
1092             array_push($params, $visibility);
1093             if (!$visibility) {
1094                 $select .= ' AND visibleold = 1';
1095             }
1096             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1097         }
1098     }
1099     return $resourcestotoggle;
1102 /**
1103  * Retrieve all metadata for the requested modules
1104  *
1105  * @param object $course The Course
1106  * @param array $modnames An array containing the list of modules and their
1107  * names
1108  * @param int $sectionreturn The section to return to
1109  * @return array A list of stdClass objects containing metadata about each
1110  * module
1111  */
1112 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1113     global $CFG, $OUTPUT;
1115     // get_module_metadata will be called once per section on the page and courses may show
1116     // different modules to one another
1117     static $modlist = array();
1118     if (!isset($modlist[$course->id])) {
1119         $modlist[$course->id] = array();
1120     }
1122     $return = array();
1123     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1124     if ($sectionreturn !== null) {
1125         $urlbase->param('sr', $sectionreturn);
1126     }
1127     foreach($modnames as $modname => $modnamestr) {
1128         if (!course_allowed_module($course, $modname)) {
1129             continue;
1130         }
1131         if (isset($modlist[$course->id][$modname])) {
1132             // This module is already cached
1133             $return[$modname] = $modlist[$course->id][$modname];
1134             continue;
1135         }
1137         // Include the module lib
1138         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1139         if (!file_exists($libfile)) {
1140             continue;
1141         }
1142         include_once($libfile);
1144         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1145         $gettypesfunc =  $modname.'_get_types';
1146         if (function_exists($gettypesfunc)) {
1147             if ($types = $gettypesfunc()) {
1148                 $group = new stdClass();
1149                 $group->name = $modname;
1150                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1151                 foreach($types as $type) {
1152                     if ($type->typestr === '--') {
1153                         continue;
1154                     }
1155                     if (strpos($type->typestr, '--') === 0) {
1156                         $group->title = str_replace('--', '', $type->typestr);
1157                         continue;
1158                     }
1159                     // Set the Sub Type metadata
1160                     $subtype = new stdClass();
1161                     $subtype->title = $type->typestr;
1162                     $subtype->type = str_replace('&amp;', '&', $type->type);
1163                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1164                     $subtype->archetype = $type->modclass;
1166                     // The group archetype should match the subtype archetypes and all subtypes
1167                     // should have the same archetype
1168                     $group->archetype = $subtype->archetype;
1170                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1171                         $subtype->help = get_string('help' . $subtype->name, $modname);
1172                     }
1173                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1174                     $group->types[] = $subtype;
1175                 }
1176                 $modlist[$course->id][$modname] = $group;
1177             }
1178         } else {
1179             $module = new stdClass();
1180             $module->title = $modnamestr;
1181             $module->name = $modname;
1182             $module->link = new moodle_url($urlbase, array('add' => $modname));
1183             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1184             $sm = get_string_manager();
1185             if ($sm->string_exists('modulename_help', $modname)) {
1186                 $module->help = get_string('modulename_help', $modname);
1187                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1188                     $link = get_string('modulename_link', $modname);
1189                     $linktext = get_string('morehelp');
1190                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1191                 }
1192             }
1193             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1194             $modlist[$course->id][$modname] = $module;
1195         }
1196         $return[$modname] = $modlist[$course->id][$modname];
1197     }
1199     return $return;
1202 /**
1203  * Return the course category context for the category with id $categoryid, except
1204  * that if $categoryid is 0, return the system context.
1205  *
1206  * @param integer $categoryid a category id or 0.
1207  * @return object the corresponding context
1208  */
1209 function get_category_or_system_context($categoryid) {
1210     if ($categoryid) {
1211         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1212     } else {
1213         return context_system::instance();
1214     }
1217 /**
1218  * Gets the child categories of a given courses category. Uses a static cache
1219  * to make repeat calls efficient.
1220  *
1221  * @param int $parentid the id of a course category.
1222  * @return array all the child course categories.
1223  */
1224 function get_child_categories($parentid) {
1225     static $allcategories = null;
1227     // only fill in this variable the first time
1228     if (null == $allcategories) {
1229         $allcategories = array();
1231         $categories = get_categories();
1232         foreach ($categories as $category) {
1233             if (empty($allcategories[$category->parent])) {
1234                 $allcategories[$category->parent] = array();
1235             }
1236             $allcategories[$category->parent][] = $category;
1237         }
1238     }
1240     if (empty($allcategories[$parentid])) {
1241         return array();
1242     } else {
1243         return $allcategories[$parentid];
1244     }
1247 /**
1248  * This function recursively travels the categories, building up a nice list
1249  * for display. It also makes an array that list all the parents for each
1250  * category.
1251  *
1252  * For example, if you have a tree of categories like:
1253  *   Miscellaneous (id = 1)
1254  *      Subcategory (id = 2)
1255  *         Sub-subcategory (id = 4)
1256  *   Other category (id = 3)
1257  * Then after calling this function you will have
1258  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1259  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1260  *      3 => 'Other category');
1261  * $parents = array(2 => array(1), 4 => array(1, 2));
1262  *
1263  * If you specify $requiredcapability, then only categories where the current
1264  * user has that capability will be added to $list, although all categories
1265  * will still be added to $parents, and if you only have $requiredcapability
1266  * in a child category, not the parent, then the child catgegory will still be
1267  * included.
1268  *
1269  * If you specify the option $excluded, then that category, and all its children,
1270  * are omitted from the tree. This is useful when you are doing something like
1271  * moving categories, where you do not want to allow people to move a category
1272  * to be the child of itself.
1273  *
1274  * @param array $list For output, accumulates an array categoryid => full category path name
1275  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1276  * @param string/array $requiredcapability if given, only categories where the current
1277  *      user has this capability will be added to $list. Can also be an array of capabilities,
1278  *      in which case they are all required.
1279  * @param integer $excludeid Omit this category and its children from the lists built.
1280  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1281  * @param string $path For internal use, as part of recursive calls.
1282  */
1283 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1284         $excludeid = 0, $category = NULL, $path = "") {
1286     // initialize the arrays if needed
1287     if (!is_array($list)) {
1288         $list = array();
1289     }
1290     if (!is_array($parents)) {
1291         $parents = array();
1292     }
1294     if (empty($category)) {
1295         // Start at the top level.
1296         $category = new stdClass;
1297         $category->id = 0;
1298     } else {
1299         // This is the excluded category, don't include it.
1300         if ($excludeid > 0 && $excludeid == $category->id) {
1301             return;
1302         }
1304         $context = context_coursecat::instance($category->id);
1305         $categoryname = format_string($category->name, true, array('context' => $context));
1307         // Update $path.
1308         if ($path) {
1309             $path = $path.' / '.$categoryname;
1310         } else {
1311             $path = $categoryname;
1312         }
1314         // Add this category to $list, if the permissions check out.
1315         if (empty($requiredcapability)) {
1316             $list[$category->id] = $path;
1318         } else {
1319             $requiredcapability = (array)$requiredcapability;
1320             if (has_all_capabilities($requiredcapability, $context)) {
1321                 $list[$category->id] = $path;
1322             }
1323         }
1324     }
1326     // Add all the children recursively, while updating the parents array.
1327     if ($categories = get_child_categories($category->id)) {
1328         foreach ($categories as $cat) {
1329             if (!empty($category->id)) {
1330                 if (isset($parents[$category->id])) {
1331                     $parents[$cat->id]   = $parents[$category->id];
1332                 }
1333                 $parents[$cat->id][] = $category->id;
1334             }
1335             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1336         }
1337     }
1340 /**
1341  * This function generates a structured array of courses and categories.
1342  *
1343  * The depth of categories is limited by $CFG->maxcategorydepth however there
1344  * is no limit on the number of courses!
1345  *
1346  * Suitable for use with the course renderers course_category_tree method:
1347  * $renderer = $PAGE->get_renderer('core','course');
1348  * echo $renderer->course_category_tree(get_course_category_tree());
1349  *
1350  * @global moodle_database $DB
1351  * @param int $id
1352  * @param int $depth
1353  */
1354 function get_course_category_tree($id = 0, $depth = 0) {
1355     global $DB, $CFG;
1356     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
1357     $categories = get_child_categories($id);
1358     $categoryids = array();
1359     foreach ($categories as $key => &$category) {
1360         if (!$category->visible && !$viewhiddencats) {
1361             unset($categories[$key]);
1362             continue;
1363         }
1364         $categoryids[$category->id] = $category;
1365         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1366             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1367             foreach ($subcategories as $subid=>$subcat) {
1368                 $categoryids[$subid] = $subcat;
1369             }
1370             $category->courses = array();
1371         }
1372     }
1374     if ($depth > 0) {
1375         // This is a recursive call so return the required array
1376         return array($categories, $categoryids);
1377     }
1379     if (empty($categoryids)) {
1380         // No categories available (probably all hidden).
1381         return array();
1382     }
1384     // The depth is 0 this function has just been called so we can finish it off
1386     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1387     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1388     $sql = "SELECT
1389             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1390             $ccselect
1391             FROM {course} c
1392             $ccjoin
1393             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1394     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1395         // loop throught them
1396         foreach ($courses as $course) {
1397             if ($course->id == SITEID) {
1398                 continue;
1399             }
1400             context_instance_preload($course);
1401             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1402                 $categoryids[$course->category]->courses[$course->id] = $course;
1403             }
1404         }
1405     }
1406     return $categories;
1409 /**
1410  * Recursive function to print out all the categories in a nice format
1411  * with or without courses included
1412  */
1413 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1414     global $CFG;
1416     // maxcategorydepth == 0 meant no limit
1417     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1418         return;
1419     }
1421     if (!$displaylist) {
1422         make_categories_list($displaylist, $parentslist);
1423     }
1425     if (!$categorycourses) {
1426         if ($category) {
1427             $categorycourses = get_category_courses_array($category->id);
1428         } else {
1429             $categorycourses = get_category_courses_array();
1430         }
1431     }
1433     if ($category) {
1434         if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
1435             print_category_info($category, $depth, $showcourses, $categorycourses[$category->id]);
1436         } else {
1437             return;  // Don't bother printing children of invisible categories
1438         }
1440     } else {
1441         $category = new stdClass();
1442         $category->id = "0";
1443     }
1445     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
1446         $countcats = count($categories);
1447         $count = 0;
1448         $first = true;
1449         $last = false;
1450         foreach ($categories as $cat) {
1451             $count++;
1452             if ($count == $countcats) {
1453                 $last = true;
1454             }
1455             $up = $first ? false : true;
1456             $down = $last ? false : true;
1457             $first = false;
1459             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses, $categorycourses);
1460         }
1461     }
1464 /**
1465  * Gets an array whose keys are category ids and whose values are arrays of courses in the corresponding category.
1466  *
1467  * @param int $categoryid
1468  * @return array
1469  */
1470 function get_category_courses_array($categoryid = 0) {
1471     $tree = get_course_category_tree($categoryid);
1472     $flattened = array();
1473     foreach ($tree as $category) {
1474         get_category_courses_array_recursively($flattened, $category);
1475     }
1476     return $flattened;
1479 /**
1480  * Recursive function to help flatten the course category tree.
1481  *
1482  * Do not call this function directly, instead calll its parent function {@link get_category_courses_array}
1483  *
1484  * @param array &$flattened An array passed by reference in which to store courses for each category.
1485  * @param stdClass $category The category to get courses for.
1486  */
1487 function get_category_courses_array_recursively(array &$flattened, $category) {
1488     $flattened[$category->id] = $category->courses;
1489     foreach ($category->categories as $childcategory) {
1490         get_category_courses_array_recursively($flattened, $childcategory);
1491     }
1494 /**
1495  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
1496  */
1497 function make_categories_options() {
1498     make_categories_list($cats,$parents);
1499     foreach ($cats as $key => $value) {
1500         if (array_key_exists($key,$parents)) {
1501             if ($indent = count($parents[$key])) {
1502                 for ($i = 0; $i < $indent; $i++) {
1503                     $cats[$key] = '&nbsp;'.$cats[$key];
1504                 }
1505             }
1506         }
1507     }
1508     return $cats;
1511 /**
1512  * Prints the category information.
1513  *
1514  * This function is only used by print_whole_category_list() above
1515  *
1516  * @param stdClass $category
1517  * @param int $depth The depth of the category.
1518  * @param bool $showcourses If set to true course information will also be printed.
1519  * @param array|null $courses An array of courses belonging to the category, or null if you don't have it yet.
1520  */
1521 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1522     global $CFG, $DB, $OUTPUT;
1524     $strsummary = get_string('summary');
1526     $catlinkcss = null;
1527     if (!$category->visible) {
1528         $catlinkcss = array('class'=>'dimmed');
1529     }
1530     static $coursecount = null;
1531     if (null === $coursecount) {
1532         // only need to check this once
1533         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
1534     }
1536     if ($showcourses and $coursecount) {
1537         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
1538     } else {
1539         $catimage = "&nbsp;";
1540     }
1542     if (is_null($courses)) {
1543         $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
1544     }
1545     $context = context_coursecat::instance($category->id);
1546     $fullname = format_string($category->name, true, array('context' => $context));
1548     if ($showcourses and $coursecount) {
1549         echo '<div class="categorylist clearfix">';
1550         $cat = '';
1551         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
1552         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1553         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
1555         $html = '';
1556         if ($depth > 0) {
1557             for ($i=0; $i< $depth; $i++) {
1558                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
1559                 $cat = '';
1560             }
1561         } else {
1562             $html = $cat;
1563         }
1564         echo html_writer::tag('div', $html, array('class'=>'category'));
1565         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1567         // does the depth exceed maxcategorydepth
1568         // maxcategorydepth == 0 or unset meant no limit
1569         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
1570         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
1571             foreach ($courses as $course) {
1572                 $linkcss = null;
1573                 if (!$course->visible) {
1574                     $linkcss = array('class'=>'dimmed');
1575                 }
1577                 $coursename = get_course_display_name_for_list($course);
1578                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
1580                 // print enrol info
1581                 $courseicon = '';
1582                 if ($icons = enrol_get_course_info_icons($course)) {
1583                     foreach ($icons as $pix_icon) {
1584                         $courseicon = $OUTPUT->render($pix_icon);
1585                     }
1586                 }
1588                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
1590                 if ($course->summary) {
1591                     $link = new moodle_url('/course/info.php?id='.$course->id);
1592                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
1593                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
1594                         array('title'=>$strsummary));
1596                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
1597                 }
1599                 $html = '';
1600                 for ($i=0; $i <= $depth; $i++) {
1601                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
1602                     $coursecontent = '';
1603                 }
1604                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
1605             }
1606         }
1607         echo '</div>';
1608     } else {
1609         echo '<div class="categorylist">';
1610         $html = '';
1611         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1612         if (count($courses) > 0) {
1613             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
1614         }
1616         if ($depth > 0) {
1617             for ($i=0; $i< $depth; $i++) {
1618                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
1619                 $cat = '';
1620             }
1621         } else {
1622             $html = $cat;
1623         }
1625         echo html_writer::tag('div', $html, array('class'=>'category'));
1626         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1627         echo '</div>';
1628     }
1631 /**
1632  * Print the buttons relating to course requests.
1633  *
1634  * @param object $systemcontext the system context.
1635  */
1636 function print_course_request_buttons($systemcontext) {
1637     global $CFG, $DB, $OUTPUT;
1638     if (empty($CFG->enablecourserequests)) {
1639         return;
1640     }
1641     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
1642     /// Print a button to request a new course
1643         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
1644     }
1645     /// Print a button to manage pending requests
1646     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
1647         $disabled = !$DB->record_exists('course_request', array());
1648         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
1649     }
1652 /**
1653  * Does the user have permission to edit things in this category?
1654  *
1655  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1656  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1657  */
1658 function can_edit_in_category($categoryid = 0) {
1659     $context = get_category_or_system_context($categoryid);
1660     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1663 /**
1664  * Prints the turn editing on/off button on course/index.php or course/category.php.
1665  *
1666  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1667  * @return string HTML of the editing button, or empty string, if this user is not allowed
1668  *      to see it.
1669  */
1670 function update_category_button($categoryid = 0) {
1671     global $CFG, $PAGE, $OUTPUT;
1673     // Check permissions.
1674     if (!can_edit_in_category($categoryid)) {
1675         return '';
1676     }
1678     // Work out the appropriate action.
1679     if ($PAGE->user_is_editing()) {
1680         $label = get_string('turneditingoff');
1681         $edit = 'off';
1682     } else {
1683         $label = get_string('turneditingon');
1684         $edit = 'on';
1685     }
1687     // Generate the button HTML.
1688     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
1689     if ($categoryid) {
1690         $options['id'] = $categoryid;
1691         $page = 'category.php';
1692     } else {
1693         $page = 'index.php';
1694     }
1695     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
1698 /**
1699  * Print courses in category. If category is 0 then all courses are printed.
1700  * @param int|stdClass $category category object or id.
1701  * @return bool true if courses found and printed, else false.
1702  */
1703 function print_courses($category) {
1704     global $CFG, $OUTPUT;
1706     if (!is_object($category) && $category==0) {
1707         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
1708         if (is_array($categories) && count($categories) == 1) {
1709             $category   = array_shift($categories);
1710             $courses    = get_courses_wmanagers($category->id,
1711                                                 'c.sortorder ASC',
1712                                                 array('summary','summaryformat'));
1713         } else {
1714             $courses    = get_courses_wmanagers('all',
1715                                                 'c.sortorder ASC',
1716                                                 array('summary','summaryformat'));
1717         }
1718         unset($categories);
1719     } else {
1720         $courses    = get_courses_wmanagers($category->id,
1721                                             'c.sortorder ASC',
1722                                             array('summary','summaryformat'));
1723     }
1725     if ($courses) {
1726         echo html_writer::start_tag('ul', array('class'=>'unlist'));
1727         foreach ($courses as $course) {
1728             $coursecontext = context_course::instance($course->id);
1729             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
1730                 echo html_writer::start_tag('li');
1731                 print_course($course);
1732                 echo html_writer::end_tag('li');
1733             }
1734         }
1735         echo html_writer::end_tag('ul');
1736     } else {
1737         echo $OUTPUT->heading(get_string("nocoursesyet"));
1738         $context = context_system::instance();
1739         if (has_capability('moodle/course:create', $context)) {
1740             $options = array();
1741             if (!empty($category->id)) {
1742                 $options['category'] = $category->id;
1743             } else {
1744                 $options['category'] = $CFG->defaultrequestcategory;
1745             }
1746             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
1747             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
1748             echo html_writer::end_tag('div');
1749             return false;
1750         }
1751     }
1752     return true;
1755 /**
1756  * Print a description of a course, suitable for browsing in a list.
1757  *
1758  * @param object $course the course object.
1759  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
1760  */
1761 function print_course($course, $highlightterms = '') {
1762     global $CFG, $USER, $DB, $OUTPUT;
1764     $context = context_course::instance($course->id);
1766     // Rewrite file URLs so that they are correct
1767     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
1769     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
1770     echo html_writer::start_tag('div', array('class'=>'info'));
1771     echo html_writer::start_tag('h3', array('class'=>'name'));
1773     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
1775     $coursename = get_course_display_name_for_list($course);
1776     $linktext = highlight($highlightterms, format_string($coursename));
1777     $linkparams = array('title'=>get_string('entercourse'));
1778     if (empty($course->visible)) {
1779         $linkparams['class'] = 'dimmed';
1780     }
1781     echo html_writer::link($linkhref, $linktext, $linkparams);
1782     echo html_writer::end_tag('h3');
1784     /// first find all roles that are supposed to be displayed
1785     if (!empty($CFG->coursecontact)) {
1786         $managerroles = explode(',', $CFG->coursecontact);
1787         $rusers = array();
1789         if (!isset($course->managers)) {
1790             list($sort, $sortparams) = users_order_by_sql('u');
1791             $rusers = get_role_users($managerroles, $context, true,
1792                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
1793                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
1794                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
1795         } else {
1796             //  use the managers array if we have it for perf reasosn
1797             //  populate the datastructure like output of get_role_users();
1798             foreach ($course->managers as $manager) {
1799                 $user = clone($manager->user);
1800                 $user->roleid = $manager->roleid;
1801                 $user->rolename = $manager->rolename;
1802                 $user->roleshortname = $manager->roleshortname;
1803                 $user->rolecoursealias = $manager->rolecoursealias;
1804                 $rusers[$user->id] = $user;
1805             }
1806         }
1808         $namesarray = array();
1809         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
1810         foreach ($rusers as $ra) {
1811             if (isset($namesarray[$ra->id])) {
1812                 //  only display a user once with the higest sortorder role
1813                 continue;
1814             }
1816             $role = new stdClass();
1817             $role->id = $ra->roleid;
1818             $role->name = $ra->rolename;
1819             $role->shortname = $ra->roleshortname;
1820             $role->coursealias = $ra->rolecoursealias;
1821             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
1823             $fullname = fullname($ra, $canviewfullnames);
1824             $namesarray[$ra->id] = $rolename.': '.
1825                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
1826         }
1828         if (!empty($namesarray)) {
1829             echo html_writer::start_tag('ul', array('class'=>'teachers'));
1830             foreach ($namesarray as $name) {
1831                 echo html_writer::tag('li', $name);
1832             }
1833             echo html_writer::end_tag('ul');
1834         }
1835     }
1836     echo html_writer::end_tag('div'); // End of info div
1838     echo html_writer::start_tag('div', array('class'=>'summary'));
1839     $options = new stdClass();
1840     $options->noclean = true;
1841     $options->para = false;
1842     $options->overflowdiv = true;
1843     if (!isset($course->summaryformat)) {
1844         $course->summaryformat = FORMAT_MOODLE;
1845     }
1846     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
1847     if ($icons = enrol_get_course_info_icons($course)) {
1848         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
1849         foreach ($icons as $icon) {
1850             $icon->attributes["alt"] .= ": ". format_string($coursename, true, array('context'=>$context));
1851             echo $OUTPUT->render($icon);
1852         }
1853         echo html_writer::end_tag('div'); // End of enrolmenticons div
1854     }
1855     echo html_writer::end_tag('div'); // End of summary div
1856     echo html_writer::end_tag('div'); // End of coursebox div
1859 /**
1860  * Prints custom user information on the home page.
1861  * Over time this can include all sorts of information
1862  */
1863 function print_my_moodle() {
1864     global $USER, $CFG, $DB, $OUTPUT;
1866     if (!isloggedin() or isguestuser()) {
1867         print_error('nopermissions', '', '', 'See My Moodle');
1868     }
1870     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
1871     $rhosts   = array();
1872     $rcourses = array();
1873     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
1874         $rcourses = get_my_remotecourses($USER->id);
1875         $rhosts   = get_my_remotehosts();
1876     }
1878     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
1880         if (!empty($courses)) {
1881             echo '<ul class="unlist">';
1882             foreach ($courses as $course) {
1883                 if ($course->id == SITEID) {
1884                     continue;
1885                 }
1886                 echo '<li>';
1887                 print_course($course);
1888                 echo "</li>\n";
1889             }
1890             echo "</ul>\n";
1891         }
1893         // MNET
1894         if (!empty($rcourses)) {
1895             // at the IDP, we know of all the remote courses
1896             foreach ($rcourses as $course) {
1897                 print_remote_course($course, "100%");
1898             }
1899         } elseif (!empty($rhosts)) {
1900             // non-IDP, we know of all the remote servers, but not courses
1901             foreach ($rhosts as $host) {
1902                 print_remote_host($host, "100%");
1903             }
1904         }
1905         unset($course);
1906         unset($host);
1908         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
1909             echo "<table width=\"100%\"><tr><td align=\"center\">";
1910             print_course_search("", false, "short");
1911             echo "</td><td align=\"center\">";
1912             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
1913             echo "</td></tr></table>\n";
1914         }
1916     } else {
1917         if ($DB->count_records("course_categories") > 1) {
1918             echo $OUTPUT->box_start("categorybox");
1919             print_whole_category_list();
1920             echo $OUTPUT->box_end();
1921         } else {
1922             print_courses(0);
1923         }
1924     }
1928 function print_course_search($value="", $return=false, $format="plain") {
1929     global $CFG;
1930     static $count = 0;
1932     $count++;
1934     $id = 'coursesearch';
1936     if ($count > 1) {
1937         $id .= $count;
1938     }
1940     $strsearchcourses= get_string("searchcourses");
1942     if ($format == 'plain') {
1943         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
1944         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
1945         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
1946         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
1947         $output .= '<input type="submit" value="'.get_string('go').'" />';
1948         $output .= '</fieldset></form>';
1949     } else if ($format == 'short') {
1950         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
1951         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
1952         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
1953         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
1954         $output .= '<input type="submit" value="'.get_string('go').'" />';
1955         $output .= '</fieldset></form>';
1956     } else if ($format == 'navbar') {
1957         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
1958         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
1959         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
1960         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
1961         $output .= '<input type="submit" value="'.get_string('go').'" />';
1962         $output .= '</fieldset></form>';
1963     }
1965     if ($return) {
1966         return $output;
1967     }
1968     echo $output;
1971 function print_remote_course($course, $width="100%") {
1972     global $CFG, $USER;
1974     $linkcss = '';
1976     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
1978     echo '<div class="coursebox remotecoursebox clearfix">';
1979     echo '<div class="info">';
1980     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
1981          $linkcss.' href="'.$url.'">'
1982         .  format_string($course->fullname) .'</a><br />'
1983         . format_string($course->hostname) . ' : '
1984         . format_string($course->cat_name) . ' : '
1985         . format_string($course->shortname). '</div>';
1986     echo '</div><div class="summary">';
1987     $options = new stdClass();
1988     $options->noclean = true;
1989     $options->para = false;
1990     $options->overflowdiv = true;
1991     echo format_text($course->summary, $course->summaryformat, $options);
1992     echo '</div>';
1993     echo '</div>';
1996 function print_remote_host($host, $width="100%") {
1997     global $OUTPUT;
1999     $linkcss = '';
2001     echo '<div class="coursebox clearfix">';
2002     echo '<div class="info">';
2003     echo '<div class="name">';
2004     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2005     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2006         . s($host['name']).'</a> - ';
2007     echo $host['count'] . ' ' . get_string('courses');
2008     echo '</div>';
2009     echo '</div>';
2010     echo '</div>';
2014 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2016 function add_course_module($mod) {
2017     global $DB;
2019     $mod->added = time();
2020     unset($mod->id);
2022     $cmid = $DB->insert_record("course_modules", $mod);
2023     rebuild_course_cache($mod->course, true);
2024     return $cmid;
2027 /**
2028  * Creates missing course section(s) and rebuilds course cache
2029  *
2030  * @param int|stdClass $courseorid course id or course object
2031  * @param int|array $sections list of relative section numbers to create
2032  * @return bool if there were any sections created
2033  */
2034 function course_create_sections_if_missing($courseorid, $sections) {
2035     global $DB;
2036     if (!is_array($sections)) {
2037         $sections = array($sections);
2038     }
2039     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2040     if (is_object($courseorid)) {
2041         $courseorid = $courseorid->id;
2042     }
2043     $coursechanged = false;
2044     foreach ($sections as $sectionnum) {
2045         if (!in_array($sectionnum, $existing)) {
2046             $cw = new stdClass();
2047             $cw->course   = $courseorid;
2048             $cw->section  = $sectionnum;
2049             $cw->summary  = '';
2050             $cw->summaryformat = FORMAT_HTML;
2051             $cw->sequence = '';
2052             $id = $DB->insert_record("course_sections", $cw);
2053             $coursechanged = true;
2054         }
2055     }
2056     if ($coursechanged) {
2057         rebuild_course_cache($courseorid, true);
2058     }
2059     return $coursechanged;
2062 /**
2063  * Adds an existing module to the section
2064  *
2065  * Updates both tables {course_sections} and {course_modules}
2066  *
2067  * @param int|stdClass $courseorid course id or course object
2068  * @param int $cmid id of the module already existing in course_modules table
2069  * @param int $sectionnum relative number of the section (field course_sections.section)
2070  *     If section does not exist it will be created
2071  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2072  *     before which the module needs to be included. Null for inserting in the
2073  *     end of the section
2074  * @return int The course_sections ID where the module is inserted
2075  */
2076 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
2077     global $DB, $COURSE;
2078     if (is_object($beforemod)) {
2079         $beforemod = $beforemod->id;
2080     }
2081     if (is_object($courseorid)) {
2082         $courseid = $courseorid->id;
2083     } else {
2084         $courseid = $courseorid;
2085     }
2086     course_create_sections_if_missing($courseorid, $sectionnum);
2087     // Do not try to use modinfo here, there is no guarantee it is valid!
2088     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
2089     $modarray = explode(",", trim($section->sequence));
2090     if (empty($section->sequence)) {
2091         $newsequence = "$cmid";
2092     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2093         $insertarray = array($cmid, $beforemod);
2094         array_splice($modarray, $key[0], 1, $insertarray);
2095         $newsequence = implode(",", $modarray);
2096     } else {
2097         $newsequence = "$section->sequence,$cmid";
2098     }
2099     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2100     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
2101     if (is_object($courseorid)) {
2102         rebuild_course_cache($courseorid->id, true);
2103     } else {
2104         rebuild_course_cache($courseorid, true);
2105     }
2106     return $section->id;     // Return course_sections ID that was used.
2109 function set_coursemodule_groupmode($id, $groupmode) {
2110     global $DB;
2111     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2112     if ($cm->groupmode != $groupmode) {
2113         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2114         rebuild_course_cache($cm->course, true);
2115     }
2116     return ($cm->groupmode != $groupmode);
2119 function set_coursemodule_idnumber($id, $idnumber) {
2120     global $DB;
2121     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2122     if ($cm->idnumber != $idnumber) {
2123         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2124         rebuild_course_cache($cm->course, true);
2125     }
2126     return ($cm->idnumber != $idnumber);
2129 /**
2130  * Set the visibility of a module and inherent properties.
2131  *
2132  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
2133  * has been moved to {@link set_section_visible()} which was the only place from which
2134  * the parameter was used.
2135  *
2136  * @param int $id of the module
2137  * @param int $visible state of the module
2138  * @return bool false when the module was not found, true otherwise
2139  */
2140 function set_coursemodule_visible($id, $visible) {
2141     global $DB, $CFG;
2142     require_once($CFG->libdir.'/gradelib.php');
2144     // Trigger developer's attention when using the previously removed argument.
2145     if (func_num_args() > 2) {
2146         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
2147             has been removed.', DEBUG_DEVELOPER);
2148     }
2150     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2151         return false;
2152     }
2154     // Create events and propagate visibility to associated grade items if the value has changed.
2155     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
2156     if ($cm->visible == $visible) {
2157         return true;
2158     }
2160     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2161         return false;
2162     }
2163     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2164         foreach($events as $event) {
2165             if ($visible) {
2166                 show_event($event);
2167             } else {
2168                 hide_event($event);
2169             }
2170         }
2171     }
2173     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
2174     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2175     if ($grade_items) {
2176         foreach ($grade_items as $grade_item) {
2177             $grade_item->set_hidden(!$visible);
2178         }
2179     }
2181     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
2182     // affect visibleold to allow for an original visibility restore. See set_section_visible().
2183     $cminfo = new stdClass();
2184     $cminfo->id = $id;
2185     $cminfo->visible = $visible;
2186     $cminfo->visibleold = $visible;
2187     $DB->update_record('course_modules', $cminfo);
2189     rebuild_course_cache($cm->course, true);
2190     return true;
2193 /**
2194  * This function will handles the whole deletion process of a module. This includes calling
2195  * the modules delete_instance function, deleting files, events, grades, conditional data,
2196  * the data in the course_module and course_sections table and adding a module deletion
2197  * event to the DB.
2198  *
2199  * @param int $cmid the course module id
2200  * @since 2.5
2201  */
2202 function course_delete_module($cmid) {
2203     global $CFG, $DB, $USER;
2205     require_once($CFG->libdir.'/gradelib.php');
2206     require_once($CFG->dirroot.'/blog/lib.php');
2208     // Get the course module.
2209     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
2210         return true;
2211     }
2213     // Get the module context.
2214     $modcontext = context_module::instance($cm->id);
2216     // Get the course module name.
2217     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
2219     // Get the file location of the delete_instance function for this module.
2220     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
2222     // Include the file required to call the delete_instance function for this module.
2223     if (file_exists($modlib)) {
2224         require_once($modlib);
2225     } else {
2226         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
2227             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
2228     }
2230     $deleteinstancefunction = $modulename . '_delete_instance';
2232     // Ensure the delete_instance function exists for this module.
2233     if (!function_exists($deleteinstancefunction)) {
2234         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
2235             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
2236     }
2238     // Call the delete_instance function, if it returns false throw an exception.
2239     if (!$deleteinstancefunction($cm->instance)) {
2240         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
2241             "Cannot delete the module $modulename (instance).");
2242     }
2244     // Remove all module files in case modules forget to do that.
2245     $fs = get_file_storage();
2246     $fs->delete_area_files($modcontext->id);
2248     // Delete events from calendar.
2249     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
2250         foreach($events as $event) {
2251             delete_event($event->id);
2252         }
2253     }
2255     // Delete grade items, outcome items and grades attached to modules.
2256     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
2257                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
2258         foreach ($grade_items as $grade_item) {
2259             $grade_item->delete('moddelete');
2260         }
2261     }
2263     // Delete completion and availability data; it is better to do this even if the
2264     // features are not turned on, in case they were turned on previously (these will be
2265     // very quick on an empty table).
2266     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2267     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2268     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2269     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2270                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2272     // Delete the context.
2273     delete_context(CONTEXT_MODULE, $cm->id);
2275     // Delete the module from the course_modules table.
2276     $DB->delete_records('course_modules', array('id' => $cm->id));
2278     // Delete module from that section.
2279     if (!delete_mod_from_section($cm->id, $cm->section)) {
2280         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
2281             "Cannot delete the module $modulename (instance) from section.");
2282     }
2284     // Trigger a mod_deleted event with information about this module.
2285     $eventdata = new stdClass();
2286     $eventdata->modulename = $modulename;
2287     $eventdata->cmid       = $cm->id;
2288     $eventdata->courseid   = $cm->course;
2289     $eventdata->userid     = $USER->id;
2290     events_trigger('mod_deleted', $eventdata);
2292     add_to_log($cm->course, 'course', "delete mod",
2293                "view.php?id=$cm->course",
2294                "$modulename $cm->instance", $cm->id);
2296     rebuild_course_cache($cm->course, true);
2299 function delete_mod_from_section($modid, $sectionid) {
2300     global $DB;
2302     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2304         $modarray = explode(",", $section->sequence);
2306         if ($key = array_keys ($modarray, $modid)) {
2307             array_splice($modarray, $key[0], 1);
2308             $newsequence = implode(",", $modarray);
2309             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2310             rebuild_course_cache($section->course, true);
2311             return true;
2312         } else {
2313             return false;
2314         }
2316     }
2317     return false;
2320 /**
2321  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2322  *
2323  * @param object $course course object
2324  * @param int $section Section number (not id!!!)
2325  * @param int $move (-1 or 1)
2326  * @return boolean true if section moved successfully
2327  * @todo MDL-33379 remove this function in 2.5
2328  */
2329 function move_section($course, $section, $move) {
2330     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2332 /// Moves a whole course section up and down within the course
2333     global $USER;
2335     if (!$move) {
2336         return true;
2337     }
2339     $sectiondest = $section + $move;
2341     // compartibility with course formats using field 'numsections'
2342     $courseformatoptions = course_get_format($course)->get_format_options();
2343     if (array_key_exists('numsections', $courseformatoptions) &&
2344             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2345         return false;
2346     }
2348     $retval = move_section_to($course, $section, $sectiondest);
2349     return $retval;
2352 /**
2353  * Moves a section within a course, from a position to another.
2354  * Be very careful: $section and $destination refer to section number,
2355  * not id!.
2356  *
2357  * @param object $course
2358  * @param int $section Section number (not id!!!)
2359  * @param int $destination
2360  * @return boolean Result
2361  */
2362 function move_section_to($course, $section, $destination) {
2363 /// Moves a whole course section up and down within the course
2364     global $USER, $DB;
2366     if (!$destination && $destination != 0) {
2367         return true;
2368     }
2370     // compartibility with course formats using field 'numsections'
2371     $courseformatoptions = course_get_format($course)->get_format_options();
2372     if ((array_key_exists('numsections', $courseformatoptions) &&
2373             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
2374         return false;
2375     }
2377     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2378     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2379             'section ASC, id ASC', 'id, section')) {
2380         return false;
2381     }
2383     $movedsections = reorder_sections($sections, $section, $destination);
2385     // Update all sections. Do this in 2 steps to avoid breaking database
2386     // uniqueness constraint
2387     $transaction = $DB->start_delegated_transaction();
2388     foreach ($movedsections as $id => $position) {
2389         if ($sections[$id] !== $position) {
2390             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2391         }
2392     }
2393     foreach ($movedsections as $id => $position) {
2394         if ($sections[$id] !== $position) {
2395             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2396         }
2397     }
2399     // If we move the highlighted section itself, then just highlight the destination.
2400     // Adjust the higlighted section location if we move something over it either direction.
2401     if ($section == $course->marker) {
2402         course_set_marker($course->id, $destination);
2403     } elseif ($section > $course->marker && $course->marker >= $destination) {
2404         course_set_marker($course->id, $course->marker+1);
2405     } elseif ($section < $course->marker && $course->marker <= $destination) {
2406         course_set_marker($course->id, $course->marker-1);
2407     }
2409     $transaction->allow_commit();
2410     rebuild_course_cache($course->id, true);
2411     return true;
2414 /**
2415  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2416  * an original position number and a target position number, rebuilds the array so that the
2417  * move is made without any duplication of section positions.
2418  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2419  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2420  *
2421  * @param array $sections
2422  * @param int $origin_position
2423  * @param int $target_position
2424  * @return array
2425  */
2426 function reorder_sections($sections, $origin_position, $target_position) {
2427     if (!is_array($sections)) {
2428         return false;
2429     }
2431     // We can't move section position 0
2432     if ($origin_position < 1) {
2433         echo "We can't move section position 0";
2434         return false;
2435     }
2437     // Locate origin section in sections array
2438     if (!$origin_key = array_search($origin_position, $sections)) {
2439         echo "searched position not in sections array";
2440         return false; // searched position not in sections array
2441     }
2443     // Extract origin section
2444     $origin_section = $sections[$origin_key];
2445     unset($sections[$origin_key]);
2447     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2448     $found = false;
2449     $append_array = array();
2450     foreach ($sections as $id => $position) {
2451         if ($found) {
2452             $append_array[$id] = $position;
2453             unset($sections[$id]);
2454         }
2455         if ($position == $target_position) {
2456             if ($target_position < $origin_position) {
2457                 $append_array[$id] = $position;
2458                 unset($sections[$id]);
2459             }
2460             $found = true;
2461         }
2462     }
2464     // Append moved section
2465     $sections[$origin_key] = $origin_section;
2467     // Append rest of array (if applicable)
2468     if (!empty($append_array)) {
2469         foreach ($append_array as $id => $position) {
2470             $sections[$id] = $position;
2471         }
2472     }
2474     // Renumber positions
2475     $position = 0;
2476     foreach ($sections as $id => $p) {
2477         $sections[$id] = $position;
2478         $position++;
2479     }
2481     return $sections;
2485 /**
2486  * Move the module object $mod to the specified $section
2487  * If $beforemod exists then that is the module
2488  * before which $modid should be inserted
2489  * All parameters are objects
2490  */
2491 function moveto_module($mod, $section, $beforemod=NULL) {
2492     global $OUTPUT, $DB;
2494 /// Remove original module from original section
2495     if (! delete_mod_from_section($mod->id, $mod->section)) {
2496         echo $OUTPUT->notification("Could not delete module from existing section");
2497     }
2499     // if moving to a hidden section then hide module
2500     if (!$section->visible && $mod->visible) {
2501         // Set this in the object because it is sent as a response to ajax calls.
2502         $mod->visible = 0;
2503         set_coursemodule_visible($mod->id, 0);
2504         // Set visibleold to 1 so module will be visible when section is made visible.
2505         $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
2506     }
2507     if ($section->visible && !$mod->visible) {
2508         set_coursemodule_visible($mod->id, $mod->visibleold);
2509         // Set this in the object because it is sent as a response to ajax calls.
2510         $mod->visible = $mod->visibleold;
2511     }
2513 /// Add the module into the new section
2514     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
2515     return true;
2518 /**
2519  * Returns the list of all editing actions that current user can perform on the module
2520  *
2521  * @param cm_info $mod The module to produce editing buttons for
2522  * @param int $indent The current indenting (default -1 means no move left-right actions)
2523  * @param int $sr The section to link back to (used for creating the links)
2524  * @return array array of action_link or pix_icon objects
2525  */
2526 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2527     global $COURSE, $SITE;
2529     static $str;
2531     $coursecontext = context_course::instance($mod->course);
2532     $modcontext = context_module::instance($mod->id);
2534     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2535     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2537     // no permission to edit anything
2538     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2539         return array();
2540     }
2542     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2544     if (!isset($str)) {
2545         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2546             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
2547         $str->assign         = get_string('assignroles', 'role');
2548         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2549         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2550         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2551         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
2552         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
2553         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
2554     }
2556     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2558     if ($sr !== null) {
2559         $baseurl->param('sr', $sr);
2560     }
2561     $actions = array();
2563     // AJAX edit title
2564     if ($mod->modname !== 'label' && $hasmanageactivities &&
2565                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
2566                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
2567         // we will not display link if we are on some other-course page (where we should not see this module anyway)
2568         $actions['title'] = new action_link(
2569             new moodle_url($baseurl, array('update' => $mod->id)),
2570             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2571             null,
2572             array('class' => 'editing_title', 'title' => $str->edittitle)
2573         );
2574     }
2576     // leftright
2577     if ($hasmanageactivities) {
2578         if (right_to_left()) {   // Exchange arrows on RTL
2579             $rightarrow = 't/left';
2580             $leftarrow  = 't/right';
2581         } else {
2582             $rightarrow = 't/right';
2583             $leftarrow  = 't/left';
2584         }
2586         if ($indent > 0) {
2587             $actions['moveleft'] = new action_link(
2588                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
2589                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2590                 null,
2591                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
2592             );
2593         }
2594         if ($indent >= 0) {
2595             $actions['moveright'] = new action_link(
2596                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2597                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2598                 null,
2599                 array('class' => 'editing_moveright', 'title' => $str->moveright)
2600             );
2601         }
2602     }
2604     // move
2605     if ($hasmanageactivities) {
2606         $actions['move'] = new action_link(
2607             new moodle_url($baseurl, array('copy' => $mod->id)),
2608             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2609             null,
2610             array('class' => 'editing_move', 'title' => $str->move)
2611         );
2612     }
2614     // Update
2615     if ($hasmanageactivities) {
2616         $actions['update'] = new action_link(
2617             new moodle_url($baseurl, array('update' => $mod->id)),
2618             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2619             null,
2620             array('class' => 'editing_update', 'title' => $str->update)
2621         );
2622     }
2624     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2625     // note that restoring on front page is never allowed
2626     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
2627             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
2628         $actions['duplicate'] = new action_link(
2629             new moodle_url($baseurl, array('duplicate' => $mod->id)),
2630             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2631             null,
2632             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
2633         );
2634     }
2636     // Delete
2637     if ($hasmanageactivities) {
2638         $actions['delete'] = new action_link(
2639             new moodle_url($baseurl, array('delete' => $mod->id)),
2640             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2641             null,
2642             array('class' => 'editing_delete', 'title' => $str->delete)
2643         );
2644     }
2646     // hideshow
2647     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2648         if ($mod->visible) {
2649             $actions['hide'] = new action_link(
2650                 new moodle_url($baseurl, array('hide' => $mod->id)),
2651                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2652                 null,
2653                 array('class' => 'editing_hide', 'title' => $str->hide)
2654             );
2655         } else {
2656             $actions['show'] = new action_link(
2657                 new moodle_url($baseurl, array('show' => $mod->id)),
2658                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2659                 null,
2660                 array('class' => 'editing_show', 'title' => $str->show)
2661             );
2662         }
2663     }
2665     // groupmode
2666     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2667         if ($mod->coursegroupmodeforce) {
2668             $modgroupmode = $mod->coursegroupmode;
2669         } else {
2670             $modgroupmode = $mod->groupmode;
2671         }
2672         if ($modgroupmode == SEPARATEGROUPS) {
2673             $groupmode = NOGROUPS;
2674             $grouptitle = $str->groupsseparate;
2675             $forcedgrouptitle = $str->forcedgroupsseparate;
2676             $actionname = 'groupsseparate';
2677             $groupimage = 't/groups';
2678         } else if ($modgroupmode == VISIBLEGROUPS) {
2679             $groupmode = SEPARATEGROUPS;
2680             $grouptitle = $str->groupsvisible;
2681             $forcedgrouptitle = $str->forcedgroupsvisible;
2682             $actionname = 'groupsvisible';
2683             $groupimage = 't/groupv';
2684         } else {
2685             $groupmode = VISIBLEGROUPS;
2686             $grouptitle = $str->groupsnone;
2687             $forcedgrouptitle = $str->forcedgroupsnone;
2688             $actionname = 'groupsnone';
2689             $groupimage = 't/groupn';
2690         }
2691         if (!$mod->coursegroupmodeforce) {
2692             $actions[$actionname] = new action_link(
2693                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
2694                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2695                 null,
2696                 array('class' => 'editing_'. $actionname, 'title' => $grouptitle)
2697             );
2698         } else {
2699             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
2700         }
2701     }
2703     // Assign
2704     if (has_capability('moodle/role:assign', $modcontext)){
2705         $actions['assign'] = new action_link(
2706             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2707             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2708             null,
2709             array('class' => 'editing_assign', 'title' => $str->assign)
2710         );
2711     }
2713     return $actions;
2716 /**
2717  * given a course object with shortname & fullname, this function will
2718  * truncate the the number of chars allowed and add ... if it was too long
2719  */
2720 function course_format_name ($course,$max=100) {
2722     $context = context_course::instance($course->id);
2723     $shortname = format_string($course->shortname, true, array('context' => $context));
2724     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2725     $str = $shortname.': '. $fullname;
2726     if (textlib::strlen($str) <= $max) {
2727         return $str;
2728     }
2729     else {
2730         return textlib::substr($str,0,$max-3).'...';
2731     }
2734 /**
2735  * Is the user allowed to add this type of module to this course?
2736  * @param object $course the course settings. Only $course->id is used.
2737  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2738  * @return bool whether the current user is allowed to add this type of module to this course.
2739  */
2740 function course_allowed_module($course, $modname) {
2741     if (is_numeric($modname)) {
2742         throw new coding_exception('Function course_allowed_module no longer
2743                 supports numeric module ids. Please update your code to pass the module name.');
2744     }
2746     $capability = 'mod/' . $modname . ':addinstance';
2747     if (!get_capability_info($capability)) {
2748         // Debug warning that the capability does not exist, but no more than once per page.
2749         static $warned = array();
2750         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2751         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2752             debugging('The module ' . $modname . ' does not define the standard capability ' .
2753                     $capability , DEBUG_DEVELOPER);
2754             $warned[$modname] = 1;
2755         }
2757         // If the capability does not exist, the module can always be added.
2758         return true;
2759     }
2761     $coursecontext = context_course::instance($course->id);
2762     return has_capability($capability, $coursecontext);
2765 /**
2766  * Recursively delete category including all subcategories and courses.
2767  * @param stdClass $category
2768  * @param boolean $showfeedback display some notices
2769  * @return array return deleted courses
2770  */
2771 function category_delete_full($category, $showfeedback=true) {
2772     global $CFG, $DB;
2773     require_once($CFG->libdir.'/gradelib.php');
2774     require_once($CFG->libdir.'/questionlib.php');
2775     require_once($CFG->dirroot.'/cohort/lib.php');
2777     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
2778         foreach ($children as $childcat) {
2779             category_delete_full($childcat, $showfeedback);
2780         }
2781     }
2783     $deletedcourses = array();
2784     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
2785         foreach ($courses as $course) {
2786             if (!delete_course($course, false)) {
2787                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
2788             }
2789             $deletedcourses[] = $course;
2790         }
2791     }
2793     // move or delete cohorts in this context
2794     cohort_delete_category($category);
2796     // now delete anything that may depend on course category context
2797     grade_course_category_delete($category->id, 0, $showfeedback);
2798     if (!question_delete_course_category($category, 0, $showfeedback)) {
2799         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
2800     }
2802     // finally delete the category and it's context
2803     $DB->delete_records('course_categories', array('id'=>$category->id));
2804     delete_context(CONTEXT_COURSECAT, $category->id);
2805     add_to_log(SITEID, "category", "delete", "index.php", "$category->name (ID $category->id)");
2807     events_trigger('course_category_deleted', $category);
2809     return $deletedcourses;
2812 /**
2813  * Delete category, but move contents to another category.
2814  * @param object $ccategory
2815  * @param int $newparentid category id
2816  * @return bool status
2817  */
2818 function category_delete_move($category, $newparentid, $showfeedback=true) {
2819     global $CFG, $DB, $OUTPUT;
2820     require_once($CFG->libdir.'/gradelib.php');
2821     require_once($CFG->libdir.'/questionlib.php');
2822     require_once($CFG->dirroot.'/cohort/lib.php');
2824     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
2825         return false;
2826     }
2828     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
2829         foreach ($children as $childcat) {
2830             move_category($childcat, $newparentcat);
2831         }
2832     }
2834     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
2835         if (!move_courses(array_keys($courses), $newparentid)) {
2836             if ($showfeedback) {
2837                 echo $OUTPUT->notification("Error moving courses");
2838             }
2839             return false;
2840         }
2841         if ($showfeedback) {
2842             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
2843         }
2844     }
2846     // move or delete cohorts in this context
2847     cohort_delete_category($category);
2849     // now delete anything that may depend on course category context
2850     grade_course_category_delete($category->id, $newparentid, $showfeedback);
2851     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
2852         if ($showfeedback) {
2853             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
2854         }
2855         return false;
2856     }
2858     // finally delete the category and it's context
2859     $DB->delete_records('course_categories', array('id'=>$category->id));
2860     delete_context(CONTEXT_COURSECAT, $category->id);
2861     add_to_log(SITEID, "category", "delete", "index.php", "$category->name (ID $category->id)");
2863     events_trigger('course_category_deleted', $category);
2865     if ($showfeedback) {
2866         echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
2867     }
2868     return true;
2871 /**
2872  * Efficiently moves many courses around while maintaining
2873  * sortorder in order.
2874  *
2875  * @param array $courseids is an array of course ids
2876  * @param int $categoryid
2877  * @return bool success
2878  */
2879 function move_courses($courseids, $categoryid) {
2880     global $CFG, $DB, $OUTPUT;
2882     if (empty($courseids)) {
2883         // nothing to do
2884         return;
2885     }
2887     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
2888         return false;
2889     }
2891     $courseids = array_reverse($courseids);
2892     $newparent = context_coursecat::instance($category->id);
2893     $i = 1;
2895     foreach ($courseids as $courseid) {
2896         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
2897             $course = new stdClass();
2898             $course->id = $courseid;
2899             $course->category  = $category->id;
2900             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2901             if ($category->visible == 0) {
2902                 // hide the course when moving into hidden category,
2903                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
2904                 $course->visible = 0;
2905             }
2907             $DB->update_record('course', $course);
2908             add_to_log($course->id, "course", "move", "edit.php?id=$course->id", $course->id);
2910             $context   = context_course::instance($course->id);
2911             context_moved($context, $newparent);
2912         }
2913     }
2914     fix_course_sortorder();
2916     return true;
2919 /**
2920  * Hide course category and child course and subcategories
2921  * @param stdClass $category
2922  * @return void
2923  */
2924 function course_category_hide($category) {
2925     global $DB;
2927     $category->visible = 0;
2928     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
2929     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
2930     $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
2931     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
2932     // get all child categories and hide too
2933     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
2934         foreach ($subcats as $cat) {
2935             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
2936             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
2937             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
2938             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
2939         }
2940     }
2941     add_to_log(SITEID, "category", "hide", "editcategory.php?id=$category->id", $category->id);
2944 /**
2945  * Show course category and child course and subcategories
2946  * @param stdClass $category
2947  * @return void
2948  */
2949 function course_category_show($category) {
2950     global $DB;
2952     $category->visible = 1;
2953     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
2954     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
2955     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
2956     // get all child categories and unhide too
2957     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
2958         foreach ($subcats as $cat) {
2959             if ($cat->visibleold) {
2960                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
2961             }
2962             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
2963         }
2964     }
2965     add_to_log(SITEID, "category", "show", "editcategory.php?id=$category->id", $category->id);
2968 /**
2969  * Efficiently moves a category - NOTE that this can have
2970  * a huge impact access-control-wise...
2971  */
2972 function move_category($category, $newparentcat) {
2973     global $CFG, $DB;
2975     $context = context_coursecat::instance($category->id);
2977     $hidecat = false;
2978     if (empty($newparentcat->id)) {
2979         $DB->set_field('course_categories', 'parent', 0, array('id' => $category->id));
2980         $newparent = context_system::instance();
2981     } else {
2982         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id' => $category->id));
2983         $newparent = context_coursecat::instance($newparentcat->id);
2985         if (!$newparentcat->visible and $category->visible) {
2986             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
2987             $hidecat = true;
2988         }
2989     }
2991     context_moved($context, $newparent);
2993     // now make it last in new category
2994     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
2996     // Log action.
2997     add_to_log(SITEID, "category", "move", "editcategory.php?id=$category->id", $category->id);
2999     // and fix the sortorders
3000     fix_course_sortorder();
3002     if ($hidecat) {
3003         course_category_hide($category);
3004     }
3007 /**
3008  * Returns the display name of the given section that the course prefers
3009  *
3010  * Implementation of this function is provided by course format
3011  * @see format_base::get_section_name()
3012  *
3013  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
3014  * @param int|stdClass $section Section object from database or just field course_sections.section
3015  * @return string Display name that the course format prefers, e.g. "Week 2"
3016  */
3017 function get_section_name($courseorid, $section) {
3018     return course_get_format($courseorid)->get_section_name($section);
3021 /**
3022  * Tells if current course format uses sections
3023  *
3024  * @param string $format Course format ID e.g. 'weeks' $course->format
3025  * @return bool
3026  */
3027 function course_format_uses_sections($format) {
3028     $course = new stdClass();
3029     $course->format = $format;
3030     return course_get_format($course)->uses_sections();
3033 /**
3034  * Returns the information about the ajax support in the given source format
3035  *
3036  * The returned object's property (boolean)capable indicates that
3037  * the course format supports Moodle course ajax features.
3038  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3039  *
3040  * @param string $format
3041  * @return stdClass
3042  */
3043 function course_format_ajax_support($format) {
3044     $course = new stdClass();
3045     $course->format = $format;
3046     return course_get_format($course)->supports_ajax();
3049 /**
3050  * Can the current user delete this course?
3051  * Course creators have exception,
3052  * 1 day after the creation they can sill delete the course.
3053  * @param int $courseid
3054  * @return boolean
3055  */
3056 function can_delete_course($courseid) {
3057     global $USER, $DB;
3059     $context = context_course::instance($courseid);
3061     if (has_capability('moodle/course:delete', $context)) {
3062         return true;
3063     }
3065     // hack: now try to find out if creator created this course recently (1 day)
3066     if (!has_capability('moodle/course:create', $context)) {
3067         return false;
3068     }
3070     $since = time() - 60*60*24;
3072     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3073     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3075     return $DB->record_exists_select('log', $select, $params);
3078 /**
3079  * Save the Your name for 'Some role' strings.
3080  *
3081  * @param integer $courseid the id of this course.
3082  * @param array $data the data that came from the course settings form.
3083  */
3084 function save_local_role_names($courseid, $data) {
3085     global $DB;
3086     $context = context_course::instance($courseid);
3088     foreach ($data as $fieldname => $value) {
3089         if (strpos($fieldname, 'role_') !== 0) {
3090             continue;
3091         }
3092         list($ignored, $roleid) = explode('_', $fieldname);
3094         // make up our mind whether we want to delete, update or insert
3095         if (!$value) {
3096             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3098         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3099             $rolename->name = $value;
3100             $DB->update_record('role_names', $rolename);
3102         } else {
3103             $rolename = new stdClass;
3104             $rolename->contextid = $context->id;
3105             $rolename->roleid = $roleid;
3106             $rolename->name = $value;
3107             $DB->insert_record('role_names', $rolename);
3108         }
3109     }
3112 /**
3113  * Create a course and either return a $course object
3114  *
3115  * Please note this functions does not verify any access control,
3116  * the calling code is responsible for all validation (usually it is the form definition).
3117  *
3118  * @param array $editoroptions course description editor options
3119  * @param object $data  - all the data needed for an entry in the 'course' table
3120  * @return object new course instance
3121  */
3122 function create_course($data, $editoroptions = NULL) {
3123     global $CFG, $DB;
3125     //check the categoryid - must be given for all new courses
3126     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3128     //check if the shortname already exist
3129     if (!empty($data->shortname)) {
3130         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3131             throw new moodle_exception('shortnametaken');
3132         }
3133     }
3135     //check if the id number already exist
3136     if (!empty($data->idnumber)) {
3137         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3138             throw new moodle_exception('idnumbertaken');
3139         }
3140     }
3142     $data->timecreated  = time();
3143     $data->timemodified = $data->timecreated;
3145     // place at beginning of any category
3146     $data->sortorder = 0;
3148     if ($editoroptions) {
3149         // summary text is updated later, we need context to store the files first
3150         $data->summary = '';
3151         $data->summary_format = FORMAT_HTML;
3152     }
3154     if (!isset($data->visible)) {
3155         // data not from form, add missing visibility info
3156         $data->visible = $category->visible;
3157     }
3158     $data->visibleold = $data->visible;
3160     $newcourseid = $DB->insert_record('course', $data);
3161     $context = context_course::instance($newcourseid, MUST_EXIST);
3163     if ($editoroptions) {
3164         // Save the files used in the summary editor and store
3165         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3166         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3167         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3168     }
3170     // update course format options
3171     course_get_format($newcourseid)->update_course_format_options($data);
3173     $course = course_get_format($newcourseid)->get_course();
3175     // Setup the blocks
3176     blocks_add_default_course_blocks($course);
3178     // Create a default section.
3179     course_create_sections_if_missing($course, 0);
3181     fix_course_sortorder();
3183     // new context created - better mark it as dirty
3184     mark_context_dirty($context->path);
3186     // Save any custom role names.
3187     save_local_role_names($course->id, (array)$data);
3189     // set up enrolments
3190     enrol_course_updated(true, $course, $data);
3192     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3194     // Trigger events
3195     events_trigger('course_created', $course);
3197     return $course;
3200 /**
3201  * Create a new course category and marks the context as dirty
3202  *
3203  * This function does not set the sortorder for the new category and
3204  * @see{fix_course_sortorder} should be called after creating a new course
3205  * category
3206  *
3207  * Please note that this function does not verify access control.
3208  *
3209  * @param object $category All of the data required for an entry in the course_categories table
3210  * @return object new course category
3211  */
3212 function create_course_category($category) {
3213     global $DB;
3215     $category->timemodified = time();
3216     $category->id = $DB->insert_record('course_categories', $category);
3217     $category = $DB->get_record('course_categories', array('id' => $category->id));
3219     // We should mark the context as dirty
3220     $category->context = context_coursecat::instance($category->id);
3221     $category->context->mark_dirty();
3223     return $category;
3226 /**
3227  * Update a course.
3228  *
3229  * Please note this functions does not verify any access control,
3230  * the calling code is responsible for all validation (usually it is the form definition).
3231  *
3232  * @param object $data  - all the data needed for an entry in the 'course' table
3233  * @param array $editoroptions course description editor options
3234  * @return void
3235  */
3236 function update_course($data, $editoroptions = NULL) {
3237     global $CFG, $DB;
3239     $data->timemodified = time();
3241     $oldcourse = course_get_format($data->id)->get_course();
3242     $context   = context_course::instance($oldcourse->id);
3244     if ($editoroptions) {
3245         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3246     }
3248     if (!isset($data->category) or empty($data->category)) {
3249         // prevent nulls and 0 in category field
3250         unset($data->category);
3251     }
3252     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3254     if (!isset($data->visible)) {
3255         // data not from form, add missing visibility info
3256         $data->visible = $oldcourse->visible;
3257     }
3259     if ($data->visible != $oldcourse->visible) {
3260         // reset the visibleold flag when manually hiding/unhiding course
3261         $data->visibleold = $data->visible;
3262     } else {
3263         if ($movecat) {
3264             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3265             if (empty($newcategory->visible)) {
3266                 // make sure when moving into hidden category the course is hidden automatically
3267                 $data->visible = 0;
3268             }
3269         }
3270     }
3272     // Update with the new data
3273     $DB->update_record('course', $data);
3274     // make sure the modinfo cache is reset
3275     rebuild_course_cache($data->id);
3277     // update course format options with full course data
3278     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
3280     $course = $DB->get_record('course', array('id'=>$data->id));
3282     if ($movecat) {
3283         $newparent = context_coursecat::instance($course->category);
3284         context_moved($context, $newparent);
3285     }
3287     fix_course_sortorder();
3289     // Test for and remove blocks which aren't appropriate anymore
3290     blocks_remove_inappropriate($course);
3292     // Save any custom role names.
3293     save_local_role_names($course->id, $data);
3295     // update enrol settings
3296     enrol_course_updated(false, $course, $data);
3298     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3300     // Trigger events
3301     events_trigger('course_updated', $course);
3303     if ($oldcourse->format !== $course->format) {
3304         // Remove all options stored for the previous format
3305         // We assume that new course format migrated everything it needed watching trigger
3306         // 'course_updated' and in method format_XXX::update_course_format_options()
3307         $DB->delete_records('course_format_options',
3308                 array('courseid' => $course->id, 'format' => $oldcourse->format));
3309     }
3312 /**
3313  * Average number of participants
3314  * @return integer
3315  */
3316 function average_number_of_participants() {
3317     global $DB, $SITE;
3319     //count total of enrolments for visible course (except front page)
3320     $sql = 'SELECT COUNT(*) FROM (
3321         SELECT DISTINCT ue.userid, e.courseid
3322         FROM {user_enrolments} ue, {enrol} e, {course} c
3323         WHERE ue.enrolid = e.id
3324             AND e.courseid <> :siteid
3325             AND c.id = e.courseid
3326             AND c.visible = 1) total';
3327     $params = array('siteid' => $SITE->id);
3328     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3331     //count total of visible courses (minus front page)
3332     $coursetotal = $DB->count_records('course', array('visible' => 1));
3333     $coursetotal = $coursetotal - 1 ;
3335     //average of enrolment
3336     if (empty($coursetotal)) {
3337         $participantaverage = 0;
3338     } else {
3339         $participantaverage = $enrolmenttotal / $coursetotal;
3340     }
3342     return $participantaverage;
3345 /**
3346  * Average number of course modules
3347  * @return integer
3348  */
3349 function average_number_of_courses_modules() {
3350     global $DB, $SITE;
3352     //count total of visible course module (except front page)
3353     $sql = 'SELECT COUNT(*) FROM (
3354         SELECT cm.course, cm.module
3355         FROM {course} c, {course_modules} cm
3356         WHERE c.id = cm.course
3357             AND c.id <> :siteid
3358             AND cm.visible = 1
3359             AND c.visible = 1) total';
3360     $params = array('siteid' => $SITE->id);
3361     $moduletotal = $DB->count_records_sql($sql, $params);
3364     //count total of visible courses (minus front page)
3365     $coursetotal = $DB->count_records('course', array('visible' => 1));
3366     $coursetotal = $coursetotal - 1 ;
3368     //average of course module
3369     if (empty($coursetotal)) {
3370         $coursemoduleaverage = 0;
3371     } else {
3372         $coursemoduleaverage = $moduletotal / $coursetotal;
3373     }
3375     return $coursemoduleaverage;
3378 /**
3379  * This class pertains to course requests and contains methods associated with
3380  * create, approving, and removing course requests.
3381  *
3382  * Please note we do not allow embedded images here because there is no context
3383  * to store them with proper access control.
3384  *
3385  * @copyright 2009 Sam Hemelryk
3386  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3387  * @since Moodle 2.0
3388  *
3389  * @property-read int $id
3390  * @property-read string $fullname
3391  * @property-read string $shortname
3392  * @property-read string $summary
3393  * @property-read int $summaryformat
3394  * @property-read int $summarytrust
3395  * @property-read string $reason
3396  * @property-read int $requester
3397  */
3398 class course_request {
3400     /**
3401      * This is the stdClass that stores the properties for the course request
3402      * and is externally accessed through the __get magic method
3403      * @var stdClass
3404      */
3405     protected $properties;
3407     /**
3408      * An array of options for the summary editor used by course request forms.
3409      * This is initially set by {@link summary_editor_options()}
3410      * @var array
3411      * @static
3412      */
3413     protected static $summaryeditoroptions;
3415     /**
3416      * Static function to prepare the summary editor for working with a course
3417      * request.
3418      *
3419      * @static
3420      * @param null|stdClass $data Optional, an object containing the default values
3421      *                       for the form, these may be modified when preparing the
3422      *                       editor so this should be called before creating the form
3423      * @return stdClass An object that can be used to set the default values for
3424      *                   an mforms form
3425      */
3426     public static function prepare($data=null) {
3427         if ($data === null) {
3428             $data = new stdClass;
3429         }
3430         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
3431         return $data;
3432     }
3434     /**
3435      * Static function to create a new course request when passed an array of properties
3436      * for it.
3437      *
3438      * This function also handles saving any files that may have been used in the editor
3439      *
3440      * @static
3441      * @param stdClass $data
3442      * @return course_request The newly created course request
3443      */
3444     public static function create($data) {
3445         global $USER, $DB, $CFG;
3446         $data->requester = $USER->id;
3448         // Setting the default category if none set.
3449         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
3450             $data->category = $CFG->defaultrequestcategory;
3451         }
3453         // Summary is a required field so copy the text over
3454         $data->summary       = $data->summary_editor['text'];
3455         $data->summaryformat = $data->summary_editor['format'];
3457         $data->id = $DB->insert_record('course_request', $data);
3459         // Create a new course_request object and return it
3460         $request = new course_request($data);
3462         // Notify the admin if required.
3463         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
3465             $a = new stdClass;
3466             $a->link = "$CFG->wwwroot/course/pending.php";
3467             $a->user = fullname($USER);
3468             $subject = get_string('courserequest');
3469             $message = get_string('courserequestnotifyemail', 'admin', $a);
3470             foreach ($users as $user) {
3471                 $request->notify($user, $USER, 'courserequested', $subject, $message);
3472             }
3473         }
3475         return $request;
3476     }
3478     /**
3479      * Returns an array of options to use with a summary editor
3480      *
3481      * @uses course_request::$summaryeditoroptions
3482      * @return array An array of options to use with the editor
3483      */
3484     public static function summary_editor_options() {
3485         global $CFG;
3486         if (self::$summaryeditoroptions === null) {
3487             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
3488         }
3489         return self::$summaryeditoroptions;
3490     }
3492     /**
3493      * Loads the properties for this course request object. Id is required and if
3494      * only id is provided then we load the rest of the properties from the database
3495      *
3496      * @param stdClass|int $properties Either an object containing properties
3497      *                      or the course_request id to load
3498      */
3499     public function __construct($properties) {
3500         global $DB;
3501         if (empty($properties->id)) {
3502             if (empty($properties)) {
3503                 throw new coding_exception('You must provide a course request id when creating a course_request object');
3504             }
3505             $id = $properties;
3506             $properties = new stdClass;
3507             $properties->id = (int)$id;
3508             unset($id);
3509         }
3510         if (empty($properties->requester)) {
3511             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3512                 print_error('unknowncourserequest');
3513             }
3514         } else {
3515             $this->properties = $properties;
3516         }
3517         $this->properties->collision = null;
3518     }
3520     /**
3521      * Returns the requested property
3522      *
3523      * @param string $key
3524      * @return mixed
3525      */
3526     public function __get($key) {
3527         return $this->properties->$key;
3528     }
3530     /**
3531      * Override this to ensure empty($request->blah) calls return a reliable answer...
3532      *
3533      * This is required because we define the __get method
3534      *
3535      * @param mixed $key
3536      * @return bool True is it not empty, false otherwise
3537      */
3538     public function __isset($key) {
3539         return (!empty($this->properties->$key));
3540     }
3542     /**
3543      * Returns the user who requested this course
3544      *
3545      * Uses a static var to cache the results and cut down the number of db queries
3546      *
3547      * @staticvar array $requesters An array of cached users
3548      * @return stdClass The user who requested the course
3549      */
3550     public function get_requester() {
3551         global $DB;
3552         static $requesters= array();
3553         if (!array_key_exists($this->properties->requester, $requesters)) {
3554             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3555         }
3556         return $requesters[$this->properties->requester];
3557     }
3559     /**
3560      * Checks that the shortname used by the course does not conflict with any other
3561      * courses that exist
3562      *
3563      * @param string|null $shortnamemark The string to append to the requests shortname
3564      *                     should a conflict be found
3565      * @return bool true is there is a conflict, false otherwise
3566      */
3567     public function check_shortname_collision($shortnamemark = '[*]') {
3568         global $DB;
3570         if ($this->properties->collision !== null) {
3571             return $this->properties->collision;
3572         }
3574         if (empty($this->properties->shortname)) {
3575             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3576             $this->properties->collision = false;
3577         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3578             if (!empty($shortnamemark)) {
3579                 $this->properties->shortname .= ' '.$shortnamemark;
3580             }
3581             $this->properties->collision = true;
3582         } else {
3583             $this->properties->collision = false;
3584         }
3585         return $this->properties->collision;
3586     }
3588     /**
3589      * This function approves the request turning it into a course
3590      *
3591      * This function converts the course request into a course, at the same time
3592      * transferring any files used in the summary to the new course and then removing