MDL-41114 Avoid unnecessary retrieving of coursecat from DB
[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');         // Not used. TODO MDL-38832 remove
48 define('FRONTPAGECATEGORYNAMES',  '2');
49 define('FRONTPAGETOPICONLY',      '3');         // Not used. TODO MDL-38832 remove
50 define('FRONTPAGECATEGORYCOMBO',  '4');
51 define('FRONTPAGEENROLLEDCOURSELIST', '5');
52 define('FRONTPAGEALLCOURSELIST',  '6');
53 define('FRONTPAGECOURSESEARCH',   '7');
54 define('FRONTPAGECOURSELIMIT',    200);         // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage. TODO MDL-38832 remove
55 define('EXCELROWS', 65535);
56 define('FIRSTUSEDEXCELROW', 3);
58 define('MOD_CLASS_ACTIVITY', 0);
59 define('MOD_CLASS_RESOURCE', 1);
61 function make_log_url($module, $url) {
62     switch ($module) {
63         case 'course':
64             if (strpos($url, 'report/') === 0) {
65                 // there is only one report type, course reports are deprecated
66                 $url = "/$url";
67                 break;
68             }
69         case 'file':
70         case 'login':
71         case 'lib':
72         case 'admin':
73         case 'calendar':
74         case 'category':
75         case 'mnet course':
76             if (strpos($url, '../') === 0) {
77                 $url = ltrim($url, '.');
78             } else {
79                 $url = "/course/$url";
80             }
81             break;
82         case 'user':
83         case 'blog':
84             $url = "/$module/$url";
85             break;
86         case 'upload':
87             $url = $url;
88             break;
89         case 'coursetags':
90             $url = '/'.$url;
91             break;
92         case 'library':
93         case '':
94             $url = '/';
95             break;
96         case 'message':
97             $url = "/message/$url";
98             break;
99         case 'notes':
100             $url = "/notes/$url";
101             break;
102         case 'tag':
103             $url = "/tag/$url";
104             break;
105         case 'role':
106             $url = '/'.$url;
107             break;
108         case 'grade':
109             $url = "/grade/$url";
110             break;
111         default:
112             $url = "/mod/$module/$url";
113             break;
114     }
116     //now let's sanitise urls - there might be some ugly nasties:-(
117     $parts = explode('?', $url);
118     $script = array_shift($parts);
119     if (strpos($script, 'http') === 0) {
120         $script = clean_param($script, PARAM_URL);
121     } else {
122         $script = clean_param($script, PARAM_PATH);
123     }
125     $query = '';
126     if ($parts) {
127         $query = implode('', $parts);
128         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
129         $parts = explode('&', $query);
130         $eq = urlencode('=');
131         foreach ($parts as $key=>$part) {
132             $part = urlencode(urldecode($part));
133             $part = str_replace($eq, '=', $part);
134             $parts[$key] = $part;
135         }
136         $query = '?'.implode('&amp;', $parts);
137     }
139     return $script.$query;
143 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
144                    $modname="", $modid=0, $modaction="", $groupid=0) {
145     global $CFG, $DB;
147     // It is assumed that $date is the GMT time of midnight for that day,
148     // and so the next 86400 seconds worth of logs are printed.
150     /// Setup for group handling.
152     // TODO: I don't understand group/context/etc. enough to be able to do
153     // something interesting with it here
154     // What is the context of a remote course?
156     /// If the group mode is separate, and this user does not have editing privileges,
157     /// then only the user's group can be viewed.
158     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
159     //    $groupid = get_current_group($course->id);
160     //}
161     /// If this course doesn't have groups, no groupid can be specified.
162     //else if (!$course->groupmode) {
163     //    $groupid = 0;
164     //}
166     $groupid = 0;
168     $joins = array();
169     $where = '';
171     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
172               FROM {mnet_log} l
173                LEFT JOIN {user} u ON l.userid = u.id
174               WHERE ";
175     $params = array();
177     $where .= "l.hostid = :hostid";
178     $params['hostid'] = $hostid;
180     // TODO: Is 1 really a magic number referring to the sitename?
181     if ($course != SITEID || $modid != 0) {
182         $where .= " AND l.course=:courseid";
183         $params['courseid'] = $course;
184     }
186     if ($modname) {
187         $where .= " AND l.module = :modname";
188         $params['modname'] = $modname;
189     }
191     if ('site_errors' === $modid) {
192         $where .= " AND ( l.action='error' OR l.action='infected' )";
193     } else if ($modid) {
194         //TODO: This assumes that modids are the same across sites... probably
195         //not true
196         $where .= " AND l.cmid = :modid";
197         $params['modid'] = $modid;
198     }
200     if ($modaction) {
201         $firstletter = substr($modaction, 0, 1);
202         if ($firstletter == '-') {
203             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
204             $params['modaction'] = '%'.substr($modaction, 1).'%';
205         } else {
206             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
207             $params['modaction'] = '%'.$modaction.'%';
208         }
209     }
211     if ($user) {
212         $where .= " AND l.userid = :user";
213         $params['user'] = $user;
214     }
216     if ($date) {
217         $enddate = $date + 86400;
218         $where .= " AND l.time > :date AND l.time < :enddate";
219         $params['date'] = $date;
220         $params['enddate'] = $enddate;
221     }
223     $result = array();
224     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
225     if(!empty($result['totalcount'])) {
226         $where .= " ORDER BY $order";
227         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
228     } else {
229         $result['logs'] = array();
230     }
231     return $result;
234 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
235                    $modname="", $modid=0, $modaction="", $groupid=0) {
236     global $DB, $SESSION, $USER;
237     // It is assumed that $date is the GMT time of midnight for that day,
238     // and so the next 86400 seconds worth of logs are printed.
240     /// Setup for group handling.
242     /// If the group mode is separate, and this user does not have editing privileges,
243     /// then only the user's group can be viewed.
244     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
245         if (isset($SESSION->currentgroup[$course->id])) {
246             $groupid =  $SESSION->currentgroup[$course->id];
247         } else {
248             $groupid = groups_get_all_groups($course->id, $USER->id);
249             if (is_array($groupid)) {
250                 $groupid = array_shift(array_keys($groupid));
251                 $SESSION->currentgroup[$course->id] = $groupid;
252             } else {
253                 $groupid = 0;
254             }
255         }
256     }
257     /// If this course doesn't have groups, no groupid can be specified.
258     else if (!$course->groupmode) {
259         $groupid = 0;
260     }
262     $joins = array();
263     $params = array();
265     if ($course->id != SITEID || $modid != 0) {
266         $joins[] = "l.course = :courseid";
267         $params['courseid'] = $course->id;
268     }
270     if ($modname) {
271         $joins[] = "l.module = :modname";
272         $params['modname'] = $modname;
273     }
275     if ('site_errors' === $modid) {
276         $joins[] = "( l.action='error' OR l.action='infected' )";
277     } else if ($modid) {
278         $joins[] = "l.cmid = :modid";
279         $params['modid'] = $modid;
280     }
282     if ($modaction) {
283         $firstletter = substr($modaction, 0, 1);
284         if ($firstletter == '-') {
285             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
286             $params['modaction'] = '%'.substr($modaction, 1).'%';
287         } else {
288             $joins[] = $DB->sql_like('l.action', ':modaction', false);
289             $params['modaction'] = '%'.$modaction.'%';
290         }
291     }
294     /// Getting all members of a group.
295     if ($groupid and !$user) {
296         if ($gusers = groups_get_members($groupid)) {
297             $gusers = array_keys($gusers);
298             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
299         } else {
300             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
301         }
302     }
303     else if ($user) {
304         $joins[] = "l.userid = :userid";
305         $params['userid'] = $user;
306     }
308     if ($date) {
309         $enddate = $date + 86400;
310         $joins[] = "l.time > :date AND l.time < :enddate";
311         $params['date'] = $date;
312         $params['enddate'] = $enddate;
313     }
315     $selector = implode(' AND ', $joins);
317     $totalcount = 0;  // Initialise
318     $result = array();
319     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
320     $result['totalcount'] = $totalcount;
321     return $result;
325 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
326                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
328     global $CFG, $DB, $OUTPUT;
330     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
331                        $modname, $modid, $modaction, $groupid)) {
332         echo $OUTPUT->notification("No logs found!");
333         echo $OUTPUT->footer();
334         exit;
335     }
337     $courses = array();
339     if ($course->id == SITEID) {
340         $courses[0] = '';
341         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
342             foreach ($ccc as $cc) {
343                 $courses[$cc->id] = $cc->shortname;
344             }
345         }
346     } else {
347         $courses[$course->id] = $course->shortname;
348     }
350     $totalcount = $logs['totalcount'];
351     $count=0;
352     $ldcache = array();
353     $tt = getdate(time());
354     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
356     $strftimedatetime = get_string("strftimedatetime");
358     echo "<div class=\"info\">\n";
359     print_string("displayingrecords", "", $totalcount);
360     echo "</div>\n";
362     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
364     $table = new html_table();
365     $table->classes = array('logtable','generaltable');
366     $table->align = array('right', 'left', 'left');
367     $table->head = array(
368         get_string('time'),
369         get_string('ip_address'),
370         get_string('fullnameuser'),
371         get_string('action'),
372         get_string('info')
373     );
374     $table->data = array();
376     if ($course->id == SITEID) {
377         array_unshift($table->align, 'left');
378         array_unshift($table->head, get_string('course'));
379     }
381     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
382     if (empty($logs['logs'])) {
383         $logs['logs'] = array();
384     }
386     foreach ($logs['logs'] as $log) {
388         if (isset($ldcache[$log->module][$log->action])) {
389             $ld = $ldcache[$log->module][$log->action];
390         } else {
391             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
392             $ldcache[$log->module][$log->action] = $ld;
393         }
394         if ($ld && is_numeric($log->info)) {
395             // ugly hack to make sure fullname is shown correctly
396             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
397                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
398             } else {
399                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
400             }
401         }
403         //Filter log->info
404         $log->info = format_string($log->info);
406         // If $log->url has been trimmed short by the db size restriction
407         // code in add_to_log, keep a note so we don't add a link to a broken url
408         $brokenurl=(core_text::strlen($log->url)==100 && core_text::substr($log->url,97)=='...');
410         $row = array();
411         if ($course->id == SITEID) {
412             if (empty($log->course)) {
413                 $row[] = get_string('site');
414             } else {
415                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
416             }
417         }
419         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
421         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
422         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
424         $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))));
426         $displayaction="$log->module $log->action";
427         if ($brokenurl) {
428             $row[] = $displayaction;
429         } else {
430             $link = make_log_url($log->module,$log->url);
431             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
432         }
433         $row[] = $log->info;
434         $table->data[] = $row;
435     }
437     echo html_writer::table($table);
438     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
442 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
443                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
445     global $CFG, $DB, $OUTPUT;
447     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
448                        $modname, $modid, $modaction, $groupid)) {
449         echo $OUTPUT->notification("No logs found!");
450         echo $OUTPUT->footer();
451         exit;
452     }
454     if ($course->id == SITEID) {
455         $courses[0] = '';
456         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
457             foreach ($ccc as $cc) {
458                 $courses[$cc->id] = $cc->shortname;
459             }
460         }
461     }
463     $totalcount = $logs['totalcount'];
464     $count=0;
465     $ldcache = array();
466     $tt = getdate(time());
467     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
469     $strftimedatetime = get_string("strftimedatetime");
471     echo "<div class=\"info\">\n";
472     print_string("displayingrecords", "", $totalcount);
473     echo "</div>\n";
475     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
477     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
478     echo "<tr>";
479     if ($course->id == SITEID) {
480         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
481     }
482     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
483     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
484     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
485     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
486     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
487     echo "</tr>\n";
489     if (empty($logs['logs'])) {
490         echo "</table>\n";
491         return;
492     }
494     $row = 1;
495     foreach ($logs['logs'] as $log) {
497         $log->info = $log->coursename;
498         $row = ($row + 1) % 2;
500         if (isset($ldcache[$log->module][$log->action])) {
501             $ld = $ldcache[$log->module][$log->action];
502         } else {
503             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
504             $ldcache[$log->module][$log->action] = $ld;
505         }
506         if (0 && $ld && !empty($log->info)) {
507             // ugly hack to make sure fullname is shown correctly
508             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
509                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
510             } else {
511                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
512             }
513         }
515         //Filter log->info
516         $log->info = format_string($log->info);
518         echo '<tr class="r'.$row.'">';
519         if ($course->id == SITEID) {
520             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
521             echo "<td class=\"r$row c0\" >\n";
522             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
523             echo "</td>\n";
524         }
525         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
526              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
527         echo "<td class=\"r$row c2\" >\n";
528         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
529         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
530         echo "</td>\n";
531         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
532         echo "<td class=\"r$row c3\" >\n";
533         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
534         echo "</td>\n";
535         echo "<td class=\"r$row c4\">\n";
536         echo $log->action .': '.$log->module;
537         echo "</td>\n";
538         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
539         echo "</tr>\n";
540     }
541     echo "</table>\n";
543     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
547 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
548                         $modid, $modaction, $groupid) {
549     global $DB, $CFG;
551     require_once($CFG->libdir . '/csvlib.class.php');
553     $csvexporter = new csv_export_writer('tab');
555     $header = array();
556     $header[] = get_string('course');
557     $header[] = get_string('time');
558     $header[] = get_string('ip_address');
559     $header[] = get_string('fullnameuser');
560     $header[] = get_string('action');
561     $header[] = get_string('info');
563     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
564                        $modname, $modid, $modaction, $groupid)) {
565         return false;
566     }
568     $courses = array();
570     if ($course->id == SITEID) {
571         $courses[0] = '';
572         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
573             foreach ($ccc as $cc) {
574                 $courses[$cc->id] = $cc->shortname;
575             }
576         }
577     } else {
578         $courses[$course->id] = $course->shortname;
579     }
581     $count=0;
582     $ldcache = array();
583     $tt = getdate(time());
584     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
586     $strftimedatetime = get_string("strftimedatetime");
588     $csvexporter->set_filename('logs', '.txt');
589     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
590     $csvexporter->add_data($title);
591     $csvexporter->add_data($header);
593     if (empty($logs['logs'])) {
594         return true;
595     }
597     foreach ($logs['logs'] as $log) {
598         if (isset($ldcache[$log->module][$log->action])) {
599             $ld = $ldcache[$log->module][$log->action];
600         } else {
601             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
602             $ldcache[$log->module][$log->action] = $ld;
603         }
604         if ($ld && is_numeric($log->info)) {
605             // ugly hack to make sure fullname is shown correctly
606             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
607                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
608             } else {
609                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
610             }
611         }
613         //Filter log->info
614         $log->info = format_string($log->info);
615         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
617         $coursecontext = context_course::instance($course->id);
618         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
619         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
620         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
621         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
622         $csvexporter->add_data($row);
623     }
624     $csvexporter->download_file();
625     return true;
629 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
630                         $modid, $modaction, $groupid) {
632     global $CFG, $DB;
634     require_once("$CFG->libdir/excellib.class.php");
636     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
637                        $modname, $modid, $modaction, $groupid)) {
638         return false;
639     }
641     $courses = array();
643     if ($course->id == SITEID) {
644         $courses[0] = '';
645         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
646             foreach ($ccc as $cc) {
647                 $courses[$cc->id] = $cc->shortname;
648             }
649         }
650     } else {
651         $courses[$course->id] = $course->shortname;
652     }
654     $count=0;
655     $ldcache = array();
656     $tt = getdate(time());
657     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
659     $strftimedatetime = get_string("strftimedatetime");
661     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
662     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
663     $filename .= '.xls';
665     $workbook = new MoodleExcelWorkbook('-');
666     $workbook->send($filename);
668     $worksheet = array();
669     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
670                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
672     // Creating worksheets
673     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
674         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
675         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
676         $worksheet[$wsnumber]->set_column(1, 1, 30);
677         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
678                                     userdate(time(), $strftimedatetime));
679         $col = 0;
680         foreach ($headers as $item) {
681             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
682             $col++;
683         }
684     }
686     if (empty($logs['logs'])) {
687         $workbook->close();
688         return true;
689     }
691     $formatDate =& $workbook->add_format();
692     $formatDate->set_num_format(get_string('log_excel_date_format'));
694     $row = FIRSTUSEDEXCELROW;
695     $wsnumber = 1;
696     $myxls =& $worksheet[$wsnumber];
697     foreach ($logs['logs'] as $log) {
698         if (isset($ldcache[$log->module][$log->action])) {
699             $ld = $ldcache[$log->module][$log->action];
700         } else {
701             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
702             $ldcache[$log->module][$log->action] = $ld;
703         }
704         if ($ld && is_numeric($log->info)) {
705             // ugly hack to make sure fullname is shown correctly
706             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
707                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
708             } else {
709                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
710             }
711         }
713         // Filter log->info
714         $log->info = format_string($log->info);
715         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
717         if ($nroPages>1) {
718             if ($row > EXCELROWS) {
719                 $wsnumber++;
720                 $myxls =& $worksheet[$wsnumber];
721                 $row = FIRSTUSEDEXCELROW;
722             }
723         }
725         $coursecontext = context_course::instance($course->id);
727         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
728         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
729         $myxls->write($row, 2, $log->ip, '');
730         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
731         $myxls->write($row, 3, $fullname, '');
732         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
733         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
734         $myxls->write($row, 5, $log->info, '');
736         $row++;
737     }
739     $workbook->close();
740     return true;
743 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
744                         $modid, $modaction, $groupid) {
746     global $CFG, $DB;
748     require_once("$CFG->libdir/odslib.class.php");
750     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
751                        $modname, $modid, $modaction, $groupid)) {
752         return false;
753     }
755     $courses = array();
757     if ($course->id == SITEID) {
758         $courses[0] = '';
759         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
760             foreach ($ccc as $cc) {
761                 $courses[$cc->id] = $cc->shortname;
762             }
763         }
764     } else {
765         $courses[$course->id] = $course->shortname;
766     }
768     $count=0;
769     $ldcache = array();
770     $tt = getdate(time());
771     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
773     $strftimedatetime = get_string("strftimedatetime");
775     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
776     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
777     $filename .= '.ods';
779     $workbook = new MoodleODSWorkbook('-');
780     $workbook->send($filename);
782     $worksheet = array();
783     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
784                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
786     // Creating worksheets
787     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
788         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
789         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
790         $worksheet[$wsnumber]->set_column(1, 1, 30);
791         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
792                                     userdate(time(), $strftimedatetime));
793         $col = 0;
794         foreach ($headers as $item) {
795             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
796             $col++;
797         }
798     }
800     if (empty($logs['logs'])) {
801         $workbook->close();
802         return true;
803     }
805     $formatDate =& $workbook->add_format();
806     $formatDate->set_num_format(get_string('log_excel_date_format'));
808     $row = FIRSTUSEDEXCELROW;
809     $wsnumber = 1;
810     $myxls =& $worksheet[$wsnumber];
811     foreach ($logs['logs'] as $log) {
812         if (isset($ldcache[$log->module][$log->action])) {
813             $ld = $ldcache[$log->module][$log->action];
814         } else {
815             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
816             $ldcache[$log->module][$log->action] = $ld;
817         }
818         if ($ld && is_numeric($log->info)) {
819             // ugly hack to make sure fullname is shown correctly
820             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
821                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
822             } else {
823                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
824             }
825         }
827         // Filter log->info
828         $log->info = format_string($log->info);
829         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
831         if ($nroPages>1) {
832             if ($row > EXCELROWS) {
833                 $wsnumber++;
834                 $myxls =& $worksheet[$wsnumber];
835                 $row = FIRSTUSEDEXCELROW;
836             }
837         }
839         $coursecontext = context_course::instance($course->id);
841         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
842         $myxls->write_date($row, 1, $log->time);
843         $myxls->write_string($row, 2, $log->ip);
844         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
845         $myxls->write_string($row, 3, $fullname);
846         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
847         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
848         $myxls->write_string($row, 5, $log->info);
850         $row++;
851     }
853     $workbook->close();
854     return true;
857 /**
858  * For a given course, returns an array of course activity objects
859  * Each item in the array contains he following properties:
860  */
861 function get_array_of_activities($courseid) {
862 //  cm - course module id
863 //  mod - name of the module (eg forum)
864 //  section - the number of the section (eg week or topic)
865 //  name - the name of the instance
866 //  visible - is the instance visible or not
867 //  groupingid - grouping id
868 //  groupmembersonly - is this instance visible to group members only
869 //  extra - contains extra string to include in any link
870     global $CFG, $DB;
871     if(!empty($CFG->enableavailability)) {
872         require_once($CFG->libdir.'/conditionlib.php');
873     }
875     $course = $DB->get_record('course', array('id'=>$courseid));
877     if (empty($course)) {
878         throw new moodle_exception('courseidnotfound');
879     }
881     $mod = array();
883     $rawmods = get_course_mods($courseid);
884     if (empty($rawmods)) {
885         return $mod; // always return array
886     }
888     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
889        foreach ($sections as $section) {
890            if (!empty($section->sequence)) {
891                $sequence = explode(",", $section->sequence);
892                foreach ($sequence as $seq) {
893                    if (empty($rawmods[$seq])) {
894                        continue;
895                    }
896                    $mod[$seq] = new stdClass();
897                    $mod[$seq]->id               = $rawmods[$seq]->instance;
898                    $mod[$seq]->cm               = $rawmods[$seq]->id;
899                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
901                     // Oh dear. Inconsistent names left here for backward compatibility.
902                    $mod[$seq]->section          = $section->section;
903                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
905                    $mod[$seq]->module           = $rawmods[$seq]->module;
906                    $mod[$seq]->added            = $rawmods[$seq]->added;
907                    $mod[$seq]->score            = $rawmods[$seq]->score;
908                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
909                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
910                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
911                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
912                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
913                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
914                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
915                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
916                    $mod[$seq]->extra            = "";
917                    $mod[$seq]->completiongradeitemnumber =
918                            $rawmods[$seq]->completiongradeitemnumber;
919                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
920                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
921                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
922                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
923                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
924                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
925                    if (!empty($CFG->enableavailability)) {
926                        condition_info::fill_availability_conditions($rawmods[$seq]);
927                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
928                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
929                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
930                    }
932                    $modname = $mod[$seq]->mod;
933                    $functionname = $modname."_get_coursemodule_info";
935                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
936                        continue;
937                    }
939                    include_once("$CFG->dirroot/mod/$modname/lib.php");
941                    if ($hasfunction = function_exists($functionname)) {
942                        if ($info = $functionname($rawmods[$seq])) {
943                            if (!empty($info->icon)) {
944                                $mod[$seq]->icon = $info->icon;
945                            }
946                            if (!empty($info->iconcomponent)) {
947                                $mod[$seq]->iconcomponent = $info->iconcomponent;
948                            }
949                            if (!empty($info->name)) {
950                                $mod[$seq]->name = $info->name;
951                            }
952                            if ($info instanceof cached_cm_info) {
953                                // When using cached_cm_info you can include three new fields
954                                // that aren't available for legacy code
955                                if (!empty($info->content)) {
956                                    $mod[$seq]->content = $info->content;
957                                }
958                                if (!empty($info->extraclasses)) {
959                                    $mod[$seq]->extraclasses = $info->extraclasses;
960                                }
961                                if (!empty($info->iconurl)) {
962                                    $mod[$seq]->iconurl = $info->iconurl;
963                                }
964                                if (!empty($info->onclick)) {
965                                    $mod[$seq]->onclick = $info->onclick;
966                                }
967                                if (!empty($info->customdata)) {
968                                    $mod[$seq]->customdata = $info->customdata;
969                                }
970                            } else {
971                                // When using a stdclass, the (horrible) deprecated ->extra field
972                                // is available for BC
973                                if (!empty($info->extra)) {
974                                    $mod[$seq]->extra = $info->extra;
975                                }
976                            }
977                        }
978                    }
979                    // When there is no modname_get_coursemodule_info function,
980                    // but showdescriptions is enabled, then we use the 'intro'
981                    // and 'introformat' fields in the module table
982                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
983                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
984                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
985                            // Set content from intro and introformat. Filters are disabled
986                            // because we  filter it with format_text at display time
987                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
988                                    $modvalues, $rawmods[$seq]->id, false);
990                            // To save making another query just below, put name in here
991                            $mod[$seq]->name = $modvalues->name;
992                        }
993                    }
994                    if (!isset($mod[$seq]->name)) {
995                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
996                    }
998                    // Minimise the database size by unsetting default options when they are
999                    // 'empty'. This list corresponds to code in the cm_info constructor.
1000                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1001                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1002                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1003                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1004                            'completionview', 'completionexpected', 'score', 'showdescription')
1005                            as $property) {
1006                        if (property_exists($mod[$seq], $property) &&
1007                                empty($mod[$seq]->{$property})) {
1008                            unset($mod[$seq]->{$property});
1009                        }
1010                    }
1011                    // Special case: this value is usually set to null, but may be 0
1012                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1013                            is_null($mod[$seq]->completiongradeitemnumber)) {
1014                        unset($mod[$seq]->completiongradeitemnumber);
1015                    }
1016                }
1017             }
1018         }
1019     }
1020     return $mod;
1023 /**
1024  * Returns the localised human-readable names of all used modules
1025  *
1026  * @param bool $plural if true returns the plural forms of the names
1027  * @return array where key is the module name (component name without 'mod_') and
1028  *     the value is the human-readable string. Array sorted alphabetically by value
1029  */
1030 function get_module_types_names($plural = false) {
1031     static $modnames = null;
1032     global $DB, $CFG;
1033     if ($modnames === null) {
1034         $modnames = array(0 => array(), 1 => array());
1035         if ($allmods = $DB->get_records("modules")) {
1036             foreach ($allmods as $mod) {
1037                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1038                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1039                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1040                 }
1041             }
1042             core_collator::asort($modnames[0]);
1043             core_collator::asort($modnames[1]);
1044         }
1045     }
1046     return $modnames[(int)$plural];
1049 /**
1050  * Set highlighted section. Only one section can be highlighted at the time.
1051  *
1052  * @param int $courseid course id
1053  * @param int $marker highlight section with this number, 0 means remove higlightin
1054  * @return void
1055  */
1056 function course_set_marker($courseid, $marker) {
1057     global $DB;
1058     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1059     format_base::reset_course_cache($courseid);
1062 /**
1063  * For a given course section, marks it visible or hidden,
1064  * and does the same for every activity in that section
1065  *
1066  * @param int $courseid course id
1067  * @param int $sectionnumber The section number to adjust
1068  * @param int $visibility The new visibility
1069  * @return array A list of resources which were hidden in the section
1070  */
1071 function set_section_visible($courseid, $sectionnumber, $visibility) {
1072     global $DB;
1074     $resourcestotoggle = array();
1075     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1076         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1077         if (!empty($section->sequence)) {
1078             $modules = explode(",", $section->sequence);
1079             foreach ($modules as $moduleid) {
1080                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1081                     if ($visibility) {
1082                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1083                         set_coursemodule_visible($moduleid, $cm->visibleold);
1084                     } else {
1085                         // We hide the section, so we hide the module but we store the original state in visibleold.
1086                         set_coursemodule_visible($moduleid, 0);
1087                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1088                     }
1089                 }
1090             }
1091         }
1092         rebuild_course_cache($courseid, true);
1094         // Determine which modules are visible for AJAX update
1095         if (!empty($modules)) {
1096             list($insql, $params) = $DB->get_in_or_equal($modules);
1097             $select = 'id ' . $insql . ' AND visible = ?';
1098             array_push($params, $visibility);
1099             if (!$visibility) {
1100                 $select .= ' AND visibleold = 1';
1101             }
1102             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1103         }
1104     }
1105     return $resourcestotoggle;
1108 /**
1109  * Retrieve all metadata for the requested modules
1110  *
1111  * @param object $course The Course
1112  * @param array $modnames An array containing the list of modules and their
1113  * names
1114  * @param int $sectionreturn The section to return to
1115  * @return array A list of stdClass objects containing metadata about each
1116  * module
1117  */
1118 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1119     global $CFG, $OUTPUT;
1121     // get_module_metadata will be called once per section on the page and courses may show
1122     // different modules to one another
1123     static $modlist = array();
1124     if (!isset($modlist[$course->id])) {
1125         $modlist[$course->id] = array();
1126     }
1128     $return = array();
1129     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1130     if ($sectionreturn !== null) {
1131         $urlbase->param('sr', $sectionreturn);
1132     }
1133     foreach($modnames as $modname => $modnamestr) {
1134         if (!course_allowed_module($course, $modname)) {
1135             continue;
1136         }
1137         if (isset($modlist[$course->id][$modname])) {
1138             // This module is already cached
1139             $return[$modname] = $modlist[$course->id][$modname];
1140             continue;
1141         }
1143         // Include the module lib
1144         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1145         if (!file_exists($libfile)) {
1146             continue;
1147         }
1148         include_once($libfile);
1150         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1151         $gettypesfunc =  $modname.'_get_types';
1152         if (function_exists($gettypesfunc)) {
1153             $types = $gettypesfunc();
1154             if (is_array($types) && count($types) > 0) {
1155                 $group = new stdClass();
1156                 $group->name = $modname;
1157                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1158                 foreach($types as $type) {
1159                     if ($type->typestr === '--') {
1160                         continue;
1161                     }
1162                     if (strpos($type->typestr, '--') === 0) {
1163                         $group->title = str_replace('--', '', $type->typestr);
1164                         continue;
1165                     }
1166                     // Set the Sub Type metadata
1167                     $subtype = new stdClass();
1168                     $subtype->title = $type->typestr;
1169                     $subtype->type = str_replace('&amp;', '&', $type->type);
1170                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1171                     $subtype->archetype = $type->modclass;
1173                     // The group archetype should match the subtype archetypes and all subtypes
1174                     // should have the same archetype
1175                     $group->archetype = $subtype->archetype;
1177                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1178                         $subtype->help = get_string('help' . $subtype->name, $modname);
1179                     }
1180                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1181                     $group->types[] = $subtype;
1182                 }
1183                 $modlist[$course->id][$modname] = $group;
1184             }
1185         } else {
1186             $module = new stdClass();
1187             $module->title = $modnamestr;
1188             $module->name = $modname;
1189             $module->link = new moodle_url($urlbase, array('add' => $modname));
1190             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1191             $sm = get_string_manager();
1192             if ($sm->string_exists('modulename_help', $modname)) {
1193                 $module->help = get_string('modulename_help', $modname);
1194                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1195                     $link = get_string('modulename_link', $modname);
1196                     $linktext = get_string('morehelp');
1197                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1198                 }
1199             }
1200             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1201             $modlist[$course->id][$modname] = $module;
1202         }
1203         if (isset($modlist[$course->id][$modname])) {
1204             $return[$modname] = $modlist[$course->id][$modname];
1205         } else {
1206             debugging("Invalid module metadata configuration for {$modname}");
1207         }
1208     }
1210     return $return;
1213 /**
1214  * Return the course category context for the category with id $categoryid, except
1215  * that if $categoryid is 0, return the system context.
1216  *
1217  * @param integer $categoryid a category id or 0.
1218  * @return object the corresponding context
1219  */
1220 function get_category_or_system_context($categoryid) {
1221     if ($categoryid) {
1222         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1223     } else {
1224         return context_system::instance();
1225     }
1228 /**
1229  * Returns full course categories trees to be used in html_writer::select()
1230  *
1231  * Calls {@link coursecat::make_categories_list()} to build the tree and
1232  * adds whitespace to denote nesting
1233  *
1234  * @return array array mapping coursecat id to the display name
1235  */
1236 function make_categories_options() {
1237     global $CFG;
1238     require_once($CFG->libdir. '/coursecatlib.php');
1239     $cats = coursecat::make_categories_list('', 0, ' / ');
1240     foreach ($cats as $key => $value) {
1241         // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1242         $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
1243     }
1244     return $cats;
1247 /**
1248  * Print the buttons relating to course requests.
1249  *
1250  * @param object $context current page context.
1251  */
1252 function print_course_request_buttons($context) {
1253     global $CFG, $DB, $OUTPUT;
1254     if (empty($CFG->enablecourserequests)) {
1255         return;
1256     }
1257     if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
1258     /// Print a button to request a new course
1259         echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
1260     }
1261     /// Print a button to manage pending requests
1262     if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
1263         $disabled = !$DB->record_exists('course_request', array());
1264         echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
1265     }
1268 /**
1269  * Does the user have permission to edit things in this category?
1270  *
1271  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1272  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1273  */
1274 function can_edit_in_category($categoryid = 0) {
1275     $context = get_category_or_system_context($categoryid);
1276     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1279 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1281 function add_course_module($mod) {
1282     global $DB;
1284     $mod->added = time();
1285     unset($mod->id);
1287     $cmid = $DB->insert_record("course_modules", $mod);
1288     rebuild_course_cache($mod->course, true);
1289     return $cmid;
1292 /**
1293  * Creates missing course section(s) and rebuilds course cache
1294  *
1295  * @param int|stdClass $courseorid course id or course object
1296  * @param int|array $sections list of relative section numbers to create
1297  * @return bool if there were any sections created
1298  */
1299 function course_create_sections_if_missing($courseorid, $sections) {
1300     global $DB;
1301     if (!is_array($sections)) {
1302         $sections = array($sections);
1303     }
1304     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1305     if (is_object($courseorid)) {
1306         $courseorid = $courseorid->id;
1307     }
1308     $coursechanged = false;
1309     foreach ($sections as $sectionnum) {
1310         if (!in_array($sectionnum, $existing)) {
1311             $cw = new stdClass();
1312             $cw->course   = $courseorid;
1313             $cw->section  = $sectionnum;
1314             $cw->summary  = '';
1315             $cw->summaryformat = FORMAT_HTML;
1316             $cw->sequence = '';
1317             $id = $DB->insert_record("course_sections", $cw);
1318             $coursechanged = true;
1319         }
1320     }
1321     if ($coursechanged) {
1322         rebuild_course_cache($courseorid, true);
1323     }
1324     return $coursechanged;
1327 /**
1328  * Adds an existing module to the section
1329  *
1330  * Updates both tables {course_sections} and {course_modules}
1331  *
1332  * @param int|stdClass $courseorid course id or course object
1333  * @param int $cmid id of the module already existing in course_modules table
1334  * @param int $sectionnum relative number of the section (field course_sections.section)
1335  *     If section does not exist it will be created
1336  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1337  *     before which the module needs to be included. Null for inserting in the
1338  *     end of the section
1339  * @return int The course_sections ID where the module is inserted
1340  */
1341 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1342     global $DB, $COURSE;
1343     if (is_object($beforemod)) {
1344         $beforemod = $beforemod->id;
1345     }
1346     if (is_object($courseorid)) {
1347         $courseid = $courseorid->id;
1348     } else {
1349         $courseid = $courseorid;
1350     }
1351     course_create_sections_if_missing($courseorid, $sectionnum);
1352     // Do not try to use modinfo here, there is no guarantee it is valid!
1353     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
1354     $modarray = explode(",", trim($section->sequence));
1355     if (empty($section->sequence)) {
1356         $newsequence = "$cmid";
1357     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1358         $insertarray = array($cmid, $beforemod);
1359         array_splice($modarray, $key[0], 1, $insertarray);
1360         $newsequence = implode(",", $modarray);
1361     } else {
1362         $newsequence = "$section->sequence,$cmid";
1363     }
1364     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
1365     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
1366     if (is_object($courseorid)) {
1367         rebuild_course_cache($courseorid->id, true);
1368     } else {
1369         rebuild_course_cache($courseorid, true);
1370     }
1371     return $section->id;     // Return course_sections ID that was used.
1374 function set_coursemodule_groupmode($id, $groupmode) {
1375     global $DB;
1376     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1377     if ($cm->groupmode != $groupmode) {
1378         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1379         rebuild_course_cache($cm->course, true);
1380     }
1381     return ($cm->groupmode != $groupmode);
1384 function set_coursemodule_idnumber($id, $idnumber) {
1385     global $DB;
1386     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1387     if ($cm->idnumber != $idnumber) {
1388         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1389         rebuild_course_cache($cm->course, true);
1390     }
1391     return ($cm->idnumber != $idnumber);
1394 /**
1395  * Set the visibility of a module and inherent properties.
1396  *
1397  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1398  * has been moved to {@link set_section_visible()} which was the only place from which
1399  * the parameter was used.
1400  *
1401  * @param int $id of the module
1402  * @param int $visible state of the module
1403  * @return bool false when the module was not found, true otherwise
1404  */
1405 function set_coursemodule_visible($id, $visible) {
1406     global $DB, $CFG;
1407     require_once($CFG->libdir.'/gradelib.php');
1408     require_once($CFG->dirroot.'/calendar/lib.php');
1410     // Trigger developer's attention when using the previously removed argument.
1411     if (func_num_args() > 2) {
1412         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1413             has been removed.', DEBUG_DEVELOPER);
1414     }
1416     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1417         return false;
1418     }
1420     // Create events and propagate visibility to associated grade items if the value has changed.
1421     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1422     if ($cm->visible == $visible) {
1423         return true;
1424     }
1426     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
1427         return false;
1428     }
1429     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
1430         foreach($events as $event) {
1431             if ($visible) {
1432                 $event = new calendar_event($event);
1433                 $event->toggle_visibility(true);
1434             } else {
1435                 $event = new calendar_event($event);
1436                 $event->toggle_visibility(false);
1437             }
1438         }
1439     }
1441     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1442     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1443     if ($grade_items) {
1444         foreach ($grade_items as $grade_item) {
1445             $grade_item->set_hidden(!$visible);
1446         }
1447     }
1449     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1450     // affect visibleold to allow for an original visibility restore. See set_section_visible().
1451     $cminfo = new stdClass();
1452     $cminfo->id = $id;
1453     $cminfo->visible = $visible;
1454     $cminfo->visibleold = $visible;
1455     $DB->update_record('course_modules', $cminfo);
1457     rebuild_course_cache($cm->course, true);
1458     return true;
1461 /**
1462  * This function will handles the whole deletion process of a module. This includes calling
1463  * the modules delete_instance function, deleting files, events, grades, conditional data,
1464  * the data in the course_module and course_sections table and adding a module deletion
1465  * event to the DB.
1466  *
1467  * @param int $cmid the course module id
1468  * @since 2.5
1469  */
1470 function course_delete_module($cmid) {
1471     global $CFG, $DB, $USER;
1473     require_once($CFG->libdir.'/gradelib.php');
1474     require_once($CFG->dirroot.'/blog/lib.php');
1475     require_once($CFG->dirroot.'/calendar/lib.php');
1477     // Get the course module.
1478     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1479         return true;
1480     }
1482     // Get the module context.
1483     $modcontext = context_module::instance($cm->id);
1485     // Get the course module name.
1486     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1488     // Get the file location of the delete_instance function for this module.
1489     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1491     // Include the file required to call the delete_instance function for this module.
1492     if (file_exists($modlib)) {
1493         require_once($modlib);
1494     } else {
1495         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1496             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1497     }
1499     $deleteinstancefunction = $modulename . '_delete_instance';
1501     // Ensure the delete_instance function exists for this module.
1502     if (!function_exists($deleteinstancefunction)) {
1503         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1504             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1505     }
1507     // Call the delete_instance function, if it returns false throw an exception.
1508     if (!$deleteinstancefunction($cm->instance)) {
1509         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1510             "Cannot delete the module $modulename (instance).");
1511     }
1513     // Remove all module files in case modules forget to do that.
1514     $fs = get_file_storage();
1515     $fs->delete_area_files($modcontext->id);
1517     // Delete events from calendar.
1518     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1519         foreach($events as $event) {
1520             $calendarevent = calendar_event::load($event->id);
1521             $calendarevent->delete();
1522         }
1523     }
1525     // Delete grade items, outcome items and grades attached to modules.
1526     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1527                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1528         foreach ($grade_items as $grade_item) {
1529             $grade_item->delete('moddelete');
1530         }
1531     }
1533     // Delete completion and availability data; it is better to do this even if the
1534     // features are not turned on, in case they were turned on previously (these will be
1535     // very quick on an empty table).
1536     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1537     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
1538     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
1539     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1540                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1542     // Delete the context.
1543     context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
1545     // Delete the module from the course_modules table.
1546     $DB->delete_records('course_modules', array('id' => $cm->id));
1548     // Delete module from that section.
1549     if (!delete_mod_from_section($cm->id, $cm->section)) {
1550         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1551             "Cannot delete the module $modulename (instance) from section.");
1552     }
1554     // Trigger a mod_deleted event with information about this module.
1555     $eventdata = new stdClass();
1556     $eventdata->modulename = $modulename;
1557     $eventdata->cmid       = $cm->id;
1558     $eventdata->courseid   = $cm->course;
1559     $eventdata->userid     = $USER->id;
1560     events_trigger('mod_deleted', $eventdata);
1562     add_to_log($cm->course, 'course', "delete mod",
1563                "view.php?id=$cm->course",
1564                "$modulename $cm->instance", $cm->id);
1566     rebuild_course_cache($cm->course, true);
1569 function delete_mod_from_section($modid, $sectionid) {
1570     global $DB;
1572     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1574         $modarray = explode(",", $section->sequence);
1576         if ($key = array_keys ($modarray, $modid)) {
1577             array_splice($modarray, $key[0], 1);
1578             $newsequence = implode(",", $modarray);
1579             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1580             rebuild_course_cache($section->course, true);
1581             return true;
1582         } else {
1583             return false;
1584         }
1586     }
1587     return false;
1590 /**
1591  * Moves a section within a course, from a position to another.
1592  * Be very careful: $section and $destination refer to section number,
1593  * not id!.
1594  *
1595  * @param object $course
1596  * @param int $section Section number (not id!!!)
1597  * @param int $destination
1598  * @return boolean Result
1599  */
1600 function move_section_to($course, $section, $destination) {
1601 /// Moves a whole course section up and down within the course
1602     global $USER, $DB;
1604     if (!$destination && $destination != 0) {
1605         return true;
1606     }
1608     // compartibility with course formats using field 'numsections'
1609     $courseformatoptions = course_get_format($course)->get_format_options();
1610     if ((array_key_exists('numsections', $courseformatoptions) &&
1611             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1612         return false;
1613     }
1615     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1616     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1617             'section ASC, id ASC', 'id, section')) {
1618         return false;
1619     }
1621     $movedsections = reorder_sections($sections, $section, $destination);
1623     // Update all sections. Do this in 2 steps to avoid breaking database
1624     // uniqueness constraint
1625     $transaction = $DB->start_delegated_transaction();
1626     foreach ($movedsections as $id => $position) {
1627         if ($sections[$id] !== $position) {
1628             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1629         }
1630     }
1631     foreach ($movedsections as $id => $position) {
1632         if ($sections[$id] !== $position) {
1633             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1634         }
1635     }
1637     // If we move the highlighted section itself, then just highlight the destination.
1638     // Adjust the higlighted section location if we move something over it either direction.
1639     if ($section == $course->marker) {
1640         course_set_marker($course->id, $destination);
1641     } elseif ($section > $course->marker && $course->marker >= $destination) {
1642         course_set_marker($course->id, $course->marker+1);
1643     } elseif ($section < $course->marker && $course->marker <= $destination) {
1644         course_set_marker($course->id, $course->marker-1);
1645     }
1647     $transaction->allow_commit();
1648     rebuild_course_cache($course->id, true);
1649     return true;
1652 /**
1653  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1654  * an original position number and a target position number, rebuilds the array so that the
1655  * move is made without any duplication of section positions.
1656  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1657  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1658  *
1659  * @param array $sections
1660  * @param int $origin_position
1661  * @param int $target_position
1662  * @return array
1663  */
1664 function reorder_sections($sections, $origin_position, $target_position) {
1665     if (!is_array($sections)) {
1666         return false;
1667     }
1669     // We can't move section position 0
1670     if ($origin_position < 1) {
1671         echo "We can't move section position 0";
1672         return false;
1673     }
1675     // Locate origin section in sections array
1676     if (!$origin_key = array_search($origin_position, $sections)) {
1677         echo "searched position not in sections array";
1678         return false; // searched position not in sections array
1679     }
1681     // Extract origin section
1682     $origin_section = $sections[$origin_key];
1683     unset($sections[$origin_key]);
1685     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1686     $found = false;
1687     $append_array = array();
1688     foreach ($sections as $id => $position) {
1689         if ($found) {
1690             $append_array[$id] = $position;
1691             unset($sections[$id]);
1692         }
1693         if ($position == $target_position) {
1694             if ($target_position < $origin_position) {
1695                 $append_array[$id] = $position;
1696                 unset($sections[$id]);
1697             }
1698             $found = true;
1699         }
1700     }
1702     // Append moved section
1703     $sections[$origin_key] = $origin_section;
1705     // Append rest of array (if applicable)
1706     if (!empty($append_array)) {
1707         foreach ($append_array as $id => $position) {
1708             $sections[$id] = $position;
1709         }
1710     }
1712     // Renumber positions
1713     $position = 0;
1714     foreach ($sections as $id => $p) {
1715         $sections[$id] = $position;
1716         $position++;
1717     }
1719     return $sections;
1723 /**
1724  * Move the module object $mod to the specified $section
1725  * If $beforemod exists then that is the module
1726  * before which $modid should be inserted
1727  * All parameters are objects
1728  */
1729 function moveto_module($mod, $section, $beforemod=NULL) {
1730     global $OUTPUT, $DB;
1732 /// Remove original module from original section
1733     if (! delete_mod_from_section($mod->id, $mod->section)) {
1734         echo $OUTPUT->notification("Could not delete module from existing section");
1735     }
1737     // if moving to a hidden section then hide module
1738     if ($mod->section != $section->id) {
1739         if (!$section->visible && $mod->visible) {
1740             // Set this in the object because it is sent as a response to ajax calls.
1741             $mod->visible = 0;
1742             set_coursemodule_visible($mod->id, 0);
1743             // Set visibleold to 1 so module will be visible when section is made visible.
1744             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1745         }
1746         if ($section->visible && !$mod->visible) {
1747             set_coursemodule_visible($mod->id, $mod->visibleold);
1748             // Set this in the object because it is sent as a response to ajax calls.
1749             $mod->visible = $mod->visibleold;
1750         }
1751     }
1753 /// Add the module into the new section
1754     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
1755     return true;
1758 /**
1759  * Returns the list of all editing actions that current user can perform on the module
1760  *
1761  * @param cm_info $mod The module to produce editing buttons for
1762  * @param int $indent The current indenting (default -1 means no move left-right actions)
1763  * @param int $sr The section to link back to (used for creating the links)
1764  * @return array array of action_link or pix_icon objects
1765  */
1766 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
1767     global $COURSE, $SITE;
1769     static $str;
1771     $coursecontext = context_course::instance($mod->course);
1772     $modcontext = context_module::instance($mod->id);
1774     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1775     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1777     // No permission to edit anything.
1778     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1779         return array();
1780     }
1782     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1784     if (!isset($str)) {
1785         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1786             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
1787         $str->assign         = get_string('assignroles', 'role');
1788         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1789         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1790         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1791         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
1792         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
1793         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
1794     }
1796     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1798     if ($sr !== null) {
1799         $baseurl->param('sr', $sr);
1800     }
1801     $actions = array();
1803     // AJAX edit title.
1804     if ($mod->has_view() && $hasmanageactivities &&
1805                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
1806                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
1807         // we will not display link if we are on some other-course page (where we should not see this module anyway)
1808         $actions['title'] = new action_menu_link_secondary(
1809             new moodle_url($baseurl, array('update' => $mod->id)),
1810             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
1811             $str->edittitle,
1812             array('class' => 'editing_title', 'data-action' => 'edittitle')
1813         );
1814     }
1816     // Indent.
1817     if ($hasmanageactivities) {
1818         if (right_to_left()) {   // Exchange arrows on RTL
1819             $rightarrow = 't/left';
1820             $leftarrow  = 't/right';
1821         } else {
1822             $rightarrow = 't/right';
1823             $leftarrow  = 't/left';
1824         }
1826         $hiddenclass = 'hidden';
1827         if ($indent > 0) {
1828             $hiddenclass = '';
1829         }
1830         $actions['moveleft'] = new action_menu_link_secondary(
1831             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
1832             new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1833             $str->moveleft,
1834             array('class' => 'editing_moveleft ' . $hiddenclass, 'data-action' => 'moveleft')
1835         );
1836         $hiddenclass = 'hidden';
1837         if ($indent >= 0) {
1838             $hiddenclass = '';
1839         }
1840         $actions['moveright'] = new action_menu_link_secondary(
1841             new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
1842             new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1843             $str->moveright,
1844             array('class' => 'editing_moveright ' . $hiddenclass, 'data-action' => 'moveright')
1845         );
1846     }
1848     // Move.
1849     if ($hasmanageactivities) {
1850         $actions['move'] = new action_menu_link_primary(
1851             new moodle_url($baseurl, array('copy' => $mod->id)),
1852             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1853             $str->move,
1854             array('class' => 'editing_move status', 'data-action' => 'move')
1855         );
1856     }
1858     // Update.
1859     if ($hasmanageactivities) {
1860         $actions['update'] = new action_menu_link_secondary(
1861             new moodle_url($baseurl, array('update' => $mod->id)),
1862             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1863             $str->update,
1864             array('class' => 'editing_update', 'data-action' => 'update')
1865         );
1866     }
1868     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1869     // Note that restoring on front page is never allowed.
1870     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
1871             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
1872         $actions['duplicate'] = new action_menu_link_secondary(
1873             new moodle_url($baseurl, array('duplicate' => $mod->id)),
1874             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1875             $str->duplicate,
1876             array('class' => 'editing_duplicate', 'data-action' => 'duplicate')
1877         );
1878     }
1880     // Delete.
1881     if ($hasmanageactivities) {
1882         $actions['delete'] = new action_menu_link_secondary(
1883             new moodle_url($baseurl, array('delete' => $mod->id)),
1884             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1885             $str->delete,
1886             array('class' => 'editing_delete', 'data-action' => 'delete')
1887         );
1888     }
1890     // Hide/Show.
1891     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1892         if ($mod->visible) {
1893             $actions['hide'] = new action_menu_link_primary(
1894                 new moodle_url($baseurl, array('hide' => $mod->id)),
1895                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1896                 $str->hide,
1897                 array('class' => 'editing_hide', 'data-action' => 'hide')
1898             );
1899         } else {
1900             $actions['show'] = new action_menu_link_primary(
1901                 new moodle_url($baseurl, array('show' => $mod->id)),
1902                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1903                 $str->show,
1904                 array('class' => 'editing_show', 'data-action' => 'show')
1905             );
1906         }
1907     }
1909     // Groupmode.
1910     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1911         if ($mod->coursegroupmodeforce) {
1912             $modgroupmode = $mod->coursegroupmode;
1913         } else {
1914             $modgroupmode = $mod->groupmode;
1915         }
1916         if ($modgroupmode == SEPARATEGROUPS) {
1917             $nextgroupmode = VISIBLEGROUPS;
1918             $grouptitle = $str->groupsseparate;
1919             $forcedgrouptitle = $str->forcedgroupsseparate;
1920             $actionname = 'groupsseparate';
1921             $groupimage = 't/groups';
1922         } else if ($modgroupmode == VISIBLEGROUPS) {
1923             $nextgroupmode = NOGROUPS;
1924             $grouptitle = $str->groupsvisible;
1925             $forcedgrouptitle = $str->forcedgroupsvisible;
1926             $actionname = 'groupsvisible';
1927             $groupimage = 't/groupv';
1928         } else {
1929             $nextgroupmode = SEPARATEGROUPS;
1930             $grouptitle = $str->groupsnone;
1931             $forcedgrouptitle = $str->forcedgroupsnone;
1932             $actionname = 'groupsnone';
1933             $groupimage = 't/groupn';
1934         }
1935         if (!$mod->coursegroupmodeforce) {
1936             $actions[$actionname] = new action_menu_link_primary(
1937                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
1938                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1939                 $grouptitle,
1940                 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode)
1941             );
1942         } else {
1943             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => '', 'class' => 'iconsmall'));
1944         }
1945     }
1947     // Assign.
1948     if (has_capability('moodle/role:assign', $modcontext)){
1949         $actions['assign'] = new action_menu_link_secondary(
1950             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
1951             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1952             $str->assign,
1953             array('class' => 'editing_assign', 'data-action' => 'assignroles')
1954         );
1955     }
1957     return $actions;
1960 /**
1961  * given a course object with shortname & fullname, this function will
1962  * truncate the the number of chars allowed and add ... if it was too long
1963  */
1964 function course_format_name ($course,$max=100) {
1966     $context = context_course::instance($course->id);
1967     $shortname = format_string($course->shortname, true, array('context' => $context));
1968     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
1969     $str = $shortname.': '. $fullname;
1970     if (core_text::strlen($str) <= $max) {
1971         return $str;
1972     }
1973     else {
1974         return core_text::substr($str,0,$max-3).'...';
1975     }
1978 /**
1979  * Is the user allowed to add this type of module to this course?
1980  * @param object $course the course settings. Only $course->id is used.
1981  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
1982  * @return bool whether the current user is allowed to add this type of module to this course.
1983  */
1984 function course_allowed_module($course, $modname) {
1985     if (is_numeric($modname)) {
1986         throw new coding_exception('Function course_allowed_module no longer
1987                 supports numeric module ids. Please update your code to pass the module name.');
1988     }
1990     $capability = 'mod/' . $modname . ':addinstance';
1991     if (!get_capability_info($capability)) {
1992         // Debug warning that the capability does not exist, but no more than once per page.
1993         static $warned = array();
1994         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1995         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
1996             debugging('The module ' . $modname . ' does not define the standard capability ' .
1997                     $capability , DEBUG_DEVELOPER);
1998             $warned[$modname] = 1;
1999         }
2001         // If the capability does not exist, the module can always be added.
2002         return true;
2003     }
2005     $coursecontext = context_course::instance($course->id);
2006     return has_capability($capability, $coursecontext);
2009 /**
2010  * Efficiently moves many courses around while maintaining
2011  * sortorder in order.
2012  *
2013  * @param array $courseids is an array of course ids
2014  * @param int $categoryid
2015  * @return bool success
2016  */
2017 function move_courses($courseids, $categoryid) {
2018     global $CFG, $DB, $OUTPUT;
2020     if (empty($courseids)) {
2021         // nothing to do
2022         return;
2023     }
2025     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
2026         return false;
2027     }
2029     $courseids = array_reverse($courseids);
2030     $newparent = context_coursecat::instance($category->id);
2031     $i = 1;
2033     foreach ($courseids as $courseid) {
2034         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
2035             $course = new stdClass();
2036             $course->id = $courseid;
2037             $course->category  = $category->id;
2038             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2039             if ($category->visible == 0) {
2040                 // hide the course when moving into hidden category,
2041                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
2042                 $course->visible = 0;
2043             }
2045             $DB->update_record('course', $course);
2046             add_to_log($course->id, "course", "move", "edit.php?id=$course->id", $course->id);
2048             $context   = context_course::instance($course->id);
2049             $context->update_moved($newparent);
2050         }
2051     }
2052     fix_course_sortorder();
2053     cache_helper::purge_by_event('changesincourse');
2055     return true;
2058 /**
2059  * Returns the display name of the given section that the course prefers
2060  *
2061  * Implementation of this function is provided by course format
2062  * @see format_base::get_section_name()
2063  *
2064  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2065  * @param int|stdClass $section Section object from database or just field course_sections.section
2066  * @return string Display name that the course format prefers, e.g. "Week 2"
2067  */
2068 function get_section_name($courseorid, $section) {
2069     return course_get_format($courseorid)->get_section_name($section);
2072 /**
2073  * Tells if current course format uses sections
2074  *
2075  * @param string $format Course format ID e.g. 'weeks' $course->format
2076  * @return bool
2077  */
2078 function course_format_uses_sections($format) {
2079     $course = new stdClass();
2080     $course->format = $format;
2081     return course_get_format($course)->uses_sections();
2084 /**
2085  * Returns the information about the ajax support in the given source format
2086  *
2087  * The returned object's property (boolean)capable indicates that
2088  * the course format supports Moodle course ajax features.
2089  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
2090  *
2091  * @param string $format
2092  * @return stdClass
2093  */
2094 function course_format_ajax_support($format) {
2095     $course = new stdClass();
2096     $course->format = $format;
2097     return course_get_format($course)->supports_ajax();
2100 /**
2101  * Can the current user delete this course?
2102  * Course creators have exception,
2103  * 1 day after the creation they can sill delete the course.
2104  * @param int $courseid
2105  * @return boolean
2106  */
2107 function can_delete_course($courseid) {
2108     global $USER, $DB;
2110     $context = context_course::instance($courseid);
2112     if (has_capability('moodle/course:delete', $context)) {
2113         return true;
2114     }
2116     // hack: now try to find out if creator created this course recently (1 day)
2117     if (!has_capability('moodle/course:create', $context)) {
2118         return false;
2119     }
2121     $since = time() - 60*60*24;
2123     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
2124     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
2126     return $DB->record_exists_select('log', $select, $params);
2129 /**
2130  * Save the Your name for 'Some role' strings.
2131  *
2132  * @param integer $courseid the id of this course.
2133  * @param array $data the data that came from the course settings form.
2134  */
2135 function save_local_role_names($courseid, $data) {
2136     global $DB;
2137     $context = context_course::instance($courseid);
2139     foreach ($data as $fieldname => $value) {
2140         if (strpos($fieldname, 'role_') !== 0) {
2141             continue;
2142         }
2143         list($ignored, $roleid) = explode('_', $fieldname);
2145         // make up our mind whether we want to delete, update or insert
2146         if (!$value) {
2147             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2149         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2150             $rolename->name = $value;
2151             $DB->update_record('role_names', $rolename);
2153         } else {
2154             $rolename = new stdClass;
2155             $rolename->contextid = $context->id;
2156             $rolename->roleid = $roleid;
2157             $rolename->name = $value;
2158             $DB->insert_record('role_names', $rolename);
2159         }
2160     }
2163 /**
2164  * Returns options to use in course overviewfiles filemanager
2165  *
2166  * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2167  *     may be empty if course does not exist yet (course create form)
2168  * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2169  *     or null if overviewfiles are disabled
2170  */
2171 function course_overviewfiles_options($course) {
2172     global $CFG;
2173     if (empty($CFG->courseoverviewfileslimit)) {
2174         return null;
2175     }
2176     $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2177     if (in_array('*', $accepted_types) || empty($accepted_types)) {
2178         $accepted_types = '*';
2179     } else {
2180         // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2181         // Make sure extensions are prefixed with dot unless they are valid typegroups
2182         foreach ($accepted_types as $i => $type) {
2183             if (substr($type, 0, 1) !== '.') {
2184                 require_once($CFG->libdir. '/filelib.php');
2185                 if (!count(file_get_typegroup('extension', $type))) {
2186                     // It does not start with dot and is not a valid typegroup, this is most likely extension.
2187                     $accepted_types[$i] = '.'. $type;
2188                     $corrected = true;
2189                 }
2190             }
2191         }
2192         if (!empty($corrected)) {
2193             set_config('courseoverviewfilesext', join(',', $accepted_types));
2194         }
2195     }
2196     $options = array(
2197         'maxfiles' => $CFG->courseoverviewfileslimit,
2198         'maxbytes' => $CFG->maxbytes,
2199         'subdirs' => 0,
2200         'accepted_types' => $accepted_types
2201     );
2202     if (!empty($course->id)) {
2203         $options['context'] = context_course::instance($course->id);
2204     } else if (is_int($course) && $course > 0) {
2205         $options['context'] = context_course::instance($course);
2206     }
2207     return $options;
2210 /**
2211  * Create a course and either return a $course object
2212  *
2213  * Please note this functions does not verify any access control,
2214  * the calling code is responsible for all validation (usually it is the form definition).
2215  *
2216  * @param array $editoroptions course description editor options
2217  * @param object $data  - all the data needed for an entry in the 'course' table
2218  * @return object new course instance
2219  */
2220 function create_course($data, $editoroptions = NULL) {
2221     global $CFG, $DB;
2223     //check the categoryid - must be given for all new courses
2224     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2226     //check if the shortname already exist
2227     if (!empty($data->shortname)) {
2228         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2229             throw new moodle_exception('shortnametaken');
2230         }
2231     }
2233     //check if the id number already exist
2234     if (!empty($data->idnumber)) {
2235         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2236             throw new moodle_exception('idnumbertaken');
2237         }
2238     }
2240     $data->timecreated  = time();
2241     $data->timemodified = $data->timecreated;
2243     // place at beginning of any category
2244     $data->sortorder = 0;
2246     if ($editoroptions) {
2247         // summary text is updated later, we need context to store the files first
2248         $data->summary = '';
2249         $data->summary_format = FORMAT_HTML;
2250     }
2252     if (!isset($data->visible)) {
2253         // data not from form, add missing visibility info
2254         $data->visible = $category->visible;
2255     }
2256     $data->visibleold = $data->visible;
2258     $newcourseid = $DB->insert_record('course', $data);
2259     $context = context_course::instance($newcourseid, MUST_EXIST);
2261     if ($editoroptions) {
2262         // Save the files used in the summary editor and store
2263         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2264         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2265         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2266     }
2267     if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2268         // Save the course overviewfiles
2269         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2270     }
2272     // update course format options
2273     course_get_format($newcourseid)->update_course_format_options($data);
2275     $course = course_get_format($newcourseid)->get_course();
2277     // Setup the blocks
2278     blocks_add_default_course_blocks($course);
2280     // Create a default section.
2281     course_create_sections_if_missing($course, 0);
2283     fix_course_sortorder();
2284     // purge appropriate caches in case fix_course_sortorder() did not change anything
2285     cache_helper::purge_by_event('changesincourse');
2287     // new context created - better mark it as dirty
2288     $context->mark_dirty();
2290     // Save any custom role names.
2291     save_local_role_names($course->id, (array)$data);
2293     // set up enrolments
2294     enrol_course_updated(true, $course, $data);
2296     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
2298     // Trigger events
2299     events_trigger('course_created', $course);
2301     return $course;
2304 /**
2305  * Update a course.
2306  *
2307  * Please note this functions does not verify any access control,
2308  * the calling code is responsible for all validation (usually it is the form definition).
2309  *
2310  * @param object $data  - all the data needed for an entry in the 'course' table
2311  * @param array $editoroptions course description editor options
2312  * @return void
2313  */
2314 function update_course($data, $editoroptions = NULL) {
2315     global $CFG, $DB;
2317     $data->timemodified = time();
2319     $oldcourse = course_get_format($data->id)->get_course();
2320     $context   = context_course::instance($oldcourse->id);
2322     if ($editoroptions) {
2323         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2324     }
2325     if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2326         $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2327     }
2329     if (!isset($data->category) or empty($data->category)) {
2330         // prevent nulls and 0 in category field
2331         unset($data->category);
2332     }
2333     $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2335     if (!isset($data->visible)) {
2336         // data not from form, add missing visibility info
2337         $data->visible = $oldcourse->visible;
2338     }
2340     if ($data->visible != $oldcourse->visible) {
2341         // reset the visibleold flag when manually hiding/unhiding course
2342         $data->visibleold = $data->visible;
2343         $changesincoursecat = true;
2344     } else {
2345         if ($movecat) {
2346             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2347             if (empty($newcategory->visible)) {
2348                 // make sure when moving into hidden category the course is hidden automatically
2349                 $data->visible = 0;
2350             }
2351         }
2352     }
2354     // Update with the new data
2355     $DB->update_record('course', $data);
2356     // make sure the modinfo cache is reset
2357     rebuild_course_cache($data->id);
2359     // update course format options with full course data
2360     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2362     $course = $DB->get_record('course', array('id'=>$data->id));
2364     if ($movecat) {
2365         $newparent = context_coursecat::instance($course->category);
2366         $context->update_moved($newparent);
2367     }
2369     fix_course_sortorder();
2370     // purge appropriate caches in case fix_course_sortorder() did not change anything
2371     cache_helper::purge_by_event('changesincourse');
2372     if ($changesincoursecat) {
2373         cache_helper::purge_by_event('changesincoursecat');
2374     }
2376     // Test for and remove blocks which aren't appropriate anymore
2377     blocks_remove_inappropriate($course);
2379     // Save any custom role names.
2380     save_local_role_names($course->id, $data);
2382     // update enrol settings
2383     enrol_course_updated(false, $course, $data);
2385     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
2387     // Trigger events
2388     events_trigger('course_updated', $course);
2390     if ($oldcourse->format !== $course->format) {
2391         // Remove all options stored for the previous format
2392         // We assume that new course format migrated everything it needed watching trigger
2393         // 'course_updated' and in method format_XXX::update_course_format_options()
2394         $DB->delete_records('course_format_options',
2395                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2396     }
2399 /**
2400  * Average number of participants
2401  * @return integer
2402  */
2403 function average_number_of_participants() {
2404     global $DB, $SITE;
2406     //count total of enrolments for visible course (except front page)
2407     $sql = 'SELECT COUNT(*) FROM (
2408         SELECT DISTINCT ue.userid, e.courseid
2409         FROM {user_enrolments} ue, {enrol} e, {course} c
2410         WHERE ue.enrolid = e.id
2411             AND e.courseid <> :siteid
2412             AND c.id = e.courseid
2413             AND c.visible = 1) total';
2414     $params = array('siteid' => $SITE->id);
2415     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2418     //count total of visible courses (minus front page)
2419     $coursetotal = $DB->count_records('course', array('visible' => 1));
2420     $coursetotal = $coursetotal - 1 ;
2422     //average of enrolment
2423     if (empty($coursetotal)) {
2424         $participantaverage = 0;
2425     } else {
2426         $participantaverage = $enrolmenttotal / $coursetotal;
2427     }
2429     return $participantaverage;
2432 /**
2433  * Average number of course modules
2434  * @return integer
2435  */
2436 function average_number_of_courses_modules() {
2437     global $DB, $SITE;
2439     //count total of visible course module (except front page)
2440     $sql = 'SELECT COUNT(*) FROM (
2441         SELECT cm.course, cm.module
2442         FROM {course} c, {course_modules} cm
2443         WHERE c.id = cm.course
2444             AND c.id <> :siteid
2445             AND cm.visible = 1
2446             AND c.visible = 1) total';
2447     $params = array('siteid' => $SITE->id);
2448     $moduletotal = $DB->count_records_sql($sql, $params);
2451     //count total of visible courses (minus front page)
2452     $coursetotal = $DB->count_records('course', array('visible' => 1));
2453     $coursetotal = $coursetotal - 1 ;
2455     //average of course module
2456     if (empty($coursetotal)) {
2457         $coursemoduleaverage = 0;
2458     } else {
2459         $coursemoduleaverage = $moduletotal / $coursetotal;
2460     }
2462     return $coursemoduleaverage;
2465 /**
2466  * This class pertains to course requests and contains methods associated with
2467  * create, approving, and removing course requests.
2468  *
2469  * Please note we do not allow embedded images here because there is no context
2470  * to store them with proper access control.
2471  *
2472  * @copyright 2009 Sam Hemelryk
2473  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2474  * @since Moodle 2.0
2475  *
2476  * @property-read int $id
2477  * @property-read string $fullname
2478  * @property-read string $shortname
2479  * @property-read string $summary
2480  * @property-read int $summaryformat
2481  * @property-read int $summarytrust
2482  * @property-read string $reason
2483  * @property-read int $requester
2484  */
2485 class course_request {
2487     /**
2488      * This is the stdClass that stores the properties for the course request
2489      * and is externally accessed through the __get magic method
2490      * @var stdClass
2491      */
2492     protected $properties;
2494     /**
2495      * An array of options for the summary editor used by course request forms.
2496      * This is initially set by {@link summary_editor_options()}
2497      * @var array
2498      * @static
2499      */
2500     protected static $summaryeditoroptions;
2502     /**
2503      * Static function to prepare the summary editor for working with a course
2504      * request.
2505      *
2506      * @static
2507      * @param null|stdClass $data Optional, an object containing the default values
2508      *                       for the form, these may be modified when preparing the
2509      *                       editor so this should be called before creating the form
2510      * @return stdClass An object that can be used to set the default values for
2511      *                   an mforms form
2512      */
2513     public static function prepare($data=null) {
2514         if ($data === null) {
2515             $data = new stdClass;
2516         }
2517         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2518         return $data;
2519     }
2521     /**
2522      * Static function to create a new course request when passed an array of properties
2523      * for it.
2524      *
2525      * This function also handles saving any files that may have been used in the editor
2526      *
2527      * @static
2528      * @param stdClass $data
2529      * @return course_request The newly created course request
2530      */
2531     public static function create($data) {
2532         global $USER, $DB, $CFG;
2533         $data->requester = $USER->id;
2535         // Setting the default category if none set.
2536         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2537             $data->category = $CFG->defaultrequestcategory;
2538         }
2540         // Summary is a required field so copy the text over
2541         $data->summary       = $data->summary_editor['text'];
2542         $data->summaryformat = $data->summary_editor['format'];
2544         $data->id = $DB->insert_record('course_request', $data);
2546         // Create a new course_request object and return it
2547         $request = new course_request($data);
2549         // Notify the admin if required.
2550         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2552             $a = new stdClass;
2553             $a->link = "$CFG->wwwroot/course/pending.php";
2554             $a->user = fullname($USER);
2555             $subject = get_string('courserequest');
2556             $message = get_string('courserequestnotifyemail', 'admin', $a);
2557             foreach ($users as $user) {
2558                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2559             }
2560         }
2562         return $request;
2563     }
2565     /**
2566      * Returns an array of options to use with a summary editor
2567      *
2568      * @uses course_request::$summaryeditoroptions
2569      * @return array An array of options to use with the editor
2570      */
2571     public static function summary_editor_options() {
2572         global $CFG;
2573         if (self::$summaryeditoroptions === null) {
2574             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2575         }
2576         return self::$summaryeditoroptions;
2577     }
2579     /**
2580      * Loads the properties for this course request object. Id is required and if
2581      * only id is provided then we load the rest of the properties from the database
2582      *
2583      * @param stdClass|int $properties Either an object containing properties
2584      *                      or the course_request id to load
2585      */
2586     public function __construct($properties) {
2587         global $DB;
2588         if (empty($properties->id)) {
2589             if (empty($properties)) {
2590                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2591             }
2592             $id = $properties;
2593             $properties = new stdClass;
2594             $properties->id = (int)$id;
2595             unset($id);
2596         }
2597         if (empty($properties->requester)) {
2598             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2599                 print_error('unknowncourserequest');
2600             }
2601         } else {
2602             $this->properties = $properties;
2603         }
2604         $this->properties->collision = null;
2605     }
2607     /**
2608      * Returns the requested property
2609      *
2610      * @param string $key
2611      * @return mixed
2612      */
2613     public function __get($key) {
2614         return $this->properties->$key;
2615     }
2617     /**
2618      * Override this to ensure empty($request->blah) calls return a reliable answer...
2619      *
2620      * This is required because we define the __get method
2621      *
2622      * @param mixed $key
2623      * @return bool True is it not empty, false otherwise
2624      */
2625     public function __isset($key) {
2626         return (!empty($this->properties->$key));
2627     }
2629     /**
2630      * Returns the user who requested this course
2631      *
2632      * Uses a static var to cache the results and cut down the number of db queries
2633      *
2634      * @staticvar array $requesters An array of cached users
2635      * @return stdClass The user who requested the course
2636      */
2637     public function get_requester() {
2638         global $DB;
2639         static $requesters= array();
2640         if (!array_key_exists($this->properties->requester, $requesters)) {
2641             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
2642         }
2643         return $requesters[$this->properties->requester];
2644     }
2646     /**
2647      * Checks that the shortname used by the course does not conflict with any other
2648      * courses that exist
2649      *
2650      * @param string|null $shortnamemark The string to append to the requests shortname
2651      *                     should a conflict be found
2652      * @return bool true is there is a conflict, false otherwise
2653      */
2654     public function check_shortname_collision($shortnamemark = '[*]') {
2655         global $DB;
2657         if ($this->properties->collision !== null) {
2658             return $this->properties->collision;
2659         }
2661         if (empty($this->properties->shortname)) {
2662             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
2663             $this->properties->collision = false;
2664         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
2665             if (!empty($shortnamemark)) {
2666                 $this->properties->shortname .= ' '.$shortnamemark;
2667             }
2668             $this->properties->collision = true;
2669         } else {
2670             $this->properties->collision = false;
2671         }
2672         return $this->properties->collision;
2673     }
2675     /**
2676      * Returns the category where this course request should be created
2677      *
2678      * Note that we don't check here that user has a capability to view
2679      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2680      * 'moodle/course:changecategory'
2681      *
2682      * @return coursecat
2683      */
2684     public function get_category() {
2685         global $CFG;
2686         require_once($CFG->libdir.'/coursecatlib.php');
2687         // If the category is not set, if the current user does not have the rights to change the category, or if the
2688         // category does not exist, we set the default category to the course to be approved.
2689         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2690         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
2691                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
2692             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
2693         }
2694         if (!$category) {
2695             $category = coursecat::get_default();
2696         }
2697         return $category;
2698     }
2700     /**
2701      * This function approves the request turning it into a course
2702      *
2703      * This function converts the course request into a course, at the same time
2704      * transferring any files used in the summary to the new course and then removing
2705      * the course request and the files associated with it.
2706      *
2707      * @return int The id of the course that was created from this request
2708      */
2709     public function approve() {
2710         global $CFG, $DB, $USER;
2712         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
2714         $courseconfig = get_config('moodlecourse');
2716         // Transfer appropriate settings
2717         $data = clone($this->properties);
2718         unset($data->id);
2719         unset($data->reason);
2720         unset($data->requester);
2722         // Set category
2723         $category = $this->get_category();
2724         $data->category = $category->id;
2725         // Set misc settings
2726         $data->requested = 1;
2728         // Apply course default settings
2729         $data->format             = $courseconfig->format;
2730         $data->newsitems          = $courseconfig->newsitems;
2731         $data->showgrades         = $courseconfig->showgrades;
2732         $data->showreports        = $courseconfig->showreports;
2733         $data->maxbytes           = $courseconfig->maxbytes;
2734         $data->groupmode          = $courseconfig->groupmode;
2735         $data->groupmodeforce     = $courseconfig->groupmodeforce;
2736         $data->visible            = $courseconfig->visible;
2737         $data->visibleold         = $data->visible;
2738         $data->lang               = $courseconfig->lang;
2740         $course = create_course($data);
2741         $context = context_course::instance($course->id, MUST_EXIST);
2743         // add enrol instances
2744         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
2745             if ($manual = enrol_get_plugin('manual')) {
2746                 $manual->add_default_instance($course);
2747             }
2748         }
2750         // enrol the requester as teacher if necessary
2751         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2752             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
2753         }
2755         $this->delete();
2757         $a = new stdClass();
2758         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2759         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
2760         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
2762         return $course->id;
2763     }
2765     /**
2766      * Reject a course request
2767      *
2768      * This function rejects a course request, emailing the requesting user the
2769      * provided notice and then removing the request from the database
2770      *
2771      * @param string $notice The message to display to the user
2772      */
2773     public function reject($notice) {
2774         global $USER, $DB;
2775         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
2776         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
2777         $this->delete();
2778     }
2780     /**
2781      * Deletes the course request and any associated files
2782      */
2783     public function delete() {
2784         global $DB;
2785         $DB->delete_records('course_request', array('id' => $this->properties->id));
2786     }
2788     /**
2789      * Send a message from one user to another using events_trigger
2790      *
2791      * @param object $touser
2792      * @param object $fromuser
2793      * @param string $name
2794      * @param string $subject
2795      * @param string $message
2796      */
2797     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
2798         $eventdata = new stdClass();
2799         $eventdata->component         = 'moodle';
2800         $eventdata->name              = $name;
2801         $eventdata->userfrom          = $fromuser;
2802         $eventdata->userto            = $touser;
2803         $eventdata->subject           = $subject;
2804         $eventdata->fullmessage       = $message;
2805         $eventdata->fullmessageformat = FORMAT_PLAIN;
2806         $eventdata->fullmessagehtml   = '';
2807         $eventdata->smallmessage      = '';
2808         $eventdata->notification      = 1;
2809         message_send($eventdata);
2810     }
2813 /**
2814  * Return a list of page types
2815  * @param string $pagetype current page type
2816  * @param context $parentcontext Block's parent context
2817  * @param context $currentcontext Current context of block
2818  * @return array array of page types
2819  */
2820 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
2821     if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
2822         // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
2823         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2824             'course-index-*' => get_string('page-course-index-x', 'pagetype'),
2825         );
2826     } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
2827         // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
2828         $pagetypes = array('*' => get_string('page-x', 'pagetype'));
2829     } else {
2830         // Otherwise consider it a page inside a course even if $currentcontext is null
2831         $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2832             'course-*' => get_string('page-course-x', 'pagetype'),
2833             'course-view-*' => get_string('page-course-view-x', 'pagetype')
2834         );
2835     }
2836     return $pagetypes;
2839 /**
2840  * Determine whether course ajax should be enabled for the specified course
2841  *
2842  * @param stdClass $course The course to test against
2843  * @return boolean Whether course ajax is enabled or note
2844  */
2845 function course_ajax_enabled($course) {
2846     global $CFG, $PAGE, $SITE;
2848     // Ajax must be enabled globally
2849     if (!$CFG->enableajax) {
2850         return false;
2851     }
2853     // The user must be editing for AJAX to be included
2854     if (!$PAGE->user_is_editing()) {
2855         return false;
2856     }
2858     // Check that the theme suports
2859     if (!$PAGE->theme->enablecourseajax) {
2860         return false;
2861     }
2863     // Check that the course format supports ajax functionality
2864     // The site 'format' doesn't have information on course format support
2865     if ($SITE->id !== $course->id) {
2866         $courseformatajaxsupport = course_format_ajax_support($course->format);
2867         if (!$courseformatajaxsupport->capable) {
2868             return false;
2869         }
2870     }
2872     // All conditions have been met so course ajax should be enabled
2873     return true;
2876 /**
2877  * Include the relevant javascript and language strings for the resource
2878  * toolbox YUI module
2879  *
2880  * @param integer $id The ID of the course being applied to
2881  * @param array $usedmodules An array containing the names of the modules in use on the page
2882  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
2883  * @param stdClass $config An object containing configuration parameters for ajax modules including:
2884  *          * resourceurl   The URL to post changes to for resource changes
2885  *          * sectionurl    The URL to post changes to for section changes
2886  *          * pageparams    Additional parameters to pass through in the post
2887  * @return bool
2888  */
2889 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
2890     global $PAGE, $SITE;
2892     // Ensure that ajax should be included
2893     if (!course_ajax_enabled($course)) {
2894         return false;
2895     }
2897     if (!$config) {
2898         $config = new stdClass();
2899     }
2901     // The URL to use for resource changes
2902     if (!isset($config->resourceurl)) {
2903         $config->resourceurl = '/course/rest.php';
2904     }
2906     // The URL to use for section changes
2907     if (!isset($config->sectionurl)) {
2908         $config->sectionurl = '/course/rest.php';
2909     }
2911     // Any additional parameters which need to be included on page submission
2912     if (!isset($config->pageparams)) {
2913         $config->pageparams = array();
2914     }
2916     // Include toolboxes
2917     $PAGE->requires->yui_module('moodle-course-toolboxes',
2918             'M.course.init_resource_toolbox',
2919             array(array(
2920                 'courseid' => $course->id,
2921                 'ajaxurl' => $config->resourceurl,
2922                 'config' => $config,
2923             ))
2924     );
2925     $PAGE->requires->yui_module('moodle-course-toolboxes',
2926             'M.course.init_section_toolbox',
2927             array(array(
2928                 'courseid' => $course->id,
2929                 'format' => $course->format,
2930                 'ajaxurl' => $config->sectionurl,
2931                 'config' => $config,
2932             ))
2933     );
2935     // Include course dragdrop
2936     if ($course->id != $SITE->id) {
2937         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
2938             array(array(
2939                 'courseid' => $course->id,
2940                 'ajaxurl' => $config->sectionurl,
2941                 'config' => $config,
2942             )), null, true);
2944         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
2945             array(array(
2946                 'courseid' => $course->id,
2947                 'ajaxurl' => $config->resourceurl,
2948                 'config' => $config,
2949             )), null, true);
2950     }
2952     // Require various strings for the command toolbox
2953     $PAGE->requires->strings_for_js(array(
2954             'moveleft',
2955             'deletechecktype',
2956             'deletechecktypename',
2957             'edittitle',
2958             'edittitleinstructions',
2959             'show',
2960             'hide',
2961             'groupsnone',
2962             'groupsvisible',
2963             'groupsseparate',
2964             'clicktochangeinbrackets',
2965             'markthistopic',
2966             'markedthistopic',
2967             'move',
2968             'movesection',
2969         ), 'moodle');
2971     // Include format-specific strings
2972     if ($course->id != $SITE->id) {
2973         $PAGE->requires->strings_for_js(array(
2974                 'showfromothers',
2975                 'hidefromothers',
2976             ), 'format_' . $course->format);
2977     }
2979     // For confirming resource deletion we need the name of the module in question
2980     foreach ($usedmodules as $module => $modname) {
2981         $PAGE->requires->string_for_js('pluginname', $module);
2982     }
2984     // Load drag and drop upload AJAX.
2985     dndupload_add_to_course($course, $enabledmodules);
2987     return true;
2990 /**
2991  * Returns the sorted list of available course formats, filtered by enabled if necessary
2992  *
2993  * @param bool $enabledonly return only formats that are enabled
2994  * @return array array of sorted format names
2995  */
2996 function get_sorted_course_formats($enabledonly = false) {
2997     global $CFG;
2998     $formats = core_component::get_plugin_list('format');
3000     if (!empty($CFG->format_plugins_sortorder)) {
3001         $order = explode(',', $CFG->format_plugins_sortorder);
3002         $order = array_merge(array_intersect($order, array_keys($formats)),
3003                     array_diff(array_keys($formats), $order));
3004     } else {
3005         $order = array_keys($formats);
3006     }
3007     if (!$enabledonly) {
3008         return $order;
3009     }
3010     $sortedformats = array();
3011     foreach ($order as $formatname) {
3012         if (!get_config('format_'.$formatname, 'disabled')) {
3013             $sortedformats[] = $formatname;
3014         }
3015     }
3016     return $sortedformats;
3019 /**
3020  * The URL to use for the specified course (with section)
3021  *
3022  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3023  * @param int|stdClass $section Section object from database or just field course_sections.section
3024  *     if omitted the course view page is returned
3025  * @param array $options options for view URL. At the moment core uses:
3026  *     'navigation' (bool) if true and section has no separate page, the function returns null
3027  *     'sr' (int) used by multipage formats to specify to which section to return
3028  * @return moodle_url The url of course
3029  */
3030 function course_get_url($courseorid, $section = null, $options = array()) {
3031     return course_get_format($courseorid)->get_view_url($section, $options);
3034 /**
3035  * Create a module.
3036  *
3037  * It includes:
3038  *      - capability checks and other checks
3039  *      - create the module from the module info
3040  *
3041  * @param object $module
3042  * @return object the created module info
3043  */
3044 function create_module($moduleinfo) {
3045     global $DB, $CFG;
3047     require_once($CFG->dirroot . '/course/modlib.php');
3049     // Check manadatory attributs.
3050     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3051     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3052         $mandatoryfields[] = 'introeditor';
3053     }
3054     foreach($mandatoryfields as $mandatoryfield) {
3055         if (!isset($moduleinfo->{$mandatoryfield})) {
3056             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3057         }
3058     }
3060     // Some additional checks (capability / existing instances).
3061     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3062     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3064     // Load module library.
3065     include_modulelib($module->name);
3067     // Add the module.
3068     $moduleinfo->module = $module->id;
3069     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3071     return $moduleinfo;
3074 /**
3075  * Update a module.
3076  *
3077  * It includes:
3078  *      - capability and other checks
3079  *      - update the module
3080  *
3081  * @param object $module
3082  * @return object the updated module info
3083  */
3084 function update_module($moduleinfo) {
3085     global $DB, $CFG;
3087     require_once($CFG->dirroot . '/course/modlib.php');
3089     // Check the course module exists.
3090     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3092     // Check the course exists.
3093     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3095     // Some checks (capaibility / existing instances).
3096     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3098     // Load module library.
3099     include_modulelib($module->name);
3101     // Retrieve few information needed by update_moduleinfo.
3102     $moduleinfo->modulename = $cm->modname;
3103     if (!isset($moduleinfo->scale)) {
3104         $moduleinfo->scale = 0;
3105     }
3106     $moduleinfo->type = 'mod';
3108     // Update the module.
3109     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3111     return $moduleinfo;
3114 /**
3115  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3116  * Sorts by descending order of time.
3117  *
3118  * @param stdClass $a First object
3119  * @param stdClass $b Second object
3120  * @return int 0,1,-1 representing the order
3121  */
3122 function compare_activities_by_time_desc($a, $b) {
3123     // Make sure the activities actually have a timestamp property.
3124     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3125         return 0;
3126     }
3127     // We treat instances without timestamp as if they have a timestamp of 0.
3128     if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3129         return 1;
3130     }
3131     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3132         return -1;
3133     }
3134     if ($a->timestamp == $b->timestamp) {
3135         return 0;
3136     }
3137     return ($a->timestamp > $b->timestamp) ? -1 : 1;
3140 /**
3141  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3142  * Sorts by ascending order of time.
3143  *
3144  * @param stdClass $a First object
3145  * @param stdClass $b Second object
3146  * @return int 0,1,-1 representing the order
3147  */
3148 function compare_activities_by_time_asc($a, $b) {
3149     // Make sure the activities actually have a timestamp property.
3150     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3151       return 0;
3152     }
3153     // We treat instances without timestamp as if they have a timestamp of 0.
3154     if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3155         return -1;
3156     }
3157     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3158         return 1;
3159     }
3160     if ($a->timestamp == $b->timestamp) {
3161         return 0;
3162     }
3163     return ($a->timestamp < $b->timestamp) ? -1 : 1;