7c050940f22ef86b0e786d985477846b7342c852
[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');
33 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
34 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
35 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
36 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
37 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
38 define('FRONTPAGENEWS',           '0');
39 define('FRONTPAGECOURSELIST',     '1');
40 define('FRONTPAGECATEGORYNAMES',  '2');
41 define('FRONTPAGETOPICONLY',      '3');
42 define('FRONTPAGECATEGORYCOMBO',  '4');
43 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
44 define('EXCELROWS', 65535);
45 define('FIRSTUSEDEXCELROW', 3);
47 define('MOD_CLASS_ACTIVITY', 0);
48 define('MOD_CLASS_RESOURCE', 1);
50 function make_log_url($module, $url) {
51     switch ($module) {
52         case 'course':
53             if (strpos($url, 'report/') === 0) {
54                 // there is only one report type, course reports are deprecated
55                 $url = "/$url";
56                 break;
57             }
58         case 'file':
59         case 'login':
60         case 'lib':
61         case 'admin':
62         case 'calendar':
63         case 'mnet course':
64             if (strpos($url, '../') === 0) {
65                 $url = ltrim($url, '.');
66             } else {
67                 $url = "/course/$url";
68             }
69             break;
70         case 'user':
71         case 'blog':
72             $url = "/$module/$url";
73             break;
74         case 'upload':
75             $url = $url;
76             break;
77         case 'coursetags':
78             $url = '/'.$url;
79             break;
80         case 'library':
81         case '':
82             $url = '/';
83             break;
84         case 'message':
85             $url = "/message/$url";
86             break;
87         case 'notes':
88             $url = "/notes/$url";
89             break;
90         case 'tag':
91             $url = "/tag/$url";
92             break;
93         case 'role':
94             $url = '/'.$url;
95             break;
96         default:
97             $url = "/mod/$module/$url";
98             break;
99     }
101     //now let's sanitise urls - there might be some ugly nasties:-(
102     $parts = explode('?', $url);
103     $script = array_shift($parts);
104     if (strpos($script, 'http') === 0) {
105         $script = clean_param($script, PARAM_URL);
106     } else {
107         $script = clean_param($script, PARAM_PATH);
108     }
110     $query = '';
111     if ($parts) {
112         $query = implode('', $parts);
113         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
114         $parts = explode('&', $query);
115         $eq = urlencode('=');
116         foreach ($parts as $key=>$part) {
117             $part = urlencode(urldecode($part));
118             $part = str_replace($eq, '=', $part);
119             $parts[$key] = $part;
120         }
121         $query = '?'.implode('&amp;', $parts);
122     }
124     return $script.$query;
128 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
129                    $modname="", $modid=0, $modaction="", $groupid=0) {
130     global $CFG, $DB;
132     // It is assumed that $date is the GMT time of midnight for that day,
133     // and so the next 86400 seconds worth of logs are printed.
135     /// Setup for group handling.
137     // TODO: I don't understand group/context/etc. enough to be able to do
138     // something interesting with it here
139     // What is the context of a remote course?
141     /// If the group mode is separate, and this user does not have editing privileges,
142     /// then only the user's group can be viewed.
143     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
144     //    $groupid = get_current_group($course->id);
145     //}
146     /// If this course doesn't have groups, no groupid can be specified.
147     //else if (!$course->groupmode) {
148     //    $groupid = 0;
149     //}
151     $groupid = 0;
153     $joins = array();
154     $where = '';
156     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
157               FROM {mnet_log} l
158                LEFT JOIN {user} u ON l.userid = u.id
159               WHERE ";
160     $params = array();
162     $where .= "l.hostid = :hostid";
163     $params['hostid'] = $hostid;
165     // TODO: Is 1 really a magic number referring to the sitename?
166     if ($course != SITEID || $modid != 0) {
167         $where .= " AND l.course=:courseid";
168         $params['courseid'] = $course;
169     }
171     if ($modname) {
172         $where .= " AND l.module = :modname";
173         $params['modname'] = $modname;
174     }
176     if ('site_errors' === $modid) {
177         $where .= " AND ( l.action='error' OR l.action='infected' )";
178     } else if ($modid) {
179         //TODO: This assumes that modids are the same across sites... probably
180         //not true
181         $where .= " AND l.cmid = :modid";
182         $params['modid'] = $modid;
183     }
185     if ($modaction) {
186         $firstletter = substr($modaction, 0, 1);
187         if ($firstletter == '-') {
188             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
189             $params['modaction'] = '%'.substr($modaction, 1).'%';
190         } else {
191             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
192             $params['modaction'] = '%'.$modaction.'%';
193         }
194     }
196     if ($user) {
197         $where .= " AND l.userid = :user";
198         $params['user'] = $user;
199     }
201     if ($date) {
202         $enddate = $date + 86400;
203         $where .= " AND l.time > :date AND l.time < :enddate";
204         $params['date'] = $date;
205         $params['enddate'] = $enddate;
206     }
208     $result = array();
209     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
210     if(!empty($result['totalcount'])) {
211         $where .= " ORDER BY $order";
212         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
213     } else {
214         $result['logs'] = array();
215     }
216     return $result;
219 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
220                    $modname="", $modid=0, $modaction="", $groupid=0) {
221     global $DB, $SESSION, $USER;
222     // It is assumed that $date is the GMT time of midnight for that day,
223     // and so the next 86400 seconds worth of logs are printed.
225     /// Setup for group handling.
227     /// If the group mode is separate, and this user does not have editing privileges,
228     /// then only the user's group can be viewed.
229     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
230         if (isset($SESSION->currentgroup[$course->id])) {
231             $groupid =  $SESSION->currentgroup[$course->id];
232         } else {
233             $groupid = groups_get_all_groups($course->id, $USER->id);
234             if (is_array($groupid)) {
235                 $groupid = array_shift(array_keys($groupid));
236                 $SESSION->currentgroup[$course->id] = $groupid;
237             } else {
238                 $groupid = 0;
239             }
240         }
241     }
242     /// If this course doesn't have groups, no groupid can be specified.
243     else if (!$course->groupmode) {
244         $groupid = 0;
245     }
247     $joins = array();
248     $params = array();
250     if ($course->id != SITEID || $modid != 0) {
251         $joins[] = "l.course = :courseid";
252         $params['courseid'] = $course->id;
253     }
255     if ($modname) {
256         $joins[] = "l.module = :modname";
257         $params['modname'] = $modname;
258     }
260     if ('site_errors' === $modid) {
261         $joins[] = "( l.action='error' OR l.action='infected' )";
262     } else if ($modid) {
263         $joins[] = "l.cmid = :modid";
264         $params['modid'] = $modid;
265     }
267     if ($modaction) {
268         $firstletter = substr($modaction, 0, 1);
269         if ($firstletter == '-') {
270             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
271             $params['modaction'] = '%'.substr($modaction, 1).'%';
272         } else {
273             $joins[] = $DB->sql_like('l.action', ':modaction', false);
274             $params['modaction'] = '%'.$modaction.'%';
275         }
276     }
279     /// Getting all members of a group.
280     if ($groupid and !$user) {
281         if ($gusers = groups_get_members($groupid)) {
282             $gusers = array_keys($gusers);
283             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
284         } else {
285             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
286         }
287     }
288     else if ($user) {
289         $joins[] = "l.userid = :userid";
290         $params['userid'] = $user;
291     }
293     if ($date) {
294         $enddate = $date + 86400;
295         $joins[] = "l.time > :date AND l.time < :enddate";
296         $params['date'] = $date;
297         $params['enddate'] = $enddate;
298     }
300     $selector = implode(' AND ', $joins);
302     $totalcount = 0;  // Initialise
303     $result = array();
304     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
305     $result['totalcount'] = $totalcount;
306     return $result;
310 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
311                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
313     global $CFG, $DB, $OUTPUT;
315     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
316                        $modname, $modid, $modaction, $groupid)) {
317         echo $OUTPUT->notification("No logs found!");
318         echo $OUTPUT->footer();
319         exit;
320     }
322     $courses = array();
324     if ($course->id == SITEID) {
325         $courses[0] = '';
326         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
327             foreach ($ccc as $cc) {
328                 $courses[$cc->id] = $cc->shortname;
329             }
330         }
331     } else {
332         $courses[$course->id] = $course->shortname;
333     }
335     $totalcount = $logs['totalcount'];
336     $count=0;
337     $ldcache = array();
338     $tt = getdate(time());
339     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
341     $strftimedatetime = get_string("strftimedatetime");
343     echo "<div class=\"info\">\n";
344     print_string("displayingrecords", "", $totalcount);
345     echo "</div>\n";
347     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
349     $table = new html_table();
350     $table->classes = array('logtable','generalbox');
351     $table->align = array('right', 'left', 'left');
352     $table->head = array(
353         get_string('time'),
354         get_string('ip_address'),
355         get_string('fullnameuser'),
356         get_string('action'),
357         get_string('info')
358     );
359     $table->data = array();
361     if ($course->id == SITEID) {
362         array_unshift($table->align, 'left');
363         array_unshift($table->head, get_string('course'));
364     }
366     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
367     if (empty($logs['logs'])) {
368         $logs['logs'] = array();
369     }
371     foreach ($logs['logs'] as $log) {
373         if (isset($ldcache[$log->module][$log->action])) {
374             $ld = $ldcache[$log->module][$log->action];
375         } else {
376             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
377             $ldcache[$log->module][$log->action] = $ld;
378         }
379         if ($ld && is_numeric($log->info)) {
380             // ugly hack to make sure fullname is shown correctly
381             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
382                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
383             } else {
384                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
385             }
386         }
388         //Filter log->info
389         $log->info = format_string($log->info);
391         // If $log->url has been trimmed short by the db size restriction
392         // code in add_to_log, keep a note so we don't add a link to a broken url
393         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
395         $row = array();
396         if ($course->id == SITEID) {
397             if (empty($log->course)) {
398                 $row[] = get_string('site');
399             } else {
400                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
401             }
402         }
404         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
406         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
407         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
409         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id))));
411         $displayaction="$log->module $log->action";
412         if ($brokenurl) {
413             $row[] = $displayaction;
414         } else {
415             $link = make_log_url($log->module,$log->url);
416             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
417         }
418         $row[] = $log->info;
419         $table->data[] = $row;
420     }
422     echo html_writer::table($table);
423     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
427 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
428                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
430     global $CFG, $DB, $OUTPUT;
432     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
433                        $modname, $modid, $modaction, $groupid)) {
434         echo $OUTPUT->notification("No logs found!");
435         echo $OUTPUT->footer();
436         exit;
437     }
439     if ($course->id == SITEID) {
440         $courses[0] = '';
441         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
442             foreach ($ccc as $cc) {
443                 $courses[$cc->id] = $cc->shortname;
444             }
445         }
446     }
448     $totalcount = $logs['totalcount'];
449     $count=0;
450     $ldcache = array();
451     $tt = getdate(time());
452     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
454     $strftimedatetime = get_string("strftimedatetime");
456     echo "<div class=\"info\">\n";
457     print_string("displayingrecords", "", $totalcount);
458     echo "</div>\n";
460     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
462     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
463     echo "<tr>";
464     if ($course->id == SITEID) {
465         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
466     }
467     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
468     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
469     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
470     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
471     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
472     echo "</tr>\n";
474     if (empty($logs['logs'])) {
475         echo "</table>\n";
476         return;
477     }
479     $row = 1;
480     foreach ($logs['logs'] as $log) {
482         $log->info = $log->coursename;
483         $row = ($row + 1) % 2;
485         if (isset($ldcache[$log->module][$log->action])) {
486             $ld = $ldcache[$log->module][$log->action];
487         } else {
488             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
489             $ldcache[$log->module][$log->action] = $ld;
490         }
491         if (0 && $ld && !empty($log->info)) {
492             // ugly hack to make sure fullname is shown correctly
493             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
494                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
495             } else {
496                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
497             }
498         }
500         //Filter log->info
501         $log->info = format_string($log->info);
503         echo '<tr class="r'.$row.'">';
504         if ($course->id == SITEID) {
505             $courseshortname = format_string($courses[$log->course], true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
506             echo "<td class=\"r$row c0\" >\n";
507             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
508             echo "</td>\n";
509         }
510         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
511              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
512         echo "<td class=\"r$row c2\" >\n";
513         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
514         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
515         echo "</td>\n";
516         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
517         echo "<td class=\"r$row c3\" >\n";
518         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
519         echo "</td>\n";
520         echo "<td class=\"r$row c4\">\n";
521         echo $log->action .': '.$log->module;
522         echo "</td>\n";;
523         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
524         echo "</tr>\n";
525     }
526     echo "</table>\n";
528     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
532 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
533                         $modid, $modaction, $groupid) {
534     global $DB, $CFG;
536     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
537             get_string('fullnameuser')."\t".get_string('action')."\t".get_string('info');
539     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
540                        $modname, $modid, $modaction, $groupid)) {
541         return false;
542     }
544     $courses = array();
546     if ($course->id == SITEID) {
547         $courses[0] = '';
548         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
549             foreach ($ccc as $cc) {
550                 $courses[$cc->id] = $cc->shortname;
551             }
552         }
553     } else {
554         $courses[$course->id] = $course->shortname;
555     }
557     $count=0;
558     $ldcache = array();
559     $tt = getdate(time());
560     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
562     $strftimedatetime = get_string("strftimedatetime");
564     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
565     $filename .= '.txt';
566     header("Content-Type: application/download\n");
567     header("Content-Disposition: attachment; filename=\"$filename\"");
568     header("Expires: 0");
569     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
570     header("Pragma: public");
572     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
573     echo $text."\n";
575     if (empty($logs['logs'])) {
576         return true;
577     }
579     foreach ($logs['logs'] as $log) {
580         if (isset($ldcache[$log->module][$log->action])) {
581             $ld = $ldcache[$log->module][$log->action];
582         } else {
583             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
584             $ldcache[$log->module][$log->action] = $ld;
585         }
586         if ($ld && !empty($log->info)) {
587             // ugly hack to make sure fullname is shown correctly
588             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
589                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
590             } else {
591                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
592             }
593         }
595         //Filter log->info
596         $log->info = format_string($log->info);
597         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
599         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
600         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
601         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
602         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
603         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);\r
604         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
605         $text = implode("\t", $row);
606         echo $text." \n";
607     }
608     return true;
612 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
613                         $modid, $modaction, $groupid) {
615     global $CFG, $DB;
617     require_once("$CFG->libdir/excellib.class.php");
619     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
620                        $modname, $modid, $modaction, $groupid)) {
621         return false;
622     }
624     $courses = array();
626     if ($course->id == SITEID) {
627         $courses[0] = '';
628         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
629             foreach ($ccc as $cc) {
630                 $courses[$cc->id] = $cc->shortname;
631             }
632         }
633     } else {
634         $courses[$course->id] = $course->shortname;
635     }
637     $count=0;
638     $ldcache = array();
639     $tt = getdate(time());
640     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
642     $strftimedatetime = get_string("strftimedatetime");
644     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
645     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
646     $filename .= '.xls';
648     $workbook = new MoodleExcelWorkbook('-');
649     $workbook->send($filename);
651     $worksheet = array();
652     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
653                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
655     // Creating worksheets
656     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
657         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
658         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
659         $worksheet[$wsnumber]->set_column(1, 1, 30);
660         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
661                                     userdate(time(), $strftimedatetime));
662         $col = 0;
663         foreach ($headers as $item) {
664             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
665             $col++;
666         }
667     }
669     if (empty($logs['logs'])) {
670         $workbook->close();
671         return true;
672     }
674     $formatDate =& $workbook->add_format();
675     $formatDate->set_num_format(get_string('log_excel_date_format'));
677     $row = FIRSTUSEDEXCELROW;
678     $wsnumber = 1;
679     $myxls =& $worksheet[$wsnumber];
680     foreach ($logs['logs'] as $log) {
681         if (isset($ldcache[$log->module][$log->action])) {
682             $ld = $ldcache[$log->module][$log->action];
683         } else {
684             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
685             $ldcache[$log->module][$log->action] = $ld;
686         }
687         if ($ld && !empty($log->info)) {
688             // ugly hack to make sure fullname is shown correctly
689             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
690                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
691             } else {
692                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
693             }
694         }
696         // Filter log->info
697         $log->info = format_string($log->info);
698         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
700         if ($nroPages>1) {
701             if ($row > EXCELROWS) {
702                 $wsnumber++;
703                 $myxls =& $worksheet[$wsnumber];
704                 $row = FIRSTUSEDEXCELROW;
705             }
706         }
708         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
710         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
711         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
712         $myxls->write($row, 2, $log->ip, '');
713         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
714         $myxls->write($row, 3, $fullname, '');
715         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
716         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
717         $myxls->write($row, 5, $log->info, '');
719         $row++;
720     }
722     $workbook->close();
723     return true;
726 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
727                         $modid, $modaction, $groupid) {
729     global $CFG, $DB;
731     require_once("$CFG->libdir/odslib.class.php");
733     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
734                        $modname, $modid, $modaction, $groupid)) {
735         return false;
736     }
738     $courses = array();
740     if ($course->id == SITEID) {
741         $courses[0] = '';
742         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
743             foreach ($ccc as $cc) {
744                 $courses[$cc->id] = $cc->shortname;
745             }
746         }
747     } else {
748         $courses[$course->id] = $course->shortname;
749     }
751     $count=0;
752     $ldcache = array();
753     $tt = getdate(time());
754     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
756     $strftimedatetime = get_string("strftimedatetime");
758     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
759     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
760     $filename .= '.ods';
762     $workbook = new MoodleODSWorkbook('-');
763     $workbook->send($filename);
765     $worksheet = array();
766     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
767                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
769     // Creating worksheets
770     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
771         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
772         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
773         $worksheet[$wsnumber]->set_column(1, 1, 30);
774         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
775                                     userdate(time(), $strftimedatetime));
776         $col = 0;
777         foreach ($headers as $item) {
778             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
779             $col++;
780         }
781     }
783     if (empty($logs['logs'])) {
784         $workbook->close();
785         return true;
786     }
788     $formatDate =& $workbook->add_format();
789     $formatDate->set_num_format(get_string('log_excel_date_format'));
791     $row = FIRSTUSEDEXCELROW;
792     $wsnumber = 1;
793     $myxls =& $worksheet[$wsnumber];
794     foreach ($logs['logs'] as $log) {
795         if (isset($ldcache[$log->module][$log->action])) {
796             $ld = $ldcache[$log->module][$log->action];
797         } else {
798             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
799             $ldcache[$log->module][$log->action] = $ld;
800         }
801         if ($ld && !empty($log->info)) {
802             // ugly hack to make sure fullname is shown correctly
803             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
804                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
805             } else {
806                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
807             }
808         }
810         // Filter log->info
811         $log->info = format_string($log->info);
812         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
814         if ($nroPages>1) {
815             if ($row > EXCELROWS) {
816                 $wsnumber++;
817                 $myxls =& $worksheet[$wsnumber];
818                 $row = FIRSTUSEDEXCELROW;
819             }
820         }
822         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
824         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
825         $myxls->write_date($row, 1, $log->time);
826         $myxls->write_string($row, 2, $log->ip);
827         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
828         $myxls->write_string($row, 3, $fullname);
829         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
830         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
831         $myxls->write_string($row, 5, $log->info);
833         $row++;
834     }
836     $workbook->close();
837     return true;
841 function print_overview($courses, array $remote_courses=array()) {
842     global $CFG, $USER, $DB, $OUTPUT;
844     $htmlarray = array();
845     if ($modules = $DB->get_records('modules')) {
846         foreach ($modules as $mod) {
847             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
848                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
849                 $fname = $mod->name.'_print_overview';
850                 if (function_exists($fname)) {
851                     $fname($courses,$htmlarray);
852                 }
853             }
854         }
855     }
856     foreach ($courses as $course) {
857         $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
858         echo $OUTPUT->box_start('coursebox');
859         $attributes = array('title' => s($fullname));
860         if (empty($course->visible)) {
861             $attributes['class'] = 'dimmed';
862         }
863         echo $OUTPUT->heading(html_writer::link(
864             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
865         if (array_key_exists($course->id,$htmlarray)) {
866             foreach ($htmlarray[$course->id] as $modname => $html) {
867                 echo $html;
868             }
869         }
870         echo $OUTPUT->box_end();
871     }
873     if (!empty($remote_courses)) {
874         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
875     }
876     foreach ($remote_courses as $course) {
877         echo $OUTPUT->box_start('coursebox');
878         $attributes = array('title' => s($course->fullname));
879         echo $OUTPUT->heading(html_writer::link(
880             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
881             format_string($course->shortname),
882             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
883         echo $OUTPUT->box_end();
884     }
888 /**
889  * This function trawls through the logs looking for
890  * anything new since the user's last login
891  */
892 function print_recent_activity($course) {
893     // $course is an object
894     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
896     $context = get_context_instance(CONTEXT_COURSE, $course->id);
898     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
900     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
902     if (!isguestuser()) {
903         if (!empty($USER->lastcourseaccess[$course->id])) {
904             if ($USER->lastcourseaccess[$course->id] > $timestart) {
905                 $timestart = $USER->lastcourseaccess[$course->id];
906             }
907         }
908     }
910     echo '<div class="activitydate">';
911     echo get_string('activitysince', '', userdate($timestart));
912     echo '</div>';
913     echo '<div class="activityhead">';
915     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
917     echo "</div>\n";
919     $content = false;
921 /// Firstly, have there been any new enrolments?
923     $users = get_recent_enrolments($course->id, $timestart);
925     //Accessibility: new users now appear in an <OL> list.
926     if ($users) {
927         echo '<div class="newusers">';
928         echo $OUTPUT->heading(get_string("newusers").':', 3);
929         $content = true;
930         echo "<ol class=\"list\">\n";
931         foreach ($users as $user) {
932             $fullname = fullname($user, $viewfullnames);
933             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
934         }
935         echo "</ol>\n</div>\n";
936     }
938 /// Next, have there been any modifications to the course structure?
940     $modinfo = get_fast_modinfo($course);
942     $changelist = array();
944     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
945                                             module = 'course' AND
946                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
947                                     array($timestart, $course->id), "id ASC");
949     if ($logs) {
950         $actions  = array('add mod', 'update mod', 'delete mod');
951         $newgones = array(); // added and later deleted items
952         foreach ($logs as $key => $log) {
953             if (!in_array($log->action, $actions)) {
954                 continue;
955             }
956             $info = explode(' ', $log->info);
958             // note: in most cases I replaced hardcoding of label with use of
959             // $cm->has_view() but it was not possible to do this here because
960             // we don't necessarily have the $cm for it
961             if ($info[0] == 'label') {     // Labels are ignored in recent activity
962                 continue;
963             }
965             if (count($info) != 2) {
966                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
967                 continue;
968             }
970             $modname    = $info[0];
971             $instanceid = $info[1];
973             if ($log->action == 'delete mod') {
974                 // unfortunately we do not know if the mod was visible
975                 if (!array_key_exists($log->info, $newgones)) {
976                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
977                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
978                 }
979             } else {
980                 if (!isset($modinfo->instances[$modname][$instanceid])) {
981                     if ($log->action == 'add mod') {
982                         // do not display added and later deleted activities
983                         $newgones[$log->info] = true;
984                     }
985                     continue;
986                 }
987                 $cm = $modinfo->instances[$modname][$instanceid];
988                 if (!$cm->uservisible) {
989                     continue;
990                 }
992                 if ($log->action == 'add mod') {
993                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
994                     $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
996                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
997                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
998                     $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
999                 }
1000             }
1001         }
1002     }
1004     if (!empty($changelist)) {
1005         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1006         $content = true;
1007         foreach ($changelist as $changeinfo => $change) {
1008             echo '<p class="activity">'.$change['text'].'</p>';
1009         }
1010     }
1012 /// Now display new things from each module
1014     $usedmodules = array();
1015     foreach($modinfo->cms as $cm) {
1016         if (isset($usedmodules[$cm->modname])) {
1017             continue;
1018         }
1019         if (!$cm->uservisible) {
1020             continue;
1021         }
1022         $usedmodules[$cm->modname] = $cm->modname;
1023     }
1025     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1026         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1027             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1028             $print_recent_activity = $modname.'_print_recent_activity';
1029             if (function_exists($print_recent_activity)) {
1030                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1031                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1032             }
1033         } else {
1034             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1035         }
1036     }
1038     if (! $content) {
1039         echo '<p class="message">'.get_string('nothingnew').'</p>';
1040     }
1043 /**
1044  * For a given course, returns an array of course activity objects
1045  * Each item in the array contains he following properties:
1046  */
1047 function get_array_of_activities($courseid) {
1048 //  cm - course module id
1049 //  mod - name of the module (eg forum)
1050 //  section - the number of the section (eg week or topic)
1051 //  name - the name of the instance
1052 //  visible - is the instance visible or not
1053 //  groupingid - grouping id
1054 //  groupmembersonly - is this instance visible to group members only
1055 //  extra - contains extra string to include in any link
1056     global $CFG, $DB;
1057     if(!empty($CFG->enableavailability)) {
1058         require_once($CFG->libdir.'/conditionlib.php');
1059     }
1061     $course = $DB->get_record('course', array('id'=>$courseid));
1063     if (empty($course)) {
1064         throw new moodle_exception('courseidnotfound');
1065     }
1067     $mod = array();
1069     $rawmods = get_course_mods($courseid);
1070     if (empty($rawmods)) {
1071         return $mod; // always return array
1072     }
1074     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1075        foreach ($sections as $section) {
1076            if (!empty($section->sequence)) {
1077                $sequence = explode(",", $section->sequence);
1078                foreach ($sequence as $seq) {
1079                    if (empty($rawmods[$seq])) {
1080                        continue;
1081                    }
1082                    $mod[$seq] = new stdClass();
1083                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1084                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1085                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1087                     // Oh dear. Inconsistent names left here for backward compatibility.
1088                    $mod[$seq]->section          = $section->section;
1089                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1091                    $mod[$seq]->module           = $rawmods[$seq]->module;
1092                    $mod[$seq]->added            = $rawmods[$seq]->added;
1093                    $mod[$seq]->score            = $rawmods[$seq]->score;
1094                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1095                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1096                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1097                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1098                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1099                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1100                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1101                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1102                    $mod[$seq]->extra            = "";
1103                    $mod[$seq]->completiongradeitemnumber =
1104                            $rawmods[$seq]->completiongradeitemnumber;
1105                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1106                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1107                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1108                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1109                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1110                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1111                    if (!empty($CFG->enableavailability)) {
1112                        condition_info::fill_availability_conditions($rawmods[$seq]);
1113                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1114                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1115                    }
1117                    $modname = $mod[$seq]->mod;
1118                    $functionname = $modname."_get_coursemodule_info";
1120                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1121                        continue;
1122                    }
1124                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1126                    if ($hasfunction = function_exists($functionname)) {
1127                        if ($info = $functionname($rawmods[$seq])) {
1128                            if (!empty($info->icon)) {
1129                                $mod[$seq]->icon = $info->icon;
1130                            }
1131                            if (!empty($info->iconcomponent)) {
1132                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1133                            }
1134                            if (!empty($info->name)) {
1135                                $mod[$seq]->name = $info->name;
1136                            }
1137                            if ($info instanceof cached_cm_info) {
1138                                // When using cached_cm_info you can include three new fields
1139                                // that aren't available for legacy code
1140                                if (!empty($info->content)) {
1141                                    $mod[$seq]->content = $info->content;
1142                                }
1143                                if (!empty($info->extraclasses)) {
1144                                    $mod[$seq]->extraclasses = $info->extraclasses;
1145                                }
1146                                if (!empty($info->iconurl)) {
1147                                    $mod[$seq]->iconurl = $info->iconurl;
1148                                }
1149                                if (!empty($info->onclick)) {
1150                                    $mod[$seq]->onclick = $info->onclick;
1151                                }
1152                                if (!empty($info->customdata)) {
1153                                    $mod[$seq]->customdata = $info->customdata;
1154                                }
1155                            } else {
1156                                // When using a stdclass, the (horrible) deprecated ->extra field
1157                                // is available for BC
1158                                if (!empty($info->extra)) {
1159                                    $mod[$seq]->extra = $info->extra;
1160                                }
1161                            }
1162                        }
1163                    }
1164                    // When there is no modname_get_coursemodule_info function,
1165                    // but showdescriptions is enabled, then we use the 'intro'
1166                    // and 'introformat' fields in the module table
1167                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1168                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1169                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1170                            // Set content from intro and introformat. Filters are disabled
1171                            // because we  filter it with format_text at display time
1172                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1173                                    $modvalues, $rawmods[$seq]->id, false);
1175                            // To save making another query just below, put name in here
1176                            $mod[$seq]->name = $modvalues->name;
1177                        }
1178                    }
1179                    if (!isset($mod[$seq]->name)) {
1180                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1181                    }
1183                    // Minimise the database size by unsetting default options when they are
1184                    // 'empty'. This list corresponds to code in the cm_info constructor.
1185                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1186                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1187                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1188                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1189                            'completionview', 'completionexpected', 'score', 'showdescription')
1190                            as $property) {
1191                        if (property_exists($mod[$seq], $property) &&
1192                                empty($mod[$seq]->{$property})) {
1193                            unset($mod[$seq]->{$property});
1194                        }
1195                    }
1196                    // Special case: this value is usually set to null, but may be 0
1197                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1198                            is_null($mod[$seq]->completiongradeitemnumber)) {
1199                        unset($mod[$seq]->completiongradeitemnumber);
1200                    }
1201                }
1202             }
1203         }
1204     }
1205     return $mod;
1209 /**
1210  * Returns a number of useful structures for course displays
1211  */
1212 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1213     global $CFG, $DB, $COURSE;
1215     $mods          = array();    // course modules indexed by id
1216     $modnames      = array();    // all course module names (except resource!)
1217     $modnamesplural= array();    // all course module names (plural form)
1218     $modnamesused  = array();    // course module names used
1220     if ($allmods = $DB->get_records("modules")) {
1221         foreach ($allmods as $mod) {
1222             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1223                 continue;
1224             }
1225             if ($mod->visible) {
1226                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1227                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1228             }
1229         }
1230         collatorlib::asort($modnames);
1231     } else {
1232         print_error("nomodules", 'debug');
1233     }
1235     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1236     $modinfo = get_fast_modinfo($course);
1238     if ($rawmods=$modinfo->cms) {
1239         foreach($rawmods as $mod) {    // Index the mods
1240             if (empty($modnames[$mod->modname])) {
1241                 continue;
1242             }
1243             $mods[$mod->id] = $mod;
1244             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1245             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1246                 continue;
1247             }
1248             // Check groupings
1249             if (!groups_course_module_visible($mod)) {
1250                 continue;
1251             }
1252             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1253         }
1254         if ($modnamesused) {
1255             collatorlib::asort($modnamesused);
1256         }
1257     }
1260 /**
1261  * Returns an array of sections for the requested course id
1262  *
1263  * This function stores the sections against the course id within a staticvar encase
1264  * of subsequent requests. This is used all over + in some standard libs and course
1265  * format callbacks so subsequent requests are a reality.
1266  *
1267  * Note: Since Moodle 2.3, it is more efficient to get this data by calling
1268  * get_fast_modinfo, then using $modinfo->get_section_info or get_section_info_all.
1269  *
1270  * @staticvar array $coursesections
1271  * @param int $courseid
1272  * @return array Array of sections
1273  */
1274 function get_all_sections($courseid) {
1275     global $DB;
1276     static $coursesections = array();
1277     if (!array_key_exists($courseid, $coursesections)) {
1278         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1279                 'section, id, course, name, summary, summaryformat, sequence, visible, ' .
1280                 'availablefrom, availableuntil, showavailability, groupingid');
1281     }
1282     return $coursesections[$courseid];
1285 /**
1286  * Set highlighted section. Only one section can be highlighted at the time.
1287  *
1288  * @param int $courseid course id
1289  * @param int $marker highlight section with this number, 0 means remove higlightin
1290  * @return void
1291  */
1292 function course_set_marker($courseid, $marker) {
1293     global $DB;
1294     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1297 /**
1298  * For a given course section, marks it visible or hidden,
1299  * and does the same for every activity in that section
1300  *
1301  * @param int $courseid course id
1302  * @param int $sectionnumber The section number to adjust
1303  * @param int $visibility The new visibility
1304  * @return array A list of resources which were hidden in the section
1305  */
1306 function set_section_visible($courseid, $sectionnumber, $visibility) {
1307     global $DB;
1309     $resourcestotoggle = array();
1310     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1311         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1312         if (!empty($section->sequence)) {
1313             $modules = explode(",", $section->sequence);
1314             foreach ($modules as $moduleid) {
1315                 set_coursemodule_visible($moduleid, $visibility, true);
1316             }
1317         }
1318         rebuild_course_cache($courseid);
1320         // Determine which modules are visible for AJAX update
1321         if (!empty($modules)) {
1322             list($insql, $params) = $DB->get_in_or_equal($modules);
1323             $select = 'id ' . $insql . ' AND visible = ?';
1324             array_push($params, $visibility);
1325             if (!$visibility) {
1326                 $select .= ' AND visibleold = 1';
1327             }
1328             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1329         }
1330     }
1331     return $resourcestotoggle;
1334 /**
1335  * Obtains shared data that is used in print_section when displaying a
1336  * course-module entry.
1337  *
1338  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1339  *
1340  * This data is also used in other areas of the code.
1341  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1342  * @param object $course Moodle course object
1343  * @return array An array with the following values in this order:
1344  *   $content (optional extra content for after link),
1345  *   $instancename (text of link)
1346  */
1347 function get_print_section_cm_text(cm_info $cm, $course) {
1348     global $OUTPUT;
1350     // Get content from modinfo if specified. Content displays either
1351     // in addition to the standard link (below), or replaces it if
1352     // the link is turned off by setting ->url to null.
1353     if (($content = $cm->get_content()) !== '') {
1354         // Improve filter performance by preloading filter setttings for all
1355         // activities on the course (this does nothing if called multiple
1356         // times)
1357         filter_preload_activities($cm->get_modinfo());
1359         // Get module context
1360         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1361         $labelformatoptions = new stdClass();
1362         $labelformatoptions->noclean = true;
1363         $labelformatoptions->overflowdiv = true;
1364         $labelformatoptions->context = $modulecontext;
1365         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1366     } else {
1367         $content = '';
1368     }
1370     // Get course context
1371     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1372     $stringoptions = new stdClass;
1373     $stringoptions->context = $coursecontext;
1374     $instancename = format_string($cm->name, true,  $stringoptions);
1375     return array($content, $instancename);
1378 /**
1379  * Prints a section full of activity modules
1380  *
1381  * @param stdClass $course The course
1382  * @param stdClass $section The section
1383  * @param array $mods The modules in the section
1384  * @param array $modnamesused An array containing the list of modules and their names
1385  * @param bool $absolute All links are absolute
1386  * @param string $width Width of the container
1387  * @param bool $hidecompletion Hide completion status
1388  * @param int $sectionreturn The section to return to
1389  * @return void
1390  */
1391 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1392     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1394     static $initialised;
1396     static $groupbuttons;
1397     static $groupbuttonslink;
1398     static $isediting;
1399     static $ismoving;
1400     static $strmovehere;
1401     static $strmovefull;
1402     static $strunreadpostsone;
1403     static $modulenames;
1405     if (!isset($initialised)) {
1406         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1407         $groupbuttonslink = (!$course->groupmodeforce);
1408         $isediting        = $PAGE->user_is_editing();
1409         $ismoving         = $isediting && ismoving($course->id);
1410         if ($ismoving) {
1411             $strmovehere  = get_string("movehere");
1412             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1413         }
1414         $modulenames      = array();
1415         $initialised = true;
1416     }
1418     $modinfo = get_fast_modinfo($course);
1419     $completioninfo = new completion_info($course);
1421     //Accessibility: replace table with list <ul>, but don't output empty list.
1422     if (!empty($section->sequence)) {
1424         // Fix bug #5027, don't want style=\"width:$width\".
1425         echo "<ul class=\"section img-text\">\n";
1426         $sectionmods = explode(",", $section->sequence);
1428         foreach ($sectionmods as $modnumber) {
1429             if (empty($mods[$modnumber])) {
1430                 continue;
1431             }
1433             /**
1434              * @var cm_info
1435              */
1436             $mod = $mods[$modnumber];
1438             if ($ismoving and $mod->id == $USER->activitycopy) {
1439                 // do not display moving mod
1440                 continue;
1441             }
1443             if (isset($modinfo->cms[$modnumber])) {
1444                 // We can continue (because it will not be displayed at all)
1445                 // if:
1446                 // 1) The activity is not visible to users
1447                 // and
1448                 // 2a) The 'showavailability' option is not set (if that is set,
1449                 //     we need to display the activity so we can show
1450                 //     availability info)
1451                 // or
1452                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1453                 //     hidden in a way that leaves no info, such as using the
1454                 //     eye icon.
1455                 if (!$modinfo->cms[$modnumber]->uservisible &&
1456                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1457                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1458                     // visibility shortcut
1459                     continue;
1460                 }
1461             } else {
1462                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1463                     // module not installed
1464                     continue;
1465                 }
1466                 if (!coursemodule_visible_for_user($mod) &&
1467                     empty($mod->showavailability)) {
1468                     // full visibility check
1469                     continue;
1470                 }
1471             }
1473             if (!isset($modulenames[$mod->modname])) {
1474                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1475             }
1476             $modulename = $modulenames[$mod->modname];
1478             // In some cases the activity is visible to user, but it is
1479             // dimmed. This is done if viewhiddenactivities is true and if:
1480             // 1. the activity is not visible, or
1481             // 2. the activity has dates set which do not include current, or
1482             // 3. the activity has any other conditions set (regardless of whether
1483             //    current user meets them)
1484             $modcontext = context_module::instance($mod->id);
1485             $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
1486             $accessiblebutdim = false;
1487             if ($canviewhidden) {
1488                 $accessiblebutdim = !$mod->visible;
1489                 if (!empty($CFG->enableavailability)) {
1490                     $accessiblebutdim = $accessiblebutdim ||
1491                         $mod->availablefrom > time() ||
1492                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1493                         count($mod->conditionsgrade) > 0 ||
1494                         count($mod->conditionscompletion) > 0;
1495                 }
1496             }
1498             $liclasses = array();
1499             $liclasses[] = 'activity';
1500             $liclasses[] = $mod->modname;
1501             $liclasses[] = 'modtype_'.$mod->modname;
1502             $extraclasses = $mod->get_extra_classes();
1503             if ($extraclasses) {
1504                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1505             }
1506             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1507             if ($ismoving) {
1508                 echo '<a title="'.$strmovefull.'"'.
1509                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1510                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1511                      ' alt="'.$strmovehere.'" /></a><br />
1512                      ';
1513             }
1515             $classes = array('mod-indent');
1516             if (!empty($mod->indent)) {
1517                 $classes[] = 'mod-indent-'.$mod->indent;
1518                 if ($mod->indent > 15) {
1519                     $classes[] = 'mod-indent-huge';
1520                 }
1521             }
1522             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1524             // Get data about this course-module
1525             list($content, $instancename) =
1526                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1528             //Accessibility: for files get description via icon, this is very ugly hack!
1529             $altname = '';
1530             $altname = $mod->modfullname;
1531             // Avoid unnecessary duplication: if e.g. a forum name already
1532             // includes the word forum (or Forum, etc) then it is unhelpful
1533             // to include that in the accessible description that is added.
1534             if (false !== strpos(textlib::strtolower($instancename),
1535                     textlib::strtolower($altname))) {
1536                 $altname = '';
1537             }
1538             // File type after name, for alphabetic lists (screen reader).
1539             if ($altname) {
1540                 $altname = get_accesshide(' '.$altname);
1541             }
1543             // We may be displaying this just in order to show information
1544             // about visibility, without the actual link
1545             $contentpart = '';
1546             if ($mod->uservisible) {
1547                 // Nope - in this case the link is fully working for user
1548                 $linkclasses = '';
1549                 $textclasses = '';
1550                 if ($accessiblebutdim) {
1551                     $linkclasses .= ' dimmed conditionalhidden';
1552                     $textclasses .= ' dimmed_text conditionalhidden';
1553                     $accesstext = '<span class="accesshide">'.
1554                         get_string('hiddenfromstudents').': </span>';
1555                 } else {
1556                     $accesstext = '';
1557                 }
1558                 if ($linkclasses) {
1559                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1560                 } else {
1561                     $linkcss = '';
1562                 }
1563                 if ($textclasses) {
1564                     $textcss = 'class="' . trim($textclasses) . '" ';
1565                 } else {
1566                     $textcss = '';
1567                 }
1569                 // Get on-click attribute value if specified
1570                 $onclick = $mod->get_on_click();
1571                 if ($onclick) {
1572                     $onclick = ' onclick="' . $onclick . '"';
1573                 }
1575                 if ($url = $mod->get_url()) {
1576                     // Display link itself
1577                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1578                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1579                             '" class="activityicon" alt="' . $modulename . '" /> ' .
1580                             $accesstext . '<span class="instancename">' .
1581                             $instancename . $altname . '</span></a>';
1583                     // If specified, display extra content after link
1584                     if ($content) {
1585                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1586                                 '">' . $content . '</div>';
1587                     }
1588                 } else {
1589                     // No link, so display only content
1590                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1591                             $accesstext . $content . '</div>';
1592                 }
1594                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1595                     $groupings = groups_get_all_groupings($course->id);
1596                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1597                 }
1598             } else {
1599                 $textclasses = $extraclasses;
1600                 $textclasses .= ' dimmed_text';
1601                 if ($textclasses) {
1602                     $textcss = 'class="' . trim($textclasses) . '" ';
1603                 } else {
1604                     $textcss = '';
1605                 }
1606                 $accesstext = '<span class="accesshide">' .
1607                         get_string('notavailableyet', 'condition') .
1608                         ': </span>';
1610                 if ($url = $mod->get_url()) {
1611                     // Display greyed-out text of link
1612                     echo '<div ' . $textcss . $mod->extra .
1613                             ' >' . '<img src="' . $mod->get_icon_url() .
1614                             '" class="activityicon" alt="" /> <span>'. $instancename . $altname .
1615                             '</span></div>';
1617                     // Do not display content after link when it is greyed out like this.
1618                 } else {
1619                     // No link, so display only content (also greyed)
1620                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1621                             $accesstext . $content . '</div>';
1622                 }
1623             }
1625             // Module can put text after the link (e.g. forum unread)
1626             echo $mod->get_after_link();
1628             // If there is content but NO link (eg label), then display the
1629             // content here (BEFORE any icons). In this case cons must be
1630             // displayed after the content so that it makes more sense visually
1631             // and for accessibility reasons, e.g. if you have a one-line label
1632             // it should work similarly (at least in terms of ordering) to an
1633             // activity.
1634             if (empty($url)) {
1635                 echo $contentpart;
1636             }
1638             if ($isediting) {
1639                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1640                     if (! $mod->groupmodelink = $groupbuttonslink) {
1641                         $mod->groupmode = $course->groupmode;
1642                     }
1644                 } else {
1645                     $mod->groupmode = false;
1646                 }
1647                 echo '&nbsp;&nbsp;';
1648                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $sectionreturn);
1649                 echo $mod->get_after_edit_icons();
1650             }
1652             // Completion
1653             $completion = $hidecompletion
1654                 ? COMPLETION_TRACKING_NONE
1655                 : $completioninfo->is_enabled($mod);
1656             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1657                 !isguestuser() && $mod->uservisible) {
1658                 $completiondata = $completioninfo->get_data($mod,true);
1659                 $completionicon = '';
1660                 if ($isediting) {
1661                     switch ($completion) {
1662                         case COMPLETION_TRACKING_MANUAL :
1663                             $completionicon = 'manual-enabled'; break;
1664                         case COMPLETION_TRACKING_AUTOMATIC :
1665                             $completionicon = 'auto-enabled'; break;
1666                         default: // wtf
1667                     }
1668                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1669                     switch($completiondata->completionstate) {
1670                         case COMPLETION_INCOMPLETE:
1671                             $completionicon = 'manual-n'; break;
1672                         case COMPLETION_COMPLETE:
1673                             $completionicon = 'manual-y'; break;
1674                     }
1675                 } else { // Automatic
1676                     switch($completiondata->completionstate) {
1677                         case COMPLETION_INCOMPLETE:
1678                             $completionicon = 'auto-n'; break;
1679                         case COMPLETION_COMPLETE:
1680                             $completionicon = 'auto-y'; break;
1681                         case COMPLETION_COMPLETE_PASS:
1682                             $completionicon = 'auto-pass'; break;
1683                         case COMPLETION_COMPLETE_FAIL:
1684                             $completionicon = 'auto-fail'; break;
1685                     }
1686                 }
1687                 if ($completionicon) {
1688                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1689                     $formattedname = format_string($mod->name, true, array('context' => $modcontext));
1690                     $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
1691                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1692                         $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
1693                         $newstate =
1694                             $completiondata->completionstate==COMPLETION_COMPLETE
1695                             ? COMPLETION_INCOMPLETE
1696                             : COMPLETION_COMPLETE;
1697                         // In manual mode the icon is a toggle form...
1699                         // If this completion state is used by the
1700                         // conditional activities system, we need to turn
1701                         // off the JS.
1702                         if (!empty($CFG->enableavailability) &&
1703                             condition_info::completion_value_used_as_condition($course, $mod)) {
1704                             $extraclass = ' preventjs';
1705                         } else {
1706                             $extraclass = '';
1707                         }
1708                         echo "
1709 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1710 <input type='hidden' name='id' value='{$mod->id}' />
1711 <input type='hidden' name='modulename' value='".s($mod->name)."' />
1712 <input type='hidden' name='sesskey' value='".sesskey()."' />
1713 <input type='hidden' name='completionstate' value='$newstate' />
1714 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1715 </div></form>";
1716                     } else {
1717                         // In auto mode, or when editing, the icon is just an image
1718                         echo "<span class='autocompletion'>";
1719                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1720                     }
1721                 }
1722             }
1724             // If there is content AND a link, then display the content here
1725             // (AFTER any icons). Otherwise it was displayed before
1726             if (!empty($url)) {
1727                 echo $contentpart;
1728             }
1730             // Show availability information (for someone who isn't allowed to
1731             // see the activity itself, or for staff)
1732             if (!$mod->uservisible) {
1733                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1734             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1735                 $visibilityclass = '';
1736                 if (!$mod->visible) {
1737                     $visibilityclass = 'accesshide';
1738                 }
1739                 $ci = new condition_info($mod);
1740                 $fullinfo = $ci->get_full_information();
1741                 if($fullinfo) {
1742                     echo '<div class="availabilityinfo '.$visibilityclass.'">'.get_string($mod->showavailability
1743                         ? 'userrestriction_visible'
1744                         : 'userrestriction_hidden','condition',
1745                         $fullinfo).'</div>';
1746                 }
1747             }
1749             echo html_writer::end_tag('div');
1750             echo html_writer::end_tag('li')."\n";
1751         }
1753     } elseif ($ismoving) {
1754         echo "<ul class=\"section\">\n";
1755     }
1757     if ($ismoving) {
1758         echo '<li><a title="'.$strmovefull.'"'.
1759              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1760              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1761              ' alt="'.$strmovehere.'" /></a></li>
1762              ';
1763     }
1764     if (!empty($section->sequence) || $ismoving) {
1765         echo "</ul><!--class='section'-->\n\n";
1766     }
1769 /**
1770  * Prints the menus to add activities and resources.
1771  *
1772  * @param stdClass $course The course
1773  * @param int $section relative section number (field course_sections.section)
1774  * @param array $modnames An array containing the list of modules and their names
1775  * @param bool $vertical Vertical orientation
1776  * @param bool $return Return the menus or send them to output
1777  * @param int $sectionreturn The section to link back to
1778  * @return void|string depending on $return
1779  */
1780 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false, $sectionreturn=null) {
1781     global $CFG, $OUTPUT;
1783     // check to see if user can add menus
1784     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1785         return false;
1786     }
1788     // Retrieve all modules with associated metadata
1789     $modules = get_module_metadata($course, $modnames, $sectionreturn);
1791     // We'll sort resources and activities into two lists
1792     $resources = array();
1793     $activities = array();
1795     // We need to add the section section to the link for each module
1796     $sectionlink = '&section=' . $section . '&sr=' . $sectionreturn;
1798     foreach ($modules as $module) {
1799         if (isset($module->types)) {
1800             // This module has a subtype
1801             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1802             $subtypes = array();
1803             foreach ($module->types as $subtype) {
1804                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1805             }
1807             // Sort module subtypes into the list
1808             if (!empty($module->title)) {
1809                 // This grouping has a name
1810                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1811                     $resources[] = array($module->title=>$subtypes);
1812                 } else {
1813                     $activities[] = array($module->title=>$subtypes);
1814                 }
1815             } else {
1816                 // This grouping does not have a name
1817                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1818                     $resources = array_merge($resources, $subtypes);
1819                 } else {
1820                     $activities = array_merge($activities, $subtypes);
1821                 }
1822             }
1823         } else {
1824             // This module has no subtypes
1825             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1826                 $resources[$module->link . $sectionlink] = $module->title;
1827             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1828                 // System modules cannot be added by user, do not add to dropdown
1829             } else {
1830                 $activities[$module->link . $sectionlink] = $module->title;
1831             }
1832         }
1833     }
1835     $straddactivity = get_string('addactivity');
1836     $straddresource = get_string('addresource');
1838     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1840     if (!$vertical) {
1841         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1842     }
1844     if (!empty($resources)) {
1845         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1846         $select->set_help_icon('resources');
1847         $output .= $OUTPUT->render($select);
1848     }
1850     if (!empty($activities)) {
1851         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1852         $select->set_help_icon('activities');
1853         $output .= $OUTPUT->render($select);
1854     }
1856     if (!$vertical) {
1857         $output .= html_writer::end_tag('div');
1858     }
1860     $output .= html_writer::end_tag('div');
1862     if (course_ajax_enabled($course)) {
1863         $straddeither = get_string('addresourceoractivity');
1864         // The module chooser link
1865         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1866         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1867         $icon = $OUTPUT->pix_icon('t/add', $straddeither);
1868         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1869         $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1870         $modchooser.= html_writer::end_tag('div');
1871         $modchooser.= html_writer::end_tag('div');
1873         // Wrap the normal output in a noscript div
1874         $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1875         if ($usemodchooser) {
1876             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1877             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1878         } else {
1879             // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1880             $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1881             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
1882         }
1883         $output = $modchooser . $output;
1884     }
1886     if ($return) {
1887         return $output;
1888     } else {
1889         echo $output;
1890     }
1893 /**
1894  * Retrieve all metadata for the requested modules
1895  *
1896  * @param object $course The Course
1897  * @param array $modnames An array containing the list of modules and their
1898  * names
1899  * @param int $sectionreturn The section to return to
1900  * @return array A list of stdClass objects containing metadata about each
1901  * module
1902  */
1903 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1904     global $CFG, $OUTPUT;
1906     // get_module_metadata will be called once per section on the page and courses may show
1907     // different modules to one another
1908     static $modlist = array();
1909     if (!isset($modlist[$course->id])) {
1910         $modlist[$course->id] = array();
1911     }
1913     $return = array();
1914     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&sr='.$sectionreturn.'&add=';
1915     foreach($modnames as $modname => $modnamestr) {
1916         if (!course_allowed_module($course, $modname)) {
1917             continue;
1918         }
1919         if (isset($modlist[$modname])) {
1920             // This module is already cached
1921             $return[$modname] = $modlist[$course->id][$modname];
1922             continue;
1923         }
1925         // Include the module lib
1926         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1927         if (!file_exists($libfile)) {
1928             continue;
1929         }
1930         include_once($libfile);
1932         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1933         $gettypesfunc =  $modname.'_get_types';
1934         if (function_exists($gettypesfunc)) {
1935             if ($types = $gettypesfunc()) {
1936                 $group = new stdClass();
1937                 $group->name = $modname;
1938                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1939                 foreach($types as $type) {
1940                     if ($type->typestr === '--') {
1941                         continue;
1942                     }
1943                     if (strpos($type->typestr, '--') === 0) {
1944                         $group->title = str_replace('--', '', $type->typestr);
1945                         continue;
1946                     }
1947                     // Set the Sub Type metadata
1948                     $subtype = new stdClass();
1949                     $subtype->title = $type->typestr;
1950                     $subtype->type = str_replace('&amp;', '&', $type->type);
1951                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1952                     $subtype->archetype = $type->modclass;
1954                     // The group archetype should match the subtype archetypes and all subtypes
1955                     // should have the same archetype
1956                     $group->archetype = $subtype->archetype;
1958                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1959                         $subtype->help = get_string('help' . $subtype->name, $modname);
1960                     }
1961                     $subtype->link = $urlbase . $subtype->type;
1962                     $group->types[] = $subtype;
1963                 }
1964                 $modlist[$course->id][$modname] = $group;
1965             }
1966         } else {
1967             $module = new stdClass();
1968             $module->title = get_string('modulename', $modname);
1969             $module->name = $modname;
1970             $module->link = $urlbase . $modname;
1971             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1972             $sm = get_string_manager();
1973             if ($sm->string_exists('modulename_help', $modname)) {
1974                 $module->help = get_string('modulename_help', $modname);
1975                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1976                     $link = get_string('modulename_link', $modname);
1977                     $linktext = get_string('morehelp');
1978                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1979                 }
1980             }
1981             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1982             $modlist[$course->id][$modname] = $module;
1983         }
1984         $return[$modname] = $modlist[$course->id][$modname];
1985     }
1987     return $return;
1990 /**
1991  * Return the course category context for the category with id $categoryid, except
1992  * that if $categoryid is 0, return the system context.
1993  *
1994  * @param integer $categoryid a category id or 0.
1995  * @return object the corresponding context
1996  */
1997 function get_category_or_system_context($categoryid) {
1998     if ($categoryid) {
1999         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
2000     } else {
2001         return get_context_instance(CONTEXT_SYSTEM);
2002     }
2005 /**
2006  * Gets the child categories of a given courses category. Uses a static cache
2007  * to make repeat calls efficient.
2008  *
2009  * @param int $parentid the id of a course category.
2010  * @return array all the child course categories.
2011  */
2012 function get_child_categories($parentid) {
2013     static $allcategories = null;
2015     // only fill in this variable the first time
2016     if (null == $allcategories) {
2017         $allcategories = array();
2019         $categories = get_categories();
2020         foreach ($categories as $category) {
2021             if (empty($allcategories[$category->parent])) {
2022                 $allcategories[$category->parent] = array();
2023             }
2024             $allcategories[$category->parent][] = $category;
2025         }
2026     }
2028     if (empty($allcategories[$parentid])) {
2029         return array();
2030     } else {
2031         return $allcategories[$parentid];
2032     }
2035 /**
2036  * This function recursively travels the categories, building up a nice list
2037  * for display. It also makes an array that list all the parents for each
2038  * category.
2039  *
2040  * For example, if you have a tree of categories like:
2041  *   Miscellaneous (id = 1)
2042  *      Subcategory (id = 2)
2043  *         Sub-subcategory (id = 4)
2044  *   Other category (id = 3)
2045  * Then after calling this function you will have
2046  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2047  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2048  *      3 => 'Other category');
2049  * $parents = array(2 => array(1), 4 => array(1, 2));
2050  *
2051  * If you specify $requiredcapability, then only categories where the current
2052  * user has that capability will be added to $list, although all categories
2053  * will still be added to $parents, and if you only have $requiredcapability
2054  * in a child category, not the parent, then the child catgegory will still be
2055  * included.
2056  *
2057  * If you specify the option $excluded, then that category, and all its children,
2058  * are omitted from the tree. This is useful when you are doing something like
2059  * moving categories, where you do not want to allow people to move a category
2060  * to be the child of itself.
2061  *
2062  * @param array $list For output, accumulates an array categoryid => full category path name
2063  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2064  * @param string/array $requiredcapability if given, only categories where the current
2065  *      user has this capability will be added to $list. Can also be an array of capabilities,
2066  *      in which case they are all required.
2067  * @param integer $excludeid Omit this category and its children from the lists built.
2068  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2069  * @param string $path For internal use, as part of recursive calls.
2070  */
2071 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2072         $excludeid = 0, $category = NULL, $path = "") {
2074     // initialize the arrays if needed
2075     if (!is_array($list)) {
2076         $list = array();
2077     }
2078     if (!is_array($parents)) {
2079         $parents = array();
2080     }
2082     if (empty($category)) {
2083         // Start at the top level.
2084         $category = new stdClass;
2085         $category->id = 0;
2086     } else {
2087         // This is the excluded category, don't include it.
2088         if ($excludeid > 0 && $excludeid == $category->id) {
2089             return;
2090         }
2092         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2093         $categoryname = format_string($category->name, true, array('context' => $context));
2095         // Update $path.
2096         if ($path) {
2097             $path = $path.' / '.$categoryname;
2098         } else {
2099             $path = $categoryname;
2100         }
2102         // Add this category to $list, if the permissions check out.
2103         if (empty($requiredcapability)) {
2104             $list[$category->id] = $path;
2106         } else {
2107             $requiredcapability = (array)$requiredcapability;
2108             if (has_all_capabilities($requiredcapability, $context)) {
2109                 $list[$category->id] = $path;
2110             }
2111         }
2112     }
2114     // Add all the children recursively, while updating the parents array.
2115     if ($categories = get_child_categories($category->id)) {
2116         foreach ($categories as $cat) {
2117             if (!empty($category->id)) {
2118                 if (isset($parents[$category->id])) {
2119                     $parents[$cat->id]   = $parents[$category->id];
2120                 }
2121                 $parents[$cat->id][] = $category->id;
2122             }
2123             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2124         }
2125     }
2128 /**
2129  * This function generates a structured array of courses and categories.
2130  *
2131  * The depth of categories is limited by $CFG->maxcategorydepth however there
2132  * is no limit on the number of courses!
2133  *
2134  * Suitable for use with the course renderers course_category_tree method:
2135  * $renderer = $PAGE->get_renderer('core','course');
2136  * echo $renderer->course_category_tree(get_course_category_tree());
2137  *
2138  * @global moodle_database $DB
2139  * @param int $id
2140  * @param int $depth
2141  */
2142 function get_course_category_tree($id = 0, $depth = 0) {
2143     global $DB, $CFG;
2144     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2145     $categories = get_child_categories($id);
2146     $categoryids = array();
2147     foreach ($categories as $key => &$category) {
2148         if (!$category->visible && !$viewhiddencats) {
2149             unset($categories[$key]);
2150             continue;
2151         }
2152         $categoryids[$category->id] = $category;
2153         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2154             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2155             foreach ($subcategories as $subid=>$subcat) {
2156                 $categoryids[$subid] = $subcat;
2157             }
2158             $category->courses = array();
2159         }
2160     }
2162     if ($depth > 0) {
2163         // This is a recursive call so return the required array
2164         return array($categories, $categoryids);
2165     }
2167     if (empty($categoryids)) {
2168         // No categories available (probably all hidden).
2169         return array();
2170     }
2172     // The depth is 0 this function has just been called so we can finish it off
2174     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2175     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2176     $sql = "SELECT
2177             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2178             $ccselect
2179             FROM {course} c
2180             $ccjoin
2181             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2182     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2183         // loop throught them
2184         foreach ($courses as $course) {
2185             if ($course->id == SITEID) {
2186                 continue;
2187             }
2188             context_instance_preload($course);
2189             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2190                 $categoryids[$course->category]->courses[$course->id] = $course;
2191             }
2192         }
2193     }
2194     return $categories;
2197 /**
2198  * Recursive function to print out all the categories in a nice format
2199  * with or without courses included
2200  */
2201 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2202     global $CFG;
2204     // maxcategorydepth == 0 meant no limit
2205     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2206         return;
2207     }
2209     if (!$displaylist) {
2210         make_categories_list($displaylist, $parentslist);
2211     }
2213     if ($category) {
2214         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2215             print_category_info($category, $depth, $showcourses);
2216         } else {
2217             return;  // Don't bother printing children of invisible categories
2218         }
2220     } else {
2221         $category = new stdClass();
2222         $category->id = "0";
2223     }
2225     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2226         $countcats = count($categories);
2227         $count = 0;
2228         $first = true;
2229         $last = false;
2230         foreach ($categories as $cat) {
2231             $count++;
2232             if ($count == $countcats) {
2233                 $last = true;
2234             }
2235             $up = $first ? false : true;
2236             $down = $last ? false : true;
2237             $first = false;
2239             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2240         }
2241     }
2244 /**
2245  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2246  */
2247 function make_categories_options() {
2248     make_categories_list($cats,$parents);
2249     foreach ($cats as $key => $value) {
2250         if (array_key_exists($key,$parents)) {
2251             if ($indent = count($parents[$key])) {
2252                 for ($i = 0; $i < $indent; $i++) {
2253                     $cats[$key] = '&nbsp;'.$cats[$key];
2254                 }
2255             }
2256         }
2257     }
2258     return $cats;
2261 /**
2262  * Prints the category info in indented fashion
2263  * This function is only used by print_whole_category_list() above
2264  */
2265 function print_category_info($category, $depth=0, $showcourses = false) {
2266     global $CFG, $DB, $OUTPUT;
2268     $strsummary = get_string('summary');
2270     $catlinkcss = null;
2271     if (!$category->visible) {
2272         $catlinkcss = array('class'=>'dimmed');
2273     }
2274     static $coursecount = null;
2275     if (null === $coursecount) {
2276         // only need to check this once
2277         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2278     }
2280     if ($showcourses and $coursecount) {
2281         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2282     } else {
2283         $catimage = "&nbsp;";
2284     }
2286     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2287     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2288     $fullname = format_string($category->name, true, array('context' => $context));
2290     if ($showcourses and $coursecount) {
2291         echo '<div class="categorylist clearfix">';
2292         $cat = '';
2293         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2294         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2295         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2297         $html = '';
2298         if ($depth > 0) {
2299             for ($i=0; $i< $depth; $i++) {
2300                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2301                 $cat = '';
2302             }
2303         } else {
2304             $html = $cat;
2305         }
2306         echo html_writer::tag('div', $html, array('class'=>'category'));
2307         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2309         // does the depth exceed maxcategorydepth
2310         // maxcategorydepth == 0 or unset meant no limit
2311         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2312         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2313             foreach ($courses as $course) {
2314                 $linkcss = null;
2315                 if (!$course->visible) {
2316                     $linkcss = array('class'=>'dimmed');
2317                 }
2319                 $coursename = get_course_display_name_for_list($course);
2320                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2322                 // print enrol info
2323                 $courseicon = '';
2324                 if ($icons = enrol_get_course_info_icons($course)) {
2325                     foreach ($icons as $pix_icon) {
2326                         $courseicon = $OUTPUT->render($pix_icon).' ';
2327                     }
2328                 }
2330                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2332                 if ($course->summary) {
2333                     $link = new moodle_url('/course/info.php?id='.$course->id);
2334                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2335                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2336                         array('title'=>$strsummary));
2338                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2339                 }
2341                 $html = '';
2342                 for ($i=0; $i <= $depth; $i++) {
2343                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2344                     $coursecontent = '';
2345                 }
2346                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2347             }
2348         }
2349         echo '</div>';
2350     } else {
2351         echo '<div class="categorylist">';
2352         $html = '';
2353         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2354         if (count($courses) > 0) {
2355             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2356         }
2358         if ($depth > 0) {
2359             for ($i=0; $i< $depth; $i++) {
2360                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2361                 $cat = '';
2362             }
2363         } else {
2364             $html = $cat;
2365         }
2367         echo html_writer::tag('div', $html, array('class'=>'category'));
2368         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2369         echo '</div>';
2370     }
2373 /**
2374  * Print the buttons relating to course requests.
2375  *
2376  * @param object $systemcontext the system context.
2377  */
2378 function print_course_request_buttons($systemcontext) {
2379     global $CFG, $DB, $OUTPUT;
2380     if (empty($CFG->enablecourserequests)) {
2381         return;
2382     }
2383     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2384     /// Print a button to request a new course
2385         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2386     }
2387     /// Print a button to manage pending requests
2388     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2389         $disabled = !$DB->record_exists('course_request', array());
2390         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2391     }
2394 /**
2395  * Does the user have permission to edit things in this category?
2396  *
2397  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2398  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2399  */
2400 function can_edit_in_category($categoryid = 0) {
2401     $context = get_category_or_system_context($categoryid);
2402     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2405 /**
2406  * Prints the turn editing on/off button on course/index.php or course/category.php.
2407  *
2408  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2409  * @return string HTML of the editing button, or empty string, if this user is not allowed
2410  *      to see it.
2411  */
2412 function update_category_button($categoryid = 0) {
2413     global $CFG, $PAGE, $OUTPUT;
2415     // Check permissions.
2416     if (!can_edit_in_category($categoryid)) {
2417         return '';
2418     }
2420     // Work out the appropriate action.
2421     if ($PAGE->user_is_editing()) {
2422         $label = get_string('turneditingoff');
2423         $edit = 'off';
2424     } else {
2425         $label = get_string('turneditingon');
2426         $edit = 'on';
2427     }
2429     // Generate the button HTML.
2430     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2431     if ($categoryid) {
2432         $options['id'] = $categoryid;
2433         $page = 'category.php';
2434     } else {
2435         $page = 'index.php';
2436     }
2437     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2440 /**
2441  * Category is 0 (for all courses) or an object
2442  */
2443 function print_courses($category) {
2444     global $CFG, $OUTPUT;
2446     if (!is_object($category) && $category==0) {
2447         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2448         if (is_array($categories) && count($categories) == 1) {
2449             $category   = array_shift($categories);
2450             $courses    = get_courses_wmanagers($category->id,
2451                                                 'c.sortorder ASC',
2452                                                 array('summary','summaryformat'));
2453         } else {
2454             $courses    = get_courses_wmanagers('all',
2455                                                 'c.sortorder ASC',
2456                                                 array('summary','summaryformat'));
2457         }
2458         unset($categories);
2459     } else {
2460         $courses    = get_courses_wmanagers($category->id,
2461                                             'c.sortorder ASC',
2462                                             array('summary','summaryformat'));
2463     }
2465     if ($courses) {
2466         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2467         foreach ($courses as $course) {
2468             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2469             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2470                 echo html_writer::start_tag('li');
2471                 print_course($course);
2472                 echo html_writer::end_tag('li');
2473             }
2474         }
2475         echo html_writer::end_tag('ul');
2476     } else {
2477         echo $OUTPUT->heading(get_string("nocoursesyet"));
2478         $context = get_context_instance(CONTEXT_SYSTEM);
2479         if (has_capability('moodle/course:create', $context)) {
2480             $options = array();
2481             if (!empty($category->id)) {
2482                 $options['category'] = $category->id;
2483             } else {
2484                 $options['category'] = $CFG->defaultrequestcategory;
2485             }
2486             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2487             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2488             echo html_writer::end_tag('div');
2489         }
2490     }
2493 /**
2494  * Print a description of a course, suitable for browsing in a list.
2495  *
2496  * @param object $course the course object.
2497  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2498  */
2499 function print_course($course, $highlightterms = '') {
2500     global $CFG, $USER, $DB, $OUTPUT;
2502     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2504     // Rewrite file URLs so that they are correct
2505     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2507     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2508     echo html_writer::start_tag('div', array('class'=>'info'));
2509     echo html_writer::start_tag('h3', array('class'=>'name'));
2511     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2513     $coursename = get_course_display_name_for_list($course);
2514     $linktext = highlight($highlightterms, format_string($coursename));
2515     $linkparams = array('title'=>get_string('entercourse'));
2516     if (empty($course->visible)) {
2517         $linkparams['class'] = 'dimmed';
2518     }
2519     echo html_writer::link($linkhref, $linktext, $linkparams);
2520     echo html_writer::end_tag('h3');
2522     /// first find all roles that are supposed to be displayed
2523     if (!empty($CFG->coursecontact)) {
2524         $managerroles = explode(',', $CFG->coursecontact);
2525         $namesarray = array();
2526         $rusers = array();
2528         if (!isset($course->managers)) {
2529             $rusers = get_role_users($managerroles, $context, true,
2530                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2531                  r.name AS rolename, r.sortorder, r.id AS roleid',
2532                 'r.sortorder ASC, u.lastname ASC');
2533         } else {
2534             //  use the managers array if we have it for perf reasosn
2535             //  populate the datastructure like output of get_role_users();
2536             foreach ($course->managers as $manager) {
2537                 $u = new stdClass();
2538                 $u = $manager->user;
2539                 $u->roleid = $manager->roleid;
2540                 $u->rolename = $manager->rolename;
2542                 $rusers[] = $u;
2543             }
2544         }
2546         /// Rename some of the role names if needed
2547         if (isset($context)) {
2548             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2549         }
2551         $namesarray = array();
2552         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2553         foreach ($rusers as $ra) {
2554             if (isset($namesarray[$ra->id])) {
2555                 //  only display a user once with the higest sortorder role
2556                 continue;
2557             }
2559             if (isset($aliasnames[$ra->roleid])) {
2560                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2561             }
2563             $fullname = fullname($ra, $canviewfullnames);
2564             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2565                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2566         }
2568         if (!empty($namesarray)) {
2569             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2570             foreach ($namesarray as $name) {
2571                 echo html_writer::tag('li', $name);
2572             }
2573             echo html_writer::end_tag('ul');
2574         }
2575     }
2576     echo html_writer::end_tag('div'); // End of info div
2578     echo html_writer::start_tag('div', array('class'=>'summary'));
2579     $options = new stdClass();
2580     $options->noclean = true;
2581     $options->para = false;
2582     $options->overflowdiv = true;
2583     if (!isset($course->summaryformat)) {
2584         $course->summaryformat = FORMAT_MOODLE;
2585     }
2586     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2587     if ($icons = enrol_get_course_info_icons($course)) {
2588         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2589         foreach ($icons as $icon) {
2590             echo $OUTPUT->render($icon);
2591         }
2592         echo html_writer::end_tag('div'); // End of enrolmenticons div
2593     }
2594     echo html_writer::end_tag('div'); // End of summary div
2595     echo html_writer::end_tag('div'); // End of coursebox div
2598 /**
2599  * Prints custom user information on the home page.
2600  * Over time this can include all sorts of information
2601  */
2602 function print_my_moodle() {
2603     global $USER, $CFG, $DB, $OUTPUT;
2605     if (!isloggedin() or isguestuser()) {
2606         print_error('nopermissions', '', '', 'See My Moodle');
2607     }
2609     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2610     $rhosts   = array();
2611     $rcourses = array();
2612     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2613         $rcourses = get_my_remotecourses($USER->id);
2614         $rhosts   = get_my_remotehosts();
2615     }
2617     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2619         if (!empty($courses)) {
2620             echo '<ul class="unlist">';
2621             foreach ($courses as $course) {
2622                 if ($course->id == SITEID) {
2623                     continue;
2624                 }
2625                 echo '<li>';
2626                 print_course($course);
2627                 echo "</li>\n";
2628             }
2629             echo "</ul>\n";
2630         }
2632         // MNET
2633         if (!empty($rcourses)) {
2634             // at the IDP, we know of all the remote courses
2635             foreach ($rcourses as $course) {
2636                 print_remote_course($course, "100%");
2637             }
2638         } elseif (!empty($rhosts)) {
2639             // non-IDP, we know of all the remote servers, but not courses
2640             foreach ($rhosts as $host) {
2641                 print_remote_host($host, "100%");
2642             }
2643         }
2644         unset($course);
2645         unset($host);
2647         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2648             echo "<table width=\"100%\"><tr><td align=\"center\">";
2649             print_course_search("", false, "short");
2650             echo "</td><td align=\"center\">";
2651             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2652             echo "</td></tr></table>\n";
2653         }
2655     } else {
2656         if ($DB->count_records("course_categories") > 1) {
2657             echo $OUTPUT->box_start("categorybox");
2658             print_whole_category_list();
2659             echo $OUTPUT->box_end();
2660         } else {
2661             print_courses(0);
2662         }
2663     }
2667 function print_course_search($value="", $return=false, $format="plain") {
2668     global $CFG;
2669     static $count = 0;
2671     $count++;
2673     $id = 'coursesearch';
2675     if ($count > 1) {
2676         $id .= $count;
2677     }
2679     $strsearchcourses= get_string("searchcourses");
2681     if ($format == 'plain') {
2682         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2683         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2684         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2685         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2686         $output .= '<input type="submit" value="'.get_string('go').'" />';
2687         $output .= '</fieldset></form>';
2688     } else if ($format == 'short') {
2689         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2690         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2691         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2692         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2693         $output .= '<input type="submit" value="'.get_string('go').'" />';
2694         $output .= '</fieldset></form>';
2695     } else if ($format == 'navbar') {
2696         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2697         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2698         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2699         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2700         $output .= '<input type="submit" value="'.get_string('go').'" />';
2701         $output .= '</fieldset></form>';
2702     }
2704     if ($return) {
2705         return $output;
2706     }
2707     echo $output;
2710 function print_remote_course($course, $width="100%") {
2711     global $CFG, $USER;
2713     $linkcss = '';
2715     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2717     echo '<div class="coursebox remotecoursebox clearfix">';
2718     echo '<div class="info">';
2719     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2720          $linkcss.' href="'.$url.'">'
2721         .  format_string($course->fullname) .'</a><br />'
2722         . format_string($course->hostname) . ' : '
2723         . format_string($course->cat_name) . ' : '
2724         . format_string($course->shortname). '</div>';
2725     echo '</div><div class="summary">';
2726     $options = new stdClass();
2727     $options->noclean = true;
2728     $options->para = false;
2729     $options->overflowdiv = true;
2730     echo format_text($course->summary, $course->summaryformat, $options);
2731     echo '</div>';
2732     echo '</div>';
2735 function print_remote_host($host, $width="100%") {
2736     global $OUTPUT;
2738     $linkcss = '';
2740     echo '<div class="coursebox clearfix">';
2741     echo '<div class="info">';
2742     echo '<div class="name">';
2743     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2744     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2745         . s($host['name']).'</a> - ';
2746     echo $host['count'] . ' ' . get_string('courses');
2747     echo '</div>';
2748     echo '</div>';
2749     echo '</div>';
2753 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2755 function add_course_module($mod) {
2756     global $DB;
2758     $mod->added = time();
2759     unset($mod->id);
2761     return $DB->insert_record("course_modules", $mod);
2764 /**
2765  * Returns course section - creates new if does not exist yet.
2766  * @param int $relative section number
2767  * @param int $courseid
2768  * @return object $course_section object
2769  */
2770 function get_course_section($section, $courseid) {
2771     global $DB;
2773     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2774         return $cw;
2775     }
2776     $cw = new stdClass();
2777     $cw->course   = $courseid;
2778     $cw->section  = $section;
2779     $cw->summary  = "";
2780     $cw->summaryformat = FORMAT_HTML;
2781     $cw->sequence = "";
2782     $id = $DB->insert_record("course_sections", $cw);
2783     rebuild_course_cache($courseid, true);
2784     return $DB->get_record("course_sections", array("id"=>$id));
2787 /**
2788  * Given a full mod object with section and course already defined, adds this module to that section.
2789  *
2790  * @param object $mod
2791  * @param int $beforemod An existing ID which we will insert the new module before
2792  * @return int The course_sections ID where the mod is inserted
2793  */
2794 function add_mod_to_section($mod, $beforemod=NULL) {
2795     global $DB;
2797     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2799         $section->sequence = trim($section->sequence);
2801         if (empty($section->sequence)) {
2802             $newsequence = "$mod->coursemodule";
2804         } else if ($beforemod) {
2805             $modarray = explode(",", $section->sequence);
2807             if ($key = array_keys($modarray, $beforemod->id)) {
2808                 $insertarray = array($mod->id, $beforemod->id);
2809                 array_splice($modarray, $key[0], 1, $insertarray);
2810                 $newsequence = implode(",", $modarray);
2812             } else {  // Just tack it on the end anyway
2813                 $newsequence = "$section->sequence,$mod->coursemodule";
2814             }
2816         } else {
2817             $newsequence = "$section->sequence,$mod->coursemodule";
2818         }
2820         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2821         return $section->id;     // Return course_sections ID that was used.
2823     } else {  // Insert a new record
2824         $section = new stdClass();
2825         $section->course   = $mod->course;
2826         $section->section  = $mod->section;
2827         $section->summary  = "";
2828         $section->summaryformat = FORMAT_HTML;
2829         $section->sequence = $mod->coursemodule;
2830         return $DB->insert_record("course_sections", $section);
2831     }
2834 function set_coursemodule_groupmode($id, $groupmode) {
2835     global $DB;
2836     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2839 function set_coursemodule_idnumber($id, $idnumber) {
2840     global $DB;
2841     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2844 /**
2845 * $prevstateoverrides = true will set the visibility of the course module
2846 * to what is defined in visibleold. This enables us to remember the current
2847 * visibility when making a whole section hidden, so that when we toggle
2848 * that section back to visible, we are able to return the visibility of
2849 * the course module back to what it was originally.
2850 */
2851 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2852     global $DB, $CFG;
2853     require_once($CFG->libdir.'/gradelib.php');
2855     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2856         return false;
2857     }
2858     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2859         return false;
2860     }
2861     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2862         foreach($events as $event) {
2863             if ($visible) {
2864                 show_event($event);
2865             } else {
2866                 hide_event($event);
2867             }
2868         }
2869     }
2871     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2872     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2873     if ($grade_items) {
2874         foreach ($grade_items as $grade_item) {
2875             $grade_item->set_hidden(!$visible);
2876         }
2877     }
2879     if ($prevstateoverrides) {
2880         if ($visible == '0') {
2881             // Remember the current visible state so we can toggle this back.
2882             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2883         } else {
2884             // Get the previous saved visible states.
2885             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2886         }
2887     }
2888     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2891 /**
2892  * Delete a course module and any associated data at the course level (events)
2893  * Until 1.5 this function simply marked a deleted flag ... now it
2894  * deletes it completely.
2895  *
2896  */
2897 function delete_course_module($id) {
2898     global $CFG, $DB;
2899     require_once($CFG->libdir.'/gradelib.php');
2900     require_once($CFG->dirroot.'/blog/lib.php');
2902     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2903         return true;
2904     }
2905     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2906     //delete events from calendar
2907     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2908         foreach($events as $event) {
2909             delete_event($event->id);
2910         }
2911     }
2912     //delete grade items, outcome items and grades attached to modules
2913     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2914                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2915         foreach ($grade_items as $grade_item) {
2916             $grade_item->delete('moddelete');
2917         }
2918     }
2919     // Delete completion and availability data; it is better to do this even if the
2920     // features are not turned on, in case they were turned on previously (these will be
2921     // very quick on an empty table)
2922     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2923     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2924     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2925                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2927     delete_context(CONTEXT_MODULE, $cm->id);
2928     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2931 function delete_mod_from_section($mod, $section) {
2932     global $DB;
2934     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2936         $modarray = explode(",", $section->sequence);
2938         if ($key = array_keys ($modarray, $mod)) {
2939             array_splice($modarray, $key[0], 1);
2940             $newsequence = implode(",", $modarray);
2941             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2942         } else {
2943             return false;
2944         }
2946     }
2947     return false;
2950 /**
2951  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2952  *
2953  * @param object $course course object
2954  * @param int $section Section number (not id!!!)
2955  * @param int $move (-1 or 1)
2956  * @return boolean true if section moved successfully
2957  * @todo MDL-33379 remove this function in 2.5
2958  */
2959 function move_section($course, $section, $move) {
2960     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2962 /// Moves a whole course section up and down within the course
2963     global $USER, $DB;
2965     if (!$move) {
2966         return true;
2967     }
2969     $sectiondest = $section + $move;
2971     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2972         return false;
2973     }
2975     $retval = move_section_to($course, $section, $sectiondest);
2976     // If section moved, then rebuild course cache.
2977     if ($retval) {
2978         rebuild_course_cache($course->id, true);
2979     }
2980     return $retval;
2983 /**
2984  * Moves a section within a course, from a position to another.
2985  * Be very careful: $section and $destination refer to section number,
2986  * not id!.
2987  *
2988  * @param object $course
2989  * @param int $section Section number (not id!!!)
2990  * @param int $destination
2991  * @return boolean Result
2992  */
2993 function move_section_to($course, $section, $destination) {
2994 /// Moves a whole course section up and down within the course
2995     global $USER, $DB;
2997     if (!$destination && $destination != 0) {
2998         return true;
2999     }
3001     if (($destination > $course->numsections) || ($destination < 1)) {
3002         return false;
3003     }
3005     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3006     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3007             'section ASC, id ASC', 'id, section')) {
3008         return false;
3009     }
3011     $movedsections = reorder_sections($sections, $section, $destination);
3013     // Update all sections. Do this in 2 steps to avoid breaking database
3014     // uniqueness constraint
3015     $transaction = $DB->start_delegated_transaction();
3016     foreach ($movedsections as $id => $position) {
3017         if ($sections[$id] !== $position) {
3018             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3019         }
3020     }
3021     foreach ($movedsections as $id => $position) {
3022         if ($sections[$id] !== $position) {
3023             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3024         }
3025     }
3027     // If we move the highlighted section itself, then just highlight the destination.
3028     // Adjust the higlighted section location if we move something over it either direction.
3029     if ($section == $course->marker) {
3030         course_set_marker($course->id, $destination);
3031     } elseif ($section > $course->marker && $course->marker >= $destination) {
3032         course_set_marker($course->id, $course->marker+1);
3033     } elseif ($section < $course->marker && $course->marker <= $destination) {
3034         course_set_marker($course->id, $course->marker-1);
3035     }
3037     $transaction->allow_commit();
3038     return true;
3041 /**
3042  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3043  * an original position number and a target position number, rebuilds the array so that the
3044  * move is made without any duplication of section positions.
3045  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3046  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3047  *
3048  * @param array $sections
3049  * @param int $origin_position
3050  * @param int $target_position
3051  * @return array
3052  */
3053 function reorder_sections($sections, $origin_position, $target_position) {
3054     if (!is_array($sections)) {
3055         return false;
3056     }
3058     // We can't move section position 0
3059     if ($origin_position < 1) {
3060         echo "We can't move section position 0";
3061         return false;
3062     }
3064     // Locate origin section in sections array
3065     if (!$origin_key = array_search($origin_position, $sections)) {
3066         echo "searched position not in sections array";
3067         return false; // searched position not in sections array
3068     }
3070     // Extract origin section
3071     $origin_section = $sections[$origin_key];
3072     unset($sections[$origin_key]);
3074     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3075     $found = false;
3076     $append_array = array();
3077     foreach ($sections as $id => $position) {
3078         if ($found) {
3079             $append_array[$id] = $position;
3080             unset($sections[$id]);
3081         }
3082         if ($position == $target_position) {
3083             if ($target_position < $origin_position) {
3084                 $append_array[$id] = $position;
3085                 unset($sections[$id]);
3086             }
3087             $found = true;
3088         }
3089     }
3091     // Append moved section
3092     $sections[$origin_key] = $origin_section;
3094     // Append rest of array (if applicable)
3095     if (!empty($append_array)) {
3096         foreach ($append_array as $id => $position) {
3097             $sections[$id] = $position;
3098         }
3099     }
3101     // Renumber positions
3102     $position = 0;
3103     foreach ($sections as $id => $p) {
3104         $sections[$id] = $position;
3105         $position++;
3106     }
3108     return $sections;
3112 /**
3113  * Move the module object $mod to the specified $section
3114  * If $beforemod exists then that is the module
3115  * before which $modid should be inserted
3116  * All parameters are objects
3117  */
3118 function moveto_module($mod, $section, $beforemod=NULL) {
3119     global $DB, $OUTPUT;
3121 /// Remove original module from original section
3122     if (! delete_mod_from_section($mod->id, $mod->section)) {
3123         echo $OUTPUT->notification("Could not delete module from existing section");
3124     }
3126 /// Update module itself if necessary
3128     if ($mod->section != $section->id) {
3129         $mod->section = $section->id;
3130         $DB->update_record("course_modules", $mod);
3131         // if moving to a hidden section then hide module
3132         if (!$section->visible) {
3133             set_coursemodule_visible($mod->id, 0);
3134         }
3135     }
3137 /// Add the module into the new section
3139     $mod->course       = $section->course;
3140     $mod->section      = $section->section;  // need relative reference
3141     $mod->coursemodule = $mod->id;
3143     if (! add_mod_to_section($mod, $beforemod)) {
3144         return false;
3145     }
3147     return true;
3150 /**
3151  * Produces the editing buttons for a module
3152  *
3153  * @global core_renderer $OUTPUT
3154  * @staticvar type $str
3155  * @param stdClass $mod The module to produce editing buttons for
3156  * @param bool $absolute_ignored ignored - all links are absolute
3157  * @param bool $moveselect If true a move seleciton process is used (default true)
3158  * @param int $indent The current indenting
3159  * @param int $section The section to link back to
3160  * @return string XHTML for the editing buttons
3161  */
3162 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3163     global $CFG, $OUTPUT, $COURSE;
3165     static $str;
3167     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3168     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3170     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3171     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3173     // no permission to edit anything
3174     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3175         return false;
3176     }
3178     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3180     if (!isset($str)) {
3181         $str = new stdClass;
3182         $str->assign         = get_string("assignroles", 'role');
3183         $str->delete         = get_string("delete");
3184         $str->move           = get_string("move");
3185         $str->moveup         = get_string("moveup");
3186         $str->movedown       = get_string("movedown");
3187         $str->moveright      = get_string("moveright");
3188         $str->moveleft       = get_string("moveleft");
3189         $str->update         = get_string("update");
3190         $str->duplicate      = get_string("duplicate");
3191         $str->hide           = get_string("hide");
3192         $str->show           = get_string("show");
3193         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3194         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3195         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3196         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3197         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3198         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3199         $str->edittitle = get_string('edittitle', 'moodle');
3200     }
3202     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3204     if ($section !== null) {
3205         $baseurl->param('sr', $section);
3206     }
3207     $actions = array();
3209     // AJAX edit title
3210     if ($mod->modname !== 'label' && $hasmanageactivities && course_ajax_enabled($COURSE)) {
3211         $actions[] = new action_link(
3212             new moodle_url($baseurl, array('update' => $mod->id)),
3213             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3214             null,
3215             array('class' => 'editing_title', 'title' => $str->edittitle)
3216         );
3217     }
3219     // leftright
3220     if ($hasmanageactivities) {
3221         if (right_to_left()) {   // Exchange arrows on RTL
3222             $rightarrow = 't/left';
3223             $leftarrow  = 't/right';
3224         } else {
3225             $rightarrow = 't/right';
3226             $leftarrow  = 't/left';
3227         }
3229         if ($indent > 0) {
3230             $actions[] = new action_link(
3231                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3232                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3233                 null,
3234                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3235             );
3236         }
3237         if ($indent >= 0) {
3238             $actions[] = new action_link(
3239                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3240                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3241                 null,
3242                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3243             );
3244         }
3245     }
3247     // move
3248     if ($hasmanageactivities) {
3249         if ($moveselect) {
3250             $actions[] = new action_link(
3251                 new moodle_url($baseurl, array('copy' => $mod->id)),
3252                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3253                 null,
3254                 array('class' => 'editing_move', 'title' => $str->move)
3255             );
3256         } else {
3257             $actions[] = new action_link(
3258                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3259                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3260                 null,
3261                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3262             );
3263             $actions[] = new action_link(
3264                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3265                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3266                 null,
3267                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3268             );
3269         }
3270     }
3272     // Update
3273     if ($hasmanageactivities) {
3274         $actions[] = new action_link(
3275             new moodle_url($baseurl, array('update' => $mod->id)),
3276             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3277             null,
3278             array('class' => 'editing_update', 'title' => $str->update)
3279         );
3280     }
3282     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3283     if (has_all_capabilities($dupecaps, $coursecontext) && plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3284         $actions[] = new action_link(
3285             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3286             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3287             null,
3288             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3289         );
3290     }
3292     // Delete
3293     if ($hasmanageactivities) {
3294         $actions[] = new action_link(
3295             new moodle_url($baseurl, array('delete' => $mod->id)),
3296             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3297             null,
3298             array('class' => 'editing_delete', 'title' => $str->delete)
3299         );
3300     }
3302     // hideshow
3303     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3304         if ($mod->visible) {
3305             $actions[] = new action_link(
3306                 new moodle_url($baseurl, array('hide' => $mod->id)),
3307                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3308                 null,
3309                 array('class' => 'editing_hide', 'title' => $str->hide)
3310             );
3311         } else {
3312             $actions[] = new action_link(
3313                 new moodle_url($baseurl, array('show' => $mod->id)),
3314                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3315                 null,
3316                 array('class' => 'editing_show', 'title' => $str->show)
3317             );
3318         }
3319     }
3321     // groupmode
3322     if ($hasmanageactivities and $mod->groupmode !== false) {
3323         if ($mod->groupmode == SEPARATEGROUPS) {
3324             $groupmode = 0;
3325             $grouptitle = $str->groupsseparate;
3326             $forcedgrouptitle = $str->forcedgroupsseparate;
3327             $groupclass = 'editing_groupsseparate';
3328             $groupimage = 't/groups';
3329         } else if ($mod->groupmode == VISIBLEGROUPS) {
3330             $groupmode = 1;
3331             $grouptitle = $str->groupsvisible;
3332             $forcedgrouptitle = $str->forcedgroupsvisible;
3333             $groupclass = 'editing_groupsvisible';
3334             $groupimage = 't/groupv';
3335         } else {
3336             $groupmode = 2;
3337             $grouptitle = $str->groupsnone;
3338             $forcedgrouptitle = $str->forcedgroupsnone;
3339             $groupclass = 'editing_groupsnone';
3340             $groupimage = 't/groupn';
3341         }
3342         if ($mod->groupmodelink) {
3343             $actions[] = new action_link(
3344                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3345                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3346                 null,
3347                 array('class' => $groupclass, 'title' => $grouptitle)
3348             );
3349         } else {
3350             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3351         }
3352     }
3354     // Assign
3355     if (has_capability('moodle/role:assign', $modcontext)){
3356         $actions[] = new action_link(
3357             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3358             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3359             null,
3360             array('class' => 'editing_assign', 'title' => $str->assign)
3361         );
3362     }
3364     $output = html_writer::start_tag('span', array('class' => 'commands'));
3365     foreach ($actions as $action) {
3366         if ($action instanceof renderable) {
3367             $output .= $OUTPUT->render($action);
3368         } else {
3369             $output .= $action;
3370         }
3371     }
3372     $output .= html_writer::end_tag('span');
3373     return $output;
3376 /**
3377  * given a course object with shortname & fullname, this function will
3378  * truncate the the number of chars allowed and add ... if it was too long
3379  */
3380 function course_format_name ($course,$max=100) {
3382     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3383     $shortname = format_string($course->shortname, true, array('context' => $context));
3384     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3385     $str = $shortname.': '. $fullname;
3386     if (textlib::strlen($str) <= $max) {
3387         return $str;
3388     }
3389     else {
3390         return textlib::substr($str,0,$max-3).'...';
3391     }
3394 /**
3395  * Is the user allowed to add this type of module to this course?
3396  * @param object $course the course settings. Only $course->id is used.
3397  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3398  * @return bool whether the current user is allowed to add this type of module to this course.
3399  */
3400 function course_allowed_module($course, $modname) {
3401     global $DB;
3403     if (is_numeric($modname)) {
3404         throw new coding_exception('Function course_allowed_module no longer
3405                 supports numeric module ids. Please update your code to pass the module name.');
3406     }
3408     $capability = 'mod/' . $modname . ':addinstance';
3409     if (!get_capability_info($capability)) {
3410         // Debug warning that the capability does not exist, but no more than once per page.
3411         static $warned = array();
3412         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3413         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3414             debugging('The module ' . $modname . ' does not define the standard capability ' .
3415                     $capability , DEBUG_DEVELOPER);
3416             $warned[$modname] = 1;
3417         }
3419         // If the capability does not exist, the module can always be added.
3420         return true;
3421     }
3423     $coursecontext = context_course::instance($course->id);
3424     return has_capability($capability, $coursecontext);
3427 /**
3428  * Recursively delete category including all subcategories and courses.
3429  * @param stdClass $category
3430  * @param boolean $showfeedback display some notices
3431  * @return array return deleted courses
3432  */
3433 function category_delete_full($category, $showfeedback=true) {
3434     global $CFG, $DB;
3435     require_once($CFG->libdir.'/gradelib.php');
3436     require_once($CFG->libdir.'/questionlib.php');
3437     require_once($CFG->dirroot.'/cohort/lib.php');
3439     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3440         foreach ($children as $childcat) {
3441             category_delete_full($childcat, $showfeedback);
3442         }
3443     }
3445     $deletedcourses = array();
3446     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3447         foreach ($courses as $course) {
3448             if (!delete_course($course, false)) {
3449                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3450             }
3451             $deletedcourses[] = $course;
3452         }
3453     }
3455     // move or delete cohorts in this context
3456     cohort_delete_category($category);
3458     // now delete anything that may depend on course category context
3459     grade_course_category_delete($category->id, 0, $showfeedback);
3460     if (!question_delete_course_category($category, 0, $showfeedback)) {
3461         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3462     }
3464     // finally delete the category and it's context
3465     $DB->delete_records('course_categories', array('id'=>$category->id));
3466     delete_context(CONTEXT_COURSECAT, $category->id);
3468     events_trigger('course_category_deleted', $category);
3470     return $deletedcourses;
3473 /**
3474  * Delete category, but move contents to another category.
3475  * @param object $ccategory
3476  * @param int $newparentid category id
3477  * @return bool status
3478  */
3479 function category_delete_move($category, $newparentid, $showfeedback=true) {
3480     global $CFG, $DB, $OUTPUT;
3481     require_once($CFG->libdir.'/gradelib.php');
3482     require_once($CFG->libdir.'/questionlib.php');
3483     require_once($CFG->dirroot.'/cohort/lib.php');
3485     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3486         return false;
3487     }
3489     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3490         foreach ($children as $childcat) {
3491             move_category($childcat, $newparentcat);
3492         }
3493     }
3495     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3496         if (!move_courses(array_keys($courses), $newparentid)) {
3497             if ($showfeedback) {
3498                 echo $OUTPUT->notification("Error moving courses");
3499             }
3500             return false;
3501         }
3502         if ($showfeedback) {
3503             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3504         }
3505     }
3507     // move or delete cohorts in this context
3508     cohort_delete_category($category);
3510     // now delete anything that may depend on course category context
3511     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3512     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3513         if ($showfeedback) {
3514             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3515         }
3516         return false;
3517     }
3519     // finally delete the category and it's context
3520     $DB->delete_records('course_categories', array('id'=>$category->id));
3521     delete_context(CONTEXT_COURSECAT, $category->id);
3523     events_trigger('course_category_deleted', $category);
3525     if ($showfeedback) {
3526         echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3527     }
3528     return true;
3531 /**
3532  * Efficiently moves many courses around while maintaining
3533  * sortorder in order.
3534  *
3535  * @param array $courseids is an array of course ids
3536  * @param int $categoryid
3537  * @return bool success
3538  */
3539 function move_courses($courseids, $categoryid) {
3540     global $CFG, $DB, $OUTPUT;
3542     if (empty($courseids)) {
3543         // nothing to do
3544         return;
3545     }
3547     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3548         return false;
3549     }
3551     $courseids = array_reverse($courseids);
3552     $newparent = get_context_instance(CONTEXT_COURSECAT, $category->id);
3553     $i = 1;
3555     foreach ($courseids as $courseid) {
3556         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3557             $course = new stdClass();
3558             $course->id = $courseid;
3559             $course->category  = $category->id;
3560             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3561             if ($category->visible == 0) {
3562                 // hide the course when moving into hidden category,
3563                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3564                 $course->visible = 0;
3565             }
3567             $DB->update_record('course', $course);
3569             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3570             context_moved($context, $newparent);
3571         }
3572     }
3573     fix_course_sortorder();
3575     return true;
3578 /**
3579  * Hide course category and child course and subcategories
3580  * @param stdClass $category
3581  * @return void
3582  */
3583 function course_category_hide($category) {
3584     global $DB;
3586     $category->visible = 0;
3587     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3588     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3589     $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
3590     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3591     // get all child categories and hide too
3592     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3593         foreach ($subcats as $cat) {
3594             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3595             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3596             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3597             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3598         }
3599     }
3602 /**
3603  * Show course category and child course and subcategories
3604  * @param stdClass $category
3605  * @return void
3606  */
3607 function course_category_show($category) {
3608     global $DB;
3610     $category->visible = 1;
3611     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3612     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3613     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3614     // get all child categories and unhide too
3615     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3616         foreach ($subcats as $cat) {
3617             if ($cat->visibleold) {
3618                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3619             }
3620             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3621         }
3622     }
3625 /**
3626  * Efficiently moves a category - NOTE that this can have
3627  * a huge impact access-control-wise...
3628  */
3629 function move_category($category, $newparentcat) {
3630     global $CFG, $DB;
3632     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3634     $hidecat = false;
3635     if (empty($newparentcat->id)) {
3636         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3638         $newparent = get_context_instance(CONTEXT_SYSTEM);
3640     } else {
3641         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3642         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3644         if (!$newparentcat->visible and $category->visible) {
3645             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3646             $hidecat = true;
3647         }
3648     }
3650     context_moved($context, $newparent);
3652     // now make it last in new category
3653     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3655     // and fix the sortorders
3656     fix_course_sortorder();
3658     if ($hidecat) {
3659         course_category_hide($category);
3660     }
3663 /**
3664  * Returns the display name of the given section that the course prefers.
3665  *
3666  * This function utilizes a callback that can be implemented within the course
3667  * formats lib.php file to customize the display name that is used to reference
3668  * the section.
3669  *
3670  * By default (if callback is not defined) the method
3671  * {@see get_numeric_section_name} is called instead.
3672  *
3673  * @param stdClass $course The course to get the section name for
3674  * @param stdClass $section Section object from database
3675  * @return Display name that the course format prefers, e.g. "Week 2"
3676  *
3677  * @see get_generic_section_name
3678  */
3679 function get_section_name(stdClass $course, stdClass $section) {
3680     global $CFG;
3682     /// Inelegant hack for bug 3408
3683     if ($course->format == 'site') {
3684         return get_string('site');
3685     }
3687     // Use course formatter callback if it exists
3688     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3689     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3690     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3691         require_once $namingfile;
3692     }
3693     if (function_exists($namingfunction)) {
3694         return $namingfunction($course, $section);
3695     }
3697     // else, default behavior:
3698     return get_generic_section_name($course->format, $section);
3701 /**
3702  * Gets the generic section name for a courses section.
3703  *
3704  * @param string $format Course format ID e.g. 'weeks' $course->format
3705  * @param stdClass $section Section object from database
3706  * @return Display name that the course format prefers, e.g. "Week 2"
3707  */
3708 function get_generic_section_name($format, stdClass $section) {
3709     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3713 function course_format_uses_sections($format) {
3714     global $CFG;
3716     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3717     $featurefunction = 'callback_'.$format.'_uses_sections';
3718     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3719         require_once $featurefile;
3720     }
3721     if (function_exists($featurefunction)) {
3722         return $featurefunction();
3723     }
3725     return false;
3728 /**
3729  * Returns the information about the ajax support in the given source format
3730  *
3731  * The returned object's property (boolean)capable indicates that
3732  * the course format supports Moodle course ajax features.
3733  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3734  *
3735  * @param string $format
3736  * @return stdClass
3737  */
3738 function course_format_ajax_support($format) {
3739     global $CFG;
3741     // set up default values
3742     $ajaxsupport = new stdClass();
3743     $ajaxsupport->capable = false;
3744     $ajaxsupport->testedbrowsers = array();
3746     // get the information from the course format library
3747     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3748     $featurefunction = 'callback_'.$format.'_ajax_support';
3749     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3750         require_once $featurefile;
3751     }
3752     if (function_exists($featurefunction)) {
3753         $formatsupport = $featurefunction();
3754         if (isset($formatsupport->capable)) {
3755             $ajaxsupport->capable = $formatsupport->capable;
3756         }
3757         if (is_array($formatsupport->testedbrowsers)) {
3758             $ajaxsupport->testedbrowsers = $formatsupport->testedbrowsers;
3759         }
3760     }
3762     return $ajaxsupport;
3765 /**
3766  * Can the current user delete this course?
3767  * Course creators have exception,
3768  * 1 day after the creation they can sill delete the course.
3769  * @param int $courseid
3770  * @return boolean
3771  */
3772 function can_delete_course($courseid) {
3773     global $USER, $DB;
3775     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3777     if (has_capability('moodle/course:delete', $context)) {
3778         return true;
3779     }
3781     // hack: now try to find out if creator created this course recently (1 day)
3782     if (!has_capability('moodle/course:create', $context)) {
3783         return false;
3784     }
3786     $since = time() - 60*60*24;
3788     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3789     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3791     return $DB->record_exists_select('log', $select, $params);
3794 /**
3795  * Save the Your name for 'Some role' strings.
3796  *
3797  * @param integer $courseid the id of this course.
3798  * @param array $data the data that came from the course settings form.
3799  */
3800 function save_local_role_names($courseid, $data) {
3801     global $DB;
3802     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3804     foreach ($data as $fieldname => $value) {
3805         if (strpos($fieldname, 'role_') !== 0) {
3806             continue;
3807         }
3808         list($ignored, $roleid) = explode('_', $fieldname);
3810         // make up our mind whether we want to delete, update or insert
3811         if (!$value) {
3812             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3814         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3815             $rolename->name = $value;
3816             $DB->update_record('role_names', $rolename);
3818         } else {
3819             $rolename = new stdClass;
3820             $rolename->contextid = $context->id;
3821             $rolename->roleid = $roleid;
3822             $rolename->name = $value;
3823             $DB->insert_record('role_names', $rolename);
3824         }
3825     }
3828 /**
3829  * Create a course and either return a $course object
3830  *
3831  * Please note this functions does not verify any access control,
3832  * the calling code is responsible for all validation (usually it is the form definition).
3833  *
3834  * @param array $editoroptions course description editor options
3835  * @param object $data  - all the data needed for an entry in the 'course' table
3836  * @return object new course instance
3837  */
3838 function create_course($data, $editoroptions = NULL) {
3839     global $CFG, $DB;
3841     //check the categoryid - must be given for all new courses
3842     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3844     //check if the shortname already exist
3845     if (!empty($data->shortname)) {
3846         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3847             throw new moodle_exception('shortnametaken');
3848         }
3849     }
3851     //check if the id number already exist
3852     if (!empty($data->idnumber)) {
3853         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3854             throw new moodle_exception('idnumbertaken');
3855         }
3856     }
3858     $data->timecreated  = time();
3859     $data->timemodified = $data->timecreated;
3861     // place at beginning of any category
3862     $data->sortorder = 0;
3864     if ($editoroptions) {
3865         // summary text is updated later, we need context to store the files first
3866         $data->summary = '';
3867         $data->summary_format = FORMAT_HTML;
3868     }
3870     if (!isset($data->visible)) {
3871         // data not from form, add missing visibility info
3872         $data->visible = $category->visible;
3873     }
3874     $data->visibleold = $data->visible;
3876     $newcourseid = $DB->insert_record('course', $data);
3877     $context = get_context_instance(CONTEXT_COURSE, $newcourseid, MUST_EXIST);
3879     if ($editoroptions) {
3880         // Save the files used in the summary editor and store
3881         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3882         $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
3883         $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
3884     }
3886     $course = $DB->get_record('course', array('id'=>$newcourseid));
3888     // Setup the blocks
3889     blocks_add_default_course_blocks($course);
3891     $section = new stdClass();
3892     $section->course        = $course->id;   // Create a default section.
3893     $section->section       = 0;
3894     $section->summaryformat = FORMAT_HTML;
3895     $DB->insert_record('course_sections', $section);
3897     fix_course_sortorder();
3899     // new context created - better mark it as dirty
3900     mark_context_dirty($context->path);
3902     // Save any custom role names.
3903     save_local_role_names($course->id, (array)$data);
3905     // set up enrolments
3906     enrol_course_updated(true, $course, $data);
3908     add_to_log(SITEID, 'course', 'new', 'view.php?id='.$course->id, $data->fullname.' (ID '.$course->id.')');
3910     // Trigger events
3911     events_trigger('course_created', $course);
3913     return $course;
3916 /**
3917  * Create a new course category and marks the context as dirty
3918  *
3919  * This function does not set the sortorder for the new category and
3920  * @see{fix_course_sortorder} should be called after creating a new course
3921  * category
3922  *
3923  * Please note that this function does not verify access control.
3924  *
3925  * @param object $category All of the data required for an entry in the course_categories table
3926  * @return object new course category
3927  */
3928 function create_course_category($category) {
3929     global $DB;
3931     $category->timemodified = time();
3932     $category->id = $DB->insert_record('course_categories', $category);
3933     $category = $DB->get_record('course_categories', array('id' => $category->id));
3935     // We should mark the context as dirty
3936     $category->context = context_coursecat::instance($category->id);
3937     $category->context->mark_dirty();
3939     return $category;
3942 /**
3943  * Update a course.
3944  *
3945  * Please note this functions does not verify any access control,
3946  * the calling code is responsible for all validation (usually it is the form definition).
3947  *
3948  * @param object $data  - all the data needed for an entry in the 'course' table
3949  * @param array $editoroptions course description editor options
3950  * @return void
3951  */
3952 function update_course($data, $editoroptions = NULL) {
3953     global $CFG, $DB;
3955     $data->timemodified = time();
3957     $oldcourse = $DB->get_record('course', array('id'=>$data->id), '*', MUST_EXIST);
3958     $context   = get_context_instance(CONTEXT_COURSE, $oldcourse->id);
3960     if ($editoroptions) {
3961         $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
3962     }
3964     if (!isset($data->category) or empty($data->category)) {
3965         // prevent nulls and 0 in category field
3966         unset($data->category);
3967     }
3968     $movecat = (isset($data->category) and $oldcourse->category != $data->category);
3970     if (!isset($data->visible)) {
3971         // data not from form, add missing visibility info
3972         $data->visible = $oldcourse->visible;
3973     }
3975     if ($data->visible != $oldcourse->visible) {
3976         // reset the visibleold flag when manually hiding/unhiding course
3977         $data->visibleold = $data->visible;
3978     } else {
3979         if ($movecat) {
3980             $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
3981             if (empty($newcategory->visible)) {
3982                 // make sure when moving into hidden category the course is hidden automatically
3983                 $data->visible = 0;
3984             }
3985         }
3986     }
3988     // Update with the new data
3989     $DB->update_record('course', $data);
3991     $course = $DB->get_record('course', array('id'=>$data->id));
3993     if ($movecat) {
3994         $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3995         context_moved($context, $newparent);
3996     }
3998     fix_course_sortorder();
4000     // Test for and remove blocks which aren't appropriate anymore
4001     blocks_remove_inappropriate($course);
4003     // Save any custom role names.
4004     save_local_role_names($course->id, $data);
4006     // update enrol settings
4007     enrol_course_updated(false, $course, $data);
4009     add_to_log($course->id, "course", "update", "edit.php?id=$course->id", $course->id);
4011     // Trigger events
4012     events_trigger('course_updated', $course);
4015 /**
4016  * Average number of participants
4017  * @return integer
4018  */
4019 function average_number_of_participants() {
4020     global $DB, $SITE;
4022     //count total of enrolments for visible course (except front page)
4023     $sql = 'SELECT COUNT(*) FROM (
4024         SELECT DISTINCT ue.userid, e.courseid
4025         FROM {user_enrolments} ue, {enrol} e, {course} c
4026         WHERE ue.enrolid = e.id
4027             AND e.courseid <> :siteid
4028             AND c.id = e.courseid
4029             AND c.visible = 1) total';
4030     $params = array('siteid' => $SITE->id);
4031     $enrolmenttotal = $DB->count_records_sql($sql, $params);
4034     //count total of visible courses (minus front page)
4035     $coursetotal = $DB->count_records('course', array('visible' => 1));
4036     $coursetotal = $coursetotal - 1 ;
4038     //average of enrolment
4039     if (empty($coursetotal)) {
4040         $participantaverage = 0;
4041     } else {
4042         $participantaverage = $enrolmenttotal / $coursetotal;
4043     }
4045     return $participantaverage;
4048 /**
4049  * Average number of course modules
4050  * @return integer
4051  */
4052 function average_number_of_courses_modules() {
4053     global $DB, $SITE;
4055     //count total of visible course module (except front page)
4056     $sql = 'SELECT COUNT(*) FROM (
4057         SELECT cm.course, cm.module
4058         FROM {course} c, {course_modules} cm
4059         WHERE c.id = cm.course
4060             AND c.id <> :siteid
4061             AND cm.visible = 1
4062             AND c.visible = 1) total';
4063     $params = array('siteid' => $SITE->id);
4064     $moduletotal = $DB->count_records_sql($sql, $params);
4067     //count total of visible courses (minus front page)
4068     $coursetotal = $DB->count_records('course', array('visible' => 1));
4069     $coursetotal = $coursetotal - 1 ;
4071     //average of course module
4072     if (empty($coursetotal)) {
4073         $coursemoduleaverage = 0;
4074     } else {
4075         $coursemoduleaverage = $moduletotal / $coursetotal;
4076     }
4078     return $coursemoduleaverage;
4081 /**
4082  * This class pertains to course requests and contains methods associated with
4083  * create, approving, and removing course requests.
4084  *
4085  * Please note we do not allow embedded images here because there is no context
4086  * to store them with proper access control.
4087  *
4088  * @copyright 2009 Sam Hemelryk
4089  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4090  * @since Moodle 2.0
4091  *
4092  * @property-read int $id
4093  * @property-read string $fullname
4094  * @property-read string $shortname
4095  * @property-read string $summary
4096  * @property-read int $summaryformat
4097  * @property-read int $summarytrust
4098  * @property-read string $reason
4099  * @property-read int $requester
4100  */
4101 class course_request {
4103     /**
4104      * This is the stdClass that stores the properties for the course request
4105      * and is externally accessed through the __get magic method
4106      * @var stdClass
4107      */
4108     protected $properties;
4110     /**
4111      * An array of options for the summary editor used by course request forms.
4112      * This is initially set by {@link summary_editor_options()}
4113      * @var array
4114      * @static
4115      */
4116     protected static $summaryeditoroptions;
4118     /**
4119      * Static function to prepare the summary editor for working with a course
4120      * request.
4121      *
4122      * @static
4123      * @param null|stdClass $data Optional, an object containing the default values
4124      *                       for the form, these may be modified when preparing the
4125      *                       editor so this should be called before creating the form
4126      * @return stdClass An object that can be used to set the default values for
4127      *                   an mforms form
4128      */
4129     public static function prepare($data=null) {
4130         if ($data === null) {
4131             $data = new stdClass;
4132         }
4133         $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
4134         return $data;
4135     }
4137     /**
4138      * Static function to create a new course request when passed an array of properties
4139      * for it.
4140      *
4141      * This function also handles saving any files that may have been used in the editor
4142      *
4143      * @static
4144      * @param stdClass $data
4145      * @return course_request The newly created course request
4146      */
4147     public static function create($data) {
4148         global $USER, $DB, $CFG;
4149         $data->requester = $USER->id;
4151         // Summary is a required field so copy the text over
4152         $data->summary       = $data->summary_editor['text'];
4153         $data->summaryformat = $data->summary_editor['format'];
4155         $data->id = $DB->insert_record('course_request', $data);