MDL-36323 usability: New icon names to assign and switch roles
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->dirroot.'/course/dnduploadlib.php');
32 require_once($CFG->dirroot.'/course/format/lib.php');
34 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
37 /**
38  * Number of courses to display when summaries are included.
39  * @var int
40  * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
41  */
42 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
44 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
45 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
46 define('FRONTPAGENEWS',           '0');
47 define('FRONTPAGECOURSELIST',     '1');
48 define('FRONTPAGECATEGORYNAMES',  '2');
49 define('FRONTPAGETOPICONLY',      '3');
50 define('FRONTPAGECATEGORYCOMBO',  '4');
51 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
52 define('EXCELROWS', 65535);
53 define('FIRSTUSEDEXCELROW', 3);
55 define('MOD_CLASS_ACTIVITY', 0);
56 define('MOD_CLASS_RESOURCE', 1);
58 function make_log_url($module, $url) {
59     switch ($module) {
60         case 'course':
61             if (strpos($url, 'report/') === 0) {
62                 // there is only one report type, course reports are deprecated
63                 $url = "/$url";
64                 break;
65             }
66         case 'file':
67         case 'login':
68         case 'lib':
69         case 'admin':
70         case 'calendar':
71         case 'mnet course':
72             if (strpos($url, '../') === 0) {
73                 $url = ltrim($url, '.');
74             } else {
75                 $url = "/course/$url";
76             }
77             break;
78         case 'user':
79         case 'blog':
80             $url = "/$module/$url";
81             break;
82         case 'upload':
83             $url = $url;
84             break;
85         case 'coursetags':
86             $url = '/'.$url;
87             break;
88         case 'library':
89         case '':
90             $url = '/';
91             break;
92         case 'message':
93             $url = "/message/$url";
94             break;
95         case 'notes':
96             $url = "/notes/$url";
97             break;
98         case 'tag':
99             $url = "/tag/$url";
100             break;
101         case 'role':
102             $url = '/'.$url;
103             break;
104         default:
105             $url = "/mod/$module/$url";
106             break;
107     }
109     //now let's sanitise urls - there might be some ugly nasties:-(
110     $parts = explode('?', $url);
111     $script = array_shift($parts);
112     if (strpos($script, 'http') === 0) {
113         $script = clean_param($script, PARAM_URL);
114     } else {
115         $script = clean_param($script, PARAM_PATH);
116     }
118     $query = '';
119     if ($parts) {
120         $query = implode('', $parts);
121         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
122         $parts = explode('&', $query);
123         $eq = urlencode('=');
124         foreach ($parts as $key=>$part) {
125             $part = urlencode(urldecode($part));
126             $part = str_replace($eq, '=', $part);
127             $parts[$key] = $part;
128         }
129         $query = '?'.implode('&amp;', $parts);
130     }
132     return $script.$query;
136 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
137                    $modname="", $modid=0, $modaction="", $groupid=0) {
138     global $CFG, $DB;
140     // It is assumed that $date is the GMT time of midnight for that day,
141     // and so the next 86400 seconds worth of logs are printed.
143     /// Setup for group handling.
145     // TODO: I don't understand group/context/etc. enough to be able to do
146     // something interesting with it here
147     // What is the context of a remote course?
149     /// If the group mode is separate, and this user does not have editing privileges,
150     /// then only the user's group can be viewed.
151     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
152     //    $groupid = get_current_group($course->id);
153     //}
154     /// If this course doesn't have groups, no groupid can be specified.
155     //else if (!$course->groupmode) {
156     //    $groupid = 0;
157     //}
159     $groupid = 0;
161     $joins = array();
162     $where = '';
164     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
165               FROM {mnet_log} l
166                LEFT JOIN {user} u ON l.userid = u.id
167               WHERE ";
168     $params = array();
170     $where .= "l.hostid = :hostid";
171     $params['hostid'] = $hostid;
173     // TODO: Is 1 really a magic number referring to the sitename?
174     if ($course != SITEID || $modid != 0) {
175         $where .= " AND l.course=:courseid";
176         $params['courseid'] = $course;
177     }
179     if ($modname) {
180         $where .= " AND l.module = :modname";
181         $params['modname'] = $modname;
182     }
184     if ('site_errors' === $modid) {
185         $where .= " AND ( l.action='error' OR l.action='infected' )";
186     } else if ($modid) {
187         //TODO: This assumes that modids are the same across sites... probably
188         //not true
189         $where .= " AND l.cmid = :modid";
190         $params['modid'] = $modid;
191     }
193     if ($modaction) {
194         $firstletter = substr($modaction, 0, 1);
195         if ($firstletter == '-') {
196             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
197             $params['modaction'] = '%'.substr($modaction, 1).'%';
198         } else {
199             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
200             $params['modaction'] = '%'.$modaction.'%';
201         }
202     }
204     if ($user) {
205         $where .= " AND l.userid = :user";
206         $params['user'] = $user;
207     }
209     if ($date) {
210         $enddate = $date + 86400;
211         $where .= " AND l.time > :date AND l.time < :enddate";
212         $params['date'] = $date;
213         $params['enddate'] = $enddate;
214     }
216     $result = array();
217     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
218     if(!empty($result['totalcount'])) {
219         $where .= " ORDER BY $order";
220         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
221     } else {
222         $result['logs'] = array();
223     }
224     return $result;
227 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
228                    $modname="", $modid=0, $modaction="", $groupid=0) {
229     global $DB, $SESSION, $USER;
230     // It is assumed that $date is the GMT time of midnight for that day,
231     // and so the next 86400 seconds worth of logs are printed.
233     /// Setup for group handling.
235     /// If the group mode is separate, and this user does not have editing privileges,
236     /// then only the user's group can be viewed.
237     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
238         if (isset($SESSION->currentgroup[$course->id])) {
239             $groupid =  $SESSION->currentgroup[$course->id];
240         } else {
241             $groupid = groups_get_all_groups($course->id, $USER->id);
242             if (is_array($groupid)) {
243                 $groupid = array_shift(array_keys($groupid));
244                 $SESSION->currentgroup[$course->id] = $groupid;
245             } else {
246                 $groupid = 0;
247             }
248         }
249     }
250     /// If this course doesn't have groups, no groupid can be specified.
251     else if (!$course->groupmode) {
252         $groupid = 0;
253     }
255     $joins = array();
256     $params = array();
258     if ($course->id != SITEID || $modid != 0) {
259         $joins[] = "l.course = :courseid";
260         $params['courseid'] = $course->id;
261     }
263     if ($modname) {
264         $joins[] = "l.module = :modname";
265         $params['modname'] = $modname;
266     }
268     if ('site_errors' === $modid) {
269         $joins[] = "( l.action='error' OR l.action='infected' )";
270     } else if ($modid) {
271         $joins[] = "l.cmid = :modid";
272         $params['modid'] = $modid;
273     }
275     if ($modaction) {
276         $firstletter = substr($modaction, 0, 1);
277         if ($firstletter == '-') {
278             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
279             $params['modaction'] = '%'.substr($modaction, 1).'%';
280         } else {
281             $joins[] = $DB->sql_like('l.action', ':modaction', false);
282             $params['modaction'] = '%'.$modaction.'%';
283         }
284     }
287     /// Getting all members of a group.
288     if ($groupid and !$user) {
289         if ($gusers = groups_get_members($groupid)) {
290             $gusers = array_keys($gusers);
291             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
292         } else {
293             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
294         }
295     }
296     else if ($user) {
297         $joins[] = "l.userid = :userid";
298         $params['userid'] = $user;
299     }
301     if ($date) {
302         $enddate = $date + 86400;
303         $joins[] = "l.time > :date AND l.time < :enddate";
304         $params['date'] = $date;
305         $params['enddate'] = $enddate;
306     }
308     $selector = implode(' AND ', $joins);
310     $totalcount = 0;  // Initialise
311     $result = array();
312     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
313     $result['totalcount'] = $totalcount;
314     return $result;
318 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
319                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
321     global $CFG, $DB, $OUTPUT;
323     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
324                        $modname, $modid, $modaction, $groupid)) {
325         echo $OUTPUT->notification("No logs found!");
326         echo $OUTPUT->footer();
327         exit;
328     }
330     $courses = array();
332     if ($course->id == SITEID) {
333         $courses[0] = '';
334         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
335             foreach ($ccc as $cc) {
336                 $courses[$cc->id] = $cc->shortname;
337             }
338         }
339     } else {
340         $courses[$course->id] = $course->shortname;
341     }
343     $totalcount = $logs['totalcount'];
344     $count=0;
345     $ldcache = array();
346     $tt = getdate(time());
347     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
349     $strftimedatetime = get_string("strftimedatetime");
351     echo "<div class=\"info\">\n";
352     print_string("displayingrecords", "", $totalcount);
353     echo "</div>\n";
355     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
357     $table = new html_table();
358     $table->classes = array('logtable','generalbox');
359     $table->align = array('right', 'left', 'left');
360     $table->head = array(
361         get_string('time'),
362         get_string('ip_address'),
363         get_string('fullnameuser'),
364         get_string('action'),
365         get_string('info')
366     );
367     $table->data = array();
369     if ($course->id == SITEID) {
370         array_unshift($table->align, 'left');
371         array_unshift($table->head, get_string('course'));
372     }
374     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
375     if (empty($logs['logs'])) {
376         $logs['logs'] = array();
377     }
379     foreach ($logs['logs'] as $log) {
381         if (isset($ldcache[$log->module][$log->action])) {
382             $ld = $ldcache[$log->module][$log->action];
383         } else {
384             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
385             $ldcache[$log->module][$log->action] = $ld;
386         }
387         if ($ld && is_numeric($log->info)) {
388             // ugly hack to make sure fullname is shown correctly
389             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
390                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
391             } else {
392                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
393             }
394         }
396         //Filter log->info
397         $log->info = format_string($log->info);
399         // If $log->url has been trimmed short by the db size restriction
400         // code in add_to_log, keep a note so we don't add a link to a broken url
401         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
403         $row = array();
404         if ($course->id == SITEID) {
405             if (empty($log->course)) {
406                 $row[] = get_string('site');
407             } else {
408                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
409             }
410         }
412         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
414         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
415         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
417         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id))));
419         $displayaction="$log->module $log->action";
420         if ($brokenurl) {
421             $row[] = $displayaction;
422         } else {
423             $link = make_log_url($log->module,$log->url);
424             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
425         }
426         $row[] = $log->info;
427         $table->data[] = $row;
428     }
430     echo html_writer::table($table);
431     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
435 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
436                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
438     global $CFG, $DB, $OUTPUT;
440     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
441                        $modname, $modid, $modaction, $groupid)) {
442         echo $OUTPUT->notification("No logs found!");
443         echo $OUTPUT->footer();
444         exit;
445     }
447     if ($course->id == SITEID) {
448         $courses[0] = '';
449         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
450             foreach ($ccc as $cc) {
451                 $courses[$cc->id] = $cc->shortname;
452             }
453         }
454     }
456     $totalcount = $logs['totalcount'];
457     $count=0;
458     $ldcache = array();
459     $tt = getdate(time());
460     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
462     $strftimedatetime = get_string("strftimedatetime");
464     echo "<div class=\"info\">\n";
465     print_string("displayingrecords", "", $totalcount);
466     echo "</div>\n";
468     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
470     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
471     echo "<tr>";
472     if ($course->id == SITEID) {
473         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
474     }
475     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
476     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
477     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
478     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
479     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
480     echo "</tr>\n";
482     if (empty($logs['logs'])) {
483         echo "</table>\n";
484         return;
485     }
487     $row = 1;
488     foreach ($logs['logs'] as $log) {
490         $log->info = $log->coursename;
491         $row = ($row + 1) % 2;
493         if (isset($ldcache[$log->module][$log->action])) {
494             $ld = $ldcache[$log->module][$log->action];
495         } else {
496             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
497             $ldcache[$log->module][$log->action] = $ld;
498         }
499         if (0 && $ld && !empty($log->info)) {
500             // ugly hack to make sure fullname is shown correctly
501             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
502                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
503             } else {
504                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
505             }
506         }
508         //Filter log->info
509         $log->info = format_string($log->info);
511         echo '<tr class="r'.$row.'">';
512         if ($course->id == SITEID) {
513             $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
514             echo "<td class=\"r$row c0\" >\n";
515             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
516             echo "</td>\n";
517         }
518         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
519              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
520         echo "<td class=\"r$row c2\" >\n";
521         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
522         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
523         echo "</td>\n";
524         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
525         echo "<td class=\"r$row c3\" >\n";
526         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
527         echo "</td>\n";
528         echo "<td class=\"r$row c4\">\n";
529         echo $log->action .': '.$log->module;
530         echo "</td>\n";;
531         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
532         echo "</tr>\n";
533     }
534     echo "</table>\n";
536     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
540 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
541                         $modid, $modaction, $groupid) {
542     global $DB, $CFG;
544     require_once($CFG->libdir . '/csvlib.class.php');
546     $csvexporter = new csv_export_writer('tab');
548     $header = array();
549     $header[] = get_string('course');
550     $header[] = get_string('time');
551     $header[] = get_string('ip_address');
552     $header[] = get_string('fullnameuser');
553     $header[] = get_string('action');
554     $header[] = get_string('info');
556     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
557                        $modname, $modid, $modaction, $groupid)) {
558         return false;
559     }
561     $courses = array();
563     if ($course->id == SITEID) {
564         $courses[0] = '';
565         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
566             foreach ($ccc as $cc) {
567                 $courses[$cc->id] = $cc->shortname;
568             }
569         }
570     } else {
571         $courses[$course->id] = $course->shortname;
572     }
574     $count=0;
575     $ldcache = array();
576     $tt = getdate(time());
577     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
579     $strftimedatetime = get_string("strftimedatetime");
581     $csvexporter->set_filename('logs', '.txt');
582     $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
583     $csvexporter->add_data($title);
584     $csvexporter->add_data($header);
586     if (empty($logs['logs'])) {
587         return true;
588     }
590     foreach ($logs['logs'] as $log) {
591         if (isset($ldcache[$log->module][$log->action])) {
592             $ld = $ldcache[$log->module][$log->action];
593         } else {
594             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
595             $ldcache[$log->module][$log->action] = $ld;
596         }
597         if ($ld && !empty($log->info)) {
598             // ugly hack to make sure fullname is shown correctly
599             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
600                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
601             } else {
602                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
603             }
604         }
606         //Filter log->info
607         $log->info = format_string($log->info);
608         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
610         $coursecontext = context_course::instance($course->id);
611         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
612         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
613         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
614         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
615         $csvexporter->add_data($row);
616     }
617     $csvexporter->download_file();
618     return true;
622 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
623                         $modid, $modaction, $groupid) {
625     global $CFG, $DB;
627     require_once("$CFG->libdir/excellib.class.php");
629     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
630                        $modname, $modid, $modaction, $groupid)) {
631         return false;
632     }
634     $courses = array();
636     if ($course->id == SITEID) {
637         $courses[0] = '';
638         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
639             foreach ($ccc as $cc) {
640                 $courses[$cc->id] = $cc->shortname;
641             }
642         }
643     } else {
644         $courses[$course->id] = $course->shortname;
645     }
647     $count=0;
648     $ldcache = array();
649     $tt = getdate(time());
650     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
652     $strftimedatetime = get_string("strftimedatetime");
654     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
655     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
656     $filename .= '.xls';
658     $workbook = new MoodleExcelWorkbook('-');
659     $workbook->send($filename);
661     $worksheet = array();
662     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
663                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
665     // Creating worksheets
666     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
667         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
668         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
669         $worksheet[$wsnumber]->set_column(1, 1, 30);
670         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
671                                     userdate(time(), $strftimedatetime));
672         $col = 0;
673         foreach ($headers as $item) {
674             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
675             $col++;
676         }
677     }
679     if (empty($logs['logs'])) {
680         $workbook->close();
681         return true;
682     }
684     $formatDate =& $workbook->add_format();
685     $formatDate->set_num_format(get_string('log_excel_date_format'));
687     $row = FIRSTUSEDEXCELROW;
688     $wsnumber = 1;
689     $myxls =& $worksheet[$wsnumber];
690     foreach ($logs['logs'] as $log) {
691         if (isset($ldcache[$log->module][$log->action])) {
692             $ld = $ldcache[$log->module][$log->action];
693         } else {
694             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
695             $ldcache[$log->module][$log->action] = $ld;
696         }
697         if ($ld && !empty($log->info)) {
698             // ugly hack to make sure fullname is shown correctly
699             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
700                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
701             } else {
702                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
703             }
704         }
706         // Filter log->info
707         $log->info = format_string($log->info);
708         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
710         if ($nroPages>1) {
711             if ($row > EXCELROWS) {
712                 $wsnumber++;
713                 $myxls =& $worksheet[$wsnumber];
714                 $row = FIRSTUSEDEXCELROW;
715             }
716         }
718         $coursecontext = context_course::instance($course->id);
720         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
721         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
722         $myxls->write($row, 2, $log->ip, '');
723         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
724         $myxls->write($row, 3, $fullname, '');
725         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
726         $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
727         $myxls->write($row, 5, $log->info, '');
729         $row++;
730     }
732     $workbook->close();
733     return true;
736 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
737                         $modid, $modaction, $groupid) {
739     global $CFG, $DB;
741     require_once("$CFG->libdir/odslib.class.php");
743     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
744                        $modname, $modid, $modaction, $groupid)) {
745         return false;
746     }
748     $courses = array();
750     if ($course->id == SITEID) {
751         $courses[0] = '';
752         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
753             foreach ($ccc as $cc) {
754                 $courses[$cc->id] = $cc->shortname;
755             }
756         }
757     } else {
758         $courses[$course->id] = $course->shortname;
759     }
761     $count=0;
762     $ldcache = array();
763     $tt = getdate(time());
764     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
766     $strftimedatetime = get_string("strftimedatetime");
768     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
769     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
770     $filename .= '.ods';
772     $workbook = new MoodleODSWorkbook('-');
773     $workbook->send($filename);
775     $worksheet = array();
776     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
777                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
779     // Creating worksheets
780     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
781         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
782         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
783         $worksheet[$wsnumber]->set_column(1, 1, 30);
784         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
785                                     userdate(time(), $strftimedatetime));
786         $col = 0;
787         foreach ($headers as $item) {
788             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
789             $col++;
790         }
791     }
793     if (empty($logs['logs'])) {
794         $workbook->close();
795         return true;
796     }
798     $formatDate =& $workbook->add_format();
799     $formatDate->set_num_format(get_string('log_excel_date_format'));
801     $row = FIRSTUSEDEXCELROW;
802     $wsnumber = 1;
803     $myxls =& $worksheet[$wsnumber];
804     foreach ($logs['logs'] as $log) {
805         if (isset($ldcache[$log->module][$log->action])) {
806             $ld = $ldcache[$log->module][$log->action];
807         } else {
808             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
809             $ldcache[$log->module][$log->action] = $ld;
810         }
811         if ($ld && !empty($log->info)) {
812             // ugly hack to make sure fullname is shown correctly
813             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
814                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
815             } else {
816                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
817             }
818         }
820         // Filter log->info
821         $log->info = format_string($log->info);
822         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
824         if ($nroPages>1) {
825             if ($row > EXCELROWS) {
826                 $wsnumber++;
827                 $myxls =& $worksheet[$wsnumber];
828                 $row = FIRSTUSEDEXCELROW;
829             }
830         }
832         $coursecontext = context_course::instance($course->id);
834         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
835         $myxls->write_date($row, 1, $log->time);
836         $myxls->write_string($row, 2, $log->ip);
837         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
838         $myxls->write_string($row, 3, $fullname);
839         $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
840         $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
841         $myxls->write_string($row, 5, $log->info);
843         $row++;
844     }
846     $workbook->close();
847     return true;
851 function print_overview($courses, array $remote_courses=array()) {
852     global $CFG, $USER, $DB, $OUTPUT;
854     $htmlarray = array();
855     if ($modules = $DB->get_records('modules')) {
856         foreach ($modules as $mod) {
857             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
858                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
859                 $fname = $mod->name.'_print_overview';
860                 if (function_exists($fname)) {
861                     $fname($courses,$htmlarray);
862                 }
863             }
864         }
865     }
866     foreach ($courses as $course) {
867         $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
868         echo $OUTPUT->box_start('coursebox');
869         $attributes = array('title' => s($fullname));
870         if (empty($course->visible)) {
871             $attributes['class'] = 'dimmed';
872         }
873         echo $OUTPUT->heading(html_writer::link(
874             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
875         if (array_key_exists($course->id,$htmlarray)) {
876             foreach ($htmlarray[$course->id] as $modname => $html) {
877                 echo $html;
878             }
879         }
880         echo $OUTPUT->box_end();
881     }
883     if (!empty($remote_courses)) {
884         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
885     }
886     foreach ($remote_courses as $course) {
887         echo $OUTPUT->box_start('coursebox');
888         $attributes = array('title' => s($course->fullname));
889         echo $OUTPUT->heading(html_writer::link(
890             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
891             format_string($course->shortname),
892             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
893         echo $OUTPUT->box_end();
894     }
898 /**
899  * This function trawls through the logs looking for
900  * anything new since the user's last login
901  */
902 function print_recent_activity($course) {
903     // $course is an object
904     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
906     $context = context_course::instance($course->id);
908     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
910     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
912     if (!isguestuser()) {
913         if (!empty($USER->lastcourseaccess[$course->id])) {
914             if ($USER->lastcourseaccess[$course->id] > $timestart) {
915                 $timestart = $USER->lastcourseaccess[$course->id];
916             }
917         }
918     }
920     echo '<div class="activitydate">';
921     echo get_string('activitysince', '', userdate($timestart));
922     echo '</div>';
923     echo '<div class="activityhead">';
925     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
927     echo "</div>\n";
929     $content = false;
931 /// Firstly, have there been any new enrolments?
933     $users = get_recent_enrolments($course->id, $timestart);
935     //Accessibility: new users now appear in an <OL> list.
936     if ($users) {
937         echo '<div class="newusers">';
938         echo $OUTPUT->heading(get_string("newusers").':', 3);
939         $content = true;
940         echo "<ol class=\"list\">\n";
941         foreach ($users as $user) {
942             $fullname = fullname($user, $viewfullnames);
943             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
944         }
945         echo "</ol>\n</div>\n";
946     }
948 /// Next, have there been any modifications to the course structure?
950     $modinfo = get_fast_modinfo($course);
952     $changelist = array();
954     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
955                                             module = 'course' AND
956                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
957                                     array($timestart, $course->id), "id ASC");
959     if ($logs) {
960         $actions  = array('add mod', 'update mod', 'delete mod');
961         $newgones = array(); // added and later deleted items
962         foreach ($logs as $key => $log) {
963             if (!in_array($log->action, $actions)) {
964                 continue;
965             }
966             $info = explode(' ', $log->info);
968             // note: in most cases I replaced hardcoding of label with use of
969             // $cm->has_view() but it was not possible to do this here because
970             // we don't necessarily have the $cm for it
971             if ($info[0] == 'label') {     // Labels are ignored in recent activity
972                 continue;
973             }
975             if (count($info) != 2) {
976                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
977                 continue;
978             }
980             $modname    = $info[0];
981             $instanceid = $info[1];
983             if ($log->action == 'delete mod') {
984                 // unfortunately we do not know if the mod was visible
985                 if (!array_key_exists($log->info, $newgones)) {
986                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
987                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
988                 }
989             } else {
990                 if (!isset($modinfo->instances[$modname][$instanceid])) {
991                     if ($log->action == 'add mod') {
992                         // do not display added and later deleted activities
993                         $newgones[$log->info] = true;
994                     }
995                     continue;
996                 }
997                 $cm = $modinfo->instances[$modname][$instanceid];
998                 if (!$cm->uservisible) {
999                     continue;
1000                 }
1002                 if ($log->action == 'add mod') {
1003                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
1004                     $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
1006                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
1007                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
1008                     $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
1009                 }
1010             }
1011         }
1012     }
1014     if (!empty($changelist)) {
1015         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1016         $content = true;
1017         foreach ($changelist as $changeinfo => $change) {
1018             echo '<p class="activity">'.$change['text'].'</p>';
1019         }
1020     }
1022 /// Now display new things from each module
1024     $usedmodules = array();
1025     foreach($modinfo->cms as $cm) {
1026         if (isset($usedmodules[$cm->modname])) {
1027             continue;
1028         }
1029         if (!$cm->uservisible) {
1030             continue;
1031         }
1032         $usedmodules[$cm->modname] = $cm->modname;
1033     }
1035     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1036         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1037             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1038             $print_recent_activity = $modname.'_print_recent_activity';
1039             if (function_exists($print_recent_activity)) {
1040                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1041                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1042             }
1043         } else {
1044             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1045         }
1046     }
1048     if (! $content) {
1049         echo '<p class="message">'.get_string('nothingnew').'</p>';
1050     }
1053 /**
1054  * For a given course, returns an array of course activity objects
1055  * Each item in the array contains he following properties:
1056  */
1057 function get_array_of_activities($courseid) {
1058 //  cm - course module id
1059 //  mod - name of the module (eg forum)
1060 //  section - the number of the section (eg week or topic)
1061 //  name - the name of the instance
1062 //  visible - is the instance visible or not
1063 //  groupingid - grouping id
1064 //  groupmembersonly - is this instance visible to group members only
1065 //  extra - contains extra string to include in any link
1066     global $CFG, $DB;
1067     if(!empty($CFG->enableavailability)) {
1068         require_once($CFG->libdir.'/conditionlib.php');
1069     }
1071     $course = $DB->get_record('course', array('id'=>$courseid));
1073     if (empty($course)) {
1074         throw new moodle_exception('courseidnotfound');
1075     }
1077     $mod = array();
1079     $rawmods = get_course_mods($courseid);
1080     if (empty($rawmods)) {
1081         return $mod; // always return array
1082     }
1084     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1085        foreach ($sections as $section) {
1086            if (!empty($section->sequence)) {
1087                $sequence = explode(",", $section->sequence);
1088                foreach ($sequence as $seq) {
1089                    if (empty($rawmods[$seq])) {
1090                        continue;
1091                    }
1092                    $mod[$seq] = new stdClass();
1093                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1094                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1095                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1097                     // Oh dear. Inconsistent names left here for backward compatibility.
1098                    $mod[$seq]->section          = $section->section;
1099                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1101                    $mod[$seq]->module           = $rawmods[$seq]->module;
1102                    $mod[$seq]->added            = $rawmods[$seq]->added;
1103                    $mod[$seq]->score            = $rawmods[$seq]->score;
1104                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1105                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1106                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1107                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1108                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1109                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1110                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1111                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1112                    $mod[$seq]->extra            = "";
1113                    $mod[$seq]->completiongradeitemnumber =
1114                            $rawmods[$seq]->completiongradeitemnumber;
1115                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1116                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1117                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1118                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1119                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1120                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1121                    if (!empty($CFG->enableavailability)) {
1122                        condition_info::fill_availability_conditions($rawmods[$seq]);
1123                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1124                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1125                        $mod[$seq]->conditionsfield  = $rawmods[$seq]->conditionsfield;
1126                    }
1128                    $modname = $mod[$seq]->mod;
1129                    $functionname = $modname."_get_coursemodule_info";
1131                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1132                        continue;
1133                    }
1135                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1137                    if ($hasfunction = function_exists($functionname)) {
1138                        if ($info = $functionname($rawmods[$seq])) {
1139                            if (!empty($info->icon)) {
1140                                $mod[$seq]->icon = $info->icon;
1141                            }
1142                            if (!empty($info->iconcomponent)) {
1143                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1144                            }
1145                            if (!empty($info->name)) {
1146                                $mod[$seq]->name = $info->name;
1147                            }
1148                            if ($info instanceof cached_cm_info) {
1149                                // When using cached_cm_info you can include three new fields
1150                                // that aren't available for legacy code
1151                                if (!empty($info->content)) {
1152                                    $mod[$seq]->content = $info->content;
1153                                }
1154                                if (!empty($info->extraclasses)) {
1155                                    $mod[$seq]->extraclasses = $info->extraclasses;
1156                                }
1157                                if (!empty($info->iconurl)) {
1158                                    $mod[$seq]->iconurl = $info->iconurl;
1159                                }
1160                                if (!empty($info->onclick)) {
1161                                    $mod[$seq]->onclick = $info->onclick;
1162                                }
1163                                if (!empty($info->customdata)) {
1164                                    $mod[$seq]->customdata = $info->customdata;
1165                                }
1166                            } else {
1167                                // When using a stdclass, the (horrible) deprecated ->extra field
1168                                // is available for BC
1169                                if (!empty($info->extra)) {
1170                                    $mod[$seq]->extra = $info->extra;
1171                                }
1172                            }
1173                        }
1174                    }
1175                    // When there is no modname_get_coursemodule_info function,
1176                    // but showdescriptions is enabled, then we use the 'intro'
1177                    // and 'introformat' fields in the module table
1178                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1179                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1180                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1181                            // Set content from intro and introformat. Filters are disabled
1182                            // because we  filter it with format_text at display time
1183                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1184                                    $modvalues, $rawmods[$seq]->id, false);
1186                            // To save making another query just below, put name in here
1187                            $mod[$seq]->name = $modvalues->name;
1188                        }
1189                    }
1190                    if (!isset($mod[$seq]->name)) {
1191                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1192                    }
1194                    // Minimise the database size by unsetting default options when they are
1195                    // 'empty'. This list corresponds to code in the cm_info constructor.
1196                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1197                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1198                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1199                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1200                            'completionview', 'completionexpected', 'score', 'showdescription')
1201                            as $property) {
1202                        if (property_exists($mod[$seq], $property) &&
1203                                empty($mod[$seq]->{$property})) {
1204                            unset($mod[$seq]->{$property});
1205                        }
1206                    }
1207                    // Special case: this value is usually set to null, but may be 0
1208                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1209                            is_null($mod[$seq]->completiongradeitemnumber)) {
1210                        unset($mod[$seq]->completiongradeitemnumber);
1211                    }
1212                }
1213             }
1214         }
1215     }
1216     return $mod;
1219 /**
1220  * Returns the localised human-readable names of all used modules
1221  *
1222  * @param bool $plural if true returns the plural forms of the names
1223  * @return array where key is the module name (component name without 'mod_') and
1224  *     the value is the human-readable string. Array sorted alphabetically by value
1225  */
1226 function get_module_types_names($plural = false) {
1227     static $modnames = null;
1228     global $DB, $CFG;
1229     if ($modnames === null) {
1230         $modnames = array(0 => array(), 1 => array());
1231         if ($allmods = $DB->get_records("modules")) {
1232             foreach ($allmods as $mod) {
1233                 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1234                     $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1235                     $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1236                 }
1237             }
1238             collatorlib::asort($modnames[0]);
1239             collatorlib::asort($modnames[1]);
1240         }
1241     }
1242     return $modnames[(int)$plural];
1245 /**
1246  * Set highlighted section. Only one section can be highlighted at the time.
1247  *
1248  * @param int $courseid course id
1249  * @param int $marker highlight section with this number, 0 means remove higlightin
1250  * @return void
1251  */
1252 function course_set_marker($courseid, $marker) {
1253     global $DB;
1254     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1257 /**
1258  * For a given course section, marks it visible or hidden,
1259  * and does the same for every activity in that section
1260  *
1261  * @param int $courseid course id
1262  * @param int $sectionnumber The section number to adjust
1263  * @param int $visibility The new visibility
1264  * @return array A list of resources which were hidden in the section
1265  */
1266 function set_section_visible($courseid, $sectionnumber, $visibility) {
1267     global $DB;
1269     $resourcestotoggle = array();
1270     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1271         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1272         if (!empty($section->sequence)) {
1273             $modules = explode(",", $section->sequence);
1274             foreach ($modules as $moduleid) {
1275                 set_coursemodule_visible($moduleid, $visibility, true);
1276             }
1277         }
1278         rebuild_course_cache($courseid, true);
1280         // Determine which modules are visible for AJAX update
1281         if (!empty($modules)) {
1282             list($insql, $params) = $DB->get_in_or_equal($modules);
1283             $select = 'id ' . $insql . ' AND visible = ?';
1284             array_push($params, $visibility);
1285             if (!$visibility) {
1286                 $select .= ' AND visibleold = 1';
1287             }
1288             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1289         }
1290     }
1291     return $resourcestotoggle;
1294 /**
1295  * Obtains shared data that is used in print_section when displaying a
1296  * course-module entry.
1297  *
1298  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1299  *
1300  * This data is also used in other areas of the code.
1301  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1302  * @param object $course Moodle course object
1303  * @return array An array with the following values in this order:
1304  *   $content (optional extra content for after link),
1305  *   $instancename (text of link)
1306  */
1307 function get_print_section_cm_text(cm_info $cm, $course) {
1308     global $OUTPUT;
1310     // Get content from modinfo if specified. Content displays either
1311     // in addition to the standard link (below), or replaces it if
1312     // the link is turned off by setting ->url to null.
1313     if (($content = $cm->get_content()) !== '') {
1314         // Improve filter performance by preloading filter setttings for all
1315         // activities on the course (this does nothing if called multiple
1316         // times)
1317         filter_preload_activities($cm->get_modinfo());
1319         // Get module context
1320         $modulecontext = context_module::instance($cm->id);
1321         $labelformatoptions = new stdClass();
1322         $labelformatoptions->noclean = true;
1323         $labelformatoptions->overflowdiv = true;
1324         $labelformatoptions->context = $modulecontext;
1325         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1326     } else {
1327         $content = '';
1328     }
1330     // Get course context
1331     $coursecontext = context_course::instance($course->id);
1332     $stringoptions = new stdClass;
1333     $stringoptions->context = $coursecontext;
1334     $instancename = format_string($cm->name, true,  $stringoptions);
1335     return array($content, $instancename);
1338 /**
1339  * Prints a section full of activity modules
1340  *
1341  * @param stdClass $course The course
1342  * @param stdClass|section_info $section The section object containing properties id and section
1343  * @param array $mods (argument not used)
1344  * @param array $modnamesused (argument not used)
1345  * @param bool $absolute All links are absolute
1346  * @param string $width Width of the container
1347  * @param bool $hidecompletion Hide completion status
1348  * @param int $sectionreturn The section to return to
1349  * @return void
1350  */
1351 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1352     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1354     static $initialised;
1356     static $groupbuttons;
1357     static $groupbuttonslink;
1358     static $isediting;
1359     static $ismoving;
1360     static $strmovehere;
1361     static $strmovefull;
1362     static $strunreadpostsone;
1364     if (!isset($initialised)) {
1365         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1366         $groupbuttonslink = (!$course->groupmodeforce);
1367         $isediting        = $PAGE->user_is_editing();
1368         $ismoving         = $isediting && ismoving($course->id);
1369         if ($ismoving) {
1370             $strmovehere  = get_string("movehere");
1371             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1372         }
1373         $initialised = true;
1374     }
1376     $modinfo = get_fast_modinfo($course);
1377     $completioninfo = new completion_info($course);
1379     //Accessibility: replace table with list <ul>, but don't output empty list.
1380     if (!empty($modinfo->sections[$section->section])) {
1382         // Fix bug #5027, don't want style=\"width:$width\".
1383         echo "<ul class=\"section img-text\">\n";
1385         foreach ($modinfo->sections[$section->section] as $modnumber) {
1386             $mod = $modinfo->cms[$modnumber];
1388             if ($ismoving and $mod->id == $USER->activitycopy) {
1389                 // do not display moving mod
1390                 continue;
1391             }
1393             // We can continue (because it will not be displayed at all)
1394             // if:
1395             // 1) The activity is not visible to users
1396             // and
1397             // 2a) The 'showavailability' option is not set (if that is set,
1398             //     we need to display the activity so we can show
1399             //     availability info)
1400             // or
1401             // 2b) The 'availableinfo' is empty, i.e. the activity was
1402             //     hidden in a way that leaves no info, such as using the
1403             //     eye icon.
1404             if (!$mod->uservisible &&
1405                 (empty($mod->showavailability) ||
1406                   empty($mod->availableinfo))) {
1407                 // visibility shortcut
1408                 continue;
1409             }
1411             // In some cases the activity is visible to user, but it is
1412             // dimmed. This is done if viewhiddenactivities is true and if:
1413             // 1. the activity is not visible, or
1414             // 2. the activity has dates set which do not include current, or
1415             // 3. the activity has any other conditions set (regardless of whether
1416             //    current user meets them)
1417             $modcontext = context_module::instance($mod->id);
1418             $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
1419             $accessiblebutdim = false;
1420             if ($canviewhidden) {
1421                 $accessiblebutdim = !$mod->visible;
1422                 if (!empty($CFG->enableavailability)) {
1423                     $accessiblebutdim = $accessiblebutdim ||
1424                         $mod->availablefrom > time() ||
1425                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1426                         count($mod->conditionsgrade) > 0 ||
1427                         count($mod->conditionscompletion) > 0;
1428                 }
1429             }
1431             $liclasses = array();
1432             $liclasses[] = 'activity';
1433             $liclasses[] = $mod->modname;
1434             $liclasses[] = 'modtype_'.$mod->modname;
1435             $extraclasses = $mod->get_extra_classes();
1436             if ($extraclasses) {
1437                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1438             }
1439             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1440             if ($ismoving) {
1441                 echo '<a title="'.$strmovefull.'"'.
1442                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1443                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1444                      ' alt="'.$strmovehere.'" /></a><br />
1445                      ';
1446             }
1448             $classes = array('mod-indent');
1449             if (!empty($mod->indent)) {
1450                 $classes[] = 'mod-indent-'.$mod->indent;
1451                 if ($mod->indent > 15) {
1452                     $classes[] = 'mod-indent-huge';
1453                 }
1454             }
1455             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1457             // Get data about this course-module
1458             list($content, $instancename) =
1459                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1461             //Accessibility: for files get description via icon, this is very ugly hack!
1462             $altname = '';
1463             $altname = $mod->modfullname;
1464             // Avoid unnecessary duplication: if e.g. a forum name already
1465             // includes the word forum (or Forum, etc) then it is unhelpful
1466             // to include that in the accessible description that is added.
1467             if (false !== strpos(textlib::strtolower($instancename),
1468                     textlib::strtolower($altname))) {
1469                 $altname = '';
1470             }
1471             // File type after name, for alphabetic lists (screen reader).
1472             if ($altname) {
1473                 $altname = get_accesshide(' '.$altname);
1474             }
1476             // We may be displaying this just in order to show information
1477             // about visibility, without the actual link
1478             $contentpart = '';
1479             if ($mod->uservisible) {
1480                 // Nope - in this case the link is fully working for user
1481                 $linkclasses = '';
1482                 $textclasses = '';
1483                 if ($accessiblebutdim) {
1484                     $linkclasses .= ' dimmed conditionalhidden';
1485                     $textclasses .= ' dimmed_text conditionalhidden';
1486                     $accesstext = '<span class="accesshide">'.
1487                         get_string('hiddenfromstudents').': </span>';
1488                 } else {
1489                     $accesstext = '';
1490                 }
1491                 if ($linkclasses) {
1492                     $linkcss = 'class="activityinstance ' . trim($linkclasses) . '" ';
1493                 } else {
1494                     $linkcss = 'class="activityinstance"';
1495                 }
1496                 if ($textclasses) {
1497                     $textcss = 'class="' . trim($textclasses) . '" ';
1498                 } else {
1499                     $textcss = '';
1500                 }
1502                 // Get on-click attribute value if specified
1503                 $onclick = $mod->get_on_click();
1504                 if ($onclick) {
1505                     $onclick = ' onclick="' . $onclick . '"';
1506                 }
1508                 if ($url = $mod->get_url()) {
1509                     // Display link itself
1510                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1511                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1512                             '" class="iconlarge activityicon" alt="' . $mod->modfullname . '" />' .
1513                             $accesstext . '<span class="instancename">' .
1514                             $instancename . $altname . '</span></a>';
1516                     // If specified, display extra content after link
1517                     if ($content) {
1518                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1519                                 '">' . $content . '</div>';
1520                     }
1521                 } else {
1522                     // No link, so display only content
1523                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1524                             $accesstext . $content . '</div>';
1525                 }
1527                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
1528                     $groupings = groups_get_all_groupings($course->id);
1529                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1530                 }
1531             } else {
1532                 $textclasses = $extraclasses;
1533                 $textclasses .= ' dimmed_text';
1534                 if ($textclasses) {
1535                     $textcss = 'class="' . trim($textclasses) . '" ';
1536                 } else {
1537                     $textcss = '';
1538                 }
1539                 $accesstext = '<span class="accesshide">' .
1540                         get_string('notavailableyet', 'condition') .
1541                         ': </span>';
1543                 if ($url = $mod->get_url()) {
1544                     // Display greyed-out text of link
1545                     echo '<div ' . $textcss . $mod->extra .
1546                             ' >' . '<img src="' . $mod->get_icon_url() .
1547                             '" class="activityicon" alt="" /> <span>'. $instancename . $altname .
1548                             '</span></div>';
1550                     // Do not display content after link when it is greyed out like this.
1551                 } else {
1552                     // No link, so display only content (also greyed)
1553                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1554                             $accesstext . $content . '</div>';
1555                 }
1556             }
1558             // Module can put text after the link (e.g. forum unread)
1559             echo $mod->get_after_link();
1561             // If there is content but NO link (eg label), then display the
1562             // content here (BEFORE any icons). In this case cons must be
1563             // displayed after the content so that it makes more sense visually
1564             // and for accessibility reasons, e.g. if you have a one-line label
1565             // it should work similarly (at least in terms of ordering) to an
1566             // activity.
1567             if (empty($url)) {
1568                 echo $contentpart;
1569             }
1571             if ($isediting) {
1572                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1573                     if (! $mod->groupmodelink = $groupbuttonslink) {
1574                         $mod->groupmode = $course->groupmode;
1575                     }
1577                 } else {
1578                     $mod->groupmode = false;
1579                 }
1580                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $sectionreturn);
1581                 echo $mod->get_after_edit_icons();
1582             }
1584             // Completion
1585             $completion = $hidecompletion
1586                 ? COMPLETION_TRACKING_NONE
1587                 : $completioninfo->is_enabled($mod);
1588             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1589                 !isguestuser() && $mod->uservisible) {
1590                 $completiondata = $completioninfo->get_data($mod,true);
1591                 $completionicon = '';
1592                 if ($isediting) {
1593                     switch ($completion) {
1594                         case COMPLETION_TRACKING_MANUAL :
1595                             $completionicon = 'manual-enabled'; break;
1596                         case COMPLETION_TRACKING_AUTOMATIC :
1597                             $completionicon = 'auto-enabled'; break;
1598                         default: // wtf
1599                     }
1600                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1601                     switch($completiondata->completionstate) {
1602                         case COMPLETION_INCOMPLETE:
1603                             $completionicon = 'manual-n'; break;
1604                         case COMPLETION_COMPLETE:
1605                             $completionicon = 'manual-y'; break;
1606                     }
1607                 } else { // Automatic
1608                     switch($completiondata->completionstate) {
1609                         case COMPLETION_INCOMPLETE:
1610                             $completionicon = 'auto-n'; break;
1611                         case COMPLETION_COMPLETE:
1612                             $completionicon = 'auto-y'; break;
1613                         case COMPLETION_COMPLETE_PASS:
1614                             $completionicon = 'auto-pass'; break;
1615                         case COMPLETION_COMPLETE_FAIL:
1616                             $completionicon = 'auto-fail'; break;
1617                     }
1618                 }
1619                 if ($completionicon) {
1620                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1621                     $formattedname = format_string($mod->name, true, array('context' => $modcontext));
1622                     $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
1623                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1624                         $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
1625                         $newstate =
1626                             $completiondata->completionstate==COMPLETION_COMPLETE
1627                             ? COMPLETION_INCOMPLETE
1628                             : COMPLETION_COMPLETE;
1629                         // In manual mode the icon is a toggle form...
1631                         // If this completion state is used by the
1632                         // conditional activities system, we need to turn
1633                         // off the JS.
1634                         if (!empty($CFG->enableavailability) &&
1635                             condition_info::completion_value_used_as_condition($course, $mod)) {
1636                             $extraclass = ' preventjs';
1637                         } else {
1638                             $extraclass = '';
1639                         }
1640                         echo "
1641 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1642 <input type='hidden' name='id' value='{$mod->id}' />
1643 <input type='hidden' name='modulename' value='".s($mod->name)."' />
1644 <input type='hidden' name='sesskey' value='".sesskey()."' />
1645 <input type='hidden' name='completionstate' value='$newstate' />
1646 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1647 </div></form>";
1648                     } else {
1649                         // In auto mode, or when editing, the icon is just an image
1650                         echo "<span class='autocompletion'>";
1651                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1652                     }
1653                 }
1654             }
1656             // If there is content AND a link, then display the content here
1657             // (AFTER any icons). Otherwise it was displayed before
1658             if (!empty($url)) {
1659                 echo $contentpart;
1660             }
1662             // Show availability information (for someone who isn't allowed to
1663             // see the activity itself, or for staff)
1664             if (!$mod->uservisible) {
1665                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1666             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1667                 $visibilityclass = '';
1668                 if (!$mod->visible) {
1669                     $visibilityclass = 'accesshide';
1670                 }
1671                 $ci = new condition_info($mod);
1672                 $fullinfo = $ci->get_full_information();
1673                 if($fullinfo) {
1674                     echo '<div class="availabilityinfo '.$visibilityclass.'">'.get_string($mod->showavailability
1675                         ? 'userrestriction_visible'
1676                         : 'userrestriction_hidden','condition',
1677                         $fullinfo).'</div>';
1678                 }
1679             }
1681             echo html_writer::end_tag('div');
1682             echo html_writer::end_tag('li')."\n";
1683         }
1685     } elseif ($ismoving) {
1686         echo "<ul class=\"section\">\n";
1687     }
1689     if ($ismoving) {
1690         echo '<li><a title="'.$strmovefull.'"'.
1691              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1692              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1693              ' alt="'.$strmovehere.'" /></a></li>
1694              ';
1695     }
1696     if (!empty($modinfo->sections[$section->section]) || $ismoving) {
1697         echo "</ul><!--class='section'-->\n\n";
1698     }
1701 /**
1702  * Prints the menus to add activities and resources.
1703  *
1704  * @param stdClass $course The course
1705  * @param int $section relative section number (field course_sections.section)
1706  * @param null|array $modnames An array containing the list of modules and their names
1707  *     if omitted will be taken from get_module_types_names()
1708  * @param bool $vertical Vertical orientation
1709  * @param bool $return Return the menus or send them to output
1710  * @param int $sectionreturn The section to link back to
1711  * @return void|string depending on $return
1712  */
1713 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1714     global $CFG, $OUTPUT;
1716     if ($modnames === null) {
1717         $modnames = get_module_types_names();
1718     }
1720     // check to see if user can add menus and there are modules to add
1721     if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
1722             || empty($modnames)) {
1723         if ($return) {
1724             return '';
1725         } else {
1726             return false;
1727         }
1728     }
1730     // Retrieve all modules with associated metadata
1731     $modules = get_module_metadata($course, $modnames, $sectionreturn);
1733     // We'll sort resources and activities into two lists
1734     $resources = array();
1735     $activities = array();
1737     // We need to add the section section to the link for each module
1738     $sectionlink = '&section=' . $section . '&sr=' . $sectionreturn;
1740     foreach ($modules as $module) {
1741         if (isset($module->types)) {
1742             // This module has a subtype
1743             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1744             $subtypes = array();
1745             foreach ($module->types as $subtype) {
1746                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1747             }
1749             // Sort module subtypes into the list
1750             if (!empty($module->title)) {
1751                 // This grouping has a name
1752                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1753                     $resources[] = array($module->title=>$subtypes);
1754                 } else {
1755                     $activities[] = array($module->title=>$subtypes);
1756                 }
1757             } else {
1758                 // This grouping does not have a name
1759                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1760                     $resources = array_merge($resources, $subtypes);
1761                 } else {
1762                     $activities = array_merge($activities, $subtypes);
1763                 }
1764             }
1765         } else {
1766             // This module has no subtypes
1767             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1768                 $resources[$module->link . $sectionlink] = $module->title;
1769             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1770                 // System modules cannot be added by user, do not add to dropdown
1771             } else {
1772                 $activities[$module->link . $sectionlink] = $module->title;
1773             }
1774         }
1775     }
1777     $straddactivity = get_string('addactivity');
1778     $straddresource = get_string('addresource');
1779     $sectionname = get_section_name($course, $section);
1780     $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
1781     $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
1783     $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
1785     if (!$vertical) {
1786         $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
1787     }
1789     if (!empty($resources)) {
1790         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1791         $select->set_help_icon('resources');
1792         $select->set_label($strresourcelabel, array('class' => 'accesshide'));
1793         $output .= $OUTPUT->render($select);
1794     }
1796     if (!empty($activities)) {
1797         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1798         $select->set_help_icon('activities');
1799         $select->set_label($stractivitylabel, array('class' => 'accesshide'));
1800         $output .= $OUTPUT->render($select);
1801     }
1803     if (!$vertical) {
1804         $output .= html_writer::end_tag('div');
1805     }
1807     $output .= html_writer::end_tag('div');
1809     if (course_ajax_enabled($course)) {
1810         $straddeither = get_string('addresourceoractivity');
1811         // The module chooser link
1812         $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1813         $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
1814         $icon = $OUTPUT->pix_icon('t/add', $straddeither);
1815         $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
1816         $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
1817         $modchooser.= html_writer::end_tag('div');
1818         $modchooser.= html_writer::end_tag('div');
1820         // Wrap the normal output in a noscript div
1821         $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
1822         if ($usemodchooser) {
1823             $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1824             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1825         } else {
1826             // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1827             $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1828             $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
1829         }
1830         $output = $modchooser . $output;
1831     }
1833     if ($return) {
1834         return $output;
1835     } else {
1836         echo $output;
1837     }
1840 /**
1841  * Retrieve all metadata for the requested modules
1842  *
1843  * @param object $course The Course
1844  * @param array $modnames An array containing the list of modules and their
1845  * names
1846  * @param int $sectionreturn The section to return to
1847  * @return array A list of stdClass objects containing metadata about each
1848  * module
1849  */
1850 function get_module_metadata($course, $modnames, $sectionreturn = null) {
1851     global $CFG, $OUTPUT;
1853     // get_module_metadata will be called once per section on the page and courses may show
1854     // different modules to one another
1855     static $modlist = array();
1856     if (!isset($modlist[$course->id])) {
1857         $modlist[$course->id] = array();
1858     }
1860     $return = array();
1861     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&sr='.$sectionreturn.'&add=';
1862     foreach($modnames as $modname => $modnamestr) {
1863         if (!course_allowed_module($course, $modname)) {
1864             continue;
1865         }
1866         if (isset($modlist[$modname])) {
1867             // This module is already cached
1868             $return[$modname] = $modlist[$course->id][$modname];
1869             continue;
1870         }
1872         // Include the module lib
1873         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1874         if (!file_exists($libfile)) {
1875             continue;
1876         }
1877         include_once($libfile);
1879         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1880         $gettypesfunc =  $modname.'_get_types';
1881         if (function_exists($gettypesfunc)) {
1882             if ($types = $gettypesfunc()) {
1883                 $group = new stdClass();
1884                 $group->name = $modname;
1885                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1886                 foreach($types as $type) {
1887                     if ($type->typestr === '--') {
1888                         continue;
1889                     }
1890                     if (strpos($type->typestr, '--') === 0) {
1891                         $group->title = str_replace('--', '', $type->typestr);
1892                         continue;
1893                     }
1894                     // Set the Sub Type metadata
1895                     $subtype = new stdClass();
1896                     $subtype->title = $type->typestr;
1897                     $subtype->type = str_replace('&amp;', '&', $type->type);
1898                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1899                     $subtype->archetype = $type->modclass;
1901                     // The group archetype should match the subtype archetypes and all subtypes
1902                     // should have the same archetype
1903                     $group->archetype = $subtype->archetype;
1905                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1906                         $subtype->help = get_string('help' . $subtype->name, $modname);
1907                     }
1908                     $subtype->link = $urlbase . $subtype->type;
1909                     $group->types[] = $subtype;
1910                 }
1911                 $modlist[$course->id][$modname] = $group;
1912             }
1913         } else {
1914             $module = new stdClass();
1915             $module->title = get_string('modulename', $modname);
1916             $module->name = $modname;
1917             $module->link = $urlbase . $modname;
1918             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1919             $sm = get_string_manager();
1920             if ($sm->string_exists('modulename_help', $modname)) {
1921                 $module->help = get_string('modulename_help', $modname);
1922                 if ($sm->string_exists('modulename_link', $modname)) {  // Link to further info in Moodle docs
1923                     $link = get_string('modulename_link', $modname);
1924                     $linktext = get_string('morehelp');
1925                     $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
1926                 }
1927             }
1928             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1929             $modlist[$course->id][$modname] = $module;
1930         }
1931         $return[$modname] = $modlist[$course->id][$modname];
1932     }
1934     return $return;
1937 /**
1938  * Return the course category context for the category with id $categoryid, except
1939  * that if $categoryid is 0, return the system context.
1940  *
1941  * @param integer $categoryid a category id or 0.
1942  * @return object the corresponding context
1943  */
1944 function get_category_or_system_context($categoryid) {
1945     if ($categoryid) {
1946         return context_coursecat::instance($categoryid, IGNORE_MISSING);
1947     } else {
1948         return context_system::instance();
1949     }
1952 /**
1953  * Gets the child categories of a given courses category. Uses a static cache
1954  * to make repeat calls efficient.
1955  *
1956  * @param int $parentid the id of a course category.
1957  * @return array all the child course categories.
1958  */
1959 function get_child_categories($parentid) {
1960     static $allcategories = null;
1962     // only fill in this variable the first time
1963     if (null == $allcategories) {
1964         $allcategories = array();
1966         $categories = get_categories();
1967         foreach ($categories as $category) {
1968             if (empty($allcategories[$category->parent])) {
1969                 $allcategories[$category->parent] = array();
1970             }
1971             $allcategories[$category->parent][] = $category;
1972         }
1973     }
1975     if (empty($allcategories[$parentid])) {
1976         return array();
1977     } else {
1978         return $allcategories[$parentid];
1979     }
1982 /**
1983  * This function recursively travels the categories, building up a nice list
1984  * for display. It also makes an array that list all the parents for each
1985  * category.
1986  *
1987  * For example, if you have a tree of categories like:
1988  *   Miscellaneous (id = 1)
1989  *      Subcategory (id = 2)
1990  *         Sub-subcategory (id = 4)
1991  *   Other category (id = 3)
1992  * Then after calling this function you will have
1993  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1994  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1995  *      3 => 'Other category');
1996  * $parents = array(2 => array(1), 4 => array(1, 2));
1997  *
1998  * If you specify $requiredcapability, then only categories where the current
1999  * user has that capability will be added to $list, although all categories
2000  * will still be added to $parents, and if you only have $requiredcapability
2001  * in a child category, not the parent, then the child catgegory will still be
2002  * included.
2003  *
2004  * If you specify the option $excluded, then that category, and all its children,
2005  * are omitted from the tree. This is useful when you are doing something like
2006  * moving categories, where you do not want to allow people to move a category
2007  * to be the child of itself.
2008  *
2009  * @param array $list For output, accumulates an array categoryid => full category path name
2010  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2011  * @param string/array $requiredcapability if given, only categories where the current
2012  *      user has this capability will be added to $list. Can also be an array of capabilities,
2013  *      in which case they are all required.
2014  * @param integer $excludeid Omit this category and its children from the lists built.
2015  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2016  * @param string $path For internal use, as part of recursive calls.
2017  */
2018 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2019         $excludeid = 0, $category = NULL, $path = "") {
2021     // initialize the arrays if needed
2022     if (!is_array($list)) {
2023         $list = array();
2024     }
2025     if (!is_array($parents)) {
2026         $parents = array();
2027     }
2029     if (empty($category)) {
2030         // Start at the top level.
2031         $category = new stdClass;
2032         $category->id = 0;
2033     } else {
2034         // This is the excluded category, don't include it.
2035         if ($excludeid > 0 && $excludeid == $category->id) {
2036             return;
2037         }
2039         $context = context_coursecat::instance($category->id);
2040         $categoryname = format_string($category->name, true, array('context' => $context));
2042         // Update $path.
2043         if ($path) {
2044             $path = $path.' / '.$categoryname;
2045         } else {
2046             $path = $categoryname;
2047         }
2049         // Add this category to $list, if the permissions check out.
2050         if (empty($requiredcapability)) {
2051             $list[$category->id] = $path;
2053         } else {
2054             $requiredcapability = (array)$requiredcapability;
2055             if (has_all_capabilities($requiredcapability, $context)) {
2056                 $list[$category->id] = $path;
2057             }
2058         }
2059     }
2061     // Add all the children recursively, while updating the parents array.
2062     if ($categories = get_child_categories($category->id)) {
2063         foreach ($categories as $cat) {
2064             if (!empty($category->id)) {
2065                 if (isset($parents[$category->id])) {
2066                     $parents[$cat->id]   = $parents[$category->id];
2067                 }
2068                 $parents[$cat->id][] = $category->id;
2069             }
2070             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2071         }
2072     }
2075 /**
2076  * This function generates a structured array of courses and categories.
2077  *
2078  * The depth of categories is limited by $CFG->maxcategorydepth however there
2079  * is no limit on the number of courses!
2080  *
2081  * Suitable for use with the course renderers course_category_tree method:
2082  * $renderer = $PAGE->get_renderer('core','course');
2083  * echo $renderer->course_category_tree(get_course_category_tree());
2084  *
2085  * @global moodle_database $DB
2086  * @param int $id
2087  * @param int $depth
2088  */
2089 function get_course_category_tree($id = 0, $depth = 0) {
2090     global $DB, $CFG;
2091     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
2092     $categories = get_child_categories($id);
2093     $categoryids = array();
2094     foreach ($categories as $key => &$category) {
2095         if (!$category->visible && !$viewhiddencats) {
2096             unset($categories[$key]);
2097             continue;
2098         }
2099         $categoryids[$category->id] = $category;
2100         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2101             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2102             foreach ($subcategories as $subid=>$subcat) {
2103                 $categoryids[$subid] = $subcat;
2104             }
2105             $category->courses = array();
2106         }
2107     }
2109     if ($depth > 0) {
2110         // This is a recursive call so return the required array
2111         return array($categories, $categoryids);
2112     }
2114     if (empty($categoryids)) {
2115         // No categories available (probably all hidden).
2116         return array();
2117     }
2119     // The depth is 0 this function has just been called so we can finish it off
2121     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2122     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2123     $sql = "SELECT
2124             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2125             $ccselect
2126             FROM {course} c
2127             $ccjoin
2128             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2129     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2130         // loop throught them
2131         foreach ($courses as $course) {
2132             if ($course->id == SITEID) {
2133                 continue;
2134             }
2135             context_instance_preload($course);
2136             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2137                 $categoryids[$course->category]->courses[$course->id] = $course;
2138             }
2139         }
2140     }
2141     return $categories;
2144 /**
2145  * Recursive function to print out all the categories in a nice format
2146  * with or without courses included
2147  */
2148 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2149     global $CFG;
2151     // maxcategorydepth == 0 meant no limit
2152     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2153         return;
2154     }
2156     if (!$displaylist) {
2157         make_categories_list($displaylist, $parentslist);
2158     }
2160     if ($category) {
2161         if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
2162             print_category_info($category, $depth, $showcourses);
2163         } else {
2164             return;  // Don't bother printing children of invisible categories
2165         }
2167     } else {
2168         $category = new stdClass();
2169         $category->id = "0";
2170     }
2172     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2173         $countcats = count($categories);
2174         $count = 0;
2175         $first = true;
2176         $last = false;
2177         foreach ($categories as $cat) {
2178             $count++;
2179             if ($count == $countcats) {
2180                 $last = true;
2181             }
2182             $up = $first ? false : true;
2183             $down = $last ? false : true;
2184             $first = false;
2186             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2187         }
2188     }
2191 /**
2192  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2193  */
2194 function make_categories_options() {
2195     make_categories_list($cats,$parents);
2196     foreach ($cats as $key => $value) {
2197         if (array_key_exists($key,$parents)) {
2198             if ($indent = count($parents[$key])) {
2199                 for ($i = 0; $i < $indent; $i++) {
2200                     $cats[$key] = '&nbsp;'.$cats[$key];
2201                 }
2202             }
2203         }
2204     }
2205     return $cats;
2208 /**
2209  * Prints the category info in indented fashion
2210  * This function is only used by print_whole_category_list() above
2211  */
2212 function print_category_info($category, $depth=0, $showcourses = false) {
2213     global $CFG, $DB, $OUTPUT;
2215     $strsummary = get_string('summary');
2217     $catlinkcss = null;
2218     if (!$category->visible) {
2219         $catlinkcss = array('class'=>'dimmed');
2220     }
2221     static $coursecount = null;
2222     if (null === $coursecount) {
2223         // only need to check this once
2224         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2225     }
2227     if ($showcourses and $coursecount) {
2228         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2229     } else {
2230         $catimage = "&nbsp;";
2231     }
2233     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2234     $context = context_coursecat::instance($category->id);
2235     $fullname = format_string($category->name, true, array('context' => $context));
2237     if ($showcourses and $coursecount) {
2238         echo '<div class="categorylist clearfix">';
2239         $cat = '';
2240         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2241         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2242         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2244         $html = '';
2245         if ($depth > 0) {
2246             for ($i=0; $i< $depth; $i++) {
2247                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2248                 $cat = '';
2249             }
2250         } else {
2251             $html = $cat;
2252         }
2253         echo html_writer::tag('div', $html, array('class'=>'category'));
2254         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2256         // does the depth exceed maxcategorydepth
2257         // maxcategorydepth == 0 or unset meant no limit
2258         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2259         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2260             foreach ($courses as $course) {
2261                 $linkcss = null;
2262                 if (!$course->visible) {
2263                     $linkcss = array('class'=>'dimmed');
2264                 }
2266                 $coursename = get_course_display_name_for_list($course);
2267                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2269                 // print enrol info
2270                 $courseicon = '';
2271                 if ($icons = enrol_get_course_info_icons($course)) {
2272                     foreach ($icons as $pix_icon) {
2273                         $courseicon = $OUTPUT->render($pix_icon).' ';
2274                     }
2275                 }
2277                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2279                 if ($course->summary) {
2280                     $link = new moodle_url('/course/info.php?id='.$course->id);
2281                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2282                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2283                         array('title'=>$strsummary));
2285                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2286                 }
2288                 $html = '';
2289                 for ($i=0; $i <= $depth; $i++) {
2290                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2291                     $coursecontent = '';
2292                 }
2293                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2294             }
2295         }
2296         echo '</div>';
2297     } else {
2298         echo '<div class="categorylist">';
2299         $html = '';
2300         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2301         if (count($courses) > 0) {
2302             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2303         }
2305         if ($depth > 0) {
2306             for ($i=0; $i< $depth; $i++) {
2307                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2308                 $cat = '';
2309             }
2310         } else {
2311             $html = $cat;
2312         }
2314         echo html_writer::tag('div', $html, array('class'=>'category'));
2315         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2316         echo '</div>';
2317     }
2320 /**
2321  * Print the buttons relating to course requests.
2322  *
2323  * @param object $systemcontext the system context.
2324  */
2325 function print_course_request_buttons($systemcontext) {
2326     global $CFG, $DB, $OUTPUT;
2327     if (empty($CFG->enablecourserequests)) {
2328         return;
2329     }
2330     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2331     /// Print a button to request a new course
2332         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2333     }
2334     /// Print a button to manage pending requests
2335     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2336         $disabled = !$DB->record_exists('course_request', array());
2337         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2338     }
2341 /**
2342  * Does the user have permission to edit things in this category?
2343  *
2344  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2345  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2346  */
2347 function can_edit_in_category($categoryid = 0) {
2348     $context = get_category_or_system_context($categoryid);
2349     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2352 /**
2353  * Prints the turn editing on/off button on course/index.php or course/category.php.
2354  *
2355  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2356  * @return string HTML of the editing button, or empty string, if this user is not allowed
2357  *      to see it.
2358  */
2359 function update_category_button($categoryid = 0) {
2360     global $CFG, $PAGE, $OUTPUT;
2362     // Check permissions.
2363     if (!can_edit_in_category($categoryid)) {
2364         return '';
2365     }
2367     // Work out the appropriate action.
2368     if ($PAGE->user_is_editing()) {
2369         $label = get_string('turneditingoff');
2370         $edit = 'off';
2371     } else {
2372         $label = get_string('turneditingon');
2373         $edit = 'on';
2374     }
2376     // Generate the button HTML.
2377     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2378     if ($categoryid) {
2379         $options['id'] = $categoryid;
2380         $page = 'category.php';
2381     } else {
2382         $page = 'index.php';
2383     }
2384     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2387 /**
2388  * Category is 0 (for all courses) or an object
2389  */
2390 function print_courses($category) {
2391     global $CFG, $OUTPUT;
2393     if (!is_object($category) && $category==0) {
2394         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2395         if (is_array($categories) && count($categories) == 1) {
2396             $category   = array_shift($categories);
2397             $courses    = get_courses_wmanagers($category->id,
2398                                                 'c.sortorder ASC',
2399                                                 array('summary','summaryformat'));
2400         } else {
2401             $courses    = get_courses_wmanagers('all',
2402                                                 'c.sortorder ASC',
2403                                                 array('summary','summaryformat'));
2404         }
2405         unset($categories);
2406     } else {
2407         $courses    = get_courses_wmanagers($category->id,
2408                                             'c.sortorder ASC',
2409                                             array('summary','summaryformat'));
2410     }
2412     if ($courses) {
2413         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2414         foreach ($courses as $course) {
2415             $coursecontext = context_course::instance($course->id);
2416             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2417                 echo html_writer::start_tag('li');
2418                 print_course($course);
2419                 echo html_writer::end_tag('li');
2420             }
2421         }
2422         echo html_writer::end_tag('ul');
2423     } else {
2424         echo $OUTPUT->heading(get_string("nocoursesyet"));
2425         $context = context_system::instance();
2426         if (has_capability('moodle/course:create', $context)) {
2427             $options = array();
2428             if (!empty($category->id)) {
2429                 $options['category'] = $category->id;
2430             } else {
2431                 $options['category'] = $CFG->defaultrequestcategory;
2432             }
2433             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2434             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2435             echo html_writer::end_tag('div');
2436         }
2437     }
2440 /**
2441  * Print a description of a course, suitable for browsing in a list.
2442  *
2443  * @param object $course the course object.
2444  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2445  */
2446 function print_course($course, $highlightterms = '') {
2447     global $CFG, $USER, $DB, $OUTPUT;
2449     $context = context_course::instance($course->id);
2451     // Rewrite file URLs so that they are correct
2452     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2454     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2455     echo html_writer::start_tag('div', array('class'=>'info'));
2456     echo html_writer::start_tag('h3', array('class'=>'name'));
2458     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2460     $coursename = get_course_display_name_for_list($course);
2461     $linktext = highlight($highlightterms, format_string($coursename));
2462     $linkparams = array('title'=>get_string('entercourse'));
2463     if (empty($course->visible)) {
2464         $linkparams['class'] = 'dimmed';
2465     }
2466     echo html_writer::link($linkhref, $linktext, $linkparams);
2467     echo html_writer::end_tag('h3');
2469     /// first find all roles that are supposed to be displayed
2470     if (!empty($CFG->coursecontact)) {
2471         $managerroles = explode(',', $CFG->coursecontact);
2472         $rusers = array();
2474         if (!isset($course->managers)) {
2475             list($sort, $sortparams) = users_order_by_sql('u');
2476             $rusers = get_role_users($managerroles, $context, true,
2477                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
2478                  r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
2479                 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
2480         } else {
2481             //  use the managers array if we have it for perf reasosn
2482             //  populate the datastructure like output of get_role_users();
2483             foreach ($course->managers as $manager) {
2484                 $user = clone($manager->user);
2485                 $user->roleid = $manager->roleid;
2486                 $user->rolename = $manager->rolename;
2487                 $user->roleshortname = $manager->roleshortname;
2488                 $user->rolecoursealias = $manager->rolecoursealias;
2489                 $rusers[$user->id] = $user;
2490             }
2491         }
2493         $namesarray = array();
2494         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2495         foreach ($rusers as $ra) {
2496             if (isset($namesarray[$ra->id])) {
2497                 //  only display a user once with the higest sortorder role
2498                 continue;
2499             }
2501             $role = new stdClass();
2502             $role->id = $ra->roleid;
2503             $role->name = $ra->rolename;
2504             $role->shortname = $ra->roleshortname;
2505             $role->coursealias = $ra->rolecoursealias;
2506             $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
2508             $fullname = fullname($ra, $canviewfullnames);
2509             $namesarray[$ra->id] = $rolename.': '.
2510                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2511         }
2513         if (!empty($namesarray)) {
2514             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2515             foreach ($namesarray as $name) {
2516                 echo html_writer::tag('li', $name);
2517             }
2518             echo html_writer::end_tag('ul');
2519         }
2520     }
2521     echo html_writer::end_tag('div'); // End of info div
2523     echo html_writer::start_tag('div', array('class'=>'summary'));
2524     $options = new stdClass();
2525     $options->noclean = true;
2526     $options->para = false;
2527     $options->overflowdiv = true;
2528     if (!isset($course->summaryformat)) {
2529         $course->summaryformat = FORMAT_MOODLE;
2530     }
2531     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2532     if ($icons = enrol_get_course_info_icons($course)) {
2533         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2534         foreach ($icons as $icon) {
2535             echo $OUTPUT->render($icon);
2536         }
2537         echo html_writer::end_tag('div'); // End of enrolmenticons div
2538     }
2539     echo html_writer::end_tag('div'); // End of summary div
2540     echo html_writer::end_tag('div'); // End of coursebox div
2543 /**
2544  * Prints custom user information on the home page.
2545  * Over time this can include all sorts of information
2546  */
2547 function print_my_moodle() {
2548     global $USER, $CFG, $DB, $OUTPUT;
2550     if (!isloggedin() or isguestuser()) {
2551         print_error('nopermissions', '', '', 'See My Moodle');
2552     }
2554     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2555     $rhosts   = array();
2556     $rcourses = array();
2557     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2558         $rcourses = get_my_remotecourses($USER->id);
2559         $rhosts   = get_my_remotehosts();
2560     }
2562     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2564         if (!empty($courses)) {
2565             echo '<ul class="unlist">';
2566             foreach ($courses as $course) {
2567                 if ($course->id == SITEID) {
2568                     continue;
2569                 }
2570                 echo '<li>';
2571                 print_course($course);
2572                 echo "</li>\n";
2573             }
2574             echo "</ul>\n";
2575         }
2577         // MNET
2578         if (!empty($rcourses)) {
2579             // at the IDP, we know of all the remote courses
2580             foreach ($rcourses as $course) {
2581                 print_remote_course($course, "100%");
2582             }
2583         } elseif (!empty($rhosts)) {
2584             // non-IDP, we know of all the remote servers, but not courses
2585             foreach ($rhosts as $host) {
2586                 print_remote_host($host, "100%");
2587             }
2588         }
2589         unset($course);
2590         unset($host);
2592         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2593             echo "<table width=\"100%\"><tr><td align=\"center\">";
2594             print_course_search("", false, "short");
2595             echo "</td><td align=\"center\">";
2596             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2597             echo "</td></tr></table>\n";
2598         }
2600     } else {
2601         if ($DB->count_records("course_categories") > 1) {
2602             echo $OUTPUT->box_start("categorybox");
2603             print_whole_category_list();
2604             echo $OUTPUT->box_end();
2605         } else {
2606             print_courses(0);
2607         }
2608     }
2612 function print_course_search($value="", $return=false, $format="plain") {
2613     global $CFG;
2614     static $count = 0;
2616     $count++;
2618     $id = 'coursesearch';
2620     if ($count > 1) {
2621         $id .= $count;
2622     }
2624     $strsearchcourses= get_string("searchcourses");
2626     if ($format == 'plain') {
2627         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2628         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2629         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2630         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2631         $output .= '<input type="submit" value="'.get_string('go').'" />';
2632         $output .= '</fieldset></form>';
2633     } else if ($format == 'short') {
2634         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2635         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2636         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2637         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2638         $output .= '<input type="submit" value="'.get_string('go').'" />';
2639         $output .= '</fieldset></form>';
2640     } else if ($format == 'navbar') {
2641         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2642         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2643         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2644         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2645         $output .= '<input type="submit" value="'.get_string('go').'" />';
2646         $output .= '</fieldset></form>';
2647     }
2649     if ($return) {
2650         return $output;
2651     }
2652     echo $output;
2655 function print_remote_course($course, $width="100%") {
2656     global $CFG, $USER;
2658     $linkcss = '';
2660     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2662     echo '<div class="coursebox remotecoursebox clearfix">';
2663     echo '<div class="info">';
2664     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2665          $linkcss.' href="'.$url.'">'
2666         .  format_string($course->fullname) .'</a><br />'
2667         . format_string($course->hostname) . ' : '
2668         . format_string($course->cat_name) . ' : '
2669         . format_string($course->shortname). '</div>';
2670     echo '</div><div class="summary">';
2671     $options = new stdClass();
2672     $options->noclean = true;
2673     $options->para = false;
2674     $options->overflowdiv = true;
2675     echo format_text($course->summary, $course->summaryformat, $options);
2676     echo '</div>';
2677     echo '</div>';
2680 function print_remote_host($host, $width="100%") {
2681     global $OUTPUT;
2683     $linkcss = '';
2685     echo '<div class="coursebox clearfix">';
2686     echo '<div class="info">';
2687     echo '<div class="name">';
2688     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2689     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2690         . s($host['name']).'</a> - ';
2691     echo $host['count'] . ' ' . get_string('courses');
2692     echo '</div>';
2693     echo '</div>';
2694     echo '</div>';
2698 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2700 function add_course_module($mod) {
2701     global $DB;
2703     $mod->added = time();
2704     unset($mod->id);
2706     $cmid = $DB->insert_record("course_modules", $mod);
2707     rebuild_course_cache($mod->course, true);
2708     return $cmid;
2711 /**
2712  * Creates missing course section(s) and rebuilds course cache
2713  *
2714  * @param int|stdClass $courseorid course id or course object
2715  * @param int|array $sections list of relative section numbers to create
2716  * @return bool if there were any sections created
2717  */
2718 function course_create_sections_if_missing($courseorid, $sections) {
2719     global $DB;
2720     if (!is_array($sections)) {
2721         $sections = array($sections);
2722     }
2723     $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2724     if (is_object($courseorid)) {
2725         $courseorid = $courseorid->id;
2726     }
2727     $coursechanged = false;
2728     foreach ($sections as $sectionnum) {
2729         if (!in_array($sectionnum, $existing)) {
2730             $cw = new stdClass();
2731             $cw->course   = $courseorid;
2732             $cw->section  = $sectionnum;
2733             $cw->summary  = '';
2734             $cw->summaryformat = FORMAT_HTML;
2735             $cw->sequence = '';
2736             $id = $DB->insert_record("course_sections", $cw);
2737             $coursechanged = true;
2738         }
2739     }
2740     if ($coursechanged) {
2741         rebuild_course_cache($courseorid, true);
2742     }
2743     return $coursechanged;
2746 /**
2747  * Adds an existing module to the section
2748  *
2749  * Updates both tables {course_sections} and {course_modules}
2750  *
2751  * @param int|stdClass $courseorid course id or course object
2752  * @param int $modid id of the module already existing in course_modules table
2753  * @param int $sectionnum relative number of the section (field course_sections.section)
2754  *     If section does not exist it will be created
2755  * @param int|stdClass $beforemod id or object with field id corresponding to the module
2756  *     before which the module needs to be included. Null for inserting in the
2757  *     end of the section
2758  * @return int The course_sections ID where the module is inserted
2759  */
2760 function course_add_cm_to_section($courseorid, $modid, $sectionnum, $beforemod = null) {
2761     global $DB, $COURSE;
2762     if (is_object($beforemod)) {
2763         $beforemod = $beforemod->id;
2764     }
2765     course_create_sections_if_missing($courseorid, $sectionnum);
2766     $section = get_fast_modinfo($courseorid)->get_section_info($sectionnum);
2767     $modarray = explode(",", trim($section->sequence));
2768     if (empty($section->sequence)) {
2769         $newsequence = "$modid";
2770     } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
2771         $insertarray = array($modid, $beforemod);
2772         array_splice($modarray, $key[0], 1, $insertarray);
2773         $newsequence = implode(",", $modarray);
2774     } else {
2775         $newsequence = "$section->sequence,$modid";
2776     }
2777     $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
2778     $DB->set_field('course_modules', 'section', $section->id, array('id' => $modid));
2779     if (is_object($courseorid)) {
2780         rebuild_course_cache($courseorid->id, true);
2781     } else {
2782         rebuild_course_cache($courseorid, true);
2783     }
2784     return $section->id;     // Return course_sections ID that was used.
2787 function set_coursemodule_groupmode($id, $groupmode) {
2788     global $DB;
2789     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2790     if ($cm->groupmode != $groupmode) {
2791         $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2792         rebuild_course_cache($cm->course, true);
2793     }
2794     return ($cm->groupmode != $groupmode);
2797 function set_coursemodule_idnumber($id, $idnumber) {
2798     global $DB;
2799     $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2800     if ($cm->idnumber != $idnumber) {
2801         $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2802         rebuild_course_cache($cm->course, true);
2803     }
2804     return ($cm->idnumber != $idnumber);
2807 /**
2808 * $prevstateoverrides = true will set the visibility of the course module
2809 * to what is defined in visibleold. This enables us to remember the current
2810 * visibility when making a whole section hidden, so that when we toggle
2811 * that section back to visible, we are able to return the visibility of
2812 * the course module back to what it was originally.
2813 */
2814 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2815     global $DB, $CFG;
2816     require_once($CFG->libdir.'/gradelib.php');
2818     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2819         return false;
2820     }
2821     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2822         return false;
2823     }
2824     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2825         foreach($events as $event) {
2826             if ($visible) {
2827                 show_event($event);
2828             } else {
2829                 hide_event($event);
2830             }
2831         }
2832     }
2834     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2835     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2836     if ($grade_items) {
2837         foreach ($grade_items as $grade_item) {
2838             $grade_item->set_hidden(!$visible);
2839         }
2840     }
2842     if ($prevstateoverrides) {
2843         if ($visible == '0') {
2844             // Remember the current visible state so we can toggle this back.
2845             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2846         } else {
2847             // Get the previous saved visible states.
2848             $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2849         }
2850     } else {
2851         $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2852     }
2853     rebuild_course_cache($cm->course, true);
2854     return true;
2857 /**
2858  * Delete a course module and any associated data at the course level (events)
2859  * Until 1.5 this function simply marked a deleted flag ... now it
2860  * deletes it completely.
2861  *
2862  */
2863 function delete_course_module($id) {
2864     global $CFG, $DB;
2865     require_once($CFG->libdir.'/gradelib.php');
2866     require_once($CFG->dirroot.'/blog/lib.php');
2868     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2869         return true;
2870     }
2871     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2872     //delete events from calendar
2873     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2874         foreach($events as $event) {
2875             delete_event($event->id);
2876         }
2877     }
2878     //delete grade items, outcome items and grades attached to modules
2879     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2880                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2881         foreach ($grade_items as $grade_item) {
2882             $grade_item->delete('moddelete');
2883         }
2884     }
2885     // Delete completion and availability data; it is better to do this even if the
2886     // features are not turned on, in case they were turned on previously (these will be
2887     // very quick on an empty table)
2888     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2889     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2890     $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
2891     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2892                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2894     delete_context(CONTEXT_MODULE, $cm->id);
2895     $DB->delete_records('course_modules', array('id'=>$cm->id));
2896     rebuild_course_cache($cm->course, true);
2897     return true;
2900 function delete_mod_from_section($modid, $sectionid) {
2901     global $DB;
2903     if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
2905         $modarray = explode(",", $section->sequence);
2907         if ($key = array_keys ($modarray, $modid)) {
2908             array_splice($modarray, $key[0], 1);
2909             $newsequence = implode(",", $modarray);
2910             $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2911             rebuild_course_cache($section->course, true);
2912             return true;
2913         } else {
2914             return false;
2915         }
2917     }
2918     return false;
2921 /**
2922  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2923  *
2924  * @param object $course course object
2925  * @param int $section Section number (not id!!!)
2926  * @param int $move (-1 or 1)
2927  * @return boolean true if section moved successfully
2928  * @todo MDL-33379 remove this function in 2.5
2929  */
2930 function move_section($course, $section, $move) {
2931     debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2933 /// Moves a whole course section up and down within the course
2934     global $USER;
2936     if (!$move) {
2937         return true;
2938     }
2940     $sectiondest = $section + $move;
2942     // compartibility with course formats using field 'numsections'
2943     $courseformatoptions = course_get_format($course)->get_format_options();
2944     if (array_key_exists('numsections', $courseformatoptions) &&
2945             $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
2946         return false;
2947     }
2949     $retval = move_section_to($course, $section, $sectiondest);
2950     return $retval;
2953 /**
2954  * Moves a section within a course, from a position to another.
2955  * Be very careful: $section and $destination refer to section number,
2956  * not id!.
2957  *
2958  * @param object $course
2959  * @param int $section Section number (not id!!!)
2960  * @param int $destination
2961  * @return boolean Result
2962  */
2963 function move_section_to($course, $section, $destination) {
2964 /// Moves a whole course section up and down within the course
2965     global $USER, $DB;
2967     if (!$destination && $destination != 0) {
2968         return true;
2969     }
2971     // compartibility with course formats using field 'numsections'
2972     $courseformatoptions = course_get_format($course)->get_format_options();
2973     if ((array_key_exists('numsections', $courseformatoptions) &&
2974             ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
2975         return false;
2976     }
2978     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2979     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2980             'section ASC, id ASC', 'id, section')) {
2981         return false;
2982     }
2984     $movedsections = reorder_sections($sections, $section, $destination);
2986     // Update all sections. Do this in 2 steps to avoid breaking database
2987     // uniqueness constraint
2988     $transaction = $DB->start_delegated_transaction();
2989     foreach ($movedsections as $id => $position) {
2990         if ($sections[$id] !== $position) {
2991             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2992         }
2993     }
2994     foreach ($movedsections as $id => $position) {
2995         if ($sections[$id] !== $position) {
2996             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2997         }
2998     }
3000     // If we move the highlighted section itself, then just highlight the destination.
3001     // Adjust the higlighted section location if we move something over it either direction.
3002     if ($section == $course->marker) {
3003         course_set_marker($course->id, $destination);
3004     } elseif ($section > $course->marker && $course->marker >= $destination) {
3005         course_set_marker($course->id, $course->marker+1);
3006     } elseif ($section < $course->marker && $course->marker <= $destination) {
3007         course_set_marker($course->id, $course->marker-1);
3008     }
3010     $transaction->allow_commit();
3011     rebuild_course_cache($course->id, true);
3012     return true;
3015 /**
3016  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3017  * an original position number and a target position number, rebuilds the array so that the
3018  * move is made without any duplication of section positions.
3019  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3020  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3021  *
3022  * @param array $sections
3023  * @param int $origin_position
3024  * @param int $target_position
3025  * @return array
3026  */
3027 function reorder_sections($sections, $origin_position, $target_position) {
3028     if (!is_array($sections)) {
3029         return false;
3030     }
3032     // We can't move section position 0
3033     if ($origin_position < 1) {
3034         echo "We can't move section position 0";
3035         return false;
3036     }
3038     // Locate origin section in sections array
3039     if (!$origin_key = array_search($origin_position, $sections)) {
3040         echo "searched position not in sections array";
3041         return false; // searched position not in sections array
3042     }
3044     // Extract origin section
3045     $origin_section = $sections[$origin_key];
3046     unset($sections[$origin_key]);
3048     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3049     $found = false;
3050     $append_array = array();
3051     foreach ($sections as $id => $position) {
3052         if ($found) {
3053             $append_array[$id] = $position;
3054             unset($sections[$id]);
3055         }
3056         if ($position == $target_position) {
3057             if ($target_position < $origin_position) {
3058                 $append_array[$id] = $position;
3059                 unset($sections[$id]);
3060             }
3061             $found = true;
3062         }
3063     }
3065     // Append moved section
3066     $sections[$origin_key] = $origin_section;
3068     // Append rest of array (if applicable)
3069     if (!empty($append_array)) {
3070         foreach ($append_array as $id => $position) {
3071             $sections[$id] = $position;
3072         }
3073     }
3075     // Renumber positions
3076     $position = 0;
3077     foreach ($sections as $id => $p) {
3078         $sections[$id] = $position;
3079         $position++;
3080     }
3082     return $sections;
3086 /**
3087  * Move the module object $mod to the specified $section
3088  * If $beforemod exists then that is the module
3089  * before which $modid should be inserted
3090  * All parameters are objects
3091  */
3092 function moveto_module($mod, $section, $beforemod=NULL) {
3093     global $OUTPUT;
3095 /// Remove original module from original section
3096     if (! delete_mod_from_section($mod->id, $mod->section)) {
3097         echo $OUTPUT->notification("Could not delete module from existing section");
3098     }
3100     // if moving to a hidden section then hide module
3101     if (!$section->visible && $mod->visible) {
3102         set_coursemodule_visible($mod->id, 0);
3103     }
3105 /// Add the module into the new section
3106     course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
3107     return true;
3110 /**
3111  * Produces the editing buttons for a module
3112  *
3113  * @global core_renderer $OUTPUT
3114  * @staticvar type $str
3115  * @param stdClass $mod The module to produce editing buttons for
3116  * @param bool $absolute_ignored ignored - all links are absolute
3117  * @param bool $moveselect If true a move seleciton process is used (default true)
3118  * @param int $indent The current indenting
3119  * @param int $section The section to link back to
3120  * @return string XHTML for the editing buttons
3121  */
3122 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
3123     global $CFG, $OUTPUT, $COURSE;
3125     static $str;
3127     $coursecontext = context_course::instance($mod->course);
3128     $modcontext = context_module::instance($mod->id);
3130     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3131     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3133     // no permission to edit anything
3134     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3135         return false;
3136     }
3138     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3140     if (!isset($str)) {
3141         $str = new stdClass;
3142         $str->assign         = get_string("assignroles", 'role');
3143         $str->delete         = get_string("delete");
3144         $str->move           = get_string("move");
3145         $str->moveup         = get_string("moveup");
3146         $str->movedown       = get_string("movedown");
3147         $str->moveright      = get_string("moveright");
3148         $str->moveleft       = get_string("moveleft");
3149         $str->update         = get_string("update");
3150         $str->duplicate      = get_string("duplicate");
3151         $str->hide           = get_string("hide");
3152         $str->show           = get_string("show");
3153         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3154         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3155         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3156         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3157         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3158         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3159         $str->edittitle = get_string('edittitle', 'moodle');
3160     }
3162     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3164     if ($section !== null) {
3165         $baseurl->param('sr', $section);
3166     }
3167     $actions = array();
3169     // AJAX edit title
3170     if ($mod->modname !== 'label' && $hasmanageactivities && course_ajax_enabled($COURSE)) {
3171         $actions[] = new action_link(
3172             new moodle_url($baseurl, array('update' => $mod->id)),
3173             new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3174             null,
3175             array('class' => 'editing_title', 'title' => $str->edittitle)
3176         );
3177     }
3179     // leftright
3180     if ($hasmanageactivities) {
3181         if (right_to_left()) {   // Exchange arrows on RTL
3182             $rightarrow = 't/left';
3183             $leftarrow  = 't/right';
3184         } else {
3185             $rightarrow = 't/right';
3186             $leftarrow  = 't/left';
3187         }
3189         if ($indent > 0) {
3190             $actions[] = new action_link(
3191                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3192                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3193                 null,
3194                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3195             );
3196         }
3197         if ($indent >= 0) {
3198             $actions[] = new action_link(
3199                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3200                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3201                 null,
3202                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3203             );
3204         }
3205     }
3207     // move
3208     if ($hasmanageactivities) {
3209         if ($moveselect) {
3210             $actions[] = new action_link(
3211                 new moodle_url($baseurl, array('copy' => $mod->id)),
3212                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3213                 null,
3214                 array('class' => 'editing_move', 'title' => $str->move)
3215             );
3216         } else {
3217             $actions[] = new action_link(
3218                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3219                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3220                 null,
3221                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3222             );
3223             $actions[] = new action_link(
3224                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3225                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3226                 null,
3227                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3228             );
3229         }
3230     }
3232     // Update
3233     if ($hasmanageactivities) {
3234         $actions[] = new action_link(
3235             new moodle_url($baseurl, array('update' => $mod->id)),
3236             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3237             null,
3238             array('class' => 'editing_update', 'title' => $str->update)
3239         );
3240     }
3242     // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
3243     if (has_all_capabilities($dupecaps, $coursecontext) && plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3244         $actions[] = new action_link(
3245             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3246             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3247             null,
3248             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3249         );
3250     }
3252     // Delete
3253     if ($hasmanageactivities) {
3254         $actions[] = new action_link(
3255             new moodle_url($baseurl, array('delete' => $mod->id)),
3256             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3257             null,
3258             array('class' => 'editing_delete', 'title' => $str->delete)
3259         );
3260     }
3262     // hideshow
3263     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3264         if ($mod->visible) {
3265             $actions[] = new action_link(
3266                 new moodle_url($baseurl, array('hide' => $mod->id)),
3267                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3268                 null,
3269                 array('class' => 'editing_hide', 'title' => $str->hide)
3270             );
3271         } else {
3272             $actions[] = new action_link(
3273                 new moodle_url($baseurl, array('show' => $mod->id)),
3274                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3275                 null,
3276                 array('class' => 'editing_show', 'title' => $str->show)
3277             );
3278         }
3279     }
3281     // groupmode
3282     if ($hasmanageactivities and $mod->groupmode !== false) {
3283         if ($mod->groupmode == SEPARATEGROUPS) {
3284             $groupmode = 0;
3285             $grouptitle = $str->groupsseparate;
3286             $forcedgrouptitle = $str->forcedgroupsseparate;
3287             $groupclass = 'editing_groupsseparate';
3288             $groupimage = 't/groups';
3289         } else if ($mod->groupmode == VISIBLEGROUPS) {
3290             $groupmode = 1;
3291             $grouptitle = $str->groupsvisible;
3292             $forcedgrouptitle = $str->forcedgroupsvisible;
3293             $groupclass = 'editing_groupsvisible';
3294             $groupimage = 't/groupv';
3295         } else {
3296             $groupmode = 2;
3297             $grouptitle = $str->groupsnone;
3298             $forcedgrouptitle = $str->forcedgroupsnone;
3299             $groupclass = 'editing_groupsnone';
3300             $groupimage = 't/groupn';
3301         }
3302         if ($mod->groupmodelink) {
3303             $actions[] = new action_link(
3304                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3305                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3306                 null,
3307                 array('class' => $groupclass, 'title' => $grouptitle)
3308             );
3309         } else {
3310             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3311         }
3312     }
3314     // Assign
3315     if (has_capability('moodle/role:assign', $modcontext)){
3316         $actions[] = new action_link(
3317             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3318             new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
3319             null,
3320             array('class' => 'editing_assign', 'title' => $str->assign)
3321         );
3322     }
3324     $output = html_writer::start_tag('span', array('class' => 'commands'));
3325     foreach ($actions as $action) {
3326         if ($action instanceof renderable) {
3327             $output .= $OUTPUT->render($action);
3328         } else {
3329             $output .= $action;
3330         }
3331     }
3332     $output .= html_writer::end_tag('span');
3333     return $output;
3336 /**
3337  * given a course object with shortname & fullname, this function will
3338  * truncate the the number of chars allowed and add ... if it was too long
3339  */
3340 function course_format_name ($course,$max=100) {
3342     $context = context_course::instance($course->id);
3343     $shortname = format_string($course->shortname, true, array('context' => $context));
3344     $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
3345     $str = $shortname.': '. $fullname;
3346     if (textlib::strlen($str) <= $max) {
3347         return $str;
3348     }
3349     else {
3350         return textlib::substr($str,0,$max-3).'...';
3351     }
3354 /**
3355  * Is the user allowed to add this type of module to this course?
3356  * @param object $course the course settings. Only $course->id is used.
3357  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3358  * @return bool whether the current user is allowed to add this type of module to this course.
3359  */
3360 function course_allowed_module($course, $modname) {
3361     if (is_numeric($modname)) {
3362         throw new coding_exception('Function course_allowed_module no longer
3363                 supports numeric module ids. Please update your code to pass the module name.');
3364     }
3366     $capability = 'mod/' . $modname . ':addinstance';
3367     if (!get_capability_info($capability)) {
3368         // Debug warning that the capability does not exist, but no more than once per page.
3369         static $warned = array();
3370         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3371         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3372             debugging('The module ' . $modname . ' does not define the standard capability ' .
3373                     $capability , DEBUG_DEVELOPER);
3374             $warned[$modname] = 1;
3375         }
3377         // If the capability does not exist, the module can always be added.
3378         return true;
3379     }
3381     $coursecontext = context_course::instance($course->id);
3382     return has_capability($capability, $coursecontext);
3385 /**
3386  * Recursively delete category including all subcategories and courses.
3387  * @param stdClass $category
3388  * @param boolean $showfeedback display some notices
3389  * @return array return deleted courses
3390  */
3391 function category_delete_full($category, $showfeedback=true) {
3392     global $CFG, $DB;
3393     require_once($CFG->libdir.'/gradelib.php');
3394     require_once($CFG->libdir.'/questionlib.php');
3395     require_once($CFG->dirroot.'/cohort/lib.php');
3397     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3398         foreach ($children as $childcat) {
3399             category_delete_full($childcat, $showfeedback);
3400         }
3401     }
3403     $deletedcourses = array();
3404     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3405         foreach ($courses as $course) {
3406             if (!delete_course($course, false)) {
3407                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3408             }
3409             $deletedcourses[] = $course;
3410         }
3411     }
3413     // move or delete cohorts in this context
3414     cohort_delete_category($category);
3416     // now delete anything that may depend on course category context
3417     grade_course_category_delete($category->id, 0, $showfeedback);
3418     if (!question_delete_course_category($category, 0, $showfeedback)) {
3419         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3420     }
3422     // finally delete the category and it's context
3423     $DB->delete_records('course_categories', array('id'=>$category->id));
3424     delete_context(CONTEXT_COURSECAT, $category->id);
3426     events_trigger('course_category_deleted', $category);
3428     return $deletedcourses;
3431 /**
3432  * Delete category, but move contents to another category.
3433  * @param object $ccategory
3434  * @param int $newparentid category id
3435  * @return bool status
3436  */
3437 function category_delete_move($category, $newparentid, $showfeedback=true) {
3438     global $CFG, $DB, $OUTPUT;
3439     require_once($CFG->libdir.'/gradelib.php');
3440     require_once($CFG->libdir.'/questionlib.php');
3441     require_once($CFG->dirroot.'/cohort/lib.php');
3443     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3444         return false;
3445     }
3447     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3448         foreach ($children as $childcat) {
3449             move_category($childcat, $newparentcat);
3450         }
3451     }
3453     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3454         if (!move_courses(array_keys($courses), $newparentid)) {
3455             if ($showfeedback) {
3456                 echo $OUTPUT->notification("Error moving courses");
3457             }
3458             return false;
3459         }
3460         if ($showfeedback) {
3461             echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3462         }
3463     }
3465     // move or delete cohorts in this context
3466     cohort_delete_category($category);
3468     // now delete anything that may depend on course category context
3469     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3470     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3471         if ($showfeedback) {
3472             echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3473         }
3474         return false;
3475     }
3477     // finally delete the category and it's context
3478     $DB->delete_records('course_categories', array('id'=>$category->id));
3479     delete_context(CONTEXT_COURSECAT, $category->id);
3481     events_trigger('course_category_deleted', $category);
3483     if ($showfeedback) {