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