983b9fc8109f1b59945e51f6fab6edde872c407d
[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;
851 function print_overview($courses, array $remote_courses=array()) {
852     global $CFG, $USER, $DB, $OUTPUT;
854     $htmlarray = array();
855     if ($modules = $DB->get_records('modules')) {
856         foreach ($modules as $mod) {
857             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
858                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
859                 $fname = $mod->name.'_print_overview';
860                 if (function_exists($fname)) {
861                     $fname($courses,$htmlarray);
862                 }
863             }
864         }
865     }
866     foreach ($courses as $course) {
867         $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
868         echo $OUTPUT->box_start('coursebox');
869         $attributes = array('title' => s($fullname));
870         if (empty($course->visible)) {
871             $attributes['class'] = 'dimmed';
872         }
873         echo $OUTPUT->heading(html_writer::link(
874             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
875         if (array_key_exists($course->id,$htmlarray)) {
876             foreach ($htmlarray[$course->id] as $modname => $html) {
877                 echo $html;
878             }
879         }
880         echo $OUTPUT->box_end();
881     }
883     if (!empty($remote_courses)) {
884         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
885     }
886     foreach ($remote_courses as $course) {
887         echo $OUTPUT->box_start('coursebox');
888         $attributes = array('title' => s($course->fullname));
889         echo $OUTPUT->heading(html_writer::link(
890             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
891             format_string($course->shortname),
892             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
893         echo $OUTPUT->box_end();
894     }
898 /**
899  * This function trawls through the logs looking for
900  * anything new since the user's last login
901  */
902 function print_recent_activity($course) {
903     // $course is an object
904     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
906     $context = context_course::instance($course->id);
908     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
910     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
912     if (!isguestuser()) {
913         if (!empty($USER->lastcourseaccess[$course->id])) {
914             if ($USER->lastcourseaccess[$course->id] > $timestart) {
915                 $timestart = $USER->lastcourseaccess[$course->id];
916             }
917         }
918     }
920     echo '<div class="activitydate">';
921     echo get_string('activitysince', '', userdate($timestart));
922     echo '</div>';
923     echo '<div class="activityhead">';
925     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
927     echo "</div>\n";
929     $content = false;
931 /// Firstly, have there been any new enrolments?
933     $users = get_recent_enrolments($course->id, $timestart);
935     //Accessibility: new users now appear in an <OL> list.
936     if ($users) {
937         echo '<div class="newusers">';
938         echo $OUTPUT->heading(get_string("newusers").':', 3);
939         $content = true;
940         echo "<ol class=\"list\">\n";
941         foreach ($users as $user) {
942             $fullname = fullname($user, $viewfullnames);
943             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
944         }
945         echo "</ol>\n</div>\n";
946     }
948 /// Next, have there been any modifications to the course structure?
950     $modinfo = get_fast_modinfo($course);
952     $changelist = array();
954     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
955                                             module = 'course' AND
956                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
957                                     array($timestart, $course->id), "id ASC");
959     if ($logs) {
960         $actions  = array('add mod', 'update mod', 'delete mod');
961         $newgones = array(); // added and later deleted items
962         foreach ($logs as $key => $log) {
963             if (!in_array($log->action, $actions)) {
964                 continue;
965             }
966             $info = explode(' ', $log->info);
968             // note: in most cases I replaced hardcoding of label with use of
969             // $cm->has_view() but it was not possible to do this here because
970             // we don't necessarily have the $cm for it
971             if ($info[0] == 'label') {     // Labels are ignored in recent activity
972                 continue;
973             }
975             if (count($info) != 2) {
976                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
977                 continue;
978             }
980             $modname    = $info[0];
981             $instanceid = $info[1];
983             if ($log->action == 'delete mod') {
984                 // unfortunately we do not know if the mod was visible
985                 if (!array_key_exists($log->info, $newgones)) {
986                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
987                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
988                 }
989             } else {
990                 if (!isset($modinfo->instances[$modname][$instanceid])) {
991                     if ($log->action == 'add mod') {
992                         // do not display added and later deleted activities
993                         $newgones[$log->info] = true;
994                     }
995                     continue;
996                 }
997                 $cm = $modinfo->instances[$modname][$instanceid];
998                 if (!$cm->uservisible) {
999                     continue;
1000                 }
1002                 if ($log->action == 'add mod') {
1003                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
1004                     $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>");
1006                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
1007                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
1008                     $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>");
1009                 }
1010             }
1011         }
1012     }
1014     if (!empty($changelist)) {
1015         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1016         $content = true;
1017         foreach ($changelist as $changeinfo => $change) {
1018             echo '<p class="activity">'.$change['text'].'</p>';
1019         }
1020     }
1022 /// Now display new things from each module
1024     $usedmodules = array();
1025     foreach($modinfo->cms as $cm) {
1026         if (isset($usedmodules[$cm->modname])) {
1027             continue;
1028         }
1029         if (!$cm->uservisible) {
1030             continue;
1031         }
1032         $usedmodules[$cm->modname] = $cm->modname;
1033     }
1035     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1036         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1037             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1038             $print_recent_activity = $modname.'_print_recent_activity';
1039             if (function_exists($print_recent_activity)) {
1040                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1041                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1042             }
1043         } else {
1044             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1045         }
1046     }
1048     if (! $content) {
1049         echo '<p class="message">'.get_string('nothingnew').'</p>';
1050     }
1053 /**
1054  * For a given course, returns an array of course activity objects
1055  * Each item in the array contains he following properties:
1056  */
1057 function get_array_of_activities($courseid) {
1058 //  cm - course module id
1059 //  mod - name of the module (eg forum)
1060 //  section - the number of the section (eg week or topic)
1061 //  name - the name of the instance
1062 //  visible - is the instance visible or not
1063 //  groupingid - grouping id
1064 //  groupmembersonly - is this instance visible to group members only
1065 //  extra - contains extra string to include in any link
1066     global $CFG, $DB;
1067     if(!empty($CFG->enableavailability)) {
1068         require_once($CFG->libdir.'/conditionlib.php');
1069     }
1071     $course = $DB->get_record('course', array('id'=>$courseid));
1073     if (empty($course)) {
1074         throw new moodle_exception('courseidnotfound');
1075     }
1077     $mod = array();
1079     $rawmods = get_course_mods($courseid);
1080     if (empty($rawmods)) {
1081         return $mod; // always return array
1082     }
1084     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1085        foreach ($sections as $section) {
1086            if (!empty($section->sequence)) {
1087                $sequence = explode(",", $section->sequence);
1088                foreach ($sequence as $seq) {
1089                    if (empty($rawmods[$seq])) {
1090                        continue;
1091                    }
1092                    $mod[$seq] = new stdClass();
1093                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1094                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1095                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1097                     // Oh dear. Inconsistent names left here for backward compatibility.
1098                    $mod[$seq]->section          = $section->section;
1099                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1101                    $mod[$seq]->module           = $rawmods[$seq]->module;
1102                    $mod[$seq]->added            = $rawmods[$seq]->added;
1103                    $mod[$seq]->score            = $rawmods[$seq]->score;
1104                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1105                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1106                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1107                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1108                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1109                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1110                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1111                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1112                    $mod[$seq]->extra            = "";
1113                    $mod[$seq]->completiongradeitemnumber =
1114                            $rawmods[$seq]->completiongradeitemnumber;
1115                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1116                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1117                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1118                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1119                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1120                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1121                    if (!empty($CFG->enableavailability)) {
1122                        condition_info::fill_availability_conditions($rawmods[$seq]);
1123                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1124                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1125                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
1126                    }
1128                    $modname = $mod[$seq]->mod;
1129                    $functionname = $modname."_get_coursemodule_info";
1131                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1132                        continue;
1133                    }
1135                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1137                    if ($hasfunction = function_exists($functionname)) {
1138                        if ($info = $functionname($rawmods[$seq])) {
1139                            if (!empty($info->icon)) {
1140                                $mod[$seq]->icon = $info->icon;
1141                            }
1142                            if (!empty($info->iconcomponent)) {
1143                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1144                            }
1145                            if (!empty($info->name)) {
1146                                $mod[$seq]->name = $info->name;
1147                            }
1148                            if ($info instanceof cached_cm_info) {
1149                                // When using cached_cm_info you can include three new fields
1150                                // that aren't available for legacy code
1151                                if (!empty($info->content)) {
1152                                    $mod[$seq]->content = $info->content;
1153                                }
1154                                if (!empty($info->extraclasses)) {
1155                                    $mod[$seq]->extraclasses = $info->extraclasses;
1156                                }
1157                                if (!empty($info->iconurl)) {
1158                                    $mod[$seq]->iconurl = $info->iconurl;
1159                                }
1160                                if (!empty($info->onclick)) {
1161                                    $mod[$seq]->onclick = $info->onclick;
1162                                }
1163                                if (!empty($info->customdata)) {
1164                                    $mod[$seq]->customdata = $info->customdata;
1165                                }
1166                            } else {
1167                                // When using a stdclass, the (horrible) deprecated ->extra field
1168                                // is available for BC
1169                                if (!empty($info->extra)) {
1170                                    $mod[$seq]->extra = $info->extra;
1171                                }
1172                            }
1173                        }
1174                    }
1175                    // When there is no modname_get_coursemodule_info function,
1176                    // but showdescriptions is enabled, then we use the 'intro'
1177                    // and 'introformat' fields in the module table
1178                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1179                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1180                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1181                            // Set content from intro and introformat. Filters are disabled
1182                            // because we  filter it with format_text at display time
1183                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1184                                    $modvalues, $rawmods[$seq]->id, false);
1186                            // To save making another query just below, put name in here
1187                            $mod[$seq]->name = $modvalues->name;
1188                        }
1189                    }
1190                    if (!isset($mod[$seq]->name)) {
1191                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1192                    }
1194                    // Minimise the database size by unsetting default options when they are
1195                    // 'empty'. This list corresponds to code in the cm_info constructor.
1196                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1197                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1198                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1199                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1200                            'completionview', 'completionexpected', 'score', 'showdescription')
1201                            as $property) {
1202                        if (property_exists($mod[$seq], $property) &&
1203                                empty($mod[$seq]->{$property})) {
1204                            unset($mod[$seq]->{$property});
1205                        }
1206                    }
1207                    // Special case: this value is usually set to null, but may be 0
1208                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1209                            is_null($mod[$seq]->completiongradeitemnumber)) {
1210                        unset($mod[$seq]->completiongradeitemnumber);
1211                    }
1212                }
1213             }
1214         }
1215     }
1216     return $mod;
1219 /**
1220  * Returns the localised human-readable names of all used modules
1221  *
1222  * @param bool $plural if true returns the plural forms of the names
1223  * @return array where key is the module name (component name without 'mod_') and
1224  *     the value is the human-readable string. Array sorted alphabetically by value
1225  */
1226 function get_module_types_names($plural = false) {
1227     static $modnames = null;
1228     global $DB, $CFG;
1229     if ($modnames === null) {
1230         $modnames = array(0 => array(), 1 => array());
1231         if ($allmods = $DB->get_records("modules")) {
1232             foreach ($allmods as $mod) {
1233                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1234                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1235                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1236                 }
1237             }
1238             collatorlib::asort($modnames[0]);
1239             collatorlib::asort($modnames[1]);
1240         }
1241     }
1242     return $modnames[(int)$plural];
1245 /**
1246  * Set highlighted section. Only one section can be highlighted at the time.
1247  *
1248  * @param int $courseid course id
1249  * @param int $marker highlight section with this number, 0 means remove higlightin
1250  * @return void
1251  */
1252 function course_set_marker($courseid, $marker) {
1253     global $DB;
1254     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1255     format_base::reset_course_cache($courseid);
1258 /**
1259  * For a given course section, marks it visible or hidden,
1260  * and does the same for every activity in that section
1261  *
1262  * @param int $courseid course id
1263  * @param int $sectionnumber The section number to adjust
1264  * @param int $visibility The new visibility
1265  * @return array A list of resources which were hidden in the section
1266  */
1267 function set_section_visible($courseid, $sectionnumber, $visibility) {
1268     global $DB;
1270     $resourcestotoggle = array();
1271     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1272         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1273         if (!empty($section->sequence)) {
1274             $modules = explode(",", $section->sequence);
1275             foreach ($modules as $moduleid) {
1276                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1277                     if ($visibility) {
1278                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1279                         set_coursemodule_visible($moduleid, $cm->visibleold);
1280                     } else {
1281                         // We hide the section, so we hide the module but we store the original state in visibleold.
1282                         set_coursemodule_visible($moduleid, 0);
1283                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1284                     }
1285                 }
1286             }
1287         }
1288         rebuild_course_cache($courseid, true);
1290         // Determine which modules are visible for AJAX update
1291         if (!empty($modules)) {
1292             list($insql, $params) = $DB->get_in_or_equal($modules);
1293             $select = 'id ' . $insql . ' AND visible = ?';
1294             array_push($params, $visibility);
1295             if (!$visibility) {
1296                 $select .= ' AND visibleold = 1';
1297             }
1298             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1299         }
1300     }
1301     return $resourcestotoggle;
1304 /**
1305  * Obtains shared data that is used in print_section when displaying a
1306  * course-module entry.
1307  *
1308  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1309  *
1310  * @deprecated since 2.5
1311  *
1312  * This data is also used in other areas of the code.
1313  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1314  * @param object $course (argument not used)
1315  * @return array An array with the following values in this order:
1316  *   $content (optional extra content for after link),
1317  *   $instancename (text of link)
1318  */
1319 function get_print_section_cm_text(cm_info $cm, $course) {
1320     return array($cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true)),
1321         $cm->get_formatted_name());
1324 /**
1325  * Prints a section full of activity modules
1326  *
1327  * @param stdClass $course The course
1328  * @param stdClass|section_info $section The section object containing properties id and section
1329  * @param array $mods (argument not used)
1330  * @param array $modnamesused (argument not used)
1331  * @param bool $absolute All links are absolute
1332  * @param string $width (argument not used)
1333  * @param bool $hidecompletion Hide completion status
1334  * @param int $sectionreturn The section to return to
1335  * @return void
1336  */
1337 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1338     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1340     static $initialised;
1342     static $groupbuttons;
1343     static $groupbuttonslink;
1344     static $isediting;
1345     static $ismoving;
1346     static $movingpix;
1347     static $strmovefull;
1348     static $strunreadpostsone;
1350     if (!isset($initialised)) {
1351         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1352         $groupbuttonslink = (!$course->groupmodeforce);
1353         $isediting        = $PAGE->user_is_editing();
1354         $ismoving         = $isediting && ismoving($course->id);
1355         if ($ismoving) {
1356             $movingpix    = new pix_icon('movehere', get_string('movehere'), 'moodle', array('class' => 'movetarget'));
1357             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1358         }
1359         $initialised = true;
1360     }
1362     $modinfo = get_fast_modinfo($course);
1363     $completioninfo = new completion_info($course);
1364     $courserenderer = $PAGE->get_renderer('core', 'course');
1366     // Get the list of modules visible to user (excluding the module being moved if there is one)
1367     $moduleslist = array();
1368     if (!empty($modinfo->sections[$section->section])) {
1369         foreach ($modinfo->sections[$section->section] as $modnumber) {
1370             $mod = $modinfo->cms[$modnumber];
1372             if ($ismoving and $mod->id == $USER->activitycopy) {
1373                 // do not display moving mod
1374                 continue;
1375             }
1376             // We can continue (because it will not be displayed at all)
1377             // if:
1378             // 1) The activity is not visible to users
1379             // and
1380             // 2a) The 'showavailability' option is not set (if that is set,
1381             //     we need to display the activity so we can show
1382             //     availability info)
1383             // or
1384             // 2b) The 'availableinfo' is empty, i.e. the activity was
1385             //     hidden in a way that leaves no info, such as using the
1386             //     eye icon.
1387             if (!$mod->uservisible &&
1388                 (empty($mod->showavailability) ||
1389                   empty($mod->availableinfo))) {
1390                 // visibility shortcut
1391                 continue;
1392             }
1394             $moduleslist[$modnumber] = $mod;
1395         }
1396     }
1398     if (!empty($moduleslist) || $ismoving) {
1400         echo html_writer::start_tag('ul', array('class' => 'section img-text'));
1402         foreach ($moduleslist as $modnumber => $mod) {
1404             // In some cases the activity is visible to user, but it is
1405             // dimmed. This is done if viewhiddenactivities is true and if:
1406             // 1. the activity is not visible, or
1407             // 2. the activity has dates set which do not include current, or
1408             // 3. the activity has any other conditions set (regardless of whether
1409             //    current user meets them)
1410             $modcontext = context_module::instance($mod->id);
1411             $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
1412             $accessiblebutdim = !$mod->uservisible;
1413             $conditionalhidden = false;
1414             if (!$accessiblebutdim && $canviewhidden) {
1415                 $accessiblebutdim = !$mod->visible;
1416                 if (!empty($CFG->enableavailability)) {
1417                     $conditionalhidden = $mod->availablefrom > time() ||
1418                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1419                         count($mod->conditionsgrade) > 0 ||
1420                         count($mod->conditionscompletion) > 0;
1421                 }
1422                 $accessiblebutdim = $conditionalhidden || $accessiblebutdim;
1423             }
1425             $modclasses = 'activity '. $mod->modname. 'modtype_'.$mod->modname. ' '. $mod->get_extra_classes();
1426             if ($ismoving) {
1427                 $movingurl = new moodle_url('/course/mod.php', array('moveto' => $mod->id, 'sesskey' => sesskey()));
1428                 echo html_writer::tag('li', html_writer::link($movingurl, $OUTPUT->render($movingpix)), array('class' => 'movehere'));
1429             }
1431             echo html_writer::start_tag('li', array('class' => $modclasses, 'id' => 'module-'. $modnumber));
1432             $indentclasses = 'mod-indent';
1433             if (!empty($mod->indent)) {
1434                 $indentclasses .= ' mod-indent-'.$mod->indent;
1435                 if ($mod->indent > 15) {
1436                     $indentclasses .= ' mod-indent-huge';
1437                 }
1438             }
1439             echo html_writer::start_tag('div', array('class' => $indentclasses));
1441             // Get data about this course-module
1442             $content = $mod->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1443             $instancename = $mod->get_formatted_name();
1445             //Accessibility: for files get description via icon, this is very ugly hack!
1446             $altname = '';
1447             $altname = $mod->modfullname;
1448             // Avoid unnecessary duplication: if e.g. a forum name already
1449             // includes the word forum (or Forum, etc) then it is unhelpful
1450             // to include that in the accessible description that is added.
1451             if (false !== strpos(textlib::strtolower($instancename),
1452                     textlib::strtolower($altname))) {
1453                 $altname = '';
1454             }
1455             // File type after name, for alphabetic lists (screen reader).
1456             if ($altname) {
1457                 $altname = get_accesshide(' '.$altname);
1458             }
1460             // Start the div for the activity title, excluding the edit icons.
1461             echo html_writer::start_tag('div', array('class' => 'activityinstance'));
1463             // We may be displaying this just in order to show information
1464             // about visibility, without the actual link ($mod->uservisible)
1465             $contentpart = '';
1466                 $linkclasses = '';
1467                 $textclasses = '';
1468                 $accesstext = '';
1469                 if ($accessiblebutdim) {
1470                     $linkclasses .= ' dimmed';
1471                     $textclasses .= ' dimmed_text';
1472                     if ($conditionalhidden) {
1473                         $linkclasses .= ' conditionalhidden';
1474                         $textclasses .= ' conditionalhidden';
1475                     }
1476                     if ($mod->uservisible) {
1477                         // show accessibility note only if user can access the module himself
1478                         $accesstext = get_accesshide(get_string('hiddenfromstudents').': ');
1479                     }
1480                 }
1482                 // Get on-click attribute value if specified and decode the onclick - it
1483                 // has already been encoded for display (puke).
1484                 $onclick = htmlspecialchars_decode($mod->get_on_click(), ENT_QUOTES);
1486                 $groupinglabel = '';
1487                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
1488                     $groupings = groups_get_all_groupings($course->id);
1489                     $groupinglabel = html_writer::tag('span', '('.format_string($groupings[$mod->groupingid]->name).')',
1490                             array('class' => 'groupinglabel '.$textclasses));
1491                 }
1493                 if ($url = $mod->get_url()) {
1494                     // Display link itself.
1495                     $activitylink = html_writer::empty_tag('img', array('src' => $mod->get_icon_url(),
1496                             'class' => 'iconlarge activityicon', 'alt' => $mod->modfullname)) . $accesstext .
1497                             html_writer::tag('span', $instancename . $altname, array('class' => 'instancename'));
1498                     if ($mod->uservisible) {
1499                         echo html_writer::link($url, $activitylink, array('class' => $linkclasses, 'onclick' => $onclick)) .
1500                                 $groupinglabel;
1501                     } else {
1502                         echo html_writer::tag('div', $activitylink, array('class' => $textclasses)) .
1503                                 $groupinglabel;
1504                     }
1506                     // If specified, display extra content after link.
1507                     if ($content) {
1508                         $contentpart = html_writer::tag('div', $content, array('class' =>
1509                                 trim('contentafterlink ' . $textclasses)));
1510                     }
1511                 } else {
1512                     // No link, so display only content.
1513                     $contentpart = html_writer::tag('div', $accesstext . $content, array('class' => $textclasses));
1514                 }
1516             // Module can put text after the link (e.g. forum unread)
1517             echo $mod->get_after_link();
1519             // Closing the tag which contains everything but edit icons. $contentpart should not be part of this.
1520             echo html_writer::end_tag('div');
1522             // If there is content but NO link (eg label), then display the
1523             // content here (BEFORE any icons). In this case cons must be
1524             // displayed after the content so that it makes more sense visually
1525             // and for accessibility reasons, e.g. if you have a one-line label
1526             // it should work similarly (at least in terms of ordering) to an
1527             // activity.
1528             if (empty($url)) {
1529                 echo $contentpart;
1530             }
1532             if ($isediting) {
1533                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1534                     if (! $mod->groupmodelink = $groupbuttonslink) {
1535                         $mod->groupmode = $course->groupmode;
1536                     }
1538                 } else {
1539                     $mod->groupmode = false;
1540                 }
1541                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $sectionreturn);
1542                 echo $mod->get_after_edit_icons();
1543             }
1545             // Completion
1546             $completion = $hidecompletion
1547                 ? COMPLETION_TRACKING_NONE
1548                 : $completioninfo->is_enabled($mod);
1549             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1550                 !isguestuser() && $mod->uservisible) {
1551                 $completiondata = $completioninfo->get_data($mod,true);
1552                 $completionicon = '';
1553                 if ($isediting) {
1554                     switch ($completion) {
1555                         case COMPLETION_TRACKING_MANUAL :
1556                             $completionicon = 'manual-enabled'; break;
1557                         case COMPLETION_TRACKING_AUTOMATIC :
1558                             $completionicon = 'auto-enabled'; break;
1559                         default: // wtf
1560                     }
1561                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1562                     switch($completiondata->completionstate) {
1563                         case COMPLETION_INCOMPLETE:
1564                             $completionicon = 'manual-n'; break;
1565                         case COMPLETION_COMPLETE:
1566                             $completionicon = 'manual-y'; break;
1567                     }
1568                 } else { // Automatic
1569                     switch($completiondata->completionstate) {
1570                         case COMPLETION_INCOMPLETE:
1571                             $completionicon = 'auto-n'; break;
1572                         case COMPLETION_COMPLETE:
1573                             $completionicon = 'auto-y'; break;
1574                         case COMPLETION_COMPLETE_PASS:
1575                             $completionicon = 'auto-pass'; break;
1576                         case COMPLETION_COMPLETE_FAIL:
1577                             $completionicon = 'auto-fail'; break;
1578                     }
1579                 }
1580                 if ($completionicon) {
1581                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1582                     $formattedname = format_string($mod->name, true, array('context' => $modcontext));
1583                     $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
1584                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1585                         $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
1586                         $newstate =
1587                             $completiondata->completionstate==COMPLETION_COMPLETE
1588                             ? COMPLETION_INCOMPLETE
1589                             : COMPLETION_COMPLETE;
1590                         // In manual mode the icon is a toggle form...
1592                         // If this completion state is used by the
1593                         // conditional activities system, we need to turn
1594                         // off the JS.
1595                         if (!empty($CFG->enableavailability) &&
1596                             condition_info::completion_value_used_as_condition($course, $mod)) {
1597                             $extraclass = ' preventjs';
1598                         } else {
1599                             $extraclass = '';
1600                         }
1601                         echo html_writer::start_tag('form', array(
1602                                 'class' => 'togglecompletion' . $extraclass,
1603                                 'method' => 'post',
1604                                 'action' => $CFG->wwwroot . '/course/togglecompletion.php'));
1605                         echo html_writer::start_tag('div');
1606                         echo html_writer::empty_tag('input', array(
1607                                 'type' => 'hidden', 'name' => 'id', 'value' => $mod->id));
1608                         echo html_writer::empty_tag('input', array(
1609                                 'type' => 'hidden', 'name' => 'modulename',
1610                                 'value' => $mod->name));
1611                         echo html_writer::empty_tag('input', array(
1612                                 'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
1613                         echo html_writer::empty_tag('input', array(
1614                                 'type' => 'hidden', 'name' => 'completionstate',
1615                                 'value' => $newstate));
1616                         echo html_writer::empty_tag('input', array(
1617                                 'type' => 'image', 'src' => $imgsrc, 'alt' => $imgalt, 'title' => $imgtitle));
1618                         echo html_writer::end_tag('div');
1619                         echo html_writer::end_tag('form');
1620                     } else {
1621                         // In auto mode, or when editing, the icon is just an image
1622                         echo "<span class='autocompletion'>";
1623                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1624                     }
1625                 }
1626             }
1628             // If there is content AND a link, then display the content here
1629             // (AFTER any icons). Otherwise it was displayed before
1630             if (!empty($url)) {
1631                 echo $contentpart;
1632             }
1634             // Show availability information (for someone who isn't allowed to
1635             // see the activity itself, or for staff)
1636             if (!$mod->uservisible) {
1637                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1638             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1639                 // Don't add availability information if user is not editing and activity is hidden.
1640                 if ($mod->visible || $PAGE->user_is_editing()) {
1641                     $hidinfoclass = '';
1642                     if (!$mod->visible) {
1643                         $hidinfoclass = 'hide';
1644                     }
1645                     $ci = new condition_info($mod);
1646                     $fullinfo = $ci->get_full_information();
1647                     if($fullinfo) {
1648                         echo '<div class="availabilityinfo '.$hidinfoclass.'">'.get_string($mod->showavailability
1649                             ? 'userrestriction_visible'
1650                             : 'userrestriction_hidden','condition',
1651                             $fullinfo).'</div>';
1652                     }
1653                 }
1654             }
1656             echo html_writer::end_tag('div');
1657             echo html_writer::end_tag('li')."\n";
1658         }
1660         if ($ismoving) {
1661             $movingurl = new moodle_url('/course/mod.php', array('movetosection' => $section->id, 'sesskey' => sesskey()));
1662             echo html_writer::tag('li', html_writer::link($movingurl, $OUTPUT->render($movingpix)), array('class' => 'movehere'));
1663         }
1665         echo html_writer::end_tag('ul'); // .section
1666     }
1669 /**
1670  * Prints the menus to add activities and resources.
1671  *
1672  * @param stdClass $course The course
1673  * @param int $section relative section number (field course_sections.section)
1674  * @param null|array $modnames An array containing the list of modules and their names
1675  *     if omitted will be taken from get_module_types_names()
1676  * @param bool $vertical Vertical orientation
1677  * @param bool $return Return the menus or send them to output
1678  * @param int $sectionreturn The section to link back to
1679  * @return void|string depending on $return
1680  */
1681 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1682     global $PAGE, $CFG, $OUTPUT;
1683     if ($course->id != $PAGE->course->id) {
1684         debugging('print_section_add_menus() can be called only for the course set on the page', DEBUG_DEVELOPER);
1685         return;
1686     }
1688     if ($modnames === null) {
1689         $modnames = get_module_types_names();
1690     }
1692     // check to see if user can add menus and there are modules to add
1693     if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
1694             || !$PAGE->user_is_editing()
1695             || empty($modnames)) {
1696         if ($return) {
1697             return '';
1698         } else {
1699             return false;
1700         }
1701     }
1703     // Retrieve all modules with associated metadata
1704     $modules = get_module_metadata($course, $modnames, $sectionreturn);
1706     // We'll sort resources and activities into two lists
1707     $resources = array();
1708     $activities = array();
1710     foreach ($modules as $module) {
1711         if (isset($module->types)) {
1712             // This module has a subtype
1713             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1714             $subtypes = array();
1715             foreach ($module->types as $subtype) {
1716                 $link = $subtype->link->out(true, array('section' => $section));
1717                 $subtypes[$link] = $subtype->title;
1718             }
1720             // Sort module subtypes into the list
1721             if (!empty($module->title)) {
1722                 // This grouping has a name
1723                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1724                     $resources[] = array($module->title=>$subtypes);
1725                 } else {
1726                     $activities[] = array($module->title=>$subtypes);
1727                 }
1728             } else {
1729                 // This grouping does not have a name
1730                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1731                     $resources = array_merge($resources, $subtypes);
1732                 } else {
1733                     $activities = array_merge($activities, $subtypes);
1734                 }
1735             }
1736         } else {
1737             // This module has no subtypes
1738             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1739                 $link = $module->link->out(true, array('section' => $section));
1740                 $resources[$link] = $module->title;
1741             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1742                 // System modules cannot be added by user, do not add to dropdown
1743             } else {
1744                 $link = $module->link->out(true, array('section' => $section));
1745                 $activities[$link] = $module->title;
1746             }
1747         }
1748     }
1750     $straddactivity = get_string('addactivity');
1751     $straddresource = get_string('addresource');
1752     $sectionname = get_section_name($course, $section);
1753     $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
1754     $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
1756     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1758     if (!$vertical) {
1759         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1760     }
1762     if (!empty($resources)) {
1763         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1764         $select->set_help_icon('resources');
1765         $select->set_label($strresourcelabel, array('class' => 'accesshide'));
1766         $output .= $OUTPUT->render($select);
1767     }
1769     if (!empty($activities)) {
1770         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1771         $select->set_help_icon('activities');
1772         $select->set_label($stractivitylabel, array('class' => 'accesshide'));
1773         $output .= $OUTPUT->render($select);
1774     }
1776     if (!$vertical) {
1777         $output .= html_writer::end_tag('div');
1778     }
1780     $output .= html_writer::end_tag('div');
1782     if (course_ajax_enabled($course)) {
1783         $straddeither = get_string('addresourceoractivity');
1784         // The module chooser link
1785         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1786         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1787         $icon = $OUTPUT->pix_icon('t/add', '');
1788         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1789         $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1790         $modchooser.= html_writer::end_tag('div');
1791         $modchooser.= html_writer::end_tag('div');
1793         // Wrap the normal output in a noscript div
1794         $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1795         if ($usemodchooser) {
1796             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1797             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1798         } else {
1799             // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1800             $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1801             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
1802         }
1803         $courserenderer = $PAGE->get_renderer('core', 'course');
1804         $output = $courserenderer->course_modchooser($modules, $course) . $modchooser . $output;
1805     }
1807     if ($return) {
1808         return $output;
1809     } else {
1810         echo $output;
1811     }
1814 /**
1815  * Retrieve all metadata for the requested modules
1816  *
1817  * @param object $course The Course
1818  * @param array $modnames An array containing the list of modules and their
1819  * names
1820  * @param int $sectionreturn The section to return to
1821  * @return array A list of stdClass objects containing metadata about each
1822  * module
1823  */
1824 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1825     global $CFG, $OUTPUT;
1827     // get_module_metadata will be called once per section on the page and courses may show
1828     // different modules to one another
1829     static $modlist = array();
1830     if (!isset($modlist[$course->id])) {
1831         $modlist[$course->id] = array();
1832     }
1834     $return = array();
1835     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1836     if ($sectionreturn !== null) {
1837         $urlbase->param('sr', $sectionreturn);
1838     }
1839     foreach($modnames as $modname => $modnamestr) {
1840         if (!course_allowed_module($course, $modname)) {
1841             continue;
1842         }
1843         if (isset($modlist[$course->id][$modname])) {
1844             // This module is already cached
1845             $return[$modname] = $modlist[$course->id][$modname];
1846             continue;
1847         }
1849         // Include the module lib
1850         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1851         if (!file_exists($libfile)) {
1852             continue;
1853         }
1854         include_once($libfile);
1856         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1857         $gettypesfunc =  $modname.'_get_types';
1858         if (function_exists($gettypesfunc)) {
1859             if ($types = $gettypesfunc()) {
1860                 $group = new stdClass();
1861                 $group->name = $modname;
1862                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1863                 foreach($types as $type) {
1864                     if ($type->typestr === '--') {
1865                         continue;
1866                     }
1867                     if (strpos($type->typestr, '--') === 0) {
1868                         $group->title = str_replace('--', '', $type->typestr);
1869                         continue;
1870                     }
1871                     // Set the Sub Type metadata
1872                     $subtype = new stdClass();
1873                     $subtype->title = $type->typestr;
1874                     $subtype->type = str_replace('&amp;', '&', $type->type);
1875                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1876                     $subtype->archetype = $type->modclass;
1878                     // The group archetype should match the subtype archetypes and all subtypes
1879                     // should have the same archetype
1880                     $group->archetype = $subtype->archetype;
1882                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1883                         $subtype->help = get_string('help' . $subtype->name, $modname);
1884                     }
1885                     $subtype->link = new moodle_url($urlbase, array('add' => $subtype->type));
1886                     $group->types[] = $subtype;
1887                 }
1888                 $modlist[$course->id][$modname] = $group;
1889             }
1890         } else {
1891             $module = new stdClass();
1892             $module->title = $modnamestr;
1893             $module->name = $modname;
1894             $module->link = new moodle_url($urlbase, array('add' => $modname));
1895             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1896             $sm = get_string_manager();
1897             if ($sm->string_exists('modulename_help', $modname)) {
1898                 $module->help = get_string('modulename_help', $modname);
1899                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1900                     $link = get_string('modulename_link', $modname);
1901                     $linktext = get_string('morehelp');
1902                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1903                 }
1904             }
1905             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1906             $modlist[$course->id][$modname] = $module;
1907         }
1908         $return[$modname] = $modlist[$course->id][$modname];
1909     }
1911     return $return;
1914 /**
1915  * Return the course category context for the category with id $categoryid, except
1916  * that if $categoryid is 0, return the system context.
1917  *
1918  * @param integer $categoryid a category id or 0.
1919  * @return object the corresponding context
1920  */
1921 function get_category_or_system_context($categoryid) {
1922     if ($categoryid) {
1923         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1924     } else {
1925         return context_system::instance();
1926     }
1929 /**
1930  * Gets the child categories of a given courses category. Uses a static cache
1931  * to make repeat calls efficient.
1932  *
1933  * @param int $parentid the id of a course category.
1934  * @return array all the child course categories.
1935  */
1936 function get_child_categories($parentid) {
1937     static $allcategories = null;
1939     // only fill in this variable the first time
1940     if (null == $allcategories) {
1941         $allcategories = array();
1943         $categories = get_categories();
1944         foreach ($categories as $category) {
1945             if (empty($allcategories[$category->parent])) {
1946                 $allcategories[$category->parent] = array();
1947             }
1948             $allcategories[$category->parent][] = $category;
1949         }
1950     }
1952     if (empty($allcategories[$parentid])) {
1953         return array();
1954     } else {
1955         return $allcategories[$parentid];
1956     }
1959 /**
1960  * This function recursively travels the categories, building up a nice list
1961  * for display. It also makes an array that list all the parents for each
1962  * category.
1963  *
1964  * For example, if you have a tree of categories like:
1965  *   Miscellaneous (id = 1)
1966  *      Subcategory (id = 2)
1967  *         Sub-subcategory (id = 4)
1968  *   Other category (id = 3)
1969  * Then after calling this function you will have
1970  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1971  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1972  *      3 => 'Other category');
1973  * $parents = array(2 => array(1), 4 => array(1, 2));
1974  *
1975  * If you specify $requiredcapability, then only categories where the current
1976  * user has that capability will be added to $list, although all categories
1977  * will still be added to $parents, and if you only have $requiredcapability
1978  * in a child category, not the parent, then the child catgegory will still be
1979  * included.
1980  *
1981  * If you specify the option $excluded, then that category, and all its children,
1982  * are omitted from the tree. This is useful when you are doing something like
1983  * moving categories, where you do not want to allow people to move a category
1984  * to be the child of itself.
1985  *
1986  * @param array $list For output, accumulates an array categoryid => full category path name
1987  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1988  * @param string/array $requiredcapability if given, only categories where the current
1989  *      user has this capability will be added to $list. Can also be an array of capabilities,
1990  *      in which case they are all required.
1991  * @param integer $excludeid Omit this category and its children from the lists built.
1992  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1993  * @param string $path For internal use, as part of recursive calls.
1994  */
1995 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1996         $excludeid = 0, $category = NULL, $path = "") {
1998     // initialize the arrays if needed
1999     if (!is_array($list)) {
2000         $list = array();
2001     }
2002     if (!is_array($parents)) {
2003         $parents = array();
2004     }
2006     if (empty($category)) {
2007         // Start at the top level.
2008         $category = new stdClass;
2009         $category->id = 0;
2010     } else {
2011         // This is the excluded category, don't include it.
2012         if ($excludeid > 0 && $excludeid == $category->id) {
2013             return;
2014         }
2016         $context = context_coursecat::instance($category->id);
2017         $categoryname = format_string($category->name, true, array('context' => $context));
2019         // Update $path.
2020         if ($path) {
2021             $path = $path.' / '.$categoryname;
2022         } else {
2023             $path = $categoryname;
2024         }
2026         // Add this category to $list, if the permissions check out.
2027         if (empty($requiredcapability)) {
2028             $list[$category->id] = $path;
2030         } else {
2031             $requiredcapability = (array)$requiredcapability;
2032             if (has_all_capabilities($requiredcapability, $context)) {
2033                 $list[$category->id] = $path;
2034             }
2035         }
2036     }
2038     // Add all the children recursively, while updating the parents array.
2039     if ($categories = get_child_categories($category->id)) {
2040         foreach ($categories as $cat) {
2041             if (!empty($category->id)) {
2042                 if (isset($parents[$category->id])) {
2043                     $parents[$cat->id]   = $parents[$category->id];
2044                 }
2045                 $parents[$cat->id][] = $category->id;
2046             }
2047             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2048         }
2049     }
2052 /**
2053  * This function generates a structured array of courses and categories.
2054  *
2055  * The depth of categories is limited by $CFG->maxcategorydepth however there
2056  * is no limit on the number of courses!
2057  *
2058  * Suitable for use with the course renderers course_category_tree method:
2059  * $renderer = $PAGE->get_renderer('core','course');
2060  * echo $renderer->course_category_tree(get_course_category_tree());
2061  *
2062  * @global moodle_database $DB
2063  * @param int $id
2064  * @param int $depth
2065  */
2066 function get_course_category_tree($id = 0, $depth = 0) {
2067     global $DB, $CFG;
2068     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
2069     $categories = get_child_categories($id);
2070     $categoryids = array();
2071     foreach ($categories as $key => &$category) {
2072         if (!$category->visible && !$viewhiddencats) {
2073             unset($categories[$key]);
2074             continue;
2075         }
2076         $categoryids[$category->id] = $category;
2077         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2078             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2079             foreach ($subcategories as $subid=>$subcat) {
2080                 $categoryids[$subid] = $subcat;
2081             }
2082             $category->courses = array();
2083         }
2084     }
2086     if ($depth > 0) {
2087         // This is a recursive call so return the required array
2088         return array($categories, $categoryids);
2089     }
2091     if (empty($categoryids)) {
2092         // No categories available (probably all hidden).
2093         return array();
2094     }
2096     // The depth is 0 this function has just been called so we can finish it off
2098     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2099     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2100     $sql = "SELECT
2101             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2102             $ccselect
2103             FROM {course} c
2104             $ccjoin
2105             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2106     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2107         // loop throught them
2108         foreach ($courses as $course) {
2109             if ($course->id == SITEID) {
2110                 continue;
2111             }
2112             context_instance_preload($course);
2113             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2114                 $categoryids[$course->category]->courses[$course->id] = $course;
2115             }
2116         }
2117     }
2118     return $categories;
2121 /**
2122  * Recursive function to print out all the categories in a nice format
2123  * with or without courses included
2124  */
2125 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2126     global $CFG;
2128     // maxcategorydepth == 0 meant no limit
2129     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2130         return;
2131     }
2133     if (!$displaylist) {
2134         make_categories_list($displaylist, $parentslist);
2135     }
2137     if ($category) {
2138         if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
2139             print_category_info($category, $depth, $showcourses);
2140         } else {
2141             return;  // Don't bother printing children of invisible categories
2142         }
2144     } else {
2145         $category = new stdClass();
2146         $category->id = "0";
2147     }
2149     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2150         $countcats = count($categories);
2151         $count = 0;
2152         $first = true;
2153         $last = false;
2154         foreach ($categories as $cat) {
2155             $count++;
2156             if ($count == $countcats) {
2157                 $last = true;
2158             }
2159             $up = $first ? false : true;
2160             $down = $last ? false : true;
2161             $first = false;
2163             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2164         }
2165     }
2168 /**
2169  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2170  */
2171 function make_categories_options() {
2172     make_categories_list($cats,$parents);
2173     foreach ($cats as $key => $value) {
2174         if (array_key_exists($key,$parents)) {
2175             if ($indent = count($parents[$key])) {
2176                 for ($i = 0; $i < $indent; $i++) {
2177                     $cats[$key] = '&nbsp;'.$cats[$key];
2178                 }
2179             }
2180         }
2181     }
2182     return $cats;
2185 /**
2186  * Prints the category info in indented fashion
2187  * This function is only used by print_whole_category_list() above
2188  */
2189 function print_category_info($category, $depth=0, $showcourses = false) {
2190     global $CFG, $DB, $OUTPUT;
2192     $strsummary = get_string('summary');
2194     $catlinkcss = null;
2195     if (!$category->visible) {
2196         $catlinkcss = array('class'=>'dimmed');
2197     }
2198     static $coursecount = null;
2199     if (null === $coursecount) {
2200         // only need to check this once
2201         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2202     }
2204     if ($showcourses and $coursecount) {
2205         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2206     } else {
2207         $catimage = "&nbsp;";
2208     }
2210     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2211     $context = context_coursecat::instance($category->id);
2212     $fullname = format_string($category->name, true, array('context' => $context));
2214     if ($showcourses and $coursecount) {
2215         echo '<div class="categorylist clearfix">';
2216         $cat = '';
2217         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2218         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2219         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2221         $html = '';
2222         if ($depth > 0) {
2223             for ($i=0; $i< $depth; $i++) {
2224                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2225                 $cat = '';
2226             }
2227         } else {
2228             $html = $cat;
2229         }
2230         echo html_writer::tag('div', $html, array('class'=>'category'));
2231         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2233         // does the depth exceed maxcategorydepth
2234         // maxcategorydepth == 0 or unset meant no limit
2235         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2236         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2237             foreach ($courses as $course) {
2238                 $linkcss = null;
2239                 if (!$course->visible) {
2240                     $linkcss = array('class'=>'dimmed');
2241                 }
2243                 $coursename = get_course_display_name_for_list($course);
2244                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2246                 // print enrol info
2247                 $courseicon = '';
2248                 if ($icons = enrol_get_course_info_icons($course)) {
2249                     foreach ($icons as $pix_icon) {
2250                         $courseicon = $OUTPUT->render($pix_icon);
2251                     }
2252                 }
2254                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2256                 if ($course->summary) {
2257                     $link = new moodle_url('/course/info.php?id='.$course->id);
2258                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2259                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2260                         array('title'=>$strsummary));
2262                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2263                 }
2265                 $html = '';
2266                 for ($i=0; $i <= $depth; $i++) {
2267                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2268                     $coursecontent = '';
2269                 }
2270                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2271             }
2272         }
2273         echo '</div>';
2274     } else {
2275         echo '<div class="categorylist">';
2276         $html = '';
2277         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2278         if (count($courses) > 0) {
2279             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2280         }
2282         if ($depth > 0) {
2283             for ($i=0; $i< $depth; $i++) {
2284                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2285                 $cat = '';
2286             }
2287         } else {
2288             $html = $cat;
2289         }
2291         echo html_writer::tag('div', $html, array('class'=>'category'));
2292         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2293         echo '</div>';
2294     }
2297 /**
2298  * Print the buttons relating to course requests.
2299  *
2300  * @param object $systemcontext the system context.
2301  */
2302 function print_course_request_buttons($systemcontext) {
2303     global $CFG, $DB, $OUTPUT;
2304     if (empty($CFG->enablecourserequests)) {
2305         return;
2306     }
2307     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2308     /// Print a button to request a new course
2309         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2310     }
2311     /// Print a button to manage pending requests
2312     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2313         $disabled = !$DB->record_exists('course_request', array());
2314         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2315     }
2318 /**
2319  * Does the user have permission to edit things in this category?
2320  *
2321  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2322  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2323  */
2324 function can_edit_in_category($categoryid = 0) {
2325     $context = get_category_or_system_context($categoryid);
2326     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2329 /**
2330  * Prints the turn editing on/off button on course/index.php or course/category.php.
2331  *
2332  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2333  * @return string HTML of the editing button, or empty string, if this user is not allowed
2334  *      to see it.
2335  */
2336 function update_category_button($categoryid = 0) {
2337     global $CFG, $PAGE, $OUTPUT;
2339     // Check permissions.
2340     if (!can_edit_in_category($categoryid)) {
2341         return '';
2342     }
2344     // Work out the appropriate action.
2345     if ($PAGE->user_is_editing()) {
2346         $label = get_string('turneditingoff');
2347         $edit = 'off';
2348     } else {
2349         $label = get_string('turneditingon');
2350         $edit = 'on';
2351     }
2353     // Generate the button HTML.
2354     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2355     if ($categoryid) {
2356         $options['id'] = $categoryid;
2357         $page = 'category.php';
2358     } else {
2359         $page = 'index.php';
2360     }
2361     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2364 /**
2365  * Category is 0 (for all courses) or an object
2366  */
2367 function print_courses($category) {
2368     global $CFG, $OUTPUT;
2370     if (!is_object($category) && $category==0) {
2371         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2372         if (is_array($categories) && count($categories) == 1) {
2373             $category   = array_shift($categories);
2374             $courses    = get_courses_wmanagers($category->id,
2375                                                 'c.sortorder ASC',
2376                                                 array('summary','summaryformat'));
2377         } else {
2378             $courses    = get_courses_wmanagers('all',
2379                                                 'c.sortorder ASC',
2380                                                 array('summary','summaryformat'));
2381         }
2382         unset($categories);
2383     } else {
2384         $courses    = get_courses_wmanagers($category->id,
2385                                             'c.sortorder ASC',
2386                                             array('summary','summaryformat'));
2387     }
2389     if ($courses) {
2390         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2391         foreach ($courses as $course) {
2392             $coursecontext = context_course::instance($course->id);
2393             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2394                 echo html_writer::start_tag('li');
2395                 print_course($course);
2396                 echo html_writer::end_tag('li');
2397             }
2398         }
2399         echo html_writer::end_tag('ul');
2400     } else {
2401         echo $OUTPUT->heading(get_string("nocoursesyet"));
2402         $context = context_system::instance();
2403         if (has_capability('moodle/course:create', $context)) {
2404             $options = array();
2405             if (!empty($category->id)) {
2406                 $options['category'] = $category->id;
2407             } else {
2408                 $options['category'] = $CFG->defaultrequestcategory;
2409             }
2410             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2411             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2412             echo html_writer::end_tag('div');
2413         }
2414     }
2417 /**
2418  * Print a description of a course, suitable for browsing in a list.
2419  *
2420  * @param object $course the course object.
2421  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2422  */
2423 function print_course($course, $highlightterms = '') {
2424     global $CFG, $USER, $DB, $OUTPUT;
2426     $context = context_course::instance($course->id);
2428     // Rewrite file URLs so that they are correct
2429     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2431     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2432     echo html_writer::start_tag('div', array('class'=>'info'));
2433     echo html_writer::start_tag('h3', array('class'=>'name'));
2435     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2437     $coursename = get_course_display_name_for_list($course);
2438     $linktext = highlight($highlightterms, format_string($coursename));
2439     $linkparams = array('title'=>get_string('entercourse'));
2440     if (empty($course->visible)) {
2441         $linkparams['class'] = 'dimmed';
2442     }
2443     echo html_writer::link($linkhref, $linktext, $linkparams);
2444     echo html_writer::end_tag('h3');
2446     /// first find all roles that are supposed to be displayed
2447     if (!empty($CFG->coursecontact)) {
2448         $managerroles = explode(',', $CFG->coursecontact);
2449         $rusers = array();
2451         if (!isset($course->managers)) {
2452             list($sort, $sortparams) = users_order_by_sql('u');
2453             $rusers = get_role_users($managerroles, $context, true,
2454                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
2455                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
2456                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
2457         } else {
2458             //  use the managers array if we have it for perf reasosn
2459             //  populate the datastructure like output of get_role_users();
2460             foreach ($course->managers as $manager) {
2461                 $user = clone($manager->user);
2462                 $user->roleid = $manager->roleid;
2463                 $user->rolename = $manager->rolename;
2464                 $user->roleshortname = $manager->roleshortname;
2465                 $user->rolecoursealias = $manager->rolecoursealias;
2466                 $rusers[$user->id] = $user;
2467             }
2468         }
2470         $namesarray = array();
2471         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2472         foreach ($rusers as $ra) {
2473             if (isset($namesarray[$ra->id])) {
2474                 //  only display a user once with the higest sortorder role
2475                 continue;
2476             }
2478             $role = new stdClass();
2479             $role->id = $ra->roleid;
2480             $role->name = $ra->rolename;
2481             $role->shortname = $ra->roleshortname;
2482             $role->coursealias = $ra->rolecoursealias;
2483             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
2485             $fullname = fullname($ra, $canviewfullnames);
2486             $namesarray[$ra->id] = $rolename.': '.
2487                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2488         }
2490         if (!empty($namesarray)) {
2491             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2492             foreach ($namesarray as $name) {
2493                 echo html_writer::tag('li', $name);
2494             }
2495             echo html_writer::end_tag('ul');
2496         }
2497     }
2498     echo html_writer::end_tag('div'); // End of info div
2500     echo html_writer::start_tag('div', array('class'=>'summary'));
2501     $options = new stdClass();
2502     $options->noclean = true;
2503     $options->para = false;
2504     $options->overflowdiv = true;
2505     if (!isset($course->summaryformat)) {
2506         $course->summaryformat = FORMAT_MOODLE;
2507     }
2508     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2509     if ($icons = enrol_get_course_info_icons($course)) {
2510         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2511         foreach ($icons as $icon) {
2512             echo $OUTPUT->render($icon);
2513         }
2514         echo html_writer::end_tag('div'); // End of enrolmenticons div
2515     }
2516     echo html_writer::end_tag('div'); // End of summary div
2517     echo html_writer::end_tag('div'); // End of coursebox div
2520 /**
2521  * Prints custom user information on the home page.
2522  * Over time this can include all sorts of information
2523  */
2524 function print_my_moodle() {
2525     global $USER, $CFG, $DB, $OUTPUT;
2527     if (!isloggedin() or isguestuser()) {
2528         print_error('nopermissions', '', '', 'See My Moodle');
2529     }
2531     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2532     $rhosts   = array();
2533     $rcourses = array();
2534     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2535         $rcourses = get_my_remotecourses($USER->id);
2536         $rhosts   = get_my_remotehosts();
2537     }
2539     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2541         if (!empty($courses)) {
2542             echo '<ul class="unlist">';
2543             foreach ($courses as $course) {
2544                 if ($course->id == SITEID) {
2545                     continue;
2546                 }
2547                 echo '<li>';
2548                 print_course($course);
2549                 echo "</li>\n";
2550             }
2551             echo "</ul>\n";
2552         }
2554         // MNET
2555         if (!empty($rcourses)) {
2556             // at the IDP, we know of all the remote courses
2557             foreach ($rcourses as $course) {
2558                 print_remote_course($course, "100%");
2559             }
2560         } elseif (!empty($rhosts)) {
2561             // non-IDP, we know of all the remote servers, but not courses
2562             foreach ($rhosts as $host) {
2563                 print_remote_host($host, "100%");
2564             }
2565         }
2566         unset($course);
2567         unset($host);
2569         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2570             echo "<table width=\"100%\"><tr><td align=\"center\">";
2571             print_course_search("", false, "short");
2572             echo "</td><td align=\"center\">";
2573             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2574             echo "</td></tr></table>\n";
2575         }
2577     } else {
2578         if ($DB->count_records("course_categories") > 1) {
2579             echo $OUTPUT->box_start("categorybox");
2580             print_whole_category_list();
2581             echo $OUTPUT->box_end();
2582         } else {
2583             print_courses(0);
2584         }
2585     }
2589 function print_course_search($value="", $return=false, $format="plain") {
2590     global $CFG;
2591     static $count = 0;
2593     $count++;
2595     $id = 'coursesearch';
2597     if ($count > 1) {
2598         $id .= $count;
2599     }
2601     $strsearchcourses= get_string("searchcourses");
2603     if ($format == 'plain') {
2604         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2605         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2606         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2607         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2608         $output .= '<input type="submit" value="'.get_string('go').'" />';
2609         $output .= '</fieldset></form>';
2610     } else if ($format == 'short') {
2611         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2612         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2613         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2614         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2615         $output .= '<input type="submit" value="'.get_string('go').'" />';
2616         $output .= '</fieldset></form>';
2617     } else if ($format == 'navbar') {
2618         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2619         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2620         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2621         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2622         $output .= '<input type="submit" value="'.get_string('go').'" />';
2623         $output .= '</fieldset></form>';
2624     }
2626     if ($return) {
2627         return $output;
2628     }
2629     echo $output;
2632 function print_remote_course($course, $width="100%") {
2633     global $CFG, $USER;
2635     $linkcss = '';
2637     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2639     echo '<div class="coursebox remotecoursebox clearfix">';
2640     echo '<div class="info">';
2641     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2642          $linkcss.' href="'.$url.'">'
2643         .  format_string($course->fullname) .'</a><br />'
2644         . format_string($course->hostname) . ' : '
2645         . format_string($course->cat_name) . ' : '
2646         . format_string($course->shortname). '</div>';
2647     echo '</div><div class="summary">';
2648     $options = new stdClass();
2649     $options->noclean = true;
2650     $options->para = false;
2651     $options->overflowdiv = true;
2652     echo format_text($course->summary, $course->summaryformat, $options);
2653     echo '</div>';
2654     echo '</div>';
2657 function print_remote_host($host, $width="100%") {
2658     global $OUTPUT;
2660     $linkcss = '';
2662     echo '<div class="coursebox clearfix">';
2663     echo '<div class="info">';
2664     echo '<div class="name">';
2665     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2666     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2667         . s($host['name']).'</a> - ';
2668     echo $host['count'] . ' ' . get_string('courses');
2669     echo '</div>';
2670     echo '</div>';
2671     echo '</div>';
2675 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2677 function add_course_module($mod) {
2678     global $DB;
2680     $mod->added = time();
2681     unset($mod->id);
2683     $cmid = $DB->insert_record("course_modules", $mod);
2684     rebuild_course_cache($mod->course, true);
2685     return $cmid;
2688 /**
2689  * Creates missing course section(s) and rebuilds course cache
2690  *
2691  * @param int|stdClass $courseorid course id or course object
2692  * @param int|array $sections list of relative section numbers to create
2693  * @return bool if there were any sections created
2694  */
2695 function course_create_sections_if_missing($courseorid, $sections) {
2696     global $DB;
2697     if (!is_array($sections)) {
2698         $sections = array($sections);
2699     }
2700     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2701     if (is_object($courseorid)) {
2702         $courseorid = $courseorid->id;
2703     }
2704     $coursechanged = false;
2705     foreach ($sections as $sectionnum) {
2706         if (!in_array($sectionnum, $existing)) {
2707             $cw = new stdClass();
2708             $cw->course   = $courseorid;
2709             $cw->section  = $sectionnum;
2710             $cw->summary  = '';
2711             $cw->summaryformat = FORMAT_HTML;
2712             $cw->sequence = '';
2713             $id = $DB->insert_record("course_sections", $cw);
2714             $coursechanged = true;
2715         }
2716     }
2717     if ($coursechanged) {
2718         rebuild_course_cache($courseorid, true);
2719     }
2720     return $coursechanged;
2723 /**
2724  * Adds an existing module to the section
2725  *
2726  * Updates both tables {course_sections} and {course_modules}
2727  *
2728  * @param int|stdClass $courseorid course id or course object
2729  * @param int $cmid id of the module already existing in course_modules table
2730  * @param int $sectionnum relative number of the section (field course_sections.section)
2731  *     If section does not exist it will be created
2732  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2733  *     before which the module needs to be included. Null for inserting in the
2734  *     end of the section
2735  * @return int The course_sections ID where the module is inserted
2736  */
2737 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
2738     global $DB, $COURSE;
2739     if (is_object($beforemod)) {
2740         $beforemod = $beforemod->id;
2741     }
2742     if (is_object($courseorid)) {
2743         $courseid = $courseorid->id;
2744     } else {
2745         $courseid = $courseorid;
2746     }
2747     course_create_sections_if_missing($courseorid, $sectionnum);
2748     // Do not try to use modinfo here, there is no guarantee it is valid!
2749     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
2750     $modarray = explode(",", trim($section->sequence));
2751     if (empty($section->sequence)) {
2752         $newsequence = "$cmid";
2753     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2754         $insertarray = array($cmid, $beforemod);
2755         array_splice($modarray, $key[0], 1, $insertarray);
2756         $newsequence = implode(",", $modarray);
2757     } else {
2758         $newsequence = "$section->sequence,$cmid";
2759     }
2760     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2761     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
2762     if (is_object($courseorid)) {
2763         rebuild_course_cache($courseorid->id, true);
2764     } else {
2765         rebuild_course_cache($courseorid, true);
2766     }
2767     return $section->id;     // Return course_sections ID that was used.
2770 function set_coursemodule_groupmode($id, $groupmode) {
2771     global $DB;
2772     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2773     if ($cm->groupmode != $groupmode) {
2774         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2775         rebuild_course_cache($cm->course, true);
2776     }
2777     return ($cm->groupmode != $groupmode);
2780 function set_coursemodule_idnumber($id, $idnumber) {
2781     global $DB;
2782     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2783     if ($cm->idnumber != $idnumber) {
2784         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2785         rebuild_course_cache($cm->course, true);
2786     }
2787     return ($cm->idnumber != $idnumber);
2790 /**
2791  * Set the visibility of a module and inherent properties.
2792  *
2793  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
2794  * has been moved to {@link set_section_visible()} which was the only place from which
2795  * the parameter was used.
2796  *
2797  * @param int $id of the module
2798  * @param int $visible state of the module
2799  * @return bool false when the module was not found, true otherwise
2800  */
2801 function set_coursemodule_visible($id, $visible) {
2802     global $DB, $CFG;
2803     require_once($CFG->libdir.'/gradelib.php');
2805     // Trigger developer's attention when using the previously removed argument.
2806     if (func_num_args() > 2) {
2807         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
2808             has been removed.', DEBUG_DEVELOPER);
2809     }
2811     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2812         return false;
2813     }
2814     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2815         return false;
2816     }
2817     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2818         foreach($events as $event) {
2819             if ($visible) {
2820                 show_event($event);
2821             } else {
2822                 hide_event($event);
2823             }
2824         }
2825     }
2827     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2828     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2829     if ($grade_items) {
2830         foreach ($grade_items as $grade_item) {
2831             $grade_item->set_hidden(!$visible);
2832         }
2833     }
2835     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
2836     // affect visibleold to allow for an original visibility restore. See set_section_visible().
2837     $cminfo = new stdClass();
2838     $cminfo->id = $id;
2839     $cminfo->visible = $visible;
2840     $cminfo->visibleold = $visible;
2841     $DB->update_record('course_modules', $cminfo);
2843     rebuild_course_cache($cm->course, true);
2844     return true;
2847 /**
2848  * Delete a course module and any associated data at the course level (events)
2849  * Until 1.5 this function simply marked a deleted flag ... now it
2850  * deletes it completely.
2851  *
2852  */
2853 function delete_course_module($id) {
2854     global $CFG, $DB;
2855     require_once($CFG->libdir.'/gradelib.php');
2856     require_once($CFG->dirroot.'/blog/lib.php');
2858     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2859         return true;
2860     }
2861     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2862     //delete events from calendar
2863     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2864         foreach($events as $event) {
2865             delete_event($event->id);
2866         }
2867     }
2868     //delete grade items, outcome items and grades attached to modules
2869     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2870                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2871         foreach ($grade_items as $grade_item) {
2872             $grade_item->delete('moddelete');
2873         }
2874     }
2875     // Delete completion and availability data; it is better to do this even if the
2876     // features are not turned on, in case they were turned on previously (these will be
2877     // very quick on an empty table)
2878     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2879     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2880     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2881     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2882                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2884     delete_context(CONTEXT_MODULE, $cm->id);
2885     $DB->delete_records('course_modules', array('id'=>$cm->id));
2886     rebuild_course_cache($cm->course, true);
2887     return true;
2890 function delete_mod_from_section($modid, $sectionid) {
2891     global $DB;
2893     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2895         $modarray = explode(",", $section->sequence);
2897         if ($key = array_keys ($modarray, $modid)) {
2898             array_splice($modarray, $key[0], 1);
2899             $newsequence = implode(",", $modarray);
2900             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2901             rebuild_course_cache($section->course, true);
2902             return true;
2903         } else {
2904             return false;
2905         }
2907     }
2908     return false;
2911 /**
2912  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2913  *
2914  * @param object $course course object
2915  * @param int $section Section number (not id!!!)
2916  * @param int $move (-1 or 1)
2917  * @return boolean true if section moved successfully
2918  * @todo MDL-33379 remove this function in 2.5
2919  */
2920 function move_section($course, $section, $move) {
2921     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2923 /// Moves a whole course section up and down within the course
2924     global $USER;
2926     if (!$move) {
2927         return true;
2928     }
2930     $sectiondest = $section + $move;
2932     // compartibility with course formats using field 'numsections'
2933     $courseformatoptions = course_get_format($course)->get_format_options();
2934     if (array_key_exists('numsections', $courseformatoptions) &&
2935             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2936         return false;
2937     }
2939     $retval = move_section_to($course, $section, $sectiondest);
2940     return $retval;
2943 /**
2944  * Moves a section within a course, from a position to another.
2945  * Be very careful: $section and $destination refer to section number,
2946  * not id!.
2947  *
2948  * @param object $course
2949  * @param int $section Section number (not id!!!)
2950  * @param int $destination
2951  * @return boolean Result
2952  */
2953 function move_section_to($course, $section, $destination) {
2954 /// Moves a whole course section up and down within the course
2955     global $USER, $DB;
2957     if (!$destination && $destination != 0) {
2958         return true;
2959     }
2961     // compartibility with course formats using field 'numsections'
2962     $courseformatoptions = course_get_format($course)->get_format_options();
2963     if ((array_key_exists('numsections', $courseformatoptions) &&
2964             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
2965         return false;
2966     }
2968     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2969     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2970             'section ASC, id ASC', 'id, section')) {
2971         return false;
2972     }
2974     $movedsections = reorder_sections($sections, $section, $destination);
2976     // Update all sections. Do this in 2 steps to avoid breaking database
2977     // uniqueness constraint
2978     $transaction = $DB->start_delegated_transaction();
2979     foreach ($movedsections as $id => $position) {
2980         if ($sections[$id] !== $position) {
2981             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2982         }
2983     }
2984     foreach ($movedsections as $id => $position) {
2985         if ($sections[$id] !== $position) {
2986             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2987         }
2988     }
2990     // If we move the highlighted section itself, then just highlight the destination.
2991     // Adjust the higlighted section location if we move something over it either direction.
2992     if ($section == $course->marker) {
2993         course_set_marker($course->id, $destination);
2994     } elseif ($section > $course->marker && $course->marker >= $destination) {
2995         course_set_marker($course->id, $course->marker+1);
2996     } elseif ($section < $course->marker && $course->marker <= $destination) {
2997         course_set_marker($course->id, $course->marker-1);
2998     }
3000     $transaction->allow_commit();
3001     rebuild_course_cache($course->id, true);
3002     return true;
3005 /**
3006  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3007  * an original position number and a target position number, rebuilds the array so that the
3008  * move is made without any duplication of section positions.
3009  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3010  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3011  *
3012  * @param array $sections
3013  * @param int $origin_position
3014  * @param int $target_position
3015  * @return array
3016  */
3017 function reorder_sections($sections, $origin_position, $target_position) {
3018     if (!is_array($sections)) {
3019         return false;
3020     }
3022     // We can't move section position 0
3023     if ($origin_position < 1) {
3024         echo "We can't move section position 0";
3025         return false;
3026     }
3028     // Locate origin section in sections array
3029     if (!$origin_key = array_search($origin_position, $sections)) {
3030         echo "searched position not in sections array";
3031         return false; // searched position not in sections array
3032     }
3034     // Extract origin section
3035     $origin_section = $sections[$origin_key];
3036     unset($sections[$origin_key]);
3038     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3039     $found = false;
3040     $append_array = array();
3041     foreach ($sections as $id => $position) {
3042         if ($found) {
3043             $append_array[$id] = $position;
3044             unset($sections[$id]);
3045         }
3046         if ($position == $target_position) {
3047             if ($target_position < $origin_position) {
3048                 $append_array[$id] = $position;
3049                 unset($sections[$id]);
3050             }
3051             $found = true;
3052         }
3053     }
3055     // Append moved section
3056     $sections[$origin_key] = $origin_section;
3058     // Append rest of array (if applicable)
3059     if (!empty($append_array)) {
3060         foreach ($append_array as $id => $position) {
3061             $sections[$id] = $position;
3062         }
3063     }
3065     // Renumber positions
3066     $position = 0;
3067     foreach ($sections as $id => $p) {
3068         $sections[$id] = $position;
3069         $position++;
3070     }
3072     return $sections;
3076 /**
3077  * Move the module object $mod to the specified $section
3078  * If $beforemod exists then that is the module
3079  * before which $modid should be inserted
3080  * All parameters are objects
3081  */
3082 function moveto_module($mod, $section, $beforemod=NULL) {
3083     global $OUTPUT;
3085 /// Remove original module from original section
3086     if (! delete_mod_from_section($mod->id, $mod->section)) {
3087         echo $OUTPUT->notification("Could not delete module from existing section");
3088     }
3090     // if moving to a hidden section then hide module
3091     if (!$section->visible && $mod->visible) {
3092         set_coursemodule_visible($mod->id, 0);
3093     }
3095 /// Add the module into the new section
3096     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
3097     return true;
3100 /**
3101  * Produces the editing buttons for a module
3102  *
3103  * @global core_renderer $OUTPUT
3104  * @staticvar type $str
3105  * @param stdClass $mod The module to produce editing buttons for
3106  * @param bool $absolute_ignored (argument ignored) - all links are absolute
3107  * @param bool $moveselect (argument ignored)
3108  * @param int $indent The current indenting
3109  * @param int $section The section to link back to
3110  * @return string XHTML for the editing buttons
3111  */
3112 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3113     global $PAGE;
3114     if (!($mod instanceof cm_info)) {
3115         $modinfo = get_fast_modinfo($mod->course);
3116         $mod = $modinfo->get_cm($mod->id);
3117     }
3118     $actions = course_get_cm_edit_actions($mod, $indent, $section);
3120     $courserenderer = $PAGE->get_renderer('core', 'course');
3121     // The space added before the <span> is a ugly hack but required to set the CSS property white-space: nowrap
3122     // and having it to work without attaching the preceding text along with it. Hopefully the refactoring of
3123     // the course page HTML will allow this to be removed.
3124     return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
3127 /**
3128  * Returns the list of all editing actions that current user can perform on the module
3129  *
3130  * @param cm_info $mod The module to produce editing buttons for
3131  * @param int $indent The current indenting (default -1 means no move left-right actions)
3132  * @param int $sr The section to link back to (used for creating the links)
3133  * @return array array of action_link or pix_icon objects
3134  */
3135 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
3136     global $COURSE, $SITE;
3138     static $str;
3140     $coursecontext = context_course::instance($mod->course);
3141     $modcontext = context_module::instance($mod->id);
3143     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3144     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3146     // no permission to edit anything
3147     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3148         return array();
3149     }
3151     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3153     if (!isset($str)) {
3154         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
3155             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
3156         $str->assign         = get_string('assignroles', 'role');
3157         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3158         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3159         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3160         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3161         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3162         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3163     }
3165     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3167     if ($sr !== null) {
3168         $baseurl->param('sr', $sr);
3169     }
3170     $actions = array();
3172     // AJAX edit title
3173     if ($mod->modname !== 'label' && $hasmanageactivities &&
3174                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
3175                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
3176         // we will not display link if we are on some other-course page (where we should not see this module anyway)
3177         $actions['title'] = new action_link(
3178             new moodle_url($baseurl, array('update' => $mod->id)),
3179             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3180             null,
3181             array('class' => 'editing_title', 'title' => $str->edittitle)
3182         );
3183     }
3185     // leftright
3186     if ($hasmanageactivities) {
3187         if (right_to_left()) {   // Exchange arrows on RTL
3188             $rightarrow = 't/left';
3189             $leftarrow  = 't/right';
3190         } else {
3191             $rightarrow = 't/right';
3192             $leftarrow  = 't/left';
3193         }
3195         if ($indent > 0) {
3196             $actions['moveleft'] = new action_link(
3197                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3198                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3199                 null,
3200                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3201             );
3202         }
3203         if ($indent >= 0) {
3204             $actions['moveright'] = new action_link(
3205                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3206                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3207                 null,
3208                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3209             );
3210         }
3211     }
3213     // move
3214     if ($hasmanageactivities) {
3215         $actions['move'] = new action_link(
3216             new moodle_url($baseurl, array('copy' => $mod->id)),
3217             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3218             null,
3219             array('class' => 'editing_move', 'title' => $str->move)
3220         );
3221     }
3223     // Update
3224     if ($hasmanageactivities) {
3225         $actions['update'] = new action_link(
3226             new moodle_url($baseurl, array('update' => $mod->id)),
3227             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3228             null,
3229             array('class' => 'editing_update', 'title' => $str->update)
3230         );
3231     }
3233     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3234     // note that restoring on front page is never allowed
3235     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
3236             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3237         $actions['duplicate'] = new action_link(
3238             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3239             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3240             null,
3241             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3242         );
3243     }
3245     // Delete
3246     if ($hasmanageactivities) {
3247         $actions['delete'] = new action_link(
3248             new moodle_url($baseurl, array('delete' => $mod->id)),
3249             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3250             null,
3251             array('class' => 'editing_delete', 'title' => $str->delete)
3252         );
3253     }
3255     // hideshow
3256     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3257         if ($mod->visible) {
3258             $actions['hide'] = new action_link(
3259                 new moodle_url($baseurl, array('hide' => $mod->id)),
3260                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3261                 null,
3262                 array('class' => 'editing_hide', 'title' => $str->hide)
3263             );
3264         } else {
3265             $actions['show'] = new action_link(
3266                 new moodle_url($baseurl, array('show' => $mod->id)),
3267                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3268                 null,
3269                 array('class' => 'editing_show', 'title' => $str->show)
3270             );
3271         }
3272     }
3274     // groupmode
3275     if ($hasmanageactivities and $mod->groupmode !== false) {
3276         if ($mod->groupmode == SEPARATEGROUPS) {
3277             $groupmode = NOGROUPS;
3278             $grouptitle = $str->groupsseparate;
3279             $forcedgrouptitle = $str->forcedgroupsseparate;
3280             $actionname = 'groupsseparate';
3281             $groupimage = 't/groups';
3282         } else if ($mod->groupmode == VISIBLEGROUPS) {
3283             $groupmode = SEPARATEGROUPS;
3284             $grouptitle = $str->groupsvisible;
3285             $forcedgrouptitle = $str->forcedgroupsvisible;
3286             $actionname = 'groupsvisible';
3287             $groupimage = 't/groupv';
3288         } else {
3289             $groupmode = VISIBLEGROUPS;
3290             $grouptitle = $str->groupsnone;
3291             $forcedgrouptitle = $str->forcedgroupsnone;
3292             $actionname = 'groupsnone';
3293             $groupimage = 't/groupn';
3294         }
3295         if ($mod->groupmodelink) {
3296             $actions[$actionname] = new action_link(
3297                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3298                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3299                 null,
3300                 array('class' => 'editing_'. $actionname, 'title' => $grouptitle)
3301             );
3302         } else {
3303             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3304         }
3305     }
3307     // Assign
3308     if (has_capability('moodle/role:assign', $modcontext)){
3309         $actions['assign'] = new action_link(
3310             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
3311             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3312             null,
3313             array('class' => 'editing_assign', 'title' => $str->assign)
3314         );
3315     }
3317     return $actions;
3320 /**
3321  * given a course object with shortname & fullname, this function will
3322  * truncate the the number of chars allowed and add ... if it was too long
3323  */
3324 function course_format_name ($course,$max=100) {
3326     $context = context_course::instance($course->id);
3327     $shortname = format_string($course->shortname, true, array('context' => $context));
3328     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3329     $str = $shortname.': '. $fullname;
3330     if (textlib::strlen($str) <= $max) {
3331         return $str;
3332     }
3333     else {
3334         return textlib::substr($str,0,$max-3).'...';
3335     }
3338 /**
3339  * Is the user allowed to add this type of module to this course?
3340  * @param object $course the course settings. Only $course->id is used.
3341  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3342  * @return bool whether the current user is allowed to add this type of module to this course.
3343  */
3344 function course_allowed_module($course, $modname) {
3345     if (is_numeric($modname)) {
3346         throw new coding_exception('Function course_allowed_module no longer
3347                 supports numeric module ids. Please update your code to pass the module name.');
3348     }
3350     $capability = 'mod/' . $modname . ':addinstance';
3351     if (!get_capability_info($capability)) {
3352         // Debug warning that the capability does not exist, but no more than once per page.
3353         static $warned = array();
3354         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3355         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3356             debugging('The module ' . $modname . ' does not define the standard capability ' .
3357                     $capability , DEBUG_DEVELOPER);
3358             $warned[$modname] = 1;
3359         }
3361         // If the capability does not exist, the module can always be added.
3362         return true;
3363     }
3365     $coursecontext = context_course::instance($course->id);
3366     return has_capability($capability, $coursecontext);
3369 /**
3370  * Recursively delete category including all subcategories and courses.
3371  * @param stdClass $category
3372  * @param boolean $showfeedback display some notices
3373  * @return array return deleted courses
3374  */
3375 function category_delete_full($category, $showfeedback=true) {
3376     global $CFG, $DB;
3377     require_once($CFG->libdir.'/gradelib.php');
3378     require_once($CFG->libdir.'/questionlib.php');
3379     require_once($CFG->dirroot.'/cohort/lib.php');
3381     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3382         foreach ($children as $childcat) {
3383             category_delete_full($childcat, $showfeedback);
3384         }
3385     }
3387     $deletedcourses = array();
3388     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3389         foreach ($courses as $course) {
3390             if (!delete_course($course, false)) {
3391                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3392             }
3393             $deletedcourses[] = $course;
3394         }
3395     }
3397     // move or delete cohorts in this context
3398     cohort_delete_category($category);
3400     // now delete anything that may depend on course category context
3401     grade_course_category_delete($category->id, 0, $showfeedback);
3402     if (!question_delete_course_category($category, 0, $showfeedback)) {
3403         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3404     }
3406     // finally delete the category and it's context
3407     $DB->delete_records('course_categories', array('id'=>$category->id));
3408     delete_context(CONTEXT_COURSECAT, $category->id);
3410     events_trigger('course_category_deleted', $category);
3412     return $deletedcourses;
3415 /**
3416  * Delete category, but move contents to another category.
3417  * @param object $ccategory
3418  * @param int $newparentid category id
3419  * @return bool status
3420  */
3421 function category_delete_move($category, $newparentid, $showfeedback=true) {
3422     global $CFG, $DB, $OUTPUT;
3423     require_once($CFG->libdir.'/gradelib.php');
3424     require_once($CFG->libdir.'/questionlib.php');
3425     require_once($CFG->dirroot.'/cohort/lib.php');
3427     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3428         return false;
3429     }
3431     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3432         foreach ($children as $childcat) {
3433             move_category($childcat, $newparentcat);
3434         }
3435     }
3437     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3438         if (!move_courses(array_keys($courses), $newparentid)) {
3439             if ($showfeedback) {
3440                 echo $OUTPUT->notification("Error moving courses");
3441             }
3442             return false;
3443         }
3444         if ($showfeedback) {
3445             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3446         }
3447     }
3449     // move or delete cohorts in this context
3450     cohort_delete_category($category);
3452     // now delete anything that may depend on course category context
3453     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3454     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3455         if ($showfeedback) {
3456             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3457         }
3458         return false;
3459     }
3461     // finally delete the category and it's context
3462     $DB->delete_records('course_categories', array('id'=>$category->id));
3463     delete_context(CONTEXT_COURSECAT, $category->id);
3465     events_trigger('course_category_deleted', $category);
3467     if ($showfeedback) {
3468         echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3469     }
3470     return true;
3473 /**
3474  * Efficiently moves many courses around while maintaining
3475  * sortorder in order.
3476  *
3477  * @param array $courseids is an array of course ids
3478  * @param int $categoryid
3479  * @return bool success
3480  */
3481 function move_courses($courseids, $categoryid) {
3482     global $CFG, $DB, $OUTPUT;
3484     if (empty($courseids)) {
3485         // nothing to do
3486         return;
3487     }
3489     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3490         return false;
3491     }
3493     $courseids = array_reverse($courseids);
3494     $newparent = context_coursecat::instance($category->id);
3495     $i = 1;
3497     foreach ($courseids as $courseid) {
3498         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3499             $course = new stdClass();
3500             $course->id = $courseid;
3501             $course->category  = $category->id;
3502             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3503             if ($category->visible == 0) {
3504                 // hide the course when moving into hidden category,
3505                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3506                 $course->visible = 0;
3507             }
3509             $DB->update_record('course', $course);
3511             $context   = context_course::instance($course->id);
3512             context_moved($context, $newparent);
3513         }
3514     }
3515     fix_course_sortorder();
3517     return true;
3520 /**
3521  * Hide course category and child course and subcategories
3522  * @param stdClass $category
3523  * @return void
3524  */
3525 function course_category_hide($category) {
3526     global $DB;
3528     $category->visible = 0;
3529     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3530     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3531     $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
3532     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3533     // get all child categories and hide too
3534     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3535         foreach ($subcats as $cat) {
3536             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3537             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3538             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3539             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3540         }
3541     }
3544 /**
3545  * Show course category and child course and subcategories
3546  * @param stdClass $category
3547  * @return void
3548  */
3549 function course_category_show($category) {
3550     global $DB;
3552     $category->visible = 1;
3553     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3554     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3555     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3556     // get all child categories and unhide too
3557     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3558         foreach ($subcats as $cat) {
3559             if ($cat->visibleold) {
3560                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3561             }
3562             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3563         }
3564     }
3567 /**
3568  * Efficiently moves a category - NOTE that this can have
3569  * a huge impact access-control-wise...
3570  */
3571 function move_category($category, $newparentcat) {
3572     global $CFG, $DB;
3574     $context = context_coursecat::instance($category->id);
3576     $hidecat = false;
3577     if (empty($newparentcat->id)) {
3578         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3580         $newparent = context_system::instance();
3582     } else {
3583         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3584         $newparent = context_coursecat::instance($newparentcat->id);
3586         if (!$newparentcat->visible and $category->visible) {
3587             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3588             $hidecat = true;
3589         }
3590     }
3592     context_moved($context, $newparent);
3594     // now make it last in new category
3595     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3597     // and fix the sortorders
3598     fix_course_sortorder();
3600     if ($hidecat) {
3601         course_category_hide($category);
3602     }
3605 /**
3606  * Returns the display name of the given section that the course prefers
3607  *
3608  * Implementation of this function is provided by course format
3609  * @see format_base::get_section_name()
3610  *
3611  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
3612  * @param int|stdClass $section Section object from database or just field course_sections.section
3613  * @return string Display name that the course format prefers, e.g. "Week 2"
3614  */
3615 function get_section_name($courseorid, $section) {
3616     return course_get_format($courseorid)->get_section_name($section);
3619 /**
3620  * Tells if current course format uses sections
3621  *
3622  * @param string $format Course format ID e.g. 'weeks' $course->format
3623  * @return bool
3624  */
3625 function course_format_uses_sections($format) {
3626     $course = new stdClass();
3627     $course->format = $format;
3628     return course_get_format($course)->uses_sections();
3631 /**
3632  * Returns the information about the ajax support in the given source format
3633  *
3634  * The returned object's property (boolean)capable indicates that
3635  * the course format supports Moodle course ajax features.
3636  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3637  *
3638  * @param string $format
3639  * @return stdClass
3640  */
3641 function course_format_ajax_support($format) {
3642     $course = new stdClass();
3643     $course->format = $format;
3644     return course_get_format($course)->supports_ajax();
3647 /**
3648  * Can the current user delete this course?
3649  * Course creators have exception,
3650  * 1 day after the creation they can sill delete the course.
3651  * @param int $courseid
3652  * @return boolean
3653  */
3654 function can_delete_course($courseid) {
3655     global $USER, $DB;
3657     $context = context_course::instance($courseid);
3659     if (has_capability('moodle/course:delete', $context)) {
3660         return true;
3661     }
3663     // hack: now try to find out if creator created this course recently (1 day)
3664     if (!has_capability('moodle/course:create', $context)) {
3665         return false;
3666     }
3668     $since = time() - 60*60*24;
3670     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3671     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3673     return $DB->record_exists_select('log', $select, $params);
3676 /**
3677  * Save the Your name for 'Some role' strings.
3678  *
3679  * @param integer $courseid the id of this course.
3680  * @param array $data the data that came from the course settings form.
3681  */
3682 function save_local_role_names($courseid, $data) {
3683     global $DB;
3684     $context = context_course::instance($courseid);
3686     foreach ($data as $fieldname => $value) {
3687         if (strpos($fieldname, 'role_') !== 0) {
3688             continue;
3689         }
3690         list($ignored, $roleid) = explode('_', $fieldname);
3692         // make up our mind whether we want to delete, update or insert
3693         if (!$value) {
3694             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3696         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3697             $rolename->name = $value;
3698             $DB->update_record('role_names', $rolename);
3700         } else {
3701             $rolename = new stdClass;
3702             $rolename->contextid = $context->id;
3703             $rolename->roleid = $roleid;
3704             $rolename->name = $value;
3705             $DB->insert_record('role_names', $rolename);
3706         }
3707     }
3710 /**
3711  * Create a course and either return a $course object
3712  *
3713  * Please note this functions does not verify any access control,
3714  * the calling code is responsible for all validation (usually it is the form definition).
3715  *
3716  * @param array $editoroptions course description editor options
3717  * @param object $data  - all the data needed for an entry in the 'course' table
3718  * @return object new course instance
3719  */
3720 function create_course($data, $editoroptions = NULL) {
3721     global $CFG, $DB;
3723     //check the categoryid - must be given for all new courses
3724     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3726     //check if the shortname already exist
3727     if (!empty($data->shortname)) {
3728         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3729             throw new moodle_exception('shortnametaken');
3730         }
3731     }
3733     //check if the id number already exist
3734     if (!empty($data->idnumber)) {
3735         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3736             throw new moodle_exception('idnumbertaken');
3737         }
3738     }
3740     $data->timecreated  = time();
3741     $data->timemodified = $data->timecreated;
3743     // place at beginning of any category
3744     $data->sortorder = 0;
3746     if ($editoroptions) {
3747         // summary text is updated later, we need context to store the files first
3748         $data->summary = '';
3749         $data->summary_format = FORMAT_HTML;
3750     }
3752     if (!isset($data->visible)) {
3753         // data not from form, add missing visibility info
3754         $data->visible = $category->visible;
3755     }
3756     $data->visibleold = $data->visible;
3758     $newcourseid = $DB->insert_record('course', $data);
3759     $context = context_course::instance($newcourseid, MUST_EXIST);
3761     if ($editoroptions) {
3762         // Save the files used in the summary editor and store
3763         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3764         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3765         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3766     }
3768     // update course format options
3769     course_get_format($newcourseid)->update_course_format_options($data);
3771     $course = course_get_format($newcourseid)->get_course();
3773     // Setup the blocks
3774     blocks_add_default_course_blocks($course);
3776     // Create a default section.
3777     course_create_sections_if_missing($course, 0);
3779     fix_course_sortorder();
3781     // new context created - better mark it as dirty
3782     mark_context_dirty($context->path);
3784     // Save any custom role names.
3785     save_local_role_names($course->id, (array)$data);
3787     // set up enrolments
3788     enrol_course_updated(true, $course, $data);
3790     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3792     // Trigger events
3793     events_trigger('course_created', $course);
3795     return $course;
3798 /**
3799  * Create a new course category and marks the context as dirty
3800  *
3801  * This function does not set the sortorder for the new category and
3802  * @see{fix_course_sortorder} should be called after creating a new course
3803  * category
3804  *
3805  * Please note that this function does not verify access control.
3806  *
3807  * @param object $category All of the data required for an entry in the course_categories table
3808  * @return object new course category
3809  */
3810 function create_course_category($category) {
3811     global $DB;
3813     $category->timemodified = time();
3814     $category->id = $DB->insert_record('course_categories', $category);
3815     $category = $DB->get_record('course_categories', array('id' => $category->id));
3817     // We should mark the context as dirty
3818     $category->context = context_coursecat::instance($category->id);
3819     $category->context->mark_dirty();
3821     return $category;
3824 /**
3825  * Update a course.
3826  *
3827  * Please note this functions does not verify any access control,
3828  * the calling code is responsible for all validation (usually it is the form definition).
3829  *
3830  * @param object $data  - all the data needed for an entry in the 'course' table
3831  * @param array $editoroptions course description editor options
3832  * @return void
3833  */
3834 function update_course($data, $editoroptions = NULL) {
3835     global $CFG, $DB;
3837     $data->timemodified = time();
3839     $oldcourse = course_get_format($data->id)->get_course();
3840     $context   = context_course::instance($oldcourse->id);
3842     if ($editoroptions) {
3843         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3844     }
3846     if (!isset($data->category) or empty($data->category)) {
3847         // prevent nulls and 0 in category field
3848         unset($data->category);
3849     }
3850     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3852     if (!isset($data->visible)) {
3853         // data not from form, add missing visibility info
3854         $data->visible = $oldcourse->visible;
3855     }
3857     if ($data->visible != $oldcourse->visible) {
3858         // reset the visibleold flag when manually hiding/unhiding course
3859         $data->visibleold = $data->visible;
3860     } else {
3861         if ($movecat) {
3862             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3863             if (empty($newcategory->visible)) {
3864                 // make sure when moving into hidden category the course is hidden automatically
3865                 $data->visible = 0;
3866             }
3867         }
3868     }
3870     // Update with the new data
3871     $DB->update_record('course', $data);
3872     // make sure the modinfo cache is reset
3873     rebuild_course_cache($data->id);
3875     // update course format options with full course data
3876     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
3878     $course = $DB->get_record('course', array('id'=>$data->id));
3880     if ($movecat) {
3881         $newparent = context_coursecat::instance($course->category);
3882         context_moved($context, $newparent);
3883     }
3885     fix_course_sortorder();
3887     // Test for and remove blocks which aren't appropriate anymore
3888     blocks_remove_inappropriate($course);
3890     // Save any custom role names.
3891     save_local_role_names($course->id, $data);
3893     // update enrol settings
3894     enrol_course_updated(false, $course, $data);
3896     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3898     // Trigger events
3899     events_trigger('course_updated', $course);
3901     if ($oldcourse->format !== $course->format) {
3902         // Remove all options stored for the previous format
3903         // We assume that new course format migrated everything it needed watching trigger
3904         // 'course_updated' and in method format_XXX::update_course_format_options()
3905         $DB->delete_records('course_format_options',
3906                 array('courseid' => $course->id, 'format' => $oldcourse->format));
3907     }
3910 /**
3911  * Average number of participants
3912  * @return integer
3913  */
3914 function average_number_of_participants() {
3915     global $DB, $SITE;
3917     //count total of enrolments for visible course (except front page)
3918     $sql = 'SELECT COUNT(*) FROM (
3919         SELECT DISTINCT ue.userid, e.courseid
3920         FROM {user_enrolments} ue, {enrol} e, {course} c
3921         WHERE ue.enrolid = e.id
3922             AND e.courseid <> :siteid
3923             AND c.id = e.courseid
3924             AND c.visible = 1) total';
3925     $params = array('siteid' => $SITE->id);
3926     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3929     //count total of visible courses (minus front page)
3930     $coursetotal = $DB->count_records('course', array('visible' => 1));
3931     $coursetotal = $coursetotal - 1 ;
3933     //average of enrolment
3934     if (empty($coursetotal)) {
3935         $participantaverage = 0;
3936     } else {
3937         $participantaverage = $enrolmenttotal / $coursetotal;
3938     }
3940     return $participantaverage;
3943 /**
3944  * Average number of course modules
3945  * @return integer
3946  */
3947 function average_number_of_courses_modules() {
3948     global $DB, $SITE;
3950     //count total of visible course module (except front page)
3951     $sql = 'SELECT COUNT(*) FROM (
3952         SELECT cm.course, cm.module
3953         FROM {course} c, {course_modules} cm
3954         WHERE c.id = cm.course
3955             AND c.id <> :siteid
3956             AND cm.visible = 1
3957             AND c.visible = 1) total';
3958     $params = array('siteid' => $SITE->id);
3959     $moduletotal = $DB->count_records_sql($sql, $params);
3962     //count total of visible courses (minus front page)
3963     $coursetotal = $DB->count_records('course', array('visible' => 1));
3964     $coursetotal = $coursetotal - 1 ;
3966     //average of course module
3967     if (empty($coursetotal)) {
3968         $coursemoduleaverage = 0;
3969     } else {
3970         $coursemoduleaverage = $moduletotal / $coursetotal;
3971     }
3973     return $coursemoduleaverage;
3976 /**
3977  * This class pertains to course requests and contains methods associated with
3978  * create, approving, and removing course requests.
3979  *
3980  * Please note we do not allow embedded images here because there is no context
3981  * to store them with proper access control.
3982  *
3983  * @copyright 2009 Sam Hemelryk
3984  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3985  * @since Moodle 2.0
3986  *
3987  * @property-read int $id
3988  * @property-read string $fullname
3989  * @property-read string $shortname
3990  * @property-read string $summary
3991  * @property-read int $summaryformat
3992  * @property-read int $summarytrust
3993  * @property-read string $reason
3994  * @property-read int $requester
3995  */
3996 class course_request {
3998     /**
3999      * This is the stdClass that stores the properties for the course request
4000      * and is externally accessed through the __get magic method
4001      * @var stdClass
4002      */
4003     protected $properties;
4005     /**
4006      * An array of options for the summary editor used by course request forms.
4007      * This is initially set by {@link summary_editor_options()}
4008      * @var array
4009      * @static
4010      */
4011     protected static $summaryeditoroptions;
4013     /**
4014      * Static function to prepare the summary editor for working with a course
4015      * request.
4016      *
4017      * @static
4018      * @param null|stdClass $data Optional, an object containing the default values
4019      *                       for the form, these may be modified when preparing the
4020      *                       editor so this should be called before creating the form
4021      * @return stdClass An object that can be used to set the default values for
4022      *                   an mforms form
4023      */
4024     public static function prepare($data=null) {
4025         if ($data === null) {
4026             $data = new stdClass;
4027         }
4028         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
4029         return $data;
4030     }
4032     /**
4033      * Static function to create a new course request when passed an array of properties
4034      * for it.
4035      *
4036      * This function also handles saving any files that may have been used in the editor
4037      *
4038      * @static
4039      * @param stdClass $data
4040      * @return course_request The newly created course request
4041      */
4042     public static function create($data) {
4043         global $USER, $DB, $CFG;
4044         $data->requester = $USER->id;
4046         // Setting the default category if none set.
4047         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
4048             $data->category = $CFG->defaultrequestcategory;
4049         }
4051         // Summary is a required field so copy the text over
4052         $data->summary       = $data->summary_editor['text'];
4053         $data->summaryformat = $data->summary_editor['format'];
4055         $data->id = $DB->insert_record('course_request', $data);
4057         // Create a new course_request object and return it
4058         $request = new course_request($data);
4060         // Notify the admin if required.
4061         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
4063             $a = new stdClass;
4064             $a->link = "$CFG->wwwroot/course/pending.php";
4065             $a->user = fullname($USER);
4066             $subject = get_string('courserequest');
4067             $message = get_string('courserequestnotifyemail', 'admin', $a);
4068             foreach ($users as $user) {
4069                 $request->notify($user, $USER, 'courserequested', $subject, $message);
4070             }
4071         }
4073         return $request;
4074     }
4076     /**
4077      * Returns an array of options to use with a summary editor
4078      *
4079      * @uses course_request::$summaryeditoroptions
4080      * @return array An array of options to use with the editor
4081      */
4082     public static function summary_editor_options() {
4083         global $CFG;
4084         if (self::$summaryeditoroptions === null) {
4085             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
4086         }
4087         return self::$summaryeditoroptions;
4088     }
4090     /**
4091      * Loads the properties for this course request object. Id is required and if
4092      * only id is provided then we load the rest of the properties from the database
4093      *
4094      * @param stdClass|int $properties Either an object containing properties
4095      *                      or the course_request id to load
4096      */
4097     public function __construct($properties) {
4098         global $DB;
4099         if (empty($properties->id)) {
4100             if (empty($properties)) {
4101                 throw new coding_exception('You must provide a course request id when creating a course_request object');
4102             }
4103             $id = $properties;
4104             $properties = new stdClass;
4105             $properties->id = (int)$id;
4106             unset($id);
4107         }
4108         if (empty($properties->requester)) {
4109             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
4110                 print_error('unknowncourserequest');
4111             }
4112         } else {
4113             $this->properties = $properties;
4114         }
4115         $this->properties->collision = null;
4116     }
4118     /**
4119      * Returns the requested property
4120      *
4121      * @param string $key
4122      * @return mixed
4123      */
4124     public function __get($key) {
4125         return $this->properties->$key;
4126     }
4128     /**
4129      * Override this to ensure empty($request->blah) calls return a reliable answer...
4130      *
4131      * This is required because we define the __get method
4132      *
4133      * @param mixed $key
4134      * @return bool True is it not empty, false otherwise
4135      */
4136     public function __isset($key) {
4137         return (!empty($this->properties->$key));
4138     }
4140     /**
4141      * Returns the user who requested this course
4142      *
4143      * Uses a static var to cache the results and cut down the number of db queries
4144      *
4145      * @staticvar array $requesters An array of cached users
4146      * @return stdClass The user who requested the course
4147