MDL-37009 Deprecated all courses display functions that are not used any more
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->dirroot.'/course/dnduploadlib.php');
32 require_once($CFG->dirroot.'/course/format/lib.php');
34 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
37 /**
38  * Number of courses to display when summaries are included.
39  * @var int
40  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
41  */
42 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
44 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
45 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
46 define('FRONTPAGENEWS',           '0');
47 define('FRONTPAGECOURSELIST',     '1');
48 define('FRONTPAGECATEGORYNAMES',  '2');
49 define('FRONTPAGETOPICONLY',      '3');
50 define('FRONTPAGECATEGORYCOMBO',  '4');
51 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 function make_log_url($module, $url) {
59     switch ($module) {
60         case 'course':
61             if (strpos($url, 'report/') === 0) {
62                 // there is only one report type, course reports are deprecated
63                 $url = "/$url";
64                 break;
65             }
66         case 'file':
67         case 'login':
68         case 'lib':
69         case 'admin':
70         case 'calendar':
71         case 'category':
72         case 'mnet course':
73             if (strpos($url, '../') === 0) {
74                 $url = ltrim($url, '.');
75             } else {
76                 $url = "/course/$url";
77             }
78             break;
79         case 'user':
80         case 'blog':
81             $url = "/$module/$url";
82             break;
83         case 'upload':
84             $url = $url;
85             break;
86         case 'coursetags':
87             $url = '/'.$url;
88             break;
89         case 'library':
90         case '':
91             $url = '/';
92             break;
93         case 'message':
94             $url = "/message/$url";
95             break;
96         case 'notes':
97             $url = "/notes/$url";
98             break;
99         case 'tag':
100             $url = "/tag/$url";
101             break;
102         case 'role':
103             $url = '/'.$url;
104             break;
105         default:
106             $url = "/mod/$module/$url";
107             break;
108     }
110     //now let's sanitise urls - there might be some ugly nasties:-(
111     $parts = explode('?', $url);
112     $script = array_shift($parts);
113     if (strpos($script, 'http') === 0) {
114         $script = clean_param($script, PARAM_URL);
115     } else {
116         $script = clean_param($script, PARAM_PATH);
117     }
119     $query = '';
120     if ($parts) {
121         $query = implode('', $parts);
122         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
123         $parts = explode('&', $query);
124         $eq = urlencode('=');
125         foreach ($parts as $key=>$part) {
126             $part = urlencode(urldecode($part));
127             $part = str_replace($eq, '=', $part);
128             $parts[$key] = $part;
129         }
130         $query = '?'.implode('&amp;', $parts);
131     }
133     return $script.$query;
137 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
138                    $modname="", $modid=0, $modaction="", $groupid=0) {
139     global $CFG, $DB;
141     // It is assumed that $date is the GMT time of midnight for that day,
142     // and so the next 86400 seconds worth of logs are printed.
144     /// Setup for group handling.
146     // TODO: I don't understand group/context/etc. enough to be able to do
147     // something interesting with it here
148     // What is the context of a remote course?
150     /// If the group mode is separate, and this user does not have editing privileges,
151     /// then only the user's group can be viewed.
152     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
153     //    $groupid = get_current_group($course->id);
154     //}
155     /// If this course doesn't have groups, no groupid can be specified.
156     //else if (!$course->groupmode) {
157     //    $groupid = 0;
158     //}
160     $groupid = 0;
162     $joins = array();
163     $where = '';
165     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
166               FROM {mnet_log} l
167                LEFT JOIN {user} u ON l.userid = u.id
168               WHERE ";
169     $params = array();
171     $where .= "l.hostid = :hostid";
172     $params['hostid'] = $hostid;
174     // TODO: Is 1 really a magic number referring to the sitename?
175     if ($course != SITEID || $modid != 0) {
176         $where .= " AND l.course=:courseid";
177         $params['courseid'] = $course;
178     }
180     if ($modname) {
181         $where .= " AND l.module = :modname";
182         $params['modname'] = $modname;
183     }
185     if ('site_errors' === $modid) {
186         $where .= " AND ( l.action='error' OR l.action='infected' )";
187     } else if ($modid) {
188         //TODO: This assumes that modids are the same across sites... probably
189         //not true
190         $where .= " AND l.cmid = :modid";
191         $params['modid'] = $modid;
192     }
194     if ($modaction) {
195         $firstletter = substr($modaction, 0, 1);
196         if ($firstletter == '-') {
197             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
198             $params['modaction'] = '%'.substr($modaction, 1).'%';
199         } else {
200             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
201             $params['modaction'] = '%'.$modaction.'%';
202         }
203     }
205     if ($user) {
206         $where .= " AND l.userid = :user";
207         $params['user'] = $user;
208     }
210     if ($date) {
211         $enddate = $date + 86400;
212         $where .= " AND l.time > :date AND l.time < :enddate";
213         $params['date'] = $date;
214         $params['enddate'] = $enddate;
215     }
217     $result = array();
218     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
219     if(!empty($result['totalcount'])) {
220         $where .= " ORDER BY $order";
221         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
222     } else {
223         $result['logs'] = array();
224     }
225     return $result;
228 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
229                    $modname="", $modid=0, $modaction="", $groupid=0) {
230     global $DB, $SESSION, $USER;
231     // It is assumed that $date is the GMT time of midnight for that day,
232     // and so the next 86400 seconds worth of logs are printed.
234     /// Setup for group handling.
236     /// If the group mode is separate, and this user does not have editing privileges,
237     /// then only the user's group can be viewed.
238     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
239         if (isset($SESSION->currentgroup[$course->id])) {
240             $groupid =  $SESSION->currentgroup[$course->id];
241         } else {
242             $groupid = groups_get_all_groups($course->id, $USER->id);
243             if (is_array($groupid)) {
244                 $groupid = array_shift(array_keys($groupid));
245                 $SESSION->currentgroup[$course->id] = $groupid;
246             } else {
247                 $groupid = 0;
248             }
249         }
250     }
251     /// If this course doesn't have groups, no groupid can be specified.
252     else if (!$course->groupmode) {
253         $groupid = 0;
254     }
256     $joins = array();
257     $params = array();
259     if ($course->id != SITEID || $modid != 0) {
260         $joins[] = "l.course = :courseid";
261         $params['courseid'] = $course->id;
262     }
264     if ($modname) {
265         $joins[] = "l.module = :modname";
266         $params['modname'] = $modname;
267     }
269     if ('site_errors' === $modid) {
270         $joins[] = "( l.action='error' OR l.action='infected' )";
271     } else if ($modid) {
272         $joins[] = "l.cmid = :modid";
273         $params['modid'] = $modid;
274     }
276     if ($modaction) {
277         $firstletter = substr($modaction, 0, 1);
278         if ($firstletter == '-') {
279             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
280             $params['modaction'] = '%'.substr($modaction, 1).'%';
281         } else {
282             $joins[] = $DB->sql_like('l.action', ':modaction', false);
283             $params['modaction'] = '%'.$modaction.'%';
284         }
285     }
288     /// Getting all members of a group.
289     if ($groupid and !$user) {
290         if ($gusers = groups_get_members($groupid)) {
291             $gusers = array_keys($gusers);
292             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
293         } else {
294             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
295         }
296     }
297     else if ($user) {
298         $joins[] = "l.userid = :userid";
299         $params['userid'] = $user;
300     }
302     if ($date) {
303         $enddate = $date + 86400;
304         $joins[] = "l.time > :date AND l.time < :enddate";
305         $params['date'] = $date;
306         $params['enddate'] = $enddate;
307     }
309     $selector = implode(' AND ', $joins);
311     $totalcount = 0;  // Initialise
312     $result = array();
313     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
314     $result['totalcount'] = $totalcount;
315     return $result;
319 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
320                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
322     global $CFG, $DB, $OUTPUT;
324     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
325                        $modname, $modid, $modaction, $groupid)) {
326         echo $OUTPUT->notification("No logs found!");
327         echo $OUTPUT->footer();
328         exit;
329     }
331     $courses = array();
333     if ($course->id == SITEID) {
334         $courses[0] = '';
335         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
336             foreach ($ccc as $cc) {
337                 $courses[$cc->id] = $cc->shortname;
338             }
339         }
340     } else {
341         $courses[$course->id] = $course->shortname;
342     }
344     $totalcount = $logs['totalcount'];
345     $count=0;
346     $ldcache = array();
347     $tt = getdate(time());
348     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
350     $strftimedatetime = get_string("strftimedatetime");
352     echo "<div class=\"info\">\n";
353     print_string("displayingrecords", "", $totalcount);
354     echo "</div>\n";
356     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
358     $table = new html_table();
359     $table->classes = array('logtable','generaltable');
360     $table->align = array('right', 'left', 'left');
361     $table->head = array(
362         get_string('time'),
363         get_string('ip_address'),
364         get_string('fullnameuser'),
365         get_string('action'),
366         get_string('info')
367     );
368     $table->data = array();
370     if ($course->id == SITEID) {
371         array_unshift($table->align, 'left');
372         array_unshift($table->head, get_string('course'));
373     }
375     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
376     if (empty($logs['logs'])) {
377         $logs['logs'] = array();
378     }
380     foreach ($logs['logs'] as $log) {
382         if (isset($ldcache[$log->module][$log->action])) {
383             $ld = $ldcache[$log->module][$log->action];
384         } else {
385             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
386             $ldcache[$log->module][$log->action] = $ld;
387         }
388         if ($ld && is_numeric($log->info)) {
389             // ugly hack to make sure fullname is shown correctly
390             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
391                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
392             } else {
393                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
394             }
395         }
397         //Filter log->info
398         $log->info = format_string($log->info);
400         // If $log->url has been trimmed short by the db size restriction
401         // code in add_to_log, keep a note so we don't add a link to a broken url
402         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
404         $row = array();
405         if ($course->id == SITEID) {
406             if (empty($log->course)) {
407                 $row[] = get_string('site');
408             } else {
409                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
410             }
411         }
413         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
415         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
416         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
418         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id))));
420         $displayaction="$log->module $log->action";
421         if ($brokenurl) {
422             $row[] = $displayaction;
423         } else {
424             $link = make_log_url($log->module,$log->url);
425             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
426         }
427         $row[] = $log->info;
428         $table->data[] = $row;
429     }
431     echo html_writer::table($table);
432     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
436 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
437                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
439     global $CFG, $DB, $OUTPUT;
441     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
442                        $modname, $modid, $modaction, $groupid)) {
443         echo $OUTPUT->notification("No logs found!");
444         echo $OUTPUT->footer();
445         exit;
446     }
448     if ($course->id == SITEID) {
449         $courses[0] = '';
450         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
451             foreach ($ccc as $cc) {
452                 $courses[$cc->id] = $cc->shortname;
453             }
454         }
455     }
457     $totalcount = $logs['totalcount'];
458     $count=0;
459     $ldcache = array();
460     $tt = getdate(time());
461     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
463     $strftimedatetime = get_string("strftimedatetime");
465     echo "<div class=\"info\">\n";
466     print_string("displayingrecords", "", $totalcount);
467     echo "</div>\n";
469     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
471     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
472     echo "<tr>";
473     if ($course->id == SITEID) {
474         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
475     }
476     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
477     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
478     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
479     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
480     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
481     echo "</tr>\n";
483     if (empty($logs['logs'])) {
484         echo "</table>\n";
485         return;
486     }
488     $row = 1;
489     foreach ($logs['logs'] as $log) {
491         $log->info = $log->coursename;
492         $row = ($row + 1) % 2;
494         if (isset($ldcache[$log->module][$log->action])) {
495             $ld = $ldcache[$log->module][$log->action];
496         } else {
497             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
498             $ldcache[$log->module][$log->action] = $ld;
499         }
500         if (0 && $ld && !empty($log->info)) {
501             // ugly hack to make sure fullname is shown correctly
502             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
503                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
504             } else {
505                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
506             }
507         }
509         //Filter log->info
510         $log->info = format_string($log->info);
512         echo '<tr class="r'.$row.'">';
513         if ($course->id == SITEID) {
514             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
515             echo "<td class=\"r$row c0\" >\n";
516             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
517             echo "</td>\n";
518         }
519         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
520              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
521         echo "<td class=\"r$row c2\" >\n";
522         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
523         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
524         echo "</td>\n";
525         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
526         echo "<td class=\"r$row c3\" >\n";
527         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
528         echo "</td>\n";
529         echo "<td class=\"r$row c4\">\n";
530         echo $log->action .': '.$log->module;
531         echo "</td>\n";
532         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
533         echo "</tr>\n";
534     }
535     echo "</table>\n";
537     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
541 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
542                         $modid, $modaction, $groupid) {
543     global $DB, $CFG;
545     require_once($CFG->libdir . '/csvlib.class.php');
547     $csvexporter = new csv_export_writer('tab');
549     $header = array();
550     $header[] = get_string('course');
551     $header[] = get_string('time');
552     $header[] = get_string('ip_address');
553     $header[] = get_string('fullnameuser');
554     $header[] = get_string('action');
555     $header[] = get_string('info');
557     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
558                        $modname, $modid, $modaction, $groupid)) {
559         return false;
560     }
562     $courses = array();
564     if ($course->id == SITEID) {
565         $courses[0] = '';
566         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
567             foreach ($ccc as $cc) {
568                 $courses[$cc->id] = $cc->shortname;
569             }
570         }
571     } else {
572         $courses[$course->id] = $course->shortname;
573     }
575     $count=0;
576     $ldcache = array();
577     $tt = getdate(time());
578     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
580     $strftimedatetime = get_string("strftimedatetime");
582     $csvexporter->set_filename('logs', '.txt');
583     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
584     $csvexporter->add_data($title);
585     $csvexporter->add_data($header);
587     if (empty($logs['logs'])) {
588         return true;
589     }
591     foreach ($logs['logs'] as $log) {
592         if (isset($ldcache[$log->module][$log->action])) {
593             $ld = $ldcache[$log->module][$log->action];
594         } else {
595             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
596             $ldcache[$log->module][$log->action] = $ld;
597         }
598         if ($ld && is_numeric($log->info)) {
599             // ugly hack to make sure fullname is shown correctly
600             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
601                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
602             } else {
603                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
604             }
605         }
607         //Filter log->info
608         $log->info = format_string($log->info);
609         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
611         $coursecontext = context_course::instance($course->id);
612         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
613         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
614         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
615         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
616         $csvexporter->add_data($row);
617     }
618     $csvexporter->download_file();
619     return true;
623 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
624                         $modid, $modaction, $groupid) {
626     global $CFG, $DB;
628     require_once("$CFG->libdir/excellib.class.php");
630     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
631                        $modname, $modid, $modaction, $groupid)) {
632         return false;
633     }
635     $courses = array();
637     if ($course->id == SITEID) {
638         $courses[0] = '';
639         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
640             foreach ($ccc as $cc) {
641                 $courses[$cc->id] = $cc->shortname;
642             }
643         }
644     } else {
645         $courses[$course->id] = $course->shortname;
646     }
648     $count=0;
649     $ldcache = array();
650     $tt = getdate(time());
651     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
653     $strftimedatetime = get_string("strftimedatetime");
655     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
656     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
657     $filename .= '.xls';
659     $workbook = new MoodleExcelWorkbook('-');
660     $workbook->send($filename);
662     $worksheet = array();
663     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
664                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
666     // Creating worksheets
667     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
668         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
669         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
670         $worksheet[$wsnumber]->set_column(1, 1, 30);
671         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
672                                     userdate(time(), $strftimedatetime));
673         $col = 0;
674         foreach ($headers as $item) {
675             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
676             $col++;
677         }
678     }
680     if (empty($logs['logs'])) {
681         $workbook->close();
682         return true;
683     }
685     $formatDate =& $workbook->add_format();
686     $formatDate->set_num_format(get_string('log_excel_date_format'));
688     $row = FIRSTUSEDEXCELROW;
689     $wsnumber = 1;
690     $myxls =& $worksheet[$wsnumber];
691     foreach ($logs['logs'] as $log) {
692         if (isset($ldcache[$log->module][$log->action])) {
693             $ld = $ldcache[$log->module][$log->action];
694         } else {
695             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
696             $ldcache[$log->module][$log->action] = $ld;
697         }
698         if ($ld && is_numeric($log->info)) {
699             // ugly hack to make sure fullname is shown correctly
700             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
701                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
702             } else {
703                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
704             }
705         }
707         // Filter log->info
708         $log->info = format_string($log->info);
709         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
711         if ($nroPages>1) {
712             if ($row > EXCELROWS) {
713                 $wsnumber++;
714                 $myxls =& $worksheet[$wsnumber];
715                 $row = FIRSTUSEDEXCELROW;
716             }
717         }
719         $coursecontext = context_course::instance($course->id);
721         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
722         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
723         $myxls->write($row, 2, $log->ip, '');
724         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
725         $myxls->write($row, 3, $fullname, '');
726         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
727         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
728         $myxls->write($row, 5, $log->info, '');
730         $row++;
731     }
733     $workbook->close();
734     return true;
737 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
738                         $modid, $modaction, $groupid) {
740     global $CFG, $DB;
742     require_once("$CFG->libdir/odslib.class.php");
744     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
745                        $modname, $modid, $modaction, $groupid)) {
746         return false;
747     }
749     $courses = array();
751     if ($course->id == SITEID) {
752         $courses[0] = '';
753         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
754             foreach ($ccc as $cc) {
755                 $courses[$cc->id] = $cc->shortname;
756             }
757         }
758     } else {
759         $courses[$course->id] = $course->shortname;
760     }
762     $count=0;
763     $ldcache = array();
764     $tt = getdate(time());
765     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
767     $strftimedatetime = get_string("strftimedatetime");
769     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
770     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
771     $filename .= '.ods';
773     $workbook = new MoodleODSWorkbook('-');
774     $workbook->send($filename);
776     $worksheet = array();
777     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
778                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
780     // Creating worksheets
781     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
782         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
783         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
784         $worksheet[$wsnumber]->set_column(1, 1, 30);
785         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
786                                     userdate(time(), $strftimedatetime));
787         $col = 0;
788         foreach ($headers as $item) {
789             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
790             $col++;
791         }
792     }
794     if (empty($logs['logs'])) {
795         $workbook->close();
796         return true;
797     }
799     $formatDate =& $workbook->add_format();
800     $formatDate->set_num_format(get_string('log_excel_date_format'));
802     $row = FIRSTUSEDEXCELROW;
803     $wsnumber = 1;
804     $myxls =& $worksheet[$wsnumber];
805     foreach ($logs['logs'] as $log) {
806         if (isset($ldcache[$log->module][$log->action])) {
807             $ld = $ldcache[$log->module][$log->action];
808         } else {
809             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
810             $ldcache[$log->module][$log->action] = $ld;
811         }
812         if ($ld && is_numeric($log->info)) {
813             // ugly hack to make sure fullname is shown correctly
814             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
815                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
816             } else {
817                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
818             }
819         }
821         // Filter log->info
822         $log->info = format_string($log->info);
823         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
825         if ($nroPages>1) {
826             if ($row > EXCELROWS) {
827                 $wsnumber++;
828                 $myxls =& $worksheet[$wsnumber];
829                 $row = FIRSTUSEDEXCELROW;
830             }
831         }
833         $coursecontext = context_course::instance($course->id);
835         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
836         $myxls->write_date($row, 1, $log->time);
837         $myxls->write_string($row, 2, $log->ip);
838         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
839         $myxls->write_string($row, 3, $fullname);
840         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
841         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
842         $myxls->write_string($row, 5, $log->info);
844         $row++;
845     }
847     $workbook->close();
848     return true;
851 /**
852  * For a given course, returns an array of course activity objects
853  * Each item in the array contains he following properties:
854  */
855 function get_array_of_activities($courseid) {
856 //  cm - course module id
857 //  mod - name of the module (eg forum)
858 //  section - the number of the section (eg week or topic)
859 //  name - the name of the instance
860 //  visible - is the instance visible or not
861 //  groupingid - grouping id
862 //  groupmembersonly - is this instance visible to group members only
863 //  extra - contains extra string to include in any link
864     global $CFG, $DB;
865     if(!empty($CFG->enableavailability)) {
866         require_once($CFG->libdir.'/conditionlib.php');
867     }
869     $course = $DB->get_record('course', array('id'=>$courseid));
871     if (empty($course)) {
872         throw new moodle_exception('courseidnotfound');
873     }
875     $mod = array();
877     $rawmods = get_course_mods($courseid);
878     if (empty($rawmods)) {
879         return $mod; // always return array
880     }
882     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
883        foreach ($sections as $section) {
884            if (!empty($section->sequence)) {
885                $sequence = explode(",", $section->sequence);
886                foreach ($sequence as $seq) {
887                    if (empty($rawmods[$seq])) {
888                        continue;
889                    }
890                    $mod[$seq] = new stdClass();
891                    $mod[$seq]->id               = $rawmods[$seq]->instance;
892                    $mod[$seq]->cm               = $rawmods[$seq]->id;
893                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
895                     // Oh dear. Inconsistent names left here for backward compatibility.
896                    $mod[$seq]->section          = $section->section;
897                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
899                    $mod[$seq]->module           = $rawmods[$seq]->module;
900                    $mod[$seq]->added            = $rawmods[$seq]->added;
901                    $mod[$seq]->score            = $rawmods[$seq]->score;
902                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
903                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
904                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
905                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
906                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
907                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
908                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
909                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
910                    $mod[$seq]->extra            = "";
911                    $mod[$seq]->completiongradeitemnumber =
912                            $rawmods[$seq]->completiongradeitemnumber;
913                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
914                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
915                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
916                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
917                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
918                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
919                    if (!empty($CFG->enableavailability)) {
920                        condition_info::fill_availability_conditions($rawmods[$seq]);
921                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
922                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
923                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
924                    }
926                    $modname = $mod[$seq]->mod;
927                    $functionname = $modname."_get_coursemodule_info";
929                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
930                        continue;
931                    }
933                    include_once("$CFG->dirroot/mod/$modname/lib.php");
935                    if ($hasfunction = function_exists($functionname)) {
936                        if ($info = $functionname($rawmods[$seq])) {
937                            if (!empty($info->icon)) {
938                                $mod[$seq]->icon = $info->icon;
939                            }
940                            if (!empty($info->iconcomponent)) {
941                                $mod[$seq]->iconcomponent = $info->iconcomponent;
942                            }
943                            if (!empty($info->name)) {
944                                $mod[$seq]->name = $info->name;
945                            }
946                            if ($info instanceof cached_cm_info) {
947                                // When using cached_cm_info you can include three new fields
948                                // that aren't available for legacy code
949                                if (!empty($info->content)) {
950                                    $mod[$seq]->content = $info->content;
951                                }
952                                if (!empty($info->extraclasses)) {
953                                    $mod[$seq]->extraclasses = $info->extraclasses;
954                                }
955                                if (!empty($info->iconurl)) {
956                                    $mod[$seq]->iconurl = $info->iconurl;
957                                }
958                                if (!empty($info->onclick)) {
959                                    $mod[$seq]->onclick = $info->onclick;
960                                }
961                                if (!empty($info->customdata)) {
962                                    $mod[$seq]->customdata = $info->customdata;
963                                }
964                            } else {
965                                // When using a stdclass, the (horrible) deprecated ->extra field
966                                // is available for BC
967                                if (!empty($info->extra)) {
968                                    $mod[$seq]->extra = $info->extra;
969                                }
970                            }
971                        }
972                    }
973                    // When there is no modname_get_coursemodule_info function,
974                    // but showdescriptions is enabled, then we use the 'intro'
975                    // and 'introformat' fields in the module table
976                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
977                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
978                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
979                            // Set content from intro and introformat. Filters are disabled
980                            // because we  filter it with format_text at display time
981                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
982                                    $modvalues, $rawmods[$seq]->id, false);
984                            // To save making another query just below, put name in here
985                            $mod[$seq]->name = $modvalues->name;
986                        }
987                    }
988                    if (!isset($mod[$seq]->name)) {
989                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
990                    }
992                    // Minimise the database size by unsetting default options when they are
993                    // 'empty'. This list corresponds to code in the cm_info constructor.
994                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
995                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
996                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
997                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
998                            'completionview', 'completionexpected', 'score', 'showdescription')
999                            as $property) {
1000                        if (property_exists($mod[$seq], $property) &&
1001                                empty($mod[$seq]->{$property})) {
1002                            unset($mod[$seq]->{$property});
1003                        }
1004                    }
1005                    // Special case: this value is usually set to null, but may be 0
1006                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1007                            is_null($mod[$seq]->completiongradeitemnumber)) {
1008                        unset($mod[$seq]->completiongradeitemnumber);
1009                    }
1010                }
1011             }
1012         }
1013     }
1014     return $mod;
1017 /**
1018  * Returns the localised human-readable names of all used modules
1019  *
1020  * @param bool $plural if true returns the plural forms of the names
1021  * @return array where key is the module name (component name without 'mod_') and
1022  *     the value is the human-readable string. Array sorted alphabetically by value
1023  */
1024 function get_module_types_names($plural = false) {
1025     static $modnames = null;
1026     global $DB, $CFG;
1027     if ($modnames === null) {
1028         $modnames = array(0 => array(), 1 => array());
1029         if ($allmods = $DB->get_records("modules")) {
1030             foreach ($allmods as $mod) {
1031                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1032                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1033                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1034                 }
1035             }
1036             collatorlib::asort($modnames[0]);
1037             collatorlib::asort($modnames[1]);
1038         }
1039     }
1040     return $modnames[(int)$plural];
1043 /**
1044  * Set highlighted section. Only one section can be highlighted at the time.
1045  *
1046  * @param int $courseid course id
1047  * @param int $marker highlight section with this number, 0 means remove higlightin
1048  * @return void
1049  */
1050 function course_set_marker($courseid, $marker) {
1051     global $DB;
1052     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1053     format_base::reset_course_cache($courseid);
1056 /**
1057  * For a given course section, marks it visible or hidden,
1058  * and does the same for every activity in that section
1059  *
1060  * @param int $courseid course id
1061  * @param int $sectionnumber The section number to adjust
1062  * @param int $visibility The new visibility
1063  * @return array A list of resources which were hidden in the section
1064  */
1065 function set_section_visible($courseid, $sectionnumber, $visibility) {
1066     global $DB;
1068     $resourcestotoggle = array();
1069     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1070         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1071         if (!empty($section->sequence)) {
1072             $modules = explode(",", $section->sequence);
1073             foreach ($modules as $moduleid) {
1074                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1075                     if ($visibility) {
1076                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1077                         set_coursemodule_visible($moduleid, $cm->visibleold);
1078                     } else {
1079                         // We hide the section, so we hide the module but we store the original state in visibleold.
1080                         set_coursemodule_visible($moduleid, 0);
1081                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1082                     }
1083                 }
1084             }
1085         }
1086         rebuild_course_cache($courseid, true);
1088         // Determine which modules are visible for AJAX update
1089         if (!empty($modules)) {
1090             list($insql, $params) = $DB->get_in_or_equal($modules);
1091             $select = 'id ' . $insql . ' AND visible = ?';
1092             array_push($params, $visibility);
1093             if (!$visibility) {
1094                 $select .= ' AND visibleold = 1';
1095             }
1096             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1097         }
1098     }
1099     return $resourcestotoggle;
1102 /**
1103  * Retrieve all metadata for the requested modules
1104  *
1105  * @param object $course The Course
1106  * @param array $modnames An array containing the list of modules and their
1107  * names
1108  * @param int $sectionreturn The section to return to
1109  * @return array A list of stdClass objects containing metadata about each
1110  * module
1111  */
1112 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1113     global $CFG, $OUTPUT;
1115     // get_module_metadata will be called once per section on the page and courses may show
1116     // different modules to one another
1117     static $modlist = array();
1118     if (!isset($modlist[$course->id])) {
1119         $modlist[$course->id] = array();
1120     }
1122     $return = array();
1123     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1124     if ($sectionreturn !== null) {
1125         $urlbase->param('sr', $sectionreturn);
1126     }
1127     foreach($modnames as $modname => $modnamestr) {
1128         if (!course_allowed_module($course, $modname)) {
1129             continue;
1130         }
1131         if (isset($modlist[$course->id][$modname])) {
1132             // This module is already cached
1133             $return[$modname] = $modlist[$course->id][$modname];
1134             continue;
1135         }
1137         // Include the module lib
1138         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1139         if (!file_exists($libfile)) {
1140             continue;
1141         }
1142         include_once($libfile);
1144         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1145         $gettypesfunc =  $modname.'_get_types';
1146         if (function_exists($gettypesfunc)) {
1147             $types = $gettypesfunc();
1148             if (is_array($types) && count($types) > 0) {
1149                 $group = new stdClass();
1150                 $group->name = $modname;
1151                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1152                 foreach($types as $type) {
1153                     if ($type->typestr === '--') {
1154                         continue;
1155                     }
1156                     if (strpos($type->typestr, '--') === 0) {
1157                         $group->title = str_replace('--', '', $type->typestr);
1158                         continue;
1159                     }
1160                     // Set the Sub Type metadata
1161                     $subtype = new stdClass();
1162                     $subtype->title = $type->typestr;
1163                     $subtype->type = str_replace('&amp;', '&', $type->type);
1164                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1165                     $subtype->archetype = $type->modclass;
1167                     // The group archetype should match the subtype archetypes and all subtypes
1168                     // should have the same archetype
1169                     $group->archetype = $subtype->archetype;
1171                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1172                         $subtype->help = get_string('help' . $subtype->name, $modname);
1173                     }
1174                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1175                     $group->types[] = $subtype;
1176                 }
1177                 $modlist[$course->id][$modname] = $group;
1178             }
1179         } else {
1180             $module = new stdClass();
1181             $module->title = $modnamestr;
1182             $module->name = $modname;
1183             $module->link = new moodle_url($urlbase, array('add' => $modname));
1184             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1185             $sm = get_string_manager();
1186             if ($sm->string_exists('modulename_help', $modname)) {
1187                 $module->help = get_string('modulename_help', $modname);
1188                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1189                     $link = get_string('modulename_link', $modname);
1190                     $linktext = get_string('morehelp');
1191                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1192                 }
1193             }
1194             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1195             $modlist[$course->id][$modname] = $module;
1196         }
1197         if (isset($modlist[$course->id][$modname])) {
1198             $return[$modname] = $modlist[$course->id][$modname];
1199         } else {
1200             debugging("Invalid module metadata configuration for {$modname}");
1201         }
1202     }
1204     return $return;
1207 /**
1208  * Return the course category context for the category with id $categoryid, except
1209  * that if $categoryid is 0, return the system context.
1210  *
1211  * @param integer $categoryid a category id or 0.
1212  * @return object the corresponding context
1213  */
1214 function get_category_or_system_context($categoryid) {
1215     if ($categoryid) {
1216         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1217     } else {
1218         return context_system::instance();
1219     }
1222 /**
1223  * Returns full course categories trees to be used in html_writer::select()
1224  *
1225  * Calls {@link coursecat::make_categories_list()} to build the tree and
1226  * adds whitespace to denote nesting
1227  *
1228  * @return array array mapping coursecat id to the display name
1229  */
1230 function make_categories_options() {
1231     global $CFG;
1232     require_once($CFG->libdir. '/coursecatlib.php');
1233     $cats = coursecat::make_categories_list();
1234     foreach ($cats as $key => $value) {
1235         $cats[$key] = str_repeat('&nbsp;', coursecat::get($key)->depth - 1). $value;
1236     }
1237     return $cats;
1240 /**
1241  * Print the buttons relating to course requests.
1242  *
1243  * @param object $context current page context.
1244  */
1245 function print_course_request_buttons($context) {
1246     global $CFG, $DB, $OUTPUT;
1247     if (empty($CFG->enablecourserequests)) {
1248         return;
1249     }
1250     if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
1251     /// Print a button to request a new course
1252         echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
1253     }
1254     /// Print a button to manage pending requests
1255     if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
1256         $disabled = !$DB->record_exists('course_request', array());
1257         echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
1258     }
1261 /**
1262  * Does the user have permission to edit things in this category?
1263  *
1264  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1265  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1266  */
1267 function can_edit_in_category($categoryid = 0) {
1268     $context = get_category_or_system_context($categoryid);
1269     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1272 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1274 function add_course_module($mod) {
1275     global $DB;
1277     $mod->added = time();
1278     unset($mod->id);
1280     $cmid = $DB->insert_record("course_modules", $mod);
1281     rebuild_course_cache($mod->course, true);
1282     return $cmid;
1285 /**
1286  * Creates missing course section(s) and rebuilds course cache
1287  *
1288  * @param int|stdClass $courseorid course id or course object
1289  * @param int|array $sections list of relative section numbers to create
1290  * @return bool if there were any sections created
1291  */
1292 function course_create_sections_if_missing($courseorid, $sections) {
1293     global $DB;
1294     if (!is_array($sections)) {
1295         $sections = array($sections);
1296     }
1297     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1298     if (is_object($courseorid)) {
1299         $courseorid = $courseorid->id;
1300     }
1301     $coursechanged = false;
1302     foreach ($sections as $sectionnum) {
1303         if (!in_array($sectionnum, $existing)) {
1304             $cw = new stdClass();
1305             $cw->course   = $courseorid;
1306             $cw->section  = $sectionnum;
1307             $cw->summary  = '';
1308             $cw->summaryformat = FORMAT_HTML;
1309             $cw->sequence = '';
1310             $id = $DB->insert_record("course_sections", $cw);
1311             $coursechanged = true;
1312         }
1313     }
1314     if ($coursechanged) {
1315         rebuild_course_cache($courseorid, true);
1316     }
1317     return $coursechanged;
1320 /**
1321  * Adds an existing module to the section
1322  *
1323  * Updates both tables {course_sections} and {course_modules}
1324  *
1325  * @param int|stdClass $courseorid course id or course object
1326  * @param int $cmid id of the module already existing in course_modules table
1327  * @param int $sectionnum relative number of the section (field course_sections.section)
1328  *     If section does not exist it will be created
1329  * @param int|stdClass $beforemod id or object with field id corresponding to the module
1330  *     before which the module needs to be included. Null for inserting in the
1331  *     end of the section
1332  * @return int The course_sections ID where the module is inserted
1333  */
1334 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
1335     global $DB, $COURSE;
1336     if (is_object($beforemod)) {
1337         $beforemod = $beforemod->id;
1338     }
1339     if (is_object($courseorid)) {
1340         $courseid = $courseorid->id;
1341     } else {
1342         $courseid = $courseorid;
1343     }
1344     course_create_sections_if_missing($courseorid, $sectionnum);
1345     // Do not try to use modinfo here, there is no guarantee it is valid!
1346     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
1347     $modarray = explode(",", trim($section->sequence));
1348     if (empty($section->sequence)) {
1349         $newsequence = "$cmid";
1350     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
1351         $insertarray = array($cmid, $beforemod);
1352         array_splice($modarray, $key[0], 1, $insertarray);
1353         $newsequence = implode(",", $modarray);
1354     } else {
1355         $newsequence = "$section->sequence,$cmid";
1356     }
1357     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
1358     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
1359     if (is_object($courseorid)) {
1360         rebuild_course_cache($courseorid->id, true);
1361     } else {
1362         rebuild_course_cache($courseorid, true);
1363     }
1364     return $section->id;     // Return course_sections ID that was used.
1367 function set_coursemodule_groupmode($id, $groupmode) {
1368     global $DB;
1369     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1370     if ($cm->groupmode != $groupmode) {
1371         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1372         rebuild_course_cache($cm->course, true);
1373     }
1374     return ($cm->groupmode != $groupmode);
1377 function set_coursemodule_idnumber($id, $idnumber) {
1378     global $DB;
1379     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1380     if ($cm->idnumber != $idnumber) {
1381         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1382         rebuild_course_cache($cm->course, true);
1383     }
1384     return ($cm->idnumber != $idnumber);
1387 /**
1388  * Set the visibility of a module and inherent properties.
1389  *
1390  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1391  * has been moved to {@link set_section_visible()} which was the only place from which
1392  * the parameter was used.
1393  *
1394  * @param int $id of the module
1395  * @param int $visible state of the module
1396  * @return bool false when the module was not found, true otherwise
1397  */
1398 function set_coursemodule_visible($id, $visible) {
1399     global $DB, $CFG;
1400     require_once($CFG->libdir.'/gradelib.php');
1402     // Trigger developer's attention when using the previously removed argument.
1403     if (func_num_args() > 2) {
1404         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1405             has been removed.', DEBUG_DEVELOPER);
1406     }
1408     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
1409         return false;
1410     }
1412     // Create events and propagate visibility to associated grade items if the value has changed.
1413     // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1414     if ($cm->visible == $visible) {
1415         return true;
1416     }
1418     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
1419         return false;
1420     }
1421     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
1422         foreach($events as $event) {
1423             if ($visible) {
1424                 show_event($event);
1425             } else {
1426                 hide_event($event);
1427             }
1428         }
1429     }
1431     // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1432     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1433     if ($grade_items) {
1434         foreach ($grade_items as $grade_item) {
1435             $grade_item->set_hidden(!$visible);
1436         }
1437     }
1439     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1440     // affect visibleold to allow for an original visibility restore. See set_section_visible().
1441     $cminfo = new stdClass();
1442     $cminfo->id = $id;
1443     $cminfo->visible = $visible;
1444     $cminfo->visibleold = $visible;
1445     $DB->update_record('course_modules', $cminfo);
1447     rebuild_course_cache($cm->course, true);
1448     return true;
1451 /**
1452  * This function will handles the whole deletion process of a module. This includes calling
1453  * the modules delete_instance function, deleting files, events, grades, conditional data,
1454  * the data in the course_module and course_sections table and adding a module deletion
1455  * event to the DB.
1456  *
1457  * @param int $cmid the course module id
1458  * @since 2.5
1459  */
1460 function course_delete_module($cmid) {
1461     global $CFG, $DB, $USER;
1463     require_once($CFG->libdir.'/gradelib.php');
1464     require_once($CFG->dirroot.'/blog/lib.php');
1466     // Get the course module.
1467     if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
1468         return true;
1469     }
1471     // Get the module context.
1472     $modcontext = context_module::instance($cm->id);
1474     // Get the course module name.
1475     $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1477     // Get the file location of the delete_instance function for this module.
1478     $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1480     // Include the file required to call the delete_instance function for this module.
1481     if (file_exists($modlib)) {
1482         require_once($modlib);
1483     } else {
1484         throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1485             "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
1486     }
1488     $deleteinstancefunction = $modulename . '_delete_instance';
1490     // Ensure the delete_instance function exists for this module.
1491     if (!function_exists($deleteinstancefunction)) {
1492         throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1493             "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1494     }
1496     // Call the delete_instance function, if it returns false throw an exception.
1497     if (!$deleteinstancefunction($cm->instance)) {
1498         throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1499             "Cannot delete the module $modulename (instance).");
1500     }
1502     // Remove all module files in case modules forget to do that.
1503     $fs = get_file_storage();
1504     $fs->delete_area_files($modcontext->id);
1506     // Delete events from calendar.
1507     if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
1508         foreach($events as $event) {
1509             delete_event($event->id);
1510         }
1511     }
1513     // Delete grade items, outcome items and grades attached to modules.
1514     if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1515                                                    'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
1516         foreach ($grade_items as $grade_item) {
1517             $grade_item->delete('moddelete');
1518         }
1519     }
1521     // Delete completion and availability data; it is better to do this even if the
1522     // features are not turned on, in case they were turned on previously (these will be
1523     // very quick on an empty table).
1524     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1525     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
1526     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
1527     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1528                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
1530     // Delete the context.
1531     delete_context(CONTEXT_MODULE, $cm->id);
1533     // Delete the module from the course_modules table.
1534     $DB->delete_records('course_modules', array('id' => $cm->id));
1536     // Delete module from that section.
1537     if (!delete_mod_from_section($cm->id, $cm->section)) {
1538         throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1539             "Cannot delete the module $modulename (instance) from section.");
1540     }
1542     // Trigger a mod_deleted event with information about this module.
1543     $eventdata = new stdClass();
1544     $eventdata->modulename = $modulename;
1545     $eventdata->cmid       = $cm->id;
1546     $eventdata->courseid   = $cm->course;
1547     $eventdata->userid     = $USER->id;
1548     events_trigger('mod_deleted', $eventdata);
1550     add_to_log($cm->course, 'course', "delete mod",
1551                "view.php?id=$cm->course",
1552                "$modulename $cm->instance", $cm->id);
1554     rebuild_course_cache($cm->course, true);
1557 function delete_mod_from_section($modid, $sectionid) {
1558     global $DB;
1560     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
1562         $modarray = explode(",", $section->sequence);
1564         if ($key = array_keys ($modarray, $modid)) {
1565             array_splice($modarray, $key[0], 1);
1566             $newsequence = implode(",", $modarray);
1567             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1568             rebuild_course_cache($section->course, true);
1569             return true;
1570         } else {
1571             return false;
1572         }
1574     }
1575     return false;
1578 /**
1579  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
1580  *
1581  * @param object $course course object
1582  * @param int $section Section number (not id!!!)
1583  * @param int $move (-1 or 1)
1584  * @return boolean true if section moved successfully
1585  * @todo MDL-33379 remove this function in 2.5
1586  */
1587 function move_section($course, $section, $move) {
1588     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
1590 /// Moves a whole course section up and down within the course
1591     global $USER;
1593     if (!$move) {
1594         return true;
1595     }
1597     $sectiondest = $section + $move;
1599     // compartibility with course formats using field 'numsections'
1600     $courseformatoptions = course_get_format($course)->get_format_options();
1601     if (array_key_exists('numsections', $courseformatoptions) &&
1602             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
1603         return false;
1604     }
1606     $retval = move_section_to($course, $section, $sectiondest);
1607     return $retval;
1610 /**
1611  * Moves a section within a course, from a position to another.
1612  * Be very careful: $section and $destination refer to section number,
1613  * not id!.
1614  *
1615  * @param object $course
1616  * @param int $section Section number (not id!!!)
1617  * @param int $destination
1618  * @return boolean Result
1619  */
1620 function move_section_to($course, $section, $destination) {
1621 /// Moves a whole course section up and down within the course
1622     global $USER, $DB;
1624     if (!$destination && $destination != 0) {
1625         return true;
1626     }
1628     // compartibility with course formats using field 'numsections'
1629     $courseformatoptions = course_get_format($course)->get_format_options();
1630     if ((array_key_exists('numsections', $courseformatoptions) &&
1631             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
1632         return false;
1633     }
1635     // Get all sections for this course and re-order them (2 of them should now share the same section number)
1636     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1637             'section ASC, id ASC', 'id, section')) {
1638         return false;
1639     }
1641     $movedsections = reorder_sections($sections, $section, $destination);
1643     // Update all sections. Do this in 2 steps to avoid breaking database
1644     // uniqueness constraint
1645     $transaction = $DB->start_delegated_transaction();
1646     foreach ($movedsections as $id => $position) {
1647         if ($sections[$id] !== $position) {
1648             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1649         }
1650     }
1651     foreach ($movedsections as $id => $position) {
1652         if ($sections[$id] !== $position) {
1653             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1654         }
1655     }
1657     // If we move the highlighted section itself, then just highlight the destination.
1658     // Adjust the higlighted section location if we move something over it either direction.
1659     if ($section == $course->marker) {
1660         course_set_marker($course->id, $destination);
1661     } elseif ($section > $course->marker && $course->marker >= $destination) {
1662         course_set_marker($course->id, $course->marker+1);
1663     } elseif ($section < $course->marker && $course->marker <= $destination) {
1664         course_set_marker($course->id, $course->marker-1);
1665     }
1667     $transaction->allow_commit();
1668     rebuild_course_cache($course->id, true);
1669     return true;
1672 /**
1673  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1674  * an original position number and a target position number, rebuilds the array so that the
1675  * move is made without any duplication of section positions.
1676  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1677  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1678  *
1679  * @param array $sections
1680  * @param int $origin_position
1681  * @param int $target_position
1682  * @return array
1683  */
1684 function reorder_sections($sections, $origin_position, $target_position) {
1685     if (!is_array($sections)) {
1686         return false;
1687     }
1689     // We can't move section position 0
1690     if ($origin_position < 1) {
1691         echo "We can't move section position 0";
1692         return false;
1693     }
1695     // Locate origin section in sections array
1696     if (!$origin_key = array_search($origin_position, $sections)) {
1697         echo "searched position not in sections array";
1698         return false; // searched position not in sections array
1699     }
1701     // Extract origin section
1702     $origin_section = $sections[$origin_key];
1703     unset($sections[$origin_key]);
1705     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1706     $found = false;
1707     $append_array = array();
1708     foreach ($sections as $id => $position) {
1709         if ($found) {
1710             $append_array[$id] = $position;
1711             unset($sections[$id]);
1712         }
1713         if ($position == $target_position) {
1714             if ($target_position < $origin_position) {
1715                 $append_array[$id] = $position;
1716                 unset($sections[$id]);
1717             }
1718             $found = true;
1719         }
1720     }
1722     // Append moved section
1723     $sections[$origin_key] = $origin_section;
1725     // Append rest of array (if applicable)
1726     if (!empty($append_array)) {
1727         foreach ($append_array as $id => $position) {
1728             $sections[$id] = $position;
1729         }
1730     }
1732     // Renumber positions
1733     $position = 0;
1734     foreach ($sections as $id => $p) {
1735         $sections[$id] = $position;
1736         $position++;
1737     }
1739     return $sections;
1743 /**
1744  * Move the module object $mod to the specified $section
1745  * If $beforemod exists then that is the module
1746  * before which $modid should be inserted
1747  * All parameters are objects
1748  */
1749 function moveto_module($mod, $section, $beforemod=NULL) {
1750     global $OUTPUT, $DB;
1752 /// Remove original module from original section
1753     if (! delete_mod_from_section($mod->id, $mod->section)) {
1754         echo $OUTPUT->notification("Could not delete module from existing section");
1755     }
1757     // if moving to a hidden section then hide module
1758     if (!$section->visible && $mod->visible) {
1759         // Set this in the object because it is sent as a response to ajax calls.
1760         $mod->visible = 0;
1761         set_coursemodule_visible($mod->id, 0);
1762         // Set visibleold to 1 so module will be visible when section is made visible.
1763         $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1764     }
1765     if ($section->visible && !$mod->visible) {
1766         set_coursemodule_visible($mod->id, $mod->visibleold);
1767         // Set this in the object because it is sent as a response to ajax calls.
1768         $mod->visible = $mod->visibleold;
1769     }
1771 /// Add the module into the new section
1772     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
1773     return true;
1776 /**
1777  * Returns the list of all editing actions that current user can perform on the module
1778  *
1779  * @param cm_info $mod The module to produce editing buttons for
1780  * @param int $indent The current indenting (default -1 means no move left-right actions)
1781  * @param int $sr The section to link back to (used for creating the links)
1782  * @return array array of action_link or pix_icon objects
1783  */
1784 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
1785     global $COURSE, $SITE;
1787     static $str;
1789     $coursecontext = context_course::instance($mod->course);
1790     $modcontext = context_module::instance($mod->id);
1792     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1793     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1795     // no permission to edit anything
1796     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
1797         return array();
1798     }
1800     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1802     if (!isset($str)) {
1803         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1804             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
1805         $str->assign         = get_string('assignroles', 'role');
1806         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1807         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1808         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1809         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
1810         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
1811         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
1812     }
1814     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
1816     if ($sr !== null) {
1817         $baseurl->param('sr', $sr);
1818     }
1819     $actions = array();
1821     // AJAX edit title
1822     if ($mod->has_view() && $hasmanageactivities &&
1823                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
1824                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
1825         // we will not display link if we are on some other-course page (where we should not see this module anyway)
1826         $actions['title'] = new action_link(
1827             new moodle_url($baseurl, array('update' => $mod->id)),
1828             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
1829             null,
1830             array('class' => 'editing_title', 'title' => $str->edittitle)
1831         );
1832     }
1834     // leftright
1835     if ($hasmanageactivities) {
1836         if (right_to_left()) {   // Exchange arrows on RTL
1837             $rightarrow = 't/left';
1838             $leftarrow  = 't/right';
1839         } else {
1840             $rightarrow = 't/right';
1841             $leftarrow  = 't/left';
1842         }
1844         if ($indent > 0) {
1845             $actions['moveleft'] = new action_link(
1846                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
1847                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1848                 null,
1849                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
1850             );
1851         }
1852         if ($indent >= 0) {
1853             $actions['moveright'] = new action_link(
1854                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
1855                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1856                 null,
1857                 array('class' => 'editing_moveright', 'title' => $str->moveright)
1858             );
1859         }
1860     }
1862     // move
1863     if ($hasmanageactivities) {
1864         $actions['move'] = new action_link(
1865             new moodle_url($baseurl, array('copy' => $mod->id)),
1866             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1867             null,
1868             array('class' => 'editing_move', 'title' => $str->move)
1869         );
1870     }
1872     // Update
1873     if ($hasmanageactivities) {
1874         $actions['update'] = new action_link(
1875             new moodle_url($baseurl, array('update' => $mod->id)),
1876             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1877             null,
1878             array('class' => 'editing_update', 'title' => $str->update)
1879         );
1880     }
1882     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
1883     // note that restoring on front page is never allowed
1884     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
1885             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
1886         $actions['duplicate'] = new action_link(
1887             new moodle_url($baseurl, array('duplicate' => $mod->id)),
1888             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1889             null,
1890             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
1891         );
1892     }
1894     // Delete
1895     if ($hasmanageactivities) {
1896         $actions['delete'] = new action_link(
1897             new moodle_url($baseurl, array('delete' => $mod->id)),
1898             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1899             null,
1900             array('class' => 'editing_delete', 'title' => $str->delete)
1901         );
1902     }
1904     // hideshow
1905     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1906         if ($mod->visible) {
1907             $actions['hide'] = new action_link(
1908                 new moodle_url($baseurl, array('hide' => $mod->id)),
1909                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1910                 null,
1911                 array('class' => 'editing_hide', 'title' => $str->hide)
1912             );
1913         } else {
1914             $actions['show'] = new action_link(
1915                 new moodle_url($baseurl, array('show' => $mod->id)),
1916                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1917                 null,
1918                 array('class' => 'editing_show', 'title' => $str->show)
1919             );
1920         }
1921     }
1923     // groupmode
1924     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1925         if ($mod->coursegroupmodeforce) {
1926             $modgroupmode = $mod->coursegroupmode;
1927         } else {
1928             $modgroupmode = $mod->groupmode;
1929         }
1930         if ($modgroupmode == SEPARATEGROUPS) {
1931             $groupmode = NOGROUPS;
1932             $grouptitle = $str->groupsseparate;
1933             $forcedgrouptitle = $str->forcedgroupsseparate;
1934             $actionname = 'groupsseparate';
1935             $groupimage = 't/groups';
1936         } else if ($modgroupmode == VISIBLEGROUPS) {
1937             $groupmode = SEPARATEGROUPS;
1938             $grouptitle = $str->groupsvisible;
1939             $forcedgrouptitle = $str->forcedgroupsvisible;
1940             $actionname = 'groupsvisible';
1941             $groupimage = 't/groupv';
1942         } else {
1943             $groupmode = VISIBLEGROUPS;
1944             $grouptitle = $str->groupsnone;
1945             $forcedgrouptitle = $str->forcedgroupsnone;
1946             $actionname = 'groupsnone';
1947             $groupimage = 't/groupn';
1948         }
1949         if (!$mod->coursegroupmodeforce) {
1950             $actions[$actionname] = new action_link(
1951                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
1952                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1953                 null,
1954                 array('class' => 'editing_'. $actionname, 'title' => $grouptitle)
1955             );
1956         } else {
1957             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
1958         }
1959     }
1961     // Assign
1962     if (has_capability('moodle/role:assign', $modcontext)){
1963         $actions['assign'] = new action_link(
1964             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
1965             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
1966             null,
1967             array('class' => 'editing_assign', 'title' => $str->assign)
1968         );
1969     }
1971     return $actions;
1974 /**
1975  * given a course object with shortname & fullname, this function will
1976  * truncate the the number of chars allowed and add ... if it was too long
1977  */
1978 function course_format_name ($course,$max=100) {
1980     $context = context_course::instance($course->id);
1981     $shortname = format_string($course->shortname, true, array('context' => $context));
1982     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
1983     $str = $shortname.': '. $fullname;
1984     if (textlib::strlen($str) <= $max) {
1985         return $str;
1986     }
1987     else {
1988         return textlib::substr($str,0,$max-3).'...';
1989     }
1992 /**
1993  * Is the user allowed to add this type of module to this course?
1994  * @param object $course the course settings. Only $course->id is used.
1995  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
1996  * @return bool whether the current user is allowed to add this type of module to this course.
1997  */
1998 function course_allowed_module($course, $modname) {
1999     if (is_numeric($modname)) {
2000         throw new coding_exception('Function course_allowed_module no longer
2001                 supports numeric module ids. Please update your code to pass the module name.');
2002     }
2004     $capability = 'mod/' . $modname . ':addinstance';
2005     if (!get_capability_info($capability)) {
2006         // Debug warning that the capability does not exist, but no more than once per page.
2007         static $warned = array();
2008         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2009         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2010             debugging('The module ' . $modname . ' does not define the standard capability ' .
2011                     $capability , DEBUG_DEVELOPER);
2012             $warned[$modname] = 1;
2013         }
2015         // If the capability does not exist, the module can always be added.
2016         return true;
2017     }
2019     $coursecontext = context_course::instance($course->id);
2020     return has_capability($capability, $coursecontext);
2023 /**
2024  * Efficiently moves many courses around while maintaining
2025  * sortorder in order.
2026  *
2027  * @param array $courseids is an array of course ids
2028  * @param int $categoryid
2029  * @return bool success
2030  */
2031 function move_courses($courseids, $categoryid) {
2032     global $CFG, $DB, $OUTPUT;
2034     if (empty($courseids)) {
2035         // nothing to do
2036         return;
2037     }
2039     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
2040         return false;
2041     }
2043     $courseids = array_reverse($courseids);
2044     $newparent = context_coursecat::instance($category->id);
2045     $i = 1;
2047     foreach ($courseids as $courseid) {
2048         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
2049             $course = new stdClass();
2050             $course->id = $courseid;
2051             $course->category  = $category->id;
2052             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2053             if ($category->visible == 0) {
2054                 // hide the course when moving into hidden category,
2055                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
2056                 $course->visible = 0;
2057             }
2059             $DB->update_record('course', $course);
2060             add_to_log($course->id, "course", "move", "edit.php?id=$course->id", $course->id);
2062             $context   = context_course::instance($course->id);
2063             context_moved($context, $newparent);
2064         }
2065     }
2066     fix_course_sortorder();
2067     cache_helper::purge_by_event('changesincourse');
2069     return true;
2072 /**
2073  * Returns the display name of the given section that the course prefers
2074  *
2075  * Implementation of this function is provided by course format
2076  * @see format_base::get_section_name()
2077  *
2078  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2079  * @param int|stdClass $section Section object from database or just field course_sections.section
2080  * @return string Display name that the course format prefers, e.g. "Week 2"
2081  */
2082 function get_section_name($courseorid, $section) {
2083     return course_get_format($courseorid)->get_section_name($section);
2086 /**
2087  * Tells if current course format uses sections
2088  *
2089  * @param string $format Course format ID e.g. 'weeks' $course->format
2090  * @return bool
2091  */
2092 function course_format_uses_sections($format) {
2093     $course = new stdClass();
2094     $course->format = $format;
2095     return course_get_format($course)->uses_sections();
2098 /**
2099  * Returns the information about the ajax support in the given source format
2100  *
2101  * The returned object's property (boolean)capable indicates that
2102  * the course format supports Moodle course ajax features.
2103  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
2104  *
2105  * @param string $format
2106  * @return stdClass
2107  */
2108 function course_format_ajax_support($format) {
2109     $course = new stdClass();
2110     $course->format = $format;
2111     return course_get_format($course)->supports_ajax();
2114 /**
2115  * Can the current user delete this course?
2116  * Course creators have exception,
2117  * 1 day after the creation they can sill delete the course.
2118  * @param int $courseid
2119  * @return boolean
2120  */
2121 function can_delete_course($courseid) {
2122     global $USER, $DB;
2124     $context = context_course::instance($courseid);
2126     if (has_capability('moodle/course:delete', $context)) {
2127         return true;
2128     }
2130     // hack: now try to find out if creator created this course recently (1 day)
2131     if (!has_capability('moodle/course:create', $context)) {
2132         return false;
2133     }
2135     $since = time() - 60*60*24;
2137     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
2138     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
2140     return $DB->record_exists_select('log', $select, $params);
2143 /**
2144  * Save the Your name for 'Some role' strings.
2145  *
2146  * @param integer $courseid the id of this course.
2147  * @param array $data the data that came from the course settings form.
2148  */
2149 function save_local_role_names($courseid, $data) {
2150     global $DB;
2151     $context = context_course::instance($courseid);
2153     foreach ($data as $fieldname => $value) {
2154         if (strpos($fieldname, 'role_') !== 0) {
2155             continue;
2156         }
2157         list($ignored, $roleid) = explode('_', $fieldname);
2159         // make up our mind whether we want to delete, update or insert
2160         if (!$value) {
2161             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2163         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2164             $rolename->name = $value;
2165             $DB->update_record('role_names', $rolename);
2167         } else {
2168             $rolename = new stdClass;
2169             $rolename->contextid = $context->id;
2170             $rolename->roleid = $roleid;
2171             $rolename->name = $value;
2172             $DB->insert_record('role_names', $rolename);
2173         }
2174     }
2177 /**
2178  * Create a course and either return a $course object
2179  *
2180  * Please note this functions does not verify any access control,
2181  * the calling code is responsible for all validation (usually it is the form definition).
2182  *
2183  * @param array $editoroptions course description editor options
2184  * @param object $data  - all the data needed for an entry in the 'course' table
2185  * @return object new course instance
2186  */
2187 function create_course($data, $editoroptions = NULL) {
2188     global $CFG, $DB;
2190     //check the categoryid - must be given for all new courses
2191     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
2193     //check if the shortname already exist
2194     if (!empty($data->shortname)) {
2195         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2196             throw new moodle_exception('shortnametaken');
2197         }
2198     }
2200     //check if the id number already exist
2201     if (!empty($data->idnumber)) {
2202         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2203             throw new moodle_exception('idnumbertaken');
2204         }
2205     }
2207     $data->timecreated  = time();
2208     $data->timemodified = $data->timecreated;
2210     // place at beginning of any category
2211     $data->sortorder = 0;
2213     if ($editoroptions) {
2214         // summary text is updated later, we need context to store the files first
2215         $data->summary = '';
2216         $data->summary_format = FORMAT_HTML;
2217     }
2219     if (!isset($data->visible)) {
2220         // data not from form, add missing visibility info
2221         $data->visible = $category->visible;
2222     }
2223     $data->visibleold = $data->visible;
2225     $newcourseid = $DB->insert_record('course', $data);
2226     $context = context_course::instance($newcourseid, MUST_EXIST);
2228     if ($editoroptions) {
2229         // Save the files used in the summary editor and store
2230         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2231         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2232         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2233     }
2235     // update course format options
2236     course_get_format($newcourseid)->update_course_format_options($data);
2238     $course = course_get_format($newcourseid)->get_course();
2240     // Setup the blocks
2241     blocks_add_default_course_blocks($course);
2243     // Create a default section.
2244     course_create_sections_if_missing($course, 0);
2246     fix_course_sortorder();
2247     // purge appropriate caches in case fix_course_sortorder() did not change anything
2248     cache_helper::purge_by_event('changesincourse');
2250     // new context created - better mark it as dirty
2251     mark_context_dirty($context->path);
2253     // Save any custom role names.
2254     save_local_role_names($course->id, (array)$data);
2256     // set up enrolments
2257     enrol_course_updated(true, $course, $data);
2259     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
2261     // Trigger events
2262     events_trigger('course_created', $course);
2264     return $course;
2267 /**
2268  * Update a course.
2269  *
2270  * Please note this functions does not verify any access control,
2271  * the calling code is responsible for all validation (usually it is the form definition).
2272  *
2273  * @param object $data  - all the data needed for an entry in the 'course' table
2274  * @param array $editoroptions course description editor options
2275  * @return void
2276  */
2277 function update_course($data, $editoroptions = NULL) {
2278     global $CFG, $DB;
2280     $data->timemodified = time();
2282     $oldcourse = course_get_format($data->id)->get_course();
2283     $context   = context_course::instance($oldcourse->id);
2285     if ($editoroptions) {
2286         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
2287     }
2289     if (!isset($data->category) or empty($data->category)) {
2290         // prevent nulls and 0 in category field
2291         unset($data->category);
2292     }
2293     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
2295     if (!isset($data->visible)) {
2296         // data not from form, add missing visibility info
2297         $data->visible = $oldcourse->visible;
2298     }
2300     if ($data->visible != $oldcourse->visible) {
2301         // reset the visibleold flag when manually hiding/unhiding course
2302         $data->visibleold = $data->visible;
2303     } else {
2304         if ($movecat) {
2305             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2306             if (empty($newcategory->visible)) {
2307                 // make sure when moving into hidden category the course is hidden automatically
2308                 $data->visible = 0;
2309             }
2310         }
2311     }
2313     // Update with the new data
2314     $DB->update_record('course', $data);
2315     // make sure the modinfo cache is reset
2316     rebuild_course_cache($data->id);
2318     // update course format options with full course data
2319     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2321     $course = $DB->get_record('course', array('id'=>$data->id));
2323     if ($movecat) {
2324         $newparent = context_coursecat::instance($course->category);
2325         context_moved($context, $newparent);
2326     }
2328     fix_course_sortorder();
2329     // purge appropriate caches in case fix_course_sortorder() did not change anything
2330     cache_helper::purge_by_event('changesincourse');
2332     // Test for and remove blocks which aren't appropriate anymore
2333     blocks_remove_inappropriate($course);
2335     // Save any custom role names.
2336     save_local_role_names($course->id, $data);
2338     // update enrol settings
2339     enrol_course_updated(false, $course, $data);
2341     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
2343     // Trigger events
2344     events_trigger('course_updated', $course);
2346     if ($oldcourse->format !== $course->format) {
2347         // Remove all options stored for the previous format
2348         // We assume that new course format migrated everything it needed watching trigger
2349         // 'course_updated' and in method format_XXX::update_course_format_options()
2350         $DB->delete_records('course_format_options',
2351                 array('courseid' => $course->id, 'format' => $oldcourse->format));
2352     }
2355 /**
2356  * Average number of participants
2357  * @return integer
2358  */
2359 function average_number_of_participants() {
2360     global $DB, $SITE;
2362     //count total of enrolments for visible course (except front page)
2363     $sql = 'SELECT COUNT(*) FROM (
2364         SELECT DISTINCT ue.userid, e.courseid
2365         FROM {user_enrolments} ue, {enrol} e, {course} c
2366         WHERE ue.enrolid = e.id
2367             AND e.courseid <> :siteid
2368             AND c.id = e.courseid
2369             AND c.visible = 1) total';
2370     $params = array('siteid' => $SITE->id);
2371     $enrolmenttotal = $DB->count_records_sql($sql, $params);
2374     //count total of visible courses (minus front page)
2375     $coursetotal = $DB->count_records('course', array('visible' => 1));
2376     $coursetotal = $coursetotal - 1 ;
2378     //average of enrolment
2379     if (empty($coursetotal)) {
2380         $participantaverage = 0;
2381     } else {
2382         $participantaverage = $enrolmenttotal / $coursetotal;
2383     }
2385     return $participantaverage;
2388 /**
2389  * Average number of course modules
2390  * @return integer
2391  */
2392 function average_number_of_courses_modules() {
2393     global $DB, $SITE;
2395     //count total of visible course module (except front page)
2396     $sql = 'SELECT COUNT(*) FROM (
2397         SELECT cm.course, cm.module
2398         FROM {course} c, {course_modules} cm
2399         WHERE c.id = cm.course
2400             AND c.id <> :siteid
2401             AND cm.visible = 1
2402             AND c.visible = 1) total';
2403     $params = array('siteid' => $SITE->id);
2404     $moduletotal = $DB->count_records_sql($sql, $params);
2407     //count total of visible courses (minus front page)
2408     $coursetotal = $DB->count_records('course', array('visible' => 1));
2409     $coursetotal = $coursetotal - 1 ;
2411     //average of course module
2412     if (empty($coursetotal)) {
2413         $coursemoduleaverage = 0;
2414     } else {
2415         $coursemoduleaverage = $moduletotal / $coursetotal;
2416     }
2418     return $coursemoduleaverage;
2421 /**
2422  * This class pertains to course requests and contains methods associated with
2423  * create, approving, and removing course requests.
2424  *
2425  * Please note we do not allow embedded images here because there is no context
2426  * to store them with proper access control.
2427  *
2428  * @copyright 2009 Sam Hemelryk
2429  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2430  * @since Moodle 2.0
2431  *
2432  * @property-read int $id
2433  * @property-read string $fullname
2434  * @property-read string $shortname
2435  * @property-read string $summary
2436  * @property-read int $summaryformat
2437  * @property-read int $summarytrust
2438  * @property-read string $reason
2439  * @property-read int $requester
2440  */
2441 class course_request {
2443     /**
2444      * This is the stdClass that stores the properties for the course request
2445      * and is externally accessed through the __get magic method
2446      * @var stdClass
2447      */
2448     protected $properties;
2450     /**
2451      * An array of options for the summary editor used by course request forms.
2452      * This is initially set by {@link summary_editor_options()}
2453      * @var array
2454      * @static
2455      */
2456     protected static $summaryeditoroptions;
2458     /**
2459      * Static function to prepare the summary editor for working with a course
2460      * request.
2461      *
2462      * @static
2463      * @param null|stdClass $data Optional, an object containing the default values
2464      *                       for the form, these may be modified when preparing the
2465      *                       editor so this should be called before creating the form
2466      * @return stdClass An object that can be used to set the default values for
2467      *                   an mforms form
2468      */
2469     public static function prepare($data=null) {
2470         if ($data === null) {
2471             $data = new stdClass;
2472         }
2473         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
2474         return $data;
2475     }
2477     /**
2478      * Static function to create a new course request when passed an array of properties
2479      * for it.
2480      *
2481      * This function also handles saving any files that may have been used in the editor
2482      *
2483      * @static
2484      * @param stdClass $data
2485      * @return course_request The newly created course request
2486      */
2487     public static function create($data) {
2488         global $USER, $DB, $CFG;
2489         $data->requester = $USER->id;
2491         // Setting the default category if none set.
2492         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2493             $data->category = $CFG->defaultrequestcategory;
2494         }
2496         // Summary is a required field so copy the text over
2497         $data->summary       = $data->summary_editor['text'];
2498         $data->summaryformat = $data->summary_editor['format'];
2500         $data->id = $DB->insert_record('course_request', $data);
2502         // Create a new course_request object and return it
2503         $request = new course_request($data);
2505         // Notify the admin if required.
2506         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
2508             $a = new stdClass;
2509             $a->link = "$CFG->wwwroot/course/pending.php";
2510             $a->user = fullname($USER);
2511             $subject = get_string('courserequest');
2512             $message = get_string('courserequestnotifyemail', 'admin', $a);
2513             foreach ($users as $user) {
2514                 $request->notify($user, $USER, 'courserequested', $subject, $message);
2515             }
2516         }
2518         return $request;
2519     }
2521     /**
2522      * Returns an array of options to use with a summary editor
2523      *
2524      * @uses course_request::$summaryeditoroptions
2525      * @return array An array of options to use with the editor
2526      */
2527     public static function summary_editor_options() {
2528         global $CFG;
2529         if (self::$summaryeditoroptions === null) {
2530             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
2531         }
2532         return self::$summaryeditoroptions;
2533     }
2535     /**
2536      * Loads the properties for this course request object. Id is required and if
2537      * only id is provided then we load the rest of the properties from the database
2538      *
2539      * @param stdClass|int $properties Either an object containing properties
2540      *                      or the course_request id to load
2541      */
2542     public function __construct($properties) {
2543         global $DB;
2544         if (empty($properties->id)) {
2545             if (empty($properties)) {
2546                 throw new coding_exception('You must provide a course request id when creating a course_request object');
2547             }
2548             $id = $properties;
2549             $properties = new stdClass;
2550             $properties->id = (int)$id;
2551             unset($id);
2552         }
2553         if (empty($properties->requester)) {
2554             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2555                 print_error('unknowncourserequest');
2556             }
2557         } else {
2558             $this->properties = $properties;
2559         }
2560         $this->properties->collision = null;
2561     }
2563     /**
2564      * Returns the requested property
2565      *
2566      * @param string $key
2567      * @return mixed
2568      */
2569     public function __get($key) {
2570         return $this->properties->$key;
2571     }
2573     /**
2574      * Override this to ensure empty($request->blah) calls return a reliable answer...
2575      *
2576      * This is required because we define the __get method
2577      *
2578      * @param mixed $key
2579      * @return bool True is it not empty, false otherwise
2580      */
2581     public function __isset($key) {
2582         return (!empty($this->properties->$key));
2583     }
2585     /**
2586      * Returns the user who requested this course
2587      *
2588      * Uses a static var to cache the results and cut down the number of db queries
2589      *
2590      * @staticvar array $requesters An array of cached users
2591      * @return stdClass The user who requested the course
2592      */
2593     public function get_requester() {
2594         global $DB;
2595         static $requesters= array();
2596         if (!array_key_exists($this->properties->requester, $requesters)) {
2597             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
2598         }
2599         return $requesters[$this->properties->requester];
2600     }
2602     /**
2603      * Checks that the shortname used by the course does not conflict with any other
2604      * courses that exist
2605      *
2606      * @param string|null $shortnamemark The string to append to the requests shortname
2607      *                     should a conflict be found
2608      * @return bool true is there is a conflict, false otherwise
2609      */
2610     public function check_shortname_collision($shortnamemark = '[*]') {
2611         global $DB;
2613         if ($this->properties->collision !== null) {
2614             return $this->properties->collision;
2615         }
2617         if (empty($this->properties->shortname)) {
2618             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
2619             $this->properties->collision = false;
2620         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
2621             if (!empty($shortnamemark)) {
2622                 $this->properties->shortname .= ' '.$shortnamemark;
2623             }
2624             $this->properties->collision = true;
2625         } else {
2626             $this->properties->collision = false;
2627         }
2628         return $this->properties->collision;
2629     }
2631     /**
2632      * Returns the category where this course request should be created
2633      *
2634      * Note that we don't check here that user has a capability to view
2635      * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2636      * 'moodle/course:changecategory'
2637      *
2638      * @return coursecat
2639      */
2640     public function get_category() {
2641         global $CFG;
2642         require_once($CFG->libdir.'/coursecatlib.php');
2643         // If the category is not set, if the current user does not have the rights to change the category, or if the
2644         // category does not exist, we set the default category to the course to be approved.
2645         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2646         if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
2647                 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
2648             $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
2649         }
2650         if (!$category) {
2651             $category = coursecat::get_default();
2652         }
2653         return $category;
2654     }
2656     /**
2657      * This function approves the request turning it into a course
2658      *
2659      * This function converts the course request into a course, at the same time
2660      * transferring any files used in the summary to the new course and then removing
2661      * the course request and the files associated with it.
2662      *
2663      * @return int The id of the course that was created from this request
2664      */
2665     public function approve() {
2666         global $CFG, $DB, $USER;
2668         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
2670         $courseconfig = get_config('moodlecourse');
2672         // Transfer appropriate settings
2673         $data = clone($this->properties);
2674         unset($data->id);
2675         unset($data->reason);
2676         unset($data->requester);
2678         // Set category
2679         $category = $this->get_category();
2680         $data->category = $category->id;
2681         // Set misc settings
2682         $data->requested = 1;
2684         // Apply course default settings
2685         $data->format             = $courseconfig->format;
2686         $data->newsitems          = $courseconfig->newsitems;
2687         $data->showgrades         = $courseconfig->showgrades;
2688         $data->showreports        = $courseconfig->showreports;
2689         $data->maxbytes           = $courseconfig->maxbytes;
2690         $data->groupmode          = $courseconfig->groupmode;
2691         $data->groupmodeforce     = $courseconfig->groupmodeforce;
2692         $data->visible            = $courseconfig->visible;
2693         $data->visibleold         = $data->visible;
2694         $data->lang               = $courseconfig->lang;
2696         $course = create_course($data);
2697         $context = context_course::instance($course->id, MUST_EXIST);
2699         // add enrol instances
2700         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
2701             if ($manual = enrol_get_plugin('manual')) {
2702                 $manual->add_default_instance($course);
2703             }
2704         }
2706         // enrol the requester as teacher if necessary
2707         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2708             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
2709         }
2711         $this->delete();
2713         $a = new stdClass();
2714         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2715         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
2716         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
2718         return $course->id;
2719     }
2721     /**
2722      * Reject a course request
2723      *
2724      * This function rejects a course request, emailing the requesting user the
2725      * provided notice and then removing the request from the database
2726      *
2727      * @param string $notice The message to display to the user
2728      */
2729     public function reject($notice) {
2730         global $USER, $DB;
2731         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
2732         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
2733         $this->delete();
2734     }
2736     /**
2737      * Deletes the course request and any associated files
2738      */
2739     public function delete() {
2740         global $DB;
2741         $DB->delete_records('course_request', array('id' => $this->properties->id));
2742     }
2744     /**
2745      * Send a message from one user to another using events_trigger
2746      *
2747      * @param object $touser
2748      * @param object $fromuser
2749      * @param string $name
2750      * @param string $subject
2751      * @param string $message
2752      */
2753     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
2754         $eventdata = new stdClass();
2755         $eventdata->component         = 'moodle';
2756         $eventdata->name              = $name;
2757         $eventdata->userfrom          = $fromuser;
2758         $eventdata->userto            = $touser;
2759         $eventdata->subject           = $subject;
2760         $eventdata->fullmessage       = $message;
2761         $eventdata->fullmessageformat = FORMAT_PLAIN;
2762         $eventdata->fullmessagehtml   = '';
2763         $eventdata->smallmessage      = '';
2764         $eventdata->notification      = 1;
2765         message_send($eventdata);
2766     }
2769 /**
2770  * Return a list of page types
2771  * @param string $pagetype current page type
2772  * @param stdClass $parentcontext Block's parent context
2773  * @param stdClass $currentcontext Current context of block
2774  */
2775 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
2776     // $currentcontext could be null, get_context_info_array() will throw an error if this is the case.
2777     if (isset($currentcontext)) {
2778         // if above course context ,display all course fomats
2779         list($currentcontext, $course, $cm) = get_context_info_array($currentcontext->id);
2780         if ($course->id == SITEID) {
2781             return array('*'=>get_string('page-x', 'pagetype'));
2782         }
2783     }
2784     return array('*'=>get_string('page-x', 'pagetype'),
2785         'course-*'=>get_string('page-course-x', 'pagetype'),
2786         'course-view-*'=>get_string('page-course-view-x', 'pagetype')
2787     );
2790 /**
2791  * Determine whether course ajax should be enabled for the specified course
2792  *
2793  * @param stdClass $course The course to test against
2794  * @return boolean Whether course ajax is enabled or note
2795  */
2796 function course_ajax_enabled($course) {
2797     global $CFG, $PAGE, $SITE;
2799     // Ajax must be enabled globally
2800     if (!$CFG->enableajax) {
2801         return false;
2802     }
2804     // The user must be editing for AJAX to be included
2805     if (!$PAGE->user_is_editing()) {
2806         return false;
2807     }
2809     // Check that the theme suports
2810     if (!$PAGE->theme->enablecourseajax) {
2811         return false;
2812     }
2814     // Check that the course format supports ajax functionality
2815     // The site 'format' doesn't have information on course format support
2816     if ($SITE->id !== $course->id) {
2817         $courseformatajaxsupport = course_format_ajax_support($course->format);
2818         if (!$courseformatajaxsupport->capable) {
2819             return false;
2820         }
2821     }
2823     // All conditions have been met so course ajax should be enabled
2824     return true;
2827 /**
2828  * Include the relevant javascript and language strings for the resource
2829  * toolbox YUI module
2830  *
2831  * @param integer $id The ID of the course being applied to
2832  * @param array $usedmodules An array containing the names of the modules in use on the page
2833  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
2834  * @param stdClass $config An object containing configuration parameters for ajax modules including:
2835  *          * resourceurl   The URL to post changes to for resource changes
2836  *          * sectionurl    The URL to post changes to for section changes
2837  *          * pageparams    Additional parameters to pass through in the post
2838  * @return bool
2839  */
2840 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
2841     global $PAGE, $SITE;
2843     // Ensure that ajax should be included
2844     if (!course_ajax_enabled($course)) {
2845         return false;
2846     }
2848     if (!$config) {
2849         $config = new stdClass();
2850     }
2852     // The URL to use for resource changes
2853     if (!isset($config->resourceurl)) {
2854         $config->resourceurl = '/course/rest.php';
2855     }
2857     // The URL to use for section changes
2858     if (!isset($config->sectionurl)) {
2859         $config->sectionurl = '/course/rest.php';
2860     }
2862     // Any additional parameters which need to be included on page submission
2863     if (!isset($config->pageparams)) {
2864         $config->pageparams = array();
2865     }
2867     // Include toolboxes
2868     $PAGE->requires->yui_module('moodle-course-toolboxes',
2869             'M.course.init_resource_toolbox',
2870             array(array(
2871                 'courseid' => $course->id,
2872                 'ajaxurl' => $config->resourceurl,
2873                 'config' => $config,
2874             ))
2875     );
2876     $PAGE->requires->yui_module('moodle-course-toolboxes',
2877             'M.course.init_section_toolbox',
2878             array(array(
2879                 'courseid' => $course->id,
2880                 'format' => $course->format,
2881                 'ajaxurl' => $config->sectionurl,
2882                 'config' => $config,
2883             ))
2884     );
2886     // Include course dragdrop
2887     if ($course->id != $SITE->id) {
2888         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
2889             array(array(
2890                 'courseid' => $course->id,
2891                 'ajaxurl' => $config->sectionurl,
2892                 'config' => $config,
2893             )), null, true);
2895         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
2896             array(array(
2897                 'courseid' => $course->id,
2898                 'ajaxurl' => $config->resourceurl,
2899                 'config' => $config,
2900             )), null, true);
2901     }
2903     // Require various strings for the command toolbox
2904     $PAGE->requires->strings_for_js(array(
2905             'moveleft',
2906             'deletechecktype',
2907             'deletechecktypename',
2908             'edittitle',
2909             'edittitleinstructions',
2910             'show',
2911             'hide',
2912             'groupsnone',
2913             'groupsvisible',
2914             'groupsseparate',
2915             'clicktochangeinbrackets',
2916             'markthistopic',
2917             'markedthistopic',
2918             'move',
2919             'movesection',
2920         ), 'moodle');
2922     // Include format-specific strings
2923     if ($course->id != $SITE->id) {
2924         $PAGE->requires->strings_for_js(array(
2925                 'showfromothers',
2926                 'hidefromothers',
2927             ), 'format_' . $course->format);
2928     }
2930     // For confirming resource deletion we need the name of the module in question
2931     foreach ($usedmodules as $module => $modname) {
2932         $PAGE->requires->string_for_js('pluginname', $module);
2933     }
2935     // Load drag and drop upload AJAX.
2936     dndupload_add_to_course($course, $enabledmodules);
2938     return true;
2941 /**
2942  * Returns the sorted list of available course formats, filtered by enabled if necessary
2943  *
2944  * @param bool $enabledonly return only formats that are enabled
2945  * @return array array of sorted format names
2946  */
2947 function get_sorted_course_formats($enabledonly = false) {
2948     global $CFG;
2949     $formats = get_plugin_list('format');
2951     if (!empty($CFG->format_plugins_sortorder)) {
2952         $order = explode(',', $CFG->format_plugins_sortorder);
2953         $order = array_merge(array_intersect($order, array_keys($formats)),
2954                     array_diff(array_keys($formats), $order));
2955     } else {
2956         $order = array_keys($formats);
2957     }
2958     if (!$enabledonly) {
2959         return $order;
2960     }
2961     $sortedformats = array();
2962     foreach ($order as $formatname) {
2963         if (!get_config('format_'.$formatname, 'disabled')) {
2964             $sortedformats[] = $formatname;
2965         }
2966     }
2967     return $sortedformats;
2970 /**
2971  * The URL to use for the specified course (with section)
2972  *
2973  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
2974  * @param int|stdClass $section Section object from database or just field course_sections.section
2975  *     if omitted the course view page is returned
2976  * @param array $options options for view URL. At the moment core uses:
2977  *     'navigation' (bool) if true and section has no separate page, the function returns null
2978  *     'sr' (int) used by multipage formats to specify to which section to return
2979  * @return moodle_url The url of course
2980  */
2981 function course_get_url($courseorid, $section = null, $options = array()) {
2982     return course_get_format($courseorid)->get_view_url($section, $options);
2985 /**
2986  * Create a module.
2987  *
2988  * It includes:
2989  *      - capability checks and other checks
2990  *      - create the module from the module info
2991  *
2992  * @param object $module
2993  * @return object the created module info
2994  */
2995 function create_module($moduleinfo) {
2996     global $DB, $CFG;
2998     require_once($CFG->dirroot . '/course/modlib.php');
3000     // Check manadatory attributs.
3001     $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3002     if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3003         $mandatoryfields[] = 'introeditor';
3004     }
3005     foreach($mandatoryfields as $mandatoryfield) {
3006         if (!isset($moduleinfo->{$mandatoryfield})) {
3007             throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3008         }
3009     }
3011     // Some additional checks (capability / existing instances).
3012     $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
3013     list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3015     // Load module library.
3016     include_modulelib($module->name);
3018     // Add the module.
3019     $moduleinfo->module = $module->id;
3020     $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3022     return $moduleinfo;
3025 /**
3026  * Update a module.
3027  *
3028  * It includes:
3029  *      - capability and other checks
3030  *      - update the module
3031  *
3032  * @param object $module
3033  * @return object the updated module info
3034  */
3035 function update_module($moduleinfo) {
3036     global $DB, $CFG;
3038     require_once($CFG->dirroot . '/course/modlib.php');
3040     // Check the course module exists.
3041     $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3043     // Check the course exists.
3044     $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
3046     // Some checks (capaibility / existing instances).
3047     list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3049     // Load module library.
3050     include_modulelib($module->name);
3052     // Retrieve few information needed by update_moduleinfo.
3053     $moduleinfo->modulename = $cm->modname;
3054     if (!isset($moduleinfo->scale)) {
3055         $moduleinfo->scale = 0;
3056     }
3057     $moduleinfo->type = 'mod';
3059     // Update the module.
3060     list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3062     return $moduleinfo;
3065 /**
3066  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3067  * Sorts by descending order of time.
3068  *
3069  * @param stdClass $a First object
3070  * @param stdClass $b Second object
3071  * @return int 0,1,-1 representing the order
3072  */
3073 function compare_activities_by_time_desc($a, $b) {
3074     // Make sure the activities actually have a timestamp property.
3075     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3076         return 0;
3077     }
3078     // We treat instances without timestamp as if they have a timestamp of 0.
3079     if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3080         return 1;
3081     }
3082     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3083         return -1;
3084     }
3085     if ($a->timestamp == $b->timestamp) {
3086         return 0;
3087     }
3088     return ($a->timestamp > $b->timestamp) ? -1 : 1;
3091 /**
3092  * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3093  * Sorts by ascending order of time.
3094  *
3095  * @param stdClass $a First object
3096  * @param stdClass $b Second object
3097  * @return int 0,1,-1 representing the order
3098  */
3099 function compare_activities_by_time_asc($a, $b) {
3100     // Make sure the activities actually have a timestamp property.
3101     if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3102       return 0;
3103     }
3104     // We treat instances without timestamp as if they have a timestamp of 0.
3105     if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3106         return -1;
3107     }
3108     if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3109         return 1;
3110     }
3111     if ($a->timestamp == $b->timestamp) {
3112         return 0;
3113     }
3114     return ($a->timestamp < $b->timestamp) ? -1 : 1;