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