MDL-25235 fixed param type for OS paths
[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');
32 define('COURSE_MAX_LOG_DISPLAY', 150);          // days
33 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
34 define('COURSE_LIVELOG_REFRESH', 60);           // Seconds
35 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
36 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
37 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
38 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
39 define('FRONTPAGENEWS',           '0');
40 define('FRONTPAGECOURSELIST',     '1');
41 define('FRONTPAGECATEGORYNAMES',  '2');
42 define('FRONTPAGETOPICONLY',      '3');
43 define('FRONTPAGECATEGORYCOMBO',  '4');
44 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
45 define('EXCELROWS', 65535);
46 define('FIRSTUSEDEXCELROW', 3);
48 define('MOD_CLASS_ACTIVITY', 0);
49 define('MOD_CLASS_RESOURCE', 1);
51 if (!defined('MAX_MODINFO_CACHE_SIZE')) {
52     define('MAX_MODINFO_CACHE_SIZE', 10);
53 }
55 function make_log_url($module, $url) {
56     switch ($module) {
57         case 'course':
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();
155     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
156               FROM {mnet_log} l
157                LEFT JOIN {user} u ON l.userid = u.id
158               WHERE ";
159     $params = array();
161     $where .= "l.hostid = :hostid";
162     $params['hostid'] = $hostid;
164     // TODO: Is 1 really a magic number referring to the sitename?
165     if ($course != SITEID || $modid != 0) {
166         $where .= " AND l.course=:courseid";
167         $params['courseid'] = $course;
168     }
170     if ($modname) {
171         $where .= " AND l.module = :modname";
172         $params['modname'] = $modname;
173     }
175     if ('site_errors' === $modid) {
176         $where .= " AND ( l.action='error' OR l.action='infected' )";
177     } else if ($modid) {
178         //TODO: This assumes that modids are the same across sites... probably
179         //not true
180         $where .= " AND l.cmid = :modid";
181         $params['modid'] = $modid;
182     }
184     if ($modaction) {
185         $firstletter = substr($modaction, 0, 1);
186         if ($firstletter == '-') {
187             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
188             $params['modaction'] = '%'.substr($modaction, 1).'%';
189         } else {
190             $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
191             $params['modaction'] = '%'.$modaction.'%';
192         }
193     }
195     if ($user) {
196         $where .= " AND l.userid = :user";
197         $params['user'] = $user;
198     }
200     if ($date) {
201         $enddate = $date + 86400;
202         $where .= " AND l.time > :date AND l.time < :enddate";
203         $params['date'] = $date;
204         $params['enddate'] = $enddate;
205     }
207     $result = array();
208     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
209     if(!empty($result['totalcount'])) {
210         $where .= " ORDER BY $order";
211         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
212     } else {
213         $result['logs'] = array();
214     }
215     return $result;
218 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
219                    $modname="", $modid=0, $modaction="", $groupid=0) {
220     global $DB, $SESSION, $USER;
221     // It is assumed that $date is the GMT time of midnight for that day,
222     // and so the next 86400 seconds worth of logs are printed.
224     /// Setup for group handling.
226     /// If the group mode is separate, and this user does not have editing privileges,
227     /// then only the user's group can be viewed.
228     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
229         if (isset($SESSION->currentgroup[$course->id])) {
230             $groupid =  $SESSION->currentgroup[$course->id];
231         } else {
232             $groupid = groups_get_all_groups($course->id, $USER->id);
233             if (is_array($groupid)) {
234                 $groupid = array_shift(array_keys($groupid));
235                 $SESSION->currentgroup[$course->id] = $groupid;
236             } else {
237                 $groupid = 0;
238             }
239         }
240     }
241     /// If this course doesn't have groups, no groupid can be specified.
242     else if (!$course->groupmode) {
243         $groupid = 0;
244     }
246     $joins = array();
247     $params = array();
249     if ($course->id != SITEID || $modid != 0) {
250         $joins[] = "l.course = :courseid";
251         $params['courseid'] = $course->id;
252     }
254     if ($modname) {
255         $joins[] = "l.module = :modname";
256         $params['modname'] = $modname;
257     }
259     if ('site_errors' === $modid) {
260         $joins[] = "( l.action='error' OR l.action='infected' )";
261     } else if ($modid) {
262         $joins[] = "l.cmid = :modid";
263         $params['modid'] = $modid;
264     }
266     if ($modaction) {
267         $firstletter = substr($modaction, 0, 1);
268         if ($firstletter == '-') {
269             $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
270             $params['modaction'] = '%'.substr($modaction, 1).'%';
271         } else {
272             $joins[] = $DB->sql_like('l.action', ':modaction', false);
273             $params['modaction'] = '%'.$modaction.'%';
274         }
275     }
278     /// Getting all members of a group.
279     if ($groupid and !$user) {
280         if ($gusers = groups_get_members($groupid)) {
281             $gusers = array_keys($gusers);
282             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
283         } else {
284             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
285         }
286     }
287     else if ($user) {
288         $joins[] = "l.userid = :userid";
289         $params['userid'] = $user;
290     }
292     if ($date) {
293         $enddate = $date + 86400;
294         $joins[] = "l.time > :date AND l.time < :enddate";
295         $params['date'] = $date;
296         $params['enddate'] = $enddate;
297     }
299     $selector = implode(' AND ', $joins);
301     $totalcount = 0;  // Initialise
302     $result = array();
303     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
304     $result['totalcount'] = $totalcount;
305     return $result;
309 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
310                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
312     global $CFG, $DB, $OUTPUT;
314     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
315                        $modname, $modid, $modaction, $groupid)) {
316         echo $OUTPUT->notification("No logs found!");
317         echo $OUTPUT->footer();
318         exit;
319     }
321     $courses = array();
323     if ($course->id == SITEID) {
324         $courses[0] = '';
325         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
326             foreach ($ccc as $cc) {
327                 $courses[$cc->id] = $cc->shortname;
328             }
329         }
330     } else {
331         $courses[$course->id] = $course->shortname;
332     }
334     $totalcount = $logs['totalcount'];
335     $count=0;
336     $ldcache = array();
337     $tt = getdate(time());
338     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
340     $strftimedatetime = get_string("strftimedatetime");
342     echo "<div class=\"info\">\n";
343     print_string("displayingrecords", "", $totalcount);
344     echo "</div>\n";
346     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
348     $table = new html_table();
349     $table->classes = array('logtable','generalbox');
350     $table->align = array('right', 'left', 'left');
351     $table->head = array(
352         get_string('time'),
353         get_string('ip_address'),
354         get_string('fullnamecourse'),
355         get_string('action'),
356         get_string('info')
357     );
358     $table->data = array();
360     if ($course->id == SITEID) {
361         array_unshift($table->align, 'left');
362         array_unshift($table->head, get_string('course'));
363     }
365     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
366     if (empty($logs['logs'])) {
367         $logs['logs'] = array();
368     }
370     foreach ($logs['logs'] as $log) {
372         if (isset($ldcache[$log->module][$log->action])) {
373             $ld = $ldcache[$log->module][$log->action];
374         } else {
375             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
376             $ldcache[$log->module][$log->action] = $ld;
377         }
378         if ($ld && is_numeric($log->info)) {
379             // ugly hack to make sure fullname is shown correctly
380             if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
381                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
382             } else {
383                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
384             }
385         }
387         //Filter log->info
388         $log->info = format_string($log->info);
390         // If $log->url has been trimmed short by the db size restriction
391         // code in add_to_log, keep a note so we don't add a link to a broken url
392         $tl=textlib_get_instance();
393         $brokenurl=($tl->strlen($log->url)==100 && $tl->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('fullnamecourse')."</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             echo "<td class=\"r$row c0\" >\n";
506             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courses[$log->course]."</a>\n";
507             echo "</td>\n";
508         }
509         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
510              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
511         echo "<td class=\"r$row c2\" >\n";
512         $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
513         echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
514         echo "</td>\n";
515         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
516         echo "<td class=\"r$row c3\" >\n";
517         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
518         echo "</td>\n";
519         echo "<td class=\"r$row c4\">\n";
520         echo $log->action .': '.$log->module;
521         echo "</td>\n";;
522         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
523         echo "</tr>\n";
524     }
525     echo "</table>\n";
527     echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
531 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
532                         $modid, $modaction, $groupid) {
533     global $DB;
535     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
536             get_string('fullnamecourse')."\t".get_string('action')."\t".get_string('info');
538     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
539                        $modname, $modid, $modaction, $groupid)) {
540         return false;
541     }
543     $courses = array();
545     if ($course->id == SITEID) {
546         $courses[0] = '';
547         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
548             foreach ($ccc as $cc) {
549                 $courses[$cc->id] = $cc->shortname;
550             }
551         }
552     } else {
553         $courses[$course->id] = $course->shortname;
554     }
556     $count=0;
557     $ldcache = array();
558     $tt = getdate(time());
559     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
561     $strftimedatetime = get_string("strftimedatetime");
563     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
564     $filename .= '.txt';
565     header("Content-Type: application/download\n");
566     header("Content-Disposition: attachment; filename=$filename");
567     header("Expires: 0");
568     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
569     header("Pragma: public");
571     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
572     echo $text;
574     if (empty($logs['logs'])) {
575         return true;
576     }
578     foreach ($logs['logs'] as $log) {
579         if (isset($ldcache[$log->module][$log->action])) {
580             $ld = $ldcache[$log->module][$log->action];
581         } else {
582             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
583             $ldcache[$log->module][$log->action] = $ld;
584         }
585         if ($ld && !empty($log->info)) {
586             // ugly hack to make sure fullname is shown correctly
587             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
588                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
589             } else {
590                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
591             }
592         }
594         //Filter log->info
595         $log->info = format_string($log->info);
596         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
598         $firstField = $courses[$log->course];
599         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
600         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
601         $text = implode("\t", $row);
602         echo $text." \n";
603     }
604     return true;
608 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
609                         $modid, $modaction, $groupid) {
611     global $CFG, $DB;
613     require_once("$CFG->libdir/excellib.class.php");
615     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
616                        $modname, $modid, $modaction, $groupid)) {
617         return false;
618     }
620     $courses = array();
622     if ($course->id == SITEID) {
623         $courses[0] = '';
624         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
625             foreach ($ccc as $cc) {
626                 $courses[$cc->id] = $cc->shortname;
627             }
628         }
629     } else {
630         $courses[$course->id] = $course->shortname;
631     }
633     $count=0;
634     $ldcache = array();
635     $tt = getdate(time());
636     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
638     $strftimedatetime = get_string("strftimedatetime");
640     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
641     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
642     $filename .= '.xls';
644     $workbook = new MoodleExcelWorkbook('-');
645     $workbook->send($filename);
647     $worksheet = array();
648     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
649                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
651     // Creating worksheets
652     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
653         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
654         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
655         $worksheet[$wsnumber]->set_column(1, 1, 30);
656         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
657                                     userdate(time(), $strftimedatetime));
658         $col = 0;
659         foreach ($headers as $item) {
660             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
661             $col++;
662         }
663     }
665     if (empty($logs['logs'])) {
666         $workbook->close();
667         return true;
668     }
670     $formatDate =& $workbook->add_format();
671     $formatDate->set_num_format(get_string('log_excel_date_format'));
673     $row = FIRSTUSEDEXCELROW;
674     $wsnumber = 1;
675     $myxls =& $worksheet[$wsnumber];
676     foreach ($logs['logs'] as $log) {
677         if (isset($ldcache[$log->module][$log->action])) {
678             $ld = $ldcache[$log->module][$log->action];
679         } else {
680             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
681             $ldcache[$log->module][$log->action] = $ld;
682         }
683         if ($ld && !empty($log->info)) {
684             // ugly hack to make sure fullname is shown correctly
685             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
686                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
687             } else {
688                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
689             }
690         }
692         // Filter log->info
693         $log->info = format_string($log->info);
694         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
696         if ($nroPages>1) {
697             if ($row > EXCELROWS) {
698                 $wsnumber++;
699                 $myxls =& $worksheet[$wsnumber];
700                 $row = FIRSTUSEDEXCELROW;
701             }
702         }
704         $myxls->write($row, 0, $courses[$log->course], '');
705         $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
706         $myxls->write($row, 2, $log->ip, '');
707         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
708         $myxls->write($row, 3, $fullname, '');
709         $myxls->write($row, 4, $log->module.' '.$log->action, '');
710         $myxls->write($row, 5, $log->info, '');
712         $row++;
713     }
715     $workbook->close();
716     return true;
719 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
720                         $modid, $modaction, $groupid) {
722     global $CFG, $DB;
724     require_once("$CFG->libdir/odslib.class.php");
726     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
727                        $modname, $modid, $modaction, $groupid)) {
728         return false;
729     }
731     $courses = array();
733     if ($course->id == SITEID) {
734         $courses[0] = '';
735         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
736             foreach ($ccc as $cc) {
737                 $courses[$cc->id] = $cc->shortname;
738             }
739         }
740     } else {
741         $courses[$course->id] = $course->shortname;
742     }
744     $count=0;
745     $ldcache = array();
746     $tt = getdate(time());
747     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
749     $strftimedatetime = get_string("strftimedatetime");
751     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
752     $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
753     $filename .= '.ods';
755     $workbook = new MoodleODSWorkbook('-');
756     $workbook->send($filename);
758     $worksheet = array();
759     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
760                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
762     // Creating worksheets
763     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
764         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
765         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
766         $worksheet[$wsnumber]->set_column(1, 1, 30);
767         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
768                                     userdate(time(), $strftimedatetime));
769         $col = 0;
770         foreach ($headers as $item) {
771             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
772             $col++;
773         }
774     }
776     if (empty($logs['logs'])) {
777         $workbook->close();
778         return true;
779     }
781     $formatDate =& $workbook->add_format();
782     $formatDate->set_num_format(get_string('log_excel_date_format'));
784     $row = FIRSTUSEDEXCELROW;
785     $wsnumber = 1;
786     $myxls =& $worksheet[$wsnumber];
787     foreach ($logs['logs'] as $log) {
788         if (isset($ldcache[$log->module][$log->action])) {
789             $ld = $ldcache[$log->module][$log->action];
790         } else {
791             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
792             $ldcache[$log->module][$log->action] = $ld;
793         }
794         if ($ld && !empty($log->info)) {
795             // ugly hack to make sure fullname is shown correctly
796             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
797                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
798             } else {
799                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
800             }
801         }
803         // Filter log->info
804         $log->info = format_string($log->info);
805         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
807         if ($nroPages>1) {
808             if ($row > EXCELROWS) {
809                 $wsnumber++;
810                 $myxls =& $worksheet[$wsnumber];
811                 $row = FIRSTUSEDEXCELROW;
812             }
813         }
815         $myxls->write_string($row, 0, $courses[$log->course]);
816         $myxls->write_date($row, 1, $log->time);
817         $myxls->write_string($row, 2, $log->ip);
818         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
819         $myxls->write_string($row, 3, $fullname);
820         $myxls->write_string($row, 4, $log->module.' '.$log->action);
821         $myxls->write_string($row, 5, $log->info);
823         $row++;
824     }
826     $workbook->close();
827     return true;
831 function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
832     global $CFG, $USER;
833     if (empty($CFG->gdversion)) {
834         echo "(".get_string("gdneed").")";
835     } else {
836         // MDL-10818, do not display broken graph when user has no permission to view graph
837         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
838             ($course->showreports and $USER->id == $userid)) {
839             echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
840                  '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
841         }
842     }
846 function print_overview($courses) {
847     global $CFG, $USER, $DB, $OUTPUT;
849     $htmlarray = array();
850     if ($modules = $DB->get_records('modules')) {
851         foreach ($modules as $mod) {
852             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
853                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
854                 $fname = $mod->name.'_print_overview';
855                 if (function_exists($fname)) {
856                     $fname($courses,$htmlarray);
857                 }
858             }
859         }
860     }
861     foreach ($courses as $course) {
862         echo $OUTPUT->box_start("coursebox");
863         $linkcss = '';
864         if (empty($course->visible)) {
865             $linkcss = 'class="dimmed"';
866         }
867         echo $OUTPUT->heading('<a title="'. format_string($course->fullname).'" '.$linkcss.' href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'. format_string($course->fullname).'</a>', 3);
868         if (array_key_exists($course->id,$htmlarray)) {
869             foreach ($htmlarray[$course->id] as $modname => $html) {
870                 echo $html;
871             }
872         }
873         echo $OUTPUT->box_end();
874     }
878 /**
879  * This function trawls through the logs looking for
880  * anything new since the user's last login
881  */
882 function print_recent_activity($course) {
883     // $course is an object
884     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
886     $context = get_context_instance(CONTEXT_COURSE, $course->id);
888     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
890     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
892     if (!isguestuser()) {
893         if (!empty($USER->lastcourseaccess[$course->id])) {
894             if ($USER->lastcourseaccess[$course->id] > $timestart) {
895                 $timestart = $USER->lastcourseaccess[$course->id];
896             }
897         }
898     }
900     echo '<div class="activitydate">';
901     echo get_string('activitysince', '', userdate($timestart));
902     echo '</div>';
903     echo '<div class="activityhead">';
905     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
907     echo "</div>\n";
909     $content = false;
911 /// Firstly, have there been any new enrolments?
913     $users = get_recent_enrolments($course->id, $timestart);
915     //Accessibility: new users now appear in an <OL> list.
916     if ($users) {
917         echo '<div class="newusers">';
918         echo $OUTPUT->heading(get_string("newusers").':', 3);
919         $content = true;
920         echo "<ol class=\"list\">\n";
921         foreach ($users as $user) {
922             $fullname = fullname($user, $viewfullnames);
923             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
924         }
925         echo "</ol>\n</div>\n";
926     }
928 /// Next, have there been any modifications to the course structure?
930     $modinfo =& get_fast_modinfo($course);
932     $changelist = array();
934     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
935                                             module = 'course' AND
936                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
937                                     array($timestart, $course->id), "id ASC");
939     if ($logs) {
940         $actions  = array('add mod', 'update mod', 'delete mod');
941         $newgones = array(); // added and later deleted items
942         foreach ($logs as $key => $log) {
943             if (!in_array($log->action, $actions)) {
944                 continue;
945             }
946             $info = explode(' ', $log->info);
948             if ($info[0] == 'label') {     // Labels are ignored in recent activity
949                 continue;
950             }
952             if (count($info) != 2) {
953                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
954                 continue;
955             }
957             $modname    = $info[0];
958             $instanceid = $info[1];
960             if ($log->action == 'delete mod') {
961                 // unfortunately we do not know if the mod was visible
962                 if (!array_key_exists($log->info, $newgones)) {
963                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
964                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
965                 }
966             } else {
967                 if (!isset($modinfo->instances[$modname][$instanceid])) {
968                     if ($log->action == 'add mod') {
969                         // do not display added and later deleted activities
970                         $newgones[$log->info] = true;
971                     }
972                     continue;
973                 }
974                 $cm = $modinfo->instances[$modname][$instanceid];
975                 if (!$cm->uservisible) {
976                     continue;
977                 }
979                 if ($log->action == 'add mod') {
980                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
981                     $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>");
983                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
984                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
985                     $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>");
986                 }
987             }
988         }
989     }
991     if (!empty($changelist)) {
992         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
993         $content = true;
994         foreach ($changelist as $changeinfo => $change) {
995             echo '<p class="activity">'.$change['text'].'</p>';
996         }
997     }
999 /// Now display new things from each module
1001     $usedmodules = array();
1002     foreach($modinfo->cms as $cm) {
1003         if (isset($usedmodules[$cm->modname])) {
1004             continue;
1005         }
1006         if (!$cm->uservisible) {
1007             continue;
1008         }
1009         $usedmodules[$cm->modname] = $cm->modname;
1010     }
1012     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1013         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1014             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1015             $print_recent_activity = $modname.'_print_recent_activity';
1016             if (function_exists($print_recent_activity)) {
1017                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1018                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1019             }
1020         } else {
1021             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1022         }
1023     }
1025     if (! $content) {
1026         echo '<p class="message">'.get_string('nothingnew').'</p>';
1027     }
1030 /**
1031  * For a given course, returns an array of course activity objects
1032  * Each item in the array contains he following properties:
1033  */
1034 function get_array_of_activities($courseid) {
1035 //  cm - course module id
1036 //  mod - name of the module (eg forum)
1037 //  section - the number of the section (eg week or topic)
1038 //  name - the name of the instance
1039 //  visible - is the instance visible or not
1040 //  groupingid - grouping id
1041 //  groupmembersonly - is this instance visible to group members only
1042 //  extra - contains extra string to include in any link
1043     global $CFG, $DB;
1044     if(!empty($CFG->enableavailability)) {
1045         require_once($CFG->libdir.'/conditionlib.php');
1046     }
1048     $course = $DB->get_record('course', array('id'=>$courseid));
1050     if (empty($course)) {
1051         throw new moodle_exception('courseidnotfound');
1052     }
1054     $mod = array();
1056     $rawmods = get_course_mods($courseid);
1057     if (empty($rawmods)) {
1058         return $mod; // always return array
1059     }
1061     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1062        foreach ($sections as $section) {
1063            if (!empty($section->sequence)) {
1064                $sequence = explode(",", $section->sequence);
1065                foreach ($sequence as $seq) {
1066                    if (empty($rawmods[$seq])) {
1067                        continue;
1068                    }
1069                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1070                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1071                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1072                    $mod[$seq]->section          = $section->section;
1073                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1074                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1075                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1076                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1077                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1078                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1079                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1080                    $mod[$seq]->extra            = "";
1081                    if(!empty($CFG->enableavailability)) {
1082                        condition_info::fill_availability_conditions($rawmods[$seq]);
1083                        $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1084                        $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1085                        $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1086                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1087                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1088                    }
1090                    $modname = $mod[$seq]->mod;
1091                    $functionname = $modname."_get_coursemodule_info";
1093                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1094                        continue;
1095                    }
1097                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1099                    if (function_exists($functionname)) {
1100                        if ($info = $functionname($rawmods[$seq])) {
1101                            if (!empty($info->extra)) {
1102                                $mod[$seq]->extra = $info->extra;
1103                            }
1104                            if (!empty($info->icon)) {
1105                                $mod[$seq]->icon = $info->icon;
1106                            }
1107                            if (!empty($info->iconcomponent)) {
1108                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1109                            }
1110                            if (!empty($info->name)) {
1111                                $mod[$seq]->name = $info->name;
1112                            }
1113                        }
1114                    }
1115                    if (!isset($mod[$seq]->name)) {
1116                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1117                    }
1118                }
1119             }
1120         }
1121     }
1122     return $mod;
1126 /**
1127  * Returns a number of useful structures for course displays
1128  */
1129 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1130     global $CFG, $DB, $COURSE;
1132     $mods          = array();    // course modules indexed by id
1133     $modnames      = array();    // all course module names (except resource!)
1134     $modnamesplural= array();    // all course module names (plural form)
1135     $modnamesused  = array();    // course module names used
1137     if ($allmods = $DB->get_records("modules")) {
1138         foreach ($allmods as $mod) {
1139             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1140                 continue;
1141             }
1142             if ($mod->visible) {
1143                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1144                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1145             }
1146         }
1147         textlib_get_instance()->asort($modnames);
1148     } else {
1149         print_error("nomodules", 'debug');
1150     }
1152     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1153     $modinfo = get_fast_modinfo($course);
1155     if ($rawmods=$modinfo->cms) {
1156         foreach($rawmods as $mod) {    // Index the mods
1157             if (empty($modnames[$mod->modname])) {
1158                 continue;
1159             }
1160             $mods[$mod->id] = $mod;
1161             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1162             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1163                 continue;
1164             }
1165             // Check groupings
1166             if (!groups_course_module_visible($mod)) {
1167                 continue;
1168             }
1169             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1170         }
1171         if ($modnamesused) {
1172             textlib_get_instance()->asort($modnamesused);
1173         }
1174     }
1177 /**
1178  * Returns an array of sections for the requested course id
1179  *
1180  * This function stores the sections against the course id within a staticvar encase
1181  * of subsequent requests. This is used all over + in some standard libs and course
1182  * format callbacks so subsequent requests are a reality.
1183  *
1184  * @staticvar array $coursesections
1185  * @param int $courseid
1186  * @return array Array of sections
1187  */
1188 function get_all_sections($courseid) {
1189     global $DB;
1190     static $coursesections = array();
1191     if (!array_key_exists($courseid, $coursesections)) {
1192         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1193                            "section, id, course, name, summary, summaryformat, sequence, visible");
1194     }
1195     return $coursesections[$courseid];
1198 function course_set_display($courseid, $display=0) {
1199     global $USER, $DB;
1201     if ($display == "all" or empty($display)) {
1202         $display = 0;
1203     }
1205     if (!isloggedin() or isguestuser()) {
1206         //do not store settings in db for guests
1207     } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
1208         $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
1209     } else {
1210         $record = new stdClass();
1211         $record->userid = $USER->id;
1212         $record->course = $courseid;
1213         $record->display = $display;
1214         $DB->insert_record("course_display", $record);
1215     }
1217     return $USER->display[$courseid] = $display;  // Note: = not ==
1220 /**
1221  * For a given course section, marks it visible or hidden,
1222  * and does the same for every activity in that section
1223  */
1224 function set_section_visible($courseid, $sectionnumber, $visibility) {
1225     global $DB;
1227     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1228         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1229         if (!empty($section->sequence)) {
1230             $modules = explode(",", $section->sequence);
1231             foreach ($modules as $moduleid) {
1232                 set_coursemodule_visible($moduleid, $visibility, true);
1233             }
1234         }
1235         rebuild_course_cache($courseid);
1236     }
1239 /**
1240  * Prints a section full of activity modules
1241  */
1242 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1243     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1245     static $initialised;
1247     static $groupbuttons;
1248     static $groupbuttonslink;
1249     static $isediting;
1250     static $ismoving;
1251     static $strmovehere;
1252     static $strmovefull;
1253     static $strunreadpostsone;
1254     static $usetracking;
1255     static $groupings;
1257     if (!isset($initialised)) {
1258         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1259         $groupbuttonslink = (!$course->groupmodeforce);
1260         $isediting        = $PAGE->user_is_editing();
1261         $ismoving         = $isediting && ismoving($course->id);
1262         if ($ismoving) {
1263             $strmovehere  = get_string("movehere");
1264             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1265         }
1266         include_once($CFG->dirroot.'/mod/forum/lib.php');
1267         if ($usetracking = forum_tp_can_track_forums()) {
1268             $strunreadpostsone = get_string('unreadpostsone', 'forum');
1269         }
1270         $initialised = true;
1271     }
1273     $labelformatoptions = new stdClass();
1274     $labelformatoptions->noclean = true;
1275     $labelformatoptions->overflowdiv = true;
1277 /// Casting $course->modinfo to string prevents one notice when the field is null
1278     $modinfo = get_fast_modinfo($course);
1279     $completioninfo = new completion_info($course);
1281     //Accessibility: replace table with list <ul>, but don't output empty list.
1282     if (!empty($section->sequence)) {
1284         // Fix bug #5027, don't want style=\"width:$width\".
1285         echo "<ul class=\"section img-text\">\n";
1286         $sectionmods = explode(",", $section->sequence);
1288         foreach ($sectionmods as $modnumber) {
1289             if (empty($mods[$modnumber])) {
1290                 continue;
1291             }
1293             $mod = $mods[$modnumber];
1295             if ($ismoving and $mod->id == $USER->activitycopy) {
1296                 // do not display moving mod
1297                 continue;
1298             }
1300             if (isset($modinfo->cms[$modnumber])) {
1301                 // We can continue (because it will not be displayed at all)
1302                 // if:
1303                 // 1) The activity is not visible to users
1304                 // and
1305                 // 2a) The 'showavailability' option is not set (if that is set,
1306                 //     we need to display the activity so we can show
1307                 //     availability info)
1308                 // or
1309                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1310                 //     hidden in a way that leaves no info, such as using the
1311                 //     eye icon.
1312                 if (!$modinfo->cms[$modnumber]->uservisible &&
1313                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1314                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1315                     // visibility shortcut
1316                     continue;
1317                 }
1318             } else {
1319                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1320                     // module not installed
1321                     continue;
1322                 }
1323                 if (!coursemodule_visible_for_user($mod) &&
1324                     empty($mod->showavailability)) {
1325                     // full visibility check
1326                     continue;
1327                 }
1328             }
1330             // In some cases the activity is visible to user, but it is
1331             // dimmed. This is done if viewhiddenactivities is true and if:
1332             // 1. the activity is not visible, or
1333             // 2. the activity has dates set which do not include current, or
1334             // 3. the activity has any other conditions set (regardless of whether
1335             //    current user meets them)
1336             $canviewhidden = has_capability(
1337                 'moodle/course:viewhiddenactivities',
1338                 get_context_instance(CONTEXT_MODULE, $mod->id));
1339             $accessiblebutdim = false;
1340             if ($canviewhidden) {
1341                 $accessiblebutdim = !$mod->visible;
1342                 if (!empty($CFG->enableavailability)) {
1343                     $accessiblebutdim = $accessiblebutdim ||
1344                         $mod->availablefrom > time() ||
1345                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1346                         count($mod->conditionsgrade) > 0 ||
1347                         count($mod->conditionscompletion) > 0;
1348                 }
1349             }
1351             echo '<li class="activity '.$mod->modname.' modtype_'.$mod->modname.'" id="module-'.$modnumber.'">';  // Unique ID
1352             if ($ismoving) {
1353                 echo '<a title="'.$strmovefull.'"'.
1354                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1355                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1356                      ' alt="'.$strmovehere.'" /></a><br />
1357                      ';
1358             }
1360             if ($mod->indent) {
1361                 echo $OUTPUT->spacer(array('height'=>12, 'width'=>(20 * $mod->indent))); // should be done with CSS instead
1362             }
1364             $extra = '';
1365             if (!empty($modinfo->cms[$modnumber]->extra)) {
1366                 $extra = $modinfo->cms[$modnumber]->extra;
1367             }
1369             if ($mod->modname == "label") {
1370                 if ($accessiblebutdim || !$mod->uservisible) {
1371                     echo '<div class="dimmed_text"><span class="accesshide">'.
1372                         get_string('hiddenfromstudents').'</span>';
1373                 } else {
1374                     echo '<div>';
1375                 }
1376                 echo format_text($extra, FORMAT_HTML, $labelformatoptions);
1377                 echo "</div>";
1378                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1379                     if (!isset($groupings)) {
1380                         $groupings = groups_get_all_groupings($course->id);
1381                     }
1382                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1383                 }
1385             } else { // Normal activity
1386                 $instancename = format_string($modinfo->cms[$modnumber]->name, true,  $course->id);
1388                 $customicon = $modinfo->cms[$modnumber]->icon;
1389                 if (!empty($customicon)) {
1390                     if (substr($customicon, 0, 4) === 'mod/') {
1391                         list($modname, $iconname) = explode('/', substr($customicon, 4), 2);
1392                         $icon = $OUTPUT->pix_url($iconname, $modname);
1393                     } else {
1394                         $icon = $OUTPUT->pix_url($customicon);
1395                     }
1396                 } else {
1397                     $icon = $OUTPUT->pix_url('icon', $mod->modname);
1398                 }
1400                 //Accessibility: for files get description via icon, this is very ugly hack!
1401                 $altname = '';
1402                 $altname = $mod->modfullname;
1403                 if (!empty($customicon)) {
1404                     $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1405                     if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1406                         $mimetype = mimeinfo_from_icon('type', $customicon);
1407                         $altname = get_mimetype_description($mimetype);
1408                     }
1409                 }
1410                 // Avoid unnecessary duplication.
1411                 if (false !== stripos($instancename, $altname)) {
1412                     $altname = '';
1413                 }
1414                 // File type after name, for alphabetic lists (screen reader).
1415                 if ($altname) {
1416                     $altname = get_accesshide(' '.$altname);
1417                 }
1419                 // We may be displaying this just in order to show information
1420                 // about visibility, without the actual link
1421                 if ($mod->uservisible) {
1422                     // Display normal module link
1423                     if (!$accessiblebutdim) {
1424                         $linkcss = '';
1425                         $accesstext  ='';
1426                     } else {
1427                         $linkcss = ' class="dimmed" ';
1428                         $accesstext = '<span class="accesshide">'.
1429                             get_string('hiddenfromstudents').': </span>';
1430                     }
1432                     echo '<a '.$linkcss.' '.$extra.
1433                          ' href="'.$CFG->wwwroot.'/mod/'.$mod->modname.'/view.php?id='.$mod->id.'">'.
1434                          '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename',$mod->modname).'" /> '.
1435                          $accesstext.'<span class="instancename">'.$instancename.$altname.'</span></a>';
1437                     if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1438                         if (!isset($groupings)) {
1439                             $groupings = groups_get_all_groupings($course->id);
1440                         }
1441                         echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1442                     }
1443                 } else {
1444                     // Display greyed-out text of link
1445                     echo '<span class="dimmed_text" '.$extra.' ><span class="accesshide">'.
1446                         get_string('notavailableyet','condition').': </span>'.
1447                         '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename', $mod->modname).'" /> <span>'.
1448                         $instancename.$altname.'</span></span>';
1449                 }
1450             }
1451             if ($usetracking && $mod->modname == 'forum') {
1452                 if ($unread = forum_tp_count_forum_unread_posts($mod, $course)) {
1453                     echo '<span class="unread"> <a href="'.$CFG->wwwroot.'/mod/forum/view.php?id='.$mod->id.'">';
1454                     if ($unread == 1) {
1455                         echo $strunreadpostsone;
1456                     } else {
1457                         print_string('unreadpostsnumber', 'forum', $unread);
1458                     }
1459                     echo '</a></span>';
1460                 }
1461             }
1463             if ($isediting) {
1464                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1465                     if (! $mod->groupmodelink = $groupbuttonslink) {
1466                         $mod->groupmode = $course->groupmode;
1467                     }
1469                 } else {
1470                     $mod->groupmode = false;
1471                 }
1472                 echo '&nbsp;&nbsp;';
1473                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1474             }
1476             // Completion
1477             $completion = $hidecompletion
1478                 ? COMPLETION_TRACKING_NONE
1479                 : $completioninfo->is_enabled($mod);
1480             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1481                 !isguestuser() && $mod->uservisible) {
1482                 $completiondata = $completioninfo->get_data($mod,true);
1483                 $completionicon = '';
1484                 if ($isediting) {
1485                     switch ($completion) {
1486                         case COMPLETION_TRACKING_MANUAL :
1487                             $completionicon = 'manual-enabled'; break;
1488                         case COMPLETION_TRACKING_AUTOMATIC :
1489                             $completionicon = 'auto-enabled'; break;
1490                         default: // wtf
1491                     }
1492                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1493                     switch($completiondata->completionstate) {
1494                         case COMPLETION_INCOMPLETE:
1495                             $completionicon = 'manual-n'; break;
1496                         case COMPLETION_COMPLETE:
1497                             $completionicon = 'manual-y'; break;
1498                     }
1499                 } else { // Automatic
1500                     switch($completiondata->completionstate) {
1501                         case COMPLETION_INCOMPLETE:
1502                             $completionicon = 'auto-n'; break;
1503                         case COMPLETION_COMPLETE:
1504                             $completionicon = 'auto-y'; break;
1505                         case COMPLETION_COMPLETE_PASS:
1506                             $completionicon = 'auto-pass'; break;
1507                         case COMPLETION_COMPLETE_FAIL:
1508                             $completionicon = 'auto-fail'; break;
1509                     }
1510                 }
1511                 if ($completionicon) {
1512                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1513                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1514                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1515                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1516                         $newstate =
1517                             $completiondata->completionstate==COMPLETION_COMPLETE
1518                             ? COMPLETION_INCOMPLETE
1519                             : COMPLETION_COMPLETE;
1520                         // In manual mode the icon is a toggle form...
1522                         // If this completion state is used by the
1523                         // conditional activities system, we need to turn
1524                         // off the JS.
1525                         if (!empty($CFG->enableavailability) &&
1526                             condition_info::completion_value_used_as_condition($course, $mod)) {
1527                             $extraclass = ' preventjs';
1528                         } else {
1529                             $extraclass = '';
1530                         }
1531                         echo "
1532 <form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>
1533 <input type='hidden' name='id' value='{$mod->id}' />
1534 <input type='hidden' name='sesskey' value='".sesskey()."' />
1535 <input type='hidden' name='completionstate' value='$newstate' />
1536 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1537 </div></form>";
1538                     } else {
1539                         // In auto mode, or when editing, the icon is just an image
1540                         echo "<span class='autocompletion'>";
1541                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1542                     }
1543                 }
1544             }
1546             // Show availability information (for someone who isn't allowed to
1547             // see the activity itself, or for staff)
1548             if (!$mod->uservisible) {
1549                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1550             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1551                 $ci = new condition_info($mod);
1552                 $fullinfo = $ci->get_full_information();
1553                 if($fullinfo) {
1554                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1555                         ? 'userrestriction_visible'
1556                         : 'userrestriction_hidden','condition',
1557                         $fullinfo).'</div>';
1558                 }
1559             }
1561             echo "</li>\n";
1562         }
1564     } elseif ($ismoving) {
1565         echo "<ul class=\"section\">\n";
1566     }
1568     if ($ismoving) {
1569         echo '<li><a title="'.$strmovefull.'"'.
1570              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1571              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1572              ' alt="'.$strmovehere.'" /></a></li>
1573              ';
1574     }
1575     if (!empty($section->sequence) || $ismoving) {
1576         echo "</ul><!--class='section'-->\n\n";
1577     }
1580 /**
1581  * Prints the menus to add activities and resources.
1582  */
1583 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1584     global $CFG, $OUTPUT;
1586     // check to see if user can add menus
1587     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1588         return false;
1589     }
1591     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1593     $resources = array();
1594     $activities = array();
1596     foreach($modnames as $modname=>$modnamestr) {
1597         if (!course_allowed_module($course, $modname)) {
1598             continue;
1599         }
1601         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1602         if (!file_exists($libfile)) {
1603             continue;
1604         }
1605         include_once($libfile);
1606         $gettypesfunc =  $modname.'_get_types';
1607         if (function_exists($gettypesfunc)) {
1608             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1609             if ($types = $gettypesfunc()) {
1610                 $menu = array();
1611                 $atype = null;
1612                 $groupname = null;
1613                 foreach($types as $type) {
1614                     if ($type->typestr === '--') {
1615                         continue;
1616                     }
1617                     if (strpos($type->typestr, '--') === 0) {
1618                         $groupname = str_replace('--', '', $type->typestr);
1619                         continue;
1620                     }
1621                     $type->type = str_replace('&amp;', '&', $type->type);
1622                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1623                         $atype = MOD_CLASS_RESOURCE;
1624                     }
1625                     $menu[$urlbase.$type->type] = $type->typestr;
1626                 }
1627                 if (!is_null($groupname)) {
1628                     if ($atype == MOD_CLASS_RESOURCE) {
1629                         $resources[] = array($groupname=>$menu);
1630                     } else {
1631                         $activities[] = array($groupname=>$menu);
1632                     }
1633                 } else {
1634                     if ($atype == MOD_CLASS_RESOURCE) {
1635                         $resources = array_merge($resources, $menu);
1636                     } else {
1637                         $activities = array_merge($activities, $menu);
1638                     }
1639                 }
1640             }
1641         } else {
1642             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1643             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1644                 $resources[$urlbase.$modname] = $modnamestr;
1645             } else {
1646                 // all other archetypes are considered activity
1647                 $activities[$urlbase.$modname] = $modnamestr;
1648             }
1649         }
1650     }
1652     $straddactivity = get_string('addactivity');
1653     $straddresource = get_string('addresource');
1655     $output  = '<div class="section_add_menus">';
1657     if (!$vertical) {
1658         $output .= '<div class="horizontal">';
1659     }
1661     if (!empty($resources)) {
1662         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1663         $select->set_help_icon('resources');
1664         $output .= $OUTPUT->render($select);
1665     }
1667     if (!empty($activities)) {
1668         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1669         $select->set_help_icon('activities');
1670         $output .= $OUTPUT->render($select);
1671     }
1673     if (!$vertical) {
1674         $output .= '</div>';
1675     }
1677     $output .= '</div>';
1679     if ($return) {
1680         return $output;
1681     } else {
1682         echo $output;
1683     }
1686 /**
1687  * Return the course category context for the category with id $categoryid, except
1688  * that if $categoryid is 0, return the system context.
1689  *
1690  * @param integer $categoryid a category id or 0.
1691  * @return object the corresponding context
1692  */
1693 function get_category_or_system_context($categoryid) {
1694     if ($categoryid) {
1695         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1696     } else {
1697         return get_context_instance(CONTEXT_SYSTEM);
1698     }
1701 /**
1702  * Rebuilds the cached list of course activities stored in the database
1703  * @param int $courseid - id of course to rebuild, empty means all
1704  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1705  */
1706 function rebuild_course_cache($courseid=0, $clearonly=false) {
1707     global $COURSE, $DB, $OUTPUT;
1709     // Destroy navigation caches
1710     navigation_cache::destroy_volatile_caches();
1712     if ($clearonly) {
1713         if (empty($courseid)) {
1714             $courseselect = array();
1715         } else {
1716             $courseselect = array('id'=>$courseid);
1717         }
1718         $DB->set_field('course', 'modinfo', null, $courseselect);
1719         // update cached global COURSE too ;-)
1720         if ($courseid == $COURSE->id or empty($courseid)) {
1721             $COURSE->modinfo = null;
1722         }
1723         // reset the fast modinfo cache
1724         $reset = 'reset';
1725         get_fast_modinfo($reset);
1726         return;
1727     }
1729     if ($courseid) {
1730         $select = array('id'=>$courseid);
1731     } else {
1732         $select = array();
1733         @set_time_limit(0);  // this could take a while!   MDL-10954
1734     }
1736     if ($rs = $DB->get_recordset("course", $select,'','id,fullname')) {
1737         foreach ($rs as $course) {
1738             $modinfo = serialize(get_array_of_activities($course->id));
1739             $DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id));
1740             // update cached global COURSE too ;-)
1741             if ($course->id == $COURSE->id) {
1742                 $COURSE->modinfo = $modinfo;
1743             }
1744         }
1745         $rs->close();
1746     }
1747     // reset the fast modinfo cache
1748     $reset = 'reset';
1749     get_fast_modinfo($reset);
1752 /**
1753  * Gets the child categories of a given courses category. Uses a static cache
1754  * to make repeat calls efficient.
1755  *
1756  * @param int $parentid the id of a course category.
1757  * @return array all the child course categories.
1758  */
1759 function get_child_categories($parentid) {
1760     static $allcategories = null;
1762     // only fill in this variable the first time
1763     if (null == $allcategories) {
1764         $allcategories = array();
1766         $categories = get_categories();
1767         foreach ($categories as $category) {
1768             if (empty($allcategories[$category->parent])) {
1769                 $allcategories[$category->parent] = array();
1770             }
1771             $allcategories[$category->parent][] = $category;
1772         }
1773     }
1775     if (empty($allcategories[$parentid])) {
1776         return array();
1777     } else {
1778         return $allcategories[$parentid];
1779     }
1782 /**
1783  * This function recursively travels the categories, building up a nice list
1784  * for display. It also makes an array that list all the parents for each
1785  * category.
1786  *
1787  * For example, if you have a tree of categories like:
1788  *   Miscellaneous (id = 1)
1789  *      Subcategory (id = 2)
1790  *         Sub-subcategory (id = 4)
1791  *   Other category (id = 3)
1792  * Then after calling this function you will have
1793  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1794  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1795  *      3 => 'Other category');
1796  * $parents = array(2 => array(1), 4 => array(1, 2));
1797  *
1798  * If you specify $requiredcapability, then only categories where the current
1799  * user has that capability will be added to $list, although all categories
1800  * will still be added to $parents, and if you only have $requiredcapability
1801  * in a child category, not the parent, then the child catgegory will still be
1802  * included.
1803  *
1804  * If you specify the option $excluded, then that category, and all its children,
1805  * are omitted from the tree. This is useful when you are doing something like
1806  * moving categories, where you do not want to allow people to move a category
1807  * to be the child of itself.
1808  *
1809  * @param array $list For output, accumulates an array categoryid => full category path name
1810  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1811  * @param string/array $requiredcapability if given, only categories where the current
1812  *      user has this capability will be added to $list. Can also be an array of capabilities,
1813  *      in which case they are all required.
1814  * @param integer $excludeid Omit this category and its children from the lists built.
1815  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1816  * @param string $path For internal use, as part of recursive calls.
1817  */
1818 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1819         $excludeid = 0, $category = NULL, $path = "") {
1821     // initialize the arrays if needed
1822     if (!is_array($list)) {
1823         $list = array();
1824     }
1825     if (!is_array($parents)) {
1826         $parents = array();
1827     }
1829     if (empty($category)) {
1830         // Start at the top level.
1831         $category = new stdClass;
1832         $category->id = 0;
1833     } else {
1834         // This is the excluded category, don't include it.
1835         if ($excludeid > 0 && $excludeid == $category->id) {
1836             return;
1837         }
1839         // Update $path.
1840         if ($path) {
1841             $path = $path.' / '.format_string($category->name);
1842         } else {
1843             $path = format_string($category->name);
1844         }
1846         // Add this category to $list, if the permissions check out.
1847         if (empty($requiredcapability)) {
1848             $list[$category->id] = $path;
1850         } else {
1851             ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1852             $requiredcapability = (array)$requiredcapability;
1853             if (has_all_capabilities($requiredcapability, $category->context)) {
1854                 $list[$category->id] = $path;
1855             }
1856         }
1857     }
1859     // Add all the children recursively, while updating the parents array.
1860     if ($categories = get_child_categories($category->id)) {
1861         foreach ($categories as $cat) {
1862             if (!empty($category->id)) {
1863                 if (isset($parents[$category->id])) {
1864                     $parents[$cat->id]   = $parents[$category->id];
1865                 }
1866                 $parents[$cat->id][] = $category->id;
1867             }
1868             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1869         }
1870     }
1873 /**
1874  * This function generates a structured array of courses and categories.
1875  *
1876  * The depth of categories is limited by $CFG->maxcategorydepth however there
1877  * is no limit on the number of courses!
1878  *
1879  * Suitable for use with the course renderers course_category_tree method:
1880  * $renderer = $PAGE->get_renderer('core','course');
1881  * echo $renderer->course_category_tree(get_course_category_tree());
1882  *
1883  * @global moodle_database $DB
1884  * @param int $id
1885  * @param int $depth
1886  */
1887 function get_course_category_tree($id = 0, $depth = 0) {
1888     global $DB, $CFG;
1889     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
1890     $categories = get_child_categories($id);
1891     $categoryids = array();
1892     foreach ($categories as $key => &$category) {
1893         if (!$category->visible && !$viewhiddencats) {
1894             unset($categories[$key]);
1895             continue;
1896         }
1897         $categoryids[$category->id] = $category;
1898         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1899             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1900             foreach ($subcategories as $subid=>$subcat) {
1901                 $categoryids[$subid] = $subcat;
1902             }
1903             $category->courses = array();
1904         }
1905     }
1907     if ($depth > 0) {
1908         // This is a recursive call so return the required array
1909         return array($categories, $categoryids);
1910     }
1912     // The depth is 0 this function has just been called so we can finish it off
1914     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1915     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1916     $sql = "SELECT
1917             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1918             $ccselect
1919             FROM {course} c
1920             $ccjoin
1921             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1922     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1923         // loop throught them
1924         foreach ($courses as $course) {
1925             if ($course->id == SITEID) {
1926                 continue;
1927             }
1928             context_instance_preload($course);
1929             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1930                 $categoryids[$course->category]->courses[$course->id] = $course;
1931             }
1932         }
1933     }
1934     return $categories;
1937 /**
1938  * Recursive function to print out all the categories in a nice format
1939  * with or without courses included
1940  */
1941 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
1942     global $CFG;
1944     // maxcategorydepth == 0 meant no limit
1945     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1946         return;
1947     }
1949     if (!$displaylist) {
1950         make_categories_list($displaylist, $parentslist);
1951     }
1953     if ($category) {
1954         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
1955             print_category_info($category, $depth, $showcourses);
1956         } else {
1957             return;  // Don't bother printing children of invisible categories
1958         }
1960     } else {
1961         $category->id = "0";
1962     }
1964     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
1965         $countcats = count($categories);
1966         $count = 0;
1967         $first = true;
1968         $last = false;
1969         foreach ($categories as $cat) {
1970             $count++;
1971             if ($count == $countcats) {
1972                 $last = true;
1973             }
1974             $up = $first ? false : true;
1975             $down = $last ? false : true;
1976             $first = false;
1978             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
1979         }
1980     }
1983 /**
1984  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
1985  */
1986 function make_categories_options() {
1987     make_categories_list($cats,$parents);
1988     foreach ($cats as $key => $value) {
1989         if (array_key_exists($key,$parents)) {
1990             if ($indent = count($parents[$key])) {
1991                 for ($i = 0; $i < $indent; $i++) {
1992                     $cats[$key] = '&nbsp;'.$cats[$key];
1993                 }
1994             }
1995         }
1996     }
1997     return $cats;
2000 /**
2001  * Prints the category info in indented fashion
2002  * This function is only used by print_whole_category_list() above
2003  */
2004 function print_category_info($category, $depth=0, $showcourses = false) {
2005     global $CFG, $DB, $OUTPUT;
2007     $strsummary = get_string('summary');
2009     $catlinkcss = null;
2010     if (!$category->visible) {
2011         $catlinkcss = array('class'=>'dimmed');
2012     }
2013     static $coursecount = null;
2014     if (null === $coursecount) {
2015         // only need to check this once
2016         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2017     }
2019     if ($showcourses and $coursecount) {
2020         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2021     } else {
2022         $catimage = "&nbsp;";
2023     }
2025     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2026     if ($showcourses and $coursecount) {
2027         echo '<div class="categorylist clearfix">';
2028         $cat = '';
2029         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2030         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2031         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2033         $html = '';
2034         if ($depth > 0) {
2035             for ($i=0; $i< $depth; $i++) {
2036                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2037                 $cat = '';
2038             }
2039         } else {
2040             $html = $cat;
2041         }
2042         echo html_writer::tag('div', $html, array('class'=>'category'));
2043         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2045         // does the depth exceed maxcategorydepth
2046         // maxcategorydepth == 0 or unset meant no limit
2047         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2048         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2049             foreach ($courses as $course) {
2050                 $linkcss = null;
2051                 if (!$course->visible) {
2052                     $linkcss = array('class'=>'dimmed');
2053                 }
2055                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2057                 // print enrol info
2058                 $courseicon = '';
2059                 if ($icons = enrol_get_course_info_icons($course)) {
2060                     foreach ($icons as $pix_icon) {
2061                         $courseicon = $OUTPUT->render($pix_icon).' ';
2062                     }
2063                 }
2065                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2067                 if ($course->summary) {
2068                     $link = new moodle_url('/course/info.php?id='.$course->id);
2069                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2070                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2071                         array('title'=>$strsummary));
2073                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2074                 }
2076                 $html = '';
2077                 for ($i=0; $i <= $depth; $i++) {
2078                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2079                     $coursecontent = '';
2080                 }
2081                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2082             }
2083         }
2084         echo '</div>';
2085     } else {
2086         echo '<div class="categorylist">';
2087         $html = '';
2088         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2089         $cat .= html_writer::tag('span', '('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2091         if ($depth > 0) {
2092             for ($i=0; $i< $depth; $i++) {
2093                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2094                 $cat = '';
2095             }
2096         } else {
2097             $html = $cat;
2098         }
2100         echo html_writer::tag('div', $html, array('class'=>'category'));
2101         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2102         echo '</div>';
2103     }
2106 /**
2107  * Print the buttons relating to course requests.
2108  *
2109  * @param object $systemcontext the system context.
2110  */
2111 function print_course_request_buttons($systemcontext) {
2112     global $CFG, $DB, $OUTPUT;
2113     if (empty($CFG->enablecourserequests)) {
2114         return;
2115     }
2116     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2117     /// Print a button to request a new course
2118         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2119     }
2120     /// Print a button to manage pending requests
2121     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2122         $disabled = !$DB->record_exists('course_request', array());
2123         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2124     }
2127 /**
2128  * Does the user have permission to edit things in this category?
2129  *
2130  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2131  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2132  */
2133 function can_edit_in_category($categoryid = 0) {
2134     $context = get_category_or_system_context($categoryid);
2135     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2138 /**
2139  * Prints the turn editing on/off button on course/index.php or course/category.php.
2140  *
2141  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2142  * @return string HTML of the editing button, or empty string, if this user is not allowed
2143  *      to see it.
2144  */
2145 function update_category_button($categoryid = 0) {
2146     global $CFG, $PAGE, $OUTPUT;
2148     // Check permissions.
2149     if (!can_edit_in_category($categoryid)) {
2150         return '';
2151     }
2153     // Work out the appropriate action.
2154     if ($PAGE->user_is_editing()) {
2155         $label = get_string('turneditingoff');
2156         $edit = 'off';
2157     } else {
2158         $label = get_string('turneditingon');
2159         $edit = 'on';
2160     }
2162     // Generate the button HTML.
2163     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2164     if ($categoryid) {
2165         $options['id'] = $categoryid;
2166         $page = 'category.php';
2167     } else {
2168         $page = 'index.php';
2169     }
2170     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2173 /**
2174  * Category is 0 (for all courses) or an object
2175  */
2176 function print_courses($category) {
2177     global $CFG, $OUTPUT;
2179     if (!is_object($category) && $category==0) {
2180         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2181         if (is_array($categories) && count($categories) == 1) {
2182             $category   = array_shift($categories);
2183             $courses    = get_courses_wmanagers($category->id,
2184                                                 'c.sortorder ASC',
2185                                                 array('summary','summaryformat'));
2186         } else {
2187             $courses    = get_courses_wmanagers('all',
2188                                                 'c.sortorder ASC',
2189                                                 array('summary','summaryformat'));
2190         }
2191         unset($categories);
2192     } else {
2193         $courses    = get_courses_wmanagers($category->id,
2194                                             'c.sortorder ASC',
2195                                             array('summary','summaryformat'));
2196     }
2198     if ($courses) {
2199         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2200         foreach ($courses as $course) {
2201             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2202             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2203                 echo html_writer::start_tag('li');
2204                 print_course($course);
2205                 echo html_writer::end_tag('li');
2206             }
2207         }
2208         echo html_writer::end_tag('ul');
2209     } else {
2210         echo $OUTPUT->heading(get_string("nocoursesyet"));
2211         $context = get_context_instance(CONTEXT_SYSTEM);
2212         if (has_capability('moodle/course:create', $context)) {
2213             $options = array();
2214             if (!empty($category->id)) {
2215                 $options['category'] = $category->id;
2216             } else {
2217                 $options['category'] = $CFG->defaultrequestcategory;
2218             }
2219             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2220             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2221             echo html_writer::end_tag('div');
2222         }
2223     }
2226 /**
2227  * Print a description of a course, suitable for browsing in a list.
2228  *
2229  * @param object $course the course object.
2230  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2231  */
2232 function print_course($course, $highlightterms = '') {
2233     global $CFG, $USER, $DB, $OUTPUT;
2235     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2237     // Rewrite file URLs so that they are correct
2238     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2240     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2241     echo html_writer::start_tag('div', array('class'=>'info'));
2242     echo html_writer::start_tag('h3', array('class'=>'name'));
2244     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2245     $linktext = highlight($highlightterms, format_string($course->fullname));
2246     $linkparams = array('title'=>get_string('entercourse'));
2247     if (empty($course->visible)) {
2248         $linkparams['class'] = 'dimmed';
2249     }
2250     echo html_writer::link($linkhref, $linktext, $linkparams);
2251     echo html_writer::end_tag('h3');
2253     /// first find all roles that are supposed to be displayed
2254     if (!empty($CFG->coursecontact)) {
2255         $managerroles = explode(',', $CFG->coursecontact);
2256         $namesarray = array();
2257         if (isset($course->managers)) {
2258             if (count($course->managers)) {
2259                 $rusers = $course->managers;
2260                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2262                  /// Rename some of the role names if needed
2263                 if (isset($context)) {
2264                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2265                 }
2267                 // keep a note of users displayed to eliminate duplicates
2268                 $usersshown = array();
2269                 foreach ($rusers as $ra) {
2271                     // if we've already displayed user don't again
2272                     if (in_array($ra->user->id,$usersshown)) {
2273                         continue;
2274                     }
2275                     $usersshown[] = $ra->user->id;
2277                     $fullname = fullname($ra->user, $canviewfullnames);
2279                     if (isset($aliasnames[$ra->roleid])) {
2280                         $ra->rolename = $aliasnames[$ra->roleid]->name;
2281                     }
2283                     $namesarray[] = format_string($ra->rolename).': '.
2284                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
2285                 }
2286             }
2287         } else {
2288             $rusers = get_role_users($managerroles, $context,
2289                                      true, '', 'r.sortorder ASC, u.lastname ASC');
2290             if (is_array($rusers) && count($rusers)) {
2291                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2293                 /// Rename some of the role names if needed
2294                 if (isset($context)) {
2295                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2296                 }
2298                 foreach ($rusers as $teacher) {
2299                     $fullname = fullname($teacher, $canviewfullnames);
2301                     /// Apply role names
2302                     if (isset($aliasnames[$teacher->roleid])) {
2303                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2304                     }
2306                     $namesarray[] = format_string($teacher->rolename).': '.
2307                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
2308                 }
2309             }
2310         }
2312         if (!empty($namesarray)) {
2313             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2314             foreach ($namesarray as $name) {
2315                 echo html_writer::tag('li', $name);
2316             }
2317             echo html_writer::end_tag('ul');
2318         }
2319     }
2320     echo html_writer::end_tag('div'); // End of info div
2322     echo html_writer::start_tag('div', array('class'=>'summary'));
2323     $options = NULL;
2324     $options->noclean = true;
2325     $options->para = false;
2326     $options->overflowdiv = true;
2327     if (!isset($course->summaryformat)) {
2328         $course->summaryformat = FORMAT_MOODLE;
2329     }
2330     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2331     if ((!isloggedin() || is_siteadmin()) && $icons = enrol_get_course_info_icons($course)) {
2332         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2333         foreach ($icons as $icon) {
2334             echo $OUTPUT->render($icon);
2335         }
2336         echo html_writer::end_tag('div'); // End of enrolmenticons div
2337     }
2338     echo html_writer::end_tag('div'); // End of summary div
2339     echo html_writer::end_tag('div'); // End of coursebox div
2342 /**
2343  * Prints custom user information on the home page.
2344  * Over time this can include all sorts of information
2345  */
2346 function print_my_moodle() {
2347     global $USER, $CFG, $DB, $OUTPUT;
2349     if (!isloggedin() or isguestuser()) {
2350         print_error('nopermissions', '', '', 'See My Moodle');
2351     }
2353     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2354     $rhosts   = array();
2355     $rcourses = array();
2356     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2357         $rcourses = get_my_remotecourses($USER->id);
2358         $rhosts   = get_my_remotehosts();
2359     }
2361     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2363         if (!empty($courses)) {
2364             echo '<ul class="unlist">';
2365             foreach ($courses as $course) {
2366                 if ($course->id == SITEID) {
2367                     continue;
2368                 }
2369                 echo '<li>';
2370                 print_course($course);
2371                 echo "</li>\n";
2372             }
2373             echo "</ul>\n";
2374         }
2376         // MNET
2377         if (!empty($rcourses)) {
2378             // at the IDP, we know of all the remote courses
2379             foreach ($rcourses as $course) {
2380                 print_remote_course($course, "100%");
2381             }
2382         } elseif (!empty($rhosts)) {
2383             // non-IDP, we know of all the remote servers, but not courses
2384             foreach ($rhosts as $host) {
2385                 print_remote_host($host, "100%");
2386             }
2387         }
2388         unset($course);
2389         unset($host);
2391         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2392             echo "<table width=\"100%\"><tr><td align=\"center\">";
2393             print_course_search("", false, "short");
2394             echo "</td><td align=\"center\">";
2395             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2396             echo "</td></tr></table>\n";
2397         }
2399     } else {
2400         if ($DB->count_records("course_categories") > 1) {
2401             echo $OUTPUT->box_start("categorybox");
2402             print_whole_category_list();
2403             echo $OUTPUT->box_end();
2404         } else {
2405             print_courses(0);
2406         }
2407     }
2411 function print_course_search($value="", $return=false, $format="plain") {
2412     global $CFG;
2413     static $count = 0;
2415     $count++;
2417     $id = 'coursesearch';
2419     if ($count > 1) {
2420         $id .= $count;
2421     }
2423     $strsearchcourses= get_string("searchcourses");
2425     if ($format == 'plain') {
2426         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2427         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2428         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2429         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2430         $output .= '<input type="submit" value="'.get_string('go').'" />';
2431         $output .= '</fieldset></form>';
2432     } else if ($format == 'short') {
2433         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2434         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2435         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2436         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2437         $output .= '<input type="submit" value="'.get_string('go').'" />';
2438         $output .= '</fieldset></form>';
2439     } else if ($format == 'navbar') {
2440         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2441         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2442         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2443         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2444         $output .= '<input type="submit" value="'.get_string('go').'" />';
2445         $output .= '</fieldset></form>';
2446     }
2448     if ($return) {
2449         return $output;
2450     }
2451     echo $output;
2454 function print_remote_course($course, $width="100%") {
2455     global $CFG, $USER;
2457     $linkcss = '';
2459     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2461     echo '<div class="coursebox remotecoursebox clearfix">';
2462     echo '<div class="info">';
2463     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2464          $linkcss.' href="'.$url.'">'
2465         .  format_string($course->fullname) .'</a><br />'
2466         . format_string($course->hostname) . ' : '
2467         . format_string($course->cat_name) . ' : '
2468         . format_string($course->shortname). '</div>';
2469     echo '</div><div class="summary">';
2470     $options = NULL;
2471     $options->noclean = true;
2472     $options->para = false;
2473     $options->overflowdiv = true;
2474     echo format_text($course->summary, $course->summaryformat, $options);
2475     echo '</div>';
2476     echo '</div>';
2479 function print_remote_host($host, $width="100%") {
2480     global $OUTPUT;
2482     $linkcss = '';
2484     echo '<div class="coursebox clearfix">';
2485     echo '<div class="info">';
2486     echo '<div class="name">';
2487     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2488     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2489         . s($host['name']).'</a> - ';
2490     echo $host['count'] . ' ' . get_string('courses');
2491     echo '</div>';
2492     echo '</div>';
2493     echo '</div>';
2497 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2499 function add_course_module($mod) {
2500     global $DB;
2502     $mod->added = time();
2503     unset($mod->id);
2505     return $DB->insert_record("course_modules", $mod);
2508 /**
2509  * Returns course section - creates new if does not exist yet.
2510  * @param int $relative section number
2511  * @param int $courseid
2512  * @return object $course_section object
2513  */
2514 function get_course_section($section, $courseid) {
2515     global $DB;
2517     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2518         return $cw;
2519     }
2520     $cw = new stdClass();
2521     $cw->course   = $courseid;
2522     $cw->section  = $section;
2523     $cw->summary  = "";
2524     $cw->summaryformat = FORMAT_HTML;
2525     $cw->sequence = "";
2526     $id = $DB->insert_record("course_sections", $cw);
2527     return $DB->get_record("course_sections", array("id"=>$id));
2529 /**
2530  * Given a full mod object with section and course already defined, adds this module to that section.
2531  *
2532  * @param object $mod
2533  * @param int $beforemod An existing ID which we will insert the new module before
2534  * @return int The course_sections ID where the mod is inserted
2535  */
2536 function add_mod_to_section($mod, $beforemod=NULL) {
2537     global $DB;
2539     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2541         $section->sequence = trim($section->sequence);
2543         if (empty($section->sequence)) {
2544             $newsequence = "$mod->coursemodule";
2546         } else if ($beforemod) {
2547             $modarray = explode(",", $section->sequence);
2549             if ($key = array_keys($modarray, $beforemod->id)) {
2550                 $insertarray = array($mod->id, $beforemod->id);
2551                 array_splice($modarray, $key[0], 1, $insertarray);
2552                 $newsequence = implode(",", $modarray);
2554             } else {  // Just tack it on the end anyway
2555                 $newsequence = "$section->sequence,$mod->coursemodule";
2556             }
2558         } else {
2559             $newsequence = "$section->sequence,$mod->coursemodule";
2560         }
2562         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2563         return $section->id;     // Return course_sections ID that was used.
2565     } else {  // Insert a new record
2566         $section->course   = $mod->course;
2567         $section->section  = $mod->section;
2568         $section->summary  = "";
2569         $section->summaryformat = FORMAT_HTML;
2570         $section->sequence = $mod->coursemodule;
2571         return $DB->insert_record("course_sections", $section);
2572     }
2575 function set_coursemodule_groupmode($id, $groupmode) {
2576     global $DB;
2577     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2580 function set_coursemodule_idnumber($id, $idnumber) {
2581     global $DB;
2582     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2585 /**
2586 * $prevstateoverrides = true will set the visibility of the course module
2587 * to what is defined in visibleold. This enables us to remember the current
2588 * visibility when making a whole section hidden, so that when we toggle
2589 * that section back to visible, we are able to return the visibility of
2590 * the course module back to what it was originally.
2591 */
2592 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2593     global $DB, $CFG;
2594     require_once($CFG->libdir.'/gradelib.php');
2596     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2597         return false;
2598     }
2599     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2600         return false;
2601     }
2602     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2603         foreach($events as $event) {
2604             if ($visible) {
2605                 show_event($event);
2606             } else {
2607                 hide_event($event);
2608             }
2609         }
2610     }
2612     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2613     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2614     if ($grade_items) {
2615         foreach ($grade_items as $grade_item) {
2616             $grade_item->set_hidden(!$visible);
2617         }
2618     }
2620     if ($prevstateoverrides) {
2621         if ($visible == '0') {
2622             // Remember the current visible state so we can toggle this back.
2623             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2624         } else {
2625             // Get the previous saved visible states.
2626             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2627         }
2628     }
2629     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2632 /**
2633  * Delete a course module and any associated data at the course level (events)
2634  * Until 1.5 this function simply marked a deleted flag ... now it
2635  * deletes it completely.
2636  *
2637  */
2638 function delete_course_module($id) {
2639     global $CFG, $DB;
2640     require_once($CFG->libdir.'/gradelib.php');
2641     require_once($CFG->dirroot.'/blog/lib.php');
2643     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2644         return true;
2645     }
2646     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2647     //delete events from calendar
2648     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2649         foreach($events as $event) {
2650             delete_event($event->id);
2651         }
2652     }
2653     //delete grade items, outcome items and grades attached to modules
2654     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2655                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2656         foreach ($grade_items as $grade_item) {
2657             $grade_item->delete('moddelete');
2658         }
2659     }
2660     // Delete completion and availability data; it is better to do this even if the
2661     // features are not turned on, in case they were turned on previously (these will be
2662     // very quick on an empty table)
2663     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2664     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2666     delete_context(CONTEXT_MODULE, $cm->id);
2667     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2670 function delete_mod_from_section($mod, $section) {
2671     global $DB;
2673     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2675         $modarray = explode(",", $section->sequence);
2677         if ($key = array_keys ($modarray, $mod)) {
2678             array_splice($modarray, $key[0], 1);
2679             $newsequence = implode(",", $modarray);
2680             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2681         } else {
2682             return false;
2683         }
2685     }
2686     return false;
2689 /**
2690  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2691  *
2692  * @param object $course
2693  * @param int $section
2694  * @param int $move (-1 or 1)
2695  */
2696 function move_section($course, $section, $move) {
2697 /// Moves a whole course section up and down within the course
2698     global $USER, $DB;
2700     if (!$move) {
2701         return true;
2702     }
2704     $sectiondest = $section + $move;
2706     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2707         return false;
2708     }
2710     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2711         return false;
2712     }
2714     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2715         return false;
2716     }
2718     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2719     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2721     // if the focus is on the section that is being moved, then move the focus along
2722     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2723         course_set_display($course->id, $sectiondest);
2724     }
2726     // Check for duplicates and fix order if needed.
2727     // There is a very rare case that some sections in the same course have the same section id.
2728     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2729     $n = 0;
2730     foreach ($sections as $section) {
2731         if ($section->section != $n) {
2732             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2733         }
2734         $n++;
2735     }
2736     return true;
2739 /**
2740  * Moves a section within a course, from a position to another.
2741  * Be very careful: $section and $destination refer to section number,
2742  * not id!.
2743  *
2744  * @param object $course
2745  * @param int $section Section number (not id!!!)
2746  * @param int $destination
2747  * @return boolean Result
2748  */
2749 function move_section_to($course, $section, $destination) {
2750 /// Moves a whole course section up and down within the course
2751     global $USER, $DB;
2753     if (!$destination && $destination != 0) {
2754         return true;
2755     }
2757     if ($destination > $course->numsections) {
2758         return false;
2759     }
2761     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2762     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2763             'section ASC, id ASC', 'id, section')) {
2764         return false;
2765     }
2767     $sections = reorder_sections($sections, $section, $destination);
2769     // Update all sections
2770     foreach ($sections as $id => $position) {
2771         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2772     }
2774     // if the focus is on the section that is being moved, then move the focus along
2775     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2776         course_set_display($course->id, $destination);
2777     }
2778     return true;
2781 /**
2782  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2783  * an original position number and a target position number, rebuilds the array so that the
2784  * move is made without any duplication of section positions.
2785  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2786  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2787  *
2788  * @param array $sections
2789  * @param int $origin_position
2790  * @param int $target_position
2791  * @return array
2792  */
2793 function reorder_sections($sections, $origin_position, $target_position) {
2794     if (!is_array($sections)) {
2795         return false;
2796     }
2798     // We can't move section position 0
2799     if ($origin_position < 1) {
2800         echo "We can't move section position 0";
2801         return false;
2802     }
2804     // Locate origin section in sections array
2805     if (!$origin_key = array_search($origin_position, $sections)) {
2806         echo "searched position not in sections array";
2807         return false; // searched position not in sections array
2808     }
2810     // Extract origin section
2811     $origin_section = $sections[$origin_key];
2812     unset($sections[$origin_key]);
2814     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2815     $found = false;
2816     $append_array = array();
2817     foreach ($sections as $id => $position) {
2818         if ($found) {
2819             $append_array[$id] = $position;
2820             unset($sections[$id]);
2821         }
2822         if ($position == $target_position) {
2823             $found = true;
2824         }
2825     }
2827     // Append moved section
2828     $sections[$origin_key] = $origin_section;
2830     // Append rest of array (if applicable)
2831     if (!empty($append_array)) {
2832         foreach ($append_array as $id => $position) {
2833             $sections[$id] = $position;
2834         }
2835     }
2837     // Renumber positions
2838     $position = 0;
2839     foreach ($sections as $id => $p) {
2840         $sections[$id] = $position;
2841         $position++;
2842     }
2844     return $sections;
2848 /**
2849  * Move the module object $mod to the specified $section
2850  * If $beforemod exists then that is the module
2851  * before which $modid should be inserted
2852  * All parameters are objects
2853  */
2854 function moveto_module($mod, $section, $beforemod=NULL) {
2855     global $DB, $OUTPUT;
2857 /// Remove original module from original section
2858     if (! delete_mod_from_section($mod->id, $mod->section)) {
2859         echo $OUTPUT->notification("Could not delete module from existing section");
2860     }
2862 /// Update module itself if necessary
2864     if ($mod->section != $section->id) {
2865         $mod->section = $section->id;
2866         $DB->update_record("course_modules", $mod);
2867         // if moving to a hidden section then hide module
2868         if (!$section->visible) {
2869             set_coursemodule_visible($mod->id, 0);
2870         }
2871     }
2873 /// Add the module into the new section
2875     $mod->course       = $section->course;
2876     $mod->section      = $section->section;  // need relative reference
2877     $mod->coursemodule = $mod->id;
2879     if (! add_mod_to_section($mod, $beforemod)) {
2880         return false;
2881     }
2883     return true;
2886 function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
2887     global $CFG, $USER, $DB, $OUTPUT;
2889     static $str;
2890     static $sesskey;
2892     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
2893     // no permission to edit
2894     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
2895         return false;
2896     }
2898     if (!isset($str)) {
2899         $str->assign         = get_string("assignroles", 'role');
2900         $str->delete         = get_string("delete");
2901         $str->move           = get_string("move");
2902         $str->moveup         = get_string("moveup");
2903         $str->movedown       = get_string("movedown");
2904         $str->moveright      = get_string("moveright");
2905         $str->moveleft       = get_string("moveleft");
2906         $str->update         = get_string("update");
2907         $str->duplicate      = get_string("duplicate");
2908         $str->hide           = get_string("hide");
2909         $str->show           = get_string("show");
2910         $str->clicktochange  = get_string("clicktochange");
2911         $str->forcedmode     = get_string("forcedmode");
2912         $str->groupsnone     = get_string("groupsnone");
2913         $str->groupsseparate = get_string("groupsseparate");
2914         $str->groupsvisible  = get_string("groupsvisible");
2915         $sesskey = sesskey();
2916     }
2918     if ($section >= 0) {
2919         $section = '&amp;sr='.$section;   // Section return
2920     } else {
2921         $section = '';
2922     }
2924     if ($absolute) {
2925         $path = $CFG->wwwroot.'/course';
2926     } else {
2927         $path = '.';
2928     }
2929     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2930         if ($mod->visible) {
2931             $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
2932                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2933                         ' src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" '.
2934                         ' alt="'.$str->hide.'" /></a>'."\n";
2935         } else {
2936             $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
2937                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2938                         ' src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" '.
2939                         ' alt="'.$str->show.'" /></a>'."\n";
2940         }
2941     } else {
2942         $hideshow = '';
2943     }
2945     if ($mod->groupmode !== false) {
2946         if ($mod->groupmode == SEPARATEGROUPS) {
2947             $grouptitle = $str->groupsseparate;
2948             $groupclass = 'editing_groupsseparate';
2949             $groupimage = $OUTPUT->pix_url('t/groups') . '';
2950             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
2951         } else if ($mod->groupmode == VISIBLEGROUPS) {
2952             $grouptitle = $str->groupsvisible;
2953             $groupclass = 'editing_groupsvisible';
2954             $groupimage = $OUTPUT->pix_url('t/groupv') . '';
2955             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
2956         } else {
2957             $grouptitle = $str->groupsnone;
2958             $groupclass = 'editing_groupsnone';
2959             $groupimage = $OUTPUT->pix_url('t/groupn') . '';
2960             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
2961         }
2962         if ($mod->groupmodelink) {
2963             $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
2964                          '<img src="'.$groupimage.'" class="iconsmall" '.
2965                          'alt="'.$grouptitle.'" /></a>';
2966         } else {
2967             $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
2968                          ' src="'.$groupimage.'" class="iconsmall" '.
2969                          'alt="'.$grouptitle.'" />';
2970         }
2971     } else {
2972         $groupmode = "";
2973     }
2975     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2976         if ($moveselect) {
2977             $move =     '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
2978                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2979                         ' src="'.$OUTPUT->pix_url('t/move') . '" class="iconsmall" '.
2980                         ' alt="'.$str->move.'" /></a>'."\n";
2981         } else {
2982             $move =     '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
2983                         '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
2984                         ' src="'.$OUTPUT->pix_url('t/up') . '" class="iconsmall" '.
2985                         ' alt="'.$str->moveup.'" /></a>'."\n".
2986                         '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
2987                         '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
2988                         ' src="'.$OUTPUT->pix_url('t/down') . '" class="iconsmall" '.
2989                         ' alt="'.$str->movedown.'" /></a>'."\n";
2990         }
2991     } else {
2992         $move = '';
2993     }
2995     $leftright = '';
2996     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2998         if (right_to_left()) {   // Exchange arrows on RTL
2999             $rightarrow = 't/left';
3000             $leftarrow  = 't/right';
3001         } else {
3002             $rightarrow = 't/right';
3003             $leftarrow  = 't/left';
3004         }
3006         if ($indent > 0) {
3007             $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
3008                         '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3009                         ' src="'.$OUTPUT->pix_url($leftarrow).'" class="iconsmall" '.
3010                         ' alt="'.$str->moveleft.'" /></a>'."\n";
3011         }
3012         if ($indent >= 0) {
3013             $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
3014                         '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
3015                         ' src="'.$OUTPUT->pix_url($rightarrow).'" class="iconsmall" '.
3016                         ' alt="'.$str->moveright.'" /></a>'."\n";
3017         }
3018     }
3019     if (has_capability('moodle/course:managegroups', $modcontext)){
3020         $context = get_context_instance(CONTEXT_MODULE, $mod->id);
3021         $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
3022             $context->id.'"><img src="'.$OUTPUT->pix_url('i/roles') . '" alt="'.$str->assign.'" class="iconsmall"/></a>';
3023     } else {
3024         $assign = '';
3025     }
3027     return '<span class="commands">'."\n".$leftright.$move.
3028            '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
3029            '&amp;sesskey='.$sesskey.$section.'"><img'.
3030            ' src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" '.
3031            ' alt="'.$str->update.'" /></a>'."\n".
3032            '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
3033            '&amp;sesskey='.$sesskey.$section.'"><img'.
3034            ' src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" '.
3035            ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
3038 /**
3039  * given a course object with shortname & fullname, this function will
3040  * truncate the the number of chars allowed and add ... if it was too long
3041  */
3042 function course_format_name ($course,$max=100) {
3044     $str = $course->shortname.': '. $course->fullname;
3045     if (strlen($str) <= $max) {
3046         return $str;
3047     }
3048     else {
3049         return substr($str,0,$max-3).'...';
3050     }
3053 function update_restricted_mods($course, $mods) {
3054     global $DB;
3056 /// Delete all the current restricted list
3057     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3059     if (empty($course->restrictmodules)) {
3060         return;   // We're done
3061     }
3063 /// Insert the new list of restricted mods
3064     foreach ($mods as $mod) {
3065         if ($mod == 0) {
3066             continue; // this is the 'allow none' option
3067         }
3068         $am = new stdClass();
3069         $am->course = $course->id;
3070         $am->module = $mod;
3071         $DB->insert_record('course_allowed_modules',$am);
3072     }
3075 /**
3076  * This function will take an int (module id) or a string (module name)
3077  * and return true or false, whether it's allowed in the given course (object)
3078  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3079  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3080  */
3082 function course_allowed_module($course,$mod) {
3083     global $DB;
3085     if (empty($course->restrictmodules)) {
3086         return true;
3087     }
3089     // Admins and admin-like people who can edit everything can also add anything.
3090     // Originally there was a course:update test only, but it did not match the test in course edit form
3091     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3092         return true;
3093     }
3095     if (is_numeric($mod)) {
3096         $modid = $mod;
3097     } else if (is_string($mod)) {
3098         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3099     }
3100     if (empty($modid)) {
3101         return false;
3102     }
3104     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3107 /**
3108  * Recursively delete category including all subcategories and courses.
3109  * @param stdClass $category
3110  * @param boolean $showfeedback display some notices
3111  * @return array return deleted courses
3112  */
3113 function category_delete_full($category, $showfeedback=true) {
3114     global $CFG, $DB;
3115     require_once($CFG->libdir.'/gradelib.php');
3116     require_once($CFG->libdir.'/questionlib.php');
3117     require_once($CFG->dirroot.'/cohort/lib.php');
3119     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3120         foreach ($children as $childcat) {
3121             category_delete_full($childcat, $showfeedback);
3122         }
3123     }
3125     $deletedcourses = array();
3126     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3127         foreach ($courses as $course) {
3128             if (!delete_course($course, false)) {
3129                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3130             }
3131             $deletedcourses[] = $course;
3132         }
3133     }
3135     // move or delete cohorts in this context
3136     cohort_delete_category($category);
3138     // now delete anything that may depend on course category context
3139     grade_course_category_delete($category->id, 0, $showfeedback);
3140     if (!question_delete_course_category($category, 0, $showfeedback)) {
3141         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3142     }
3144     // finally delete the category and it's context
3145     $DB->delete_records('course_categories', array('id'=>$category->id));
3146     delete_context(CONTEXT_COURSECAT, $category->id);
3148     events_trigger('course_category_deleted', $category);
3150     return $deletedcourses;
3153 /**
3154  * Delete category, but move contents to another category.
3155  * @param object $ccategory
3156  * @param int $newparentid category id
3157  * @return bool status
3158  */
3159 function category_delete_move($category, $newparentid, $showfeedback=true) {
3160     global $CFG, $DB, $OUTPUT;
3161     require_once($CFG->libdir.'/gradelib.php');
3162     require_once($CFG->libdir.'/questionlib.php');
3163     require_once($CFG->dirroot.'/cohort/lib.php');
3165     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3166         return false;
3167     }
3169     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3170         foreach ($children as $childcat) {
3171             move_category($childcat, $newparentcat);
3172         }
3173     }
3175     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3176         if (!move_courses(array_keys($courses), $newparentid)) {
3177             echo $OUTPUT->notification("Error moving courses");
3178             return false;
3179         }
3180         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3181     }
3183     // move or delete cohorts in this context
3184     cohort_delete_category($category);
3186     // now delete anything that may depend on course category context
3187     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3188     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3189         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3190         return false;
3191     }
3193     // finally delete the category and it's context
3194     $DB->delete_records('course_categories', array('id'=>$category->id));
3195     delete_context(CONTEXT_COURSECAT, $category->id);
3197     events_trigger('course_category_deleted', $category);
3199     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3201     return true;
3204 /**
3205  * Efficiently moves many courses around while maintaining
3206  * sortorder in order.
3207  *
3208  * @param array $courseids is an array of course ids
3209  * @param int $categoryid
3210  * @return bool success
3211  */
3212 function move_courses($courseids, $categoryid) {
3213     global $CFG, $DB, $OUTPUT;
3215     if (empty($courseids)) {
3216         // nothing to do
3217         return;
3218     }
3220     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3221         return false;
3222     }
3224     $courseids = array_reverse($courseids);
3225     $i = 1;
3227     foreach ($courseids as $courseid) {
3228         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3229             $course->category  = $category->id;
3230             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3231             if ($category->visible == 0) {
3232                 // hide the course when moving into hidden category,
3233                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3234                 $course->visible = 0;
3235             }
3237             $DB->update_record('course', $course);
3239             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3240             $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3241             context_moved($context, $newparent);
3242         }
3243     }
3244     fix_course_sortorder();
3246     return true;
3249 /**
3250  * Hide course category and child course and subcategories
3251  * @param stdClass $category
3252  * @return void
3253  */
3254 function course_category_hide($category) {
3255     global $DB;
3257     $category->visible = 0;
3258     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3259     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3260     $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($category->id)); // store visible flag so that we can return to it if we immediately unhide
3261     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3262     // get all child categories and hide too
3263     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3264         foreach ($subcats as $cat) {
3265             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3266             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3267             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3268             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3269         }
3270     }
3273 /**
3274  * Show course category and child course and subcategories
3275  * @param stdClass $category
3276  * @return void
3277  */
3278 function course_category_show($category) {
3279     global $DB;
3281     $category->visible = 1;
3282     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3283     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3284     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3285     // get all child categories and unhide too
3286     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3287         foreach ($subcats as $cat) {
3288             if ($cat->visibleold) {
3289                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3290             }
3291             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3292         }
3293     }
3296 /**
3297  * Efficiently moves a category - NOTE that this can have
3298  * a huge impact access-control-wise...
3299  */
3300 function move_category($category, $newparentcat) {
3301     global $CFG, $DB;
3303     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3305     $hidecat = false;
3306     if (empty($newparentcat->id)) {
3307         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3309         $newparent = get_context_instance(CONTEXT_SYSTEM);
3311     } else {
3312         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3313         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3315         if (!$newparentcat->visible and $category->visible) {
3316             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3317             $hidecat = true;
3318         }
3319     }
3321     context_moved($context, $newparent);
3323     // now make it last in new category
3324     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3326     // and fix the sortorders
3327     fix_course_sortorder();
3329     if ($hidecat) {
3330         course_category_hide($category);
3331     }
3334 /**
3335  * Returns the display name of the given section that the course prefers.
3336  *
3337  * This function utilizes a callback that can be implemented within the course
3338  * formats lib.php file to customize the display name that is used to reference
3339  * the section.
3340  *
3341  * By default (if callback is not defined) the method
3342  * {@see get_numeric_section_name} is called instead.
3343  *
3344  * @param stdClass $course The course to get the section name for
3345  * @param stdClass $section Section object from database
3346  * @return Display name that the course format prefers, e.g. "Week 2"
3347  *
3348  * @see get_generic_section_name
3349  */
3350 function get_section_name(stdClass $course, stdClass $section) {
3351     global $CFG;
3353     /// Inelegant hack for bug 3408
3354     if ($course->format == 'site') {
3355         return get_string('site');
3356     }
3358     // Use course formatter callback if it exists
3359     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3360     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3361     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3362         require_once $namingfile;
3363     }
3364     if (function_exists($namingfunction)) {
3365         return $namingfunction($course, $section);
3366     }
3368     // else, default behavior:
3369     return get_generic_section_name($course->format, $section);
3372 /**
3373  * Gets the generic section name for a courses section.
3374  *
3375  * @param string $format Course format ID e.g. 'weeks' $course->format
3376  * @param stdClass $section Section object from database
3377  * @return Display name that the course format prefers, e.g. "Week 2"
3378  */
3379 function get_generic_section_name($format, stdClass $section) {
3380     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3384 function course_format_uses_sections($format) {
3385     global $CFG;
3387     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3388     $featurefunction = 'callback_'.$format.'_uses_sections';
3389     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3390         require_once $featurefile;
3391     }
3392     if (function_exists($featurefunction)) {
3393         return $featurefunction();
3394     }
3396     return false;
3399 /**
3400  * Returns the information about the ajax support in the given source format
3401  *
3402  * The returned object's property (boolean)capable indicates that
3403  * the course format supports Moodle course ajax features.
3404  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3405  *
3406  * @param string $format
3407  * @return stdClass
3408  */
3409 function course_format_ajax_support($format) {
3410     global $CFG;
3412     // set up default values
3413     $ajaxsupport = new stdClass();
3414     $ajaxsupport->capable = false;
3415     $ajaxsupport->testedbrowsers = array();
3417     // get the information from the course format library
3418     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3419     $featurefunction = 'callback_'.$format.'_ajax_support';
3420     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3421         require_once $featurefile;
3422     }
3423     if (function_exists($featurefunction)) {
3424         $formatsupport = $featurefunction();
3425         if (isset($formatsupport->capable)) {
3426             $ajaxsupport->capable = $formatsupport->capable;
3427         }
3428         if (is_array($formatsupport->testedbrowsers)) {
3429             $ajaxsupport->testedbrowsers = $formatsupport->testedbrowsers;
3430         }
3431     }
3433     return $ajaxsupport;
3436 /**
3437  * Can the current user delete this course?
3438  * Course creators have exception,
3439  * 1 day after the creation they can sill delete the course.
3440  * @param int $courseid
3441  * @return boolean
3442  */
3443 function can_delete_course($courseid) {
3444     global $USER, $DB;
3446     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3448     if (has_capability('moodle/course:delete', $context)) {
3449         return true;
3450     }
3452     // hack: now try to find out if creator created this course recently (1 day)
3453     if (!has_capability('moodle/course:create', $context)) {
3454         return false;
3455     }
3457     $since = time() - 60*60*24;
3459     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3460     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3462     return $DB->record_exists_select('log', $select, $params);
3465 /**
3466  * Save the Your name for 'Some role' strings.
3467  *
3468  * @param integer $courseid the id of this course.
3469  * @param array $data the data that came from the course settings form.
3470  */
3471 function save_local_role_names($courseid, $data) {
3472     global $DB;
3473     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3475     foreach ($data as $fieldname => $value) {
3476         if (strpos($fieldname, 'role_') !== 0) {
3477             continue;
3478         }
3479         list($ignored, $roleid) = explode('_', $fieldname);
3481         // make up our mind whether we want to delete, update or insert
3482         if (!$value) {
3483             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3485         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3486             $rolename->name = $value;
3487             $DB->update_record('role_names', $rolename);
3489         } else {
3490             $rolename = new stdClass;
3491             $rolename->contextid = $context->id;
3492             $rolename->roleid = $roleid;
3493             $rolename->name = $value;
3494             $DB->insert_record('role_names', $rolename);
3495         }
3496     }
3499 /**
3500  * Create a course and either return a $course object
3501  *
3502  * Please note this functions does not verify any access control,
3503  * the calling code is responsible for all validation (usually it is the form definition).
3504  *
3505  * @param array $editoroptions course description editor options
3506  * @param object $data  - all the data needed for an entry in the 'course' table
3507  * @return object new course instance
3508  */
3509 function create_course($data, $editoroptions = NULL) {
3510     global $CFG, $DB;
3512     //check the categoryid - must be given for all new courses
3513     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3515     //check if the shortname already exist
3516     if (!empty($data->shortname)) {
3517         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3518             throw new moodle_exception('shortnametaken');
3519         }
3520     }
3522     //check if the id number already exist
3523     if (!empty($data->idnumber)) {
3524         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3525             throw new moodle_exception('idnumbertaken');
3526         }
3527     }
3529     $data->timecreated  = time();
3530     $data->timemodified = $data->timecreated;
3532     // place at beginning of any category
3533     $data->sortorder = 0;
3535     if ($editoroptions) {
3536         // summary text is updated later, we need context to store the files first
3537         $data->summary = '';
3538         $data->summary_format = FORMAT_HTML;
3539     }
3541     if (!isset($data->visible)) {
3542         // data not from form, add missing visibility info
3543         $data->visible = $category->visible;
3544     }
3545     $data->visibleold = $data->visible;
3547    &nbs