0affe66ed3073c3f4f2dd41bd4b1da0292541bd5
[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 'mnet course':
72             if (strpos($url, '../') === 0) {
73                 $url = ltrim($url, '.');
74             } else {
75                 $url = "/course/$url";
76             }
77             break;
78         case 'user':
79         case 'blog':
80             $url = "/$module/$url";
81             break;
82         case 'upload':
83             $url = $url;
84             break;
85         case 'coursetags':
86             $url = '/'.$url;
87             break;
88         case 'library':
89         case '':
90             $url = '/';
91             break;
92         case 'message':
93             $url = "/message/$url";
94             break;
95         case 'notes':
96             $url = "/notes/$url";
97             break;
98         case 'tag':
99             $url = "/tag/$url";
100             break;
101         case 'role':
102             $url = '/'.$url;
103             break;
104         default:
105             $url = "/mod/$module/$url";
106             break;
107     }
109     //now let's sanitise urls - there might be some ugly nasties:-(
110     $parts = explode('?', $url);
111     $script = array_shift($parts);
112     if (strpos($script, 'http') === 0) {
113         $script = clean_param($script, PARAM_URL);
114     } else {
115         $script = clean_param($script, PARAM_PATH);
116     }
118     $query = '';
119     if ($parts) {
120         $query = implode('', $parts);
121         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
122         $parts = explode('&', $query);
123         $eq = urlencode('=');
124         foreach ($parts as $key=>$part) {
125             $part = urlencode(urldecode($part));
126             $part = str_replace($eq, '=', $part);
127             $parts[$key] = $part;
128         }
129         $query = '?'.implode('&amp;', $parts);
130     }
132     return $script.$query;
136 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
137                    $modname="", $modid=0, $modaction="", $groupid=0) {
138     global $CFG, $DB;
140     // It is assumed that $date is the GMT time of midnight for that day,
141     // and so the next 86400 seconds worth of logs are printed.
143     /// Setup for group handling.
145     // TODO: I don't understand group/context/etc. enough to be able to do
146     // something interesting with it here
147     // What is the context of a remote course?
149     /// If the group mode is separate, and this user does not have editing privileges,
150     /// then only the user's group can be viewed.
151     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
152     //    $groupid = get_current_group($course->id);
153     //}
154     /// If this course doesn't have groups, no groupid can be specified.
155     //else if (!$course->groupmode) {
156     //    $groupid = 0;
157     //}
159     $groupid = 0;
161     $joins = array();
162     $where = '';
164     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
165               FROM {mnet_log} l
166                LEFT JOIN {user} u ON l.userid = u.id
167               WHERE ";
168     $params = array();
170     $where .= "l.hostid = :hostid";
171     $params['hostid'] = $hostid;
173     // TODO: Is 1 really a magic number referring to the sitename?
174     if ($course != SITEID || $modid != 0) {
175         $where .= " AND l.course=:courseid";
176         $params['courseid'] = $course;
177     }
179     if ($modname) {
180         $where .= " AND l.module = :modname";
181         $params['modname'] = $modname;
182     }
184     if ('site_errors' === $modid) {
185         $where .= " AND ( l.action='error' OR l.action='infected' )";
186     } else if ($modid) {
187         //TODO: This assumes that modids are the same across sites... probably
188         //not true
189         $where .= " AND l.cmid = :modid";
190         $params['modid'] = $modid;
191     }
193     if ($modaction) {
194         $firstletter = substr($modaction, 0, 1);
195         if ($firstletter == '-') {
196             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
197             $params['modaction'] = '%'.substr($modaction, 1).'%';
198         } else {
199             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
200             $params['modaction'] = '%'.$modaction.'%';
201         }
202     }
204     if ($user) {
205         $where .= " AND l.userid = :user";
206         $params['user'] = $user;
207     }
209     if ($date) {
210         $enddate = $date + 86400;
211         $where .= " AND l.time > :date AND l.time < :enddate";
212         $params['date'] = $date;
213         $params['enddate'] = $enddate;
214     }
216     $result = array();
217     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
218     if(!empty($result['totalcount'])) {
219         $where .= " ORDER BY $order";
220         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
221     } else {
222         $result['logs'] = array();
223     }
224     return $result;
227 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
228                    $modname="", $modid=0, $modaction="", $groupid=0) {
229     global $DB, $SESSION, $USER;
230     // It is assumed that $date is the GMT time of midnight for that day,
231     // and so the next 86400 seconds worth of logs are printed.
233     /// Setup for group handling.
235     /// If the group mode is separate, and this user does not have editing privileges,
236     /// then only the user's group can be viewed.
237     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
238         if (isset($SESSION->currentgroup[$course->id])) {
239             $groupid =  $SESSION->currentgroup[$course->id];
240         } else {
241             $groupid = groups_get_all_groups($course->id, $USER->id);
242             if (is_array($groupid)) {
243                 $groupid = array_shift(array_keys($groupid));
244                 $SESSION->currentgroup[$course->id] = $groupid;
245             } else {
246                 $groupid = 0;
247             }
248         }
249     }
250     /// If this course doesn't have groups, no groupid can be specified.
251     else if (!$course->groupmode) {
252         $groupid = 0;
253     }
255     $joins = array();
256     $params = array();
258     if ($course->id != SITEID || $modid != 0) {
259         $joins[] = "l.course = :courseid";
260         $params['courseid'] = $course->id;
261     }
263     if ($modname) {
264         $joins[] = "l.module = :modname";
265         $params['modname'] = $modname;
266     }
268     if ('site_errors' === $modid) {
269         $joins[] = "( l.action='error' OR l.action='infected' )";
270     } else if ($modid) {
271         $joins[] = "l.cmid = :modid";
272         $params['modid'] = $modid;
273     }
275     if ($modaction) {
276         $firstletter = substr($modaction, 0, 1);
277         if ($firstletter == '-') {
278             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
279             $params['modaction'] = '%'.substr($modaction, 1).'%';
280         } else {
281             $joins[] = $DB->sql_like('l.action', ':modaction', false);
282             $params['modaction'] = '%'.$modaction.'%';
283         }
284     }
287     /// Getting all members of a group.
288     if ($groupid and !$user) {
289         if ($gusers = groups_get_members($groupid)) {
290             $gusers = array_keys($gusers);
291             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
292         } else {
293             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
294         }
295     }
296     else if ($user) {
297         $joins[] = "l.userid = :userid";
298         $params['userid'] = $user;
299     }
301     if ($date) {
302         $enddate = $date + 86400;
303         $joins[] = "l.time > :date AND l.time < :enddate";
304         $params['date'] = $date;
305         $params['enddate'] = $enddate;
306     }
308     $selector = implode(' AND ', $joins);
310     $totalcount = 0;  // Initialise
311     $result = array();
312     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
313     $result['totalcount'] = $totalcount;
314     return $result;
318 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
319                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
321     global $CFG, $DB, $OUTPUT;
323     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
324                        $modname, $modid, $modaction, $groupid)) {
325         echo $OUTPUT->notification("No logs found!");
326         echo $OUTPUT->footer();
327         exit;
328     }
330     $courses = array();
332     if ($course->id == SITEID) {
333         $courses[0] = '';
334         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
335             foreach ($ccc as $cc) {
336                 $courses[$cc->id] = $cc->shortname;
337             }
338         }
339     } else {
340         $courses[$course->id] = $course->shortname;
341     }
343     $totalcount = $logs['totalcount'];
344     $count=0;
345     $ldcache = array();
346     $tt = getdate(time());
347     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
349     $strftimedatetime = get_string("strftimedatetime");
351     echo "<div class=\"info\">\n";
352     print_string("displayingrecords", "", $totalcount);
353     echo "</div>\n";
355     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
357     $table = new html_table();
358     $table->classes = array('logtable','generalbox');
359     $table->align = array('right', 'left', 'left');
360     $table->head = array(
361         get_string('time'),
362         get_string('ip_address'),
363         get_string('fullnameuser'),
364         get_string('action'),
365         get_string('info')
366     );
367     $table->data = array();
369     if ($course->id == SITEID) {
370         array_unshift($table->align, 'left');
371         array_unshift($table->head, get_string('course'));
372     }
374     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
375     if (empty($logs['logs'])) {
376         $logs['logs'] = array();
377     }
379     foreach ($logs['logs'] as $log) {
381         if (isset($ldcache[$log->module][$log->action])) {
382             $ld = $ldcache[$log->module][$log->action];
383         } else {
384             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
385             $ldcache[$log->module][$log->action] = $ld;
386         }
387         if ($ld && is_numeric($log->info)) {
388             // ugly hack to make sure fullname is shown correctly
389             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
390                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
391             } else {
392                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
393             }
394         }
396         //Filter log->info
397         $log->info = format_string($log->info);
399         // If $log->url has been trimmed short by the db size restriction
400         // code in add_to_log, keep a note so we don't add a link to a broken url
401         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
403         $row = array();
404         if ($course->id == SITEID) {
405             if (empty($log->course)) {
406                 $row[] = get_string('site');
407             } else {
408                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
409             }
410         }
412         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
414         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
415         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
417         $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))));
419         $displayaction="$log->module $log->action";
420         if ($brokenurl) {
421             $row[] = $displayaction;
422         } else {
423             $link = make_log_url($log->module,$log->url);
424             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
425         }
426         $row[] = $log->info;
427         $table->data[] = $row;
428     }
430     echo html_writer::table($table);
431     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
435 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
436                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
438     global $CFG, $DB, $OUTPUT;
440     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
441                        $modname, $modid, $modaction, $groupid)) {
442         echo $OUTPUT->notification("No logs found!");
443         echo $OUTPUT->footer();
444         exit;
445     }
447     if ($course->id == SITEID) {
448         $courses[0] = '';
449         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
450             foreach ($ccc as $cc) {
451                 $courses[$cc->id] = $cc->shortname;
452             }
453         }
454     }
456     $totalcount = $logs['totalcount'];
457     $count=0;
458     $ldcache = array();
459     $tt = getdate(time());
460     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
462     $strftimedatetime = get_string("strftimedatetime");
464     echo "<div class=\"info\">\n";
465     print_string("displayingrecords", "", $totalcount);
466     echo "</div>\n";
468     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
470     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
471     echo "<tr>";
472     if ($course->id == SITEID) {
473         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
474     }
475     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
476     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
477     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
478     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
479     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
480     echo "</tr>\n";
482     if (empty($logs['logs'])) {
483         echo "</table>\n";
484         return;
485     }
487     $row = 1;
488     foreach ($logs['logs'] as $log) {
490         $log->info = $log->coursename;
491         $row = ($row + 1) % 2;
493         if (isset($ldcache[$log->module][$log->action])) {
494             $ld = $ldcache[$log->module][$log->action];
495         } else {
496             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
497             $ldcache[$log->module][$log->action] = $ld;
498         }
499         if (0 && $ld && !empty($log->info)) {
500             // ugly hack to make sure fullname is shown correctly
501             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
502                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
503             } else {
504                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
505             }
506         }
508         //Filter log->info
509         $log->info = format_string($log->info);
511         echo '<tr class="r'.$row.'">';
512         if ($course->id == SITEID) {
513             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
514             echo "<td class=\"r$row c0\" >\n";
515             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
516             echo "</td>\n";
517         }
518         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
519              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
520         echo "<td class=\"r$row c2\" >\n";
521         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
522         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
523         echo "</td>\n";
524         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
525         echo "<td class=\"r$row c3\" >\n";
526         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
527         echo "</td>\n";
528         echo "<td class=\"r$row c4\">\n";
529         echo $log->action .': '.$log->module;
530         echo "</td>\n";
531         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
532         echo "</tr>\n";
533     }
534     echo "</table>\n";
536     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
540 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
541                         $modid, $modaction, $groupid) {
542     global $DB, $CFG;
544     require_once($CFG->libdir . '/csvlib.class.php');
546     $csvexporter = new csv_export_writer('tab');
548     $header = array();
549     $header[] = get_string('course');
550     $header[] = get_string('time');
551     $header[] = get_string('ip_address');
552     $header[] = get_string('fullnameuser');
553     $header[] = get_string('action');
554     $header[] = get_string('info');
556     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
557                        $modname, $modid, $modaction, $groupid)) {
558         return false;
559     }
561     $courses = array();
563     if ($course->id == SITEID) {
564         $courses[0] = '';
565         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
566             foreach ($ccc as $cc) {
567                 $courses[$cc->id] = $cc->shortname;
568             }
569         }
570     } else {
571         $courses[$course->id] = $course->shortname;
572     }
574     $count=0;
575     $ldcache = array();
576     $tt = getdate(time());
577     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
579     $strftimedatetime = get_string("strftimedatetime");
581     $csvexporter->set_filename('logs', '.txt');
582     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
583     $csvexporter->add_data($title);
584     $csvexporter->add_data($header);
586     if (empty($logs['logs'])) {
587         return true;
588     }
590     foreach ($logs['logs'] as $log) {
591         if (isset($ldcache[$log->module][$log->action])) {
592             $ld = $ldcache[$log->module][$log->action];
593         } else {
594             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
595             $ldcache[$log->module][$log->action] = $ld;
596         }
597         if ($ld && is_numeric($log->info)) {
598             // ugly hack to make sure fullname is shown correctly
599             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
600                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
601             } else {
602                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
603             }
604         }
606         //Filter log->info
607         $log->info = format_string($log->info);
608         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
610         $coursecontext = context_course::instance($course->id);
611         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
612         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
613         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
614         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
615         $csvexporter->add_data($row);
616     }
617     $csvexporter->download_file();
618     return true;
622 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
623                         $modid, $modaction, $groupid) {
625     global $CFG, $DB;
627     require_once("$CFG->libdir/excellib.class.php");
629     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
630                        $modname, $modid, $modaction, $groupid)) {
631         return false;
632     }
634     $courses = array();
636     if ($course->id == SITEID) {
637         $courses[0] = '';
638         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
639             foreach ($ccc as $cc) {
640                 $courses[$cc->id] = $cc->shortname;
641             }
642         }
643     } else {
644         $courses[$course->id] = $course->shortname;
645     }
647     $count=0;
648     $ldcache = array();
649     $tt = getdate(time());
650     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
652     $strftimedatetime = get_string("strftimedatetime");
654     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
655     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
656     $filename .= '.xls';
658     $workbook = new MoodleExcelWorkbook('-');
659     $workbook->send($filename);
661     $worksheet = array();
662     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
663                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
665     // Creating worksheets
666     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
667         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
668         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
669         $worksheet[$wsnumber]->set_column(1, 1, 30);
670         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
671                                     userdate(time(), $strftimedatetime));
672         $col = 0;
673         foreach ($headers as $item) {
674             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
675             $col++;
676         }
677     }
679     if (empty($logs['logs'])) {
680         $workbook->close();
681         return true;
682     }
684     $formatDate =& $workbook->add_format();
685     $formatDate->set_num_format(get_string('log_excel_date_format'));
687     $row = FIRSTUSEDEXCELROW;
688     $wsnumber = 1;
689     $myxls =& $worksheet[$wsnumber];
690     foreach ($logs['logs'] as $log) {
691         if (isset($ldcache[$log->module][$log->action])) {
692             $ld = $ldcache[$log->module][$log->action];
693         } else {
694             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
695             $ldcache[$log->module][$log->action] = $ld;
696         }
697         if ($ld && is_numeric($log->info)) {
698             // ugly hack to make sure fullname is shown correctly
699             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
700                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
701             } else {
702                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
703             }
704         }
706         // Filter log->info
707         $log->info = format_string($log->info);
708         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
710         if ($nroPages>1) {
711             if ($row > EXCELROWS) {
712                 $wsnumber++;
713                 $myxls =& $worksheet[$wsnumber];
714                 $row = FIRSTUSEDEXCELROW;
715             }
716         }
718         $coursecontext = context_course::instance($course->id);
720         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
721         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
722         $myxls->write($row, 2, $log->ip, '');
723         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
724         $myxls->write($row, 3, $fullname, '');
725         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
726         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
727         $myxls->write($row, 5, $log->info, '');
729         $row++;
730     }
732     $workbook->close();
733     return true;
736 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
737                         $modid, $modaction, $groupid) {
739     global $CFG, $DB;
741     require_once("$CFG->libdir/odslib.class.php");
743     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
744                        $modname, $modid, $modaction, $groupid)) {
745         return false;
746     }
748     $courses = array();
750     if ($course->id == SITEID) {
751         $courses[0] = '';
752         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
753             foreach ($ccc as $cc) {
754                 $courses[$cc->id] = $cc->shortname;
755             }
756         }
757     } else {
758         $courses[$course->id] = $course->shortname;
759     }
761     $count=0;
762     $ldcache = array();
763     $tt = getdate(time());
764     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
766     $strftimedatetime = get_string("strftimedatetime");
768     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
769     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
770     $filename .= '.ods';
772     $workbook = new MoodleODSWorkbook('-');
773     $workbook->send($filename);
775     $worksheet = array();
776     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
777                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
779     // Creating worksheets
780     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
781         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
782         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
783         $worksheet[$wsnumber]->set_column(1, 1, 30);
784         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
785                                     userdate(time(), $strftimedatetime));
786         $col = 0;
787         foreach ($headers as $item) {
788             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
789             $col++;
790         }
791     }
793     if (empty($logs['logs'])) {
794         $workbook->close();
795         return true;
796     }
798     $formatDate =& $workbook->add_format();
799     $formatDate->set_num_format(get_string('log_excel_date_format'));
801     $row = FIRSTUSEDEXCELROW;
802     $wsnumber = 1;
803     $myxls =& $worksheet[$wsnumber];
804     foreach ($logs['logs'] as $log) {
805         if (isset($ldcache[$log->module][$log->action])) {
806             $ld = $ldcache[$log->module][$log->action];
807         } else {
808             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
809             $ldcache[$log->module][$log->action] = $ld;
810         }
811         if ($ld && is_numeric($log->info)) {
812             // ugly hack to make sure fullname is shown correctly
813             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
814                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
815             } else {
816                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
817             }
818         }
820         // Filter log->info
821         $log->info = format_string($log->info);
822         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
824         if ($nroPages>1) {
825             if ($row > EXCELROWS) {
826                 $wsnumber++;
827                 $myxls =& $worksheet[$wsnumber];
828                 $row = FIRSTUSEDEXCELROW;
829             }
830         }
832         $coursecontext = context_course::instance($course->id);
834         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
835         $myxls->write_date($row, 1, $log->time);
836         $myxls->write_string($row, 2, $log->ip);
837         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
838         $myxls->write_string($row, 3, $fullname);
839         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
840         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
841         $myxls->write_string($row, 5, $log->info);
843         $row++;
844     }
846     $workbook->close();
847     return true;
850 /**
851  * This function trawls through the logs looking for
852  * anything new since the user's last login
853  */
854 function print_recent_activity($course) {
855     // $course is an object
856     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
858     $context = context_course::instance($course->id);
860     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
862     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
864     if (!isguestuser()) {
865         if (!empty($USER->lastcourseaccess[$course->id])) {
866             if ($USER->lastcourseaccess[$course->id] > $timestart) {
867                 $timestart = $USER->lastcourseaccess[$course->id];
868             }
869         }
870     }
872     echo '<div class="activitydate">';
873     echo get_string('activitysince', '', userdate($timestart));
874     echo '</div>';
875     echo '<div class="activityhead">';
877     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
879     echo "</div>\n";
881     $content = false;
883 /// Firstly, have there been any new enrolments?
885     $users = get_recent_enrolments($course->id, $timestart);
887     //Accessibility: new users now appear in an <OL> list.
888     if ($users) {
889         echo '<div class="newusers">';
890         echo $OUTPUT->heading(get_string("newusers").':', 3);
891         $content = true;
892         echo "<ol class=\"list\">\n";
893         foreach ($users as $user) {
894             $fullname = fullname($user, $viewfullnames);
895             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
896         }
897         echo "</ol>\n</div>\n";
898     }
900 /// Next, have there been any modifications to the course structure?
902     $modinfo = get_fast_modinfo($course);
904     $changelist = array();
906     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
907                                             module = 'course' AND
908                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
909                                     array($timestart, $course->id), "id ASC");
911     if ($logs) {
912         $actions  = array('add mod', 'update mod', 'delete mod');
913         $newgones = array(); // added and later deleted items
914         foreach ($logs as $key => $log) {
915             if (!in_array($log->action, $actions)) {
916                 continue;
917             }
918             $info = explode(' ', $log->info);
920             // note: in most cases I replaced hardcoding of label with use of
921             // $cm->has_view() but it was not possible to do this here because
922             // we don't necessarily have the $cm for it
923             if ($info[0] == 'label') {     // Labels are ignored in recent activity
924                 continue;
925             }
927             if (count($info) != 2) {
928                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
929                 continue;
930             }
932             $modname    = $info[0];
933             $instanceid = $info[1];
935             if ($log->action == 'delete mod') {
936                 // unfortunately we do not know if the mod was visible
937                 if (!array_key_exists($log->info, $newgones)) {
938                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
939                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
940                 }
941             } else {
942                 if (!isset($modinfo->instances[$modname][$instanceid])) {
943                     if ($log->action == 'add mod') {
944                         // do not display added and later deleted activities
945                         $newgones[$log->info] = true;
946                     }
947                     continue;
948                 }
949                 $cm = $modinfo->instances[$modname][$instanceid];
950                 if (!$cm->uservisible) {
951                     continue;
952                 }
954                 if ($log->action == 'add mod') {
955                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
956                     $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
958                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
959                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
960                     $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
961                 }
962             }
963         }
964     }
966     if (!empty($changelist)) {
967         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
968         $content = true;
969         foreach ($changelist as $changeinfo => $change) {
970             echo '<p class="activity">'.$change['text'].'</p>';
971         }
972     }
974 /// Now display new things from each module
976     $usedmodules = array();
977     foreach($modinfo->cms as $cm) {
978         if (isset($usedmodules[$cm->modname])) {
979             continue;
980         }
981         if (!$cm->uservisible) {
982             continue;
983         }
984         $usedmodules[$cm->modname] = $cm->modname;
985     }
987     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
988         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
989             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
990             $print_recent_activity = $modname.'_print_recent_activity';
991             if (function_exists($print_recent_activity)) {
992                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
993                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
994             }
995         } else {
996             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
997         }
998     }
1000     if (! $content) {
1001         echo '<p class="message">'.get_string('nothingnew').'</p>';
1002     }
1005 /**
1006  * For a given course, returns an array of course activity objects
1007  * Each item in the array contains he following properties:
1008  */
1009 function get_array_of_activities($courseid) {
1010 //  cm - course module id
1011 //  mod - name of the module (eg forum)
1012 //  section - the number of the section (eg week or topic)
1013 //  name - the name of the instance
1014 //  visible - is the instance visible or not
1015 //  groupingid - grouping id
1016 //  groupmembersonly - is this instance visible to group members only
1017 //  extra - contains extra string to include in any link
1018     global $CFG, $DB;
1019     if(!empty($CFG->enableavailability)) {
1020         require_once($CFG->libdir.'/conditionlib.php');
1021     }
1023     $course = $DB->get_record('course', array('id'=>$courseid));
1025     if (empty($course)) {
1026         throw new moodle_exception('courseidnotfound');
1027     }
1029     $mod = array();
1031     $rawmods = get_course_mods($courseid);
1032     if (empty($rawmods)) {
1033         return $mod; // always return array
1034     }
1036     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1037        foreach ($sections as $section) {
1038            if (!empty($section->sequence)) {
1039                $sequence = explode(",", $section->sequence);
1040                foreach ($sequence as $seq) {
1041                    if (empty($rawmods[$seq])) {
1042                        continue;
1043                    }
1044                    $mod[$seq] = new stdClass();
1045                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1046                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1047                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1049                     // Oh dear. Inconsistent names left here for backward compatibility.
1050                    $mod[$seq]->section          = $section->section;
1051                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1053                    $mod[$seq]->module           = $rawmods[$seq]->module;
1054                    $mod[$seq]->added            = $rawmods[$seq]->added;
1055                    $mod[$seq]->score            = $rawmods[$seq]->score;
1056                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1057                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1058                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1059                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1060                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1061                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1062                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1063                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1064                    $mod[$seq]->extra            = "";
1065                    $mod[$seq]->completiongradeitemnumber =
1066                            $rawmods[$seq]->completiongradeitemnumber;
1067                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1068                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1069                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1070                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1071                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1072                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1073                    if (!empty($CFG->enableavailability)) {
1074                        condition_info::fill_availability_conditions($rawmods[$seq]);
1075                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1076                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1077                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
1078                    }
1080                    $modname = $mod[$seq]->mod;
1081                    $functionname = $modname."_get_coursemodule_info";
1083                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1084                        continue;
1085                    }
1087                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1089                    if ($hasfunction = function_exists($functionname)) {
1090                        if ($info = $functionname($rawmods[$seq])) {
1091                            if (!empty($info->icon)) {
1092                                $mod[$seq]->icon = $info->icon;
1093                            }
1094                            if (!empty($info->iconcomponent)) {
1095                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1096                            }
1097                            if (!empty($info->name)) {
1098                                $mod[$seq]->name = $info->name;
1099                            }
1100                            if ($info instanceof cached_cm_info) {
1101                                // When using cached_cm_info you can include three new fields
1102                                // that aren't available for legacy code
1103                                if (!empty($info->content)) {
1104                                    $mod[$seq]->content = $info->content;
1105                                }
1106                                if (!empty($info->extraclasses)) {
1107                                    $mod[$seq]->extraclasses = $info->extraclasses;
1108                                }
1109                                if (!empty($info->iconurl)) {
1110                                    $mod[$seq]->iconurl = $info->iconurl;
1111                                }
1112                                if (!empty($info->onclick)) {
1113                                    $mod[$seq]->onclick = $info->onclick;
1114                                }
1115                                if (!empty($info->customdata)) {
1116                                    $mod[$seq]->customdata = $info->customdata;
1117                                }
1118                            } else {
1119                                // When using a stdclass, the (horrible) deprecated ->extra field
1120                                // is available for BC
1121                                if (!empty($info->extra)) {
1122                                    $mod[$seq]->extra = $info->extra;
1123                                }
1124                            }
1125                        }
1126                    }
1127                    // When there is no modname_get_coursemodule_info function,
1128                    // but showdescriptions is enabled, then we use the 'intro'
1129                    // and 'introformat' fields in the module table
1130                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1131                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1132                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1133                            // Set content from intro and introformat. Filters are disabled
1134                            // because we  filter it with format_text at display time
1135                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1136                                    $modvalues, $rawmods[$seq]->id, false);
1138                            // To save making another query just below, put name in here
1139                            $mod[$seq]->name = $modvalues->name;
1140                        }
1141                    }
1142                    if (!isset($mod[$seq]->name)) {
1143                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1144                    }
1146                    // Minimise the database size by unsetting default options when they are
1147                    // 'empty'. This list corresponds to code in the cm_info constructor.
1148                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1149                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1150                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1151                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1152                            'completionview', 'completionexpected', 'score', 'showdescription')
1153                            as $property) {
1154                        if (property_exists($mod[$seq], $property) &&
1155                                empty($mod[$seq]->{$property})) {
1156                            unset($mod[$seq]->{$property});
1157                        }
1158                    }
1159                    // Special case: this value is usually set to null, but may be 0
1160                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1161                            is_null($mod[$seq]->completiongradeitemnumber)) {
1162                        unset($mod[$seq]->completiongradeitemnumber);
1163                    }
1164                }
1165             }
1166         }
1167     }
1168     return $mod;
1171 /**
1172  * Returns the localised human-readable names of all used modules
1173  *
1174  * @param bool $plural if true returns the plural forms of the names
1175  * @return array where key is the module name (component name without 'mod_') and
1176  *     the value is the human-readable string. Array sorted alphabetically by value
1177  */
1178 function get_module_types_names($plural = false) {
1179     static $modnames = null;
1180     global $DB, $CFG;
1181     if ($modnames === null) {
1182         $modnames = array(0 => array(), 1 => array());
1183         if ($allmods = $DB->get_records("modules")) {
1184             foreach ($allmods as $mod) {
1185                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1186                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1187                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1188                 }
1189             }
1190             collatorlib::asort($modnames[0]);
1191             collatorlib::asort($modnames[1]);
1192         }
1193     }
1194     return $modnames[(int)$plural];
1197 /**
1198  * Set highlighted section. Only one section can be highlighted at the time.
1199  *
1200  * @param int $courseid course id
1201  * @param int $marker highlight section with this number, 0 means remove higlightin
1202  * @return void
1203  */
1204 function course_set_marker($courseid, $marker) {
1205     global $DB;
1206     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1207     format_base::reset_course_cache($courseid);
1210 /**
1211  * For a given course section, marks it visible or hidden,
1212  * and does the same for every activity in that section
1213  *
1214  * @param int $courseid course id
1215  * @param int $sectionnumber The section number to adjust
1216  * @param int $visibility The new visibility
1217  * @return array A list of resources which were hidden in the section
1218  */
1219 function set_section_visible($courseid, $sectionnumber, $visibility) {
1220     global $DB;
1222     $resourcestotoggle = array();
1223     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1224         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1225         if (!empty($section->sequence)) {
1226             $modules = explode(",", $section->sequence);
1227             foreach ($modules as $moduleid) {
1228                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1229                     if ($visibility) {
1230                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1231                         set_coursemodule_visible($moduleid, $cm->visibleold);
1232                     } else {
1233                         // We hide the section, so we hide the module but we store the original state in visibleold.
1234                         set_coursemodule_visible($moduleid, 0);
1235                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1236                     }
1237                 }
1238             }
1239         }
1240         rebuild_course_cache($courseid, true);
1242         // Determine which modules are visible for AJAX update
1243         if (!empty($modules)) {
1244             list($insql, $params) = $DB->get_in_or_equal($modules);
1245             $select = 'id ' . $insql . ' AND visible = ?';
1246             array_push($params, $visibility);
1247             if (!$visibility) {
1248                 $select .= ' AND visibleold = 1';
1249             }
1250             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1251         }
1252     }
1253     return $resourcestotoggle;
1256 /**
1257  * Retrieve all metadata for the requested modules
1258  *
1259  * @param object $course The Course
1260  * @param array $modnames An array containing the list of modules and their
1261  * names
1262  * @param int $sectionreturn The section to return to
1263  * @return array A list of stdClass objects containing metadata about each
1264  * module
1265  */
1266 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1267     global $CFG, $OUTPUT;
1269     // get_module_metadata will be called once per section on the page and courses may show
1270     // different modules to one another
1271     static $modlist = array();
1272     if (!isset($modlist[$course->id])) {
1273         $modlist[$course->id] = array();
1274     }
1276     $return = array();
1277     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1278     if ($sectionreturn !== null) {
1279         $urlbase->param('sr', $sectionreturn);
1280     }
1281     foreach($modnames as $modname => $modnamestr) {
1282         if (!course_allowed_module($course, $modname)) {
1283             continue;
1284         }
1285         if (isset($modlist[$course->id][$modname])) {
1286             // This module is already cached
1287             $return[$modname] = $modlist[$course->id][$modname];
1288             continue;
1289         }
1291         // Include the module lib
1292         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1293         if (!file_exists($libfile)) {
1294             continue;
1295         }
1296         include_once($libfile);
1298         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1299         $gettypesfunc =  $modname.'_get_types';
1300         if (function_exists($gettypesfunc)) {
1301             if ($types = $gettypesfunc()) {
1302                 $group = new stdClass();
1303                 $group->name = $modname;
1304                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1305                 foreach($types as $type) {
1306                     if ($type->typestr === '--') {
1307                         continue;
1308                     }
1309                     if (strpos($type->typestr, '--') === 0) {
1310                         $group->title = str_replace('--', '', $type->typestr);
1311                         continue;
1312                     }
1313                     // Set the Sub Type metadata
1314                     $subtype = new stdClass();
1315                     $subtype->title = $type->typestr;
1316                     $subtype->type = str_replace('&amp;', '&', $type->type);
1317                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1318                     $subtype->archetype = $type->modclass;
1320                     // The group archetype should match the subtype archetypes and all subtypes
1321                     // should have the same archetype
1322                     $group->archetype = $subtype->archetype;
1324                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1325                         $subtype->help = get_string('help' . $subtype->name, $modname);
1326                     }
1327                     $subtype->link = new moodle_url($urlbase, array('add' => $subtype->type));
1328                     $group->types[] = $subtype;
1329                 }
1330                 $modlist[$course->id][$modname] = $group;
1331             }
1332         } else {
1333             $module = new stdClass();
1334             $module->title = $modnamestr;
1335             $module->name = $modname;
1336             $module->link = new moodle_url($urlbase, array('add' => $modname));
1337             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1338             $sm = get_string_manager();
1339             if ($sm->string_exists('modulename_help', $modname)) {
1340                 $module->help = get_string('modulename_help', $modname);
1341                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1342                     $link = get_string('modulename_link', $modname);
1343                     $linktext = get_string('morehelp');
1344                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1345                 }
1346             }
1347             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1348             $modlist[$course->id][$modname] = $module;
1349         }
1350         $return[$modname] = $modlist[$course->id][$modname];
1351     }
1353     return $return;
1356 /**
1357  * Return the course category context for the category with id $categoryid, except
1358  * that if $categoryid is 0, return the system context.
1359  *
1360  * @param integer $categoryid a category id or 0.
1361  * @return object the corresponding context
1362  */
1363 function get_category_or_system_context($categoryid) {
1364     if ($categoryid) {
1365         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1366     } else {
1367         return context_system::instance();
1368     }
1371 /**
1372  * Gets the child categories of a given courses category. Uses a static cache
1373  * to make repeat calls efficient.
1374  *
1375  * @param int $parentid the id of a course category.
1376  * @return array all the child course categories.
1377  */
1378 function get_child_categories($parentid) {
1379     static $allcategories = null;
1381     // only fill in this variable the first time
1382     if (null == $allcategories) {
1383         $allcategories = array();
1385         $categories = get_categories();
1386         foreach ($categories as $category) {
1387             if (empty($allcategories[$category->parent])) {
1388                 $allcategories[$category->parent] = array();
1389             }
1390             $allcategories[$category->parent][] = $category;
1391         }
1392     }
1394     if (empty($allcategories[$parentid])) {
1395         return array();
1396     } else {
1397         return $allcategories[$parentid];
1398     }
1401 /**
1402  * This function recursively travels the categories, building up a nice list
1403  * for display. It also makes an array that list all the parents for each
1404  * category.
1405  *
1406  * For example, if you have a tree of categories like:
1407  *   Miscellaneous (id = 1)
1408  *      Subcategory (id = 2)
1409  *         Sub-subcategory (id = 4)
1410  *   Other category (id = 3)
1411  * Then after calling this function you will have
1412  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1413  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1414  *      3 => 'Other category');
1415  * $parents = array(2 => array(1), 4 => array(1, 2));
1416  *
1417  * If you specify $requiredcapability, then only categories where the current
1418  * user has that capability will be added to $list, although all categories
1419  * will still be added to $parents, and if you only have $requiredcapability
1420  * in a child category, not the parent, then the child catgegory will still be
1421  * included.
1422  *
1423  * If you specify the option $excluded, then that category, and all its children,
1424  * are omitted from the tree. This is useful when you are doing something like
1425  * moving categories, where you do not want to allow people to move a category
1426  * to be the child of itself.
1427  *
1428  * @param array $list For output, accumulates an array categoryid => full category path name
1429  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1430  * @param string/array $requiredcapability if given, only categories where the current
1431  *      user has this capability will be added to $list. Can also be an array of capabilities,
1432  *      in which case they are all required.
1433  * @param integer $excludeid Omit this category and its children from the lists built.
1434  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1435  * @param string $path For internal use, as part of recursive calls.
1436  */
1437 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1438         $excludeid = 0, $category = NULL, $path = "") {
1440     // initialize the arrays if needed
1441     if (!is_array($list)) {
1442         $list = array();
1443     }
1444     if (!is_array($parents)) {
1445         $parents = array();
1446     }
1448     if (empty($category)) {
1449         // Start at the top level.
1450         $category = new stdClass;
1451         $category->id = 0;
1452     } else {
1453         // This is the excluded category, don't include it.
1454         if ($excludeid > 0 && $excludeid == $category->id) {
1455             return;
1456         }
1458         $context = context_coursecat::instance($category->id);
1459         $categoryname = format_string($category->name, true, array('context' => $context));
1461         // Update $path.
1462         if ($path) {
1463             $path = $path.' / '.$categoryname;
1464         } else {
1465             $path = $categoryname;
1466         }
1468         // Add this category to $list, if the permissions check out.
1469         if (empty($requiredcapability)) {
1470             $list[$category->id] = $path;
1472         } else {
1473             $requiredcapability = (array)$requiredcapability;
1474             if (has_all_capabilities($requiredcapability, $context)) {
1475                 $list[$category->id] = $path;
1476             }
1477         }
1478     }
1480     // Add all the children recursively, while updating the parents array.
1481     if ($categories = get_child_categories($category->id)) {
1482         foreach ($categories as $cat) {
1483             if (!empty($category->id)) {
1484                 if (isset($parents[$category->id])) {
1485                     $parents[$cat->id]   = $parents[$category->id];
1486                 }
1487                 $parents[$cat->id][] = $category->id;
1488             }
1489             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1490         }
1491     }
1494 /**
1495  * This function generates a structured array of courses and categories.
1496  *
1497  * The depth of categories is limited by $CFG->maxcategorydepth however there
1498  * is no limit on the number of courses!
1499  *
1500  * Suitable for use with the course renderers course_category_tree method:
1501  * $renderer = $PAGE->get_renderer('core','course');
1502  * echo $renderer->course_category_tree(get_course_category_tree());
1503  *
1504  * @global moodle_database $DB
1505  * @param int $id
1506  * @param int $depth
1507  */
1508 function get_course_category_tree($id = 0, $depth = 0) {
1509     global $DB, $CFG;
1510     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
1511     $categories = get_child_categories($id);
1512     $categoryids = array();
1513     foreach ($categories as $key => &$category) {
1514         if (!$category->visible && !$viewhiddencats) {
1515             unset($categories[$key]);
1516             continue;
1517         }
1518         $categoryids[$category->id] = $category;
1519         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1520             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1521             foreach ($subcategories as $subid=>$subcat) {
1522                 $categoryids[$subid] = $subcat;
1523             }
1524             $category->courses = array();
1525         }
1526     }
1528     if ($depth > 0) {
1529         // This is a recursive call so return the required array
1530         return array($categories, $categoryids);
1531     }
1533     if (empty($categoryids)) {
1534         // No categories available (probably all hidden).
1535         return array();
1536     }
1538     // The depth is 0 this function has just been called so we can finish it off
1540     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1541     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1542     $sql = "SELECT
1543             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1544             $ccselect
1545             FROM {course} c
1546             $ccjoin
1547             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1548     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1549         // loop throught them
1550         foreach ($courses as $course) {
1551             if ($course->id == SITEID) {
1552                 continue;
1553             }
1554             context_instance_preload($course);
1555             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1556                 $categoryids[$course->category]->courses[$course->id] = $course;
1557             }
1558         }
1559     }
1560     return $categories;
1563 /**
1564  * Recursive function to print out all the categories in a nice format
1565  * with or without courses included
1566  */
1567 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1568     global $CFG;
1570     // maxcategorydepth == 0 meant no limit
1571     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1572         return;
1573     }
1575     if (!$displaylist) {
1576         make_categories_list($displaylist, $parentslist);
1577     }
1579     if (!$categorycourses) {
1580         if ($category) {
1581             $categorycourses = get_category_courses($category->id);
1582         } else {
1583             $categorycourses = get_category_courses();
1584         }
1585     }
1587     if ($category) {
1588         if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
1589             print_category_info($category, $depth, $showcourses, $categorycourses[$category->id]);
1590         } else {
1591             return;  // Don't bother printing children of invisible categories
1592         }
1594     } else {
1595         $category = new stdClass();
1596         $category->id = "0";
1597     }
1599     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
1600         $countcats = count($categories);
1601         $count = 0;
1602         $first = true;
1603         $last = false;
1604         foreach ($categories as $cat) {
1605             $count++;
1606             if ($count == $countcats) {
1607                 $last = true;
1608             }
1609             $up = $first ? false : true;
1610             $down = $last ? false : true;
1611             $first = false;
1613             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses, $categorycourses);
1614         }
1615     }
1618 /**
1619  * Gets an array whose keys are category ids and whose values are arrays of courses in the corresponding category.
1620  *
1621  * @param int $categoryid
1622  * @return array
1623  */
1624 function get_category_courses_array($categoryid = 0) {
1625     $tree = get_course_category_tree($categoryid);
1626     $flattened = array();
1627     foreach ($tree as $category) {
1628         get_category_courses_array_recursively($flattened, $category);
1629     }
1630     return $flattened;
1633 /**
1634  * Recursive function to help flatten the course category tree.
1635  *
1636  * Do not call this function directly, instead calll its parent function {@link get_category_courses_array}
1637  *
1638  * @param array &$flattened An array passed by reference in which to store courses for each category.
1639  * @param stdClass $category The category to get courses for.
1640  */
1641 function get_category_courses_array_recursively(array &$flattened, $category) {
1642     $flattened[$category->id] = $category->courses;
1643     foreach ($category->categories as $childcategory) {
1644         get_category_courses_array_recursively($flattened, $childcategory);
1645     }
1648 /**
1649  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
1650  */
1651 function make_categories_options() {
1652     make_categories_list($cats,$parents);
1653     foreach ($cats as $key => $value) {
1654         if (array_key_exists($key,$parents)) {
1655             if ($indent = count($parents[$key])) {
1656                 for ($i = 0; $i < $indent; $i++) {
1657                     $cats[$key] = '&nbsp;'.$cats[$key];
1658                 }
1659             }
1660         }
1661     }
1662     return $cats;
1665 /**
1666  * Prints the category information.
1667  *
1668  * This function is only used by print_whole_category_list() above
1669  *
1670  * @param stdClass $category
1671  * @param int $depth The depth of the category.
1672  * @param bool $showcourses If set to true course information will also be printed.
1673  * @param array|null $courses An array of courses belonging to the category, or null if you don't have it yet.
1674  */
1675 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1676     global $CFG, $DB, $OUTPUT;
1678     $strsummary = get_string('summary');
1680     $catlinkcss = null;
1681     if (!$category->visible) {
1682         $catlinkcss = array('class'=>'dimmed');
1683     }
1684     static $coursecount = null;
1685     if (null === $coursecount) {
1686         // only need to check this once
1687         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
1688     }
1690     if ($showcourses and $coursecount) {
1691         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
1692     } else {
1693         $catimage = "&nbsp;";
1694     }
1696     if (is_null($courses)) {
1697         $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
1698     }
1699     $context = context_coursecat::instance($category->id);
1700     $fullname = format_string($category->name, true, array('context' => $context));
1702     if ($showcourses and $coursecount) {
1703         echo '<div class="categorylist clearfix">';
1704         $cat = '';
1705         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
1706         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1707         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
1709         $html = '';
1710         if ($depth > 0) {
1711             for ($i=0; $i< $depth; $i++) {
1712                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
1713                 $cat = '';
1714             }
1715         } else {
1716             $html = $cat;
1717         }
1718         echo html_writer::tag('div', $html, array('class'=>'category'));
1719         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1721         // does the depth exceed maxcategorydepth
1722         // maxcategorydepth == 0 or unset meant no limit
1723         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
1724         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
1725             foreach ($courses as $course) {
1726                 $linkcss = null;
1727                 if (!$course->visible) {
1728                     $linkcss = array('class'=>'dimmed');
1729                 }
1731                 $coursename = get_course_display_name_for_list($course);
1732                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
1734                 // print enrol info
1735                 $courseicon = '';
1736                 if ($icons = enrol_get_course_info_icons($course)) {
1737                     foreach ($icons as $pix_icon) {
1738                         $courseicon = $OUTPUT->render($pix_icon);
1739                     }
1740                 }
1742                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
1744                 if ($course->summary) {
1745                     $link = new moodle_url('/course/info.php?id='.$course->id);
1746                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
1747                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
1748                         array('title'=>$strsummary));
1750                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
1751                 }
1753                 $html = '';
1754                 for ($i=0; $i <= $depth; $i++) {
1755                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
1756                     $coursecontent = '';
1757                 }
1758                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
1759             }
1760         }
1761         echo '</div>';
1762     } else {
1763         echo '<div class="categorylist">';
1764         $html = '';
1765         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1766         if (count($courses) > 0) {
1767             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
1768         }
1770         if ($depth > 0) {
1771             for ($i=0; $i< $depth; $i++) {
1772                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
1773                 $cat = '';
1774             }
1775         } else {
1776             $html = $cat;
1777         }
1779         echo html_writer::tag('div', $html, array('class'=>'category'));
1780         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1781         echo '</div>';
1782     }
1785 /**
1786  * Print the buttons relating to course requests.
1787  *
1788  * @param object $systemcontext the system context.
1789  */
1790 function print_course_request_buttons($systemcontext) {
1791     global $CFG, $DB, $OUTPUT;
1792     if (empty($CFG->enablecourserequests)) {
1793         return;
1794     }
1795     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
1796     /// Print a button to request a new course
1797         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
1798     }
1799     /// Print a button to manage pending requests
1800     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
1801         $disabled = !$DB->record_exists('course_request', array());
1802         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
1803     }
1806 /**
1807  * Does the user have permission to edit things in this category?
1808  *
1809  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1810  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1811  */
1812 function can_edit_in_category($categoryid = 0) {
1813     $context = get_category_or_system_context($categoryid);
1814     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1817 /**
1818  * Prints the turn editing on/off button on course/index.php or course/category.php.
1819  *
1820  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1821  * @return string HTML of the editing button, or empty string, if this user is not allowed
1822  *      to see it.
1823  */
1824 function update_category_button($categoryid = 0) {
1825     global $CFG, $PAGE, $OUTPUT;
1827     // Check permissions.
1828     if (!can_edit_in_category($categoryid)) {
1829         return '';
1830     }
1832     // Work out the appropriate action.
1833     if ($PAGE->user_is_editing()) {
1834         $label = get_string('turneditingoff');
1835         $edit = 'off';
1836     } else {
1837         $label = get_string('turneditingon');
1838         $edit = 'on';
1839     }
1841     // Generate the button HTML.
1842     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
1843     if ($categoryid) {
1844         $options['id'] = $categoryid;
1845         $page = 'category.php';
1846     } else {
1847         $page = 'index.php';
1848     }
1849     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
1852 /**
1853  * Print courses in category. If category is 0 then all courses are printed.
1854  * @param int|stdClass $category category object or id.
1855  * @return bool true if courses found and printed, else false.
1856  */
1857 function print_courses($category) {
1858     global $CFG, $OUTPUT;
1860     if (!is_object($category) && $category==0) {
1861         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
1862         if (is_array($categories) && count($categories) == 1) {
1863             $category   = array_shift($categories);
1864             $courses    = get_courses_wmanagers($category->id,
1865                                                 'c.sortorder ASC',
1866                                                 array('summary','summaryformat'));
1867         } else {
1868             $courses    = get_courses_wmanagers('all',
1869                                                 'c.sortorder ASC',
1870                                                 array('summary','summaryformat'));
1871         }
1872         unset($categories);
1873     } else {
1874         $courses    = get_courses_wmanagers($category->id,
1875                                             'c.sortorder ASC',
1876                                             array('summary','summaryformat'));
1877     }
1879     if ($courses) {
1880         echo html_writer::start_tag('ul', array('class'=>'unlist'));
1881         foreach ($courses as $course) {
1882             $coursecontext = context_course::instance($course->id);
1883             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
1884                 echo html_writer::start_tag('li');
1885                 print_course($course);
1886                 echo html_writer::end_tag('li');
1887             }
1888         }
1889         echo html_writer::end_tag('ul');
1890     } else {
1891         echo $OUTPUT->heading(get_string("nocoursesyet"));
1892         $context = context_system::instance();
1893         if (has_capability('moodle/course:create', $context)) {
1894             $options = array();
1895             if (!empty($category->id)) {
1896                 $options['category'] = $category->id;
1897             } else {
1898                 $options['category'] = $CFG->defaultrequestcategory;
1899             }
1900             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
1901             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
1902             echo html_writer::end_tag('div');
1903             return false;
1904         }
1905     }
1906     return true;
1909 /**
1910  * Print a description of a course, suitable for browsing in a list.
1911  *
1912  * @param object $course the course object.
1913  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
1914  */
1915 function print_course($course, $highlightterms = '') {
1916     global $CFG, $USER, $DB, $OUTPUT;
1918     $context = context_course::instance($course->id);
1920     // Rewrite file URLs so that they are correct
1921     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
1923     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
1924     echo html_writer::start_tag('div', array('class'=>'info'));
1925     echo html_writer::start_tag('h3', array('class'=>'name'));
1927     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
1929     $coursename = get_course_display_name_for_list($course);
1930     $linktext = highlight($highlightterms, format_string($coursename));
1931     $linkparams = array('title'=>get_string('entercourse'));
1932     if (empty($course->visible)) {
1933         $linkparams['class'] = 'dimmed';
1934     }
1935     echo html_writer::link($linkhref, $linktext, $linkparams);
1936     echo html_writer::end_tag('h3');
1938     /// first find all roles that are supposed to be displayed
1939     if (!empty($CFG->coursecontact)) {
1940         $managerroles = explode(',', $CFG->coursecontact);
1941         $rusers = array();
1943         if (!isset($course->managers)) {
1944             list($sort, $sortparams) = users_order_by_sql('u');
1945             $rusers = get_role_users($managerroles, $context, true,
1946                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
1947                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
1948                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
1949         } else {
1950             //  use the managers array if we have it for perf reasosn
1951             //  populate the datastructure like output of get_role_users();
1952             foreach ($course->managers as $manager) {
1953                 $user = clone($manager->user);
1954                 $user->roleid = $manager->roleid;
1955                 $user->rolename = $manager->rolename;
1956                 $user->roleshortname = $manager->roleshortname;
1957                 $user->rolecoursealias = $manager->rolecoursealias;
1958                 $rusers[$user->id] = $user;
1959             }
1960         }
1962         $namesarray = array();
1963         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
1964         foreach ($rusers as $ra) {
1965             if (isset($namesarray[$ra->id])) {
1966                 //  only display a user once with the higest sortorder role
1967                 continue;
1968             }
1970             $role = new stdClass();
1971             $role->id = $ra->roleid;
1972             $role->name = $ra->rolename;
1973             $role->shortname = $ra->roleshortname;
1974             $role->coursealias = $ra->rolecoursealias;
1975             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
1977             $fullname = fullname($ra, $canviewfullnames);
1978             $namesarray[$ra->id] = $rolename.': '.
1979                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
1980         }
1982         if (!empty($namesarray)) {
1983             echo html_writer::start_tag('ul', array('class'=>'teachers'));
1984             foreach ($namesarray as $name) {
1985                 echo html_writer::tag('li', $name);
1986             }
1987             echo html_writer::end_tag('ul');
1988         }
1989     }
1990     echo html_writer::end_tag('div'); // End of info div
1992     echo html_writer::start_tag('div', array('class'=>'summary'));
1993     $options = new stdClass();
1994     $options->noclean = true;
1995     $options->para = false;
1996     $options->overflowdiv = true;
1997     if (!isset($course->summaryformat)) {
1998         $course->summaryformat = FORMAT_MOODLE;
1999     }
2000     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2001     if ($icons = enrol_get_course_info_icons($course)) {
2002         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2003         foreach ($icons as $icon) {
2004             echo $OUTPUT->render($icon);
2005         }
2006         echo html_writer::end_tag('div'); // End of enrolmenticons div
2007     }
2008     echo html_writer::end_tag('div'); // End of summary div
2009     echo html_writer::end_tag('div'); // End of coursebox div
2012 /**
2013  * Prints custom user information on the home page.
2014  * Over time this can include all sorts of information
2015  */
2016 function print_my_moodle() {
2017     global $USER, $CFG, $DB, $OUTPUT;
2019     if (!isloggedin() or isguestuser()) {
2020         print_error('nopermissions', '', '', 'See My Moodle');
2021     }
2023     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2024     $rhosts   = array();
2025     $rcourses = array();
2026     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2027         $rcourses = get_my_remotecourses($USER->id);
2028         $rhosts   = get_my_remotehosts();
2029     }
2031     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2033         if (!empty($courses)) {
2034             echo '<ul class="unlist">';
2035             foreach ($courses as $course) {
2036                 if ($course->id == SITEID) {
2037                     continue;
2038                 }
2039                 echo '<li>';
2040                 print_course($course);
2041                 echo "</li>\n";
2042             }
2043             echo "</ul>\n";
2044         }
2046         // MNET
2047         if (!empty($rcourses)) {
2048             // at the IDP, we know of all the remote courses
2049             foreach ($rcourses as $course) {
2050                 print_remote_course($course, "100%");
2051             }
2052         } elseif (!empty($rhosts)) {
2053             // non-IDP, we know of all the remote servers, but not courses
2054             foreach ($rhosts as $host) {
2055                 print_remote_host($host, "100%");
2056             }
2057         }
2058         unset($course);
2059         unset($host);
2061         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2062             echo "<table width=\"100%\"><tr><td align=\"center\">";
2063             print_course_search("", false, "short");
2064             echo "</td><td align=\"center\">";
2065             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2066             echo "</td></tr></table>\n";
2067         }
2069     } else {
2070         if ($DB->count_records("course_categories") > 1) {
2071             echo $OUTPUT->box_start("categorybox");
2072             print_whole_category_list();
2073             echo $OUTPUT->box_end();
2074         } else {
2075             print_courses(0);
2076         }
2077     }
2081 function print_course_search($value="", $return=false, $format="plain") {
2082     global $CFG;
2083     static $count = 0;
2085     $count++;
2087     $id = 'coursesearch';
2089     if ($count > 1) {
2090         $id .= $count;
2091     }
2093     $strsearchcourses= get_string("searchcourses");
2095     if ($format == 'plain') {
2096         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2097         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2098         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2099         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2100         $output .= '<input type="submit" value="'.get_string('go').'" />';
2101         $output .= '</fieldset></form>';
2102     } else if ($format == 'short') {
2103         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2104         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2105         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2106         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2107         $output .= '<input type="submit" value="'.get_string('go').'" />';
2108         $output .= '</fieldset></form>';
2109     } else if ($format == 'navbar') {
2110         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2111         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2112         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2113         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2114         $output .= '<input type="submit" value="'.get_string('go').'" />';
2115         $output .= '</fieldset></form>';
2116     }
2118     if ($return) {
2119         return $output;
2120     }
2121     echo $output;
2124 function print_remote_course($course, $width="100%") {
2125     global $CFG, $USER;
2127     $linkcss = '';
2129     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2131     echo '<div class="coursebox remotecoursebox clearfix">';
2132     echo '<div class="info">';
2133     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2134          $linkcss.' href="'.$url.'">'
2135         .  format_string($course->fullname) .'</a><br />'
2136         . format_string($course->hostname) . ' : '
2137         . format_string($course->cat_name) . ' : '
2138         . format_string($course->shortname). '</div>';
2139     echo '</div><div class="summary">';
2140     $options = new stdClass();
2141     $options->noclean = true;
2142     $options->para = false;
2143     $options->overflowdiv = true;
2144     echo format_text($course->summary, $course->summaryformat, $options);
2145     echo '</div>';
2146     echo '</div>';
2149 function print_remote_host($host, $width="100%") {
2150     global $OUTPUT;
2152     $linkcss = '';
2154     echo '<div class="coursebox clearfix">';
2155     echo '<div class="info">';
2156     echo '<div class="name">';
2157     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2158     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2159         . s($host['name']).'</a> - ';
2160     echo $host['count'] . ' ' . get_string('courses');
2161     echo '</div>';
2162     echo '</div>';
2163     echo '</div>';
2167 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2169 function add_course_module($mod) {
2170     global $DB;
2172     $mod->added = time();
2173     unset($mod->id);
2175     $cmid = $DB->insert_record("course_modules", $mod);
2176     rebuild_course_cache($mod->course, true);
2177     return $cmid;
2180 /**
2181  * Creates missing course section(s) and rebuilds course cache
2182  *
2183  * @param int|stdClass $courseorid course id or course object
2184  * @param int|array $sections list of relative section numbers to create
2185  * @return bool if there were any sections created
2186  */
2187 function course_create_sections_if_missing($courseorid, $sections) {
2188     global $DB;
2189     if (!is_array($sections)) {
2190         $sections = array($sections);
2191     }
2192     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2193     if (is_object($courseorid)) {
2194         $courseorid = $courseorid->id;
2195     }
2196     $coursechanged = false;
2197     foreach ($sections as $sectionnum) {
2198         if (!in_array($sectionnum, $existing)) {
2199             $cw = new stdClass();
2200             $cw->course   = $courseorid;
2201             $cw->section  = $sectionnum;
2202             $cw->summary  = '';
2203             $cw->summaryformat = FORMAT_HTML;
2204             $cw->sequence = '';
2205             $id = $DB->insert_record("course_sections", $cw);
2206             $coursechanged = true;
2207         }
2208     }
2209     if ($coursechanged) {
2210         rebuild_course_cache($courseorid, true);
2211     }
2212     return $coursechanged;
2215 /**
2216  * Adds an existing module to the section
2217  *
2218  * Updates both tables {course_sections} and {course_modules}
2219  *
2220  * @param int|stdClass $courseorid course id or course object
2221  * @param int $cmid id of the module already existing in course_modules table
2222  * @param int $sectionnum relative number of the section (field course_sections.section)
2223  *     If section does not exist it will be created
2224  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2225  *     before which the module needs to be included. Null for inserting in the
2226  *     end of the section
2227  * @return int The course_sections ID where the module is inserted
2228  */
2229 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
2230     global $DB, $COURSE;
2231     if (is_object($beforemod)) {
2232         $beforemod = $beforemod->id;
2233     }
2234     if (is_object($courseorid)) {
2235         $courseid = $courseorid->id;
2236     } else {
2237         $courseid = $courseorid;
2238     }
2239     course_create_sections_if_missing($courseorid, $sectionnum);
2240     // Do not try to use modinfo here, there is no guarantee it is valid!
2241     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
2242     $modarray = explode(",", trim($section->sequence));
2243     if (empty($section->sequence)) {
2244         $newsequence = "$cmid";
2245     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2246         $insertarray = array($cmid, $beforemod);
2247         array_splice($modarray, $key[0], 1, $insertarray);
2248         $newsequence = implode(",", $modarray);
2249     } else {
2250         $newsequence = "$section->sequence,$cmid";
2251     }
2252     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2253     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
2254     if (is_object($courseorid)) {
2255         rebuild_course_cache($courseorid->id, true);
2256     } else {
2257         rebuild_course_cache($courseorid, true);
2258     }
2259     return $section->id;     // Return course_sections ID that was used.
2262 function set_coursemodule_groupmode($id, $groupmode) {
2263     global $DB;
2264     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2265     if ($cm->groupmode != $groupmode) {
2266         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2267         rebuild_course_cache($cm->course, true);
2268     }
2269     return ($cm->groupmode != $groupmode);
2272 function set_coursemodule_idnumber($id, $idnumber) {
2273     global $DB;
2274     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2275     if ($cm->idnumber != $idnumber) {
2276         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2277         rebuild_course_cache($cm->course, true);
2278     }
2279     return ($cm->idnumber != $idnumber);
2282 /**
2283  * Set the visibility of a module and inherent properties.
2284  *
2285  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
2286  * has been moved to {@link set_section_visible()} which was the only place from which
2287  * the parameter was used.
2288  *
2289  * @param int $id of the module
2290  * @param int $visible state of the module
2291  * @return bool false when the module was not found, true otherwise
2292  */
2293 function set_coursemodule_visible($id, $visible) {
2294     global $DB, $CFG;
2295     require_once($CFG->libdir.'/gradelib.php');
2297     // Trigger developer's attention when using the previously removed argument.
2298     if (func_num_args() > 2) {
2299         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
2300             has been removed.', DEBUG_DEVELOPER);
2301     }
2303     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2304         return false;
2305     }
2306     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2307         return false;
2308     }
2309     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2310         foreach($events as $event) {
2311             if ($visible) {
2312                 show_event($event);
2313             } else {
2314                 hide_event($event);
2315             }
2316         }
2317     }
2319     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2320     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2321     if ($grade_items) {
2322         foreach ($grade_items as $grade_item) {
2323             $grade_item->set_hidden(!$visible);
2324         }
2325     }
2327     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
2328     // affect visibleold to allow for an original visibility restore. See set_section_visible().
2329     $cminfo = new stdClass();
2330     $cminfo->id = $id;
2331     $cminfo->visible = $visible;
2332     $cminfo->visibleold = $visible;
2333     $DB->update_record('course_modules', $cminfo);
2335     rebuild_course_cache($cm->course, true);
2336     return true;
2339 /**
2340  * Delete a course module and any associated data at the course level (events)
2341  * Until 1.5 this function simply marked a deleted flag ... now it
2342  * deletes it completely.
2343  *
2344  */
2345 function delete_course_module($id) {
2346     global $CFG, $DB;
2347     require_once($CFG->libdir.'/gradelib.php');
2348     require_once($CFG->dirroot.'/blog/lib.php');
2350     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2351         return true;
2352     }
2353     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2354     //delete events from calendar
2355     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2356         foreach($events as $event) {
2357             delete_event($event->id);
2358         }
2359     }
2360     //delete grade items, outcome items and grades attached to modules
2361     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2362                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2363         foreach ($grade_items as $grade_item) {
2364             $grade_item->delete('moddelete');
2365         }
2366     }
2367     // Delete completion and availability data; it is better to do this even if the
2368     // features are not turned on, in case they were turned on previously (these will be
2369     // very quick on an empty table)
2370     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2371     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2372     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2373     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2374                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2376     delete_context(CONTEXT_MODULE, $cm->id);
2377     $DB->delete_records('course_modules', array('id'=>$cm->id));
2378     rebuild_course_cache($cm->course, true);
2379     return true;
2382 function delete_mod_from_section($modid, $sectionid) {
2383     global $DB;
2385     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2387         $modarray = explode(",", $section->sequence);
2389         if ($key = array_keys ($modarray, $modid)) {
2390             array_splice($modarray, $key[0], 1);
2391             $newsequence = implode(",", $modarray);
2392             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2393             rebuild_course_cache($section->course, true);
2394             return true;
2395         } else {
2396             return false;
2397         }
2399     }
2400     return false;
2403 /**
2404  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2405  *
2406  * @param object $course course object
2407  * @param int $section Section number (not id!!!)
2408  * @param int $move (-1 or 1)
2409  * @return boolean true if section moved successfully
2410  * @todo MDL-33379 remove this function in 2.5
2411  */
2412 function move_section($course, $section, $move) {
2413     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2415 /// Moves a whole course section up and down within the course
2416     global $USER;
2418     if (!$move) {
2419         return true;
2420     }
2422     $sectiondest = $section + $move;
2424     // compartibility with course formats using field 'numsections'
2425     $courseformatoptions = course_get_format($course)->get_format_options();
2426     if (array_key_exists('numsections', $courseformatoptions) &&
2427             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2428         return false;
2429     }
2431     $retval = move_section_to($course, $section, $sectiondest);
2432     return $retval;
2435 /**
2436  * Moves a section within a course, from a position to another.
2437  * Be very careful: $section and $destination refer to section number,
2438  * not id!.
2439  *
2440  * @param object $course
2441  * @param int $section Section number (not id!!!)
2442  * @param int $destination
2443  * @return boolean Result
2444  */
2445 function move_section_to($course, $section, $destination) {
2446 /// Moves a whole course section up and down within the course
2447     global $USER, $DB;
2449     if (!$destination && $destination != 0) {
2450         return true;
2451     }
2453     // compartibility with course formats using field 'numsections'
2454     $courseformatoptions = course_get_format($course)->get_format_options();
2455     if ((array_key_exists('numsections', $courseformatoptions) &&
2456             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
2457         return false;
2458     }
2460     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2461     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2462             'section ASC, id ASC', 'id, section')) {
2463         return false;
2464     }
2466     $movedsections = reorder_sections($sections, $section, $destination);
2468     // Update all sections. Do this in 2 steps to avoid breaking database
2469     // uniqueness constraint
2470     $transaction = $DB->start_delegated_transaction();
2471     foreach ($movedsections as $id => $position) {
2472         if ($sections[$id] !== $position) {
2473             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2474         }
2475     }
2476     foreach ($movedsections as $id => $position) {
2477         if ($sections[$id] !== $position) {
2478             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2479         }
2480     }
2482     // If we move the highlighted section itself, then just highlight the destination.
2483     // Adjust the higlighted section location if we move something over it either direction.
2484     if ($section == $course->marker) {
2485         course_set_marker($course->id, $destination);
2486     } elseif ($section > $course->marker && $course->marker >= $destination) {
2487         course_set_marker($course->id, $course->marker+1);
2488     } elseif ($section < $course->marker && $course->marker <= $destination) {
2489         course_set_marker($course->id, $course->marker-1);
2490     }
2492     $transaction->allow_commit();
2493     rebuild_course_cache($course->id, true);
2494     return true;
2497 /**
2498  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2499  * an original position number and a target position number, rebuilds the array so that the
2500  * move is made without any duplication of section positions.
2501  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2502  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2503  *
2504  * @param array $sections
2505  * @param int $origin_position
2506  * @param int $target_position
2507  * @return array
2508  */
2509 function reorder_sections($sections, $origin_position, $target_position) {
2510     if (!is_array($sections)) {
2511         return false;
2512     }
2514     // We can't move section position 0
2515     if ($origin_position < 1) {
2516         echo "We can't move section position 0";
2517         return false;
2518     }
2520     // Locate origin section in sections array
2521     if (!$origin_key = array_search($origin_position, $sections)) {
2522         echo "searched position not in sections array";
2523         return false; // searched position not in sections array
2524     }
2526     // Extract origin section
2527     $origin_section = $sections[$origin_key];
2528     unset($sections[$origin_key]);
2530     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2531     $found = false;
2532     $append_array = array();
2533     foreach ($sections as $id => $position) {
2534         if ($found) {
2535             $append_array[$id] = $position;
2536             unset($sections[$id]);
2537         }
2538         if ($position == $target_position) {
2539             if ($target_position < $origin_position) {
2540                 $append_array[$id] = $position;
2541                 unset($sections[$id]);
2542             }
2543             $found = true;
2544         }
2545     }
2547     // Append moved section
2548     $sections[$origin_key] = $origin_section;
2550     // Append rest of array (if applicable)
2551     if (!empty($append_array)) {
2552         foreach ($append_array as $id => $position) {
2553             $sections[$id] = $position;
2554         }
2555     }
2557     // Renumber positions
2558     $position = 0;
2559     foreach ($sections as $id => $p) {
2560         $sections[$id] = $position;
2561         $position++;
2562     }
2564     return $sections;
2568 /**
2569  * Move the module object $mod to the specified $section
2570  * If $beforemod exists then that is the module
2571  * before which $modid should be inserted
2572  * All parameters are objects
2573  */
2574 function moveto_module($mod, $section, $beforemod=NULL) {
2575     global $OUTPUT;
2577 /// Remove original module from original section
2578     if (! delete_mod_from_section($mod->id, $mod->section)) {
2579         echo $OUTPUT->notification("Could not delete module from existing section");
2580     }
2582     // if moving to a hidden section then hide module
2583     if (!$section->visible && $mod->visible) {
2584         set_coursemodule_visible($mod->id, 0);
2585     }
2587 /// Add the module into the new section
2588     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
2589     return true;
2592 /**
2593  * Returns the list of all editing actions that current user can perform on the module
2594  *
2595  * @param cm_info $mod The module to produce editing buttons for
2596  * @param int $indent The current indenting (default -1 means no move left-right actions)
2597  * @param int $sr The section to link back to (used for creating the links)
2598  * @return array array of action_link or pix_icon objects
2599  */
2600 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2601     global $COURSE, $SITE;
2603     static $str;
2605     $coursecontext = context_course::instance($mod->course);
2606     $modcontext = context_module::instance($mod->id);
2608     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2609     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2611     // no permission to edit anything
2612     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2613         return array();
2614     }
2616     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2618     if (!isset($str)) {
2619         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2620             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
2621         $str->assign         = get_string('assignroles', 'role');
2622         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2623         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2624         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2625         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
2626         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
2627         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
2628     }
2630     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2632     if ($sr !== null) {
2633         $baseurl->param('sr', $sr);
2634     }
2635     $actions = array();
2637     // AJAX edit title
2638     if ($mod->modname !== 'label' && $hasmanageactivities &&
2639                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
2640                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
2641         // we will not display link if we are on some other-course page (where we should not see this module anyway)
2642         $actions['title'] = new action_link(
2643             new moodle_url($baseurl, array('update' => $mod->id)),
2644             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2645             null,
2646             array('class' => 'editing_title', 'title' => $str->edittitle)
2647         );
2648     }
2650     // leftright
2651     if ($hasmanageactivities) {
2652         if (right_to_left()) {   // Exchange arrows on RTL
2653             $rightarrow = 't/left';
2654             $leftarrow  = 't/right';
2655         } else {
2656             $rightarrow = 't/right';
2657             $leftarrow  = 't/left';
2658         }
2660         if ($indent > 0) {
2661             $actions['moveleft'] = new action_link(
2662                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
2663                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2664                 null,
2665                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
2666             );
2667         }
2668         if ($indent >= 0) {
2669             $actions['moveright'] = new action_link(
2670                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2671                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2672                 null,
2673                 array('class' => 'editing_moveright', 'title' => $str->moveright)
2674             );
2675         }
2676     }
2678     // move
2679     if ($hasmanageactivities) {
2680         $actions['move'] = new action_link(
2681             new moodle_url($baseurl, array('copy' => $mod->id)),
2682             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2683             null,
2684             array('class' => 'editing_move', 'title' => $str->move)
2685         );
2686     }
2688     // Update
2689     if ($hasmanageactivities) {
2690         $actions['update'] = new action_link(
2691             new moodle_url($baseurl, array('update' => $mod->id)),
2692             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2693             null,
2694             array('class' => 'editing_update', 'title' => $str->update)
2695         );
2696     }
2698     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2699     // note that restoring on front page is never allowed
2700     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
2701             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
2702         $actions['duplicate'] = new action_link(
2703             new moodle_url($baseurl, array('duplicate' => $mod->id)),
2704             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2705             null,
2706             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
2707         );
2708     }
2710     // Delete
2711     if ($hasmanageactivities) {
2712         $actions['delete'] = new action_link(
2713             new moodle_url($baseurl, array('delete' => $mod->id)),
2714             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2715             null,
2716             array('class' => 'editing_delete', 'title' => $str->delete)
2717         );
2718     }
2720     // hideshow
2721     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2722         if ($mod->visible) {
2723             $actions['hide'] = new action_link(
2724                 new moodle_url($baseurl, array('hide' => $mod->id)),
2725                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2726                 null,
2727                 array('class' => 'editing_hide', 'title' => $str->hide)
2728             );
2729         } else {
2730             $actions['show'] = new action_link(
2731                 new moodle_url($baseurl, array('show' => $mod->id)),
2732                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2733                 null,
2734                 array('class' => 'editing_show', 'title' => $str->show)
2735             );
2736         }
2737     }
2739     // groupmode
2740     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2741         if ($mod->coursegroupmodeforce) {
2742             $modgroupmode = $mod->coursegroupmode;
2743         } else {
2744             $modgroupmode = $mod->groupmode;
2745         }
2746         if ($modgroupmode == SEPARATEGROUPS) {
2747             $groupmode = NOGROUPS;
2748             $grouptitle = $str->groupsseparate;
2749             $forcedgrouptitle = $str->forcedgroupsseparate;
2750             $actionname = 'groupsseparate';
2751             $groupimage = 't/groups';
2752         } else if ($modgroupmode == VISIBLEGROUPS) {
2753             $groupmode = SEPARATEGROUPS;
2754             $grouptitle = $str->groupsvisible;
2755             $forcedgrouptitle = $str->forcedgroupsvisible;
2756             $actionname = 'groupsvisible';
2757             $groupimage = 't/groupv';
2758         } else {
2759             $groupmode = VISIBLEGROUPS;
2760             $grouptitle = $str->groupsnone;
2761             $forcedgrouptitle = $str->forcedgroupsnone;
2762             $actionname = 'groupsnone';
2763             $groupimage = 't/groupn';
2764         }
2765         if (!$mod->coursegroupmodeforce) {
2766             $actions[$actionname] = new action_link(
2767                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
2768                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2769                 null,
2770                 array('class' => 'editing_'. $actionname, 'title' => $grouptitle)
2771             );
2772         } else {
2773             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
2774         }
2775     }
2777     // Assign
2778     if (has_capability('moodle/role:assign', $modcontext)){
2779         $actions['assign'] = new action_link(
2780             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2781             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2782             null,
2783             array('class' => 'editing_assign', 'title' => $str->assign)
2784         );
2785     }
2787     return $actions;
2790 /**
2791  * given a course object with shortname & fullname, this function will
2792  * truncate the the number of chars allowed and add ... if it was too long
2793  */
2794 function course_format_name ($course,$max=100) {
2796     $context = context_course::instance($course->id);
2797     $shortname = format_string($course->shortname, true, array('context' => $context));
2798     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2799     $str = $shortname.': '. $fullname;
2800     if (textlib::strlen($str) <= $max) {
2801         return $str;
2802     }
2803     else {
2804         return textlib::substr($str,0,$max-3).'...';
2805     }
2808 /**
2809  * Is the user allowed to add this type of module to this course?
2810  * @param object $course the course settings. Only $course->id is used.
2811  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2812  * @return bool whether the current user is allowed to add this type of module to this course.
2813  */
2814 function course_allowed_module($course, $modname) {
2815     if (is_numeric($modname)) {
2816         throw new coding_exception('Function course_allowed_module no longer
2817                 supports numeric module ids. Please update your code to pass the module name.');
2818     }
2820     $capability = 'mod/' . $modname . ':addinstance';
2821     if (!get_capability_info($capability)) {
2822         // Debug warning that the capability does not exist, but no more than once per page.
2823         static $warned = array();
2824         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2825         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2826             debugging('The module ' . $modname . ' does not define the standard capability ' .
2827                     $capability , DEBUG_DEVELOPER);
2828             $warned[$modname] = 1;
2829         }
2831         // If the capability does not exist, the module can always be added.
2832         return true;
2833     }
2835     $coursecontext = context_course::instance($course->id);
2836     return has_capability($capability, $coursecontext);
2839 /**
2840  * Recursively delete category including all subcategories and courses.
2841  * @param stdClass $category
2842  * @param boolean $showfeedback display some notices
2843  * @return array return deleted courses
2844  */
2845 function category_delete_full($category, $showfeedback=true) {
2846     global $CFG, $DB;
2847     require_once($CFG->libdir.'/gradelib.php');
2848     require_once($CFG->libdir.'/questionlib.php');
2849     require_once($CFG->dirroot.'/cohort/lib.php');
2851     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
2852         foreach ($children as $childcat) {
2853             category_delete_full($childcat, $showfeedback);
2854         }
2855     }
2857     $deletedcourses = array();
2858     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
2859         foreach ($courses as $course) {
2860             if (!delete_course($course, false)) {
2861                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
2862             }
2863             $deletedcourses[] = $course;
2864         }
2865     }
2867     // move or delete cohorts in this context
2868     cohort_delete_category($category);
2870     // now delete anything that may depend on course category context
2871     grade_course_category_delete($category->id, 0, $showfeedback);
2872     if (!question_delete_course_category($category, 0, $showfeedback)) {
2873         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
2874     }
2876     // finally delete the category and it's context
2877     $DB->delete_records('course_categories', array('id'=>$category->id));
2878     delete_context(CONTEXT_COURSECAT, $category->id);
2880     events_trigger('course_category_deleted', $category);
2882     return $deletedcourses;
2885 /**
2886  * Delete category, but move contents to another category.
2887  * @param object $ccategory
2888  * @param int $newparentid category id
2889  * @return bool status
2890  */
2891 function category_delete_move($category, $newparentid, $showfeedback=true) {
2892     global $CFG, $DB, $OUTPUT;
2893     require_once($CFG->libdir.'/gradelib.php');
2894     require_once($CFG->libdir.'/questionlib.php');
2895     require_once($CFG->dirroot.'/cohort/lib.php');
2897     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
2898         return false;
2899     }
2901     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
2902         foreach ($children as $childcat) {
2903             move_category($childcat, $newparentcat);
2904         }
2905     }
2907     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
2908         if (!move_courses(array_keys($courses), $newparentid)) {
2909             if ($showfeedback) {
2910                 echo $OUTPUT->notification("Error moving courses");
2911             }
2912             return false;
2913         }
2914         if ($showfeedback) {
2915             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
2916         }
2917     }
2919     // move or delete cohorts in this context
2920     cohort_delete_category($category);
2922     // now delete anything that may depend on course category context
2923     grade_course_category_delete($category->id, $newparentid, $showfeedback);
2924     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
2925         if ($showfeedback) {
2926             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
2927         }
2928         return false;
2929     }
2931     // finally delete the category and it's context
2932     $DB->delete_records('course_categories', array('id'=>$category->id));
2933     delete_context(CONTEXT_COURSECAT, $category->id);
2935     events_trigger('course_category_deleted', $category);
2937     if ($showfeedback) {
2938         echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
2939     }
2940     return true;
2943 /**
2944  * Efficiently moves many courses around while maintaining
2945  * sortorder in order.
2946  *
2947  * @param array $courseids is an array of course ids
2948  * @param int $categoryid
2949  * @return bool success
2950  */
2951 function move_courses($courseids, $categoryid) {
2952     global $CFG, $DB, $OUTPUT;
2954     if (empty($courseids)) {
2955         // nothing to do
2956         return;
2957     }
2959     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
2960         return false;
2961     }
2963     $courseids = array_reverse($courseids);
2964     $newparent = context_coursecat::instance($category->id);
2965     $i = 1;
2967     foreach ($courseids as $courseid) {
2968         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
2969             $course = new stdClass();
2970             $course->id = $courseid;
2971             $course->category  = $category->id;
2972             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2973             if ($category->visible == 0) {
2974                 // hide the course when moving into hidden category,
2975                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
2976                 $course->visible = 0;
2977             }
2979             $DB->update_record('course', $course);
2981             $context   = context_course::instance($course->id);
2982             context_moved($context, $newparent);
2983         }
2984     }
2985     fix_course_sortorder();
2987     return true;
2990 /**
2991  * Hide course category and child course and subcategories
2992  * @param stdClass $category
2993  * @return void
2994  */
2995 function course_category_hide($category) {
2996     global $DB;
2998     $category->visible = 0;
2999     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3000     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3001     $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($category->id)); // store visible flag so that we can return to it if we immediately unhide
3002     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3003     // get all child categories and hide too
3004     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3005         foreach ($subcats as $cat) {
3006             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3007             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3008             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3009             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3010         }
3011     }
3014 /**
3015  * Show course category and child course and subcategories
3016  * @param stdClass $category
3017  * @return void
3018  */
3019 function course_category_show($category) {
3020     global $DB;
3022     $category->visible = 1;
3023     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3024     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3025     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3026     // get all child categories and unhide too
3027     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3028         foreach ($subcats as $cat) {
3029             if ($cat->visibleold) {
3030                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3031             }
3032             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3033         }
3034     }
3037 /**
3038  * Efficiently moves a category - NOTE that this can have
3039  * a huge impact access-control-wise...
3040  */
3041 function move_category($category, $newparentcat) {
3042     global $CFG, $DB;
3044     $context = context_coursecat::instance($category->id);
3046     $hidecat = false;
3047     if (empty($newparentcat->id)) {
3048         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3050         $newparent = context_system::instance();
3052     } else {
3053         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3054         $newparent = context_coursecat::instance($newparentcat->id);
3056         if (!$newparentcat->visible and $category->visible) {
3057             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3058             $hidecat = true;
3059         }
3060     }
3062     context_moved($context, $newparent);
3064     // now make it last in new category
3065     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3067     // and fix the sortorders
3068     fix_course_sortorder();
3070     if ($hidecat) {
3071         course_category_hide($category);
3072     }
3075 /**
3076  * Returns the display name of the given section that the course prefers
3077  *
3078  * Implementation of this function is provided by course format
3079  * @see format_base::get_section_name()
3080  *
3081  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
3082  * @param int|stdClass $section Section object from database or just field course_sections.section
3083  * @return string Display name that the course format prefers, e.g. "Week 2"
3084  */
3085 function get_section_name($courseorid, $section) {
3086     return course_get_format($courseorid)->get_section_name($section);
3089 /**
3090  * Tells if current course format uses sections
3091  *
3092  * @param string $format Course format ID e.g. 'weeks' $course->format
3093  * @return bool
3094  */
3095 function course_format_uses_sections($format) {
3096     $course = new stdClass();
3097     $course->format = $format;
3098     return course_get_format($course)->uses_sections();
3101 /**
3102  * Returns the information about the ajax support in the given source format
3103  *
3104  * The returned object's property (boolean)capable indicates that
3105  * the course format supports Moodle course ajax features.
3106  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3107  *
3108  * @param string $format
3109  * @return stdClass
3110  */
3111 function course_format_ajax_support($format) {
3112     $course = new stdClass();
3113     $course->format = $format;
3114     return course_get_format($course)->supports_ajax();
3117 /**
3118  * Can the current user delete this course?
3119  * Course creators have exception,
3120  * 1 day after the creation they can sill delete the course.
3121  * @param int $courseid
3122  * @return boolean
3123  */
3124 function can_delete_course($courseid) {
3125     global $USER, $DB;
3127     $context = context_course::instance($courseid);
3129     if (has_capability('moodle/course:delete', $context)) {
3130         return true;
3131     }
3133     // hack: now try to find out if creator created this course recently (1 day)
3134     if (!has_capability('moodle/course:create', $context)) {
3135         return false;
3136     }
3138     $since = time() - 60*60*24;
3140     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3141     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3143     return $DB->record_exists_select('log', $select, $params);
3146 /**
3147  * Save the Your name for 'Some role' strings.
3148  *
3149  * @param integer $courseid the id of this course.
3150  * @param array $data the data that came from the course settings form.
3151  */
3152 function save_local_role_names($courseid, $data) {
3153     global $DB;
3154     $context = context_course::instance($courseid);
3156     foreach ($data as $fieldname => $value) {
3157         if (strpos($fieldname, 'role_') !== 0) {
3158             continue;
3159         }
3160         list($ignored, $roleid) = explode('_', $fieldname);
3162         // make up our mind whether we want to delete, update or insert
3163         if (!$value) {
3164             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3166         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3167             $rolename->name = $value;
3168             $DB->update_record('role_names', $rolename);
3170         } else {
3171             $rolename = new stdClass;
3172             $rolename->contextid = $context->id;
3173             $rolename->roleid = $roleid;
3174             $rolename->name = $value;
3175             $DB->insert_record('role_names', $rolename);
3176         }
3177     }
3180 /**
3181  * Create a course and either return a $course object
3182  *
3183  * Please note this functions does not verify any access control,
3184  * the calling code is responsible for all validation (usually it is the form definition).
3185  *
3186  * @param array $editoroptions course description editor options
3187  * @param object $data  - all the data needed for an entry in the 'course' table
3188  * @return object new course instance
3189  */
3190 function create_course($data, $editoroptions = NULL) {
3191     global $CFG, $DB;
3193     //check the categoryid - must be given for all new courses
3194     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3196     //check if the shortname already exist
3197     if (!empty($data->shortname)) {
3198         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3199             throw new moodle_exception('shortnametaken');
3200         }
3201     }
3203     //check if the id number already exist
3204     if (!empty($data->idnumber)) {
3205         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3206             throw new moodle_exception('idnumbertaken');
3207         }
3208     }
3210     $data->timecreated  = time();
3211     $data->timemodified = $data->timecreated;
3213     // place at beginning of any category
3214     $data->sortorder = 0;
3216     if ($editoroptions) {
3217         // summary text is updated later, we need context to store the files first
3218         $data->summary = '';
3219         $data->summary_format = FORMAT_HTML;
3220     }
3222     if (!isset($data->visible)) {
3223         // data not from form, add missing visibility info
3224         $data->visible = $category->visible;
3225     }
3226     $data->visibleold = $data->visible;
3228     $newcourseid = $DB->insert_record('course', $data);
3229     $context = context_course::instance($newcourseid, MUST_EXIST);
3231     if ($editoroptions) {
3232         // Save the files used in the summary editor and store
3233         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3234         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3235         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3236     }
3238     // update course format options
3239     course_get_format($newcourseid)->update_course_format_options($data);
3241     $course = course_get_format($newcourseid)->get_course();
3243     // Setup the blocks
3244     blocks_add_default_course_blocks($course);
3246     // Create a default section.
3247     course_create_sections_if_missing($course, 0);
3249     fix_course_sortorder();
3251     // new context created - better mark it as dirty
3252     mark_context_dirty($context->path);
3254     // Save any custom role names.
3255     save_local_role_names($course->id, (array)$data);
3257     // set up enrolments
3258     enrol_course_updated(true, $course, $data);
3260     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3262     // Trigger events
3263     events_trigger('course_created', $course);
3265     return $course;
3268 /**
3269  * Create a new course category and marks the context as dirty
3270  *
3271  * This function does not set the sortorder for the new category and
3272  * @see{fix_course_sortorder} should be called after creating a new course
3273  * category
3274  *
3275  * Please note that this function does not verify access control.
3276  *
3277  * @param object $category All of the data required for an entry in the course_categories table
3278  * @return object new course category
3279  */
3280 function create_course_category($category) {
3281     global $DB;
3283     $category->timemodified = time();
3284     $category->id = $DB->insert_record('course_categories', $category);
3285     $category = $DB->get_record('course_categories', array('id' => $category->id));
3287     // We should mark the context as dirty
3288     $category->context = context_coursecat::instance($category->id);
3289     $category->context->mark_dirty();
3291     return $category;
3294 /**
3295  * Update a course.
3296  *
3297  * Please note this functions does not verify any access control,
3298  * the calling code is responsible for all validation (usually it is the form definition).
3299  *
3300  * @param object $data  - all the data needed for an entry in the 'course' table
3301  * @param array $editoroptions course description editor options
3302  * @return void
3303  */
3304 function update_course($data, $editoroptions = NULL) {
3305     global $CFG, $DB;
3307     $data->timemodified = time();
3309     $oldcourse = course_get_format($data->id)->get_course();
3310     $context   = context_course::instance($oldcourse->id);
3312     if ($editoroptions) {
3313         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3314     }
3316     if (!isset($data->category) or empty($data->category)) {
3317         // prevent nulls and 0 in category field
3318         unset($data->category);
3319     }
3320     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3322     if (!isset($data->visible)) {
3323         // data not from form, add missing visibility info
3324         $data->visible = $oldcourse->visible;
3325     }
3327     if ($data->visible != $oldcourse->visible) {
3328         // reset the visibleold flag when manually hiding/unhiding course
3329         $data->visibleold = $data->visible;
3330     } else {
3331         if ($movecat) {
3332             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3333             if (empty($newcategory->visible)) {
3334                 // make sure when moving into hidden category the course is hidden automatically
3335                 $data->visible = 0;
3336             }
3337         }
3338     }
3340     // Update with the new data
3341     $DB->update_record('course', $data);
3342     // make sure the modinfo cache is reset
3343     rebuild_course_cache($data->id);
3345     // update course format options with full course data
3346     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
3348     $course = $DB->get_record('course', array('id'=>$data->id));
3350     if ($movecat) {
3351         $newparent = context_coursecat::instance($course->category);
3352         context_moved($context, $newparent);
3353     }
3355     fix_course_sortorder();
3357     // Test for and remove blocks which aren't appropriate anymore
3358     blocks_remove_inappropriate($course);
3360     // Save any custom role names.
3361     save_local_role_names($course->id, $data);
3363     // update enrol settings
3364     enrol_course_updated(false, $course, $data);
3366     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3368     // Trigger events
3369     events_trigger('course_updated', $course);
3371     if ($oldcourse->format !== $course->format) {
3372         // Remove all options stored for the previous format
3373         // We assume that new course format migrated everything it needed watching trigger
3374         // 'course_updated' and in method format_XXX::update_course_format_options()
3375         $DB->delete_records('course_format_options',
3376                 array('courseid' => $course->id, 'format' => $oldcourse->format));
3377     }
3380 /**
3381  * Average number of participants
3382  * @return integer
3383  */
3384 function average_number_of_participants() {
3385     global $DB, $SITE;
3387     //count total of enrolments for visible course (except front page)
3388     $sql = 'SELECT COUNT(*) FROM (
3389         SELECT DISTINCT ue.userid, e.courseid
3390         FROM {user_enrolments} ue, {enrol} e, {course} c
3391         WHERE ue.enrolid = e.id
3392             AND e.courseid <> :siteid
3393             AND c.id = e.courseid
3394             AND c.visible = 1) total';
3395     $params = array('siteid' => $SITE->id);
3396     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3399     //count total of visible courses (minus front page)
3400     $coursetotal = $DB->count_records('course', array('visible' => 1));
3401     $coursetotal = $coursetotal - 1 ;
3403     //average of enrolment
3404     if (empty($coursetotal)) {
3405         $participantaverage = 0;
3406     } else {
3407         $participantaverage = $enrolmenttotal / $coursetotal;
3408     }
3410     return $participantaverage;
3413 /**
3414  * Average number of course modules
3415  * @return integer
3416  */
3417 function average_number_of_courses_modules() {
3418     global $DB, $SITE;
3420     //count total of visible course module (except front page)
3421     $sql = 'SELECT COUNT(*) FROM (
3422         SELECT cm.course, cm.module
3423         FROM {course} c, {course_modules} cm
3424         WHERE c.id = cm.course
3425             AND c.id <> :siteid
3426             AND cm.visible = 1
3427             AND c.visible = 1) total';
3428     $params = array('siteid' => $SITE->id);
3429     $moduletotal = $DB->count_records_sql($sql, $params);
3432     //count total of visible courses (minus front page)
3433     $coursetotal = $DB->count_records('course', array('visible' => 1));
3434     $coursetotal = $coursetotal - 1 ;
3436     //average of course module
3437     if (empty($coursetotal)) {
3438         $coursemoduleaverage = 0;
3439     } else {
3440         $coursemoduleaverage = $moduletotal / $coursetotal;
3441     }
3443     return $coursemoduleaverage;
3446 /**
3447  * This class pertains to course requests and contains methods associated with
3448  * create, approving, and removing course requests.
3449  *
3450  * Please note we do not allow embedded images here because there is no context
3451  * to store them with proper access control.
3452  *
3453  * @copyright 2009 Sam Hemelryk
3454  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3455  * @since Moodle 2.0
3456  *
3457  * @property-read int $id
3458  * @property-read string $fullname
3459  * @property-read string $shortname
3460  * @property-read string $summary
3461  * @property-read int $summaryformat
3462  * @property-read int $summarytrust
3463  * @property-read string $reason
3464  * @property-read int $requester
3465  */
3466 class course_request {
3468     /**
3469      * This is the stdClass that stores the properties for the course request
3470      * and is externally accessed through the __get magic method
3471      * @var stdClass
3472      */
3473     protected $properties;
3475     /**
3476      * An array of options for the summary editor used by course request forms.
3477      * This is initially set by {@link summary_editor_options()}
3478      * @var array
3479      * @static
3480      */
3481     protected static $summaryeditoroptions;
3483     /**
3484      * Static function to prepare the summary editor for working with a course
3485      * request.
3486      *
3487      * @static
3488      * @param null|stdClass $data Optional, an object containing the default values
3489      *                       for the form, these may be modified when preparing the
3490      *                       editor so this should be called before creating the form
3491      * @return stdClass An object that can be used to set the default values for
3492      *                   an mforms form
3493      */
3494     public static function prepare($data=null) {
3495         if ($data === null) {
3496             $data = new stdClass;
3497         }
3498         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
3499         return $data;
3500     }
3502     /**
3503      * Static function to create a new course request when passed an array of properties
3504      * for it.
3505      *
3506      * This function also handles saving any files that may have been used in the editor
3507      *
3508      * @static
3509      * @param stdClass $data
3510      * @return course_request The newly created course request
3511      */
3512     public static function create($data) {
3513         global $USER, $DB, $CFG;
3514         $data->requester = $USER->id;
3516         // Setting the default category if none set.
3517         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
3518             $data->category = $CFG->defaultrequestcategory;
3519         }
3521         // Summary is a required field so copy the text over
3522         $data->summary       = $data->summary_editor['text'];
3523         $data->summaryformat = $data->summary_editor['format'];
3525         $data->id = $DB->insert_record('course_request', $data);
3527         // Create a new course_request object and return it
3528         $request = new course_request($data);
3530         // Notify the admin if required.
3531         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
3533             $a = new stdClass;
3534             $a->link = "$CFG->wwwroot/course/pending.php";
3535             $a->user = fullname($USER);
3536             $subject = get_string('courserequest');
3537             $message = get_string('courserequestnotifyemail', 'admin', $a);
3538             foreach ($users as $user) {
3539                 $request->notify($user, $USER, 'courserequested', $subject, $message);
3540             }
3541         }
3543         return $request;
3544     }
3546     /**
3547      * Returns an array of options to use with a summary editor
3548      *
3549      * @uses course_request::$summaryeditoroptions
3550      * @return array An array of options to use with the editor
3551      */
3552     public static function summary_editor_options() {
3553         global $CFG;
3554         if (self::$summaryeditoroptions === null) {
3555             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
3556         }
3557         return self::$summaryeditoroptions;
3558     }
3560     /**
3561      * Loads the properties for this course request object. Id is required and if
3562      * only id is provided then we load the rest of the properties from the database
3563      *
3564      * @param stdClass|int $properties Either an object containing properties
3565      *                      or the course_request id to load
3566      */
3567     public function __construct($properties) {
3568         global $DB;
3569         if (empty($properties->id)) {
3570             if (empty($properties)) {
3571                 throw new coding_exception('You must provide a course request id when creating a course_request object');
3572             }
3573             $id = $properties;
3574             $properties = new stdClass;
3575             $properties->id = (int)$id;
3576             unset($id);
3577         }
3578         if (empty($properties->requester)) {
3579             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3580                 print_error('unknowncourserequest');
3581             }
3582         } else {
3583             $this->properties = $properties;
3584         }
3585         $this->properties->collision = null;
3586     }
3588     /**
3589      * Returns the requested property
3590      *