MDL-37009 function print_course_search() is moved to course renderer
[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','generaltable');
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             $types = $gettypesfunc();
1148             if (is_array($types) && count($types) > 0) {
1149                 $group = new stdClass();
1150                 $group->name = $modname;
1151                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1152                 foreach($types as $type) {
1153                     if ($type->typestr === '--') {
1154                         continue;
1155                     }
1156                     if (strpos($type->typestr, '--') === 0) {
1157                         $group->title = str_replace('--', '', $type->typestr);
1158                         continue;
1159                     }
1160                     // Set the Sub Type metadata
1161                     $subtype = new stdClass();
1162                     $subtype->title = $type->typestr;
1163                     $subtype->type = str_replace('&amp;', '&', $type->type);
1164                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1165                     $subtype->archetype = $type->modclass;
1167                     // The group archetype should match the subtype archetypes and all subtypes
1168                     // should have the same archetype
1169                     $group->archetype = $subtype->archetype;
1171                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1172                         $subtype->help = get_string('help' . $subtype->name, $modname);
1173                     }
1174                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1175                     $group->types[] = $subtype;
1176                 }
1177                 $modlist[$course->id][$modname] = $group;
1178             }
1179         } else {
1180             $module = new stdClass();
1181             $module->title = $modnamestr;
1182             $module->name = $modname;
1183             $module->link = new moodle_url($urlbase, array('add' => $modname));
1184             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1185             $sm = get_string_manager();
1186             if ($sm->string_exists('modulename_help', $modname)) {
1187                 $module->help = get_string('modulename_help', $modname);
1188                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1189                     $link = get_string('modulename_link', $modname);
1190                     $linktext = get_string('morehelp');
1191                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1192                 }
1193             }
1194             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1195             $modlist[$course->id][$modname] = $module;
1196         }
1197         if (isset($modlist[$course->id][$modname])) {
1198             $return[$modname] = $modlist[$course->id][$modname];
1199         } else {
1200             debugging("Invalid module metadata configuration for {$modname}");
1201         }
1202     }
1204     return $return;
1207 /**
1208  * Return the course category context for the category with id $categoryid, except
1209  * that if $categoryid is 0, return the system context.
1210  *
1211  * @param integer $categoryid a category id or 0.
1212  * @return object the corresponding context
1213  */
1214 function get_category_or_system_context($categoryid) {
1215     if ($categoryid) {
1216         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1217     } else {
1218         return context_system::instance();
1219     }
1222 /**
1223  * This function generates a structured array of courses and categories.
1224  *
1225  * The depth of categories is limited by $CFG->maxcategorydepth however there
1226  * is no limit on the number of courses!
1227  *
1228  * Suitable for use with the course renderers course_category_tree method:
1229  * $renderer = $PAGE->get_renderer('core','course');
1230  * echo $renderer->course_category_tree(get_course_category_tree());
1231  *
1232  * @global moodle_database $DB
1233  * @param int $id
1234  * @param int $depth
1235  */
1236 function get_course_category_tree($id = 0, $depth = 0) {
1237     global $DB, $CFG;
1238     require_once($CFG->libdir. '/coursecatlib.php');
1239     if (!$coursecat = coursecat::get($id, IGNORE_MISSING)) {
1240         return array();
1241     }
1242     $categories = array();
1243     $categoryids = array();
1244     foreach ($coursecat->get_children() as $child) {
1245         $categories[] = $category = (object)convert_to_array($child);
1246         $categoryids[$category->id] = $category;
1247         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1248             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1249             foreach ($subcategories as $subid=>$subcat) {
1250                 $categoryids[$subid] = $subcat;
1251             }
1252             $category->courses = array();
1253         }
1254     }
1256     if ($depth > 0) {
1257         // This is a recursive call so return the required array
1258         return array($categories, $categoryids);
1259     }
1261     if (empty($categoryids)) {
1262         // No categories available (probably all hidden).
1263         return array();
1264     }
1266     // The depth is 0 this function has just been called so we can finish it off
1268     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1269     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1270     $sql = "SELECT
1271             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1272             $ccselect
1273             FROM {course} c
1274             $ccjoin
1275             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1276     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1277         // loop throught them
1278         foreach ($courses as $course) {
1279             if ($course->id == SITEID) {
1280                 continue;
1281             }
1282             context_instance_preload($course);
1283             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1284                 $categoryids[$course->category]->courses[$course->id] = $course;
1285             }
1286         }
1287     }
1288     return $categories;
1291 /**
1292  * Recursive function to print out all the categories in a nice format
1293  * with or without courses included
1294  */
1295 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1296     global $CFG;
1297     require_once($CFG->libdir. '/coursecatlib.php');
1299     // maxcategorydepth == 0 meant no limit
1300     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1301         return;
1302     }
1304     // make sure category is visible to the current user
1305     if ($category) {
1306         if (!$coursecat = coursecat::get($category->id, IGNORE_MISSING)) {
1307             return;
1308         }
1309     } else {
1310         $coursecat = coursecat::get(0);
1311     }
1313     if (!$categorycourses) {
1314         $categorycourses = get_category_courses_array($coursecat->id);
1315     }
1317     if ($coursecat->id) {
1318         print_category_info($category, $depth, $showcourses, $categorycourses[$category->id]);
1319     }
1321     if ($categories = $coursecat->get_children()) {   // Print all the children recursively
1322         $countcats = count($categories);
1323         $count = 0;
1324         $first = true;
1325         $last = false;
1326         foreach ($categories as $cat) {
1327             $count++;
1328             if ($count == $countcats) {
1329                 $last = true;
1330             }
1331             $up = $first ? false : true;
1332             $down = $last ? false : true;
1333             $first = false;
1335             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses, $categorycourses);
1336         }
1337     }
1340 /**
1341  * Gets an array whose keys are category ids and whose values are arrays of courses in the corresponding category.
1342  *
1343  * @param int $categoryid
1344  * @return array
1345  */
1346 function get_category_courses_array($categoryid = 0) {
1347     $tree = get_course_category_tree($categoryid);
1348     $flattened = array();
1349     foreach ($tree as $category) {
1350         get_category_courses_array_recursively($flattened, $category);
1351     }
1352     return $flattened;
1355 /**
1356  * Recursive function to help flatten the course category tree.
1357  *
1358  * Do not call this function directly, instead calll its parent function {@link get_category_courses_array}
1359  *
1360  * @param array &$flattened An array passed by reference in which to store courses for each category.
1361  * @param stdClass $category The category to get courses for.
1362  */
1363 function get_category_courses_array_recursively(array &$flattened, $category) {
1364     $flattened[$category->id] = $category->courses;
1365     foreach ($category->categories as $childcategory) {
1366         get_category_courses_array_recursively($flattened, $childcategory);
1367     }
1370 /**
1371  * Returns full course categories trees to be used in html_writer::select()
1372  *
1373  * Calls {@link coursecat::make_categories_list()} to build the tree and
1374  * adds whitespace to denote nesting
1375  *
1376  * @return array array mapping coursecat id to the display name
1377  */
1378 function make_categories_options() {
1379     global $CFG;
1380     require_once($CFG->libdir. '/coursecatlib.php');
1381     $cats = coursecat::make_categories_list();
1382     foreach ($cats as $key => $value) {
1383         $cats[$key] = str_repeat('&nbsp;', coursecat::get($key)->depth - 1). $value;
1384     }
1385     return $cats;
1388 /**
1389  * Prints the category information.
1390  *
1391  * This function is only used by print_whole_category_list() above
1392  *
1393  * @param stdClass $category
1394  * @param int $depth The depth of the category.
1395  * @param bool $showcourses If set to true course information will also be printed.
1396  * @param array|null $courses An array of courses belonging to the category, or null if you don't have it yet.
1397  */
1398 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1399     global $CFG, $DB, $OUTPUT;
1401     $strsummary = get_string('summary');
1403     $catlinkcss = null;
1404     if (!$category->visible) {
1405         $catlinkcss = array('class'=>'dimmed');
1406     }
1407     static $coursecount = null;
1408     if (null === $coursecount) {
1409         // only need to check this once
1410         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
1411     }
1413     if ($showcourses and $coursecount) {
1414         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
1415     } else {
1416         $catimage = "&nbsp;";
1417     }
1419     if (is_null($courses)) {
1420         $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
1421     }
1422     $context = context_coursecat::instance($category->id);
1423     $fullname = format_string($category->name, true, array('context' => $context));
1425     if ($showcourses and $coursecount) {
1426         echo '<div class="categorylist clearfix">';
1427         $cat = '';
1428         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
1429         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1430         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
1432         $html = '';
1433         if ($depth > 0) {
1434             for ($i=0; $i< $depth; $i++) {
1435                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
1436                 $cat = '';
1437             }
1438         } else {
1439             $html = $cat;
1440         }
1441         echo html_writer::tag('div', $html, array('class'=>'category'));
1442         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1444         // does the depth exceed maxcategorydepth
1445         // maxcategorydepth == 0 or unset meant no limit
1446         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
1447         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
1448             foreach ($courses as $course) {
1449                 $linkcss = null;
1450                 if (!$course->visible) {
1451                     $linkcss = array('class'=>'dimmed');
1452                 }
1454                 $coursename = get_course_display_name_for_list($course);
1455                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
1457                 // print enrol info
1458                 $courseicon = '';
1459                 if ($icons = enrol_get_course_info_icons($course)) {
1460                     foreach ($icons as $pix_icon) {
1461                         $courseicon = $OUTPUT->render($pix_icon);
1462                     }
1463                 }
1465                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
1467                 if ($course->summary) {
1468                     $link = new moodle_url('/course/info.php?id='.$course->id);
1469                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
1470                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
1471                         array('title'=>$strsummary));
1473                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
1474                 }
1476                 $html = '';
1477                 for ($i=0; $i <= $depth; $i++) {
1478                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
1479                     $coursecontent = '';
1480                 }
1481                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
1482             }
1483         }
1484         echo '</div>';
1485     } else {
1486         echo '<div class="categorylist">';
1487         $html = '';
1488         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1489         if (count($courses) > 0) {
1490             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
1491         }
1493         if ($depth > 0) {
1494             for ($i=0; $i< $depth; $i++) {
1495                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
1496                 $cat = '';
1497             }
1498         } else {
1499             $html = $cat;
1500         }
1502         echo html_writer::tag('div', $html, array('class'=>'category'));
1503         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1504         echo '</div>';
1505     }
1508 /**
1509  * Print the buttons relating to course requests.
1510  *
1511  * @param object $systemcontext the system context.
1512  */
1513 function print_course_request_buttons($systemcontext) {
1514     global $CFG, $DB, $OUTPUT;
1515     if (empty($CFG->enablecourserequests)) {
1516         return;
1517     }
1518     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
1519     /// Print a button to request a new course
1520         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
1521     }
1522     /// Print a button to manage pending requests
1523     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
1524         $disabled = !$DB->record_exists('course_request', array());
1525         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
1526     }
1529 /**
1530  * Does the user have permission to edit things in this category?
1531  *
1532  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1533  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1534  */
1535 function can_edit_in_category($categoryid = 0) {
1536     $context = get_category_or_system_context($categoryid);
1537     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1540 /**
1541  * Print courses in category. If category is 0 then all courses are printed.
1542  * @param int|stdClass $category category object or id.
1543  * @return bool true if courses found and printed, else false.
1544  */
1545 function print_courses($category) {
1546     global $CFG, $OUTPUT;
1547     require_once($CFG->libdir. '/coursecatlib.php');
1549     if (!is_object($category) && $category==0) {
1550         $categories = coursecat::get(0)->get_children();  // Parent = 0   ie top-level categories only
1551         if (is_array($categories) && count($categories) == 1) {
1552             $category   = array_shift($categories);
1553             $courses    = get_courses_wmanagers($category->id,
1554                                                 'c.sortorder ASC',
1555                                                 array('summary','summaryformat'));
1556         } else {
1557             $courses    = get_courses_wmanagers('all',
1558                                                 'c.sortorder ASC',
1559                                                 array('summary','summaryformat'));
1560         }
1561         unset($categories);
1562     } else {
1563         $courses    = get_courses_wmanagers($category->id,
1564                                             'c.sortorder ASC',
1565                                             array('summary','summaryformat'));
1566     }
1568     if ($courses) {
1569         echo html_writer::start_tag('ul', array('class'=>'unlist'));
1570         foreach ($courses as $course) {
1571             $coursecontext = context_course::instance($course->id);
1572             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
1573                 echo html_writer::start_tag('li');
1574                 print_course($course);
1575                 echo html_writer::end_tag('li');
1576             }
1577         }
1578         echo html_writer::end_tag('ul');
1579     } else {
1580         echo $OUTPUT->heading(get_string("nocoursesyet"));
1581         $context = context_system::instance();
1582         if (has_capability('moodle/course:create', $context)) {
1583             $options = array();
1584             if (!empty($category->id)) {
1585                 $options['category'] = $category->id;
1586             } else {
1587                 $options['category'] = $CFG->defaultrequestcategory;
1588             }
1589             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
1590             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
1591             echo html_writer::end_tag('div');
1592             return false;
1593         }
1594     }
1595     return true;
1598 /**
1599  * Print a description of a course, suitable for browsing in a list.
1600  *
1601  * @param object $course the course object.
1602  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
1603  */
1604 function print_course($course, $highlightterms = '') {
1605     global $CFG, $USER, $DB, $OUTPUT;
1607     $context = context_course::instance($course->id);
1609     // Rewrite file URLs so that they are correct
1610     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
1612     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
1613     echo html_writer::start_tag('div', array('class'=>'info'));
1614     echo html_writer::start_tag('h3', array('class'=>'name'));
1616     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
1618     $coursename = get_course_display_name_for_list($course);
1619     $linktext = highlight($highlightterms, format_string($coursename));
1620     $linkparams = array('title'=>get_string('entercourse'));
1621     if (empty($course->visible)) {
1622         $linkparams['class'] = 'dimmed';
1623     }
1624     echo html_writer::link($linkhref, $linktext, $linkparams);
1625     echo html_writer::end_tag('h3');
1627     /// first find all roles that are supposed to be displayed
1628     if (!empty($CFG->coursecontact)) {
1629         $managerroles = explode(',', $CFG->coursecontact);
1630         $rusers = array();
1632         if (!isset($course->managers)) {
1633             list($sort, $sortparams) = users_order_by_sql('u');
1634             $rusers = get_role_users($managerroles, $context, true,
1635                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
1636                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
1637                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
1638         } else {
1639             //  use the managers array if we have it for perf reasosn
1640             //  populate the datastructure like output of get_role_users();
1641             foreach ($course->managers as $manager) {
1642                 $user = clone($manager->user);
1643                 $user->roleid = $manager->roleid;
1644                 $user->rolename = $manager->rolename;
1645                 $user->roleshortname = $manager->roleshortname;
1646                 $user->rolecoursealias = $manager->rolecoursealias;
1647                 $rusers[$user->id] = $user;
1648             }
1649         }
1651         $namesarray = array();
1652         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
1653         foreach ($rusers as $ra) {
1654             if (isset($namesarray[$ra->id])) {
1655                 //  only display a user once with the higest sortorder role
1656                 continue;
1657             }
1659             $role = new stdClass();
1660             $role->id = $ra->roleid;
1661             $role->name = $ra->rolename;
1662             $role->shortname = $ra->roleshortname;
1663             $role->coursealias = $ra->rolecoursealias;
1664             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
1666             $fullname = fullname($ra, $canviewfullnames);
1667             $namesarray[$ra->id] = $rolename.': '.
1668                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
1669         }
1671         if (!empty($namesarray)) {
1672             echo html_writer::start_tag('ul', array('class'=>'teachers'));
1673             foreach ($namesarray as $name) {
1674                 echo html_writer::tag('li', $name);
1675             }
1676             echo html_writer::end_tag('ul');
1677         }
1678     }
1679     echo html_writer::end_tag('div'); // End of info div
1681     echo html_writer::start_tag('div', array('class'=>'summary'));
1682     $options = new stdClass();
1683     $options->noclean = true;
1684     $options->para = false;
1685     $options->overflowdiv = true;
1686     if (!isset($course->summaryformat)) {
1687         $course->summaryformat = FORMAT_MOODLE;
1688     }
1689     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
1690     if ($icons = enrol_get_course_info_icons($course)) {
1691         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
1692         foreach ($icons as $icon) {
1693             $icon->attributes["alt"] .= ": ". format_string($coursename, true, array('context'=>$context));
1694             echo $OUTPUT->render($icon);
1695         }
1696         echo html_writer::end_tag('div'); // End of enrolmenticons div
1697     }
1698     echo html_writer::end_tag('div'); // End of summary div
1699     echo html_writer::end_tag('div'); // End of coursebox div
1702 /**
1703  * Prints custom user information on the home page.
1704  * Over time this can include all sorts of information
1705  */
1706 function print_my_moodle() {
1707     global $USER, $CFG, $DB, $OUTPUT;
1709     if (!isloggedin() or isguestuser()) {
1710         print_error('nopermissions', '', '', 'See My Moodle');
1711     }
1713     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
1714     $rhosts   = array();
1715     $rcourses = array();
1716     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
1717         $rcourses = get_my_remotecourses($USER->id);
1718         $rhosts   = get_my_remotehosts();
1719     }
1721     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
1723         if (!empty($courses)) {
1724             echo '<ul class="unlist">';
1725             foreach ($courses as $course) {
1726                 if ($course->id == SITEID) {
1727                     continue;
1728                 }
1729                 echo '<li>';
1730                 print_course($course);
1731                 echo "</li>\n";
1732             }
1733             echo "</ul>\n";
1734         }
1736         // MNET
1737         if (!empty($rcourses)) {
1738             // at the IDP, we know of all the remote courses
1739             foreach ($rcourses as $course) {
1740                 print_remote_course($course, "100%");
1741             }
1742         } elseif (!empty($rhosts)) {
1743             // non-IDP, we know of all the remote servers, but not courses
1744             foreach ($rhosts as $host) {
1745                 print_remote_host($host, "100%");
1746             }
1747         }
1748         unset($course);
1749         unset($host);
1751         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
1752             echo "<table width=\"100%\"><tr><td align=\"center\">";
1753             print_course_search("", false, "short");
1754             echo "</td><td align=\"center\">";
1755             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
1756             echo "</td></tr></table>\n";
1757         }
1759     } else {
1760         if ($DB->count_records("course_categories") > 1) {
1761             echo $OUTPUT->box_start("categorybox");
1762             print_whole_category_list();
1763             echo $OUTPUT->box_end();
1764         } else {
1765             print_courses(0);
1766         }
1767     }
1771 function print_course_search($value="", $return=false, $format="plain") {
1772     global $PAGE;
1773     debugging('Function print_course_search() is deprecated, please use course renderer', DEBUG_DEVELOPER);
1774     $renderer = $PAGE->get_renderer('core', 'course');
1775     if ($return) {
1776         return $renderer->course_search_form($value, $format);
1777     } else {
1778         echo $renderer->course_search_form($value, $format);
1779     }
1782 function print_remote_course($course, $width="100%") {
1783     global $CFG, $USER;
1785     $linkcss = '';
1787     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
1789     echo '<div class="coursebox remotecoursebox clearfix">';
1790     echo '<div class="info">';
1791     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
1792          $linkcss.' href="'.$url.'">'
1793         .  format_string($course->fullname) .'</a><br />'
1794         . format_string($course->hostname) . ' : '
1795         . format_string($course->cat_name) . ' : '
1796         . format_string($course->shortname). '</div>';
1797     echo '</div><div class="summary">';
1798     $options = new stdClass();
1799     $options->noclean = true;
1800     $options->para = false;
1801     $options->overflowdiv = true;
1802     echo format_text($course->summary, $course->summaryformat, $options);
1803     echo '</div>';
1804     echo '</div>';
1807 function print_remote_host($host, $width="100%") {
1808     global $OUTPUT;
1810     $linkcss = '';
1812     echo '<div class="coursebox clearfix">';
1813     echo '<div class="info">';
1814     echo '<div class="name">';
1815     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
1816     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
1817         . s($host['name']).'</a> - ';
1818     echo $host['count'] . ' ' . get_string('courses');
1819     echo '</div>';
1820     echo '</div>';
1821     echo '</div>';
1825 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1827 function add_course_module($mod) {
1828     global $DB;
1830     $mod->added = time();
1831     unset($mod->id);
1833     $cmid = $DB->insert_record("course_modules", $mod);
1834     rebuild_course_cache($mod->course, true);
1835     return $cmid;
1838 /**
1839  * Creates missing course section(s) and rebuilds course cache
1840  *
1841  * @param int|stdClass $courseorid course id or course object
1842  * @param int|array $sections list of relative section numbers to create
1843  * @return bool if there were any sections created
1844  */
1845 function course_create_sections_if_missing($courseorid, $sections) {
1846     global $DB;
1847     if (!is_array($sections)) {
1848         $sections = array($sections);
1849     }
1850     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1851     if (is_object($courseorid)) {
1852         $courseorid = $courseorid->id;
1853     }
1854     $coursechanged = false;
1855     foreach ($sections as $sectionnum) {
1856         if (!in_array($sectionnum, $existing)) {
1857             $cw = new stdClass();
1858             $cw->course   = $courseorid;
1859             $cw->section  = $sectionnum;
1860             $cw->summary  = '';
1861             $cw->summaryformat = FORMAT_HTML;
1862             $cw->sequence = '';
1863             $id = $DB->insert_record("course_sections", $cw);
1864             $coursechanged = true;
1865         }
1866     }
1867     if ($coursechanged) {
1868         rebuild_course_cache($courseorid, true);
1869     }
1870     return $coursechanged;
1873 /**
1874  * Adds an existing module to the section
1875  *
1876  * Updates both tables {course_sections} and {course_modules}
1877  *
1878  * @param int|stdClass $courseorid course id or course object
1879  * @param int $cmid id of the module already existing in course_modules table
1880  * @param int $sectionnum relative number of the section (field course_sections.section)
1881  *     If section does not exist it will be created
1882  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1883  *     before which the module needs to be included. Null for inserting in the
1884  *     end of the section
1885  * @return int The course_sections ID where the module is inserted
1886  */
1887 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1888     global $DB, $COURSE;
1889     if (is_object($beforemod)) {
1890         $beforemod = $beforemod->id;
1891     }
1892     if (is_object($courseorid)) {
1893         $courseid = $courseorid->id;
1894     } else {
1895         $courseid = $courseorid;
1896     }
1897     course_create_sections_if_missing($courseorid, $sectionnum);
1898     // Do not try to use modinfo here, there is no guarantee it is valid!
1899     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
1900     $modarray = explode(",", trim($section->sequence));
1901     if (empty($section->sequence)) {
1902         $newsequence = "$cmid";
1903     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1904         $insertarray = array($cmid, $beforemod);
1905         array_splice($modarray, $key[0], 1, $insertarray);
1906         $newsequence = implode(",", $modarray);
1907     } else {
1908         $newsequence = "$section->sequence,$cmid";
1909     }
1910     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
1911     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
1912     if (is_object($courseorid)) {
1913         rebuild_course_cache($courseorid->id, true);
1914     } else {
1915         rebuild_course_cache($courseorid, true);
1916     }
1917     return $section->id;     // Return course_sections ID that was used.
1920 function set_coursemodule_groupmode($id, $groupmode) {
1921     global $DB;
1922     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1923     if ($cm->groupmode != $groupmode) {
1924         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1925         rebuild_course_cache($cm->course, true);
1926     }
1927     return ($cm->groupmode != $groupmode);
1930 function set_coursemodule_idnumber($id, $idnumber) {
1931     global $DB;
1932     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1933     if ($cm->idnumber != $idnumber) {
1934         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1935         rebuild_course_cache($cm->course, true);
1936     }
1937     return ($cm->idnumber != $idnumber);
1940 /**
1941  * Set the visibility of a module and inherent properties.
1942  *
1943  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1944  * has been moved to {@link set_section_visible()} which was the only place from which
1945  * the parameter was used.
1946  *
1947  * @param int $id of the module
1948  * @param int $visible state of the module
1949  * @return bool false when the module was not found, true otherwise
1950  */
1951 function set_coursemodule_visible($id, $visible) {
1952     global $DB, $CFG;
1953     require_once($CFG->libdir.'/gradelib.php');
1955     // Trigger developer's attention when using the previously removed argument.
1956     if (func_num_args() > 2) {
1957         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1958             has been removed.', DEBUG_DEVELOPER);
1959     }
1961     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1962         return false;
1963     }
1965     // Create events and propagate visibility to associated grade items if the value has changed.
1966     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1967     if ($cm->visible == $visible) {
1968         return true;
1969     }
1971     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
1972         return false;
1973     }
1974     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
1975         foreach($events as $event) {
1976             if ($visible) {
1977                 show_event($event);
1978             } else {
1979                 hide_event($event);
1980             }
1981         }
1982     }
1984     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1985     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1986     if ($grade_items) {
1987         foreach ($grade_items as $grade_item) {
1988             $grade_item->set_hidden(!$visible);
1989         }
1990     }
1992     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1993     // affect visibleold to allow for an original visibility restore. See set_section_visible().
1994     $cminfo = new stdClass();
1995     $cminfo->id = $id;
1996     $cminfo->visible = $visible;
1997     $cminfo->visibleold = $visible;
1998     $DB->update_record('course_modules', $cminfo);
2000     rebuild_course_cache($cm->course, true);
2001     return true;
2004 /**
2005  * This function will handles the whole deletion process of a module. This includes calling
2006  * the modules delete_instance function, deleting files, events, grades, conditional data,
2007  * the data in the course_module and course_sections table and adding a module deletion
2008  * event to the DB.
2009  *
2010  * @param int $cmid the course module id
2011  * @since 2.5
2012  */
2013 function course_delete_module($cmid) {
2014     global $CFG, $DB, $USER;
2016     require_once($CFG->libdir.'/gradelib.php');
2017     require_once($CFG->dirroot.'/blog/lib.php');
2019     // Get the course module.
2020     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
2021         return true;
2022     }
2024     // Get the module context.
2025     $modcontext = context_module::instance($cm->id);
2027     // Get the course module name.
2028     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
2030     // Get the file location of the delete_instance function for this module.
2031     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
2033     // Include the file required to call the delete_instance function for this module.
2034     if (file_exists($modlib)) {
2035         require_once($modlib);
2036     } else {
2037         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
2038             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
2039     }
2041     $deleteinstancefunction = $modulename . '_delete_instance';
2043     // Ensure the delete_instance function exists for this module.
2044     if (!function_exists($deleteinstancefunction)) {
2045         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
2046             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
2047     }
2049     // Call the delete_instance function, if it returns false throw an exception.
2050     if (!$deleteinstancefunction($cm->instance)) {
2051         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
2052             "Cannot delete the module $modulename (instance).");
2053     }
2055     // Remove all module files in case modules forget to do that.
2056     $fs = get_file_storage();
2057     $fs->delete_area_files($modcontext->id);
2059     // Delete events from calendar.
2060     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
2061         foreach($events as $event) {
2062             delete_event($event->id);
2063         }
2064     }
2066     // Delete grade items, outcome items and grades attached to modules.
2067     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
2068                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
2069         foreach ($grade_items as $grade_item) {
2070             $grade_item->delete('moddelete');
2071         }
2072     }
2074     // Delete completion and availability data; it is better to do this even if the
2075     // features are not turned on, in case they were turned on previously (these will be
2076     // very quick on an empty table).
2077     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2078     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2079     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2080     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2081                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2083     // Delete the context.
2084     delete_context(CONTEXT_MODULE, $cm->id);
2086     // Delete the module from the course_modules table.
2087     $DB->delete_records('course_modules', array('id' => $cm->id));
2089     // Delete module from that section.
2090     if (!delete_mod_from_section($cm->id, $cm->section)) {
2091         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
2092             "Cannot delete the module $modulename (instance) from section.");
2093     }
2095     // Trigger a mod_deleted event with information about this module.
2096     $eventdata = new stdClass();
2097     $eventdata->modulename = $modulename;
2098     $eventdata->cmid       = $cm->id;
2099     $eventdata->courseid   = $cm->course;
2100     $eventdata->userid     = $USER->id;
2101     events_trigger('mod_deleted', $eventdata);
2103     add_to_log($cm->course, 'course', "delete mod",
2104                "view.php?id=$cm->course",
2105                "$modulename $cm->instance", $cm->id);
2107     rebuild_course_cache($cm->course, true);
2110 function delete_mod_from_section($modid, $sectionid) {
2111     global $DB;
2113     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2115         $modarray = explode(",", $section->sequence);
2117         if ($key = array_keys ($modarray, $modid)) {
2118             array_splice($modarray, $key[0], 1);
2119             $newsequence = implode(",", $modarray);
2120             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2121             rebuild_course_cache($section->course, true);
2122             return true;
2123         } else {
2124             return false;
2125         }
2127     }
2128     return false;
2131 /**
2132  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2133  *
2134  * @param object $course course object
2135  * @param int $section Section number (not id!!!)
2136  * @param int $move (-1 or 1)
2137  * @return boolean true if section moved successfully
2138  * @todo MDL-33379 remove this function in 2.5
2139  */
2140 function move_section($course, $section, $move) {
2141     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2143 /// Moves a whole course section up and down within the course
2144     global $USER;
2146     if (!$move) {
2147         return true;
2148     }
2150     $sectiondest = $section + $move;
2152     // compartibility with course formats using field 'numsections'
2153     $courseformatoptions = course_get_format($course)->get_format_options();
2154     if (array_key_exists('numsections', $courseformatoptions) &&
2155             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2156         return false;
2157     }
2159     $retval = move_section_to($course, $section, $sectiondest);
2160     return $retval;
2163 /**
2164  * Moves a section within a course, from a position to another.
2165  * Be very careful: $section and $destination refer to section number,
2166  * not id!.
2167  *
2168  * @param object $course
2169  * @param int $section Section number (not id!!!)
2170  * @param int $destination
2171  * @return boolean Result
2172  */
2173 function move_section_to($course, $section, $destination) {
2174 /// Moves a whole course section up and down within the course
2175     global $USER, $DB;
2177     if (!$destination && $destination != 0) {
2178         return true;
2179     }
2181     // compartibility with course formats using field 'numsections'
2182     $courseformatoptions = course_get_format($course)->get_format_options();
2183     if ((array_key_exists('numsections', $courseformatoptions) &&
2184             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
2185         return false;
2186     }
2188     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2189     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2190             'section ASC, id ASC', 'id, section')) {
2191         return false;
2192     }
2194     $movedsections = reorder_sections($sections, $section, $destination);
2196     // Update all sections. Do this in 2 steps to avoid breaking database
2197     // uniqueness constraint
2198     $transaction = $DB->start_delegated_transaction();
2199     foreach ($movedsections as $id => $position) {
2200         if ($sections[$id] !== $position) {
2201             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2202         }
2203     }
2204     foreach ($movedsections as $id => $position) {
2205         if ($sections[$id] !== $position) {
2206             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2207         }
2208     }
2210     // If we move the highlighted section itself, then just highlight the destination.
2211     // Adjust the higlighted section location if we move something over it either direction.
2212     if ($section == $course->marker) {
2213         course_set_marker($course->id, $destination);
2214     } elseif ($section > $course->marker && $course->marker >= $destination) {
2215         course_set_marker($course->id, $course->marker+1);
2216     } elseif ($section < $course->marker && $course->marker <= $destination) {
2217         course_set_marker($course->id, $course->marker-1);
2218     }
2220     $transaction->allow_commit();
2221     rebuild_course_cache($course->id, true);
2222     return true;
2225 /**
2226  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2227  * an original position number and a target position number, rebuilds the array so that the
2228  * move is made without any duplication of section positions.
2229  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2230  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2231  *
2232  * @param array $sections
2233  * @param int $origin_position
2234  * @param int $target_position
2235  * @return array
2236  */
2237 function reorder_sections($sections, $origin_position, $target_position) {
2238     if (!is_array($sections)) {
2239         return false;
2240     }
2242     // We can't move section position 0
2243     if ($origin_position < 1) {
2244         echo "We can't move section position 0";
2245         return false;
2246     }
2248     // Locate origin section in sections array
2249     if (!$origin_key = array_search($origin_position, $sections)) {
2250         echo "searched position not in sections array";
2251         return false; // searched position not in sections array
2252     }
2254     // Extract origin section
2255     $origin_section = $sections[$origin_key];
2256     unset($sections[$origin_key]);
2258     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2259     $found = false;
2260     $append_array = array();
2261     foreach ($sections as $id => $position) {
2262         if ($found) {
2263             $append_array[$id] = $position;
2264             unset($sections[$id]);
2265         }
2266         if ($position == $target_position) {
2267             if ($target_position < $origin_position) {
2268                 $append_array[$id] = $position;
2269                 unset($sections[$id]);
2270             }
2271             $found = true;
2272         }
2273     }
2275     // Append moved section
2276     $sections[$origin_key] = $origin_section;
2278     // Append rest of array (if applicable)
2279     if (!empty($append_array)) {
2280         foreach ($append_array as $id => $position) {
2281             $sections[$id] = $position;
2282         }
2283     }
2285     // Renumber positions
2286     $position = 0;
2287     foreach ($sections as $id => $p) {
2288         $sections[$id] = $position;
2289         $position++;
2290     }
2292     return $sections;
2296 /**
2297  * Move the module object $mod to the specified $section
2298  * If $beforemod exists then that is the module
2299  * before which $modid should be inserted
2300  * All parameters are objects
2301  */
2302 function moveto_module($mod, $section, $beforemod=NULL) {
2303     global $OUTPUT, $DB;
2305 /// Remove original module from original section
2306     if (! delete_mod_from_section($mod->id, $mod->section)) {
2307         echo $OUTPUT->notification("Could not delete module from existing section");
2308     }
2310     // if moving to a hidden section then hide module
2311     if (!$section->visible && $mod->visible) {
2312         // Set this in the object because it is sent as a response to ajax calls.
2313         $mod->visible = 0;
2314         set_coursemodule_visible($mod->id, 0);
2315         // Set visibleold to 1 so module will be visible when section is made visible.
2316         $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
2317     }
2318     if ($section->visible && !$mod->visible) {
2319         set_coursemodule_visible($mod->id, $mod->visibleold);
2320         // Set this in the object because it is sent as a response to ajax calls.
2321         $mod->visible = $mod->visibleold;
2322     }
2324 /// Add the module into the new section
2325     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
2326     return true;
2329 /**
2330  * Returns the list of all editing actions that current user can perform on the module
2331  *
2332  * @param cm_info $mod The module to produce editing buttons for
2333  * @param int $indent The current indenting (default -1 means no move left-right actions)
2334  * @param int $sr The section to link back to (used for creating the links)
2335  * @return array array of action_link or pix_icon objects
2336  */
2337 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2338     global $COURSE, $SITE;
2340     static $str;
2342     $coursecontext = context_course::instance($mod->course);
2343     $modcontext = context_module::instance($mod->id);
2345     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2346     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2348     // no permission to edit anything
2349     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2350         return array();
2351     }
2353     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2355     if (!isset($str)) {
2356         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2357             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
2358         $str->assign         = get_string('assignroles', 'role');
2359         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2360         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2361         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2362         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
2363         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
2364         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
2365     }
2367     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2369     if ($sr !== null) {
2370         $baseurl->param('sr', $sr);
2371     }
2372     $actions = array();
2374     // AJAX edit title
2375     if ($mod->has_view() && $hasmanageactivities &&
2376                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
2377                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
2378         // we will not display link if we are on some other-course page (where we should not see this module anyway)
2379         $actions['title'] = new action_link(
2380             new moodle_url($baseurl, array('update' => $mod->id)),
2381             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2382             null,
2383             array('class' => 'editing_title', 'title' => $str->edittitle)
2384         );
2385     }
2387     // leftright
2388     if ($hasmanageactivities) {
2389         if (right_to_left()) {   // Exchange arrows on RTL
2390             $rightarrow = 't/left';
2391             $leftarrow  = 't/right';
2392         } else {
2393             $rightarrow = 't/right';
2394             $leftarrow  = 't/left';
2395         }
2397         if ($indent > 0) {
2398             $actions['moveleft'] = new action_link(
2399                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
2400                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2401                 null,
2402                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
2403             );
2404         }
2405         if ($indent >= 0) {
2406             $actions['moveright'] = new action_link(
2407                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2408                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2409                 null,
2410                 array('class' => 'editing_moveright', 'title' => $str->moveright)
2411             );
2412         }
2413     }
2415     // move
2416     if ($hasmanageactivities) {
2417         $actions['move'] = new action_link(
2418             new moodle_url($baseurl, array('copy' => $mod->id)),
2419             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2420             null,
2421             array('class' => 'editing_move', 'title' => $str->move)
2422         );
2423     }
2425     // Update
2426     if ($hasmanageactivities) {
2427         $actions['update'] = new action_link(
2428             new moodle_url($baseurl, array('update' => $mod->id)),
2429             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2430             null,
2431             array('class' => 'editing_update', 'title' => $str->update)
2432         );
2433     }
2435     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2436     // note that restoring on front page is never allowed
2437     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
2438             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
2439         $actions['duplicate'] = new action_link(
2440             new moodle_url($baseurl, array('duplicate' => $mod->id)),
2441             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2442             null,
2443             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
2444         );
2445     }
2447     // Delete
2448     if ($hasmanageactivities) {
2449         $actions['delete'] = new action_link(
2450             new moodle_url($baseurl, array('delete' => $mod->id)),
2451             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2452             null,
2453             array('class' => 'editing_delete', 'title' => $str->delete)
2454         );
2455     }
2457     // hideshow
2458     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2459         if ($mod->visible) {
2460             $actions['hide'] = new action_link(
2461                 new moodle_url($baseurl, array('hide' => $mod->id)),
2462                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2463                 null,
2464                 array('class' => 'editing_hide', 'title' => $str->hide)
2465             );
2466         } else {
2467             $actions['show'] = new action_link(
2468                 new moodle_url($baseurl, array('show' => $mod->id)),
2469                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2470                 null,
2471                 array('class' => 'editing_show', 'title' => $str->show)
2472             );
2473         }
2474     }
2476     // groupmode
2477     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2478         if ($mod->coursegroupmodeforce) {
2479             $modgroupmode = $mod->coursegroupmode;
2480         } else {
2481             $modgroupmode = $mod->groupmode;
2482         }
2483         if ($modgroupmode == SEPARATEGROUPS) {
2484             $groupmode = NOGROUPS;
2485             $grouptitle = $str->groupsseparate;
2486             $forcedgrouptitle = $str->forcedgroupsseparate;
2487             $actionname = 'groupsseparate';
2488             $groupimage = 't/groups';
2489         } else if ($modgroupmode == VISIBLEGROUPS) {
2490             $groupmode = SEPARATEGROUPS;
2491             $grouptitle = $str->groupsvisible;
2492             $forcedgrouptitle = $str->forcedgroupsvisible;
2493             $actionname = 'groupsvisible';
2494             $groupimage = 't/groupv';
2495         } else {
2496             $groupmode = VISIBLEGROUPS;
2497             $grouptitle = $str->groupsnone;
2498             $forcedgrouptitle = $str->forcedgroupsnone;
2499             $actionname = 'groupsnone';
2500             $groupimage = 't/groupn';
2501         }
2502         if (!$mod->coursegroupmodeforce) {
2503             $actions[$actionname] = new action_link(
2504                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
2505                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2506                 null,
2507                 array('class' => 'editing_'. $actionname, 'title' => $grouptitle)
2508             );
2509         } else {
2510             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
2511         }
2512     }
2514     // Assign
2515     if (has_capability('moodle/role:assign', $modcontext)){
2516         $actions['assign'] = new action_link(
2517             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2518             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2519             null,
2520             array('class' => 'editing_assign', 'title' => $str->assign)
2521         );
2522     }
2524     return $actions;
2527 /**
2528  * given a course object with shortname & fullname, this function will
2529  * truncate the the number of chars allowed and add ... if it was too long
2530  */
2531 function course_format_name ($course,$max=100) {
2533     $context = context_course::instance($course->id);
2534     $shortname = format_string($course->shortname, true, array('context' => $context));
2535     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2536     $str = $shortname.': '. $fullname;
2537     if (textlib::strlen($str) <= $max) {
2538         return $str;
2539     }
2540     else {
2541         return textlib::substr($str,0,$max-3).'...';
2542     }
2545 /**
2546  * Is the user allowed to add this type of module to this course?
2547  * @param object $course the course settings. Only $course->id is used.
2548  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2549  * @return bool whether the current user is allowed to add this type of module to this course.
2550  */
2551 function course_allowed_module($course, $modname) {
2552     if (is_numeric($modname)) {
2553         throw new coding_exception('Function course_allowed_module no longer
2554                 supports numeric module ids. Please update your code to pass the module name.');
2555     }
2557     $capability = 'mod/' . $modname . ':addinstance';
2558     if (!get_capability_info($capability)) {
2559         // Debug warning that the capability does not exist, but no more than once per page.
2560         static $warned = array();
2561         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2562         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2563             debugging('The module ' . $modname . ' does not define the standard capability ' .
2564                     $capability , DEBUG_DEVELOPER);
2565             $warned[$modname] = 1;
2566         }
2568         // If the capability does not exist, the module can always be added.
2569         return true;
2570     }
2572     $coursecontext = context_course::instance($course->id);
2573     return has_capability($capability, $coursecontext);
2576 /**
2577  * Efficiently moves many courses around while maintaining
2578  * sortorder in order.
2579  *
2580  * @param array $courseids is an array of course ids
2581  * @param int $categoryid
2582  * @return bool success
2583  */
2584 function move_courses($courseids, $categoryid) {
2585     global $CFG, $DB, $OUTPUT;
2587     if (empty($courseids)) {
2588         // nothing to do
2589         return;
2590     }
2592     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
2593         return false;
2594     }
2596     $courseids = array_reverse($courseids);
2597     $newparent = context_coursecat::instance($category->id);
2598     $i = 1;
2600     foreach ($courseids as $courseid) {
2601         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
2602             $course = new stdClass();
2603             $course->id = $courseid;
2604             $course->category  = $category->id;
2605             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2606             if ($category->visible == 0) {
2607                 // hide the course when moving into hidden category,
2608                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
2609                 $course->visible = 0;
2610             }
2612             $DB->update_record('course', $course);
2613             add_to_log($course->id, "course", "move", "edit.php?id=$course->id", $course->id);
2615             $context   = context_course::instance($course->id);
2616             context_moved($context, $newparent);
2617         }
2618     }
2619     fix_course_sortorder();
2620     cache_helper::purge_by_event('changesincourse');
2622     return true;
2625 /**
2626  * Returns the display name of the given section that the course prefers
2627  *
2628  * Implementation of this function is provided by course format
2629  * @see format_base::get_section_name()
2630  *
2631  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2632  * @param int|stdClass $section Section object from database or just field course_sections.section
2633  * @return string Display name that the course format prefers, e.g. "Week 2"
2634  */
2635 function get_section_name($courseorid, $section) {
2636     return course_get_format($courseorid)->get_section_name($section);
2639 /**
2640  * Tells if current course format uses sections
2641  *
2642  * @param string $format Course format ID e.g. 'weeks' $course->format
2643  * @return bool
2644  */
2645 function course_format_uses_sections($format) {
2646     $course = new stdClass();
2647     $course->format = $format;
2648     return course_get_format($course)->uses_sections();
2651 /**
2652  * Returns the information about the ajax support in the given source format
2653  *
2654  * The returned object's property (boolean)capable indicates that
2655  * the course format supports Moodle course ajax features.
2656  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
2657  *
2658  * @param string $format
2659  * @return stdClass
2660  */
2661 function course_format_ajax_support($format) {
2662     $course = new stdClass();
2663     $course->format = $format;
2664     return course_get_format($course)->supports_ajax();
2667 /**
2668  * Can the current user delete this course?
2669  * Course creators have exception,
2670  * 1 day after the creation they can sill delete the course.
2671  * @param int $courseid
2672  * @return boolean
2673  */
2674 function can_delete_course($courseid) {
2675     global $USER, $DB;
2677     $context = context_course::instance($courseid);
2679     if (has_capability('moodle/course:delete', $context)) {
2680         return true;
2681     }
2683     // hack: now try to find out if creator created this course recently (1 day)
2684     if (!has_capability('moodle/course:create', $context)) {
2685         return false;
2686     }
2688     $since = time() - 60*60*24;
2690     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
2691     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
2693     return $DB->record_exists_select('log', $select, $params);
2696 /**
2697  * Save the Your name for 'Some role' strings.
2698  *
2699  * @param integer $courseid the id of this course.
2700  * @param array $data the data that came from the course settings form.
2701  */
2702 function save_local_role_names($courseid, $data) {
2703     global $DB;
2704     $context = context_course::instance($courseid);
2706     foreach ($data as $fieldname => $value) {
2707         if (strpos($fieldname, 'role_') !== 0) {
2708             continue;
2709         }
2710         list($ignored, $roleid) = explode('_', $fieldname);
2712         // make up our mind whether we want to delete, update or insert
2713         if (!$value) {
2714             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2716         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2717             $rolename->name = $value;
2718             $DB->update_record('role_names', $rolename);
2720         } else {
2721             $rolename = new stdClass;
2722             $rolename->contextid = $context->id;
2723             $rolename->roleid = $roleid;
2724             $rolename->name = $value;
2725             $DB->insert_record('role_names', $rolename);
2726         }
2727     }
2730 /**
2731  * Create a course and either return a $course object
2732  *
2733  * Please note this functions does not verify any access control,
2734  * the calling code is responsible for all validation (usually it is the form definition).
2735  *
2736  * @param array $editoroptions course description editor options
2737  * @param object $data  - all the data needed for an entry in the 'course' table
2738  * @return object new course instance
2739  */
2740 function create_course($data, $editoroptions = NULL) {
2741     global $CFG, $DB;
2743     //check the categoryid - must be given for all new courses
2744     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2746     //check if the shortname already exist
2747     if (!empty($data->shortname)) {
2748         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2749             throw new moodle_exception('shortnametaken');
2750         }
2751     }
2753     //check if the id number already exist
2754     if (!empty($data->idnumber)) {
2755         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2756             throw new moodle_exception('idnumbertaken');
2757         }
2758     }
2760     $data->timecreated  = time();
2761     $data->timemodified = $data->timecreated;
2763     // place at beginning of any category
2764     $data->sortorder = 0;
2766     if ($editoroptions) {
2767         // summary text is updated later, we need context to store the files first
2768         $data->summary = '';
2769         $data->summary_format = FORMAT_HTML;
2770     }
2772     if (!isset($data->visible)) {
2773         // data not from form, add missing visibility info
2774         $data->visible = $category->visible;
2775     }
2776     $data->visibleold = $data->visible;
2778     $newcourseid = $DB->insert_record('course', $data);
2779     $context = context_course::instance($newcourseid, MUST_EXIST);
2781     if ($editoroptions) {
2782         // Save the files used in the summary editor and store
2783         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2784         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2785         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2786     }
2788     // update course format options
2789     course_get_format($newcourseid)->update_course_format_options($data);
2791     $course = course_get_format($newcourseid)->get_course();
2793     // Setup the blocks
2794     blocks_add_default_course_blocks($course);
2796     // Create a default section.
2797     course_create_sections_if_missing($course, 0);
2799     fix_course_sortorder();
2800     // purge appropriate caches in case fix_course_sortorder() did not change anything
2801     cache_helper::purge_by_event('changesincourse');
2803     // new context created - better mark it as dirty
2804     mark_context_dirty($context->path);
2806     // Save any custom role names.
2807     save_local_role_names($course->id, (array)$data);
2809     // set up enrolments
2810     enrol_course_updated(true, $course, $data);
2812     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
2814     // Trigger events
2815     events_trigger('course_created', $course);
2817     return $course;
2820 /**
2821  * Update a course.
2822  *
2823  * Please note this functions does not verify any access control,
2824  * the calling code is responsible for all validation (usually it is the form definition).
2825  *
2826  * @param object $data  - all the data needed for an entry in the 'course' table
2827  * @param array $editoroptions course description editor options
2828  * @return void
2829  */
2830 function update_course($data, $editoroptions = NULL) {
2831     global $CFG, $DB;
2833     $data->timemodified = time();
2835     $oldcourse = course_get_format($data->id)->get_course();
2836     $context   = context_course::instance($oldcourse->id);
2838     if ($editoroptions) {
2839         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2840     }
2842     if (!isset($data->category) or empty($data->category)) {
2843         // prevent nulls and 0 in category field
2844         unset($data->category);
2845     }
2846     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2848     if (!isset($data->visible)) {
2849         // data not from form, add missing visibility info
2850         $data->visible = $oldcourse->visible;
2851     }
2853     if ($data->visible != $oldcourse->visible) {
2854         // reset the visibleold flag when manually hiding/unhiding course
2855         $data->visibleold = $data->visible;
2856     } else {
2857         if ($movecat) {
2858             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2859             if (empty($newcategory->visible)) {
2860                 // make sure when moving into hidden category the course is hidden automatically
2861                 $data->visible = 0;
2862             }
2863         }
2864     }
2866     // Update with the new data
2867     $DB->update_record('course', $data);
2868     // make sure the modinfo cache is reset
2869     rebuild_course_cache($data->id);
2871     // update course format options with full course data
2872     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2874     $course = $DB->get_record('course', array('id'=>$data->id));
2876     if ($movecat) {
2877         $newparent = context_coursecat::instance($course->category);
2878         context_moved($context, $newparent);
2879     }
2881     fix_course_sortorder();
2882     // purge appropriate caches in case fix_course_sortorder() did not change anything
2883     cache_helper::purge_by_event('changesincourse');
2885     // Test for and remove blocks which aren't appropriate anymore
2886     blocks_remove_inappropriate($course);
2888     // Save any custom role names.
2889     save_local_role_names($course->id, $data);
2891     // update enrol settings
2892     enrol_course_updated(false, $course, $data);
2894     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
2896     // Trigger events
2897     events_trigger('course_updated', $course);
2899     if ($oldcourse->format !== $course->format) {
2900         // Remove all options stored for the previous format
2901         // We assume that new course format migrated everything it needed watching trigger
2902         // 'course_updated' and in method format_XXX::update_course_format_options()
2903         $DB->delete_records('course_format_options',
2904                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2905     }
2908 /**
2909  * Average number of participants
2910  * @return integer
2911  */
2912 function average_number_of_participants() {
2913     global $DB, $SITE;
2915     //count total of enrolments for visible course (except front page)
2916     $sql = 'SELECT COUNT(*) FROM (
2917         SELECT DISTINCT ue.userid, e.courseid
2918         FROM {user_enrolments} ue, {enrol} e, {course} c
2919         WHERE ue.enrolid = e.id
2920             AND e.courseid <> :siteid
2921             AND c.id = e.courseid
2922             AND c.visible = 1) total';
2923     $params = array('siteid' => $SITE->id);
2924     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2927     //count total of visible courses (minus front page)
2928     $coursetotal = $DB->count_records('course', array('visible' => 1));
2929     $coursetotal = $coursetotal - 1 ;
2931     //average of enrolment
2932     if (empty($coursetotal)) {
2933         $participantaverage = 0;
2934     } else {
2935         $participantaverage = $enrolmenttotal / $coursetotal;
2936     }
2938     return $participantaverage;
2941 /**
2942  * Average number of course modules
2943  * @return integer
2944  */
2945 function average_number_of_courses_modules() {
2946     global $DB, $SITE;
2948     //count total of visible course module (except front page)
2949     $sql = 'SELECT COUNT(*) FROM (
2950         SELECT cm.course, cm.module
2951         FROM {course} c, {course_modules} cm
2952         WHERE c.id = cm.course
2953             AND c.id <> :siteid
2954             AND cm.visible = 1
2955             AND c.visible = 1) total';
2956     $params = array('siteid' => $SITE->id);
2957     $moduletotal = $DB->count_records_sql($sql, $params);
2960     //count total of visible courses (minus front page)
2961     $coursetotal = $DB->count_records('course', array('visible' => 1));
2962     $coursetotal = $coursetotal - 1 ;
2964     //average of course module
2965     if (empty($coursetotal)) {
2966         $coursemoduleaverage = 0;
2967     } else {
2968         $coursemoduleaverage = $moduletotal / $coursetotal;
2969     }
2971     return $coursemoduleaverage;
2974 /**
2975  * This class pertains to course requests and contains methods associated with
2976  * create, approving, and removing course requests.
2977  *
2978  * Please note we do not allow embedded images here because there is no context
2979  * to store them with proper access control.
2980  *
2981  * @copyright 2009 Sam Hemelryk
2982  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2983  * @since Moodle 2.0
2984  *
2985  * @property-read int $id
2986  * @property-read string $fullname
2987  * @property-read string $shortname
2988  * @property-read string $summary
2989  * @property-read int $summaryformat
2990  * @property-read int $summarytrust
2991  * @property-read string $reason
2992  * @property-read int $requester
2993  */
2994 class course_request {
2996     /**
2997      * This is the stdClass that stores the properties for the course request
2998      * and is externally accessed through the __get magic method
2999      * @var stdClass
3000      */
3001     protected $properties;
3003     /**
3004      * An array of options for the summary editor used by course request forms.
3005      * This is initially set by {@link summary_editor_options()}
3006      * @var array
3007      * @static
3008      */
3009     protected static $summaryeditoroptions;
3011     /**
3012      * Static function to prepare the summary editor for working with a course
3013      * request.
3014      *
3015      * @static
3016      * @param null|stdClass $data Optional, an object containing the default values
3017      *                       for the form, these may be modified when preparing the
3018      *                       editor so this should be called before creating the form
3019      * @return stdClass An object that can be used to set the default values for
3020      *                   an mforms form
3021      */
3022     public static function prepare($data=null) {
3023         if ($data === null) {
3024             $data = new stdClass;
3025         }
3026         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
3027         return $data;
3028     }
3030     /**
3031      * Static function to create a new course request when passed an array of properties
3032      * for it.
3033      *
3034      * This function also handles saving any files that may have been used in the editor
3035      *
3036      * @static
3037      * @param stdClass $data
3038      * @return course_request The newly created course request
3039      */
3040     public static function create($data) {
3041         global $USER, $DB, $CFG;
3042         $data->requester = $USER->id;
3044         // Setting the default category if none set.
3045         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
3046             $data->category = $CFG->defaultrequestcategory;
3047         }
3049         // Summary is a required field so copy the text over
3050         $data->summary       = $data->summary_editor['text'];
3051         $data->summaryformat = $data->summary_editor['format'];
3053         $data->id = $DB->insert_record('course_request', $data);
3055         // Create a new course_request object and return it
3056         $request = new course_request($data);
3058         // Notify the admin if required.
3059         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
3061             $a = new stdClass;
3062             $a->link = "$CFG->wwwroot/course/pending.php";
3063             $a->user = fullname($USER);
3064             $subject = get_string('courserequest');
3065             $message = get_string('courserequestnotifyemail', 'admin', $a);
3066             foreach ($users as $user) {
3067                 $request->notify($user, $USER, 'courserequested', $subject, $message);
3068             }
3069         }
3071         return $request;
3072     }
3074     /**
3075      * Returns an array of options to use with a summary editor
3076      *
3077      * @uses course_request::$summaryeditoroptions
3078      * @return array An array of options to use with the editor
3079      */
3080     public static function summary_editor_options() {
3081         global $CFG;
3082         if (self::$summaryeditoroptions === null) {
3083             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
3084         }
3085         return self::$summaryeditoroptions;
3086     }
3088     /**
3089      * Loads the properties for this course request object. Id is required and if
3090      * only id is provided then we load the rest of the properties from the database
3091      *
3092      * @param stdClass|int $properties Either an object containing properties
3093      *                      or the course_request id to load
3094      */
3095     public function __construct($properties) {
3096         global $DB;
3097         if (empty($properties->id)) {
3098             if (empty($properties)) {
3099                 throw new coding_exception('You must provide a course request id when creating a course_request object');
3100             }
3101             $id = $properties;
3102             $properties = new stdClass;
3103             $properties->id = (int)$id;
3104             unset($id);
3105         }
3106         if (empty($properties->requester)) {
3107             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3108                 print_error('unknowncourserequest');
3109             }
3110         } else {
3111             $this->properties = $properties;
3112         }
3113         $this->properties->collision = null;
3114     }
3116     /**
3117      * Returns the requested property
3118      *
3119      * @param string $key
3120      * @return mixed
3121      */
3122     public function __get($key) {
3123         return $this->properties->$key;
3124     }
3126     /**
3127      * Override this to ensure empty($request->blah) calls return a reliable answer...
3128      *
3129      * This is required because we define the __get method
3130      *
3131      * @param mixed $key
3132      * @return bool True is it not empty, false otherwise
3133      */
3134     public function __isset($key) {
3135         return (!empty($this->properties->$key));
3136     }
3138     /**
3139      * Returns the user who requested this course
3140      *
3141      * Uses a static var to cache the results and cut down the number of db queries
3142      *
3143      * @staticvar array $requesters An array of cached users
3144      * @return stdClass The user who requested the course
3145      */
3146     public function get_requester() {
3147         global $DB;
3148         static $requesters= array();
3149         if (!array_key_exists($this->properties->requester, $requesters)) {
3150             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3151         }
3152         return $requesters[$this->properties->requester];
3153     }
3155     /**
3156      * Checks that the shortname used by the course does not conflict with any other
3157      * courses that exist
3158      *
3159      * @param string|null $shortnamemark The string to append to the requests shortname
3160      *                     should a conflict be found
3161      * @return bool true is there is a conflict, false otherwise
3162      */
3163     public function check_shortname_collision($shortnamemark = '[*]') {
3164         global $DB;
3166         if ($this->properties->collision !== null) {
3167             return $this->properties->collision;
3168         }
3170         if (empty($this->properties->shortname)) {
3171             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3172             $this->properties->collision = false;
3173         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3174             if (!empty($shortnamemark)) {
3175                 $this->properties->shortname .= ' '.$shortnamemark;
3176             }
3177             $this->properties->collision = true;
3178         } else {
3179             $this->properties->collision = false;
3180         }
3181         return $this->properties->collision;
3182     }
3184     /**
3185      * Returns the category where this course request should be created
3186      *
3187      * Note that we don't check here that user has a capability to view
3188      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
3189      * 'moodle/course:changecategory'
3190      *
3191      * @return coursecat
3192      */
3193     public function get_category() {
3194         global $CFG;
3195         require_once($CFG->libdir.'/coursecatlib.php');
3196         // If the category is not set, if the current user does not have the rights to change the category, or if the
3197         // category does not exist, we set the default category to the course to be approved.
3198         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3199         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
3200                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
3201             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
3202         }
3203         if (!$category) {
3204             $category = coursecat::get_default();
3205         }
3206         return $category;
3207     }
3209     /**
3210      * This function approves the request turning it into a course
3211      *
3212      * This function converts the course request into a course, at the same time
3213      * transferring any files used in the summary to the new course and then removing
3214      * the course request and the files associated with it.
3215      *
3216      * @return int The id of the course that was created from this request
3217      */
3218     public function approve() {
3219         global $CFG, $DB, $USER;
3221         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3223         $courseconfig = get_config('moodlecourse');
3225         // Transfer appropriate settings
3226         $data = clone($this->properties);
3227         unset($data->id);
3228         unset($data->reason);
3229         unset($data->requester);
3231         // Set category
3232         $category = $this->get_category();
3233         $data->category = $category->id;
3234         // Set misc settings
3235         $data->requested = 1;
3237         // Apply course default settings
3238         $data->format             = $courseconfig->format;
3239         $data->newsitems          = $courseconfig->newsitems;
3240         $data->showgrades         = $courseconfig->showgrades;
3241         $data->showreports        = $courseconfig->showreports;
3242         $data->maxbytes           = $courseconfig->maxbytes;
3243         $data->groupmode          = $courseconfig->groupmode;
3244         $data->groupmodeforce     = $courseconfig->groupmodeforce;
3245         $data->visible            = $courseconfig->visible;
3246         $data->visibleold         = $data->visible;
3247         $data->lang               = $courseconfig->lang;
3249         $course = create_course($data);
3250         $context = context_course::instance($course->id, MUST_EXIST);
3252         // add enrol instances
3253         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3254             if ($manual = enrol_get_plugin('manual')) {
3255                 $manual->add_default_instance($course);
3256             }
3257         }
3259         // enrol the requester as teacher if necessary
3260         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3261             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3262         }
3264         $this->delete();
3266         $a = new stdClass();
3267         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3268         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3269         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3271         return $course->id;
3272     }
3274     /**
3275      * Reject a course request
3276      *
3277      * This function rejects a course request, emailing the requesting user the
3278      * provided notice and then removing the request from the database
3279      *
3280      * @param string $notice The message to display to the user
3281      */
3282     public function reject($notice) {
3283         global $USER, $DB;
3284         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
3285         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3286         $this->delete();
3287     }
3289     /**
3290      * Deletes the course request and any associated files
3291      */
3292     public function delete() {
3293         global $DB;
3294         $DB->delete_records('course_request', array('id' => $this->properties->id));
3295     }
3297     /**
3298      * Send a message from one user to another using events_trigger
3299      *
3300      * @param object $touser
3301      * @param object $fromuser
3302      * @param string $name
3303      * @param string $subject
3304      * @param string $message
3305      */
3306     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
3307         $eventdata = new stdClass();
3308         $eventdata->component         = 'moodle';
3309         $eventdata->name              = $name;
3310         $eventdata->userfrom          = $fromuser;
3311         $eventdata->userto            = $touser;
3312         $eventdata->subject           = $subject;
3313         $eventdata->fullmessage       = $message;
3314         $eventdata->fullmessageformat = FORMAT_PLAIN;
3315         $eventdata->fullmessagehtml   = '';
3316         $eventdata->smallmessage      = '';
3317         $eventdata->notification      = 1;
3318         message_send($eventdata);
3319     }
3322 /**
3323  * Return a list of page types
3324  * @param string $pagetype current page type
3325  * @param stdClass $parentcontext Block's parent context
3326  * @param stdClass $currentcontext Current context of block
3327  */
3328 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3329     // $currentcontext could be null, get_context_info_array() will throw an error if this is the case.
3330     if (isset($currentcontext)) {
3331         // if above course context ,display all course fomats
3332         list($currentcontext, $course, $cm) = get_context_info_array($currentcontext->id);
3333         if ($course->id == SITEID) {
3334             return array('*'=>get_string('page-x', 'pagetype'));
3335         }
3336     }
3337     return array('*'=>get_string('page-x', 'pagetype'),
3338         'course-*'=>get_string('page-course-x', 'pagetype'),
3339         'course-view-*'=>get_string('page-course-view-x', 'pagetype')
3340     );
3343 /**
3344  * Determine whether course ajax should be enabled for the specified course
3345  *
3346  * @param stdClass $course The course to test against
3347  * @return boolean Whether course ajax is enabled or note
3348  */
3349 function course_ajax_enabled($course) {
3350     global $CFG, $PAGE, $SITE;
3352     // Ajax must be enabled globally
3353     if (!$CFG->enableajax) {
3354         return false;
3355     }
3357     // The user must be editing for AJAX to be included
3358     if (!$PAGE->user_is_editing()) {
3359         return false;
3360     }
3362     // Check that the theme suports
3363     if (!$PAGE->theme->enablecourseajax) {
3364         return false;
3365     }
3367     // Check that the course format supports ajax functionality
3368     // The site 'format' doesn't have information on course format support
3369     if ($SITE->id !== $course->id) {
3370         $courseformatajaxsupport = course_format_ajax_support($course->format);
3371         if (!$courseformatajaxsupport->capable) {
3372             return false;
3373         }
3374     }
3376     // All conditions have been met so course ajax should be enabled
3377     return true;
3380 /**
3381  * Include the relevant javascript and language strings for the resource
3382  * toolbox YUI module
3383  *
3384  * @param integer $id The ID of the course being applied to
3385  * @param array $usedmodules An array containing the names of the modules in use on the page
3386  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3387  * @param stdClass $config An object containing configuration parameters for ajax modules including:
3388  *          * resourceurl   The URL to post changes to for resource changes
3389  *          * sectionurl    The URL to post changes to for section changes
3390  *          * pageparams    Additional parameters to pass through in the post
3391  * @return bool
3392  */
3393 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3394     global $PAGE, $SITE;
3396     // Ensure that ajax should be included
3397     if (!course_ajax_enabled($course)) {
3398         return false;
3399     }
3401     if (!$config) {
3402         $config = new stdClass();
3403     }
3405     // The URL to use for resource changes
3406     if (!isset($config->resourceurl)) {
3407         $config->resourceurl = '/course/rest.php';
3408     }
3410     // The URL to use for section changes
3411     if (!isset($config->sectionurl)) {
3412         $config->sectionurl = '/course/rest.php';
3413     }
3415     // Any additional parameters which need to be included on page submission
3416     if (!isset($config->pageparams)) {
3417         $config->pageparams = array();
3418     }
3420     // Include toolboxes
3421     $PAGE->requires->yui_module('moodle-course-toolboxes',
3422             'M.course.init_resource_toolbox',
3423             array(array(
3424                 'courseid' => $course->id,
3425                 'ajaxurl' => $config->resourceurl,
3426                 'config' => $config,
3427             ))
3428     );
3429     $PAGE->requires->yui_module('moodle-course-toolboxes',
3430             'M.course.init_section_toolbox',
3431             array(array(
3432                 'courseid' => $course->id,
3433                 'format' => $course->format,
3434                 'ajaxurl' => $config->sectionurl,
3435                 'config' => $config,
3436             ))
3437     );
3439     // Include course dragdrop
3440     if ($course->id != $SITE->id) {
3441         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3442             array(array(
3443                 'courseid' => $course->id,
3444                 'ajaxurl' => $config->sectionurl,
3445                 'config' => $config,
3446             )), null, true);
3448         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3449             array(array(
3450                 'courseid' => $course->id,
3451                 'ajaxurl' => $config->resourceurl,
3452                 'config' => $config,
3453             )), null, true);
3454     }
3456     // Require various strings for the command toolbox
3457     $PAGE->requires->strings_for_js(array(
3458             'moveleft',
3459             'deletechecktype',
3460             'deletechecktypename',
3461             'edittitle',
3462             'edittitleinstructions',
3463             'show',
3464             'hide',
3465             'groupsnone',
3466             'groupsvisible',
3467             'groupsseparate',
3468             'clicktochangeinbrackets',
3469             'markthistopic',
3470             'markedthistopic',
3471             'move',
3472             'movesection',
3473         ), 'moodle');
3475     // Include format-specific strings
3476     if ($course->id != $SITE->id) {
3477         $PAGE->requires->strings_for_js(array(
3478                 'showfromothers',
3479                 'hidefromothers',
3480             ), 'format_' . $course->format);
3481     }
3483     // For confirming resource deletion we need the name of the module in question
3484     foreach ($usedmodules as $module => $modname) {
3485         $PAGE->requires->string_for_js('pluginname', $module);
3486     }
3488     // Load drag and drop upload AJAX.
3489     dndupload_add_to_course($course, $enabledmodules);
3491     return true;
3494 /**
3495  * Returns the sorted list of available course formats, filtered by enabled if necessary
3496  *
3497  * @param bool $enabledonly return only formats that are enabled
3498  * @return array array of sorted format names
3499  */
3500 function get_sorted_course_formats($enabledonly = false) {
3501     global $CFG;
3502     $formats = get_plugin_list('format');
3504     if (!empty($CFG->format_plugins_sortorder)) {
3505         $order = explode(',', $CFG->format_plugins_sortorder);
3506         $order = array_merge(array_intersect($order, array_keys($formats)),
3507                     array_diff(array_keys($formats), $order));
3508     } else {
3509         $order = array_keys($formats);
3510     }
3511     if (!$enabledonly) {
3512         return $order;
3513     }
3514     $sortedformats = array();
3515     foreach ($order as $formatname) {
3516         if (!get_config('format_'.$formatname, 'disabled')) {
3517             $sortedformats[] = $formatname;
3518         }
3519     }
3520     return $sortedformats;
3523 /**
3524  * The URL to use for the specified course (with section)
3525  *
3526  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3527  * @param int|stdClass $section Section object from database or just field course_sections.section
3528  *     if omitted the course view page is returned
3529  * @param array $options options for view URL. At the moment core uses:
3530  *     'navigation' (bool) if true and section has no separate page, the function returns null
3531  *     'sr' (int) used by multipage formats to specify to which section to return
3532  * @return moodle_url The url of course
3533  */
3534 function course_get_url($courseorid, $section = null, $options = array()) {
3535     return course_get_format($courseorid)->get_view_url($section, $options);
3538 /**
3539  * Create a module.
3540  *
3541  * It includes:
3542  *      - capability checks and other checks
3543  *      - create the module from the module info
3544  *
3545  * @param object $module
3546  * @return object the created module info
3547  */
3548 function create_module($moduleinfo) {
3549     global $DB, $CFG;
3551     require_once($CFG->dirroot . '/course/modlib.php');
3553     // Check manadatory attributs.
3554     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3555     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3556         $mandatoryfields[] = 'introeditor';
3557     }
3558     foreach($mandatoryfields as $mandatoryfield) {
3559         if (!isset($moduleinfo->{$mandatoryfield})) {
3560             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3561         }
3562     }
3564     // Some additional checks (capability / existing instances).
3565     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3566     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3568     // Load module library.
3569     include_modulelib($module->name);
3571     // Add the module.
3572     $moduleinfo->module = $module->id;
3573     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3575     return $moduleinfo;
3578 /**
3579  * Update a module.
3580  *
3581  * It includes:
3582  *      - capability and other checks
3583  *      - update the module
3584  *
3585  * @param object $module
3586  * @return object the updated module info
3587  */
3588 function update_module($moduleinfo) {
3589     global $DB, $CFG;
3591     require_once($CFG->dirroot . '/course/modlib.php');
3593     // Check the course module exists.
3594     $cm = get_coursemodule_from_id('',