18b08928909fcf3492c19a74e0d6bfd0872c7c19
[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 $CFG, $OUTPUT;
1684     if ($modnames === null) {
1685         $modnames = get_module_types_names();
1686     }
1688     // check to see if user can add menus and there are modules to add
1689     if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
1690             || empty($modnames)) {
1691         if ($return) {
1692             return '';
1693         } else {
1694             return false;
1695         }
1696     }
1698     // Retrieve all modules with associated metadata
1699     $modules = get_module_metadata($course, $modnames, $sectionreturn);
1701     // We'll sort resources and activities into two lists
1702     $resources = array();
1703     $activities = array();
1705     // We need to add the section section to the link for each module
1706     $sectionlink = '&section=' . $section . '&sr=' . $sectionreturn;
1708     foreach ($modules as $module) {
1709         if (isset($module->types)) {
1710             // This module has a subtype
1711             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1712             $subtypes = array();
1713             foreach ($module->types as $subtype) {
1714                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1715             }
1717             // Sort module subtypes into the list
1718             if (!empty($module->title)) {
1719                 // This grouping has a name
1720                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1721                     $resources[] = array($module->title=>$subtypes);
1722                 } else {
1723                     $activities[] = array($module->title=>$subtypes);
1724                 }
1725             } else {
1726                 // This grouping does not have a name
1727                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1728                     $resources = array_merge($resources, $subtypes);
1729                 } else {
1730                     $activities = array_merge($activities, $subtypes);
1731                 }
1732             }
1733         } else {
1734             // This module has no subtypes
1735             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1736                 $resources[$module->link . $sectionlink] = $module->title;
1737             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1738                 // System modules cannot be added by user, do not add to dropdown
1739             } else {
1740                 $activities[$module->link . $sectionlink] = $module->title;
1741             }
1742         }
1743     }
1745     $straddactivity = get_string('addactivity');
1746     $straddresource = get_string('addresource');
1747     $sectionname = get_section_name($course, $section);
1748     $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
1749     $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
1751     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1753     if (!$vertical) {
1754         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1755     }
1757     if (!empty($resources)) {
1758         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1759         $select->set_help_icon('resources');
1760         $select->set_label($strresourcelabel, array('class' => 'accesshide'));
1761         $output .= $OUTPUT->render($select);
1762     }
1764     if (!empty($activities)) {
1765         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1766         $select->set_help_icon('activities');
1767         $select->set_label($stractivitylabel, array('class' => 'accesshide'));
1768         $output .= $OUTPUT->render($select);
1769     }
1771     if (!$vertical) {
1772         $output .= html_writer::end_tag('div');
1773     }
1775     $output .= html_writer::end_tag('div');
1777     if (course_ajax_enabled($course)) {
1778         $straddeither = get_string('addresourceoractivity');
1779         // The module chooser link
1780         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1781         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1782         $icon = $OUTPUT->pix_icon('t/add', '');
1783         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1784         $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1785         $modchooser.= html_writer::end_tag('div');
1786         $modchooser.= html_writer::end_tag('div');
1788         // Wrap the normal output in a noscript div
1789         $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1790         if ($usemodchooser) {
1791             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1792             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1793         } else {
1794             // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1795             $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1796             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
1797         }
1798         $output = $modchooser . $output;
1799     }
1801     if ($return) {
1802         return $output;
1803     } else {
1804         echo $output;
1805     }
1808 /**
1809  * Retrieve all metadata for the requested modules
1810  *
1811  * @param object $course The Course
1812  * @param array $modnames An array containing the list of modules and their
1813  * names
1814  * @param int $sectionreturn The section to return to
1815  * @return array A list of stdClass objects containing metadata about each
1816  * module
1817  */
1818 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1819     global $CFG, $OUTPUT;
1821     // get_module_metadata will be called once per section on the page and courses may show
1822     // different modules to one another
1823     static $modlist = array();
1824     if (!isset($modlist[$course->id])) {
1825         $modlist[$course->id] = array();
1826     }
1828     $return = array();
1829     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&sr='.$sectionreturn.'&add=';
1830     foreach($modnames as $modname => $modnamestr) {
1831         if (!course_allowed_module($course, $modname)) {
1832             continue;
1833         }
1834         if (isset($modlist[$course->id][$modname])) {
1835             // This module is already cached
1836             $return[$modname] = $modlist[$course->id][$modname];
1837             continue;
1838         }
1840         // Include the module lib
1841         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1842         if (!file_exists($libfile)) {
1843             continue;
1844         }
1845         include_once($libfile);
1847         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1848         $gettypesfunc =  $modname.'_get_types';
1849         if (function_exists($gettypesfunc)) {
1850             if ($types = $gettypesfunc()) {
1851                 $group = new stdClass();
1852                 $group->name = $modname;
1853                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1854                 foreach($types as $type) {
1855                     if ($type->typestr === '--') {
1856                         continue;
1857                     }
1858                     if (strpos($type->typestr, '--') === 0) {
1859                         $group->title = str_replace('--', '', $type->typestr);
1860                         continue;
1861                     }
1862                     // Set the Sub Type metadata
1863                     $subtype = new stdClass();
1864                     $subtype->title = $type->typestr;
1865                     $subtype->type = str_replace('&amp;', '&', $type->type);
1866                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1867                     $subtype->archetype = $type->modclass;
1869                     // The group archetype should match the subtype archetypes and all subtypes
1870                     // should have the same archetype
1871                     $group->archetype = $subtype->archetype;
1873                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1874                         $subtype->help = get_string('help' . $subtype->name, $modname);
1875                     }
1876                     $subtype->link = $urlbase . $subtype->type;
1877                     $group->types[] = $subtype;
1878                 }
1879                 $modlist[$course->id][$modname] = $group;
1880             }
1881         } else {
1882             $module = new stdClass();
1883             $module->title = get_string('modulename', $modname);
1884             $module->name = $modname;
1885             $module->link = $urlbase . $modname;
1886             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1887             $sm = get_string_manager();
1888             if ($sm->string_exists('modulename_help', $modname)) {
1889                 $module->help = get_string('modulename_help', $modname);
1890                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1891                     $link = get_string('modulename_link', $modname);
1892                     $linktext = get_string('morehelp');
1893                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1894                 }
1895             }
1896             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1897             $modlist[$course->id][$modname] = $module;
1898         }
1899         $return[$modname] = $modlist[$course->id][$modname];
1900     }
1902     return $return;
1905 /**
1906  * Return the course category context for the category with id $categoryid, except
1907  * that if $categoryid is 0, return the system context.
1908  *
1909  * @param integer $categoryid a category id or 0.
1910  * @return object the corresponding context
1911  */
1912 function get_category_or_system_context($categoryid) {
1913     if ($categoryid) {
1914         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1915     } else {
1916         return context_system::instance();
1917     }
1920 /**
1921  * Gets the child categories of a given courses category. Uses a static cache
1922  * to make repeat calls efficient.
1923  *
1924  * @param int $parentid the id of a course category.
1925  * @return array all the child course categories.
1926  */
1927 function get_child_categories($parentid) {
1928     static $allcategories = null;
1930     // only fill in this variable the first time
1931     if (null == $allcategories) {
1932         $allcategories = array();
1934         $categories = get_categories();
1935         foreach ($categories as $category) {
1936             if (empty($allcategories[$category->parent])) {
1937                 $allcategories[$category->parent] = array();
1938             }
1939             $allcategories[$category->parent][] = $category;
1940         }
1941     }
1943     if (empty($allcategories[$parentid])) {
1944         return array();
1945     } else {
1946         return $allcategories[$parentid];
1947     }
1950 /**
1951  * This function recursively travels the categories, building up a nice list
1952  * for display. It also makes an array that list all the parents for each
1953  * category.
1954  *
1955  * For example, if you have a tree of categories like:
1956  *   Miscellaneous (id = 1)
1957  *      Subcategory (id = 2)
1958  *         Sub-subcategory (id = 4)
1959  *   Other category (id = 3)
1960  * Then after calling this function you will have
1961  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1962  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1963  *      3 => 'Other category');
1964  * $parents = array(2 => array(1), 4 => array(1, 2));
1965  *
1966  * If you specify $requiredcapability, then only categories where the current
1967  * user has that capability will be added to $list, although all categories
1968  * will still be added to $parents, and if you only have $requiredcapability
1969  * in a child category, not the parent, then the child catgegory will still be
1970  * included.
1971  *
1972  * If you specify the option $excluded, then that category, and all its children,
1973  * are omitted from the tree. This is useful when you are doing something like
1974  * moving categories, where you do not want to allow people to move a category
1975  * to be the child of itself.
1976  *
1977  * @param array $list For output, accumulates an array categoryid => full category path name
1978  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1979  * @param string/array $requiredcapability if given, only categories where the current
1980  *      user has this capability will be added to $list. Can also be an array of capabilities,
1981  *      in which case they are all required.
1982  * @param integer $excludeid Omit this category and its children from the lists built.
1983  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1984  * @param string $path For internal use, as part of recursive calls.
1985  */
1986 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1987         $excludeid = 0, $category = NULL, $path = "") {
1989     // initialize the arrays if needed
1990     if (!is_array($list)) {
1991         $list = array();
1992     }
1993     if (!is_array($parents)) {
1994         $parents = array();
1995     }
1997     if (empty($category)) {
1998         // Start at the top level.
1999         $category = new stdClass;
2000         $category->id = 0;
2001     } else {
2002         // This is the excluded category, don't include it.
2003         if ($excludeid > 0 && $excludeid == $category->id) {
2004             return;
2005         }
2007         $context = context_coursecat::instance($category->id);
2008         $categoryname = format_string($category->name, true, array('context' => $context));
2010         // Update $path.
2011         if ($path) {
2012             $path = $path.' / '.$categoryname;
2013         } else {
2014             $path = $categoryname;
2015         }
2017         // Add this category to $list, if the permissions check out.
2018         if (empty($requiredcapability)) {
2019             $list[$category->id] = $path;
2021         } else {
2022             $requiredcapability = (array)$requiredcapability;
2023             if (has_all_capabilities($requiredcapability, $context)) {
2024                 $list[$category->id] = $path;
2025             }
2026         }
2027     }
2029     // Add all the children recursively, while updating the parents array.
2030     if ($categories = get_child_categories($category->id)) {
2031         foreach ($categories as $cat) {
2032             if (!empty($category->id)) {
2033                 if (isset($parents[$category->id])) {
2034                     $parents[$cat->id]   = $parents[$category->id];
2035                 }
2036                 $parents[$cat->id][] = $category->id;
2037             }
2038             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2039         }
2040     }
2043 /**
2044  * This function generates a structured array of courses and categories.
2045  *
2046  * The depth of categories is limited by $CFG->maxcategorydepth however there
2047  * is no limit on the number of courses!
2048  *
2049  * Suitable for use with the course renderers course_category_tree method:
2050  * $renderer = $PAGE->get_renderer('core','course');
2051  * echo $renderer->course_category_tree(get_course_category_tree());
2052  *
2053  * @global moodle_database $DB
2054  * @param int $id
2055  * @param int $depth
2056  */
2057 function get_course_category_tree($id = 0, $depth = 0) {
2058     global $DB, $CFG;
2059     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
2060     $categories = get_child_categories($id);
2061     $categoryids = array();
2062     foreach ($categories as $key => &$category) {
2063         if (!$category->visible && !$viewhiddencats) {
2064             unset($categories[$key]);
2065             continue;
2066         }
2067         $categoryids[$category->id] = $category;
2068         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2069             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2070             foreach ($subcategories as $subid=>$subcat) {
2071                 $categoryids[$subid] = $subcat;
2072             }
2073             $category->courses = array();
2074         }
2075     }
2077     if ($depth > 0) {
2078         // This is a recursive call so return the required array
2079         return array($categories, $categoryids);
2080     }
2082     if (empty($categoryids)) {
2083         // No categories available (probably all hidden).
2084         return array();
2085     }
2087     // The depth is 0 this function has just been called so we can finish it off
2089     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2090     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2091     $sql = "SELECT
2092             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2093             $ccselect
2094             FROM {course} c
2095             $ccjoin
2096             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2097     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2098         // loop throught them
2099         foreach ($courses as $course) {
2100             if ($course->id == SITEID) {
2101                 continue;
2102             }
2103             context_instance_preload($course);
2104             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2105                 $categoryids[$course->category]->courses[$course->id] = $course;
2106             }
2107         }
2108     }
2109     return $categories;
2112 /**
2113  * Recursive function to print out all the categories in a nice format
2114  * with or without courses included
2115  */
2116 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2117     global $CFG;
2119     // maxcategorydepth == 0 meant no limit
2120     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2121         return;
2122     }
2124     if (!$displaylist) {
2125         make_categories_list($displaylist, $parentslist);
2126     }
2128     if ($category) {
2129         if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
2130             print_category_info($category, $depth, $showcourses);
2131         } else {
2132             return;  // Don't bother printing children of invisible categories
2133         }
2135     } else {
2136         $category = new stdClass();
2137         $category->id = "0";
2138     }
2140     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2141         $countcats = count($categories);
2142         $count = 0;
2143         $first = true;
2144         $last = false;
2145         foreach ($categories as $cat) {
2146             $count++;
2147             if ($count == $countcats) {
2148                 $last = true;
2149             }
2150             $up = $first ? false : true;
2151             $down = $last ? false : true;
2152             $first = false;
2154             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2155         }
2156     }
2159 /**
2160  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2161  */
2162 function make_categories_options() {
2163     make_categories_list($cats,$parents);
2164     foreach ($cats as $key => $value) {
2165         if (array_key_exists($key,$parents)) {
2166             if ($indent = count($parents[$key])) {
2167                 for ($i = 0; $i < $indent; $i++) {
2168                     $cats[$key] = '&nbsp;'.$cats[$key];
2169                 }
2170             }
2171         }
2172     }
2173     return $cats;
2176 /**
2177  * Prints the category info in indented fashion
2178  * This function is only used by print_whole_category_list() above
2179  */
2180 function print_category_info($category, $depth=0, $showcourses = false) {
2181     global $CFG, $DB, $OUTPUT;
2183     $strsummary = get_string('summary');
2185     $catlinkcss = null;
2186     if (!$category->visible) {
2187         $catlinkcss = array('class'=>'dimmed');
2188     }
2189     static $coursecount = null;
2190     if (null === $coursecount) {
2191         // only need to check this once
2192         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2193     }
2195     if ($showcourses and $coursecount) {
2196         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2197     } else {
2198         $catimage = "&nbsp;";
2199     }
2201     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2202     $context = context_coursecat::instance($category->id);
2203     $fullname = format_string($category->name, true, array('context' => $context));
2205     if ($showcourses and $coursecount) {
2206         echo '<div class="categorylist clearfix">';
2207         $cat = '';
2208         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2209         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2210         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2212         $html = '';
2213         if ($depth > 0) {
2214             for ($i=0; $i< $depth; $i++) {
2215                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2216                 $cat = '';
2217             }
2218         } else {
2219             $html = $cat;
2220         }
2221         echo html_writer::tag('div', $html, array('class'=>'category'));
2222         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2224         // does the depth exceed maxcategorydepth
2225         // maxcategorydepth == 0 or unset meant no limit
2226         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2227         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2228             foreach ($courses as $course) {
2229                 $linkcss = null;
2230                 if (!$course->visible) {
2231                     $linkcss = array('class'=>'dimmed');
2232                 }
2234                 $coursename = get_course_display_name_for_list($course);
2235                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2237                 // print enrol info
2238                 $courseicon = '';
2239                 if ($icons = enrol_get_course_info_icons($course)) {
2240                     foreach ($icons as $pix_icon) {
2241                         $courseicon = $OUTPUT->render($pix_icon);
2242                     }
2243                 }
2245                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2247                 if ($course->summary) {
2248                     $link = new moodle_url('/course/info.php?id='.$course->id);
2249                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2250                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2251                         array('title'=>$strsummary));
2253                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2254                 }
2256                 $html = '';
2257                 for ($i=0; $i <= $depth; $i++) {
2258                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2259                     $coursecontent = '';
2260                 }
2261                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2262             }
2263         }
2264         echo '</div>';
2265     } else {
2266         echo '<div class="categorylist">';
2267         $html = '';
2268         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2269         if (count($courses) > 0) {
2270             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2271         }
2273         if ($depth > 0) {
2274             for ($i=0; $i< $depth; $i++) {
2275                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2276                 $cat = '';
2277             }
2278         } else {
2279             $html = $cat;
2280         }
2282         echo html_writer::tag('div', $html, array('class'=>'category'));
2283         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2284         echo '</div>';
2285     }
2288 /**
2289  * Print the buttons relating to course requests.
2290  *
2291  * @param object $systemcontext the system context.
2292  */
2293 function print_course_request_buttons($systemcontext) {
2294     global $CFG, $DB, $OUTPUT;
2295     if (empty($CFG->enablecourserequests)) {
2296         return;
2297     }
2298     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2299     /// Print a button to request a new course
2300         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2301     }
2302     /// Print a button to manage pending requests
2303     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2304         $disabled = !$DB->record_exists('course_request', array());
2305         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2306     }
2309 /**
2310  * Does the user have permission to edit things in this category?
2311  *
2312  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2313  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2314  */
2315 function can_edit_in_category($categoryid = 0) {
2316     $context = get_category_or_system_context($categoryid);
2317     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2320 /**
2321  * Prints the turn editing on/off button on course/index.php or course/category.php.
2322  *
2323  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2324  * @return string HTML of the editing button, or empty string, if this user is not allowed
2325  *      to see it.
2326  */
2327 function update_category_button($categoryid = 0) {
2328     global $CFG, $PAGE, $OUTPUT;
2330     // Check permissions.
2331     if (!can_edit_in_category($categoryid)) {
2332         return '';
2333     }
2335     // Work out the appropriate action.
2336     if ($PAGE->user_is_editing()) {
2337         $label = get_string('turneditingoff');
2338         $edit = 'off';
2339     } else {
2340         $label = get_string('turneditingon');
2341         $edit = 'on';
2342     }
2344     // Generate the button HTML.
2345     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2346     if ($categoryid) {
2347         $options['id'] = $categoryid;
2348         $page = 'category.php';
2349     } else {
2350         $page = 'index.php';
2351     }
2352     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2355 /**
2356  * Category is 0 (for all courses) or an object
2357  */
2358 function print_courses($category) {
2359     global $CFG, $OUTPUT;
2361     if (!is_object($category) && $category==0) {
2362         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2363         if (is_array($categories) && count($categories) == 1) {
2364             $category   = array_shift($categories);
2365             $courses    = get_courses_wmanagers($category->id,
2366                                                 'c.sortorder ASC',
2367                                                 array('summary','summaryformat'));
2368         } else {
2369             $courses    = get_courses_wmanagers('all',
2370                                                 'c.sortorder ASC',
2371                                                 array('summary','summaryformat'));
2372         }
2373         unset($categories);
2374     } else {
2375         $courses    = get_courses_wmanagers($category->id,
2376                                             'c.sortorder ASC',
2377                                             array('summary','summaryformat'));
2378     }
2380     if ($courses) {
2381         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2382         foreach ($courses as $course) {
2383             $coursecontext = context_course::instance($course->id);
2384             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2385                 echo html_writer::start_tag('li');
2386                 print_course($course);
2387                 echo html_writer::end_tag('li');
2388             }
2389         }
2390         echo html_writer::end_tag('ul');
2391     } else {
2392         echo $OUTPUT->heading(get_string("nocoursesyet"));
2393         $context = context_system::instance();
2394         if (has_capability('moodle/course:create', $context)) {
2395             $options = array();
2396             if (!empty($category->id)) {
2397                 $options['category'] = $category->id;
2398             } else {
2399                 $options['category'] = $CFG->defaultrequestcategory;
2400             }
2401             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2402             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2403             echo html_writer::end_tag('div');
2404         }
2405     }
2408 /**
2409  * Print a description of a course, suitable for browsing in a list.
2410  *
2411  * @param object $course the course object.
2412  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2413  */
2414 function print_course($course, $highlightterms = '') {
2415     global $CFG, $USER, $DB, $OUTPUT;
2417     $context = context_course::instance($course->id);
2419     // Rewrite file URLs so that they are correct
2420     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2422     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2423     echo html_writer::start_tag('div', array('class'=>'info'));
2424     echo html_writer::start_tag('h3', array('class'=>'name'));
2426     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2428     $coursename = get_course_display_name_for_list($course);
2429     $linktext = highlight($highlightterms, format_string($coursename));
2430     $linkparams = array('title'=>get_string('entercourse'));
2431     if (empty($course->visible)) {
2432         $linkparams['class'] = 'dimmed';
2433     }
2434     echo html_writer::link($linkhref, $linktext, $linkparams);
2435     echo html_writer::end_tag('h3');
2437     /// first find all roles that are supposed to be displayed
2438     if (!empty($CFG->coursecontact)) {
2439         $managerroles = explode(',', $CFG->coursecontact);
2440         $rusers = array();
2442         if (!isset($course->managers)) {
2443             list($sort, $sortparams) = users_order_by_sql('u');
2444             $rusers = get_role_users($managerroles, $context, true,
2445                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
2446                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
2447                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
2448         } else {
2449             //  use the managers array if we have it for perf reasosn
2450             //  populate the datastructure like output of get_role_users();
2451             foreach ($course->managers as $manager) {
2452                 $user = clone($manager->user);
2453                 $user->roleid = $manager->roleid;
2454                 $user->rolename = $manager->rolename;
2455                 $user->roleshortname = $manager->roleshortname;
2456                 $user->rolecoursealias = $manager->rolecoursealias;
2457                 $rusers[$user->id] = $user;
2458             }
2459         }
2461         $namesarray = array();
2462         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2463         foreach ($rusers as $ra) {
2464             if (isset($namesarray[$ra->id])) {
2465                 //  only display a user once with the higest sortorder role
2466                 continue;
2467             }
2469             $role = new stdClass();
2470             $role->id = $ra->roleid;
2471             $role->name = $ra->rolename;
2472             $role->shortname = $ra->roleshortname;
2473             $role->coursealias = $ra->rolecoursealias;
2474             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
2476             $fullname = fullname($ra, $canviewfullnames);
2477             $namesarray[$ra->id] = $rolename.': '.
2478                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2479         }
2481         if (!empty($namesarray)) {
2482             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2483             foreach ($namesarray as $name) {
2484                 echo html_writer::tag('li', $name);
2485             }
2486             echo html_writer::end_tag('ul');
2487         }
2488     }
2489     echo html_writer::end_tag('div'); // End of info div
2491     echo html_writer::start_tag('div', array('class'=>'summary'));
2492     $options = new stdClass();
2493     $options->noclean = true;
2494     $options->para = false;
2495     $options->overflowdiv = true;
2496     if (!isset($course->summaryformat)) {
2497         $course->summaryformat = FORMAT_MOODLE;
2498     }
2499     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2500     if ($icons = enrol_get_course_info_icons($course)) {
2501         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2502         foreach ($icons as $icon) {
2503             echo $OUTPUT->render($icon);
2504         }
2505         echo html_writer::end_tag('div'); // End of enrolmenticons div
2506     }
2507     echo html_writer::end_tag('div'); // End of summary div
2508     echo html_writer::end_tag('div'); // End of coursebox div
2511 /**
2512  * Prints custom user information on the home page.
2513  * Over time this can include all sorts of information
2514  */
2515 function print_my_moodle() {
2516     global $USER, $CFG, $DB, $OUTPUT;
2518     if (!isloggedin() or isguestuser()) {
2519         print_error('nopermissions', '', '', 'See My Moodle');
2520     }
2522     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2523     $rhosts   = array();
2524     $rcourses = array();
2525     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2526         $rcourses = get_my_remotecourses($USER->id);
2527         $rhosts   = get_my_remotehosts();
2528     }
2530     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2532         if (!empty($courses)) {
2533             echo '<ul class="unlist">';
2534             foreach ($courses as $course) {
2535                 if ($course->id == SITEID) {
2536                     continue;
2537                 }
2538                 echo '<li>';
2539                 print_course($course);
2540                 echo "</li>\n";
2541             }
2542             echo "</ul>\n";
2543         }
2545         // MNET
2546         if (!empty($rcourses)) {
2547             // at the IDP, we know of all the remote courses
2548             foreach ($rcourses as $course) {
2549                 print_remote_course($course, "100%");
2550             }
2551         } elseif (!empty($rhosts)) {
2552             // non-IDP, we know of all the remote servers, but not courses
2553             foreach ($rhosts as $host) {
2554                 print_remote_host($host, "100%");
2555             }
2556         }
2557         unset($course);
2558         unset($host);
2560         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2561             echo "<table width=\"100%\"><tr><td align=\"center\">";
2562             print_course_search("", false, "short");
2563             echo "</td><td align=\"center\">";
2564             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2565             echo "</td></tr></table>\n";
2566         }
2568     } else {
2569         if ($DB->count_records("course_categories") > 1) {
2570             echo $OUTPUT->box_start("categorybox");
2571             print_whole_category_list();
2572             echo $OUTPUT->box_end();
2573         } else {
2574             print_courses(0);
2575         }
2576     }
2580 function print_course_search($value="", $return=false, $format="plain") {
2581     global $CFG;
2582     static $count = 0;
2584     $count++;
2586     $id = 'coursesearch';
2588     if ($count > 1) {
2589         $id .= $count;
2590     }
2592     $strsearchcourses= get_string("searchcourses");
2594     if ($format == 'plain') {
2595         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2596         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2597         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2598         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2599         $output .= '<input type="submit" value="'.get_string('go').'" />';
2600         $output .= '</fieldset></form>';
2601     } else if ($format == 'short') {
2602         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2603         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2604         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2605         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2606         $output .= '<input type="submit" value="'.get_string('go').'" />';
2607         $output .= '</fieldset></form>';
2608     } else if ($format == 'navbar') {
2609         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2610         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2611         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2612         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2613         $output .= '<input type="submit" value="'.get_string('go').'" />';
2614         $output .= '</fieldset></form>';
2615     }
2617     if ($return) {
2618         return $output;
2619     }
2620     echo $output;
2623 function print_remote_course($course, $width="100%") {
2624     global $CFG, $USER;
2626     $linkcss = '';
2628     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2630     echo '<div class="coursebox remotecoursebox clearfix">';
2631     echo '<div class="info">';
2632     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2633          $linkcss.' href="'.$url.'">'
2634         .  format_string($course->fullname) .'</a><br />'
2635         . format_string($course->hostname) . ' : '
2636         . format_string($course->cat_name) . ' : '
2637         . format_string($course->shortname). '</div>';
2638     echo '</div><div class="summary">';
2639     $options = new stdClass();
2640     $options->noclean = true;
2641     $options->para = false;
2642     $options->overflowdiv = true;
2643     echo format_text($course->summary, $course->summaryformat, $options);
2644     echo '</div>';
2645     echo '</div>';
2648 function print_remote_host($host, $width="100%") {
2649     global $OUTPUT;
2651     $linkcss = '';
2653     echo '<div class="coursebox clearfix">';
2654     echo '<div class="info">';
2655     echo '<div class="name">';
2656     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2657     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2658         . s($host['name']).'</a> - ';
2659     echo $host['count'] . ' ' . get_string('courses');
2660     echo '</div>';
2661     echo '</div>';
2662     echo '</div>';
2666 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2668 function add_course_module($mod) {
2669     global $DB;
2671     $mod->added = time();
2672     unset($mod->id);
2674     $cmid = $DB->insert_record("course_modules", $mod);
2675     rebuild_course_cache($mod->course, true);
2676     return $cmid;
2679 /**
2680  * Creates missing course section(s) and rebuilds course cache
2681  *
2682  * @param int|stdClass $courseorid course id or course object
2683  * @param int|array $sections list of relative section numbers to create
2684  * @return bool if there were any sections created
2685  */
2686 function course_create_sections_if_missing($courseorid, $sections) {
2687     global $DB;
2688     if (!is_array($sections)) {
2689         $sections = array($sections);
2690     }
2691     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2692     if (is_object($courseorid)) {
2693         $courseorid = $courseorid->id;
2694     }
2695     $coursechanged = false;
2696     foreach ($sections as $sectionnum) {
2697         if (!in_array($sectionnum, $existing)) {
2698             $cw = new stdClass();
2699             $cw->course   = $courseorid;
2700             $cw->section  = $sectionnum;
2701             $cw->summary  = '';
2702             $cw->summaryformat = FORMAT_HTML;
2703             $cw->sequence = '';
2704             $id = $DB->insert_record("course_sections", $cw);
2705             $coursechanged = true;
2706         }
2707     }
2708     if ($coursechanged) {
2709         rebuild_course_cache($courseorid, true);
2710     }
2711     return $coursechanged;
2714 /**
2715  * Adds an existing module to the section
2716  *
2717  * Updates both tables {course_sections} and {course_modules}
2718  *
2719  * @param int|stdClass $courseorid course id or course object
2720  * @param int $cmid id of the module already existing in course_modules table
2721  * @param int $sectionnum relative number of the section (field course_sections.section)
2722  *     If section does not exist it will be created
2723  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2724  *     before which the module needs to be included. Null for inserting in the
2725  *     end of the section
2726  * @return int The course_sections ID where the module is inserted
2727  */
2728 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
2729     global $DB, $COURSE;
2730     if (is_object($beforemod)) {
2731         $beforemod = $beforemod->id;
2732     }
2733     if (is_object($courseorid)) {
2734         $courseid = $courseorid->id;
2735     } else {
2736         $courseid = $courseorid;
2737     }
2738     course_create_sections_if_missing($courseorid, $sectionnum);
2739     // Do not try to use modinfo here, there is no guarantee it is valid!
2740     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
2741     $modarray = explode(",", trim($section->sequence));
2742     if (empty($section->sequence)) {
2743         $newsequence = "$cmid";
2744     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2745         $insertarray = array($cmid, $beforemod);
2746         array_splice($modarray, $key[0], 1, $insertarray);
2747         $newsequence = implode(",", $modarray);
2748     } else {
2749         $newsequence = "$section->sequence,$cmid";
2750     }
2751     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2752     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
2753     if (is_object($courseorid)) {
2754         rebuild_course_cache($courseorid->id, true);
2755     } else {
2756         rebuild_course_cache($courseorid, true);
2757     }
2758     return $section->id;     // Return course_sections ID that was used.
2761 function set_coursemodule_groupmode($id, $groupmode) {
2762     global $DB;
2763     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2764     if ($cm->groupmode != $groupmode) {
2765         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2766         rebuild_course_cache($cm->course, true);
2767     }
2768     return ($cm->groupmode != $groupmode);
2771 function set_coursemodule_idnumber($id, $idnumber) {
2772     global $DB;
2773     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2774     if ($cm->idnumber != $idnumber) {
2775         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2776         rebuild_course_cache($cm->course, true);
2777     }
2778     return ($cm->idnumber != $idnumber);
2781 /**
2782  * Set the visibility of a module and inherent properties.
2783  *
2784  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
2785  * has been moved to {@link set_section_visible()} which was the only place from which
2786  * the parameter was used.
2787  *
2788  * @param int $id of the module
2789  * @param int $visible state of the module
2790  * @return bool false when the module was not found, true otherwise
2791  */
2792 function set_coursemodule_visible($id, $visible) {
2793     global $DB, $CFG;
2794     require_once($CFG->libdir.'/gradelib.php');
2796     // Trigger developer's attention when using the previously removed argument.
2797     if (func_num_args() > 2) {
2798         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
2799             has been removed.', DEBUG_DEVELOPER);
2800     }
2802     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2803         return false;
2804     }
2805     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2806         return false;
2807     }
2808     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2809         foreach($events as $event) {
2810             if ($visible) {
2811                 show_event($event);
2812             } else {
2813                 hide_event($event);
2814             }
2815         }
2816     }
2818     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2819     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2820     if ($grade_items) {
2821         foreach ($grade_items as $grade_item) {
2822             $grade_item->set_hidden(!$visible);
2823         }
2824     }
2826     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
2827     // affect visibleold to allow for an original visibility restore. See set_section_visible().
2828     $cminfo = new stdClass();
2829     $cminfo->id = $id;
2830     $cminfo->visible = $visible;
2831     $cminfo->visibleold = $visible;
2832     $DB->update_record('course_modules', $cminfo);
2834     rebuild_course_cache($cm->course, true);
2835     return true;
2838 /**
2839  * Delete a course module and any associated data at the course level (events)
2840  * Until 1.5 this function simply marked a deleted flag ... now it
2841  * deletes it completely.
2842  *
2843  */
2844 function delete_course_module($id) {
2845     global $CFG, $DB;
2846     require_once($CFG->libdir.'/gradelib.php');
2847     require_once($CFG->dirroot.'/blog/lib.php');
2849     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2850         return true;
2851     }
2852     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2853     //delete events from calendar
2854     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2855         foreach($events as $event) {
2856             delete_event($event->id);
2857         }
2858     }
2859     //delete grade items, outcome items and grades attached to modules
2860     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2861                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2862         foreach ($grade_items as $grade_item) {
2863             $grade_item->delete('moddelete');
2864         }
2865     }
2866     // Delete completion and availability data; it is better to do this even if the
2867     // features are not turned on, in case they were turned on previously (these will be
2868     // very quick on an empty table)
2869     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2870     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2871     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2872     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2873                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2875     delete_context(CONTEXT_MODULE, $cm->id);
2876     $DB->delete_records('course_modules', array('id'=>$cm->id));
2877     rebuild_course_cache($cm->course, true);
2878     return true;
2881 function delete_mod_from_section($modid, $sectionid) {
2882     global $DB;
2884     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2886         $modarray = explode(",", $section->sequence);
2888         if ($key = array_keys ($modarray, $modid)) {
2889             array_splice($modarray, $key[0], 1);
2890             $newsequence = implode(",", $modarray);
2891             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2892             rebuild_course_cache($section->course, true);
2893             return true;
2894         } else {
2895             return false;
2896         }
2898     }
2899     return false;
2902 /**
2903  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2904  *
2905  * @param object $course course object
2906  * @param int $section Section number (not id!!!)
2907  * @param int $move (-1 or 1)
2908  * @return boolean true if section moved successfully
2909  * @todo MDL-33379 remove this function in 2.5
2910  */
2911 function move_section($course, $section, $move) {
2912     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2914 /// Moves a whole course section up and down within the course
2915     global $USER;
2917     if (!$move) {
2918         return true;
2919     }
2921     $sectiondest = $section + $move;
2923     // compartibility with course formats using field 'numsections'
2924     $courseformatoptions = course_get_format($course)->get_format_options();
2925     if (array_key_exists('numsections', $courseformatoptions) &&
2926             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2927         return false;
2928     }
2930     $retval = move_section_to($course, $section, $sectiondest);
2931     return $retval;
2934 /**
2935  * Moves a section within a course, from a position to another.
2936  * Be very careful: $section and $destination refer to section number,
2937  * not id!.
2938  *
2939  * @param object $course
2940  * @param int $section Section number (not id!!!)
2941  * @param int $destination
2942  * @return boolean Result
2943  */
2944 function move_section_to($course, $section, $destination) {
2945 /// Moves a whole course section up and down within the course
2946     global $USER, $DB;
2948     if (!$destination && $destination != 0) {
2949         return true;
2950     }
2952     // compartibility with course formats using field 'numsections'
2953     $courseformatoptions = course_get_format($course)->get_format_options();
2954     if ((array_key_exists('numsections', $courseformatoptions) &&
2955             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
2956         return false;
2957     }
2959     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2960     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2961             'section ASC, id ASC', 'id, section')) {
2962         return false;
2963     }
2965     $movedsections = reorder_sections($sections, $section, $destination);
2967     // Update all sections. Do this in 2 steps to avoid breaking database
2968     // uniqueness constraint
2969     $transaction = $DB->start_delegated_transaction();
2970     foreach ($movedsections as $id => $position) {
2971         if ($sections[$id] !== $position) {
2972             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2973         }
2974     }
2975     foreach ($movedsections as $id => $position) {
2976         if ($sections[$id] !== $position) {
2977             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2978         }
2979     }
2981     // If we move the highlighted section itself, then just highlight the destination.
2982     // Adjust the higlighted section location if we move something over it either direction.
2983     if ($section == $course->marker) {
2984         course_set_marker($course->id, $destination);
2985     } elseif ($section > $course->marker && $course->marker >= $destination) {
2986         course_set_marker($course->id, $course->marker+1);
2987     } elseif ($section < $course->marker && $course->marker <= $destination) {
2988         course_set_marker($course->id, $course->marker-1);
2989     }
2991     $transaction->allow_commit();
2992     rebuild_course_cache($course->id, true);
2993     return true;
2996 /**
2997  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2998  * an original position number and a target position number, rebuilds the array so that the
2999  * move is made without any duplication of section positions.
3000  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3001  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3002  *
3003  * @param array $sections
3004  * @param int $origin_position
3005  * @param int $target_position
3006  * @return array
3007  */
3008 function reorder_sections($sections, $origin_position, $target_position) {
3009     if (!is_array($sections)) {
3010         return false;
3011     }
3013     // We can't move section position 0
3014     if ($origin_position < 1) {
3015         echo "We can't move section position 0";
3016         return false;
3017     }
3019     // Locate origin section in sections array
3020     if (!$origin_key = array_search($origin_position, $sections)) {
3021         echo "searched position not in sections array";
3022         return false; // searched position not in sections array
3023     }
3025     // Extract origin section
3026     $origin_section = $sections[$origin_key];
3027     unset($sections[$origin_key]);
3029     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3030     $found = false;
3031     $append_array = array();
3032     foreach ($sections as $id => $position) {
3033         if ($found) {
3034             $append_array[$id] = $position;
3035             unset($sections[$id]);
3036         }
3037         if ($position == $target_position) {
3038             if ($target_position < $origin_position) {
3039                 $append_array[$id] = $position;
3040                 unset($sections[$id]);
3041             }
3042             $found = true;
3043         }
3044     }
3046     // Append moved section
3047     $sections[$origin_key] = $origin_section;
3049     // Append rest of array (if applicable)
3050     if (!empty($append_array)) {
3051         foreach ($append_array as $id => $position) {
3052             $sections[$id] = $position;
3053         }
3054     }
3056     // Renumber positions
3057     $position = 0;
3058     foreach ($sections as $id => $p) {
3059         $sections[$id] = $position;
3060         $position++;
3061     }
3063     return $sections;
3067 /**
3068  * Move the module object $mod to the specified $section
3069  * If $beforemod exists then that is the module
3070  * before which $modid should be inserted
3071  * All parameters are objects
3072  */
3073 function moveto_module($mod, $section, $beforemod=NULL) {
3074     global $OUTPUT;
3076 /// Remove original module from original section
3077     if (! delete_mod_from_section($mod->id, $mod->section)) {
3078         echo $OUTPUT->notification("Could not delete module from existing section");
3079     }
3081     // if moving to a hidden section then hide module
3082     if (!$section->visible && $mod->visible) {
3083         set_coursemodule_visible($mod->id, 0);
3084     }
3086 /// Add the module into the new section
3087     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
3088     return true;
3091 /**
3092  * Produces the editing buttons for a module
3093  *
3094  * @global core_renderer $OUTPUT
3095  * @staticvar type $str
3096  * @param stdClass $mod The module to produce editing buttons for
3097  * @param bool $absolute_ignored (argument ignored) - all links are absolute
3098  * @param bool $moveselect (argument ignored)
3099  * @param int $indent The current indenting
3100  * @param int $section The section to link back to
3101  * @return string XHTML for the editing buttons
3102  */
3103 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3104     global $PAGE;
3105     if (!($mod instanceof cm_info)) {
3106         $modinfo = get_fast_modinfo($mod->course);
3107         $mod = $modinfo->get_cm($mod->id);
3108     }
3109     $actions = course_get_cm_edit_actions($mod, $indent, $section);
3111     $courserenderer = $PAGE->get_renderer('core', 'course');
3112     // The space added before the <span> is a ugly hack but required to set the CSS property white-space: nowrap
3113     // and having it to work without attaching the preceding text along with it. Hopefully the refactoring of
3114     // the course page HTML will allow this to be removed.
3115     return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
3118 /**
3119  * Returns the list of all editing actions that current user can perform on the module
3120  *
3121  * @param cm_info $mod The module to produce editing buttons for
3122  * @param int $indent The current indenting (default -1 means no move left-right actions)
3123  * @param int $sr The section to link back to (used for creating the links)
3124  * @return array array of action_link or pix_icon objects
3125  */
3126 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
3127     global $COURSE, $SITE;
3129     static $str;
3131     $coursecontext = context_course::instance($mod->course);
3132     $modcontext = context_module::instance($mod->id);
3134     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3135     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3137     // no permission to edit anything
3138     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3139         return array();
3140     }
3142     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3144     if (!isset($str)) {
3145         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
3146             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
3147         $str->assign         = get_string('assignroles', 'role');
3148         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3149         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3150         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3151         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3152         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3153         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3154     }
3156     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3158     if ($sr !== null) {
3159         $baseurl->param('sr', $sr);
3160     }
3161     $actions = array();
3163     // AJAX edit title
3164     if ($mod->modname !== 'label' && $hasmanageactivities &&
3165                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
3166                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
3167         // we will not display link if we are on some other-course page (where we should not see this module anyway)
3168         $actions['title'] = new action_link(
3169             new moodle_url($baseurl, array('update' => $mod->id)),
3170             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3171             null,
3172             array('class' => 'editing_title', 'title' => $str->edittitle)
3173         );
3174     }
3176     // leftright
3177     if ($hasmanageactivities) {
3178         if (right_to_left()) {   // Exchange arrows on RTL
3179             $rightarrow = 't/left';
3180             $leftarrow  = 't/right';
3181         } else {
3182             $rightarrow = 't/right';
3183             $leftarrow  = 't/left';
3184         }
3186         if ($indent > 0) {
3187             $actions['moveleft'] = new action_link(
3188                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3189                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3190                 null,
3191                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3192             );
3193         }
3194         if ($indent >= 0) {
3195             $actions['moveright'] = new action_link(
3196                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3197                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3198                 null,
3199                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3200             );
3201         }
3202     }
3204     // move
3205     if ($hasmanageactivities) {
3206         $actions['move'] = new action_link(
3207             new moodle_url($baseurl, array('copy' => $mod->id)),
3208             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3209             null,
3210             array('class' => 'editing_move', 'title' => $str->move)
3211         );
3212     }
3214     // Update
3215     if ($hasmanageactivities) {
3216         $actions['update'] = new action_link(
3217             new moodle_url($baseurl, array('update' => $mod->id)),
3218             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3219             null,
3220             array('class' => 'editing_update', 'title' => $str->update)
3221         );
3222     }
3224     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3225     // note that restoring on front page is never allowed
3226     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
3227             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3228         $actions['duplicate'] = new action_link(
3229             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3230             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3231             null,
3232             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3233         );
3234     }
3236     // Delete
3237     if ($hasmanageactivities) {
3238         $actions['delete'] = new action_link(
3239             new moodle_url($baseurl, array('delete' => $mod->id)),
3240             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3241             null,
3242             array('class' => 'editing_delete', 'title' => $str->delete)
3243         );
3244     }
3246     // hideshow
3247     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3248         if ($mod->visible) {
3249             $actions['hide'] = new action_link(
3250                 new moodle_url($baseurl, array('hide' => $mod->id)),
3251                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3252                 null,
3253                 array('class' => 'editing_hide', 'title' => $str->hide)
3254             );
3255         } else {
3256             $actions['show'] = new action_link(
3257                 new moodle_url($baseurl, array('show' => $mod->id)),
3258                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3259                 null,
3260                 array('class' => 'editing_show', 'title' => $str->show)
3261             );
3262         }
3263     }
3265     // groupmode
3266     if ($hasmanageactivities and $mod->groupmode !== false) {
3267         if ($mod->groupmode == SEPARATEGROUPS) {
3268             $groupmode = NOGROUPS;
3269             $grouptitle = $str->groupsseparate;
3270             $forcedgrouptitle = $str->forcedgroupsseparate;
3271             $actionname = 'groupsseparate';
3272             $groupimage = 't/groups';
3273         } else if ($mod->groupmode == VISIBLEGROUPS) {
3274             $groupmode = SEPARATEGROUPS;
3275             $grouptitle = $str->groupsvisible;
3276             $forcedgrouptitle = $str->forcedgroupsvisible;
3277             $actionname = 'groupsvisible';
3278             $groupimage = 't/groupv';
3279         } else {
3280             $groupmode = VISIBLEGROUPS;
3281             $grouptitle = $str->groupsnone;
3282             $forcedgrouptitle = $str->forcedgroupsnone;
3283             $actionname = 'groupsnone';
3284             $groupimage = 't/groupn';
3285         }
3286         if ($mod->groupmodelink) {
3287             $actions[$actionname] = new action_link(
3288                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3289                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3290                 null,
3291                 array('class' => 'editing_'. $actionname, 'title' => $grouptitle)
3292             );
3293         } else {
3294             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3295         }
3296     }
3298     // Assign
3299     if (has_capability('moodle/role:assign', $modcontext)){
3300         $actions['assign'] = new action_link(
3301             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
3302             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3303             null,
3304             array('class' => 'editing_assign', 'title' => $str->assign)
3305         );
3306     }
3308     return $actions;
3311 /**
3312  * given a course object with shortname & fullname, this function will
3313  * truncate the the number of chars allowed and add ... if it was too long
3314  */
3315 function course_format_name ($course,$max=100) {
3317     $context = context_course::instance($course->id);
3318     $shortname = format_string($course->shortname, true, array('context' => $context));
3319     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3320     $str = $shortname.': '. $fullname;
3321     if (textlib::strlen($str) <= $max) {
3322         return $str;
3323     }
3324     else {
3325         return textlib::substr($str,0,$max-3).'...';
3326     }
3329 /**
3330  * Is the user allowed to add this type of module to this course?
3331  * @param object $course the course settings. Only $course->id is used.
3332  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3333  * @return bool whether the current user is allowed to add this type of module to this course.
3334  */
3335 function course_allowed_module($course, $modname) {
3336     if (is_numeric($modname)) {
3337         throw new coding_exception('Function course_allowed_module no longer
3338                 supports numeric module ids. Please update your code to pass the module name.');
3339     }
3341     $capability = 'mod/' . $modname . ':addinstance';
3342     if (!get_capability_info($capability)) {
3343         // Debug warning that the capability does not exist, but no more than once per page.
3344         static $warned = array();
3345         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3346         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3347             debugging('The module ' . $modname . ' does not define the standard capability ' .
3348                     $capability , DEBUG_DEVELOPER);
3349             $warned[$modname] = 1;
3350         }
3352         // If the capability does not exist, the module can always be added.
3353         return true;
3354     }
3356     $coursecontext = context_course::instance($course->id);
3357     return has_capability($capability, $coursecontext);
3360 /**
3361  * Recursively delete category including all subcategories and courses.
3362  * @param stdClass $category
3363  * @param boolean $showfeedback display some notices
3364  * @return array return deleted courses
3365  */
3366 function category_delete_full($category, $showfeedback=true) {
3367     global $CFG, $DB;
3368     require_once($CFG->libdir.'/gradelib.php');
3369     require_once($CFG->libdir.'/questionlib.php');
3370     require_once($CFG->dirroot.'/cohort/lib.php');
3372     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3373         foreach ($children as $childcat) {
3374             category_delete_full($childcat, $showfeedback);
3375         }
3376     }
3378     $deletedcourses = array();
3379     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3380         foreach ($courses as $course) {
3381             if (!delete_course($course, false)) {
3382                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3383             }
3384             $deletedcourses[] = $course;
3385         }
3386     }
3388     // move or delete cohorts in this context
3389     cohort_delete_category($category);
3391     // now delete anything that may depend on course category context
3392     grade_course_category_delete($category->id, 0, $showfeedback);
3393     if (!question_delete_course_category($category, 0, $showfeedback)) {
3394         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3395     }
3397     // finally delete the category and it's context
3398     $DB->delete_records('course_categories', array('id'=>$category->id));
3399     delete_context(CONTEXT_COURSECAT, $category->id);
3401     events_trigger('course_category_deleted', $category);
3403     return $deletedcourses;
3406 /**
3407  * Delete category, but move contents to another category.
3408  * @param object $ccategory
3409  * @param int $newparentid category id
3410  * @return bool status
3411  */
3412 function category_delete_move($category, $newparentid, $showfeedback=true) {
3413     global $CFG, $DB, $OUTPUT;
3414     require_once($CFG->libdir.'/gradelib.php');
3415     require_once($CFG->libdir.'/questionlib.php');
3416     require_once($CFG->dirroot.'/cohort/lib.php');
3418     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3419         return false;
3420     }
3422     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3423         foreach ($children as $childcat) {
3424             move_category($childcat, $newparentcat);
3425         }
3426     }
3428     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3429         if (!move_courses(array_keys($courses), $newparentid)) {
3430             if ($showfeedback) {
3431                 echo $OUTPUT->notification("Error moving courses");
3432             }
3433             return false;
3434         }
3435         if ($showfeedback) {
3436             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3437         }
3438     }
3440     // move or delete cohorts in this context
3441     cohort_delete_category($category);
3443     // now delete anything that may depend on course category context
3444     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3445     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3446         if ($showfeedback) {
3447             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3448         }
3449         return false;
3450     }
3452     // finally delete the category and it's context
3453     $DB->delete_records('course_categories', array('id'=>$category->id));
3454     delete_context(CONTEXT_COURSECAT, $category->id);
3456     events_trigger('course_category_deleted', $category);
3458     if ($showfeedback) {
3459         echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3460     }
3461     return true;
3464 /**
3465  * Efficiently moves many courses around while maintaining
3466  * sortorder in order.
3467  *
3468  * @param array $courseids is an array of course ids
3469  * @param int $categoryid
3470  * @return bool success
3471  */
3472 function move_courses($courseids, $categoryid) {
3473     global $CFG, $DB, $OUTPUT;
3475     if (empty($courseids)) {
3476         // nothing to do
3477         return;
3478     }
3480     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3481         return false;
3482     }
3484     $courseids = array_reverse($courseids);
3485     $newparent = context_coursecat::instance($category->id);
3486     $i = 1;
3488     foreach ($courseids as $courseid) {
3489         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3490             $course = new stdClass();
3491             $course->id = $courseid;
3492             $course->category  = $category->id;
3493             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3494             if ($category->visible == 0) {
3495                 // hide the course when moving into hidden category,
3496                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3497                 $course->visible = 0;
3498             }
3500             $DB->update_record('course', $course);
3502             $context   = context_course::instance($course->id);
3503             context_moved($context, $newparent);
3504         }
3505     }
3506     fix_course_sortorder();
3508     return true;
3511 /**
3512  * Hide course category and child course and subcategories
3513  * @param stdClass $category
3514  * @return void
3515  */
3516 function course_category_hide($category) {
3517     global $DB;
3519     $category->visible = 0;
3520     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3521     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3522     $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
3523     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3524     // get all child categories and hide too
3525     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3526         foreach ($subcats as $cat) {
3527             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3528             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3529             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3530             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3531         }
3532     }
3535 /**
3536  * Show course category and child course and subcategories
3537  * @param stdClass $category
3538  * @return void
3539  */
3540 function course_category_show($category) {
3541     global $DB;
3543     $category->visible = 1;
3544     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3545     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3546     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3547     // get all child categories and unhide too
3548     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3549         foreach ($subcats as $cat) {
3550             if ($cat->visibleold) {
3551                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3552             }
3553             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3554         }
3555     }
3558 /**
3559  * Efficiently moves a category - NOTE that this can have
3560  * a huge impact access-control-wise...
3561  */
3562 function move_category($category, $newparentcat) {
3563     global $CFG, $DB;
3565     $context = context_coursecat::instance($category->id);
3567     $hidecat = false;
3568     if (empty($newparentcat->id)) {
3569         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3571         $newparent = context_system::instance();
3573     } else {
3574         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3575         $newparent = context_coursecat::instance($newparentcat->id);
3577         if (!$newparentcat->visible and $category->visible) {
3578             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3579             $hidecat = true;
3580         }
3581     }
3583     context_moved($context, $newparent);
3585     // now make it last in new category
3586     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3588     // and fix the sortorders
3589     fix_course_sortorder();
3591     if ($hidecat) {
3592         course_category_hide($category);
3593     }
3596 /**
3597  * Returns the display name of the given section that the course prefers
3598  *
3599  * Implementation of this function is provided by course format
3600  * @see format_base::get_section_name()
3601  *
3602  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
3603  * @param int|stdClass $section Section object from database or just field course_sections.section
3604  * @return string Display name that the course format prefers, e.g. "Week 2"
3605  */
3606 function get_section_name($courseorid, $section) {
3607     return course_get_format($courseorid)->get_section_name($section);
3610 /**
3611  * Tells if current course format uses sections
3612  *
3613  * @param string $format Course format ID e.g. 'weeks' $course->format
3614  * @return bool
3615  */
3616 function course_format_uses_sections($format) {
3617     $course = new stdClass();
3618     $course->format = $format;
3619     return course_get_format($course)->uses_sections();
3622 /**
3623  * Returns the information about the ajax support in the given source format
3624  *
3625  * The returned object's property (boolean)capable indicates that
3626  * the course format supports Moodle course ajax features.
3627  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3628  *
3629  * @param string $format
3630  * @return stdClass
3631  */
3632 function course_format_ajax_support($format) {
3633     $course = new stdClass();
3634     $course->format = $format;
3635     return course_get_format($course)->supports_ajax();
3638 /**
3639  * Can the current user delete this course?
3640  * Course creators have exception,
3641  * 1 day after the creation they can sill delete the course.
3642  * @param int $courseid
3643  * @return boolean
3644  */
3645 function can_delete_course($courseid) {
3646     global $USER, $DB;
3648     $context = context_course::instance($courseid);
3650     if (has_capability('moodle/course:delete', $context)) {
3651         return true;
3652     }
3654     // hack: now try to find out if creator created this course recently (1 day)
3655     if (!has_capability('moodle/course:create', $context)) {
3656         return false;
3657     }
3659     $since = time() - 60*60*24;
3661     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3662     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3664     return $DB->record_exists_select('log', $select, $params);
3667 /**
3668  * Save the Your name for 'Some role' strings.
3669  *
3670  * @param integer $courseid the id of this course.
3671  * @param array $data the data that came from the course settings form.
3672  */
3673 function save_local_role_names($courseid, $data) {
3674     global $DB;
3675     $context = context_course::instance($courseid);
3677     foreach ($data as $fieldname => $value) {
3678         if (strpos($fieldname, 'role_') !== 0) {
3679             continue;
3680         }
3681         list($ignored, $roleid) = explode('_', $fieldname);
3683         // make up our mind whether we want to delete, update or insert
3684         if (!$value) {
3685             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3687         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3688             $rolename->name = $value;
3689             $DB->update_record('role_names', $rolename);
3691         } else {
3692             $rolename = new stdClass;
3693             $rolename->contextid = $context->id;
3694             $rolename->roleid = $roleid;
3695             $rolename->name = $value;
3696             $DB->insert_record('role_names', $rolename);
3697         }
3698     }
3701 /**
3702  * Create a course and either return a $course object
3703  *
3704  * Please note this functions does not verify any access control,
3705  * the calling code is responsible for all validation (usually it is the form definition).
3706  *
3707  * @param array $editoroptions course description editor options
3708  * @param object $data  - all the data needed for an entry in the 'course' table
3709  * @return object new course instance
3710  */
3711 function create_course($data, $editoroptions = NULL) {
3712     global $CFG, $DB;
3714     //check the categoryid - must be given for all new courses
3715     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3717     //check if the shortname already exist
3718     if (!empty($data->shortname)) {
3719         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3720             throw new moodle_exception('shortnametaken');
3721         }
3722     }
3724     //check if the id number already exist
3725     if (!empty($data->idnumber)) {
3726         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3727             throw new moodle_exception('idnumbertaken');
3728         }
3729     }
3731     $data->timecreated  = time();
3732     $data->timemodified = $data->timecreated;
3734     // place at beginning of any category
3735     $data->sortorder = 0;
3737     if ($editoroptions) {
3738         // summary text is updated later, we need context to store the files first
3739         $data->summary = '';
3740         $data->summary_format = FORMAT_HTML;
3741     }
3743     if (!isset($data->visible)) {
3744         // data not from form, add missing visibility info
3745         $data->visible = $category->visible;
3746     }
3747     $data->visibleold = $data->visible;
3749     $newcourseid = $DB->insert_record('course', $data);
3750     $context = context_course::instance($newcourseid, MUST_EXIST);
3752     if ($editoroptions) {
3753         // Save the files used in the summary editor and store
3754         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3755         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3756         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3757     }
3759     // update course format options
3760     course_get_format($newcourseid)->update_course_format_options($data);
3762     $course = course_get_format($newcourseid)->get_course();
3764     // Setup the blocks
3765     blocks_add_default_course_blocks($course);
3767     // Create a default section.
3768     course_create_sections_if_missing($course, 0);
3770     fix_course_sortorder();
3772     // new context created - better mark it as dirty
3773     mark_context_dirty($context->path);
3775     // Save any custom role names.
3776     save_local_role_names($course->id, (array)$data);
3778     // set up enrolments
3779     enrol_course_updated(true, $course, $data);
3781     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3783     // Trigger events
3784     events_trigger('course_created', $course);
3786     return $course;
3789 /**
3790  * Create a new course category and marks the context as dirty
3791  *
3792  * This function does not set the sortorder for the new category and
3793  * @see{fix_course_sortorder} should be called after creating a new course
3794  * category
3795  *
3796  * Please note that this function does not verify access control.
3797  *
3798  * @param object $category All of the data required for an entry in the course_categories table
3799  * @return object new course category
3800  */
3801 function create_course_category($category) {
3802     global $DB;
3804     $category->timemodified = time();
3805     $category->id = $DB->insert_record('course_categories', $category);
3806     $category = $DB->get_record('course_categories', array('id' => $category->id));
3808     // We should mark the context as dirty
3809     $category->context = context_coursecat::instance($category->id);
3810     $category->context->mark_dirty();
3812     return $category;
3815 /**
3816  * Update a course.
3817  *
3818  * Please note this functions does not verify any access control,
3819  * the calling code is responsible for all validation (usually it is the form definition).
3820  *
3821  * @param object $data  - all the data needed for an entry in the 'course' table
3822  * @param array $editoroptions course description editor options
3823  * @return void
3824  */
3825 function update_course($data, $editoroptions = NULL) {
3826     global $CFG, $DB;
3828     $data->timemodified = time();
3830     $oldcourse = course_get_format($data->id)->get_course();
3831     $context   = context_course::instance($oldcourse->id);
3833     if ($editoroptions) {
3834         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3835     }
3837     if (!isset($data->category) or empty($data->category)) {
3838         // prevent nulls and 0 in category field
3839         unset($data->category);
3840     }
3841     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3843     if (!isset($data->visible)) {
3844         // data not from form, add missing visibility info
3845         $data->visible = $oldcourse->visible;
3846     }
3848     if ($data->visible != $oldcourse->visible) {
3849         // reset the visibleold flag when manually hiding/unhiding course
3850         $data->visibleold = $data->visible;
3851     } else {
3852         if ($movecat) {
3853             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3854             if (empty($newcategory->visible)) {
3855                 // make sure when moving into hidden category the course is hidden automatically
3856                 $data->visible = 0;
3857             }
3858         }
3859     }
3861     // Update with the new data
3862     $DB->update_record('course', $data);
3863     // make sure the modinfo cache is reset
3864     rebuild_course_cache($data->id);
3866     // update course format options with full course data
3867     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
3869     $course = $DB->get_record('course', array('id'=>$data->id));
3871     if ($movecat) {
3872         $newparent = context_coursecat::instance($course->category);
3873         context_moved($context, $newparent);
3874     }
3876     fix_course_sortorder();
3878     // Test for and remove blocks which aren't appropriate anymore
3879     blocks_remove_inappropriate($course);
3881     // Save any custom role names.
3882     save_local_role_names($course->id, $data);
3884     // update enrol settings
3885     enrol_course_updated(false, $course, $data);
3887     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3889     // Trigger events
3890     events_trigger('course_updated', $course);
3892     if ($oldcourse->format !== $course->format) {
3893         // Remove all options stored for the previous format
3894         // We assume that new course format migrated everything it needed watching trigger
3895         // 'course_updated' and in method format_XXX::update_course_format_options()
3896         $DB->delete_records('course_format_options',
3897                 array('courseid' => $course->id, 'format' => $oldcourse->format));
3898     }
3901 /**
3902  * Average number of participants
3903  * @return integer
3904  */
3905 function average_number_of_participants() {
3906     global $DB, $SITE;
3908     //count total of enrolments for visible course (except front page)
3909     $sql = 'SELECT COUNT(*) FROM (
3910         SELECT DISTINCT ue.userid, e.courseid
3911         FROM {user_enrolments} ue, {enrol} e, {course} c
3912         WHERE ue.enrolid = e.id
3913             AND e.courseid <> :siteid
3914             AND c.id = e.courseid
3915             AND c.visible = 1) total';
3916     $params = array('siteid' => $SITE->id);
3917     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3920     //count total of visible courses (minus front page)
3921     $coursetotal = $DB->count_records('course', array('visible' => 1));
3922     $coursetotal = $coursetotal - 1 ;
3924     //average of enrolment
3925     if (empty($coursetotal)) {
3926         $participantaverage = 0;
3927     } else {
3928         $participantaverage = $enrolmenttotal / $coursetotal;
3929     }
3931     return $participantaverage;
3934 /**
3935  * Average number of course modules
3936  * @return integer
3937  */
3938 function average_number_of_courses_modules() {
3939     global $DB, $SITE;
3941     //count total of visible course module (except front page)
3942     $sql = 'SELECT COUNT(*) FROM (
3943         SELECT cm.course, cm.module
3944         FROM {course} c, {course_modules} cm
3945         WHERE c.id = cm.course
3946             AND c.id <> :siteid
3947             AND cm.visible = 1
3948             AND c.visible = 1) total';
3949     $params = array('siteid' => $SITE->id);
3950     $moduletotal = $DB->count_records_sql($sql, $params);
3953     //count total of visible courses (minus front page)
3954     $coursetotal = $DB->count_records('course', array('visible' => 1));
3955     $coursetotal = $coursetotal - 1 ;
3957     //average of course module
3958     if (empty($coursetotal)) {
3959         $coursemoduleaverage = 0;
3960     } else {
3961         $coursemoduleaverage = $moduletotal / $coursetotal;
3962     }
3964     return $coursemoduleaverage;
3967 /**
3968  * This class pertains to course requests and contains methods associated with
3969  * create, approving, and removing course requests.
3970  *
3971  * Please note we do not allow embedded images here because there is no context
3972  * to store them with proper access control.
3973  *
3974  * @copyright 2009 Sam Hemelryk
3975  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3976  * @since Moodle 2.0
3977  *
3978  * @property-read int $id
3979  * @property-read string $fullname
3980  * @property-read string $shortname
3981  * @property-read string $summary
3982  * @property-read int $summaryformat
3983  * @property-read int $summarytrust
3984  * @property-read string $reason
3985  * @property-read int $requester
3986  */
3987 class course_request {
3989     /**
3990      * This is the stdClass that stores the properties for the course request
3991      * and is externally accessed through the __get magic method
3992      * @var stdClass
3993      */
3994     protected $properties;
3996     /**
3997      * An array of options for the summary editor used by course request forms.
3998      * This is initially set by {@link summary_editor_options()}
3999      * @var array
4000      * @static
4001      */
4002     protected static $summaryeditoroptions;
4004     /**
4005      * Static function to prepare the summary editor for working with a course
4006      * request.
4007      *
4008      * @static
4009      * @param null|stdClass $data Optional, an object containing the default values
4010      *                       for the form, these may be modified when preparing the
4011      *                       editor so this should be called before creating the form
4012      * @return stdClass An object that can be used to set the default values for
4013      *                   an mforms form
4014      */
4015     public static function prepare($data=null) {
4016         if ($data === null) {
4017             $data = new stdClass;
4018         }
4019         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
4020         return $data;
4021     }
4023     /**
4024      * Static function to create a new course request when passed an array of properties
4025      * for it.
4026      *
4027      * This function also handles saving any files that may have been used in the editor
4028      *
4029      * @static
4030      * @param stdClass $data
4031      * @return course_request The newly created course request
4032      */
4033     public static function create($data) {
4034         global $USER, $DB, $CFG;
4035         $data->requester = $USER->id;
4037         // Setting the default category if none set.
4038         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
4039             $data->category = $CFG->defaultrequestcategory;
4040         }
4042         // Summary is a required field so copy the text over
4043         $data->summary       = $data->summary_editor['text'];
4044         $data->summaryformat = $data->summary_editor['format'];
4046         $data->id = $DB->insert_record('course_request', $data);
4048         // Create a new course_request object and return it
4049         $request = new course_request($data);
4051         // Notify the admin if required.
4052         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
4054             $a = new stdClass;
4055             $a->link = "$CFG->wwwroot/course/pending.php";
4056             $a->user = fullname($USER);
4057             $subject = get_string('courserequest');
4058             $message = get_string('courserequestnotifyemail', 'admin', $a);
4059             foreach ($users as $user) {
4060                 $request->notify($user, $USER, 'courserequested', $subject, $message);
4061             }
4062         }
4064         return $request;
4065     }
4067     /**
4068      * Returns an array of options to use with a summary editor
4069      *
4070      * @uses course_request::$summaryeditoroptions
4071      * @return array An array of options to use with the editor
4072      */
4073     public static function summary_editor_options() {
4074         global $CFG;
4075         if (self::$summaryeditoroptions === null) {
4076             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
4077         }
4078         return self::$summaryeditoroptions;
4079     }
4081     /**
4082      * Loads the properties for this course request object. Id is required and if
4083      * only id is provided then we load the rest of the properties from the database
4084      *
4085      * @param stdClass|int $properties Either an object containing properties
4086      *                      or the course_request id to load
4087      */
4088     public function __construct($properties) {
4089         global $DB;
4090         if (empty($properties->id)) {
4091             if (empty($properties)) {
4092                 throw new coding_exception('You must provide a course request id when creating a course_request object');
4093             }
4094             $id = $properties;
4095             $properties = new stdClass;
4096             $properties->id = (int)$id;
4097             unset($id);
4098         }
4099         if (empty($properties->requester)) {
4100             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
4101                 print_error('unknowncourserequest');
4102             }
4103         } else {
4104             $this->properties = $properties;
4105         }
4106         $this->properties->collision = null;
4107     }
4109     /**
4110      * Returns the requested property
4111      *
4112      * @param string $key
4113      * @return mixed
4114      */
4115     public function __get($key) {
4116         return $this->properties->$key;
4117     }
4119     /**
4120      * Override this to ensure empty($request->blah) calls return a reliable answer...
4121      *
4122      * This is required because we define the __get method
4123      *
4124      * @param mixed $key
4125      * @return bool True is it not empty, false otherwise
4126      */
4127     public function __isset($key) {
4128         return (!empty($this->properties->$key));
4129     }
4131     /**
4132      * Returns the user who requested this course
4133      *
4134      * Uses a static var to cache the results and cut down the number of db queries
4135      *
4136      * @staticvar array $requesters An array of cached users
4137      * @return stdClass The user who requested the course
4138      */
4139     public function get_requester() {
4140         global $DB;
4141         static $requesters= array();
4142         if (!array_key_exists($this->properties->requester, $requesters)) {
4143             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
4144         }
4145         return $requesters[$this->properties->requester];
4146     }
4148     /**
4149      * Checks that the shortname u