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