MDL-22504 Course drag and drop upload - moved file locations
[moodle.git] / course / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of useful functions
20  *
21  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package core
24  * @subpackage course
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->libdir.'/completionlib.php');
30 require_once($CFG->libdir.'/filelib.php');
31 require_once($CFG->dirroot.'/course/dnduploadlib.php');
33 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
34 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
35 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
36 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
37 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
38 define('FRONTPAGENEWS',           '0');
39 define('FRONTPAGECOURSELIST',     '1');
40 define('FRONTPAGECATEGORYNAMES',  '2');
41 define('FRONTPAGETOPICONLY',      '3');
42 define('FRONTPAGECATEGORYCOMBO',  '4');
43 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
44 define('EXCELROWS', 65535);
45 define('FIRSTUSEDEXCELROW', 3);
47 define('MOD_CLASS_ACTIVITY', 0);
48 define('MOD_CLASS_RESOURCE', 1);
50 function make_log_url($module, $url) {
51     switch ($module) {
52         case 'course':
53             if (strpos($url, 'report/') === 0) {
54                 // there is only one report type, course reports are deprecated
55                 $url = "/$url";
56                 break;
57             }
58         case 'file':
59         case 'login':
60         case 'lib':
61         case 'admin':
62         case 'calendar':
63         case 'mnet course':
64             if (strpos($url, '../') === 0) {
65                 $url = ltrim($url, '.');
66             } else {
67                 $url = "/course/$url";
68             }
69             break;
70         case 'user':
71         case 'blog':
72             $url = "/$module/$url";
73             break;
74         case 'upload':
75             $url = $url;
76             break;
77         case 'coursetags':
78             $url = '/'.$url;
79             break;
80         case 'library':
81         case '':
82             $url = '/';
83             break;
84         case 'message':
85             $url = "/message/$url";
86             break;
87         case 'notes':
88             $url = "/notes/$url";
89             break;
90         case 'tag':
91             $url = "/tag/$url";
92             break;
93         case 'role':
94             $url = '/'.$url;
95             break;
96         default:
97             $url = "/mod/$module/$url";
98             break;
99     }
101     //now let's sanitise urls - there might be some ugly nasties:-(
102     $parts = explode('?', $url);
103     $script = array_shift($parts);
104     if (strpos($script, 'http') === 0) {
105         $script = clean_param($script, PARAM_URL);
106     } else {
107         $script = clean_param($script, PARAM_PATH);
108     }
110     $query = '';
111     if ($parts) {
112         $query = implode('', $parts);
113         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
114         $parts = explode('&', $query);
115         $eq = urlencode('=');
116         foreach ($parts as $key=>$part) {
117             $part = urlencode(urldecode($part));
118             $part = str_replace($eq, '=', $part);
119             $parts[$key] = $part;
120         }
121         $query = '?'.implode('&amp;', $parts);
122     }
124     return $script.$query;
128 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
129                    $modname="", $modid=0, $modaction="", $groupid=0) {
130     global $CFG, $DB;
132     // It is assumed that $date is the GMT time of midnight for that day,
133     // and so the next 86400 seconds worth of logs are printed.
135     /// Setup for group handling.
137     // TODO: I don't understand group/context/etc. enough to be able to do
138     // something interesting with it here
139     // What is the context of a remote course?
141     /// If the group mode is separate, and this user does not have editing privileges,
142     /// then only the user's group can be viewed.
143     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
144     //    $groupid = get_current_group($course->id);
145     //}
146     /// If this course doesn't have groups, no groupid can be specified.
147     //else if (!$course->groupmode) {
148     //    $groupid = 0;
149     //}
151     $groupid = 0;
153     $joins = array();
154     $where = '';
156     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
157               FROM {mnet_log} l
158                LEFT JOIN {user} u ON l.userid = u.id
159               WHERE ";
160     $params = array();
162     $where .= "l.hostid = :hostid";
163     $params['hostid'] = $hostid;
165     // TODO: Is 1 really a magic number referring to the sitename?
166     if ($course != SITEID || $modid != 0) {
167         $where .= " AND l.course=:courseid";
168         $params['courseid'] = $course;
169     }
171     if ($modname) {
172         $where .= " AND l.module = :modname";
173         $params['modname'] = $modname;
174     }
176     if ('site_errors' === $modid) {
177         $where .= " AND ( l.action='error' OR l.action='infected' )";
178     } else if ($modid) {
179         //TODO: This assumes that modids are the same across sites... probably
180         //not true
181         $where .= " AND l.cmid = :modid";
182         $params['modid'] = $modid;
183     }
185     if ($modaction) {
186         $firstletter = substr($modaction, 0, 1);
187         if ($firstletter == '-') {
188             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
189             $params['modaction'] = '%'.substr($modaction, 1).'%';
190         } else {
191             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
192             $params['modaction'] = '%'.$modaction.'%';
193         }
194     }
196     if ($user) {
197         $where .= " AND l.userid = :user";
198         $params['user'] = $user;
199     }
201     if ($date) {
202         $enddate = $date + 86400;
203         $where .= " AND l.time > :date AND l.time < :enddate";
204         $params['date'] = $date;
205         $params['enddate'] = $enddate;
206     }
208     $result = array();
209     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
210     if(!empty($result['totalcount'])) {
211         $where .= " ORDER BY $order";
212         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
213     } else {
214         $result['logs'] = array();
215     }
216     return $result;
219 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
220                    $modname="", $modid=0, $modaction="", $groupid=0) {
221     global $DB, $SESSION, $USER;
222     // It is assumed that $date is the GMT time of midnight for that day,
223     // and so the next 86400 seconds worth of logs are printed.
225     /// Setup for group handling.
227     /// If the group mode is separate, and this user does not have editing privileges,
228     /// then only the user's group can be viewed.
229     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
230         if (isset($SESSION->currentgroup[$course->id])) {
231             $groupid =  $SESSION->currentgroup[$course->id];
232         } else {
233             $groupid = groups_get_all_groups($course->id, $USER->id);
234             if (is_array($groupid)) {
235                 $groupid = array_shift(array_keys($groupid));
236                 $SESSION->currentgroup[$course->id] = $groupid;
237             } else {
238                 $groupid = 0;
239             }
240         }
241     }
242     /// If this course doesn't have groups, no groupid can be specified.
243     else if (!$course->groupmode) {
244         $groupid = 0;
245     }
247     $joins = array();
248     $params = array();
250     if ($course->id != SITEID || $modid != 0) {
251         $joins[] = "l.course = :courseid";
252         $params['courseid'] = $course->id;
253     }
255     if ($modname) {
256         $joins[] = "l.module = :modname";
257         $params['modname'] = $modname;
258     }
260     if ('site_errors' === $modid) {
261         $joins[] = "( l.action='error' OR l.action='infected' )";
262     } else if ($modid) {
263         $joins[] = "l.cmid = :modid";
264         $params['modid'] = $modid;
265     }
267     if ($modaction) {
268         $firstletter = substr($modaction, 0, 1);
269         if ($firstletter == '-') {
270             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
271             $params['modaction'] = '%'.substr($modaction, 1).'%';
272         } else {
273             $joins[] = $DB->sql_like('l.action', ':modaction', false);
274             $params['modaction'] = '%'.$modaction.'%';
275         }
276     }
279     /// Getting all members of a group.
280     if ($groupid and !$user) {
281         if ($gusers = groups_get_members($groupid)) {
282             $gusers = array_keys($gusers);
283             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
284         } else {
285             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
286         }
287     }
288     else if ($user) {
289         $joins[] = "l.userid = :userid";
290         $params['userid'] = $user;
291     }
293     if ($date) {
294         $enddate = $date + 86400;
295         $joins[] = "l.time > :date AND l.time < :enddate";
296         $params['date'] = $date;
297         $params['enddate'] = $enddate;
298     }
300     $selector = implode(' AND ', $joins);
302     $totalcount = 0;  // Initialise
303     $result = array();
304     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
305     $result['totalcount'] = $totalcount;
306     return $result;
310 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
311                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
313     global $CFG, $DB, $OUTPUT;
315     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
316                        $modname, $modid, $modaction, $groupid)) {
317         echo $OUTPUT->notification("No logs found!");
318         echo $OUTPUT->footer();
319         exit;
320     }
322     $courses = array();
324     if ($course->id == SITEID) {
325         $courses[0] = '';
326         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
327             foreach ($ccc as $cc) {
328                 $courses[$cc->id] = $cc->shortname;
329             }
330         }
331     } else {
332         $courses[$course->id] = $course->shortname;
333     }
335     $totalcount = $logs['totalcount'];
336     $count=0;
337     $ldcache = array();
338     $tt = getdate(time());
339     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
341     $strftimedatetime = get_string("strftimedatetime");
343     echo "<div class=\"info\">\n";
344     print_string("displayingrecords", "", $totalcount);
345     echo "</div>\n";
347     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
349     $table = new html_table();
350     $table->classes = array('logtable','generalbox');
351     $table->align = array('right', 'left', 'left');
352     $table->head = array(
353         get_string('time'),
354         get_string('ip_address'),
355         get_string('fullnameuser'),
356         get_string('action'),
357         get_string('info')
358     );
359     $table->data = array();
361     if ($course->id == SITEID) {
362         array_unshift($table->align, 'left');
363         array_unshift($table->head, get_string('course'));
364     }
366     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
367     if (empty($logs['logs'])) {
368         $logs['logs'] = array();
369     }
371     foreach ($logs['logs'] as $log) {
373         if (isset($ldcache[$log->module][$log->action])) {
374             $ld = $ldcache[$log->module][$log->action];
375         } else {
376             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
377             $ldcache[$log->module][$log->action] = $ld;
378         }
379         if ($ld && is_numeric($log->info)) {
380             // ugly hack to make sure fullname is shown correctly
381             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
382                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
383             } else {
384                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
385             }
386         }
388         //Filter log->info
389         $log->info = format_string($log->info);
391         // If $log->url has been trimmed short by the db size restriction
392         // code in add_to_log, keep a note so we don't add a link to a broken url
393         $brokenurl=(textlib::strlen($log->url)==100 && textlib::substr($log->url,97)=='...');
395         $row = array();
396         if ($course->id == SITEID) {
397             if (empty($log->course)) {
398                 $row[] = get_string('site');
399             } else {
400                 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
401             }
402         }
404         $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
406         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
407         $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
409         $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id))));
411         $displayaction="$log->module $log->action";
412         if ($brokenurl) {
413             $row[] = $displayaction;
414         } else {
415             $link = make_log_url($log->module,$log->url);
416             $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
417         }
418         $row[] = $log->info;
419         $table->data[] = $row;
420     }
422     echo html_writer::table($table);
423     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
427 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
428                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
430     global $CFG, $DB, $OUTPUT;
432     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
433                        $modname, $modid, $modaction, $groupid)) {
434         echo $OUTPUT->notification("No logs found!");
435         echo $OUTPUT->footer();
436         exit;
437     }
439     if ($course->id == SITEID) {
440         $courses[0] = '';
441         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
442             foreach ($ccc as $cc) {
443                 $courses[$cc->id] = $cc->shortname;
444             }
445         }
446     }
448     $totalcount = $logs['totalcount'];
449     $count=0;
450     $ldcache = array();
451     $tt = getdate(time());
452     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
454     $strftimedatetime = get_string("strftimedatetime");
456     echo "<div class=\"info\">\n";
457     print_string("displayingrecords", "", $totalcount);
458     echo "</div>\n";
460     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
462     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
463     echo "<tr>";
464     if ($course->id == SITEID) {
465         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
466     }
467     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
468     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
469     echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
470     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
471     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
472     echo "</tr>\n";
474     if (empty($logs['logs'])) {
475         echo "</table>\n";
476         return;
477     }
479     $row = 1;
480     foreach ($logs['logs'] as $log) {
482         $log->info = $log->coursename;
483         $row = ($row + 1) % 2;
485         if (isset($ldcache[$log->module][$log->action])) {
486             $ld = $ldcache[$log->module][$log->action];
487         } else {
488             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
489             $ldcache[$log->module][$log->action] = $ld;
490         }
491         if (0 && $ld && !empty($log->info)) {
492             // ugly hack to make sure fullname is shown correctly
493             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
494                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
495             } else {
496                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
497             }
498         }
500         //Filter log->info
501         $log->info = format_string($log->info);
503         echo '<tr class="r'.$row.'">';
504         if ($course->id == SITEID) {
505             $courseshortname = format_string($courses[$log->course], true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
506             echo "<td class=\"r$row c0\" >\n";
507             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
508             echo "</td>\n";
509         }
510         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
511              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
512         echo "<td class=\"r$row c2\" >\n";
513         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
514         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
515         echo "</td>\n";
516         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
517         echo "<td class=\"r$row c3\" >\n";
518         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
519         echo "</td>\n";
520         echo "<td class=\"r$row c4\">\n";
521         echo $log->action .': '.$log->module;
522         echo "</td>\n";;
523         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
524         echo "</tr>\n";
525     }
526     echo "</table>\n";
528     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
532 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
533                         $modid, $modaction, $groupid) {
534     global $DB;
536     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
537             get_string('fullnameuser')."\t".get_string('action')."\t".get_string('info');
539     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
540                        $modname, $modid, $modaction, $groupid)) {
541         return false;
542     }
544     $courses = array();
546     if ($course->id == SITEID) {
547         $courses[0] = '';
548         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
549             foreach ($ccc as $cc) {
550                 $courses[$cc->id] = $cc->shortname;
551             }
552         }
553     } else {
554         $courses[$course->id] = $course->shortname;
555     }
557     $count=0;
558     $ldcache = array();
559     $tt = getdate(time());
560     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
562     $strftimedatetime = get_string("strftimedatetime");
564     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
565     $filename .= '.txt';
566     header("Content-Type: application/download\n");
567     header("Content-Disposition: attachment; filename=$filename");
568     header("Expires: 0");
569     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
570     header("Pragma: public");
572     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
573     echo $text."\n";
575     if (empty($logs['logs'])) {
576         return true;
577     }
579     foreach ($logs['logs'] as $log) {
580         if (isset($ldcache[$log->module][$log->action])) {
581             $ld = $ldcache[$log->module][$log->action];
582         } else {
583             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
584             $ldcache[$log->module][$log->action] = $ld;
585         }
586         if ($ld && !empty($log->info)) {
587             // ugly hack to make sure fullname is shown correctly
588             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
589                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
590             } else {
591                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
592             }
593         }
595         //Filter log->info
596         $log->info = format_string($log->info);
597         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
599         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
600         $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
601         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
602         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
603         $text = implode("\t", $row);
604         echo $text." \n";
605     }
606     return true;
610 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
611                         $modid, $modaction, $groupid) {
613     global $CFG, $DB;
615     require_once("$CFG->libdir/excellib.class.php");
617     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
618                        $modname, $modid, $modaction, $groupid)) {
619         return false;
620     }
622     $courses = array();
624     if ($course->id == SITEID) {
625         $courses[0] = '';
626         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
627             foreach ($ccc as $cc) {
628                 $courses[$cc->id] = $cc->shortname;
629             }
630         }
631     } else {
632         $courses[$course->id] = $course->shortname;
633     }
635     $count=0;
636     $ldcache = array();
637     $tt = getdate(time());
638     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
640     $strftimedatetime = get_string("strftimedatetime");
642     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
643     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
644     $filename .= '.xls';
646     $workbook = new MoodleExcelWorkbook('-');
647     $workbook->send($filename);
649     $worksheet = array();
650     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
651                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
653     // Creating worksheets
654     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
655         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
656         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
657         $worksheet[$wsnumber]->set_column(1, 1, 30);
658         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
659                                     userdate(time(), $strftimedatetime));
660         $col = 0;
661         foreach ($headers as $item) {
662             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
663             $col++;
664         }
665     }
667     if (empty($logs['logs'])) {
668         $workbook->close();
669         return true;
670     }
672     $formatDate =& $workbook->add_format();
673     $formatDate->set_num_format(get_string('log_excel_date_format'));
675     $row = FIRSTUSEDEXCELROW;
676     $wsnumber = 1;
677     $myxls =& $worksheet[$wsnumber];
678     foreach ($logs['logs'] as $log) {
679         if (isset($ldcache[$log->module][$log->action])) {
680             $ld = $ldcache[$log->module][$log->action];
681         } else {
682             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
683             $ldcache[$log->module][$log->action] = $ld;
684         }
685         if ($ld && !empty($log->info)) {
686             // ugly hack to make sure fullname is shown correctly
687             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
688                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
689             } else {
690                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
691             }
692         }
694         // Filter log->info
695         $log->info = format_string($log->info);
696         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
698         if ($nroPages>1) {
699             if ($row > EXCELROWS) {
700                 $wsnumber++;
701                 $myxls =& $worksheet[$wsnumber];
702                 $row = FIRSTUSEDEXCELROW;
703             }
704         }
706         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
708         $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
709         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
710         $myxls->write($row, 2, $log->ip, '');
711         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
712         $myxls->write($row, 3, $fullname, '');
713         $myxls->write($row, 4, $log->module.' '.$log->action, '');
714         $myxls->write($row, 5, $log->info, '');
716         $row++;
717     }
719     $workbook->close();
720     return true;
723 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
724                         $modid, $modaction, $groupid) {
726     global $CFG, $DB;
728     require_once("$CFG->libdir/odslib.class.php");
730     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
731                        $modname, $modid, $modaction, $groupid)) {
732         return false;
733     }
735     $courses = array();
737     if ($course->id == SITEID) {
738         $courses[0] = '';
739         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
740             foreach ($ccc as $cc) {
741                 $courses[$cc->id] = $cc->shortname;
742             }
743         }
744     } else {
745         $courses[$course->id] = $course->shortname;
746     }
748     $count=0;
749     $ldcache = array();
750     $tt = getdate(time());
751     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
753     $strftimedatetime = get_string("strftimedatetime");
755     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
756     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
757     $filename .= '.ods';
759     $workbook = new MoodleODSWorkbook('-');
760     $workbook->send($filename);
762     $worksheet = array();
763     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
764                         get_string('fullnameuser'),    get_string('action'), get_string('info'));
766     // Creating worksheets
767     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
768         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
769         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
770         $worksheet[$wsnumber]->set_column(1, 1, 30);
771         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
772                                     userdate(time(), $strftimedatetime));
773         $col = 0;
774         foreach ($headers as $item) {
775             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
776             $col++;
777         }
778     }
780     if (empty($logs['logs'])) {
781         $workbook->close();
782         return true;
783     }
785     $formatDate =& $workbook->add_format();
786     $formatDate->set_num_format(get_string('log_excel_date_format'));
788     $row = FIRSTUSEDEXCELROW;
789     $wsnumber = 1;
790     $myxls =& $worksheet[$wsnumber];
791     foreach ($logs['logs'] as $log) {
792         if (isset($ldcache[$log->module][$log->action])) {
793             $ld = $ldcache[$log->module][$log->action];
794         } else {
795             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
796             $ldcache[$log->module][$log->action] = $ld;
797         }
798         if ($ld && !empty($log->info)) {
799             // ugly hack to make sure fullname is shown correctly
800             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
801                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
802             } else {
803                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
804             }
805         }
807         // Filter log->info
808         $log->info = format_string($log->info);
809         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
811         if ($nroPages>1) {
812             if ($row > EXCELROWS) {
813                 $wsnumber++;
814                 $myxls =& $worksheet[$wsnumber];
815                 $row = FIRSTUSEDEXCELROW;
816             }
817         }
819         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
821         $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
822         $myxls->write_date($row, 1, $log->time);
823         $myxls->write_string($row, 2, $log->ip);
824         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
825         $myxls->write_string($row, 3, $fullname);
826         $myxls->write_string($row, 4, $log->module.' '.$log->action);
827         $myxls->write_string($row, 5, $log->info);
829         $row++;
830     }
832     $workbook->close();
833     return true;
837 function print_overview($courses, array $remote_courses=array()) {
838     global $CFG, $USER, $DB, $OUTPUT;
840     $htmlarray = array();
841     if ($modules = $DB->get_records('modules')) {
842         foreach ($modules as $mod) {
843             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
844                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
845                 $fname = $mod->name.'_print_overview';
846                 if (function_exists($fname)) {
847                     $fname($courses,$htmlarray);
848                 }
849             }
850         }
851     }
852     foreach ($courses as $course) {
853         $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
854         echo $OUTPUT->box_start('coursebox');
855         $attributes = array('title' => s($fullname));
856         if (empty($course->visible)) {
857             $attributes['class'] = 'dimmed';
858         }
859         echo $OUTPUT->heading(html_writer::link(
860             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
861         if (array_key_exists($course->id,$htmlarray)) {
862             foreach ($htmlarray[$course->id] as $modname => $html) {
863                 echo $html;
864             }
865         }
866         echo $OUTPUT->box_end();
867     }
869     if (!empty($remote_courses)) {
870         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
871     }
872     foreach ($remote_courses as $course) {
873         echo $OUTPUT->box_start('coursebox');
874         $attributes = array('title' => s($course->fullname));
875         echo $OUTPUT->heading(html_writer::link(
876             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
877             format_string($course->shortname),
878             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
879         echo $OUTPUT->box_end();
880     }
884 /**
885  * This function trawls through the logs looking for
886  * anything new since the user's last login
887  */
888 function print_recent_activity($course) {
889     // $course is an object
890     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
892     $context = get_context_instance(CONTEXT_COURSE, $course->id);
894     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
896     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
898     if (!isguestuser()) {
899         if (!empty($USER->lastcourseaccess[$course->id])) {
900             if ($USER->lastcourseaccess[$course->id] > $timestart) {
901                 $timestart = $USER->lastcourseaccess[$course->id];
902             }
903         }
904     }
906     echo '<div class="activitydate">';
907     echo get_string('activitysince', '', userdate($timestart));
908     echo '</div>';
909     echo '<div class="activityhead">';
911     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
913     echo "</div>\n";
915     $content = false;
917 /// Firstly, have there been any new enrolments?
919     $users = get_recent_enrolments($course->id, $timestart);
921     //Accessibility: new users now appear in an <OL> list.
922     if ($users) {
923         echo '<div class="newusers">';
924         echo $OUTPUT->heading(get_string("newusers").':', 3);
925         $content = true;
926         echo "<ol class=\"list\">\n";
927         foreach ($users as $user) {
928             $fullname = fullname($user, $viewfullnames);
929             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
930         }
931         echo "</ol>\n</div>\n";
932     }
934 /// Next, have there been any modifications to the course structure?
936     $modinfo = get_fast_modinfo($course);
938     $changelist = array();
940     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
941                                             module = 'course' AND
942                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
943                                     array($timestart, $course->id), "id ASC");
945     if ($logs) {
946         $actions  = array('add mod', 'update mod', 'delete mod');
947         $newgones = array(); // added and later deleted items
948         foreach ($logs as $key => $log) {
949             if (!in_array($log->action, $actions)) {
950                 continue;
951             }
952             $info = explode(' ', $log->info);
954             // note: in most cases I replaced hardcoding of label with use of
955             // $cm->has_view() but it was not possible to do this here because
956             // we don't necessarily have the $cm for it
957             if ($info[0] == 'label') {     // Labels are ignored in recent activity
958                 continue;
959             }
961             if (count($info) != 2) {
962                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
963                 continue;
964             }
966             $modname    = $info[0];
967             $instanceid = $info[1];
969             if ($log->action == 'delete mod') {
970                 // unfortunately we do not know if the mod was visible
971                 if (!array_key_exists($log->info, $newgones)) {
972                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
973                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
974                 }
975             } else {
976                 if (!isset($modinfo->instances[$modname][$instanceid])) {
977                     if ($log->action == 'add mod') {
978                         // do not display added and later deleted activities
979                         $newgones[$log->info] = true;
980                     }
981                     continue;
982                 }
983                 $cm = $modinfo->instances[$modname][$instanceid];
984                 if (!$cm->uservisible) {
985                     continue;
986                 }
988                 if ($log->action == 'add mod') {
989                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
990                     $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>");
992                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
993                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
994                     $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>");
995                 }
996             }
997         }
998     }
1000     if (!empty($changelist)) {
1001         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1002         $content = true;
1003         foreach ($changelist as $changeinfo => $change) {
1004             echo '<p class="activity">'.$change['text'].'</p>';
1005         }
1006     }
1008 /// Now display new things from each module
1010     $usedmodules = array();
1011     foreach($modinfo->cms as $cm) {
1012         if (isset($usedmodules[$cm->modname])) {
1013             continue;
1014         }
1015         if (!$cm->uservisible) {
1016             continue;
1017         }
1018         $usedmodules[$cm->modname] = $cm->modname;
1019     }
1021     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1022         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1023             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1024             $print_recent_activity = $modname.'_print_recent_activity';
1025             if (function_exists($print_recent_activity)) {
1026                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1027                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1028             }
1029         } else {
1030             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1031         }
1032     }
1034     if (! $content) {
1035         echo '<p class="message">'.get_string('nothingnew').'</p>';
1036     }
1039 /**
1040  * For a given course, returns an array of course activity objects
1041  * Each item in the array contains he following properties:
1042  */
1043 function get_array_of_activities($courseid) {
1044 //  cm - course module id
1045 //  mod - name of the module (eg forum)
1046 //  section - the number of the section (eg week or topic)
1047 //  name - the name of the instance
1048 //  visible - is the instance visible or not
1049 //  groupingid - grouping id
1050 //  groupmembersonly - is this instance visible to group members only
1051 //  extra - contains extra string to include in any link
1052     global $CFG, $DB;
1053     if(!empty($CFG->enableavailability)) {
1054         require_once($CFG->libdir.'/conditionlib.php');
1055     }
1057     $course = $DB->get_record('course', array('id'=>$courseid));
1059     if (empty($course)) {
1060         throw new moodle_exception('courseidnotfound');
1061     }
1063     $mod = array();
1065     $rawmods = get_course_mods($courseid);
1066     if (empty($rawmods)) {
1067         return $mod; // always return array
1068     }
1070     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1071        foreach ($sections as $section) {
1072            if (!empty($section->sequence)) {
1073                $sequence = explode(",", $section->sequence);
1074                foreach ($sequence as $seq) {
1075                    if (empty($rawmods[$seq])) {
1076                        continue;
1077                    }
1078                    $mod[$seq] = new stdClass();
1079                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1080                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1081                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1083                     // Oh dear. Inconsistent names left here for backward compatibility.
1084                    $mod[$seq]->section          = $section->section;
1085                    $mod[$seq]->sectionid        = $rawmods[$seq]->section;
1087                    $mod[$seq]->module           = $rawmods[$seq]->module;
1088                    $mod[$seq]->added            = $rawmods[$seq]->added;
1089                    $mod[$seq]->score            = $rawmods[$seq]->score;
1090                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1091                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1092                    $mod[$seq]->visibleold       = $rawmods[$seq]->visibleold;
1093                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1094                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1095                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1096                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1097                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1098                    $mod[$seq]->extra            = "";
1099                    $mod[$seq]->completiongradeitemnumber =
1100                            $rawmods[$seq]->completiongradeitemnumber;
1101                    $mod[$seq]->completionview   = $rawmods[$seq]->completionview;
1102                    $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
1103                    $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1104                    $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1105                    $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1106                    $mod[$seq]->showdescription  = $rawmods[$seq]->showdescription;
1107                    if (!empty($CFG->enableavailability)) {
1108                        condition_info::fill_availability_conditions($rawmods[$seq]);
1109                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1110                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1111                    }
1113                    $modname = $mod[$seq]->mod;
1114                    $functionname = $modname."_get_coursemodule_info";
1116                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1117                        continue;
1118                    }
1120                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1122                    if ($hasfunction = function_exists($functionname)) {
1123                        if ($info = $functionname($rawmods[$seq])) {
1124                            if (!empty($info->icon)) {
1125                                $mod[$seq]->icon = $info->icon;
1126                            }
1127                            if (!empty($info->iconcomponent)) {
1128                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1129                            }
1130                            if (!empty($info->name)) {
1131                                $mod[$seq]->name = $info->name;
1132                            }
1133                            if ($info instanceof cached_cm_info) {
1134                                // When using cached_cm_info you can include three new fields
1135                                // that aren't available for legacy code
1136                                if (!empty($info->content)) {
1137                                    $mod[$seq]->content = $info->content;
1138                                }
1139                                if (!empty($info->extraclasses)) {
1140                                    $mod[$seq]->extraclasses = $info->extraclasses;
1141                                }
1142                                if (!empty($info->iconurl)) {
1143                                    $mod[$seq]->iconurl = $info->iconurl;
1144                                }
1145                                if (!empty($info->onclick)) {
1146                                    $mod[$seq]->onclick = $info->onclick;
1147                                }
1148                                if (!empty($info->customdata)) {
1149                                    $mod[$seq]->customdata = $info->customdata;
1150                                }
1151                            } else {
1152                                // When using a stdclass, the (horrible) deprecated ->extra field
1153                                // is available for BC
1154                                if (!empty($info->extra)) {
1155                                    $mod[$seq]->extra = $info->extra;
1156                                }
1157                            }
1158                        }
1159                    }
1160                    // When there is no modname_get_coursemodule_info function,
1161                    // but showdescriptions is enabled, then we use the 'intro'
1162                    // and 'introformat' fields in the module table
1163                    if (!$hasfunction && $rawmods[$seq]->showdescription) {
1164                        if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1165                                array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1166                            // Set content from intro and introformat. Filters are disabled
1167                            // because we  filter it with format_text at display time
1168                            $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1169                                    $modvalues, $rawmods[$seq]->id, false);
1171                            // To save making another query just below, put name in here
1172                            $mod[$seq]->name = $modvalues->name;
1173                        }
1174                    }
1175                    if (!isset($mod[$seq]->name)) {
1176                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1177                    }
1179                    // Minimise the database size by unsetting default options when they are
1180                    // 'empty'. This list corresponds to code in the cm_info constructor.
1181                    foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
1182                            'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1183                            'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1184                            'availableuntil', 'conditionscompletion', 'conditionsgrade',
1185                            'completionview', 'completionexpected', 'score', 'showdescription')
1186                            as $property) {
1187                        if (property_exists($mod[$seq], $property) &&
1188                                empty($mod[$seq]->{$property})) {
1189                            unset($mod[$seq]->{$property});
1190                        }
1191                    }
1192                    // Special case: this value is usually set to null, but may be 0
1193                    if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1194                            is_null($mod[$seq]->completiongradeitemnumber)) {
1195                        unset($mod[$seq]->completiongradeitemnumber);
1196                    }
1197                }
1198             }
1199         }
1200     }
1201     return $mod;
1205 /**
1206  * Returns a number of useful structures for course displays
1207  */
1208 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1209     global $CFG, $DB, $COURSE;
1211     $mods          = array();    // course modules indexed by id
1212     $modnames      = array();    // all course module names (except resource!)
1213     $modnamesplural= array();    // all course module names (plural form)
1214     $modnamesused  = array();    // course module names used
1216     if ($allmods = $DB->get_records("modules")) {
1217         foreach ($allmods as $mod) {
1218             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1219                 continue;
1220             }
1221             if ($mod->visible) {
1222                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1223                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1224             }
1225         }
1226         collatorlib::asort($modnames);
1227     } else {
1228         print_error("nomodules", 'debug');
1229     }
1231     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1232     $modinfo = get_fast_modinfo($course);
1234     if ($rawmods=$modinfo->cms) {
1235         foreach($rawmods as $mod) {    // Index the mods
1236             if (empty($modnames[$mod->modname])) {
1237                 continue;
1238             }
1239             $mods[$mod->id] = $mod;
1240             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1241             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1242                 continue;
1243             }
1244             // Check groupings
1245             if (!groups_course_module_visible($mod)) {
1246                 continue;
1247             }
1248             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1249         }
1250         if ($modnamesused) {
1251             collatorlib::asort($modnamesused);
1252         }
1253     }
1256 /**
1257  * Returns an array of sections for the requested course id
1258  *
1259  * This function stores the sections against the course id within a staticvar encase
1260  * of subsequent requests. This is used all over + in some standard libs and course
1261  * format callbacks so subsequent requests are a reality.
1262  *
1263  * @staticvar array $coursesections
1264  * @param int $courseid
1265  * @return array Array of sections
1266  */
1267 function get_all_sections($courseid) {
1268     global $DB;
1269     static $coursesections = array();
1270     if (!array_key_exists($courseid, $coursesections)) {
1271         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1272                            "section, id, course, name, summary, summaryformat, sequence, visible");
1273     }
1274     return $coursesections[$courseid];
1277 /**
1278  * Returns the course section to display or 0 meaning show all sections. Returns 0 for guests.
1279  * It also sets the $USER->display cache to array($courseid=>return value)
1280  *
1281  * @param int $courseid The course id
1282  * @return int Course section to display, 0 means all
1283  */
1284 function course_get_display($courseid) {
1285     global $USER, $DB;
1287     if (!isloggedin() or isguestuser()) {
1288         //do not get settings in db for guests
1289         return 0; //return the implicit setting
1290     }
1292     if (!isset($USER->display[$courseid])) {
1293         if (!$display = $DB->get_field('course_display', 'display', array('userid' => $USER->id, 'course'=>$courseid))) {
1294             $display = 0; // all sections option is not stored in DB, this makes the table much smaller
1295         }
1296         //use display cache for one course only - we need to keep session small
1297         $USER->display = array($courseid => $display);
1298     }
1300     return $USER->display[$courseid];
1303 /**
1304  * Show one section only or all sections.
1305  *
1306  * @param int $courseid The course id
1307  * @param mixed $display show only this section, 0 or 'all' means show all sections
1308  * @return int Course section to display, 0 means all
1309  */
1310 function course_set_display($courseid, $display) {
1311     global $USER, $DB;
1313     if ($display === 'all' or empty($display)) {
1314         $display = 0;
1315     }
1317     if (!isloggedin() or isguestuser()) {
1318         //do not store settings in db for guests
1319         return 0;
1320     }
1322     if ($display == 0) {
1323         //show all, do not store anything in database
1324         $DB->delete_records('course_display', array('userid' => $USER->id, 'course' => $courseid));
1326     } else {
1327         if ($DB->record_exists('course_display', array('userid' => $USER->id, 'course' => $courseid))) {
1328             $DB->set_field('course_display', 'display', $display, array('userid' => $USER->id, 'course' => $courseid));
1329         } else {
1330             $record = new stdClass();
1331             $record->userid = $USER->id;
1332             $record->course = $courseid;
1333             $record->display = $display;
1334             $DB->insert_record('course_display', $record);
1335         }
1336     }
1338     //use display cache for one course only - we need to keep session small
1339     $USER->display = array($courseid => $display);
1341     return $display;
1344 /**
1345  * Set highlighted section. Only one section can be highlighted at the time.
1346  *
1347  * @param int $courseid course id
1348  * @param int $marker highlight section with this number, 0 means remove higlightin
1349  * @return void
1350  */
1351 function course_set_marker($courseid, $marker) {
1352     global $DB;
1353     $DB->set_field("course", "marker", $marker, array('id' => $courseid));
1356 /**
1357  * For a given course section, marks it visible or hidden,
1358  * and does the same for every activity in that section
1359  *
1360  * @param int $courseid course id
1361  * @param int $sectionnumber The section number to adjust
1362  * @param int $visibility The new visibility
1363  * @return array A list of resources which were hidden in the section
1364  */
1365 function set_section_visible($courseid, $sectionnumber, $visibility) {
1366     global $DB;
1368     $resourcestotoggle = array();
1369     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1370         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1371         if (!empty($section->sequence)) {
1372             $modules = explode(",", $section->sequence);
1373             foreach ($modules as $moduleid) {
1374                 set_coursemodule_visible($moduleid, $visibility, true);
1375             }
1376         }
1377         rebuild_course_cache($courseid);
1379         // Determine which modules are visible for AJAX update
1380         if (!empty($modules)) {
1381             list($insql, $params) = $DB->get_in_or_equal($modules);
1382             $select = 'id ' . $insql . ' AND visible = ?';
1383             array_push($params, $visibility);
1384             if (!$visibility) {
1385                 $select .= ' AND visibleold = 1';
1386             }
1387             $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1388         }
1389     }
1390     return $resourcestotoggle;
1393 /**
1394  * Obtains shared data that is used in print_section when displaying a
1395  * course-module entry.
1396  *
1397  * Calls format_text or format_string as appropriate, and obtains the correct icon.
1398  *
1399  * This data is also used in other areas of the code.
1400  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
1401  * @param object $course Moodle course object
1402  * @return array An array with the following values in this order:
1403  *   $content (optional extra content for after link),
1404  *   $instancename (text of link)
1405  */
1406 function get_print_section_cm_text(cm_info $cm, $course) {
1407     global $OUTPUT;
1409     // Get content from modinfo if specified. Content displays either
1410     // in addition to the standard link (below), or replaces it if
1411     // the link is turned off by setting ->url to null.
1412     if (($content = $cm->get_content()) !== '') {
1413         // Improve filter performance by preloading filter setttings for all
1414         // activities on the course (this does nothing if called multiple
1415         // times)
1416         filter_preload_activities($cm->get_modinfo());
1418         // Get module context
1419         $modulecontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1420         $labelformatoptions = new stdClass();
1421         $labelformatoptions->noclean = true;
1422         $labelformatoptions->overflowdiv = true;
1423         $labelformatoptions->context = $modulecontext;
1424         $content = format_text($content, FORMAT_HTML, $labelformatoptions);
1425     } else {
1426         $content = '';
1427     }
1429     // Get course context
1430     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1431     $stringoptions = new stdClass;
1432     $stringoptions->context = $coursecontext;
1433     $instancename = format_string($cm->name, true,  $stringoptions);
1434     return array($content, $instancename);
1437 /**
1438  * Prints a section full of activity modules
1439  */
1440 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1441     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1443     static $initialised;
1445     static $groupbuttons;
1446     static $groupbuttonslink;
1447     static $isediting;
1448     static $ismoving;
1449     static $strmovehere;
1450     static $strmovefull;
1451     static $strunreadpostsone;
1452     static $groupings;
1453     static $modulenames;
1455     if (!isset($initialised)) {
1456         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1457         $groupbuttonslink = (!$course->groupmodeforce);
1458         $isediting        = $PAGE->user_is_editing();
1459         $ismoving         = $isediting && ismoving($course->id);
1460         if ($ismoving) {
1461             $strmovehere  = get_string("movehere");
1462             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1463         }
1464         $modulenames      = array();
1465         $initialised = true;
1466     }
1468     $modinfo = get_fast_modinfo($course);
1469     $completioninfo = new completion_info($course);
1471     //Accessibility: replace table with list <ul>, but don't output empty list.
1472     if (!empty($section->sequence)) {
1474         // Fix bug #5027, don't want style=\"width:$width\".
1475         echo "<ul class=\"section img-text\">\n";
1476         $sectionmods = explode(",", $section->sequence);
1478         foreach ($sectionmods as $modnumber) {
1479             if (empty($mods[$modnumber])) {
1480                 continue;
1481             }
1483             /**
1484              * @var cm_info
1485              */
1486             $mod = $mods[$modnumber];
1488             if ($ismoving and $mod->id == $USER->activitycopy) {
1489                 // do not display moving mod
1490                 continue;
1491             }
1493             if (isset($modinfo->cms[$modnumber])) {
1494                 // We can continue (because it will not be displayed at all)
1495                 // if:
1496                 // 1) The activity is not visible to users
1497                 // and
1498                 // 2a) The 'showavailability' option is not set (if that is set,
1499                 //     we need to display the activity so we can show
1500                 //     availability info)
1501                 // or
1502                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1503                 //     hidden in a way that leaves no info, such as using the
1504                 //     eye icon.
1505                 if (!$modinfo->cms[$modnumber]->uservisible &&
1506                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1507                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1508                     // visibility shortcut
1509                     continue;
1510                 }
1511             } else {
1512                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1513                     // module not installed
1514                     continue;
1515                 }
1516                 if (!coursemodule_visible_for_user($mod) &&
1517                     empty($mod->showavailability)) {
1518                     // full visibility check
1519                     continue;
1520                 }
1521             }
1523             if (!isset($modulenames[$mod->modname])) {
1524                 $modulenames[$mod->modname] = get_string('modulename', $mod->modname);
1525             }
1526             $modulename = $modulenames[$mod->modname];
1528             // In some cases the activity is visible to user, but it is
1529             // dimmed. This is done if viewhiddenactivities is true and if:
1530             // 1. the activity is not visible, or
1531             // 2. the activity has dates set which do not include current, or
1532             // 3. the activity has any other conditions set (regardless of whether
1533             //    current user meets them)
1534             $canviewhidden = has_capability(
1535                 'moodle/course:viewhiddenactivities',
1536                 get_context_instance(CONTEXT_MODULE, $mod->id));
1537             $accessiblebutdim = false;
1538             if ($canviewhidden) {
1539                 $accessiblebutdim = !$mod->visible;
1540                 if (!empty($CFG->enableavailability)) {
1541                     $accessiblebutdim = $accessiblebutdim ||
1542                         $mod->availablefrom > time() ||
1543                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1544                         count($mod->conditionsgrade) > 0 ||
1545                         count($mod->conditionscompletion) > 0;
1546                 }
1547             }
1549             $liclasses = array();
1550             $liclasses[] = 'activity';
1551             $liclasses[] = $mod->modname;
1552             $liclasses[] = 'modtype_'.$mod->modname;
1553             $extraclasses = $mod->get_extra_classes();
1554             if ($extraclasses) {
1555                 $liclasses = array_merge($liclasses, explode(' ', $extraclasses));
1556             }
1557             echo html_writer::start_tag('li', array('class'=>join(' ', $liclasses), 'id'=>'module-'.$modnumber));
1558             if ($ismoving) {
1559                 echo '<a title="'.$strmovefull.'"'.
1560                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1561                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1562                      ' alt="'.$strmovehere.'" /></a><br />
1563                      ';
1564             }
1566             $classes = array('mod-indent');
1567             if (!empty($mod->indent)) {
1568                 $classes[] = 'mod-indent-'.$mod->indent;
1569                 if ($mod->indent > 15) {
1570                     $classes[] = 'mod-indent-huge';
1571                 }
1572             }
1573             echo html_writer::start_tag('div', array('class'=>join(' ', $classes)));
1575             // Get data about this course-module
1576             list($content, $instancename) =
1577                     get_print_section_cm_text($modinfo->cms[$modnumber], $course);
1579             //Accessibility: for files get description via icon, this is very ugly hack!
1580             $altname = '';
1581             $altname = $mod->modfullname;
1582             if (!empty($customicon)) {
1583                 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1584                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1585                     $mimetype = mimeinfo_from_icon('type', $customicon);
1586                     $altname = get_mimetype_description($mimetype);
1587                 }
1588             }
1589             // Avoid unnecessary duplication: if e.g. a forum name already
1590             // includes the word forum (or Forum, etc) then it is unhelpful
1591             // to include that in the accessible description that is added.
1592             if (false !== strpos(textlib::strtolower($instancename),
1593                     textlib::strtolower($altname))) {
1594                 $altname = '';
1595             }
1596             // File type after name, for alphabetic lists (screen reader).
1597             if ($altname) {
1598                 $altname = get_accesshide(' '.$altname);
1599             }
1601             // We may be displaying this just in order to show information
1602             // about visibility, without the actual link
1603             $contentpart = '';
1604             if ($mod->uservisible) {
1605                 // Nope - in this case the link is fully working for user
1606                 $linkclasses = '';
1607                 $textclasses = '';
1608                 if ($accessiblebutdim) {
1609                     $linkclasses .= ' dimmed';
1610                     $textclasses .= ' dimmed_text';
1611                     $accesstext = '<span class="accesshide">'.
1612                         get_string('hiddenfromstudents').': </span>';
1613                 } else {
1614                     $accesstext = '';
1615                 }
1616                 if ($linkclasses) {
1617                     $linkcss = 'class="' . trim($linkclasses) . '" ';
1618                 } else {
1619                     $linkcss = '';
1620                 }
1621                 if ($textclasses) {
1622                     $textcss = 'class="' . trim($textclasses) . '" ';
1623                 } else {
1624                     $textcss = '';
1625                 }
1627                 // Get on-click attribute value if specified
1628                 $onclick = $mod->get_on_click();
1629                 if ($onclick) {
1630                     $onclick = ' onclick="' . $onclick . '"';
1631                 }
1633                 if ($url = $mod->get_url()) {
1634                     // Display link itself
1635                     echo '<a ' . $linkcss . $mod->extra . $onclick .
1636                             ' href="' . $url . '"><img src="' . $mod->get_icon_url() .
1637                             '" class="activityicon" alt="' .
1638                             $modulename . '" /> ' .
1639                             $accesstext . '<span class="instancename">' .
1640                             $instancename . $altname . '</span></a>';
1642                     // If specified, display extra content after link
1643                     if ($content) {
1644                         $contentpart = '<div class="' . trim('contentafterlink' . $textclasses) .
1645                                 '">' . $content . '</div>';
1646                     }
1647                 } else {
1648                     // No link, so display only content
1649                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1650                             $accesstext . $content . '</div>';
1651                 }
1653                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1654                     if (!isset($groupings)) {
1655                         $groupings = groups_get_all_groupings($course->id);
1656                     }
1657                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1658                 }
1659             } else {
1660                 $textclasses = $extraclasses;
1661                 $textclasses .= ' dimmed_text';
1662                 if ($textclasses) {
1663                     $textcss = 'class="' . trim($textclasses) . '" ';
1664                 } else {
1665                     $textcss = '';
1666                 }
1667                 $accesstext = '<span class="accesshide">' .
1668                         get_string('notavailableyet', 'condition') .
1669                         ': </span>';
1671                 if ($url = $mod->get_url()) {
1672                     // Display greyed-out text of link
1673                     echo '<div ' . $textcss . $mod->extra .
1674                             ' >' . '<img src="' . $mod->get_icon_url() .
1675                             '" class="activityicon" alt="' .
1676                             $modulename .
1677                             '" /> <span>'. $instancename . $altname .
1678                             '</span></div>';
1680                     // Do not display content after link when it is greyed out like this.
1681                 } else {
1682                     // No link, so display only content (also greyed)
1683                     $contentpart = '<div ' . $textcss . $mod->extra . '>' .
1684                             $accesstext . $content . '</div>';
1685                 }
1686             }
1688             // Module can put text after the link (e.g. forum unread)
1689             echo $mod->get_after_link();
1691             // If there is content but NO link (eg label), then display the
1692             // content here (BEFORE any icons). In this case cons must be
1693             // displayed after the content so that it makes more sense visually
1694             // and for accessibility reasons, e.g. if you have a one-line label
1695             // it should work similarly (at least in terms of ordering) to an
1696             // activity.
1697             if (empty($url)) {
1698                 echo $contentpart;
1699             }
1701             if ($isediting) {
1702                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1703                     if (! $mod->groupmodelink = $groupbuttonslink) {
1704                         $mod->groupmode = $course->groupmode;
1705                     }
1707                 } else {
1708                     $mod->groupmode = false;
1709                 }
1710                 echo '&nbsp;&nbsp;';
1711                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1712                 echo $mod->get_after_edit_icons();
1713             }
1715             // Completion
1716             $completion = $hidecompletion
1717                 ? COMPLETION_TRACKING_NONE
1718                 : $completioninfo->is_enabled($mod);
1719             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1720                 !isguestuser() && $mod->uservisible) {
1721                 $completiondata = $completioninfo->get_data($mod,true);
1722                 $completionicon = '';
1723                 if ($isediting) {
1724                     switch ($completion) {
1725                         case COMPLETION_TRACKING_MANUAL :
1726                             $completionicon = 'manual-enabled'; break;
1727                         case COMPLETION_TRACKING_AUTOMATIC :
1728                             $completionicon = 'auto-enabled'; break;
1729                         default: // wtf
1730                     }
1731                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1732                     switch($completiondata->completionstate) {
1733                         case COMPLETION_INCOMPLETE:
1734                             $completionicon = 'manual-n'; break;
1735                         case COMPLETION_COMPLETE:
1736                             $completionicon = 'manual-y'; break;
1737                     }
1738                 } else { // Automatic
1739                     switch($completiondata->completionstate) {
1740                         case COMPLETION_INCOMPLETE:
1741                             $completionicon = 'auto-n'; break;
1742                         case COMPLETION_COMPLETE:
1743                             $completionicon = 'auto-y'; break;
1744                         case COMPLETION_COMPLETE_PASS:
1745                             $completionicon = 'auto-pass'; break;
1746                         case COMPLETION_COMPLETE_FAIL:
1747                             $completionicon = 'auto-fail'; break;
1748                     }
1749                 }
1750                 if ($completionicon) {
1751                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1752                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion', $mod->name));
1753                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1754                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion', $mod->name));
1755                         $newstate =
1756                             $completiondata->completionstate==COMPLETION_COMPLETE
1757                             ? COMPLETION_INCOMPLETE
1758                             : COMPLETION_COMPLETE;
1759                         // In manual mode the icon is a toggle form...
1761                         // If this completion state is used by the
1762                         // conditional activities system, we need to turn
1763                         // off the JS.
1764                         if (!empty($CFG->enableavailability) &&
1765                             condition_info::completion_value_used_as_condition($course, $mod)) {
1766                             $extraclass = ' preventjs';
1767                         } else {
1768                             $extraclass = '';
1769                         }
1770                         echo "
1771 <form class='togglecompletion$extraclass' method='post' action='".$CFG->wwwroot."/course/togglecompletion.php'><div>
1772 <input type='hidden' name='id' value='{$mod->id}' />
1773 <input type='hidden' name='modulename' value='".s($mod->name)."' />
1774 <input type='hidden' name='sesskey' value='".sesskey()."' />
1775 <input type='hidden' name='completionstate' value='$newstate' />
1776 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1777 </div></form>";
1778                     } else {
1779                         // In auto mode, or when editing, the icon is just an image
1780                         echo "<span class='autocompletion'>";
1781                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1782                     }
1783                 }
1784             }
1786             // If there is content AND a link, then display the content here
1787             // (AFTER any icons). Otherwise it was displayed before
1788             if (!empty($url)) {
1789                 echo $contentpart;
1790             }
1792             // Show availability information (for someone who isn't allowed to
1793             // see the activity itself, or for staff)
1794             if (!$mod->uservisible) {
1795                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1796             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1797                 $ci = new condition_info($mod);
1798                 $fullinfo = $ci->get_full_information();
1799                 if($fullinfo) {
1800                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1801                         ? 'userrestriction_visible'
1802                         : 'userrestriction_hidden','condition',
1803                         $fullinfo).'</div>';
1804                 }
1805             }
1807             echo html_writer::end_tag('div');
1808             echo html_writer::end_tag('li')."\n";
1809         }
1811     } elseif ($ismoving) {
1812         echo "<ul class=\"section\">\n";
1813     }
1815     if ($ismoving) {
1816         echo '<li><a title="'.$strmovefull.'"'.
1817              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1818              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1819              ' alt="'.$strmovehere.'" /></a></li>
1820              ';
1821     }
1822     if (!empty($section->sequence) || $ismoving) {
1823         echo "</ul><!--class='section'-->\n\n";
1824     }
1827 /**
1828  * Prints the menus to add activities and resources.
1829  */
1830 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1831     global $CFG, $OUTPUT;
1833     // check to see if user can add menus
1834     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1835         return false;
1836     }
1838     // Retrieve all modules with associated metadata
1839     $modules = get_module_metadata($course, $modnames);
1841     // We'll sort resources and activities into two lists
1842     $resources = array();
1843     $activities = array();
1845     // We need to add the section section to the link for each module
1846     $sectionlink = '&section=' . $section;
1848     foreach ($modules as $module) {
1849         if (isset($module->types)) {
1850             // This module has a subtype
1851             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1852             $subtypes = array();
1853             foreach ($module->types as $subtype) {
1854                 $subtypes[$subtype->link . $sectionlink] = $subtype->title;
1855             }
1857             // Sort module subtypes into the list
1858             if (!empty($module->title)) {
1859                 // This grouping has a name
1860                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1861                     $resources[] = array($module->title=>$subtypes);
1862                 } else {
1863                     $activities[] = array($module->title=>$subtypes);
1864                 }
1865             } else {
1866                 // This grouping does not have a name
1867                 if ($module->archetype == MOD_CLASS_RESOURCE) {
1868                     $resources = array_merge($resources, $subtypes);
1869                 } else {
1870                     $activities = array_merge($activities, $subtypes);
1871                 }
1872             }
1873         } else {
1874             // This module has no subtypes
1875             if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
1876                 $resources[$module->link . $sectionlink] = $module->title;
1877             } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
1878                 // System modules cannot be added by user, do not add to dropdown
1879             } else {
1880                 $activities[$module->link . $sectionlink] = $module->title;
1881             }
1882         }
1883     }
1885     $straddactivity = get_string('addactivity');
1886     $straddresource = get_string('addresource');
1888     $output  = '<div class="section_add_menus">';
1890     if (!$vertical) {
1891         $output .= '<div class="horizontal">';
1892     }
1894     if (!empty($resources)) {
1895         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1896         $select->set_help_icon('resources');
1897         $output .= $OUTPUT->render($select);
1898     }
1900     if (!empty($activities)) {
1901         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1902         $select->set_help_icon('activities');
1903         $output .= $OUTPUT->render($select);
1904     }
1906     if (!$vertical) {
1907         $output .= '</div>';
1908     }
1910     $output .= '</div>';
1912     if ($return) {
1913         return $output;
1914     } else {
1915         echo $output;
1916     }
1919 /**
1920  * Retrieve all metadata for the requested modules
1921  *
1922  * @param object $course The Course
1923  * @param array $modnames An array containing the list of modules and their
1924  * names
1925  * @return array A list of stdClass objects containing metadata about each
1926  * module
1927  */
1928 function get_module_metadata($course, $modnames) {
1929     global $CFG, $OUTPUT;
1931     // get_module_metadata will be called once per section on the page and courses may show
1932     // different modules to one another
1933     static $modlist = array();
1934     if (!isset($modlist[$course->id])) {
1935         $modlist[$course->id] = array();
1936     }
1938     $return = array();
1939     $urlbase = "/course/mod.php?id=$course->id&sesskey=".sesskey().'&add=';
1940     foreach($modnames as $modname => $modnamestr) {
1941         if (!course_allowed_module($course, $modname)) {
1942             continue;
1943         }
1944         if (isset($modlist[$modname])) {
1945             // This module is already cached
1946             $return[$modname] = $modlist[$course->id][$modname];
1947             continue;
1948         }
1950         // Include the module lib
1951         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1952         if (!file_exists($libfile)) {
1953             continue;
1954         }
1955         include_once($libfile);
1957         // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1958         $gettypesfunc =  $modname.'_get_types';
1959         if (function_exists($gettypesfunc)) {
1960             if ($types = $gettypesfunc()) {
1961                 $group = new stdClass();
1962                 $group->name = $modname;
1963                 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1964                 foreach($types as $type) {
1965                     if ($type->typestr === '--') {
1966                         continue;
1967                     }
1968                     if (strpos($type->typestr, '--') === 0) {
1969                         $group->title = str_replace('--', '', $type->typestr);
1970                         continue;
1971                     }
1972                     // Set the Sub Type metadata
1973                     $subtype = new stdClass();
1974                     $subtype->title = $type->typestr;
1975                     $subtype->type = str_replace('&amp;', '&', $type->type);
1976                     $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1977                     $subtype->archetype = $type->modclass;
1979                     // The group archetype should match the subtype archetypes and all subtypes
1980                     // should have the same archetype
1981                     $group->archetype = $subtype->archetype;
1983                     if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1984                         $subtype->help = get_string('help' . $subtype->name, $modname);
1985                     }
1986                     $subtype->link = $urlbase . $subtype->type;
1987                     $group->types[] = $subtype;
1988                 }
1989                 $modlist[$course->id][$modname] = $group;
1990             }
1991         } else {
1992             $module = new stdClass();
1993             $module->title = get_string('modulename', $modname);
1994             $module->name = $modname;
1995             $module->link = $urlbase . $modname;
1996             $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
1997             if (get_string_manager()->string_exists('modulename_help', $modname)) {
1998                 $module->help = get_string('modulename_help', $modname);
1999             }
2000             $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2001             $modlist[$course->id][$modname] = $module;
2002         }
2003         $return[$modname] = $modlist[$course->id][$modname];
2004     }
2006     return $return;
2009 /**
2010  * Return the course category context for the category with id $categoryid, except
2011  * that if $categoryid is 0, return the system context.
2012  *
2013  * @param integer $categoryid a category id or 0.
2014  * @return object the corresponding context
2015  */
2016 function get_category_or_system_context($categoryid) {
2017     if ($categoryid) {
2018         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
2019     } else {
2020         return get_context_instance(CONTEXT_SYSTEM);
2021     }
2024 /**
2025  * Gets the child categories of a given courses category. Uses a static cache
2026  * to make repeat calls efficient.
2027  *
2028  * @param int $parentid the id of a course category.
2029  * @return array all the child course categories.
2030  */
2031 function get_child_categories($parentid) {
2032     static $allcategories = null;
2034     // only fill in this variable the first time
2035     if (null == $allcategories) {
2036         $allcategories = array();
2038         $categories = get_categories();
2039         foreach ($categories as $category) {
2040             if (empty($allcategories[$category->parent])) {
2041                 $allcategories[$category->parent] = array();
2042             }
2043             $allcategories[$category->parent][] = $category;
2044         }
2045     }
2047     if (empty($allcategories[$parentid])) {
2048         return array();
2049     } else {
2050         return $allcategories[$parentid];
2051     }
2054 /**
2055  * This function recursively travels the categories, building up a nice list
2056  * for display. It also makes an array that list all the parents for each
2057  * category.
2058  *
2059  * For example, if you have a tree of categories like:
2060  *   Miscellaneous (id = 1)
2061  *      Subcategory (id = 2)
2062  *         Sub-subcategory (id = 4)
2063  *   Other category (id = 3)
2064  * Then after calling this function you will have
2065  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2066  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2067  *      3 => 'Other category');
2068  * $parents = array(2 => array(1), 4 => array(1, 2));
2069  *
2070  * If you specify $requiredcapability, then only categories where the current
2071  * user has that capability will be added to $list, although all categories
2072  * will still be added to $parents, and if you only have $requiredcapability
2073  * in a child category, not the parent, then the child catgegory will still be
2074  * included.
2075  *
2076  * If you specify the option $excluded, then that category, and all its children,
2077  * are omitted from the tree. This is useful when you are doing something like
2078  * moving categories, where you do not want to allow people to move a category
2079  * to be the child of itself.
2080  *
2081  * @param array $list For output, accumulates an array categoryid => full category path name
2082  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2083  * @param string/array $requiredcapability if given, only categories where the current
2084  *      user has this capability will be added to $list. Can also be an array of capabilities,
2085  *      in which case they are all required.
2086  * @param integer $excludeid Omit this category and its children from the lists built.
2087  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
2088  * @param string $path For internal use, as part of recursive calls.
2089  */
2090 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2091         $excludeid = 0, $category = NULL, $path = "") {
2093     // initialize the arrays if needed
2094     if (!is_array($list)) {
2095         $list = array();
2096     }
2097     if (!is_array($parents)) {
2098         $parents = array();
2099     }
2101     if (empty($category)) {
2102         // Start at the top level.
2103         $category = new stdClass;
2104         $category->id = 0;
2105     } else {
2106         // This is the excluded category, don't include it.
2107         if ($excludeid > 0 && $excludeid == $category->id) {
2108             return;
2109         }
2111         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2112         $categoryname = format_string($category->name, true, array('context' => $context));
2114         // Update $path.
2115         if ($path) {
2116             $path = $path.' / '.$categoryname;
2117         } else {
2118             $path = $categoryname;
2119         }
2121         // Add this category to $list, if the permissions check out.
2122         if (empty($requiredcapability)) {
2123             $list[$category->id] = $path;
2125         } else {
2126             $requiredcapability = (array)$requiredcapability;
2127             if (has_all_capabilities($requiredcapability, $context)) {
2128                 $list[$category->id] = $path;
2129             }
2130         }
2131     }
2133     // Add all the children recursively, while updating the parents array.
2134     if ($categories = get_child_categories($category->id)) {
2135         foreach ($categories as $cat) {
2136             if (!empty($category->id)) {
2137                 if (isset($parents[$category->id])) {
2138                     $parents[$cat->id]   = $parents[$category->id];
2139                 }
2140                 $parents[$cat->id][] = $category->id;
2141             }
2142             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
2143         }
2144     }
2147 /**
2148  * This function generates a structured array of courses and categories.
2149  *
2150  * The depth of categories is limited by $CFG->maxcategorydepth however there
2151  * is no limit on the number of courses!
2152  *
2153  * Suitable for use with the course renderers course_category_tree method:
2154  * $renderer = $PAGE->get_renderer('core','course');
2155  * echo $renderer->course_category_tree(get_course_category_tree());
2156  *
2157  * @global moodle_database $DB
2158  * @param int $id
2159  * @param int $depth
2160  */
2161 function get_course_category_tree($id = 0, $depth = 0) {
2162     global $DB, $CFG;
2163     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
2164     $categories = get_child_categories($id);
2165     $categoryids = array();
2166     foreach ($categories as $key => &$category) {
2167         if (!$category->visible && !$viewhiddencats) {
2168             unset($categories[$key]);
2169             continue;
2170         }
2171         $categoryids[$category->id] = $category;
2172         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2173             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
2174             foreach ($subcategories as $subid=>$subcat) {
2175                 $categoryids[$subid] = $subcat;
2176             }
2177             $category->courses = array();
2178         }
2179     }
2181     if ($depth > 0) {
2182         // This is a recursive call so return the required array
2183         return array($categories, $categoryids);
2184     }
2186     // The depth is 0 this function has just been called so we can finish it off
2188     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2189     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2190     $sql = "SELECT
2191             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
2192             $ccselect
2193             FROM {course} c
2194             $ccjoin
2195             WHERE c.category $catsql ORDER BY c.sortorder ASC";
2196     if ($courses = $DB->get_records_sql($sql, $catparams)) {
2197         // loop throught them
2198         foreach ($courses as $course) {
2199             if ($course->id == SITEID) {
2200                 continue;
2201             }
2202             context_instance_preload($course);
2203             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2204                 $categoryids[$course->category]->courses[$course->id] = $course;
2205             }
2206         }
2207     }
2208     return $categories;
2211 /**
2212  * Recursive function to print out all the categories in a nice format
2213  * with or without courses included
2214  */
2215 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
2216     global $CFG;
2218     // maxcategorydepth == 0 meant no limit
2219     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2220         return;
2221     }
2223     if (!$displaylist) {
2224         make_categories_list($displaylist, $parentslist);
2225     }
2227     if ($category) {
2228         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2229             print_category_info($category, $depth, $showcourses);
2230         } else {
2231             return;  // Don't bother printing children of invisible categories
2232         }
2234     } else {
2235         $category = new stdClass();
2236         $category->id = "0";
2237     }
2239     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2240         $countcats = count($categories);
2241         $count = 0;
2242         $first = true;
2243         $last = false;
2244         foreach ($categories as $cat) {
2245             $count++;
2246             if ($count == $countcats) {
2247                 $last = true;
2248             }
2249             $up = $first ? false : true;
2250             $down = $last ? false : true;
2251             $first = false;
2253             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2254         }
2255     }
2258 /**
2259  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
2260  */
2261 function make_categories_options() {
2262     make_categories_list($cats,$parents);
2263     foreach ($cats as $key => $value) {
2264         if (array_key_exists($key,$parents)) {
2265             if ($indent = count($parents[$key])) {
2266                 for ($i = 0; $i < $indent; $i++) {
2267                     $cats[$key] = '&nbsp;'.$cats[$key];
2268                 }
2269             }
2270         }
2271     }
2272     return $cats;
2275 /**
2276  * Gets the name of a course to be displayed when showing a list of courses.
2277  * By default this is just $course->fullname but user can configure it. The
2278  * result of this function should be passed through print_string.
2279  * @param object $course Moodle course object
2280  * @return string Display name of course (either fullname or short + fullname)
2281  */
2282 function get_course_display_name_for_list($course) {
2283     global $CFG;
2284     if (!empty($CFG->courselistshortnames)) {
2285         return $course->shortname . ' ' .$course->fullname;
2286     } else {
2287         return $course->fullname;
2288     }
2291 /**
2292  * Prints the category info in indented fashion
2293  * This function is only used by print_whole_category_list() above
2294  */
2295 function print_category_info($category, $depth=0, $showcourses = false) {
2296     global $CFG, $DB, $OUTPUT;
2298     $strsummary = get_string('summary');
2300     $catlinkcss = null;
2301     if (!$category->visible) {
2302         $catlinkcss = array('class'=>'dimmed');
2303     }
2304     static $coursecount = null;
2305     if (null === $coursecount) {
2306         // only need to check this once
2307         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2308     }
2310     if ($showcourses and $coursecount) {
2311         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2312     } else {
2313         $catimage = "&nbsp;";
2314     }
2316     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2317     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
2318     $fullname = format_string($category->name, true, array('context' => $context));
2320     if ($showcourses and $coursecount) {
2321         echo '<div class="categorylist clearfix">';
2322         $cat = '';
2323         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2324         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2325         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2327         $html = '';
2328         if ($depth > 0) {
2329             for ($i=0; $i< $depth; $i++) {
2330                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2331                 $cat = '';
2332             }
2333         } else {
2334             $html = $cat;
2335         }
2336         echo html_writer::tag('div', $html, array('class'=>'category'));
2337         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2339         // does the depth exceed maxcategorydepth
2340         // maxcategorydepth == 0 or unset meant no limit
2341         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2342         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2343             foreach ($courses as $course) {
2344                 $linkcss = null;
2345                 if (!$course->visible) {
2346                     $linkcss = array('class'=>'dimmed');
2347                 }
2349                 $coursename = get_course_display_name_for_list($course);
2350                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2352                 // print enrol info
2353                 $courseicon = '';
2354                 if ($icons = enrol_get_course_info_icons($course)) {
2355                     foreach ($icons as $pix_icon) {
2356                         $courseicon = $OUTPUT->render($pix_icon).' ';
2357                     }
2358                 }
2360                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2362                 if ($course->summary) {
2363                     $link = new moodle_url('/course/info.php?id='.$course->id);
2364                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2365                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2366                         array('title'=>$strsummary));
2368                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2369                 }
2371                 $html = '';
2372                 for ($i=0; $i <= $depth; $i++) {
2373                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2374                     $coursecontent = '';
2375                 }
2376                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2377             }
2378         }
2379         echo '</div>';
2380     } else {
2381         echo '<div class="categorylist">';
2382         $html = '';
2383         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2384         if (count($courses) > 0) {
2385             $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2386         }
2388         if ($depth > 0) {
2389             for ($i=0; $i< $depth; $i++) {
2390                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2391                 $cat = '';
2392             }
2393         } else {
2394             $html = $cat;
2395         }
2397         echo html_writer::tag('div', $html, array('class'=>'category'));
2398         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2399         echo '</div>';
2400     }
2403 /**
2404  * Print the buttons relating to course requests.
2405  *
2406  * @param object $systemcontext the system context.
2407  */
2408 function print_course_request_buttons($systemcontext) {
2409     global $CFG, $DB, $OUTPUT;
2410     if (empty($CFG->enablecourserequests)) {
2411         return;
2412     }
2413     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2414     /// Print a button to request a new course
2415         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2416     }
2417     /// Print a button to manage pending requests
2418     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2419         $disabled = !$DB->record_exists('course_request', array());
2420         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2421     }
2424 /**
2425  * Does the user have permission to edit things in this category?
2426  *
2427  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2428  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2429  */
2430 function can_edit_in_category($categoryid = 0) {
2431     $context = get_category_or_system_context($categoryid);
2432     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2435 /**
2436  * Prints the turn editing on/off button on course/index.php or course/category.php.
2437  *
2438  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2439  * @return string HTML of the editing button, or empty string, if this user is not allowed
2440  *      to see it.
2441  */
2442 function update_category_button($categoryid = 0) {
2443     global $CFG, $PAGE, $OUTPUT;
2445     // Check permissions.
2446     if (!can_edit_in_category($categoryid)) {
2447         return '';
2448     }
2450     // Work out the appropriate action.
2451     if ($PAGE->user_is_editing()) {
2452         $label = get_string('turneditingoff');
2453         $edit = 'off';
2454     } else {
2455         $label = get_string('turneditingon');
2456         $edit = 'on';
2457     }
2459     // Generate the button HTML.
2460     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2461     if ($categoryid) {
2462         $options['id'] = $categoryid;
2463         $page = 'category.php';
2464     } else {
2465         $page = 'index.php';
2466     }
2467     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2470 /**
2471  * Category is 0 (for all courses) or an object
2472  */
2473 function print_courses($category) {
2474     global $CFG, $OUTPUT;
2476     if (!is_object($category) && $category==0) {
2477         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2478         if (is_array($categories) && count($categories) == 1) {
2479             $category   = array_shift($categories);
2480             $courses    = get_courses_wmanagers($category->id,
2481                                                 'c.sortorder ASC',
2482                                                 array('summary','summaryformat'));
2483         } else {
2484             $courses    = get_courses_wmanagers('all',
2485                                                 'c.sortorder ASC',
2486                                                 array('summary','summaryformat'));
2487         }
2488         unset($categories);
2489     } else {
2490         $courses    = get_courses_wmanagers($category->id,
2491                                             'c.sortorder ASC',
2492                                             array('summary','summaryformat'));
2493     }
2495     if ($courses) {
2496         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2497         foreach ($courses as $course) {
2498             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2499             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2500                 echo html_writer::start_tag('li');
2501                 print_course($course);
2502                 echo html_writer::end_tag('li');
2503             }
2504         }
2505         echo html_writer::end_tag('ul');
2506     } else {
2507         echo $OUTPUT->heading(get_string("nocoursesyet"));
2508         $context = get_context_instance(CONTEXT_SYSTEM);
2509         if (has_capability('moodle/course:create', $context)) {
2510             $options = array();
2511             if (!empty($category->id)) {
2512                 $options['category'] = $category->id;
2513             } else {
2514                 $options['category'] = $CFG->defaultrequestcategory;
2515             }
2516             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2517             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2518             echo html_writer::end_tag('div');
2519         }
2520     }
2523 /**
2524  * Print a description of a course, suitable for browsing in a list.
2525  *
2526  * @param object $course the course object.
2527  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2528  */
2529 function print_course($course, $highlightterms = '') {
2530     global $CFG, $USER, $DB, $OUTPUT;
2532     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2534     // Rewrite file URLs so that they are correct
2535     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2537     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2538     echo html_writer::start_tag('div', array('class'=>'info'));
2539     echo html_writer::start_tag('h3', array('class'=>'name'));
2541     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2543     $coursename = get_course_display_name_for_list($course);
2544     $linktext = highlight($highlightterms, format_string($coursename));
2545     $linkparams = array('title'=>get_string('entercourse'));
2546     if (empty($course->visible)) {
2547         $linkparams['class'] = 'dimmed';
2548     }
2549     echo html_writer::link($linkhref, $linktext, $linkparams);
2550     echo html_writer::end_tag('h3');
2552     /// first find all roles that are supposed to be displayed
2553     if (!empty($CFG->coursecontact)) {
2554         $managerroles = explode(',', $CFG->coursecontact);
2555         $namesarray = array();
2556         $rusers = array();
2558         if (!isset($course->managers)) {
2559             $rusers = get_role_users($managerroles, $context, true,
2560                 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname,
2561                  r.name AS rolename, r.sortorder, r.id AS roleid',
2562                 'r.sortorder ASC, u.lastname ASC');
2563         } else {
2564             //  use the managers array if we have it for perf reasosn
2565             //  populate the datastructure like output of get_role_users();
2566             foreach ($course->managers as $manager) {
2567                 $u = new stdClass();
2568                 $u = $manager->user;
2569                 $u->roleid = $manager->roleid;
2570                 $u->rolename = $manager->rolename;
2572                 $rusers[] = $u;
2573             }
2574         }
2576         /// Rename some of the role names if needed
2577         if (isset($context)) {
2578             $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2579         }
2581         $namesarray = array();
2582         $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2583         foreach ($rusers as $ra) {
2584             if (isset($namesarray[$ra->id])) {
2585                 //  only display a user once with the higest sortorder role
2586                 continue;
2587             }
2589             if (isset($aliasnames[$ra->roleid])) {
2590                 $ra->rolename = $aliasnames[$ra->roleid]->name;
2591             }
2593             $fullname = fullname($ra, $canviewfullnames);
2594             $namesarray[$ra->id] = format_string($ra->rolename).': '.
2595                 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
2596         }
2598         if (!empty($namesarray)) {
2599             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2600             foreach ($namesarray as $name) {
2601                 echo html_writer::tag('li', $name);
2602             }
2603             echo html_writer::end_tag('ul');
2604         }
2605     }
2606     echo html_writer::end_tag('div'); // End of info div
2608     echo html_writer::start_tag('div', array('class'=>'summary'));
2609     $options = new stdClass();
2610     $options->noclean = true;
2611     $options->para = false;
2612     $options->overflowdiv = true;
2613     if (!isset($course->summaryformat)) {
2614         $course->summaryformat = FORMAT_MOODLE;
2615     }
2616     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2617     if ($icons = enrol_get_course_info_icons($course)) {
2618         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2619         foreach ($icons as $icon) {
2620             echo $OUTPUT->render($icon);
2621         }
2622         echo html_writer::end_tag('div'); // End of enrolmenticons div
2623     }
2624     echo html_writer::end_tag('div'); // End of summary div
2625     echo html_writer::end_tag('div'); // End of coursebox div
2628 /**
2629  * Prints custom user information on the home page.
2630  * Over time this can include all sorts of information
2631  */
2632 function print_my_moodle() {
2633     global $USER, $CFG, $DB, $OUTPUT;
2635     if (!isloggedin() or isguestuser()) {
2636         print_error('nopermissions', '', '', 'See My Moodle');
2637     }
2639     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2640     $rhosts   = array();
2641     $rcourses = array();
2642     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2643         $rcourses = get_my_remotecourses($USER->id);
2644         $rhosts   = get_my_remotehosts();
2645     }
2647     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2649         if (!empty($courses)) {
2650             echo '<ul class="unlist">';
2651             foreach ($courses as $course) {
2652                 if ($course->id == SITEID) {
2653                     continue;
2654                 }
2655                 echo '<li>';
2656                 print_course($course);
2657                 echo "</li>\n";
2658             }
2659             echo "</ul>\n";
2660         }
2662         // MNET
2663         if (!empty($rcourses)) {
2664             // at the IDP, we know of all the remote courses
2665             foreach ($rcourses as $course) {
2666                 print_remote_course($course, "100%");
2667             }
2668         } elseif (!empty($rhosts)) {
2669             // non-IDP, we know of all the remote servers, but not courses
2670             foreach ($rhosts as $host) {
2671                 print_remote_host($host, "100%");
2672             }
2673         }
2674         unset($course);
2675         unset($host);
2677         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2678             echo "<table width=\"100%\"><tr><td align=\"center\">";
2679             print_course_search("", false, "short");
2680             echo "</td><td align=\"center\">";
2681             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2682             echo "</td></tr></table>\n";
2683         }
2685     } else {
2686         if ($DB->count_records("course_categories") > 1) {
2687             echo $OUTPUT->box_start("categorybox");
2688             print_whole_category_list();
2689             echo $OUTPUT->box_end();
2690         } else {
2691             print_courses(0);
2692         }
2693     }
2697 function print_course_search($value="", $return=false, $format="plain") {
2698     global $CFG;
2699     static $count = 0;
2701     $count++;
2703     $id = 'coursesearch';
2705     if ($count > 1) {
2706         $id .= $count;
2707     }
2709     $strsearchcourses= get_string("searchcourses");
2711     if ($format == 'plain') {
2712         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2713         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2714         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2715         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2716         $output .= '<input type="submit" value="'.get_string('go').'" />';
2717         $output .= '</fieldset></form>';
2718     } else if ($format == 'short') {
2719         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2720         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2721         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2722         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2723         $output .= '<input type="submit" value="'.get_string('go').'" />';
2724         $output .= '</fieldset></form>';
2725     } else if ($format == 'navbar') {
2726         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2727         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2728         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2729         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2730         $output .= '<input type="submit" value="'.get_string('go').'" />';
2731         $output .= '</fieldset></form>';
2732     }
2734     if ($return) {
2735         return $output;
2736     }
2737     echo $output;
2740 function print_remote_course($course, $width="100%") {
2741     global $CFG, $USER;
2743     $linkcss = '';
2745     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2747     echo '<div class="coursebox remotecoursebox clearfix">';
2748     echo '<div class="info">';
2749     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2750          $linkcss.' href="'.$url.'">'
2751         .  format_string($course->fullname) .'</a><br />'
2752         . format_string($course->hostname) . ' : '
2753         . format_string($course->cat_name) . ' : '
2754         . format_string($course->shortname). '</div>';
2755     echo '</div><div class="summary">';
2756     $options = new stdClass();
2757     $options->noclean = true;
2758     $options->para = false;
2759     $options->overflowdiv = true;
2760     echo format_text($course->summary, $course->summaryformat, $options);
2761     echo '</div>';
2762     echo '</div>';
2765 function print_remote_host($host, $width="100%") {
2766     global $OUTPUT;
2768     $linkcss = '';
2770     echo '<div class="coursebox clearfix">';
2771     echo '<div class="info">';
2772     echo '<div class="name">';
2773     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2774     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2775         . s($host['name']).'</a> - ';
2776     echo $host['count'] . ' ' . get_string('courses');
2777     echo '</div>';
2778     echo '</div>';
2779     echo '</div>';
2783 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2785 function add_course_module($mod) {
2786     global $DB;
2788     $mod->added = time();
2789     unset($mod->id);
2791     return $DB->insert_record("course_modules", $mod);
2794 /**
2795  * Returns course section - creates new if does not exist yet.
2796  * @param int $relative section number
2797  * @param int $courseid
2798  * @return object $course_section object
2799  */
2800 function get_course_section($section, $courseid) {
2801     global $DB;
2803     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2804         return $cw;
2805     }
2806     $cw = new stdClass();
2807     $cw->course   = $courseid;
2808     $cw->section  = $section;
2809     $cw->summary  = "";
2810     $cw->summaryformat = FORMAT_HTML;
2811     $cw->sequence = "";
2812     $id = $DB->insert_record("course_sections", $cw);
2813     return $DB->get_record("course_sections", array("id"=>$id));
2815 /**
2816  * Given a full mod object with section and course already defined, adds this module to that section.
2817  *
2818  * @param object $mod
2819  * @param int $beforemod An existing ID which we will insert the new module before
2820  * @return int The course_sections ID where the mod is inserted
2821  */
2822 function add_mod_to_section($mod, $beforemod=NULL) {
2823     global $DB;
2825     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2827         $section->sequence = trim($section->sequence);
2829         if (empty($section->sequence)) {
2830             $newsequence = "$mod->coursemodule";
2832         } else if ($beforemod) {
2833             $modarray = explode(",", $section->sequence);
2835             if ($key = array_keys($modarray, $beforemod->id)) {
2836                 $insertarray = array($mod->id, $beforemod->id);
2837                 array_splice($modarray, $key[0], 1, $insertarray);
2838                 $newsequence = implode(",", $modarray);
2840             } else {  // Just tack it on the end anyway
2841                 $newsequence = "$section->sequence,$mod->coursemodule";
2842             }
2844         } else {
2845             $newsequence = "$section->sequence,$mod->coursemodule";
2846         }
2848         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2849         return $section->id;     // Return course_sections ID that was used.
2851     } else {  // Insert a new record
2852         $section = new stdClass();
2853         $section->course   = $mod->course;
2854         $section->section  = $mod->section;
2855         $section->summary  = "";
2856         $section->summaryformat = FORMAT_HTML;
2857         $section->sequence = $mod->coursemodule;
2858         return $DB->insert_record("course_sections", $section);
2859     }
2862 function set_coursemodule_groupmode($id, $groupmode) {
2863     global $DB;
2864     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2867 function set_coursemodule_idnumber($id, $idnumber) {
2868     global $DB;
2869     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2872 /**
2873 * $prevstateoverrides = true will set the visibility of the course module
2874 * to what is defined in visibleold. This enables us to remember the current
2875 * visibility when making a whole section hidden, so that when we toggle
2876 * that section back to visible, we are able to return the visibility of
2877 * the course module back to what it was originally.
2878 */
2879 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2880     global $DB, $CFG;
2881     require_once($CFG->libdir.'/gradelib.php');
2883     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2884         return false;
2885     }
2886     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2887         return false;
2888     }
2889     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2890         foreach($events as $event) {
2891             if ($visible) {
2892                 show_event($event);
2893             } else {
2894                 hide_event($event);
2895             }
2896         }
2897     }
2899     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2900     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2901     if ($grade_items) {
2902         foreach ($grade_items as $grade_item) {
2903             $grade_item->set_hidden(!$visible);
2904         }
2905     }
2907     if ($prevstateoverrides) {
2908         if ($visible == '0') {
2909             // Remember the current visible state so we can toggle this back.
2910             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2911         } else {
2912             // Get the previous saved visible states.
2913             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2914         }
2915     }
2916     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2919 /**
2920  * Delete a course module and any associated data at the course level (events)
2921  * Until 1.5 this function simply marked a deleted flag ... now it
2922  * deletes it completely.
2923  *
2924  */
2925 function delete_course_module($id) {
2926     global $CFG, $DB;
2927     require_once($CFG->libdir.'/gradelib.php');
2928     require_once($CFG->dirroot.'/blog/lib.php');
2930     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2931         return true;
2932     }
2933     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2934     //delete events from calendar
2935     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2936         foreach($events as $event) {
2937             delete_event($event->id);
2938         }
2939     }
2940     //delete grade items, outcome items and grades attached to modules
2941     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2942                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2943         foreach ($grade_items as $grade_item) {
2944             $grade_item->delete('moddelete');
2945         }
2946     }
2947     // Delete completion and availability data; it is better to do this even if the
2948     // features are not turned on, in case they were turned on previously (these will be
2949     // very quick on an empty table)
2950     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2951     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2952     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2953                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2955     delete_context(CONTEXT_MODULE, $cm->id);
2956     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2959 function delete_mod_from_section($mod, $section) {
2960     global $DB;
2962     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2964         $modarray = explode(",", $section->sequence);
2966         if ($key = array_keys ($modarray, $mod)) {
2967             array_splice($modarray, $key[0], 1);
2968             $newsequence = implode(",", $modarray);
2969             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2970         } else {
2971             return false;
2972         }
2974     }
2975     return false;
2978 /**
2979  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2980  *
2981  * @param object $course course object
2982  * @param int $section Section number (not id!!!)
2983  * @param int $move (-1 or 1)
2984  * @return boolean true if section moved successfully
2985  */
2986 function move_section($course, $section, $move) {
2987 /// Moves a whole course section up and down within the course
2988     global $USER, $DB;
2990     if (!$move) {
2991         return true;
2992     }
2994     $sectiondest = $section + $move;
2996     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2997         return false;
2998     }
3000     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
3001         return false;
3002     }
3004     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
3005         return false;
3006     }
3008     // Three-step change ensures that the section always remains unique (there is
3009     // a unique index now)
3010     $DB->set_field("course_sections", "section", -$sectiondest, array("id"=>$sectionrecord->id));
3011     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
3012     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
3014     // Update highlighting if the move affects highlighted section
3015     if ($course->marker == $section) {
3016         course_set_marker($course->id, $sectiondest);
3017     } elseif ($course->marker == $sectiondest) {
3018         course_set_marker($course->id, $section);
3019     }
3021     // if the focus is on the section that is being moved, then move the focus along
3022     if (course_get_display($course->id) == $section) {
3023         course_set_display($course->id, $sectiondest);
3024     }
3026     // Fix order if needed. The database prevents duplicate sections, but it is
3027     // possible there could be a gap in the numbering.
3028     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
3029     $n = 0;
3030     foreach ($sections as $section) {
3031         if ($section->section != $n) {
3032             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
3033         }
3034         $n++;
3035     }
3036     return true;
3039 /**
3040  * Moves a section within a course, from a position to another.
3041  * Be very careful: $section and $destination refer to section number,
3042  * not id!.
3043  *
3044  * @param object $course
3045  * @param int $section Section number (not id!!!)
3046  * @param int $destination
3047  * @return boolean Result
3048  */
3049 function move_section_to($course, $section, $destination) {
3050 /// Moves a whole course section up and down within the course
3051     global $USER, $DB;
3053     if (!$destination && $destination != 0) {
3054         return true;
3055     }
3057     if ($destination > $course->numsections) {
3058         return false;
3059     }
3061     // Get all sections for this course and re-order them (2 of them should now share the same section number)
3062     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
3063             'section ASC, id ASC', 'id, section')) {
3064         return false;
3065     }
3067     $movedsections = reorder_sections($sections, $section, $destination);
3069     // Update all sections. Do this in 2 steps to avoid breaking database
3070     // uniqueness constraint
3071     $transaction = $DB->start_delegated_transaction();
3072     foreach ($movedsections as $id => $position) {
3073         if ($sections[$id] !== $position) {
3074             $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
3075         }
3076     }
3077     foreach ($movedsections as $id => $position) {
3078         if ($sections[$id] !== $position) {
3079             $DB->set_field('course_sections', 'section', $position, array('id' => $id));
3080         }
3081     }
3083     // Adjust destination to reflect the actual section
3084     $moveup = false;
3085     if ($section > $destination) {
3086         $destination++;
3087         $moveup = true;
3088     }
3090     // If we move the highlighted section itself, then just highlight the destination.
3091     // Adjust the higlighted section location if we move something over it either direction.
3092     if ($section == $course->marker) {
3093         course_set_marker($course, $destination);
3094     } elseif ($moveup && $section > $course->marker && $course->marker >= $destination) {
3095         course_set_marker($course, $course->marker+1);
3096     } elseif (!$moveup && $section < $course->marker && $course->marker <= $destination) {
3097         course_set_marker($course, $course->marker-1);
3098     }
3100     // if the focus is on the section that is being moved, then move the focus along
3101     if (course_get_display($course->id) == $section) {
3102         course_set_display($course->id, $destination);
3103     }
3104     $transaction->allow_commit();
3105     return true;
3108 /**
3109  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3110  * an original position number and a target position number, rebuilds the array so that the
3111  * move is made without any duplication of section positions.
3112  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3113  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3114  *
3115  * @param array $sections
3116  * @param int $origin_position
3117  * @param int $target_position
3118  * @return array
3119  */
3120 function reorder_sections($sections, $origin_position, $target_position) {
3121     if (!is_array($sections)) {
3122         return false;
3123     }
3125     // We can't move section position 0
3126     if ($origin_position < 1) {
3127         echo "We can't move section position 0";
3128         return false;
3129     }
3131     // Locate origin section in sections array
3132     if (!$origin_key = array_search($origin_position, $sections)) {
3133         echo "searched position not in sections array";
3134         return false; // searched position not in sections array
3135     }
3137     // Extract origin section
3138     $origin_section = $sections[$origin_key];
3139     unset($sections[$origin_key]);
3141     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3142     $found = false;
3143     $append_array = array();
3144     foreach ($sections as $id => $position) {
3145         if ($found) {
3146             $append_array[$id] = $position;
3147             unset($sections[$id]);
3148         }
3149         if ($position == $target_position) {
3150             $found = true;
3151         }
3152     }
3154     // Append moved section
3155     $sections[$origin_key] = $origin_section;
3157     // Append rest of array (if applicable)
3158     if (!empty($append_array)) {
3159         foreach ($append_array as $id => $position) {
3160             $sections[$id] = $position;
3161         }
3162     }
3164     // Renumber positions
3165     $position = 0;
3166     foreach ($sections as $id => $p) {
3167         $sections[$id] = $position;
3168         $position++;
3169     }
3171     return $sections;
3175 /**
3176  * Move the module object $mod to the specified $section
3177  * If $beforemod exists then that is the module
3178  * before which $modid should be inserted
3179  * All parameters are objects
3180  */
3181 function moveto_module($mod, $section, $beforemod=NULL) {
3182     global $DB, $OUTPUT;
3184 /// Remove original module from original section
3185     if (! delete_mod_from_section($mod->id, $mod->section)) {
3186         echo $OUTPUT->notification("Could not delete module from existing section");
3187     }
3189 /// Update module itself if necessary
3191     if ($mod->section != $section->id) {
3192         $mod->section = $section->id;
3193         $DB->update_record("course_modules", $mod);
3194         // if moving to a hidden section then hide module
3195         if (!$section->visible) {
3196             set_coursemodule_visible($mod->id, 0);
3197         }
3198     }
3200 /// Add the module into the new section
3202     $mod->course       = $section->course;
3203     $mod->section      = $section->section;  // need relative reference
3204     $mod->coursemodule = $mod->id;
3206     if (! add_mod_to_section($mod, $beforemod)) {
3207         return false;
3208     }
3210     return true;
3213 /**
3214  * Produces the editing buttons for a module
3215  *
3216  * @global core_renderer $OUTPUT
3217  * @staticvar type $str
3218  * @param stdClass $mod The module to produce editing buttons for
3219  * @param bool $absolute_ignored ignored - all links are absolute
3220  * @param bool $moveselect If true a move seleciton process is used (default true)
3221  * @param int $indent The current indenting
3222  * @param int $section The section to link back to
3223  * @return string XHTML for the editing buttons
3224  */
3225 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=-1) {
3226     global $CFG, $OUTPUT;
3228     static $str;
3230     $coursecontext = get_context_instance(CONTEXT_COURSE, $mod->course);
3231     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
3233     $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
3234     $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
3236     // no permission to edit anything
3237     if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
3238         return false;
3239     }
3241     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3243     if (!isset($str)) {
3244         $str = new stdClass;
3245         $str->assign         = get_string("assignroles", 'role');
3246         $str->delete         = get_string("delete");
3247         $str->move           = get_string("move");
3248         $str->moveup         = get_string("moveup");
3249         $str->movedown       = get_string("movedown");
3250         $str->moveright      = get_string("moveright");
3251         $str->moveleft       = get_string("moveleft");
3252         $str->update         = get_string("update");
3253         $str->duplicate      = get_string("duplicate");
3254         $str->hide           = get_string("hide");
3255         $str->show           = get_string("show");
3256         $str->groupsnone     = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
3257         $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
3258         $str->groupsvisible  = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
3259         $str->forcedgroupsnone     = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
3260         $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
3261         $str->forcedgroupsvisible  = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
3262     }
3264     $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3266     if ($section >= 0) {
3267         $baseurl->param('sr', $section);
3268     }
3269     $actions = array();
3271     // leftright
3272     if ($hasmanageactivities) {
3273         if (right_to_left()) {   // Exchange arrows on RTL
3274             $rightarrow = 't/left';
3275             $leftarrow  = 't/right';
3276         } else {
3277             $rightarrow = 't/right';
3278             $leftarrow  = 't/left';
3279         }
3281         if ($indent > 0) {
3282             $actions[] = new action_link(
3283                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
3284                 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall')),
3285                 null,
3286                 array('class' => 'editing_moveleft', 'title' => $str->moveleft)
3287             );
3288         }
3289         if ($indent >= 0) {
3290             $actions[] = new action_link(
3291                 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
3292                 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall')),
3293                 null,
3294                 array('class' => 'editing_moveright', 'title' => $str->moveright)
3295             );
3296         }
3297     }
3299     // move
3300     if ($hasmanageactivities) {
3301         if ($moveselect) {
3302             $actions[] = new action_link(
3303                 new moodle_url($baseurl, array('copy' => $mod->id)),
3304                 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall')),
3305                 null,
3306                 array('class' => 'editing_move', 'title' => $str->move)
3307             );
3308         } else {
3309             $actions[] = new action_link(
3310                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '-1')),
3311                 new pix_icon('t/up', $str->moveup, 'moodle', array('class' => 'iconsmall')),
3312                 null,
3313                 array('class' => 'editing_moveup', 'title' => $str->moveup)
3314             );
3315             $actions[] = new action_link(
3316                 new moodle_url($baseurl, array('id' => $mod->id, 'move' => '1')),
3317                 new pix_icon('t/down', $str->movedown, 'moodle', array('class' => 'iconsmall')),
3318                 null,
3319                 array('class' => 'editing_movedown', 'title' => $str->movedown)
3320             );
3321         }
3322     }
3324     // Update
3325     if ($hasmanageactivities) {
3326         $actions[] = new action_link(
3327             new moodle_url($baseurl, array('update' => $mod->id)),
3328             new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall')),
3329             null,
3330             array('class' => 'editing_update', 'title' => $str->update)
3331         );
3332     }
3334     // Duplicate (require both target import caps to be able to duplicate, see modduplicate.php)
3335     if (has_all_capabilities($dupecaps, $coursecontext)) {
3336         $actions[] = new action_link(
3337             new moodle_url($baseurl, array('duplicate' => $mod->id)),
3338             new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall')),
3339             null,
3340             array('class' => 'editing_duplicate', 'title' => $str->duplicate)
3341         );
3342     }
3344     // Delete
3345     if ($hasmanageactivities) {
3346         $actions[] = new action_link(
3347             new moodle_url($baseurl, array('delete' => $mod->id)),
3348             new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall')),
3349             null,
3350             array('class' => 'editing_delete', 'title' => $str->delete)
3351         );
3352     }
3354     // hideshow
3355     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
3356         if ($mod->visible) {
3357             $actions[] = new action_link(
3358                 new moodle_url($baseurl, array('hide' => $mod->id)),
3359                 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall')),
3360                 null,
3361                 array('class' => 'editing_hide', 'title' => $str->hide)
3362             );
3363         } else {
3364             $actions[] = new action_link(
3365                 new moodle_url($baseurl, array('show' => $mod->id)),
3366                 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall')),
3367                 null,
3368                 array('class' => 'editing_show', 'title' => $str->show)
3369             );
3370         }
3371     }
3373     // groupmode
3374     if ($hasmanageactivities and $mod->groupmode !== false) {
3375         if ($mod->groupmode == SEPARATEGROUPS) {
3376             $groupmode = 0;
3377             $grouptitle = $str->groupsseparate;
3378             $forcedgrouptitle = $str->forcedgroupsseparate;
3379             $groupclass = 'editing_groupsseparate';
3380             $groupimage = 't/groups';
3381         } else if ($mod->groupmode == VISIBLEGROUPS) {
3382             $groupmode = 1;
3383             $grouptitle = $str->groupsvisible;
3384             $forcedgrouptitle = $str->forcedgroupsvisible;
3385             $groupclass = 'editing_groupsvisible';
3386             $groupimage = 't/groupv';
3387         } else {
3388             $groupmode = 2;
3389             $grouptitle = $str->groupsnone;
3390             $forcedgrouptitle = $str->forcedgroupsnone;
3391             $groupclass = 'editing_groupsnone';
3392             $groupimage = 't/groupn';
3393         }
3394         if ($mod->groupmodelink) {
3395             $actions[] = new action_link(
3396                 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $groupmode)),
3397                 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall')),
3398                 null,
3399                 array('class' => $groupclass, 'title' => $grouptitle)
3400             );
3401         } else {
3402             $actions[] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('title' => $forcedgrouptitle, 'class' => 'iconsmall'));
3403         }
3404     }
3406     // Assign
3407     if (has_capability('moodle/role:assign', $modcontext)){
3408         $actions[] = new action_link(
3409             new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $modcontext->id)),
3410             new pix_icon('i/roles', $str->assign, 'moodle', array('class' => 'iconsmall')),
3411             null,
3412             array('class' => 'editing_assign', 'title' => $str->assign)
3413         );
3414     }
3416     $output = html_writer::start_tag('span', array('class' => 'commands'));
3417     foreach ($actions as $action) {
3418         if ($action instanceof renderable) {
3419             $output .= $OUTPUT->render($action);
3420         } else {
3421             $output .= $action;
3422         }
3423     }
3424     $output .= html_writer::end_tag('span');
3425     return $output;
3428 /**
3429  * given a course object with shortname & fullname, this function will
3430  * truncate the the number of chars allowed and add ... if it was too long
3431  */
3432 function course_format_name ($course,$max=100) {
3434     $context = get_context_instance(CONTEXT_COURSE, $course->id);
3435     $shortname = format_string($course->shortname, true, array('context' => $context));
3436     $fullname = format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
3437     $str = $shortname.': '. $fullname;
3438     if (textlib::strlen($str) <= $max) {
3439         return $str;
3440     }
3441     else {
3442         return textlib::substr($str,0,$max-3).'...';
3443     }
3446 /**
3447  * Is the user allowed to add this type of module to this course?
3448  * @param object $course the course settings. Only $course->id is used.
3449  * @param string $modname the module name. E.g. 'forum' or 'quiz'.
3450  * @return bool whether the current user is allowed to add this type of module to this course.
3451  */
3452 function course_allowed_module($course, $modname) {
3453     global $DB;
3455     if (is_numeric($modname)) {
3456         throw new coding_exception('Function course_allowed_module no longer
3457                 supports numeric module ids. Please update your code to pass the module name.');
3458     }
3460     $capability = 'mod/' . $modname . ':addinstance';
3461     if (!get_capability_info($capability)) {
3462         // Debug warning that the capability does not exist, but no more than once per page.
3463         static $warned = array();
3464         $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3465         if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
3466             debugging('The module ' . $modname . ' does not define the standard capability ' .
3467                     $capability , DEBUG_DEVELOPER);
3468             $warned[$modname] = 1;
3469         }
3471         // If the capability does not exist, the module can always be added.
3472         return true;
3473     }
3475     $coursecontext = context_course::instance($course->id);
3476     return has_capability($capability, $coursecontext);
3479 /**
3480  * Recursively delete category including all subcategories and courses.
3481  * @param stdClass $category
3482  * @param boolean $showfeedback display some notices
3483  * @return array return deleted courses
3484  */
3485 function category_delete_full($category, $showfeedback=true) {
3486     global $CFG, $DB;
3487     require_once($CFG->libdir.'/gradelib.php');
3488     require_once($CFG->libdir.'/questionlib.php');
3489     require_once($CFG->dirroot.'/cohort/lib.php');
3491     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3492         foreach ($children as $childcat) {
3493