92268fdf938e4c5a7cd5d94834d99f89958631d0
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->dirroot.'/course/dnduploadlib.php');
32 require_once($CFG->dirroot.'/course/format/lib.php');
34 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
37 /**
38  * Number of courses to display when summaries are included.
39  * @var int
40  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
41  */
42 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
44 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
45 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
46 define('FRONTPAGENEWS',           '0');
47 define('FRONTPAGECOURSELIST',     '1');
48 define('FRONTPAGECATEGORYNAMES',  '2');
49 define('FRONTPAGETOPICONLY',      '3');
50 define('FRONTPAGECATEGORYCOMBO',  '4');
51 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 function make_log_url($module, $url) {
59     switch ($module) {
60         case 'course':
61             if (strpos($url, 'report/') === 0) {
62                 // there is only one report type, course reports are deprecated
63                 $url = "/$url";
64                 break;
65             }
66         case 'file':
67         case 'login':
68         case 'lib':
69         case 'admin':
70         case 'calendar':
71         case 'mnet course':
72             if (strpos($url, '../') === 0) {
73                 $url = ltrim($url, '.');
74             } else {
75                 $url = "/course/$url";
76             }
77             break;
78         case 'user':
79         case 'blog':
80             $url = "/$module/$url";
81             break;
82         case 'upload':
83             $url = $url;
84             break;
85         case 'coursetags':
86             $url = '/'.$url;
87             break;
88         case 'library':
89         case '':
90             $url = '/';
91             break;
92         case 'message':
93             $url = "/message/$url";
94             break;
95         case 'notes':
96             $url = "/notes/$url";
97             break;
98         case 'tag':
99             $url = "/tag/$url";
100             break;
101         case 'role':
102             $url = '/'.$url;
103             break;
104         default:
105             $url = "/mod/$module/$url";
106             break;
107     }
109     //now let's sanitise urls - there might be some ugly nasties:-(
110     $parts = explode('?', $url);
111     $script = array_shift($parts);
112     if (strpos($script, 'http') === 0) {
113         $script = clean_param($script, PARAM_URL);
114     } else {
115         $script = clean_param($script, PARAM_PATH);
116     }
118     $query = '';
119     if ($parts) {
120         $query = implode('', $parts);
121         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
122         $parts = explode('&', $query);
123         $eq = urlencode('=');
124         foreach ($parts as $key=>$part) {
125             $part = urlencode(urldecode($part));
126             $part = str_replace($eq, '=', $part);
127             $parts[$key] = $part;
128         }
129         $query = '?'.implode('&amp;', $parts);
130     }
132     return $script.$query;
136 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
137                    $modname="", $modid=0, $modaction="", $groupid=0) {
138     global $CFG, $DB;
140     // It is assumed that $date is the GMT time of midnight for that day,
141     // and so the next 86400 seconds worth of logs are printed.
143     /// Setup for group handling.
145     // TODO: I don't understand group/context/etc. enough to be able to do
146     // something interesting with it here
147     // What is the context of a remote course?
149     /// If the group mode is separate, and this user does not have editing privileges,
150     /// then only the user's group can be viewed.
151     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
152     //    $groupid = get_current_group($course->id);
153     //}
154     /// If this course doesn't have groups, no groupid can be specified.
155     //else if (!$course->groupmode) {
156     //    $groupid = 0;
157     //}
159     $groupid = 0;
161     $joins = array();
162     $where = '';
164     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
165               FROM {mnet_log} l
166                LEFT JOIN {user} u ON l.userid = u.id
167               WHERE ";
168     $params = array();
170     $where .= "l.hostid = :hostid";
171     $params['hostid'] = $hostid;
173     // TODO: Is 1 really a magic number referring to the sitename?
174     if ($course != SITEID || $modid != 0) {
175         $where .= " AND l.course=:courseid";
176         $params['courseid'] = $course;
177     }
179     if ($modname) {
180         $where .= " AND l.module = :modname";
181         $params['modname'] = $modname;
182     }
184     if ('site_errors' === $modid) {
185         $where .= " AND ( l.action='error' OR l.action='infected' )";
186     } else if ($modid) {
187         //TODO: This assumes that modids are the same across sites... probably
188         //not true
189         $where .= " AND l.cmid = :modid";
190         $params['modid'] = $modid;
191     }
193     if ($modaction) {
194         $firstletter = substr($modaction, 0, 1);
195         if ($firstletter == '-') {
196             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
197             $params['modaction'] = '%'.substr($modaction, 1).'%';
198         } else {
199             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
200             $params['modaction'] = '%'.$modaction.'%';
201         }
202     }
204     if ($user) {
205         $where .= " AND l.userid = :user";
206         $params['user'] = $user;
207     }
209     if ($date) {
210         $enddate = $date + 86400;
211         $where .= " AND l.time > :date AND l.time < :enddate";
212         $params['date'] = $date;
213         $params['enddate'] = $enddate;
214     }
216     $result = array();
217     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
218     if(!empty($result['totalcount'])) {
219         $where .= " ORDER BY $order";
220         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
221     } else {
222         $result['logs'] = array();
223     }
224     return $result;
227 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
228                    $modname="", $modid=0, $modaction="", $groupid=0) {
229     global $DB, $SESSION, $USER;
230     // It is assumed that $date is the GMT time of midnight for that day,
231     // and so the next 86400 seconds worth of logs are printed.
233     /// Setup for group handling.
235     /// If the group mode is separate, and this user does not have editing privileges,
236     /// then only the user's group can be viewed.
237     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
238         if (isset($SESSION->currentgroup[$course->id])) {
239             $groupid =  $SESSION->currentgroup[$course->id];
240         } else {
241             $groupid = groups_get_all_groups($course->id, $USER->id);
242             if (is_array($groupid)) {
243                 $groupid = array_shift(array_keys($groupid));
244                 $SESSION->currentgroup[$course->id] = $groupid;
245             } else {
246                 $groupid = 0;
247             }
248         }
249     }
250     /// If this course doesn't have groups, no groupid can be specified.
251     else if (!$course->groupmode) {
252         $groupid = 0;
253     }
255     $joins = array();
256     $params = array();
258     if ($course->id != SITEID || $modid != 0) {
259         $joins[] = "l.course = :courseid";
260         $params['courseid'] = $course->id;
261     }
263     if ($modname) {
264         $joins[] = "l.module = :modname";
265         $params['modname'] = $modname;
266     }
268     if ('site_errors' === $modid) {
269         $joins[] = "( l.action='error' OR l.action='infected' )";
270     } else if ($modid) {
271         $joins[] = "l.cmid = :modid";
272         $params['modid'] = $modid;
273     }
275     if ($modaction) {
276         $firstletter = substr($modaction, 0, 1);
277         if ($firstletter == '-') {
278             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
279             $params['modaction'] = '%'.substr($modaction, 1).'%';
280         } else {
281             $joins[] = $DB->sql_like('l.action', ':modaction', false);
282             $params['modaction'] = '%'.$modaction.'%';
283         }
284     }
287     /// Getting all members of a group.
288     if ($groupid and !$user) {
289         if ($gusers = groups_get_members($groupid)) {
290             $gusers = array_keys($gusers);
291             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
292         } else {
293             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
294         }
295     }
296     else if ($user) {
297         $joins[] = "l.userid = :userid";
298         $params['userid'] = $user;
299     }
301     if ($date) {
302         $enddate = $date + 86400;
303         $joins[] = "l.time > :date AND l.time < :enddate";
304         $params['date'] = $date;
305         $params['enddate'] = $enddate;
306     }
308     $selector = implode(' AND ', $joins);
310     $totalcount = 0;  // Initialise
311     $result = array();
312     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
313     $result['totalcount'] = $totalcount;
314     return $result;
318 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
319                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
321     global $CFG, $DB, $OUTPUT;
323     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
324                        $modname, $modid, $modaction, $groupid)) {
325         echo $OUTPUT->notification("No logs found!");
326         echo $OUTPUT->footer();
327         exit;
328     }
330     $courses = array();
332     if ($course->id == SITEID) {
333         $courses[0] = '';
334         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
335             foreach ($ccc as $cc) {
336                 $courses[$cc->id] = $cc->shortname;
337             }
338         }
339     } else {
340         $courses[$course->id] = $course->shortname;
341     }
343     $totalcount = $logs['totalcount'];
344     $count=0;
345     $ldcache = array();
346     $tt = getdate(time());
347     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
349     $strftimedatetime = get_string("strftimedatetime");
351     echo "<div class=\"info\">\n";
352     print_string("displayingrecords", "", $totalcount);
353     echo "</div>\n";
355     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
357     $table = new html_table();
358     $table->classes = array('logtable','generalbox');
359     $table->align = array('right', 'left', 'left');
360     $table->head = array(
361         get_string('time'),
362         get_string('ip_address'),
363         get_string('fullnameuser'),
364         get_string('action'),
365         get_string('info')
366     );
367     $table->data = array();
369     if ($course->id == SITEID) {
370         array_unshift($table->align, 'left');
371         array_unshift($table->head, get_string('course'));
372     }
374     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
375     if (empty($logs['logs'])) {
376         $logs['logs'] = array();
377     }
379     foreach ($logs['logs'] as $log) {
381         if (isset($ldcache[$log->module][$log->action])) {
382             $ld = $ldcache[$log->module][$log->action];
383         } else {
384             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
385             $ldcache[$log->module][$log->action] = $ld;
386         }
387         if ($ld && is_numeric($log->info)) {
388             // ugly hack to make sure fullname is shown correctly
389             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
390                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
391             } else {
392                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
393             }
394         }
396         //Filter log->info
397         $log->info = format_string($log->info);
399         // If $log->url has been trimmed short by the db size restriction
400         // code in add_to_log, keep a note so we don't add a link to a broken url
401         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
403         $row = array();
404         if ($course->id == SITEID) {
405             if (empty($log->course)) {
406                 $row[] = get_string('site');
407             } else {
408                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
409             }
410         }
412         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
414         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
415         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
417         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id))));
419         $displayaction="$log->module $log->action";
420         if ($brokenurl) {
421             $row[] = $displayaction;
422         } else {
423             $link = make_log_url($log->module,$log->url);
424             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
425         }
426         $row[] = $log->info;
427         $table->data[] = $row;
428     }
430     echo html_writer::table($table);
431     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
435 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
436                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
438     global $CFG, $DB, $OUTPUT;
440     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
441                        $modname, $modid, $modaction, $groupid)) {
442         echo $OUTPUT->notification("No logs found!");
443         echo $OUTPUT->footer();
444         exit;
445     }
447     if ($course->id == SITEID) {
448         $courses[0] = '';
449         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
450             foreach ($ccc as $cc) {
451                 $courses[$cc->id] = $cc->shortname;
452             }
453         }
454     }
456     $totalcount = $logs['totalcount'];
457     $count=0;
458     $ldcache = array();
459     $tt = getdate(time());
460     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
462     $strftimedatetime = get_string("strftimedatetime");
464     echo "<div class=\"info\">\n";
465     print_string("displayingrecords", "", $totalcount);
466     echo "</div>\n";
468     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
470     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
471     echo "<tr>";
472     if ($course->id == SITEID) {
473         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
474     }
475     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
476     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
477     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
478     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
479     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
480     echo "</tr>\n";
482     if (empty($logs['logs'])) {
483         echo "</table>\n";
484         return;
485     }
487     $row = 1;
488     foreach ($logs['logs'] as $log) {
490         $log->info = $log->coursename;
491         $row = ($row + 1) % 2;
493         if (isset($ldcache[$log->module][$log->action])) {
494             $ld = $ldcache[$log->module][$log->action];
495         } else {
496             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
497             $ldcache[$log->module][$log->action] = $ld;
498         }
499         if (0 && $ld && !empty($log->info)) {
500             // ugly hack to make sure fullname is shown correctly
501             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
502                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
503             } else {
504                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
505             }
506         }
508         //Filter log->info
509         $log->info = format_string($log->info);
511         echo '<tr class="r'.$row.'">';
512         if ($course->id == SITEID) {
513             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
514             echo "<td class=\"r$row c0\" >\n";
515             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
516             echo "</td>\n";
517         }
518         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
519              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
520         echo "<td class=\"r$row c2\" >\n";
521         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
522         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
523         echo "</td>\n";
524         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
525         echo "<td class=\"r$row c3\" >\n";
526         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
527         echo "</td>\n";
528         echo "<td class=\"r$row c4\">\n";
529         echo $log->action .': '.$log->module;
530         echo "</td>\n";
531         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
532         echo "</tr>\n";
533     }
534     echo "</table>\n";
536     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
540 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
541                         $modid, $modaction, $groupid) {
542     global $DB, $CFG;
544     require_once($CFG->libdir . '/csvlib.class.php');
546     $csvexporter = new csv_export_writer('tab');
548     $header = array();
549     $header[] = get_string('course');
550     $header[] = get_string('time');
551     $header[] = get_string('ip_address');
552     $header[] = get_string('fullnameuser');
553     $header[] = get_string('action');
554     $header[] = get_string('info');
556     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
557                        $modname, $modid, $modaction, $groupid)) {
558         return false;
559     }
561     $courses = array();
563     if ($course->id == SITEID) {
564         $courses[0] = '';
565         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
566             foreach ($ccc as $cc) {
567                 $courses[$cc->id] = $cc->shortname;
568             }
569         }
570     } else {
571         $courses[$course->id] = $course->shortname;
572     }
574     $count=0;
575     $ldcache = array();
576     $tt = getdate(time());
577     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
579     $strftimedatetime = get_string("strftimedatetime");
581     $csvexporter->set_filename('logs', '.txt');
582     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
583     $csvexporter->add_data($title);
584     $csvexporter->add_data($header);
586     if (empty($logs['logs'])) {
587         return true;
588     }
590     foreach ($logs['logs'] as $log) {
591         if (isset($ldcache[$log->module][$log->action])) {
592             $ld = $ldcache[$log->module][$log->action];
593         } else {
594             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
595             $ldcache[$log->module][$log->action] = $ld;
596         }
597         if ($ld && is_numeric($log->info)) {
598             // ugly hack to make sure fullname is shown correctly
599             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
600                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
601             } else {
602                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
603             }
604         }
606         //Filter log->info
607         $log->info = format_string($log->info);
608         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
610         $coursecontext = context_course::instance($course->id);
611         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
612         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
613         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
614         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
615         $csvexporter->add_data($row);
616     }
617     $csvexporter->download_file();
618     return true;
622 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
623                         $modid, $modaction, $groupid) {
625     global $CFG, $DB;
627     require_once("$CFG->libdir/excellib.class.php");
629     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
630                        $modname, $modid, $modaction, $groupid)) {
631         return false;
632     }
634     $courses = array();
636     if ($course->id == SITEID) {
637         $courses[0] = '';
638         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
639             foreach ($ccc as $cc) {
640                 $courses[$cc->id] = $cc->shortname;
641             }
642         }
643     } else {
644         $courses[$course->id] = $course->shortname;
645     }
647     $count=0;
648     $ldcache = array();
649     $tt = getdate(time());
650     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
652     $strftimedatetime = get_string("strftimedatetime");
654     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
655     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
656     $filename .= '.xls';
658     $workbook = new MoodleExcelWorkbook('-');
659     $workbook->send($filename);
661     $worksheet = array();
662     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
663                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
665     // Creating worksheets
666     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
667         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
668         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
669         $worksheet[$wsnumber]->set_column(1, 1, 30);
670         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
671                                     userdate(time(), $strftimedatetime));
672         $col = 0;
673         foreach ($headers as $item) {
674             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
675             $col++;
676         }
677     }
679     if (empty($logs['logs'])) {
680         $workbook->close();
681         return true;
682     }
684     $formatDate =& $workbook->add_format();
685     $formatDate->set_num_format(get_string('log_excel_date_format'));
687     $row = FIRSTUSEDEXCELROW;
688     $wsnumber = 1;
689     $myxls =& $worksheet[$wsnumber];
690     foreach ($logs['logs'] as $log) {
691         if (isset($ldcache[$log->module][$log->action])) {
692             $ld = $ldcache[$log->module][$log->action];
693         } else {
694             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
695             $ldcache[$log->module][$log->action] = $ld;
696         }
697         if ($ld && is_numeric($log->info)) {
698             // ugly hack to make sure fullname is shown correctly
699             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
700                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
701             } else {
702                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
703             }
704         }
706         // Filter log->info
707         $log->info = format_string($log->info);
708         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
710         if ($nroPages>1) {
711             if ($row > EXCELROWS) {
712                 $wsnumber++;
713                 $myxls =& $worksheet[$wsnumber];
714                 $row = FIRSTUSEDEXCELROW;
715             }
716         }
718         $coursecontext = context_course::instance($course->id);
720         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
721         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
722         $myxls->write($row, 2, $log->ip, '');
723         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
724         $myxls->write($row, 3, $fullname, '');
725         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
726         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
727         $myxls->write($row, 5, $log->info, '');
729         $row++;
730     }
732     $workbook->close();
733     return true;
736 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
737                         $modid, $modaction, $groupid) {
739     global $CFG, $DB;
741     require_once("$CFG->libdir/odslib.class.php");
743     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
744                        $modname, $modid, $modaction, $groupid)) {
745         return false;
746     }
748     $courses = array();
750     if ($course->id == SITEID) {
751         $courses[0] = '';
752         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
753             foreach ($ccc as $cc) {
754                 $courses[$cc->id] = $cc->shortname;
755             }
756         }
757     } else {
758         $courses[$course->id] = $course->shortname;
759     }
761     $count=0;
762     $ldcache = array();
763     $tt = getdate(time());
764     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
766     $strftimedatetime = get_string("strftimedatetime");
768     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
769     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
770     $filename .= '.ods';
772     $workbook = new MoodleODSWorkbook('-');
773     $workbook->send($filename);
775     $worksheet = array();
776     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
777                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
779     // Creating worksheets
780     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
781         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
782         $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
783         $worksheet[$wsnumber]->set_column(1, 1, 30);
784         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
785                                     userdate(time(), $strftimedatetime));
786         $col = 0;
787         foreach ($headers as $item) {
788             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
789             $col++;
790         }
791     }
793     if (empty($logs['logs'])) {
794         $workbook->close();
795         return true;
796     }
798     $formatDate =& $workbook->add_format();
799     $formatDate->set_num_format(get_string('log_excel_date_format'));
801     $row = FIRSTUSEDEXCELROW;
802     $wsnumber = 1;
803     $myxls =& $worksheet[$wsnumber];
804     foreach ($logs['logs'] as $log) {
805         if (isset($ldcache[$log->module][$log->action])) {
806             $ld = $ldcache[$log->module][$log->action];
807         } else {
808             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
809             $ldcache[$log->module][$log->action] = $ld;
810         }
811         if ($ld && is_numeric($log->info)) {
812             // ugly hack to make sure fullname is shown correctly
813             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
814                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
815             } else {
816                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
817             }
818         }
820         // Filter log->info
821         $log->info = format_string($log->info);
822         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
824         if ($nroPages>1) {
825             if ($row > EXCELROWS) {
826                 $wsnumber++;
827                 $myxls =& $worksheet[$wsnumber];
828                 $row = FIRSTUSEDEXCELROW;
829             }
830         }
832         $coursecontext = context_course::instance($course->id);
834         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
835         $myxls->write_date($row, 1, $log->time);
836         $myxls->write_string($row, 2, $log->ip);
837         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
838         $myxls->write_string($row, 3, $fullname);
839         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
840         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
841         $myxls->write_string($row, 5, $log->info);
843         $row++;
844     }
846     $workbook->close();
847     return true;
850 /**
851  * For a given course, returns an array of course activity objects
852  * Each item in the array contains he following properties:
853  */
854 function get_array_of_activities($courseid) {
855 //  cm - course module id
856 //  mod - name of the module (eg forum)
857 //  section - the number of the section (eg week or topic)
858 //  name - the name of the instance
859 //  visible - is the instance visible or not
860 //  groupingid - grouping id
861 //  groupmembersonly - is this instance visible to group members only
862 //  extra - contains extra string to include in any link
863     global $CFG, $DB;
864     if(!empty($CFG->enableavailability)) {
865         require_once($CFG->libdir.'/conditionlib.php');
866     }
868     $course = $DB->get_record('course', array('id'=>$courseid));
870     if (empty($course)) {
871         throw new moodle_exception('courseidnotfound');
872     }
874     $mod = array();
876     $rawmods = get_course_mods($courseid);
877     if (empty($rawmods)) {
878         return $mod; // always return array
879     }
881     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
882        foreach ($sections as $section) {
883            if (!empty($section->sequence)) {
884                $sequence = explode(",", $section->sequence);
885                foreach ($sequence as $seq) {
886                    if (empty($rawmods[$seq])) {
887                        continue;
888                    }
889                    $mod[$seq] = new stdClass();
890                    $mod[$seq]->id               = $rawmods[$seq]->instance;
891                    $mod[$seq]->cm               = $rawmods[$seq]->id;
892                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
894                     // Oh dear. Inconsistent names left here for backward compatibility.
895                    $mod[$seq]->section          = $section->section;
896                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
898                    $mod[$seq]->module           = $rawmods[$seq]->module;
899                    $mod[$seq]->added            = $rawmods[$seq]->added;
900                    $mod[$seq]->score            = $rawmods[$seq]->score;
901                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
902                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
903                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
904                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
905                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
906                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
907                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
908                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
909                    $mod[$seq]->extra            = "";
910                    $mod[$seq]->completiongradeitemnumber =
911                            $rawmods[$seq]->completiongradeitemnumber;
912                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
913                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
914                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
915                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
916                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
917                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
918                    if (!empty($CFG->enableavailability)) {
919                        condition_info::fill_availability_conditions($rawmods[$seq]);
920                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
921                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
922                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
923                    }
925                    $modname = $mod[$seq]->mod;
926                    $functionname = $modname."_get_coursemodule_info";
928                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
929                        continue;
930                    }
932                    include_once("$CFG->dirroot/mod/$modname/lib.php");
934                    if ($hasfunction = function_exists($functionname)) {
935                        if ($info = $functionname($rawmods[$seq])) {
936                            if (!empty($info->icon)) {
937                                $mod[$seq]->icon = $info->icon;
938                            }
939                            if (!empty($info->iconcomponent)) {
940                                $mod[$seq]->iconcomponent = $info->iconcomponent;
941                            }
942                            if (!empty($info->name)) {
943                                $mod[$seq]->name = $info->name;
944                            }
945                            if ($info instanceof cached_cm_info) {
946                                // When using cached_cm_info you can include three new fields
947                                // that aren't available for legacy code
948                                if (!empty($info->content)) {
949                                    $mod[$seq]->content = $info->content;
950                                }
951                                if (!empty($info->extraclasses)) {
952                                    $mod[$seq]->extraclasses = $info->extraclasses;
953                                }
954                                if (!empty($info->iconurl)) {
955                                    $mod[$seq]->iconurl = $info->iconurl;
956                                }
957                                if (!empty($info->onclick)) {
958                                    $mod[$seq]->onclick = $info->onclick;
959                                }
960                                if (!empty($info->customdata)) {
961                                    $mod[$seq]->customdata = $info->customdata;
962                                }
963                            } else {
964                                // When using a stdclass, the (horrible) deprecated ->extra field
965                                // is available for BC
966                                if (!empty($info->extra)) {
967                                    $mod[$seq]->extra = $info->extra;
968                                }
969                            }
970                        }
971                    }
972                    // When there is no modname_get_coursemodule_info function,
973                    // but showdescriptions is enabled, then we use the 'intro'
974                    // and 'introformat' fields in the module table
975                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
976                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
977                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
978                            // Set content from intro and introformat. Filters are disabled
979                            // because we  filter it with format_text at display time
980                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
981                                    $modvalues, $rawmods[$seq]->id, false);
983                            // To save making another query just below, put name in here
984                            $mod[$seq]->name = $modvalues->name;
985                        }
986                    }
987                    if (!isset($mod[$seq]->name)) {
988                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
989                    }
991                    // Minimise the database size by unsetting default options when they are
992                    // 'empty'. This list corresponds to code in the cm_info constructor.
993                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
994                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
995                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
996                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
997                            'completionview', 'completionexpected', 'score', 'showdescription')
998                            as $property) {
999                        if (property_exists($mod[$seq], $property) &&
1000                                empty($mod[$seq]->{$property})) {
1001                            unset($mod[$seq]->{$property});
1002                        }
1003                    }
1004                    // Special case: this value is usually set to null, but may be 0
1005                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1006                            is_null($mod[$seq]->completiongradeitemnumber)) {
1007                        unset($mod[$seq]->completiongradeitemnumber);
1008                    }
1009                }
1010             }
1011         }
1012     }
1013     return $mod;
1016 /**
1017  * Returns the localised human-readable names of all used modules
1018  *
1019  * @param bool $plural if true returns the plural forms of the names
1020  * @return array where key is the module name (component name without 'mod_') and
1021  *     the value is the human-readable string. Array sorted alphabetically by value
1022  */
1023 function get_module_types_names($plural = false) {
1024     static $modnames = null;
1025     global $DB, $CFG;
1026     if ($modnames === null) {
1027         $modnames = array(0 => array(), 1 => array());
1028         if ($allmods = $DB->get_records("modules")) {
1029             foreach ($allmods as $mod) {
1030                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1031                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1032                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1033                 }
1034             }
1035             collatorlib::asort($modnames[0]);
1036             collatorlib::asort($modnames[1]);
1037         }
1038     }
1039     return $modnames[(int)$plural];
1042 /**
1043  * Set highlighted section. Only one section can be highlighted at the time.
1044  *
1045  * @param int $courseid course id
1046  * @param int $marker highlight section with this number, 0 means remove higlightin
1047  * @return void
1048  */
1049 function course_set_marker($courseid, $marker) {
1050     global $DB;
1051     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1052     format_base::reset_course_cache($courseid);
1055 /**
1056  * For a given course section, marks it visible or hidden,
1057  * and does the same for every activity in that section
1058  *
1059  * @param int $courseid course id
1060  * @param int $sectionnumber The section number to adjust
1061  * @param int $visibility The new visibility
1062  * @return array A list of resources which were hidden in the section
1063  */
1064 function set_section_visible($courseid, $sectionnumber, $visibility) {
1065     global $DB;
1067     $resourcestotoggle = array();
1068     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1069         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1070         if (!empty($section->sequence)) {
1071             $modules = explode(",", $section->sequence);
1072             foreach ($modules as $moduleid) {
1073                 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1074                     if ($visibility) {
1075                         // As we unhide the section, we use the previously saved visibility stored in visibleold.
1076                         set_coursemodule_visible($moduleid, $cm->visibleold);
1077                     } else {
1078                         // We hide the section, so we hide the module but we store the original state in visibleold.
1079                         set_coursemodule_visible($moduleid, 0);
1080                         $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1081                     }
1082                 }
1083             }
1084         }
1085         rebuild_course_cache($courseid, true);
1087         // Determine which modules are visible for AJAX update
1088         if (!empty($modules)) {
1089             list($insql, $params) = $DB->get_in_or_equal($modules);
1090             $select = 'id ' . $insql . ' AND visible = ?';
1091             array_push($params, $visibility);
1092             if (!$visibility) {
1093                 $select .= ' AND visibleold = 1';
1094             }
1095             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1096         }
1097     }
1098     return $resourcestotoggle;
1101 /**
1102  * Retrieve all metadata for the requested modules
1103  *
1104  * @param object $course The Course
1105  * @param array $modnames An array containing the list of modules and their
1106  * names
1107  * @param int $sectionreturn The section to return to
1108  * @return array A list of stdClass objects containing metadata about each
1109  * module
1110  */
1111 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1112     global $CFG, $OUTPUT;
1114     // get_module_metadata will be called once per section on the page and courses may show
1115     // different modules to one another
1116     static $modlist = array();
1117     if (!isset($modlist[$course->id])) {
1118         $modlist[$course->id] = array();
1119     }
1121     $return = array();
1122     $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1123     if ($sectionreturn !== null) {
1124         $urlbase->param('sr', $sectionreturn);
1125     }
1126     foreach($modnames as $modname => $modnamestr) {
1127         if (!course_allowed_module($course, $modname)) {
1128             continue;
1129         }
1130         if (isset($modlist[$course->id][$modname])) {
1131             // This module is already cached
1132             $return[$modname] = $modlist[$course->id][$modname];
1133             continue;
1134         }
1136         // Include the module lib
1137         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1138         if (!file_exists($libfile)) {
1139             continue;
1140         }
1141         include_once($libfile);
1143         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1144         $gettypesfunc =  $modname.'_get_types';
1145         if (function_exists($gettypesfunc)) {
1146             if ($types = $gettypesfunc()) {
1147                 $group = new stdClass();
1148                 $group->name = $modname;
1149                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1150                 foreach($types as $type) {
1151                     if ($type->typestr === '--') {
1152                         continue;
1153                     }
1154                     if (strpos($type->typestr, '--') === 0) {
1155                         $group->title = str_replace('--', '', $type->typestr);
1156                         continue;
1157                     }
1158                     // Set the Sub Type metadata
1159                     $subtype = new stdClass();
1160                     $subtype->title = $type->typestr;
1161                     $subtype->type = str_replace('&amp;', '&', $type->type);
1162                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1163                     $subtype->archetype = $type->modclass;
1165                     // The group archetype should match the subtype archetypes and all subtypes
1166                     // should have the same archetype
1167                     $group->archetype = $subtype->archetype;
1169                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1170                         $subtype->help = get_string('help' . $subtype->name, $modname);
1171                     }
1172                     $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
1173                     $group->types[] = $subtype;
1174                 }
1175                 $modlist[$course->id][$modname] = $group;
1176             }
1177         } else {
1178             $module = new stdClass();
1179             $module->title = $modnamestr;
1180             $module->name = $modname;
1181             $module->link = new moodle_url($urlbase, array('add' => $modname));
1182             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1183             $sm = get_string_manager();
1184             if ($sm->string_exists('modulename_help', $modname)) {
1185                 $module->help = get_string('modulename_help', $modname);
1186                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1187                     $link = get_string('modulename_link', $modname);
1188                     $linktext = get_string('morehelp');
1189                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1190                 }
1191             }
1192             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1193             $modlist[$course->id][$modname] = $module;
1194         }
1195         $return[$modname] = $modlist[$course->id][$modname];
1196     }
1198     return $return;
1201 /**
1202  * Return the course category context for the category with id $categoryid, except
1203  * that if $categoryid is 0, return the system context.
1204  *
1205  * @param integer $categoryid a category id or 0.
1206  * @return object the corresponding context
1207  */
1208 function get_category_or_system_context($categoryid) {
1209     if ($categoryid) {
1210         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1211     } else {
1212         return context_system::instance();
1213     }
1216 /**
1217  * Gets the child categories of a given courses category. Uses a static cache
1218  * to make repeat calls efficient.
1219  *
1220  * @param int $parentid the id of a course category.
1221  * @return array all the child course categories.
1222  */
1223 function get_child_categories($parentid) {
1224     static $allcategories = null;
1226     // only fill in this variable the first time
1227     if (null == $allcategories) {
1228         $allcategories = array();
1230         $categories = get_categories();
1231         foreach ($categories as $category) {
1232             if (empty($allcategories[$category->parent])) {
1233                 $allcategories[$category->parent] = array();
1234             }
1235             $allcategories[$category->parent][] = $category;
1236         }
1237     }
1239     if (empty($allcategories[$parentid])) {
1240         return array();
1241     } else {
1242         return $allcategories[$parentid];
1243     }
1246 /**
1247  * This function recursively travels the categories, building up a nice list
1248  * for display. It also makes an array that list all the parents for each
1249  * category.
1250  *
1251  * For example, if you have a tree of categories like:
1252  *   Miscellaneous (id = 1)
1253  *      Subcategory (id = 2)
1254  *         Sub-subcategory (id = 4)
1255  *   Other category (id = 3)
1256  * Then after calling this function you will have
1257  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1258  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1259  *      3 => 'Other category');
1260  * $parents = array(2 => array(1), 4 => array(1, 2));
1261  *
1262  * If you specify $requiredcapability, then only categories where the current
1263  * user has that capability will be added to $list, although all categories
1264  * will still be added to $parents, and if you only have $requiredcapability
1265  * in a child category, not the parent, then the child catgegory will still be
1266  * included.
1267  *
1268  * If you specify the option $excluded, then that category, and all its children,
1269  * are omitted from the tree. This is useful when you are doing something like
1270  * moving categories, where you do not want to allow people to move a category
1271  * to be the child of itself.
1272  *
1273  * @param array $list For output, accumulates an array categoryid => full category path name
1274  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1275  * @param string/array $requiredcapability if given, only categories where the current
1276  *      user has this capability will be added to $list. Can also be an array of capabilities,
1277  *      in which case they are all required.
1278  * @param integer $excludeid Omit this category and its children from the lists built.
1279  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1280  * @param string $path For internal use, as part of recursive calls.
1281  */
1282 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1283         $excludeid = 0, $category = NULL, $path = "") {
1285     // initialize the arrays if needed
1286     if (!is_array($list)) {
1287         $list = array();
1288     }
1289     if (!is_array($parents)) {
1290         $parents = array();
1291     }
1293     if (empty($category)) {
1294         // Start at the top level.
1295         $category = new stdClass;
1296         $category->id = 0;
1297     } else {
1298         // This is the excluded category, don't include it.
1299         if ($excludeid > 0 && $excludeid == $category->id) {
1300             return;
1301         }
1303         $context = context_coursecat::instance($category->id);
1304         $categoryname = format_string($category->name, true, array('context' => $context));
1306         // Update $path.
1307         if ($path) {
1308             $path = $path.' / '.$categoryname;
1309         } else {
1310             $path = $categoryname;
1311         }
1313         // Add this category to $list, if the permissions check out.
1314         if (empty($requiredcapability)) {
1315             $list[$category->id] = $path;
1317         } else {
1318             $requiredcapability = (array)$requiredcapability;
1319             if (has_all_capabilities($requiredcapability, $context)) {
1320                 $list[$category->id] = $path;
1321             }
1322         }
1323     }
1325     // Add all the children recursively, while updating the parents array.
1326     if ($categories = get_child_categories($category->id)) {
1327         foreach ($categories as $cat) {
1328             if (!empty($category->id)) {
1329                 if (isset($parents[$category->id])) {
1330                     $parents[$cat->id]   = $parents[$category->id];
1331                 }
1332                 $parents[$cat->id][] = $category->id;
1333             }
1334             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1335         }
1336     }
1339 /**
1340  * This function generates a structured array of courses and categories.
1341  *
1342  * The depth of categories is limited by $CFG->maxcategorydepth however there
1343  * is no limit on the number of courses!
1344  *
1345  * Suitable for use with the course renderers course_category_tree method:
1346  * $renderer = $PAGE->get_renderer('core','course');
1347  * echo $renderer->course_category_tree(get_course_category_tree());
1348  *
1349  * @global moodle_database $DB
1350  * @param int $id
1351  * @param int $depth
1352  */
1353 function get_course_category_tree($id = 0, $depth = 0) {
1354     global $DB, $CFG;
1355     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
1356     $categories = get_child_categories($id);
1357     $categoryids = array();
1358     foreach ($categories as $key => &$category) {
1359         if (!$category->visible && !$viewhiddencats) {
1360             unset($categories[$key]);
1361             continue;
1362         }
1363         $categoryids[$category->id] = $category;
1364         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1365             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1366             foreach ($subcategories as $subid=>$subcat) {
1367                 $categoryids[$subid] = $subcat;
1368             }
1369             $category->courses = array();
1370         }
1371     }
1373     if ($depth > 0) {
1374         // This is a recursive call so return the required array
1375         return array($categories, $categoryids);
1376     }
1378     if (empty($categoryids)) {
1379         // No categories available (probably all hidden).
1380         return array();
1381     }
1383     // The depth is 0 this function has just been called so we can finish it off
1385     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1386     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1387     $sql = "SELECT
1388             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1389             $ccselect
1390             FROM {course} c
1391             $ccjoin
1392             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1393     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1394         // loop throught them
1395         foreach ($courses as $course) {
1396             if ($course->id == SITEID) {
1397                 continue;
1398             }
1399             context_instance_preload($course);
1400             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1401                 $categoryids[$course->category]->courses[$course->id] = $course;
1402             }
1403         }
1404     }
1405     return $categories;
1408 /**
1409  * Recursive function to print out all the categories in a nice format
1410  * with or without courses included
1411  */
1412 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1413     global $CFG;
1415     // maxcategorydepth == 0 meant no limit
1416     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1417         return;
1418     }
1420     if (!$displaylist) {
1421         make_categories_list($displaylist, $parentslist);
1422     }
1424     if (!$categorycourses) {
1425         if ($category) {
1426             $categorycourses = get_category_courses_array($category->id);
1427         } else {
1428             $categorycourses = get_category_courses_array();
1429         }
1430     }
1432     if ($category) {
1433         if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
1434             print_category_info($category, $depth, $showcourses, $categorycourses[$category->id]);
1435         } else {
1436             return;  // Don't bother printing children of invisible categories
1437         }
1439     } else {
1440         $category = new stdClass();
1441         $category->id = "0";
1442     }
1444     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
1445         $countcats = count($categories);
1446         $count = 0;
1447         $first = true;
1448         $last = false;
1449         foreach ($categories as $cat) {
1450             $count++;
1451             if ($count == $countcats) {
1452                 $last = true;
1453             }
1454             $up = $first ? false : true;
1455             $down = $last ? false : true;
1456             $first = false;
1458             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses, $categorycourses);
1459         }
1460     }
1463 /**
1464  * Gets an array whose keys are category ids and whose values are arrays of courses in the corresponding category.
1465  *
1466  * @param int $categoryid
1467  * @return array
1468  */
1469 function get_category_courses_array($categoryid = 0) {
1470     $tree = get_course_category_tree($categoryid);
1471     $flattened = array();
1472     foreach ($tree as $category) {
1473         get_category_courses_array_recursively($flattened, $category);
1474     }
1475     return $flattened;
1478 /**
1479  * Recursive function to help flatten the course category tree.
1480  *
1481  * Do not call this function directly, instead calll its parent function {@link get_category_courses_array}
1482  *
1483  * @param array &$flattened An array passed by reference in which to store courses for each category.
1484  * @param stdClass $category The category to get courses for.
1485  */
1486 function get_category_courses_array_recursively(array &$flattened, $category) {
1487     $flattened[$category->id] = $category->courses;
1488     foreach ($category->categories as $childcategory) {
1489         get_category_courses_array_recursively($flattened, $childcategory);
1490     }
1493 /**
1494  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
1495  */
1496 function make_categories_options() {
1497     make_categories_list($cats,$parents);
1498     foreach ($cats as $key => $value) {
1499         if (array_key_exists($key,$parents)) {
1500             if ($indent = count($parents[$key])) {
1501                 for ($i = 0; $i < $indent; $i++) {
1502                     $cats[$key] = '&nbsp;'.$cats[$key];
1503                 }
1504             }
1505         }
1506     }
1507     return $cats;
1510 /**
1511  * Prints the category information.
1512  *
1513  * This function is only used by print_whole_category_list() above
1514  *
1515  * @param stdClass $category
1516  * @param int $depth The depth of the category.
1517  * @param bool $showcourses If set to true course information will also be printed.
1518  * @param array|null $courses An array of courses belonging to the category, or null if you don't have it yet.
1519  */
1520 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1521     global $CFG, $DB, $OUTPUT;
1523     $strsummary = get_string('summary');
1525     $catlinkcss = null;
1526     if (!$category->visible) {
1527         $catlinkcss = array('class'=>'dimmed');
1528     }
1529     static $coursecount = null;
1530     if (null === $coursecount) {
1531         // only need to check this once
1532         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
1533     }
1535     if ($showcourses and $coursecount) {
1536         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
1537     } else {
1538         $catimage = "&nbsp;";
1539     }
1541     if (is_null($courses)) {
1542         $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
1543     }
1544     $context = context_coursecat::instance($category->id);
1545     $fullname = format_string($category->name, true, array('context' => $context));
1547     if ($showcourses and $coursecount) {
1548         echo '<div class="categorylist clearfix">';
1549         $cat = '';
1550         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
1551         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1552         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
1554         $html = '';
1555         if ($depth > 0) {
1556             for ($i=0; $i< $depth; $i++) {
1557                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
1558                 $cat = '';
1559             }
1560         } else {
1561             $html = $cat;
1562         }
1563         echo html_writer::tag('div', $html, array('class'=>'category'));
1564         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1566         // does the depth exceed maxcategorydepth
1567         // maxcategorydepth == 0 or unset meant no limit
1568         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
1569         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
1570             foreach ($courses as $course) {
1571                 $linkcss = null;
1572                 if (!$course->visible) {
1573                     $linkcss = array('class'=>'dimmed');
1574                 }
1576                 $coursename = get_course_display_name_for_list($course);
1577                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
1579                 // print enrol info
1580                 $courseicon = '';
1581                 if ($icons = enrol_get_course_info_icons($course)) {
1582                     foreach ($icons as $pix_icon) {
1583                         $courseicon = $OUTPUT->render($pix_icon);
1584                     }
1585                 }
1587                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
1589                 if ($course->summary) {
1590                     $link = new moodle_url('/course/info.php?id='.$course->id);
1591                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
1592                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
1593                         array('title'=>$strsummary));
1595                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
1596                 }
1598                 $html = '';
1599                 for ($i=0; $i <= $depth; $i++) {
1600                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
1601                     $coursecontent = '';
1602                 }
1603                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
1604             }
1605         }
1606         echo '</div>';
1607     } else {
1608         echo '<div class="categorylist">';
1609         $html = '';
1610         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
1611         if (count($courses) > 0) {
1612             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
1613         }
1615         if ($depth > 0) {
1616             for ($i=0; $i< $depth; $i++) {
1617                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
1618                 $cat = '';
1619             }
1620         } else {
1621             $html = $cat;
1622         }
1624         echo html_writer::tag('div', $html, array('class'=>'category'));
1625         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
1626         echo '</div>';
1627     }
1630 /**
1631  * Print the buttons relating to course requests.
1632  *
1633  * @param object $systemcontext the system context.
1634  */
1635 function print_course_request_buttons($systemcontext) {
1636     global $CFG, $DB, $OUTPUT;
1637     if (empty($CFG->enablecourserequests)) {
1638         return;
1639     }
1640     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
1641     /// Print a button to request a new course
1642         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
1643     }
1644     /// Print a button to manage pending requests
1645     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
1646         $disabled = !$DB->record_exists('course_request', array());
1647         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
1648     }
1651 /**
1652  * Does the user have permission to edit things in this category?
1653  *
1654  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1655  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1656  */
1657 function can_edit_in_category($categoryid = 0) {
1658     $context = get_category_or_system_context($categoryid);
1659     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1662 /**
1663  * Prints the turn editing on/off button on course/index.php or course/category.php.
1664  *
1665  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1666  * @return string HTML of the editing button, or empty string, if this user is not allowed
1667  *      to see it.
1668  */
1669 function update_category_button($categoryid = 0) {
1670     global $CFG, $PAGE, $OUTPUT;
1672     // Check permissions.
1673     if (!can_edit_in_category($categoryid)) {
1674         return '';
1675     }
1677     // Work out the appropriate action.
1678     if ($PAGE->user_is_editing()) {
1679         $label = get_string('turneditingoff');
1680         $edit = 'off';
1681     } else {
1682         $label = get_string('turneditingon');
1683         $edit = 'on';
1684     }
1686     // Generate the button HTML.
1687     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
1688     if ($categoryid) {
1689         $options['id'] = $categoryid;
1690         $page = 'category.php';
1691     } else {
1692         $page = 'index.php';
1693     }
1694     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
1697 /**
1698  * Print courses in category. If category is 0 then all courses are printed.
1699  * @param int|stdClass $category category object or id.
1700  * @return bool true if courses found and printed, else false.
1701  */
1702 function print_courses($category) {
1703     global $CFG, $OUTPUT;
1705     if (!is_object($category) && $category==0) {
1706         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
1707         if (is_array($categories) && count($categories) == 1) {
1708             $category   = array_shift($categories);
1709             $courses    = get_courses_wmanagers($category->id,
1710                                                 'c.sortorder ASC',
1711                                                 array('summary','summaryformat'));
1712         } else {
1713             $courses    = get_courses_wmanagers('all',
1714                                                 'c.sortorder ASC',
1715                                                 array('summary','summaryformat'));
1716         }
1717         unset($categories);
1718     } else {
1719         $courses    = get_courses_wmanagers($category->id,
1720                                             'c.sortorder ASC',
1721                                             array('summary','summaryformat'));
1722     }
1724     if ($courses) {
1725         echo html_writer::start_tag('ul', array('class'=>'unlist'));
1726         foreach ($courses as $course) {
1727             $coursecontext = context_course::instance($course->id);
1728             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
1729                 echo html_writer::start_tag('li');
1730                 print_course($course);
1731                 echo html_writer::end_tag('li');
1732             }
1733         }
1734         echo html_writer::end_tag('ul');
1735     } else {
1736         echo $OUTPUT->heading(get_string("nocoursesyet"));
1737         $context = context_system::instance();
1738         if (has_capability('moodle/course:create', $context)) {
1739             $options = array();
1740             if (!empty($category->id)) {
1741                 $options['category'] = $category->id;
1742             } else {
1743                 $options['category'] = $CFG->defaultrequestcategory;
1744             }
1745             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
1746             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
1747             echo html_writer::end_tag('div');
1748             return false;
1749         }
1750     }
1751     return true;
1754 /**
1755  * Print a description of a course, suitable for browsing in a list.
1756  *
1757  * @param object $course the course object.
1758  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
1759  */
1760 function print_course($course, $highlightterms = '') {
1761     global $CFG, $USER, $DB, $OUTPUT;
1763     $context = context_course::instance($course->id);
1765     // Rewrite file URLs so that they are correct
1766     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
1768     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
1769     echo html_writer::start_tag('div', array('class'=>'info'));
1770     echo html_writer::start_tag('h3', array('class'=>'name'));
1772     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
1774     $coursename = get_course_display_name_for_list($course);
1775     $linktext = highlight($highlightterms, format_string($coursename));
1776     $linkparams = array('title'=>get_string('entercourse'));
1777     if (empty($course->visible)) {
1778         $linkparams['class'] = 'dimmed';
1779     }
1780     echo html_writer::link($linkhref, $linktext, $linkparams);
1781     echo html_writer::end_tag('h3');
1783     /// first find all roles that are supposed to be displayed
1784     if (!empty($CFG->coursecontact)) {
1785         $managerroles = explode(',', $CFG->coursecontact);
1786         $rusers = array();
1788         if (!isset($course->managers)) {
1789             list($sort, $sortparams) = users_order_by_sql('u');
1790             $rusers = get_role_users($managerroles, $context, true,
1791                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
1792                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
1793                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
1794         } else {
1795             //  use the managers array if we have it for perf reasosn
1796             //  populate the datastructure like output of get_role_users();
1797             foreach ($course->managers as $manager) {
1798                 $user = clone($manager->user);
1799                 $user->roleid = $manager->roleid;
1800                 $user->rolename = $manager->rolename;
1801                 $user->roleshortname = $manager->roleshortname;
1802                 $user->rolecoursealias = $manager->rolecoursealias;
1803                 $rusers[$user->id] = $user;
1804             }
1805         }
1807         $namesarray = array();
1808         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
1809         foreach ($rusers as $ra) {
1810             if (isset($namesarray[$ra->id])) {
1811                 //  only display a user once with the higest sortorder role
1812                 continue;
1813             }
1815             $role = new stdClass();
1816             $role->id = $ra->roleid;
1817             $role->name = $ra->rolename;
1818             $role->shortname = $ra->roleshortname;
1819             $role->coursealias = $ra->rolecoursealias;
1820             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
1822             $fullname = fullname($ra, $canviewfullnames);
1823             $namesarray[$ra->id] = $rolename.': '.
1824                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
1825         }
1827         if (!empty($namesarray)) {
1828             echo html_writer::start_tag('ul', array('class'=>'teachers'));
1829             foreach ($namesarray as $name) {
1830                 echo html_writer::tag('li', $name);
1831             }
1832             echo html_writer::end_tag('ul');
1833         }
1834     }
1835     echo html_writer::end_tag('div'); // End of info div
1837     echo html_writer::start_tag('div', array('class'=>'summary'));
1838     $options = new stdClass();
1839     $options->noclean = true;
1840     $options->para = false;
1841     $options->overflowdiv = true;
1842     if (!isset($course->summaryformat)) {
1843         $course->summaryformat = FORMAT_MOODLE;
1844     }
1845     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
1846     if ($icons = enrol_get_course_info_icons($course)) {
1847         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
1848         foreach ($icons as $icon) {
1849             $icon->attributes["alt"] .= ": ". format_string($coursename, true, array('context'=>$context));
1850             echo $OUTPUT->render($icon);
1851         }
1852         echo html_writer::end_tag('div'); // End of enrolmenticons div
1853     }
1854     echo html_writer::end_tag('div'); // End of summary div
1855     echo html_writer::end_tag('div'); // End of coursebox div
1858 /**
1859  * Prints custom user information on the home page.
1860  * Over time this can include all sorts of information
1861  */
1862 function print_my_moodle() {
1863     global $USER, $CFG, $DB, $OUTPUT;
1865     if (!isloggedin() or isguestuser()) {
1866         print_error('nopermissions', '', '', 'See My Moodle');
1867     }
1869     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
1870     $rhosts   = array();
1871     $rcourses = array();
1872     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
1873         $rcourses = get_my_remotecourses($USER->id);
1874         $rhosts   = get_my_remotehosts();
1875     }
1877     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
1879         if (!empty($courses)) {
1880             echo '<ul class="unlist">';
1881             foreach ($courses as $course) {
1882                 if ($course->id == SITEID) {
1883                     continue;
1884                 }
1885                 echo '<li>';
1886                 print_course($course);
1887                 echo "</li>\n";
1888             }
1889             echo "</ul>\n";
1890         }
1892         // MNET
1893         if (!empty($rcourses)) {
1894             // at the IDP, we know of all the remote courses
1895             foreach ($rcourses as $course) {
1896                 print_remote_course($course, "100%");
1897             }
1898         } elseif (!empty($rhosts)) {
1899             // non-IDP, we know of all the remote servers, but not courses
1900             foreach ($rhosts as $host) {
1901                 print_remote_host($host, "100%");
1902             }
1903         }
1904         unset($course);
1905         unset($host);
1907         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
1908             echo "<table width=\"100%\"><tr><td align=\"center\">";
1909             print_course_search("", false, "short");
1910             echo "</td><td align=\"center\">";
1911             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
1912             echo "</td></tr></table>\n";
1913         }
1915     } else {
1916         if ($DB->count_records("course_categories") > 1) {
1917             echo $OUTPUT->box_start("categorybox");
1918             print_whole_category_list();
1919             echo $OUTPUT->box_end();
1920         } else {
1921             print_courses(0);
1922         }
1923     }
1927 function print_course_search($value="", $return=false, $format="plain") {
1928     global $CFG;
1929     static $count = 0;
1931     $count++;
1933     $id = 'coursesearch';
1935     if ($count > 1) {
1936         $id .= $count;
1937     }
1939     $strsearchcourses= get_string("searchcourses");
1941     if ($format == 'plain') {
1942         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
1943         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
1944         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
1945         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
1946         $output .= '<input type="submit" value="'.get_string('go').'" />';
1947         $output .= '</fieldset></form>';
1948     } else if ($format == 'short') {
1949         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
1950         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
1951         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
1952         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
1953         $output .= '<input type="submit" value="'.get_string('go').'" />';
1954         $output .= '</fieldset></form>';
1955     } else if ($format == 'navbar') {
1956         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
1957         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
1958         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
1959         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
1960         $output .= '<input type="submit" value="'.get_string('go').'" />';
1961         $output .= '</fieldset></form>';
1962     }
1964     if ($return) {
1965         return $output;
1966     }
1967     echo $output;
1970 function print_remote_course($course, $width="100%") {
1971     global $CFG, $USER;
1973     $linkcss = '';
1975     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
1977     echo '<div class="coursebox remotecoursebox clearfix">';
1978     echo '<div class="info">';
1979     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
1980          $linkcss.' href="'.$url.'">'
1981         .  format_string($course->fullname) .'</a><br />'
1982         . format_string($course->hostname) . ' : '
1983         . format_string($course->cat_name) . ' : '
1984         . format_string($course->shortname). '</div>';
1985     echo '</div><div class="summary">';
1986     $options = new stdClass();
1987     $options->noclean = true;
1988     $options->para = false;
1989     $options->overflowdiv = true;
1990     echo format_text($course->summary, $course->summaryformat, $options);
1991     echo '</div>';
1992     echo '</div>';
1995 function print_remote_host($host, $width="100%") {
1996     global $OUTPUT;
1998     $linkcss = '';
2000     echo '<div class="coursebox clearfix">';
2001     echo '<div class="info">';
2002     echo '<div class="name">';
2003     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2004     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2005         . s($host['name']).'</a> - ';
2006     echo $host['count'] . ' ' . get_string('courses');
2007     echo '</div>';
2008     echo '</div>';
2009     echo '</div>';
2013 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2015 function add_course_module($mod) {
2016     global $DB;
2018     $mod->added = time();
2019     unset($mod->id);
2021     $cmid = $DB->insert_record("course_modules", $mod);
2022     rebuild_course_cache($mod->course, true);
2023     return $cmid;
2026 /**
2027  * Creates missing course section(s) and rebuilds course cache
2028  *
2029  * @param int|stdClass $courseorid course id or course object
2030  * @param int|array $sections list of relative section numbers to create
2031  * @return bool if there were any sections created
2032  */
2033 function course_create_sections_if_missing($courseorid, $sections) {
2034     global $DB;
2035     if (!is_array($sections)) {
2036         $sections = array($sections);
2037     }
2038     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2039     if (is_object($courseorid)) {
2040         $courseorid = $courseorid->id;
2041     }
2042     $coursechanged = false;
2043     foreach ($sections as $sectionnum) {
2044         if (!in_array($sectionnum, $existing)) {
2045             $cw = new stdClass();
2046             $cw->course   = $courseorid;
2047             $cw->section  = $sectionnum;
2048             $cw->summary  = '';
2049             $cw->summaryformat = FORMAT_HTML;
2050             $cw->sequence = '';
2051             $id = $DB->insert_record("course_sections", $cw);
2052             $coursechanged = true;
2053         }
2054     }
2055     if ($coursechanged) {
2056         rebuild_course_cache($courseorid, true);
2057     }
2058     return $coursechanged;
2061 /**
2062  * Adds an existing module to the section
2063  *
2064  * Updates both tables {course_sections} and {course_modules}
2065  *
2066  * @param int|stdClass $courseorid course id or course object
2067  * @param int $cmid id of the module already existing in course_modules table
2068  * @param int $sectionnum relative number of the section (field course_sections.section)
2069  *     If section does not exist it will be created
2070  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2071  *     before which the module needs to be included. Null for inserting in the
2072  *     end of the section
2073  * @return int The course_sections ID where the module is inserted
2074  */
2075 function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
2076     global $DB, $COURSE;
2077     if (is_object($beforemod)) {
2078         $beforemod = $beforemod->id;
2079     }
2080     if (is_object($courseorid)) {
2081         $courseid = $courseorid->id;
2082     } else {
2083         $courseid = $courseorid;
2084     }
2085     course_create_sections_if_missing($courseorid, $sectionnum);
2086     // Do not try to use modinfo here, there is no guarantee it is valid!
2087     $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
2088     $modarray = explode(",", trim($section->sequence));
2089     if (empty($section->sequence)) {
2090         $newsequence = "$cmid";
2091     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2092         $insertarray = array($cmid, $beforemod);
2093         array_splice($modarray, $key[0], 1, $insertarray);
2094         $newsequence = implode(",", $modarray);
2095     } else {
2096         $newsequence = "$section->sequence,$cmid";
2097     }
2098     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2099     $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
2100     if (is_object($courseorid)) {
2101         rebuild_course_cache($courseorid->id, true);
2102     } else {
2103         rebuild_course_cache($courseorid, true);
2104     }
2105     return $section->id;     // Return course_sections ID that was used.
2108 function set_coursemodule_groupmode($id, $groupmode) {
2109     global $DB;
2110     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2111     if ($cm->groupmode != $groupmode) {
2112         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2113         rebuild_course_cache($cm->course, true);
2114     }
2115     return ($cm->groupmode != $groupmode);
2118 function set_coursemodule_idnumber($id, $idnumber) {
2119     global $DB;
2120     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2121     if ($cm->idnumber != $idnumber) {
2122         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2123         rebuild_course_cache($cm->course, true);
2124     }
2125     return ($cm->idnumber != $idnumber);
2128 /**
2129  * Set the visibility of a module and inherent properties.
2130  *
2131  * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
2132  * has been moved to {@link set_section_visible()} which was the only place from which
2133  * the parameter was used.
2134  *
2135  * @param int $id of the module
2136  * @param int $visible state of the module
2137  * @return bool false when the module was not found, true otherwise
2138  */
2139 function set_coursemodule_visible($id, $visible) {
2140     global $DB, $CFG;
2141     require_once($CFG->libdir.'/gradelib.php');
2143     // Trigger developer's attention when using the previously removed argument.
2144     if (func_num_args() > 2) {
2145         debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
2146             has been removed.', DEBUG_DEVELOPER);
2147     }
2149     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2150         return false;
2151     }
2152     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2153         return false;
2154     }
2155     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2156         foreach($events as $event) {
2157             if ($visible) {
2158                 show_event($event);
2159             } else {
2160                 hide_event($event);
2161             }
2162         }
2163     }
2165     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2166     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2167     if ($grade_items) {
2168         foreach ($grade_items as $grade_item) {
2169             $grade_item->set_hidden(!$visible);
2170         }
2171     }
2173     // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
2174     // affect visibleold to allow for an original visibility restore. See set_section_visible().
2175     $cminfo = new stdClass();
2176     $cminfo->id = $id;
2177     $cminfo->visible = $visible;
2178     $cminfo->visibleold = $visible;
2179     $DB->update_record('course_modules', $cminfo);
2181     rebuild_course_cache($cm->course, true);
2182     return true;
2185 /**
2186  * Delete a course module and any associated data at the course level (events)
2187  * Until 1.5 this function simply marked a deleted flag ... now it
2188  * deletes it completely.
2189  *
2190  */
2191 function delete_course_module($id) {
2192     global $CFG, $DB;
2193     require_once($CFG->libdir.'/gradelib.php');
2194     require_once($CFG->dirroot.'/blog/lib.php');
2196     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2197         return true;
2198     }
2199     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2200     //delete events from calendar
2201     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2202         foreach($events as $event) {
2203             delete_event($event->id);
2204         }
2205     }
2206     //delete grade items, outcome items and grades attached to modules
2207     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2208                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2209         foreach ($grade_items as $grade_item) {
2210             $grade_item->delete('moddelete');
2211         }
2212     }
2213     // Delete completion and availability data; it is better to do this even if the
2214     // features are not turned on, in case they were turned on previously (these will be
2215     // very quick on an empty table)
2216     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2217     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2218     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2219     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2220                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2222     delete_context(CONTEXT_MODULE, $cm->id);
2223     $DB->delete_records('course_modules', array('id'=>$cm->id));
2224     rebuild_course_cache($cm->course, true);
2225     return true;
2228 function delete_mod_from_section($modid, $sectionid) {
2229     global $DB;
2231     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2233         $modarray = explode(",", $section->sequence);
2235         if ($key = array_keys ($modarray, $modid)) {
2236             array_splice($modarray, $key[0], 1);
2237             $newsequence = implode(",", $modarray);
2238             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2239             rebuild_course_cache($section->course, true);
2240             return true;
2241         } else {
2242             return false;
2243         }
2245     }
2246     return false;
2249 /**
2250  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2251  *
2252  * @param object $course course object
2253  * @param int $section Section number (not id!!!)
2254  * @param int $move (-1 or 1)
2255  * @return boolean true if section moved successfully
2256  * @todo MDL-33379 remove this function in 2.5
2257  */
2258 function move_section($course, $section, $move) {
2259     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2261 /// Moves a whole course section up and down within the course
2262     global $USER;
2264     if (!$move) {
2265         return true;
2266     }
2268     $sectiondest = $section + $move;
2270     // compartibility with course formats using field 'numsections'
2271     $courseformatoptions = course_get_format($course)->get_format_options();
2272     if (array_key_exists('numsections', $courseformatoptions) &&
2273             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2274         return false;
2275     }
2277     $retval = move_section_to($course, $section, $sectiondest);
2278     return $retval;
2281 /**
2282  * Moves a section within a course, from a position to another.
2283  * Be very careful: $section and $destination refer to section number,
2284  * not id!.
2285  *
2286  * @param object $course
2287  * @param int $section Section number (not id!!!)
2288  * @param int $destination
2289  * @return boolean Result
2290  */
2291 function move_section_to($course, $section, $destination) {
2292 /// Moves a whole course section up and down within the course
2293     global $USER, $DB;
2295     if (!$destination && $destination != 0) {
2296         return true;
2297     }
2299     // compartibility with course formats using field 'numsections'
2300     $courseformatoptions = course_get_format($course)->get_format_options();
2301     if ((array_key_exists('numsections', $courseformatoptions) &&
2302             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
2303         return false;
2304     }
2306     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2307     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2308             'section ASC, id ASC', 'id, section')) {
2309         return false;
2310     }
2312     $movedsections = reorder_sections($sections, $section, $destination);
2314     // Update all sections. Do this in 2 steps to avoid breaking database
2315     // uniqueness constraint
2316     $transaction = $DB->start_delegated_transaction();
2317     foreach ($movedsections as $id => $position) {
2318         if ($sections[$id] !== $position) {
2319             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2320         }
2321     }
2322     foreach ($movedsections as $id => $position) {
2323         if ($sections[$id] !== $position) {
2324             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2325         }
2326     }
2328     // If we move the highlighted section itself, then just highlight the destination.
2329     // Adjust the higlighted section location if we move something over it either direction.
2330     if ($section == $course->marker) {
2331         course_set_marker($course->id, $destination);
2332     } elseif ($section > $course->marker && $course->marker >= $destination) {
2333         course_set_marker($course->id, $course->marker+1);
2334     } elseif ($section < $course->marker && $course->marker <= $destination) {
2335         course_set_marker($course->id, $course->marker-1);
2336     }
2338     $transaction->allow_commit();
2339     rebuild_course_cache($course->id, true);
2340     return true;
2343 /**
2344  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2345  * an original position number and a target position number, rebuilds the array so that the
2346  * move is made without any duplication of section positions.
2347  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2348  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2349  *
2350  * @param array $sections
2351  * @param int $origin_position
2352  * @param int $target_position
2353  * @return array
2354  */
2355 function reorder_sections($sections, $origin_position, $target_position) {
2356     if (!is_array($sections)) {
2357         return false;
2358     }
2360     // We can't move section position 0
2361     if ($origin_position < 1) {
2362         echo "We can't move section position 0";
2363         return false;
2364     }
2366     // Locate origin section in sections array
2367     if (!$origin_key = array_search($origin_position, $sections)) {
2368         echo "searched position not in sections array";
2369         return false; // searched position not in sections array
2370     }
2372     // Extract origin section
2373     $origin_section = $sections[$origin_key];
2374     unset($sections[$origin_key]);
2376     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2377     $found = false;
2378     $append_array = array();
2379     foreach ($sections as $id => $position) {
2380         if ($found) {
2381             $append_array[$id] = $position;
2382             unset($sections[$id]);
2383         }
2384         if ($position == $target_position) {
2385             if ($target_position < $origin_position) {
2386                 $append_array[$id] = $position;
2387                 unset($sections[$id]);
2388             }
2389             $found = true;
2390         }
2391     }
2393     // Append moved section
2394     $sections[$origin_key] = $origin_section;
2396     // Append rest of array (if applicable)
2397     if (!empty($append_array)) {
2398         foreach ($append_array as $id => $position) {
2399             $sections[$id] = $position;
2400         }
2401     }
2403     // Renumber positions
2404     $position = 0;
2405     foreach ($sections as $id => $p) {
2406         $sections[$id] = $position;
2407         $position++;
2408     }
2410     return $sections;
2414 /**
2415  * Move the module object $mod to the specified $section
2416  * If $beforemod exists then that is the module
2417  * before which $modid should be inserted
2418  * All parameters are objects
2419  */
2420 function moveto_module($mod, $section, $beforemod=NULL) {
2421     global $OUTPUT;
2423 /// Remove original module from original section
2424     if (! delete_mod_from_section($mod->id, $mod->section)) {
2425         echo $OUTPUT->notification("Could not delete module from existing section");
2426     }
2428     // if moving to a hidden section then hide module
2429     if (!$section->visible && $mod->visible) {
2430         set_coursemodule_visible($mod->id, 0);
2431     }
2433 /// Add the module into the new section
2434     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
2435     return true;
2438 /**
2439  * Returns the list of all editing actions that current user can perform on the module
2440  *
2441  * @param cm_info $mod The module to produce editing buttons for
2442  * @param int $indent The current indenting (default -1 means no move left-right actions)
2443  * @param int $sr The section to link back to (used for creating the links)
2444  * @return array array of action_link or pix_icon objects
2445  */
2446 function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2447     global $COURSE, $SITE;
2449     static $str;
2451     $coursecontext = context_course::instance($mod->course);
2452     $modcontext = context_module::instance($mod->id);
2454     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2455     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2457     // no permission to edit anything
2458     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
2459         return array();
2460     }
2462     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2464     if (!isset($str)) {
2465         $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
2466             'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
2467         $str->assign         = get_string('assignroles', 'role');
2468         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2469         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2470         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
2471         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
2472         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
2473         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
2474     }
2476     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2478     if ($sr !== null) {
2479         $baseurl->param('sr', $sr);
2480     }
2481     $actions = array();
2483     // AJAX edit title
2484     if ($mod->modname !== 'label' && $hasmanageactivities &&
2485                 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
2486                  ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
2487         // we will not display link if we are on some other-course page (where we should not see this module anyway)
2488         $actions['title'] = new action_link(
2489             new moodle_url($baseurl, array('update' => $mod->id)),
2490             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2491             null,
2492             array('class' => 'editing_title', 'title' => $str->edittitle)
2493         );
2494     }
2496     // leftright
2497     if ($hasmanageactivities) {
2498         if (right_to_left()) {   // Exchange arrows on RTL
2499             $rightarrow = 't/left';
2500             $leftarrow  = 't/right';
2501         } else {
2502             $rightarrow = 't/right';
2503             $leftarrow  = 't/left';
2504         }
2506         if ($indent > 0) {
2507             $actions['moveleft'] = new action_link(
2508                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
2509                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2510                 null,
2511                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
2512             );
2513         }
2514         if ($indent >= 0) {
2515             $actions['moveright'] = new action_link(
2516                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2517                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2518                 null,
2519                 array('class' => 'editing_moveright', 'title' => $str->moveright)
2520             );
2521         }
2522     }
2524     // move
2525     if ($hasmanageactivities) {
2526         $actions['move'] = new action_link(
2527             new moodle_url($baseurl, array('copy' => $mod->id)),
2528             new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2529             null,
2530             array('class' => 'editing_move', 'title' => $str->move)
2531         );
2532     }
2534     // Update
2535     if ($hasmanageactivities) {
2536         $actions['update'] = new action_link(
2537             new moodle_url($baseurl, array('update' => $mod->id)),
2538             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2539             null,
2540             array('class' => 'editing_update', 'title' => $str->update)
2541         );
2542     }
2544     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
2545     // note that restoring on front page is never allowed
2546     if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
2547             plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
2548         $actions['duplicate'] = new action_link(
2549             new moodle_url($baseurl, array('duplicate' => $mod->id)),
2550             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2551             null,
2552             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
2553         );
2554     }
2556     // Delete
2557     if ($hasmanageactivities) {
2558         $actions['delete'] = new action_link(
2559             new moodle_url($baseurl, array('delete' => $mod->id)),
2560             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2561             null,
2562             array('class' => 'editing_delete', 'title' => $str->delete)
2563         );
2564     }
2566     // hideshow
2567     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2568         if ($mod->visible) {
2569             $actions['hide'] = new action_link(
2570                 new moodle_url($baseurl, array('hide' => $mod->id)),
2571                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2572                 null,
2573                 array('class' => 'editing_hide', 'title' => $str->hide)
2574             );
2575         } else {
2576             $actions['show'] = new action_link(
2577                 new moodle_url($baseurl, array('show' => $mod->id)),
2578                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2579                 null,
2580                 array('class' => 'editing_show', 'title' => $str->show)
2581             );
2582         }
2583     }
2585     // groupmode
2586     if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2587         if ($mod->coursegroupmodeforce) {
2588             $modgroupmode = $mod->coursegroupmode;
2589         } else {
2590             $modgroupmode = $mod->groupmode;
2591         }
2592         if ($modgroupmode == SEPARATEGROUPS) {
2593             $groupmode = NOGROUPS;
2594             $grouptitle = $str->groupsseparate;
2595             $forcedgrouptitle = $str->forcedgroupsseparate;
2596             $actionname = 'groupsseparate';
2597             $groupimage = 't/groups';
2598         } else if ($modgroupmode == VISIBLEGROUPS) {
2599             $groupmode = SEPARATEGROUPS;
2600             $grouptitle = $str->groupsvisible;
2601             $forcedgrouptitle = $str->forcedgroupsvisible;
2602             $actionname = 'groupsvisible';
2603             $groupimage = 't/groupv';
2604         } else {
2605             $groupmode = VISIBLEGROUPS;
2606             $grouptitle = $str->groupsnone;
2607             $forcedgrouptitle = $str->forcedgroupsnone;
2608             $actionname = 'groupsnone';
2609             $groupimage = 't/groupn';
2610         }
2611         if (!$mod->coursegroupmodeforce) {
2612             $actions[$actionname] = new action_link(
2613                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
2614                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2615                 null,
2616                 array('class' => 'editing_'. $actionname, 'title' => $grouptitle)
2617             );
2618         } else {
2619             $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
2620         }
2621     }
2623     // Assign
2624     if (has_capability('moodle/role:assign', $modcontext)){
2625         $actions['assign'] = new action_link(
2626             new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
2627             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2628             null,
2629             array('class' => 'editing_assign', 'title' => $str->assign)
2630         );
2631     }
2633     return $actions;
2636 /**
2637  * given a course object with shortname & fullname, this function will
2638  * truncate the the number of chars allowed and add ... if it was too long
2639  */
2640 function course_format_name ($course,$max=100) {
2642     $context = context_course::instance($course->id);
2643     $shortname = format_string($course->shortname, true, array('context' => $context));
2644     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2645     $str = $shortname.': '. $fullname;
2646     if (textlib::strlen($str) <= $max) {
2647         return $str;
2648     }
2649     else {
2650         return textlib::substr($str,0,$max-3).'...';
2651     }
2654 /**
2655  * Is the user allowed to add this type of module to this course?
2656  * @param object $course the course settings. Only $course->id is used.
2657  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2658  * @return bool whether the current user is allowed to add this type of module to this course.
2659  */
2660 function course_allowed_module($course, $modname) {
2661     if (is_numeric($modname)) {
2662         throw new coding_exception('Function course_allowed_module no longer
2663                 supports numeric module ids. Please update your code to pass the module name.');
2664     }
2666     $capability = 'mod/' . $modname . ':addinstance';
2667     if (!get_capability_info($capability)) {
2668         // Debug warning that the capability does not exist, but no more than once per page.
2669         static $warned = array();
2670         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2671         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2672             debugging('The module ' . $modname . ' does not define the standard capability ' .
2673                     $capability , DEBUG_DEVELOPER);
2674             $warned[$modname] = 1;
2675         }
2677         // If the capability does not exist, the module can always be added.
2678         return true;
2679     }
2681     $coursecontext = context_course::instance($course->id);
2682     return has_capability($capability, $coursecontext);
2685 /**
2686  * Recursively delete category including all subcategories and courses.
2687  * @param stdClass $category
2688  * @param boolean $showfeedback display some notices
2689  * @return array return deleted courses
2690  */
2691 function category_delete_full($category, $showfeedback=true) {
2692     global $CFG, $DB;
2693     require_once($CFG->libdir.'/gradelib.php');
2694     require_once($CFG->libdir.'/questionlib.php');
2695     require_once($CFG->dirroot.'/cohort/lib.php');
2697     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
2698         foreach ($children as $childcat) {
2699             category_delete_full($childcat, $showfeedback);
2700         }
2701     }
2703     $deletedcourses = array();
2704     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
2705         foreach ($courses as $course) {
2706             if (!delete_course($course, false)) {
2707                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
2708             }
2709             $deletedcourses[] = $course;
2710         }
2711     }
2713     // move or delete cohorts in this context
2714     cohort_delete_category($category);
2716     // now delete anything that may depend on course category context
2717     grade_course_category_delete($category->id, 0, $showfeedback);
2718     if (!question_delete_course_category($category, 0, $showfeedback)) {
2719         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
2720     }
2722     // finally delete the category and it's context
2723     $DB->delete_records('course_categories', array('id'=>$category->id));
2724     delete_context(CONTEXT_COURSECAT, $category->id);
2726     events_trigger('course_category_deleted', $category);
2728     return $deletedcourses;
2731 /**
2732  * Delete category, but move contents to another category.
2733  * @param object $ccategory
2734  * @param int $newparentid category id
2735  * @return bool status
2736  */
2737 function category_delete_move($category, $newparentid, $showfeedback=true) {
2738     global $CFG, $DB, $OUTPUT;
2739     require_once($CFG->libdir.'/gradelib.php');
2740     require_once($CFG->libdir.'/questionlib.php');
2741     require_once($CFG->dirroot.'/cohort/lib.php');
2743     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
2744         return false;
2745     }
2747     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
2748         foreach ($children as $childcat) {
2749             move_category($childcat, $newparentcat);
2750         }
2751     }
2753     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
2754         if (!move_courses(array_keys($courses), $newparentid)) {
2755             if ($showfeedback) {
2756                 echo $OUTPUT->notification("Error moving courses");
2757             }
2758             return false;
2759         }
2760         if ($showfeedback) {
2761             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
2762         }
2763     }
2765     // move or delete cohorts in this context
2766     cohort_delete_category($category);
2768     // now delete anything that may depend on course category context
2769     grade_course_category_delete($category->id, $newparentid, $showfeedback);
2770     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
2771         if ($showfeedback) {
2772             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
2773         }
2774         return false;
2775     }
2777     // finally delete the category and it's context
2778     $DB->delete_records('course_categories', array('id'=>$category->id));
2779     delete_context(CONTEXT_COURSECAT, $category->id);
2781     events_trigger('course_category_deleted', $category);
2783     if ($showfeedback) {
2784         echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
2785     }
2786     return true;
2789 /**
2790  * Efficiently moves many courses around while maintaining
2791  * sortorder in order.
2792  *
2793  * @param array $courseids is an array of course ids
2794  * @param int $categoryid
2795  * @return bool success
2796  */
2797 function move_courses($courseids, $categoryid) {
2798     global $CFG, $DB, $OUTPUT;
2800     if (empty($courseids)) {
2801         // nothing to do
2802         return;
2803     }
2805     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
2806         return false;
2807     }
2809     $courseids = array_reverse($courseids);
2810     $newparent = context_coursecat::instance($category->id);
2811     $i = 1;
2813     foreach ($courseids as $courseid) {
2814         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
2815             $course = new stdClass();
2816             $course->id = $courseid;
2817             $course->category  = $category->id;
2818             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2819             if ($category->visible == 0) {
2820                 // hide the course when moving into hidden category,
2821                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
2822                 $course->visible = 0;
2823             }
2825             $DB->update_record('course', $course);
2827             $context   = context_course::instance($course->id);
2828             context_moved($context, $newparent);
2829         }
2830     }
2831     fix_course_sortorder();
2833     return true;
2836 /**
2837  * Hide course category and child course and subcategories
2838  * @param stdClass $category
2839  * @return void
2840  */
2841 function course_category_hide($category) {
2842     global $DB;
2844     $category->visible = 0;
2845     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
2846     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
2847     $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
2848     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
2849     // get all child categories and hide too
2850     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
2851         foreach ($subcats as $cat) {
2852             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
2853             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
2854             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
2855             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
2856         }
2857     }
2860 /**
2861  * Show course category and child course and subcategories
2862  * @param stdClass $category
2863  * @return void
2864  */
2865 function course_category_show($category) {
2866     global $DB;
2868     $category->visible = 1;
2869     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
2870     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
2871     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
2872     // get all child categories and unhide too
2873     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
2874         foreach ($subcats as $cat) {
2875             if ($cat->visibleold) {
2876                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
2877             }
2878             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
2879         }
2880     }
2883 /**
2884  * Efficiently moves a category - NOTE that this can have
2885  * a huge impact access-control-wise...
2886  */
2887 function move_category($category, $newparentcat) {
2888     global $CFG, $DB;
2890     $context = context_coursecat::instance($category->id);
2892     $hidecat = false;
2893     if (empty($newparentcat->id)) {
2894         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
2896         $newparent = context_system::instance();
2898     } else {
2899         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
2900         $newparent = context_coursecat::instance($newparentcat->id);
2902         if (!$newparentcat->visible and $category->visible) {
2903             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
2904             $hidecat = true;
2905         }
2906     }
2908     context_moved($context, $newparent);
2910     // now make it last in new category
2911     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
2913     // and fix the sortorders
2914     fix_course_sortorder();
2916     if ($hidecat) {
2917         course_category_hide($category);
2918     }
2921 /**
2922  * Returns the display name of the given section that the course prefers
2923  *
2924  * Implementation of this function is provided by course format
2925  * @see format_base::get_section_name()
2926  *
2927  * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2928  * @param int|stdClass $section Section object from database or just field course_sections.section
2929  * @return string Display name that the course format prefers, e.g. "Week 2"
2930  */
2931 function get_section_name($courseorid, $section) {
2932     return course_get_format($courseorid)->get_section_name($section);
2935 /**
2936  * Tells if current course format uses sections
2937  *
2938  * @param string $format Course format ID e.g. 'weeks' $course->format
2939  * @return bool
2940  */
2941 function course_format_uses_sections($format) {
2942     $course = new stdClass();
2943     $course->format = $format;
2944     return course_get_format($course)->uses_sections();
2947 /**
2948  * Returns the information about the ajax support in the given source format
2949  *
2950  * The returned object's property (boolean)capable indicates that
2951  * the course format supports Moodle course ajax features.
2952  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
2953  *
2954  * @param string $format
2955  * @return stdClass
2956  */
2957 function course_format_ajax_support($format) {
2958     $course = new stdClass();
2959     $course->format = $format;
2960     return course_get_format($course)->supports_ajax();
2963 /**
2964  * Can the current user delete this course?
2965  * Course creators have exception,
2966  * 1 day after the creation they can sill delete the course.
2967  * @param int $courseid
2968  * @return boolean
2969  */
2970 function can_delete_course($courseid) {
2971     global $USER, $DB;
2973     $context = context_course::instance($courseid);
2975     if (has_capability('moodle/course:delete', $context)) {
2976         return true;
2977     }
2979     // hack: now try to find out if creator created this course recently (1 day)
2980     if (!has_capability('moodle/course:create', $context)) {
2981         return false;
2982     }
2984     $since = time() - 60*60*24;
2986     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
2987     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
2989     return $DB->record_exists_select('log', $select, $params);
2992 /**
2993  * Save the Your name for 'Some role' strings.
2994  *
2995  * @param integer $courseid the id of this course.
2996  * @param array $data the data that came from the course settings form.
2997  */
2998 function save_local_role_names($courseid, $data) {
2999     global $DB;
3000     $context = context_course::instance($courseid);
3002     foreach ($data as $fieldname => $value) {
3003         if (strpos($fieldname, 'role_') !== 0) {
3004             continue;
3005         }
3006         list($ignored, $roleid) = explode('_', $fieldname);
3008         // make up our mind whether we want to delete, update or insert
3009         if (!$value) {
3010             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3012         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3013             $rolename->name = $value;
3014             $DB->update_record('role_names', $rolename);
3016         } else {
3017             $rolename = new stdClass;
3018             $rolename->contextid = $context->id;
3019             $rolename->roleid = $roleid;
3020             $rolename->name = $value;
3021             $DB->insert_record('role_names', $rolename);
3022         }
3023     }
3026 /**
3027  * Create a course and either return a $course object
3028  *
3029  * Please note this functions does not verify any access control,
3030  * the calling code is responsible for all validation (usually it is the form definition).
3031  *
3032  * @param array $editoroptions course description editor options
3033  * @param object $data  - all the data needed for an entry in the 'course' table
3034  * @return object new course instance
3035  */
3036 function create_course($data, $editoroptions = NULL) {
3037     global $CFG, $DB;
3039     //check the categoryid - must be given for all new courses
3040     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3042     //check if the shortname already exist
3043     if (!empty($data->shortname)) {
3044         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3045             throw new moodle_exception('shortnametaken');
3046         }
3047     }
3049     //check if the id number already exist
3050     if (!empty($data->idnumber)) {
3051         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3052             throw new moodle_exception('idnumbertaken');
3053         }
3054     }
3056     $data->timecreated  = time();
3057     $data->timemodified = $data->timecreated;
3059     // place at beginning of any category
3060     $data->sortorder = 0;
3062     if ($editoroptions) {
3063         // summary text is updated later, we need context to store the files first
3064         $data->summary = '';
3065         $data->summary_format = FORMAT_HTML;
3066     }
3068     if (!isset($data->visible)) {
3069         // data not from form, add missing visibility info
3070         $data->visible = $category->visible;
3071     }
3072     $data->visibleold = $data->visible;
3074     $newcourseid = $DB->insert_record('course', $data);
3075     $context = context_course::instance($newcourseid, MUST_EXIST);
3077     if ($editoroptions) {
3078         // Save the files used in the summary editor and store
3079         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3080         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3081         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3082     }
3084     // update course format options
3085     course_get_format($newcourseid)->update_course_format_options($data);
3087     $course = course_get_format($newcourseid)->get_course();
3089     // Setup the blocks
3090     blocks_add_default_course_blocks($course);
3092     // Create a default section.
3093     course_create_sections_if_missing($course, 0);
3095     fix_course_sortorder();
3097     // new context created - better mark it as dirty
3098     mark_context_dirty($context->path);
3100     // Save any custom role names.
3101     save_local_role_names($course->id, (array)$data);
3103     // set up enrolments
3104     enrol_course_updated(true, $course, $data);
3106     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3108     // Trigger events
3109     events_trigger('course_created', $course);
3111     return $course;
3114 /**
3115  * Create a new course category and marks the context as dirty
3116  *
3117  * This function does not set the sortorder for the new category and
3118  * @see{fix_course_sortorder} should be called after creating a new course
3119  * category
3120  *
3121  * Please note that this function does not verify access control.
3122  *
3123  * @param object $category All of the data required for an entry in the course_categories table
3124  * @return object new course category
3125  */
3126 function create_course_category($category) {
3127     global $DB;
3129     $category->timemodified = time();
3130     $category->id = $DB->insert_record('course_categories', $category);
3131     $category = $DB->get_record('course_categories', array('id' => $category->id));
3133     // We should mark the context as dirty
3134     $category->context = context_coursecat::instance($category->id);
3135     $category->context->mark_dirty();
3137     return $category;
3140 /**
3141  * Update a course.
3142  *
3143  * Please note this functions does not verify any access control,
3144  * the calling code is responsible for all validation (usually it is the form definition).
3145  *
3146  * @param object $data  - all the data needed for an entry in the 'course' table
3147  * @param array $editoroptions course description editor options
3148  * @return void
3149  */
3150 function update_course($data, $editoroptions = NULL) {
3151     global $CFG, $DB;
3153     $data->timemodified = time();
3155     $oldcourse = course_get_format($data->id)->get_course();
3156     $context   = context_course::instance($oldcourse->id);
3158     if ($editoroptions) {
3159         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3160     }
3162     if (!isset($data->category) or empty($data->category)) {
3163         // prevent nulls and 0 in category field
3164         unset($data->category);
3165     }
3166     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3168     if (!isset($data->visible)) {
3169         // data not from form, add missing visibility info
3170         $data->visible = $oldcourse->visible;
3171     }
3173     if ($data->visible != $oldcourse->visible) {
3174         // reset the visibleold flag when manually hiding/unhiding course
3175         $data->visibleold = $data->visible;
3176     } else {
3177         if ($movecat) {
3178             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3179             if (empty($newcategory->visible)) {
3180                 // make sure when moving into hidden category the course is hidden automatically
3181                 $data->visible = 0;
3182             }
3183         }
3184     }
3186     // Update with the new data
3187     $DB->update_record('course', $data);
3188     // make sure the modinfo cache is reset
3189     rebuild_course_cache($data->id);
3191     // update course format options with full course data
3192     course_get_format($data->id)->update_course_format_options($data, $oldcourse);
3194     $course = $DB->get_record('course', array('id'=>$data->id));
3196     if ($movecat) {
3197         $newparent = context_coursecat::instance($course->category);
3198         context_moved($context, $newparent);
3199     }
3201     fix_course_sortorder();
3203     // Test for and remove blocks which aren't appropriate anymore
3204     blocks_remove_inappropriate($course);
3206     // Save any custom role names.
3207     save_local_role_names($course->id, $data);
3209     // update enrol settings
3210     enrol_course_updated(false, $course, $data);
3212     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
3214     // Trigger events
3215     events_trigger('course_updated', $course);
3217     if ($oldcourse->format !== $course->format) {
3218         // Remove all options stored for the previous format
3219         // We assume that new course format migrated everything it needed watching trigger
3220         // 'course_updated' and in method format_XXX::update_course_format_options()
3221         $DB->delete_records('course_format_options',
3222                 array('courseid' => $course->id, 'format' => $oldcourse->format));
3223     }
3226 /**
3227  * Average number of participants
3228  * @return integer
3229  */
3230 function average_number_of_participants() {
3231     global $DB, $SITE;
3233     //count total of enrolments for visible course (except front page)
3234     $sql = 'SELECT COUNT(*) FROM (
3235         SELECT DISTINCT ue.userid, e.courseid
3236         FROM {user_enrolments} ue, {enrol} e, {course} c
3237         WHERE ue.enrolid = e.id
3238             AND e.courseid <> :siteid
3239             AND c.id = e.courseid
3240             AND c.visible = 1) total';
3241     $params = array('siteid' => $SITE->id);
3242     $enrolmenttotal = $DB->count_records_sql($sql, $params);
3245     //count total of visible courses (minus front page)
3246     $coursetotal = $DB->count_records('course', array('visible' => 1));
3247     $coursetotal = $coursetotal - 1 ;
3249     //average of enrolment
3250     if (empty($coursetotal)) {
3251         $participantaverage = 0;
3252     } else {
3253         $participantaverage = $enrolmenttotal / $coursetotal;
3254     }
3256     return $participantaverage;
3259 /**
3260  * Average number of course modules
3261  * @return integer
3262  */
3263 function average_number_of_courses_modules() {
3264     global $DB, $SITE;
3266     //count total of visible course module (except front page)
3267     $sql = 'SELECT COUNT(*) FROM (
3268         SELECT cm.course, cm.module
3269         FROM {course} c, {course_modules} cm
3270         WHERE c.id = cm.course
3271             AND c.id <> :siteid
3272             AND cm.visible = 1
3273             AND c.visible = 1) total';
3274     $params = array('siteid' => $SITE->id);
3275     $moduletotal = $DB->count_records_sql($sql, $params);
3278     //count total of visible courses (minus front page)
3279     $coursetotal = $DB->count_records('course', array('visible' => 1));
3280     $coursetotal = $coursetotal - 1 ;
3282     //average of course module
3283     if (empty($coursetotal)) {
3284         $coursemoduleaverage = 0;
3285     } else {
3286         $coursemoduleaverage = $moduletotal / $coursetotal;
3287     }
3289     return $coursemoduleaverage;
3292 /**
3293  * This class pertains to course requests and contains methods associated with
3294  * create, approving, and removing course requests.
3295  *
3296  * Please note we do not allow embedded images here because there is no context
3297  * to store them with proper access control.
3298  *
3299  * @copyright 2009 Sam Hemelryk
3300  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3301  * @since Moodle 2.0
3302  *
3303  * @property-read int $id
3304  * @property-read string $fullname
3305  * @property-read string $shortname
3306  * @property-read string $summary
3307  * @property-read int $summaryformat
3308  * @property-read int $summarytrust
3309  * @property-read string $reason
3310  * @property-read int $requester
3311  */
3312 class course_request {
3314     /**
3315      * This is the stdClass that stores the properties for the course request
3316      * and is externally accessed through the __get magic method
3317      * @var stdClass
3318      */
3319     protected $properties;
3321     /**
3322      * An array of options for the summary editor used by course request forms.
3323      * This is initially set by {@link summary_editor_options()}
3324      * @var array
3325      * @static
3326      */
3327     protected static $summaryeditoroptions;
3329     /**
3330      * Static function to prepare the summary editor for working with a course
3331      * request.
3332      *
3333      * @static
3334      * @param null|stdClass $data Optional, an object containing the default values
3335      *                       for the form, these may be modified when preparing the
3336      *                       editor so this should be called before creating the form
3337      * @return stdClass An object that can be used to set the default values for
3338      *                   an mforms form
3339      */
3340     public static function prepare($data=null) {
3341         if ($data === null) {
3342             $data = new stdClass;
3343         }
3344         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
3345         return $data;
3346     }
3348     /**
3349      * Static function to create a new course request when passed an array of properties
3350      * for it.
3351      *
3352      * This function also handles saving any files that may have been used in the editor
3353      *
3354      * @static
3355      * @param stdClass $data
3356      * @return course_request The newly created course request
3357      */
3358     public static function create($data) {
3359         global $USER, $DB, $CFG;
3360         $data->requester = $USER->id;
3362         // Setting the default category if none set.
3363         if (empty($data->category) || empty($CFG->requestcategoryselection)) {
3364             $data->category = $CFG->defaultrequestcategory;
3365         }
3367         // Summary is a required field so copy the text over
3368         $data->summary       = $data->summary_editor['text'];
3369         $data->summaryformat = $data->summary_editor['format'];
3371         $data->id = $DB->insert_record('course_request', $data);
3373         // Create a new course_request object and return it
3374         $request = new course_request($data);
3376         // Notify the admin if required.
3377         if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
3379             $a = new stdClass;
3380             $a->link = "$CFG->wwwroot/course/pending.php";
3381             $a->user = fullname($USER);
3382             $subject = get_string('courserequest');
3383             $message = get_string('courserequestnotifyemail', 'admin', $a);
3384             foreach ($users as $user) {
3385                 $request->notify($user, $USER, 'courserequested', $subject, $message);
3386             }
3387         }
3389         return $request;
3390     }
3392     /**
3393      * Returns an array of options to use with a summary editor
3394      *
3395      * @uses course_request::$summaryeditoroptions
3396      * @return array An array of options to use with the editor
3397      */
3398     public static function summary_editor_options() {
3399         global $CFG;
3400         if (self::$summaryeditoroptions === null) {
3401             self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
3402         }
3403         return self::$summaryeditoroptions;
3404     }
3406     /**
3407      * Loads the properties for this course request object. Id is required and if
3408      * only id is provided then we load the rest of the properties from the database
3409      *
3410      * @param stdClass|int $properties Either an object containing properties
3411      *                      or the course_request id to load
3412      */
3413     public function __construct($properties) {
3414         global $DB;
3415         if (empty($properties->id)) {
3416             if (empty($properties)) {
3417                 throw new coding_exception('You must provide a course request id when creating a course_request object');
3418             }
3419             $id = $properties;
3420             $properties = new stdClass;
3421             $properties->id = (int)$id;
3422             unset($id);
3423         }
3424         if (empty($properties->requester)) {
3425             if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3426                 print_error('unknowncourserequest');
3427             }
3428         } else {
3429             $this->properties = $properties;
3430         }
3431         $this->properties->collision = null;
3432     }
3434     /**
3435      * Returns the requested property
3436      *
3437      * @param string $key
3438      * @return mixed
3439      */
3440     public function __get($key) {
3441         return $this->properties->$key;
3442     }
3444     /**
3445      * Override this to ensure empty($request->blah) calls return a reliable answer...
3446      *
3447      * This is required because we define the __get method
3448      *
3449      * @param mixed $key
3450      * @return bool True is it not empty, false otherwise
3451      */
3452     public function __isset($key) {
3453         return (!empty($this->properties->$key));
3454     }
3456     /**
3457      * Returns the user who requested this course
3458      *
3459      * Uses a static var to cache the results and cut down the number of db queries
3460      *
3461      * @staticvar array $requesters An array of cached users
3462      * @return stdClass The user who requested the course
3463      */
3464     public function get_requester() {
3465         global $DB;
3466         static $requesters= array();
3467         if (!array_key_exists($this->properties->requester, $requesters)) {
3468             $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3469         }
3470         return $requesters[$this->properties->requester];
3471     }
3473     /**
3474      * Checks that the shortname used by the course does not conflict with any other
3475      * courses that exist
3476      *
3477      * @param string|null $shortnamemark The string to append to the requests shortname
3478      *                     should a conflict be found
3479      * @return bool true is there is a conflict, false otherwise
3480      */
3481     public function check_shortname_collision($shortnamemark = '[*]') {
3482         global $DB;
3484         if ($this->properties->collision !== null) {
3485             return $this->properties->collision;
3486         }
3488         if (empty($this->properties->shortname)) {
3489             debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3490             $this->properties->collision = false;
3491         } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3492             if (!empty($shortnamemark)) {
3493                 $this->properties->shortname .= ' '.$shortnamemark;
3494             }
3495             $this->properties->collision = true;
3496         } else {
3497             $this->properties->collision = false;
3498         }
3499         return $this->properties->collision;
3500     }
3502     /**
3503      * This function approves the request turning it into a course
3504      *
3505      * This function converts the course request into a course, at the same time
3506      * transferring any files used in the summary to the new course and then removing
3507      * the course request and the files associated with it.
3508      *
3509      * @return int The id of the course that was created from this request
3510      */
3511     public function approve() {
3512         global $CFG, $DB, $USER;
3514         $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3516         $courseconfig = get_config('moodlecourse');
3518         // Transfer appropriate settings
3519         $data = clone($this->properties);
3520         unset($data->id);
3521         unset($data->reason);
3522         unset($data->requester);
3524         // If the category is not set, if the current user does not have the rights to change the category, or if the
3525         // category does not exist, we set the default category to the course to be approved.
3526         // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3527         if (empty($data->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
3528                 (!$category = get_course_category($data->category))) {
3529             $category = get_course_category($CFG->defaultrequestcategory);
3530         }
3532         // Set category
3533         $data->category = $category->id;
3534         $data->sortorder = $category->sortorder; // place as the first in category
3536         // Set misc settings
3537         $data->requested = 1;
3539         // Apply course default settings
3540         $data->format             = $courseconfig->format;
3541         $data->newsitems          = $courseconfig->newsitems;
3542         $data->showgrades         = $courseconfig->showgrades;
3543         $data->showreports        = $courseconfig->showreports;
3544         $data->maxbytes           = $courseconfig->maxbytes;
3545         $data->groupmode          = $courseconfig->groupmode;
3546         $data->groupmodeforce     = $courseconfig->groupmodeforce;
3547         $data->visible            = $courseconfig->visible;
3548         $data->visibleold         = $data->visible;
3549         $data->lang               = $courseconfig->lang;
3551         $course = create_course($data);
3552         $context = context_course::instance($course->id, MUST_EXIST);
3554         // add enrol instances
3555         if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3556             if ($manual = enrol_get_plugin('manual')) {
3557                 $manual->add_default_instance($course);
3558             }
3559         }
3561         // enrol the requester as teacher if necessary
3562         if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3563             enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3564         }
3566         $this->delete();
3568         $a = new stdClass();
3569         $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3570         $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3571         $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3573         return $course->id;
3574     }
3576     /**
3577      * Reject a course request
3578      *
3579      * This function rejects a course request, emailing the requesting user the
3580      * provided notice and then removing the request from the database
3581      *
3582      * @param string $notice The message to display to the user
3583      */
3584     public function reject($notice) {
3585         global $USER, $DB;
3586         $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
3587         $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3588         $this->delete();
3589     }
3591     /**
3592      * Deletes the course request and any associated files
3593      */
3594     public function delete() {
3595         global $DB;
3596         $DB->delete_records('course_request', array('id' => $this->properties->id));
3597     }
3599     /**
3600      * Send a message from one user to another using events_trigger
3601      *
3602      * @param object $touser
3603      * @param object $fromuser
3604      * @param string $name
3605      * @param string $subject
3606      * @param string $message
3607      */
3608     protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
3609         $eventdata = new stdClass();
3610         $eventdata->component         = 'moodle';
3611         $eventdata->name              = $name;
3612         $eventdata->userfrom          = $fromuser;
3613         $eventdata->userto            = $touser;
3614         $eventdata->subject           = $subject;
3615         $eventdata->fullmessage       = $message;
3616         $eventdata->fullmessageformat = FORMAT_PLAIN;
3617         $eventdata->fullmessagehtml   = '';
3618         $eventdata->smallmessage      = '';
3619         $eventdata->notification      = 1;
3620         message_send($eventdata);
3621     }
3624 /**
3625  * Return a list of page types
3626  * @param string $pagetype current page type
3627  * @param stdClass $parentcontext Block's parent context
3628  * @param stdClass $currentcontext Current context of block
3629  */
3630 function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
3631     // if above course context ,display all course fomats
3632     list($currentcontext, $course, $cm) = get_context_info_array($currentcontext->id);
3633     if ($course->id == SITEID) {
3634         return array('*'=>get_string('page-x', 'pagetype'));
3635     } else {
3636         return array('*'=>get_string('page-x', 'pagetype'),
3637             'course-*'=>get_string('page-course-x', 'pagetype'),
3638             'course-view-*'=>get_string('page-course-view-x', 'pagetype')
3639         );
3640     }
3643 /**
3644  * Determine whether course ajax should be enabled for the specified course
3645  *
3646  * @param stdClass $course The course to test against
3647  * @return boolean Whether course ajax is enabled or note
3648  */
3649 function course_ajax_enabled($course) {
3650     global $CFG, $PAGE, $SITE;
3652     // Ajax must be enabled globally
3653     if (!$CFG->enableajax) {
3654         return false;
3655     }
3657     // The user must be editing for AJAX to be included
3658     if (!$PAGE->user_is_editing()) {
3659         return false;
3660     }
3662     // Check that the theme suports
3663     if (!$PAGE->theme->enablecourseajax) {
3664         return false;
3665     }
3667     // Check that the course format supports ajax functionality
3668     // The site 'format' doesn't have information on course format support
3669     if ($SITE->id !== $course->id) {
3670         $courseformatajaxsupport = course_format_ajax_support($course->format);
3671         if (!$courseformatajaxsupport->capable) {
3672             return false;
3673         }
3674     }
3676     // All conditions have been met so course ajax should be enabled
3677     return true;
3680 /**
3681  * Include the relevant javascript and language strings for the resource
3682  * toolbox YUI module
3683  *
3684  * @param integer $id The ID of the course being applied to
3685  * @param array $usedmodules An array containing the names of the modules in use on the page
3686  * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
3687  * @param stdClass $config An object containing configuration parameters for ajax modules including:
3688  *          * resourceurl   The URL to post changes to for resource changes
3689  *          * sectionurl    The URL to post changes to for section changes
3690  *          * pageparams    Additional parameters to pass through in the post
3691  * @return bool
3692  */
3693 function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
3694     global $PAGE, $SITE;
3696     // Ensure that ajax should be included
3697     if (!course_ajax_enabled($course)) {
3698         return false;
3699     }
3701     if (!$config) {
3702         $config = new stdClass();
3703     }
3705     // The URL to use for resource changes
3706     if (!isset($config->resourceurl)) {
3707         $config->resourceurl = '/course/rest.php';
3708     }
3710     // The URL to use for section changes
3711     if (!isset($config->sectionurl)) {
3712         $config->sectionurl = '/course/rest.php';
3713     }
3715     // Any additional parameters which need to be included on page submission
3716     if (!isset($config->pageparams)) {
3717         $config->pageparams = array();
3718     }
3720     // Include toolboxes
3721     $PAGE->requires->yui_module('moodle-course-toolboxes',
3722             'M.course.init_resource_toolbox',
3723             array(array(
3724                 'courseid' => $course->id,
3725                 'ajaxurl' => $config->resourceurl,
3726                 'config' => $config,
3727             ))
3728     );
3729     $PAGE->requires->yui_module('moodle-course-toolboxes',
3730             'M.course.init_section_toolbox',
3731             array(array(
3732                 'courseid' => $course->id,
3733                 'format' => $course->format,
3734                 'ajaxurl' => $config->sectionurl,
3735                 'config' => $config,
3736             ))
3737     );
3739     // Include course dragdrop
3740     if ($course->id != $SITE->id) {
3741         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
3742             array(array(
3743                 'courseid' => $course->id,
3744                 'ajaxurl' => $config->sectionurl,
3745                 'config' => $config,
3746             )), null, true);
3748         $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
3749             array(array(
3750                 'courseid' => $course->id,
3751                 'ajaxurl' => $config->resourceurl,
3752                 'config' => $config,
3753             )), null, true);
3754     }
3756     // Include blocks dragdrop
3757     $params = array(
3758         'courseid' => $course->id,
3759         'pagetype' => $PAGE->pagetype,
3760         'pagelayout' => $PAGE->pagelayout,
3761         'subpage' => $PAGE->subpage,
3762         'regions' => $PAGE->blocks->get_regions(),
3763     );
3764     $PAGE->requires->yui_module('moodle-core-blocks', 'M.core_blocks.init_dragdrop', array($params), null, true);
3766     // Require various strings for the command toolbox
3767     $PAGE->requires->strings_for_js(array(
3768             'moveleft',
3769             'deletechecktype',
3770             'deletechecktypename',
3771             'edittitle',
3772             'edittitleinstructions',
3773             'show',
3774             'hide',
3775             'groupsnone',
3776             'groupsvisible',
3777             'groupsseparate',
3778             'clicktochangeinbrackets',
3779             'markthistopic',
3780             'markedthistopic',
3781             'move',
3782             'movesection',
3783         ), 'moodle');
3785     // Include format-specific strings
3786     if ($course->id != $SITE->id) {
3787         $PAGE->requires->strings_for_js(array(
3788                 'showfromothers',
3789                 'hidefromothers',
3790             ), 'format_' . $course->format);
3791     }
3793     // For confirming resource deletion we need the name of the module in question
3794     foreach ($usedmodules as $module => $modname) {
3795         $PAGE->requires->string_for_js('pluginname', $module);
3796     }
3798     // Load drag and drop upload AJAX.
3799     dndupload_add_to_course($course, $enabledmodules);
3801     return true;
3804 /**
3805  * Returns the sorted list of available course formats, filtered by enabled if necessary
3806  *
3807  * @param bool $enabledonly return only formats that are enabled
3808  * @return array array of sorted format names
3809  */
3810 function get_sorted_course_formats($enabledonly = false) {
3811     global $CFG;
3812     $formats = get_plugin_list('format');
3814     if (!empty($CFG->format_plugins_sortorder)) {
3815         $order = explode(',', $CFG->format_plugins_sortorder);
3816         $order = array_merge(array_intersect($order, array_keys($formats)),
3817                     array_diff(array_keys($formats), $order));
3818     } else {
3819         $order = array_keys($formats);
3820     }
3821     if (!$enabledonly) {
3822         return $order;
3823     }
3824     $sortedformats = array();
3825     foreach ($order as $formatname) {
3826         if (!get_config('format_'.$formatname, 'disabled')) {
3827             $sortedformats[] = $formatname;
3828         }
3829     }
3830     return $sortedformats;
3833 /**
3834  * The URL to use for the specified course (with section)
3835  *
3836  * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3837  * @param int|stdClass $section Section object from database or just field course_sections.section
3838  *     if omitted the course view page is returned
3839  * @param array $options options for view URL. At the moment core uses:
3840  *     'navigation' (bool) if true and section has no separate page, the function returns null
3841  *     'sr' (int) used by multipage formats to specify to which section to return
3842  * @return moodle_url The url of course
3843  */
3844 function course_get_url($courseorid, $section = null, $options = array()) {
3845     return course_get_format($courseorid)->get_view_url($section, $options);