MDL-13379 mnet: course overview at my home page displays remote courses, too
[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, array $remote_courses=array()) {
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         $attributes = array('title' => s($course->fullname));
864         if (empty($course->visible)) {
865             $attributes['class'] = 'dimmed';
866         }
867         echo $OUTPUT->heading(html_writer::link(
868             new moodle_url('/course/view.php', array('id' => $course->id)), format_string($course->fullname), $attributes), 3);
869         if (array_key_exists($course->id,$htmlarray)) {
870             foreach ($htmlarray[$course->id] as $modname => $html) {
871                 echo $html;
872             }
873         }
874         echo $OUTPUT->box_end();
875     }
877     if (!empty($remote_courses)) {
878         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
879     }
880     foreach ($remote_courses as $course) {
881         echo $OUTPUT->box_start('coursebox');
882         $attributes = array('title' => s($course->fullname));
883         echo $OUTPUT->heading(html_writer::link(
884             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
885             format_string($course->shortname),
886             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
887         echo $OUTPUT->box_end();
888     }
892 /**
893  * This function trawls through the logs looking for
894  * anything new since the user's last login
895  */
896 function print_recent_activity($course) {
897     // $course is an object
898     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
900     $context = get_context_instance(CONTEXT_COURSE, $course->id);
902     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
904     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
906     if (!isguestuser()) {
907         if (!empty($USER->lastcourseaccess[$course->id])) {
908             if ($USER->lastcourseaccess[$course->id] > $timestart) {
909                 $timestart = $USER->lastcourseaccess[$course->id];
910             }
911         }
912     }
914     echo '<div class="activitydate">';
915     echo get_string('activitysince', '', userdate($timestart));
916     echo '</div>';
917     echo '<div class="activityhead">';
919     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
921     echo "</div>\n";
923     $content = false;
925 /// Firstly, have there been any new enrolments?
927     $users = get_recent_enrolments($course->id, $timestart);
929     //Accessibility: new users now appear in an <OL> list.
930     if ($users) {
931         echo '<div class="newusers">';
932         echo $OUTPUT->heading(get_string("newusers").':', 3);
933         $content = true;
934         echo "<ol class=\"list\">\n";
935         foreach ($users as $user) {
936             $fullname = fullname($user, $viewfullnames);
937             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
938         }
939         echo "</ol>\n</div>\n";
940     }
942 /// Next, have there been any modifications to the course structure?
944     $modinfo =& get_fast_modinfo($course);
946     $changelist = array();
948     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
949                                             module = 'course' AND
950                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
951                                     array($timestart, $course->id), "id ASC");
953     if ($logs) {
954         $actions  = array('add mod', 'update mod', 'delete mod');
955         $newgones = array(); // added and later deleted items
956         foreach ($logs as $key => $log) {
957             if (!in_array($log->action, $actions)) {
958                 continue;
959             }
960             $info = explode(' ', $log->info);
962             if ($info[0] == 'label') {     // Labels are ignored in recent activity
963                 continue;
964             }
966             if (count($info) != 2) {
967                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
968                 continue;
969             }
971             $modname    = $info[0];
972             $instanceid = $info[1];
974             if ($log->action == 'delete mod') {
975                 // unfortunately we do not know if the mod was visible
976                 if (!array_key_exists($log->info, $newgones)) {
977                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
978                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
979                 }
980             } else {
981                 if (!isset($modinfo->instances[$modname][$instanceid])) {
982                     if ($log->action == 'add mod') {
983                         // do not display added and later deleted activities
984                         $newgones[$log->info] = true;
985                     }
986                     continue;
987                 }
988                 $cm = $modinfo->instances[$modname][$instanceid];
989                 if (!$cm->uservisible) {
990                     continue;
991                 }
993                 if ($log->action == 'add mod') {
994                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
995                     $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>");
997                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
998                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
999                     $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>");
1000                 }
1001             }
1002         }
1003     }
1005     if (!empty($changelist)) {
1006         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
1007         $content = true;
1008         foreach ($changelist as $changeinfo => $change) {
1009             echo '<p class="activity">'.$change['text'].'</p>';
1010         }
1011     }
1013 /// Now display new things from each module
1015     $usedmodules = array();
1016     foreach($modinfo->cms as $cm) {
1017         if (isset($usedmodules[$cm->modname])) {
1018             continue;
1019         }
1020         if (!$cm->uservisible) {
1021             continue;
1022         }
1023         $usedmodules[$cm->modname] = $cm->modname;
1024     }
1026     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
1027         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1028             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1029             $print_recent_activity = $modname.'_print_recent_activity';
1030             if (function_exists($print_recent_activity)) {
1031                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1032                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
1033             }
1034         } else {
1035             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
1036         }
1037     }
1039     if (! $content) {
1040         echo '<p class="message">'.get_string('nothingnew').'</p>';
1041     }
1044 /**
1045  * For a given course, returns an array of course activity objects
1046  * Each item in the array contains he following properties:
1047  */
1048 function get_array_of_activities($courseid) {
1049 //  cm - course module id
1050 //  mod - name of the module (eg forum)
1051 //  section - the number of the section (eg week or topic)
1052 //  name - the name of the instance
1053 //  visible - is the instance visible or not
1054 //  groupingid - grouping id
1055 //  groupmembersonly - is this instance visible to group members only
1056 //  extra - contains extra string to include in any link
1057     global $CFG, $DB;
1058     if(!empty($CFG->enableavailability)) {
1059         require_once($CFG->libdir.'/conditionlib.php');
1060     }
1062     $course = $DB->get_record('course', array('id'=>$courseid));
1064     if (empty($course)) {
1065         throw new moodle_exception('courseidnotfound');
1066     }
1068     $mod = array();
1070     $rawmods = get_course_mods($courseid);
1071     if (empty($rawmods)) {
1072         return $mod; // always return array
1073     }
1075     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1076        foreach ($sections as $section) {
1077            if (!empty($section->sequence)) {
1078                $sequence = explode(",", $section->sequence);
1079                foreach ($sequence as $seq) {
1080                    if (empty($rawmods[$seq])) {
1081                        continue;
1082                    }
1083                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1084                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1085                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1086                    $mod[$seq]->section          = $section->section;
1087                    $mod[$seq]->idnumber         = $rawmods[$seq]->idnumber;
1088                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1089                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1090                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1091                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1092                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1093                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1094                    $mod[$seq]->extra            = "";
1095                    if(!empty($CFG->enableavailability)) {
1096                        condition_info::fill_availability_conditions($rawmods[$seq]);
1097                        $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1098                        $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1099                        $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1100                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1101                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1102                    }
1104                    $modname = $mod[$seq]->mod;
1105                    $functionname = $modname."_get_coursemodule_info";
1107                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1108                        continue;
1109                    }
1111                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1113                    if (function_exists($functionname)) {
1114                        if ($info = $functionname($rawmods[$seq])) {
1115                            if (!empty($info->extra)) {
1116                                $mod[$seq]->extra = $info->extra;
1117                            }
1118                            if (!empty($info->icon)) {
1119                                $mod[$seq]->icon = $info->icon;
1120                            }
1121                            if (!empty($info->iconcomponent)) {
1122                                $mod[$seq]->iconcomponent = $info->iconcomponent;
1123                            }
1124                            if (!empty($info->name)) {
1125                                $mod[$seq]->name = $info->name;
1126                            }
1127                        }
1128                    }
1129                    if (!isset($mod[$seq]->name)) {
1130                        $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1131                    }
1132                }
1133             }
1134         }
1135     }
1136     return $mod;
1140 /**
1141  * Returns a number of useful structures for course displays
1142  */
1143 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1144     global $CFG, $DB, $COURSE;
1146     $mods          = array();    // course modules indexed by id
1147     $modnames      = array();    // all course module names (except resource!)
1148     $modnamesplural= array();    // all course module names (plural form)
1149     $modnamesused  = array();    // course module names used
1151     if ($allmods = $DB->get_records("modules")) {
1152         foreach ($allmods as $mod) {
1153             if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1154                 continue;
1155             }
1156             if ($mod->visible) {
1157                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1158                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1159             }
1160         }
1161         textlib_get_instance()->asort($modnames);
1162     } else {
1163         print_error("nomodules", 'debug');
1164     }
1166     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1167     $modinfo = get_fast_modinfo($course);
1169     if ($rawmods=$modinfo->cms) {
1170         foreach($rawmods as $mod) {    // Index the mods
1171             if (empty($modnames[$mod->modname])) {
1172                 continue;
1173             }
1174             $mods[$mod->id] = $mod;
1175             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1176             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1177                 continue;
1178             }
1179             // Check groupings
1180             if (!groups_course_module_visible($mod)) {
1181                 continue;
1182             }
1183             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1184         }
1185         if ($modnamesused) {
1186             textlib_get_instance()->asort($modnamesused);
1187         }
1188     }
1191 /**
1192  * Returns an array of sections for the requested course id
1193  *
1194  * This function stores the sections against the course id within a staticvar encase
1195  * of subsequent requests. This is used all over + in some standard libs and course
1196  * format callbacks so subsequent requests are a reality.
1197  *
1198  * @staticvar array $coursesections
1199  * @param int $courseid
1200  * @return array Array of sections
1201  */
1202 function get_all_sections($courseid) {
1203     global $DB;
1204     static $coursesections = array();
1205     if (!array_key_exists($courseid, $coursesections)) {
1206         $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1207                            "section, id, course, name, summary, summaryformat, sequence, visible");
1208     }
1209     return $coursesections[$courseid];
1212 function course_set_display($courseid, $display=0) {
1213     global $USER, $DB;
1215     if ($display == "all" or empty($display)) {
1216         $display = 0;
1217     }
1219     if (!isloggedin() or isguestuser()) {
1220         //do not store settings in db for guests
1221     } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
1222         $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
1223     } else {
1224         $record = new stdClass();
1225         $record->userid = $USER->id;
1226         $record->course = $courseid;
1227         $record->display = $display;
1228         $DB->insert_record("course_display", $record);
1229     }
1231     return $USER->display[$courseid] = $display;  // Note: = not ==
1234 /**
1235  * For a given course section, marks it visible or hidden,
1236  * and does the same for every activity in that section
1237  */
1238 function set_section_visible($courseid, $sectionnumber, $visibility) {
1239     global $DB;
1241     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1242         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1243         if (!empty($section->sequence)) {
1244             $modules = explode(",", $section->sequence);
1245             foreach ($modules as $moduleid) {
1246                 set_coursemodule_visible($moduleid, $visibility, true);
1247             }
1248         }
1249         rebuild_course_cache($courseid);
1250     }
1253 /**
1254  * Prints a section full of activity modules
1255  */
1256 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1257     global $CFG, $USER, $DB, $PAGE, $OUTPUT;
1259     static $initialised;
1261     static $groupbuttons;
1262     static $groupbuttonslink;
1263     static $isediting;
1264     static $ismoving;
1265     static $strmovehere;
1266     static $strmovefull;
1267     static $strunreadpostsone;
1268     static $usetracking;
1269     static $groupings;
1271     if (!isset($initialised)) {
1272         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1273         $groupbuttonslink = (!$course->groupmodeforce);
1274         $isediting        = $PAGE->user_is_editing();
1275         $ismoving         = $isediting && ismoving($course->id);
1276         if ($ismoving) {
1277             $strmovehere  = get_string("movehere");
1278             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1279         }
1280         include_once($CFG->dirroot.'/mod/forum/lib.php');
1281         if ($usetracking = forum_tp_can_track_forums()) {
1282             $strunreadpostsone = get_string('unreadpostsone', 'forum');
1283         }
1284         $initialised = true;
1285     }
1287     $labelformatoptions = new stdClass();
1288     $labelformatoptions->noclean = true;
1289     $labelformatoptions->overflowdiv = true;
1291 /// Casting $course->modinfo to string prevents one notice when the field is null
1292     $modinfo = get_fast_modinfo($course);
1293     $completioninfo = new completion_info($course);
1295     //Accessibility: replace table with list <ul>, but don't output empty list.
1296     if (!empty($section->sequence)) {
1298         // Fix bug #5027, don't want style=\"width:$width\".
1299         echo "<ul class=\"section img-text\">\n";
1300         $sectionmods = explode(",", $section->sequence);
1302         foreach ($sectionmods as $modnumber) {
1303             if (empty($mods[$modnumber])) {
1304                 continue;
1305             }
1307             $mod = $mods[$modnumber];
1309             if ($ismoving and $mod->id == $USER->activitycopy) {
1310                 // do not display moving mod
1311                 continue;
1312             }
1314             if (isset($modinfo->cms[$modnumber])) {
1315                 // We can continue (because it will not be displayed at all)
1316                 // if:
1317                 // 1) The activity is not visible to users
1318                 // and
1319                 // 2a) The 'showavailability' option is not set (if that is set,
1320                 //     we need to display the activity so we can show
1321                 //     availability info)
1322                 // or
1323                 // 2b) The 'availableinfo' is empty, i.e. the activity was
1324                 //     hidden in a way that leaves no info, such as using the
1325                 //     eye icon.
1326                 if (!$modinfo->cms[$modnumber]->uservisible &&
1327                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1328                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1329                     // visibility shortcut
1330                     continue;
1331                 }
1332             } else {
1333                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1334                     // module not installed
1335                     continue;
1336                 }
1337                 if (!coursemodule_visible_for_user($mod) &&
1338                     empty($mod->showavailability)) {
1339                     // full visibility check
1340                     continue;
1341                 }
1342             }
1344             // In some cases the activity is visible to user, but it is
1345             // dimmed. This is done if viewhiddenactivities is true and if:
1346             // 1. the activity is not visible, or
1347             // 2. the activity has dates set which do not include current, or
1348             // 3. the activity has any other conditions set (regardless of whether
1349             //    current user meets them)
1350             $canviewhidden = has_capability(
1351                 'moodle/course:viewhiddenactivities',
1352                 get_context_instance(CONTEXT_MODULE, $mod->id));
1353             $accessiblebutdim = false;
1354             if ($canviewhidden) {
1355                 $accessiblebutdim = !$mod->visible;
1356                 if (!empty($CFG->enableavailability)) {
1357                     $accessiblebutdim = $accessiblebutdim ||
1358                         $mod->availablefrom > time() ||
1359                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1360                         count($mod->conditionsgrade) > 0 ||
1361                         count($mod->conditionscompletion) > 0;
1362                 }
1363             }
1365             echo '<li class="activity '.$mod->modname.' modtype_'.$mod->modname.'" id="module-'.$modnumber.'">';  // Unique ID
1366             if ($ismoving) {
1367                 echo '<a title="'.$strmovefull.'"'.
1368                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1369                      '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1370                      ' alt="'.$strmovehere.'" /></a><br />
1371                      ';
1372             }
1374             if ($mod->indent) {
1375                 echo $OUTPUT->spacer(array('height'=>12, 'width'=>(20 * $mod->indent))); // should be done with CSS instead
1376             }
1378             $extra = '';
1379             if (!empty($modinfo->cms[$modnumber]->extra)) {
1380                 $extra = $modinfo->cms[$modnumber]->extra;
1381             }
1383             if ($mod->modname == "label") {
1384                 if ($accessiblebutdim || !$mod->uservisible) {
1385                     echo '<div class="dimmed_text"><span class="accesshide">'.
1386                         get_string('hiddenfromstudents').'</span>';
1387                 } else {
1388                     echo '<div>';
1389                 }
1390                 echo format_text($extra, FORMAT_HTML, $labelformatoptions);
1391                 echo "</div>";
1392                 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1393                     if (!isset($groupings)) {
1394                         $groupings = groups_get_all_groupings($course->id);
1395                     }
1396                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1397                 }
1399             } else { // Normal activity
1400                 $instancename = format_string($modinfo->cms[$modnumber]->name, true,  $course->id);
1402                 $customicon = $modinfo->cms[$modnumber]->icon;
1403                 if (!empty($customicon)) {
1404                     if (substr($customicon, 0, 4) === 'mod/') {
1405                         list($modname, $iconname) = explode('/', substr($customicon, 4), 2);
1406                         $icon = $OUTPUT->pix_url($iconname, $modname);
1407                     } else {
1408                         $icon = $OUTPUT->pix_url($customicon);
1409                     }
1410                 } else {
1411                     $icon = $OUTPUT->pix_url('icon', $mod->modname);
1412                 }
1414                 //Accessibility: for files get description via icon, this is very ugly hack!
1415                 $altname = '';
1416                 $altname = $mod->modfullname;
1417                 if (!empty($customicon)) {
1418                     $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1419                     if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1420                         $mimetype = mimeinfo_from_icon('type', $customicon);
1421                         $altname = get_mimetype_description($mimetype);
1422                     }
1423                 }
1424                 // Avoid unnecessary duplication.
1425                 if (false !== stripos($instancename, $altname)) {
1426                     $altname = '';
1427                 }
1428                 // File type after name, for alphabetic lists (screen reader).
1429                 if ($altname) {
1430                     $altname = get_accesshide(' '.$altname);
1431                 }
1433                 // We may be displaying this just in order to show information
1434                 // about visibility, without the actual link
1435                 if ($mod->uservisible) {
1436                     // Display normal module link
1437                     if (!$accessiblebutdim) {
1438                         $linkcss = '';
1439                         $accesstext  ='';
1440                     } else {
1441                         $linkcss = ' class="dimmed" ';
1442                         $accesstext = '<span class="accesshide">'.
1443                             get_string('hiddenfromstudents').': </span>';
1444                     }
1446                     echo '<a '.$linkcss.' '.$extra.
1447                          ' href="'.$CFG->wwwroot.'/mod/'.$mod->modname.'/view.php?id='.$mod->id.'">'.
1448                          '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename',$mod->modname).'" /> '.
1449                          $accesstext.'<span class="instancename">'.$instancename.$altname.'</span></a>';
1451                     if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1452                         if (!isset($groupings)) {
1453                             $groupings = groups_get_all_groupings($course->id);
1454                         }
1455                         echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1456                     }
1457                 } else {
1458                     // Display greyed-out text of link
1459                     echo '<span class="dimmed_text" '.$extra.' ><span class="accesshide">'.
1460                         get_string('notavailableyet','condition').': </span>'.
1461                         '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename', $mod->modname).'" /> <span>'.
1462                         $instancename.$altname.'</span></span>';
1463                 }
1464             }
1465             if ($usetracking && $mod->modname == 'forum') {
1466                 if ($unread = forum_tp_count_forum_unread_posts($mod, $course)) {
1467                     echo '<span class="unread"> <a href="'.$CFG->wwwroot.'/mod/forum/view.php?id='.$mod->id.'">';
1468                     if ($unread == 1) {
1469                         echo $strunreadpostsone;
1470                     } else {
1471                         print_string('unreadpostsnumber', 'forum', $unread);
1472                     }
1473                     echo '</a></span>';
1474                 }
1475             }
1477             if ($isediting) {
1478                 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
1479                     if (! $mod->groupmodelink = $groupbuttonslink) {
1480                         $mod->groupmode = $course->groupmode;
1481                     }
1483                 } else {
1484                     $mod->groupmode = false;
1485                 }
1486                 echo '&nbsp;&nbsp;';
1487                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1488             }
1490             // Completion
1491             $completion = $hidecompletion
1492                 ? COMPLETION_TRACKING_NONE
1493                 : $completioninfo->is_enabled($mod);
1494             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
1495                 !isguestuser() && $mod->uservisible) {
1496                 $completiondata = $completioninfo->get_data($mod,true);
1497                 $completionicon = '';
1498                 if ($isediting) {
1499                     switch ($completion) {
1500                         case COMPLETION_TRACKING_MANUAL :
1501                             $completionicon = 'manual-enabled'; break;
1502                         case COMPLETION_TRACKING_AUTOMATIC :
1503                             $completionicon = 'auto-enabled'; break;
1504                         default: // wtf
1505                     }
1506                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1507                     switch($completiondata->completionstate) {
1508                         case COMPLETION_INCOMPLETE:
1509                             $completionicon = 'manual-n'; break;
1510                         case COMPLETION_COMPLETE:
1511                             $completionicon = 'manual-y'; break;
1512                     }
1513                 } else { // Automatic
1514                     switch($completiondata->completionstate) {
1515                         case COMPLETION_INCOMPLETE:
1516                             $completionicon = 'auto-n'; break;
1517                         case COMPLETION_COMPLETE:
1518                             $completionicon = 'auto-y'; break;
1519                         case COMPLETION_COMPLETE_PASS:
1520                             $completionicon = 'auto-pass'; break;
1521                         case COMPLETION_COMPLETE_FAIL:
1522                             $completionicon = 'auto-fail'; break;
1523                     }
1524                 }
1525                 if ($completionicon) {
1526                     $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
1527                     $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1528                     if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1529                         $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
1530                         $newstate =
1531                             $completiondata->completionstate==COMPLETION_COMPLETE
1532                             ? COMPLETION_INCOMPLETE
1533                             : COMPLETION_COMPLETE;
1534                         // In manual mode the icon is a toggle form...
1536                         // If this completion state is used by the
1537                         // conditional activities system, we need to turn
1538                         // off the JS.
1539                         if (!empty($CFG->enableavailability) &&
1540                             condition_info::completion_value_used_as_condition($course, $mod)) {
1541                             $extraclass = ' preventjs';
1542                         } else {
1543                             $extraclass = '';
1544                         }
1545                         echo "
1546 <form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>
1547 <input type='hidden' name='id' value='{$mod->id}' />
1548 <input type='hidden' name='sesskey' value='".sesskey()."' />
1549 <input type='hidden' name='completionstate' value='$newstate' />
1550 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1551 </div></form>";
1552                     } else {
1553                         // In auto mode, or when editing, the icon is just an image
1554                         echo "<span class='autocompletion'>";
1555                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1556                     }
1557                 }
1558             }
1560             // Show availability information (for someone who isn't allowed to
1561             // see the activity itself, or for staff)
1562             if (!$mod->uservisible) {
1563                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1564             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1565                 $ci = new condition_info($mod);
1566                 $fullinfo = $ci->get_full_information();
1567                 if($fullinfo) {
1568                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability
1569                         ? 'userrestriction_visible'
1570                         : 'userrestriction_hidden','condition',
1571                         $fullinfo).'</div>';
1572                 }
1573             }
1575             echo "</li>\n";
1576         }
1578     } elseif ($ismoving) {
1579         echo "<ul class=\"section\">\n";
1580     }
1582     if ($ismoving) {
1583         echo '<li><a title="'.$strmovefull.'"'.
1584              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1585              '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
1586              ' alt="'.$strmovehere.'" /></a></li>
1587              ';
1588     }
1589     if (!empty($section->sequence) || $ismoving) {
1590         echo "</ul><!--class='section'-->\n\n";
1591     }
1594 /**
1595  * Prints the menus to add activities and resources.
1596  */
1597 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1598     global $CFG, $OUTPUT;
1600     // check to see if user can add menus
1601     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1602         return false;
1603     }
1605     $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1607     $resources = array();
1608     $activities = array();
1610     foreach($modnames as $modname=>$modnamestr) {
1611         if (!course_allowed_module($course, $modname)) {
1612             continue;
1613         }
1615         $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1616         if (!file_exists($libfile)) {
1617             continue;
1618         }
1619         include_once($libfile);
1620         $gettypesfunc =  $modname.'_get_types';
1621         if (function_exists($gettypesfunc)) {
1622             // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1623             if ($types = $gettypesfunc()) {
1624                 $menu = array();
1625                 $atype = null;
1626                 $groupname = null;
1627                 foreach($types as $type) {
1628                     if ($type->typestr === '--') {
1629                         continue;
1630                     }
1631                     if (strpos($type->typestr, '--') === 0) {
1632                         $groupname = str_replace('--', '', $type->typestr);
1633                         continue;
1634                     }
1635                     $type->type = str_replace('&amp;', '&', $type->type);
1636                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1637                         $atype = MOD_CLASS_RESOURCE;
1638                     }
1639                     $menu[$urlbase.$type->type] = $type->typestr;
1640                 }
1641                 if (!is_null($groupname)) {
1642                     if ($atype == MOD_CLASS_RESOURCE) {
1643                         $resources[] = array($groupname=>$menu);
1644                     } else {
1645                         $activities[] = array($groupname=>$menu);
1646                     }
1647                 } else {
1648                     if ($atype == MOD_CLASS_RESOURCE) {
1649                         $resources = array_merge($resources, $menu);
1650                     } else {
1651                         $activities = array_merge($activities, $menu);
1652                     }
1653                 }
1654             }
1655         } else {
1656             $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1657             if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1658                 $resources[$urlbase.$modname] = $modnamestr;
1659             } else {
1660                 // all other archetypes are considered activity
1661                 $activities[$urlbase.$modname] = $modnamestr;
1662             }
1663         }
1664     }
1666     $straddactivity = get_string('addactivity');
1667     $straddresource = get_string('addresource');
1669     $output  = '<div class="section_add_menus">';
1671     if (!$vertical) {
1672         $output .= '<div class="horizontal">';
1673     }
1675     if (!empty($resources)) {
1676         $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
1677         $select->set_help_icon('resources');
1678         $output .= $OUTPUT->render($select);
1679     }
1681     if (!empty($activities)) {
1682         $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
1683         $select->set_help_icon('activities');
1684         $output .= $OUTPUT->render($select);
1685     }
1687     if (!$vertical) {
1688         $output .= '</div>';
1689     }
1691     $output .= '</div>';
1693     if ($return) {
1694         return $output;
1695     } else {
1696         echo $output;
1697     }
1700 /**
1701  * Return the course category context for the category with id $categoryid, except
1702  * that if $categoryid is 0, return the system context.
1703  *
1704  * @param integer $categoryid a category id or 0.
1705  * @return object the corresponding context
1706  */
1707 function get_category_or_system_context($categoryid) {
1708     if ($categoryid) {
1709         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1710     } else {
1711         return get_context_instance(CONTEXT_SYSTEM);
1712     }
1715 /**
1716  * Rebuilds the cached list of course activities stored in the database
1717  * @param int $courseid - id of course to rebuild, empty means all
1718  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1719  */
1720 function rebuild_course_cache($courseid=0, $clearonly=false) {
1721     global $COURSE, $DB, $OUTPUT;
1723     // Destroy navigation caches
1724     navigation_cache::destroy_volatile_caches();
1726     if ($clearonly) {
1727         if (empty($courseid)) {
1728             $courseselect = array();
1729         } else {
1730             $courseselect = array('id'=>$courseid);
1731         }
1732         $DB->set_field('course', 'modinfo', null, $courseselect);
1733         // update cached global COURSE too ;-)
1734         if ($courseid == $COURSE->id or empty($courseid)) {
1735             $COURSE->modinfo = null;
1736         }
1737         // reset the fast modinfo cache
1738         $reset = 'reset';
1739         get_fast_modinfo($reset);
1740         return;
1741     }
1743     if ($courseid) {
1744         $select = array('id'=>$courseid);
1745     } else {
1746         $select = array();
1747         @set_time_limit(0);  // this could take a while!   MDL-10954
1748     }
1750     if ($rs = $DB->get_recordset("course", $select,'','id,fullname')) {
1751         foreach ($rs as $course) {
1752             $modinfo = serialize(get_array_of_activities($course->id));
1753             $DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id));
1754             // update cached global COURSE too ;-)
1755             if ($course->id == $COURSE->id) {
1756                 $COURSE->modinfo = $modinfo;
1757             }
1758         }
1759         $rs->close();
1760     }
1761     // reset the fast modinfo cache
1762     $reset = 'reset';
1763     get_fast_modinfo($reset);
1766 /**
1767  * Gets the child categories of a given courses category. Uses a static cache
1768  * to make repeat calls efficient.
1769  *
1770  * @param int $parentid the id of a course category.
1771  * @return array all the child course categories.
1772  */
1773 function get_child_categories($parentid) {
1774     static $allcategories = null;
1776     // only fill in this variable the first time
1777     if (null == $allcategories) {
1778         $allcategories = array();
1780         $categories = get_categories();
1781         foreach ($categories as $category) {
1782             if (empty($allcategories[$category->parent])) {
1783                 $allcategories[$category->parent] = array();
1784             }
1785             $allcategories[$category->parent][] = $category;
1786         }
1787     }
1789     if (empty($allcategories[$parentid])) {
1790         return array();
1791     } else {
1792         return $allcategories[$parentid];
1793     }
1796 /**
1797  * This function recursively travels the categories, building up a nice list
1798  * for display. It also makes an array that list all the parents for each
1799  * category.
1800  *
1801  * For example, if you have a tree of categories like:
1802  *   Miscellaneous (id = 1)
1803  *      Subcategory (id = 2)
1804  *         Sub-subcategory (id = 4)
1805  *   Other category (id = 3)
1806  * Then after calling this function you will have
1807  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1808  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1809  *      3 => 'Other category');
1810  * $parents = array(2 => array(1), 4 => array(1, 2));
1811  *
1812  * If you specify $requiredcapability, then only categories where the current
1813  * user has that capability will be added to $list, although all categories
1814  * will still be added to $parents, and if you only have $requiredcapability
1815  * in a child category, not the parent, then the child catgegory will still be
1816  * included.
1817  *
1818  * If you specify the option $excluded, then that category, and all its children,
1819  * are omitted from the tree. This is useful when you are doing something like
1820  * moving categories, where you do not want to allow people to move a category
1821  * to be the child of itself.
1822  *
1823  * @param array $list For output, accumulates an array categoryid => full category path name
1824  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1825  * @param string/array $requiredcapability if given, only categories where the current
1826  *      user has this capability will be added to $list. Can also be an array of capabilities,
1827  *      in which case they are all required.
1828  * @param integer $excludeid Omit this category and its children from the lists built.
1829  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1830  * @param string $path For internal use, as part of recursive calls.
1831  */
1832 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1833         $excludeid = 0, $category = NULL, $path = "") {
1835     // initialize the arrays if needed
1836     if (!is_array($list)) {
1837         $list = array();
1838     }
1839     if (!is_array($parents)) {
1840         $parents = array();
1841     }
1843     if (empty($category)) {
1844         // Start at the top level.
1845         $category = new stdClass;
1846         $category->id = 0;
1847     } else {
1848         // This is the excluded category, don't include it.
1849         if ($excludeid > 0 && $excludeid == $category->id) {
1850             return;
1851         }
1853         // Update $path.
1854         if ($path) {
1855             $path = $path.' / '.format_string($category->name);
1856         } else {
1857             $path = format_string($category->name);
1858         }
1860         // Add this category to $list, if the permissions check out.
1861         if (empty($requiredcapability)) {
1862             $list[$category->id] = $path;
1864         } else {
1865             ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1866             $requiredcapability = (array)$requiredcapability;
1867             if (has_all_capabilities($requiredcapability, $category->context)) {
1868                 $list[$category->id] = $path;
1869             }
1870         }
1871     }
1873     // Add all the children recursively, while updating the parents array.
1874     if ($categories = get_child_categories($category->id)) {
1875         foreach ($categories as $cat) {
1876             if (!empty($category->id)) {
1877                 if (isset($parents[$category->id])) {
1878                     $parents[$cat->id]   = $parents[$category->id];
1879                 }
1880                 $parents[$cat->id][] = $category->id;
1881             }
1882             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1883         }
1884     }
1887 /**
1888  * This function generates a structured array of courses and categories.
1889  *
1890  * The depth of categories is limited by $CFG->maxcategorydepth however there
1891  * is no limit on the number of courses!
1892  *
1893  * Suitable for use with the course renderers course_category_tree method:
1894  * $renderer = $PAGE->get_renderer('core','course');
1895  * echo $renderer->course_category_tree(get_course_category_tree());
1896  *
1897  * @global moodle_database $DB
1898  * @param int $id
1899  * @param int $depth
1900  */
1901 function get_course_category_tree($id = 0, $depth = 0) {
1902     global $DB, $CFG;
1903     $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
1904     $categories = get_child_categories($id);
1905     $categoryids = array();
1906     foreach ($categories as $key => &$category) {
1907         if (!$category->visible && !$viewhiddencats) {
1908             unset($categories[$key]);
1909             continue;
1910         }
1911         $categoryids[$category->id] = $category;
1912         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1913             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
1914             foreach ($subcategories as $subid=>$subcat) {
1915                 $categoryids[$subid] = $subcat;
1916             }
1917             $category->courses = array();
1918         }
1919     }
1921     if ($depth > 0) {
1922         // This is a recursive call so return the required array
1923         return array($categories, $categoryids);
1924     }
1926     // The depth is 0 this function has just been called so we can finish it off
1928     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1929     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1930     $sql = "SELECT
1931             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
1932             $ccselect
1933             FROM {course} c
1934             $ccjoin
1935             WHERE c.category $catsql ORDER BY c.sortorder ASC";
1936     if ($courses = $DB->get_records_sql($sql, $catparams)) {
1937         // loop throught them
1938         foreach ($courses as $course) {
1939             if ($course->id == SITEID) {
1940                 continue;
1941             }
1942             context_instance_preload($course);
1943             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1944                 $categoryids[$course->category]->courses[$course->id] = $course;
1945             }
1946         }
1947     }
1948     return $categories;
1951 /**
1952  * Recursive function to print out all the categories in a nice format
1953  * with or without courses included
1954  */
1955 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
1956     global $CFG;
1958     // maxcategorydepth == 0 meant no limit
1959     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
1960         return;
1961     }
1963     if (!$displaylist) {
1964         make_categories_list($displaylist, $parentslist);
1965     }
1967     if ($category) {
1968         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
1969             print_category_info($category, $depth, $showcourses);
1970         } else {
1971             return;  // Don't bother printing children of invisible categories
1972         }
1974     } else {
1975         $category->id = "0";
1976     }
1978     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
1979         $countcats = count($categories);
1980         $count = 0;
1981         $first = true;
1982         $last = false;
1983         foreach ($categories as $cat) {
1984             $count++;
1985             if ($count == $countcats) {
1986                 $last = true;
1987             }
1988             $up = $first ? false : true;
1989             $down = $last ? false : true;
1990             $first = false;
1992             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
1993         }
1994     }
1997 /**
1998  * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
1999  */
2000 function make_categories_options() {
2001     make_categories_list($cats,$parents);
2002     foreach ($cats as $key => $value) {
2003         if (array_key_exists($key,$parents)) {
2004             if ($indent = count($parents[$key])) {
2005                 for ($i = 0; $i < $indent; $i++) {
2006                     $cats[$key] = '&nbsp;'.$cats[$key];
2007                 }
2008             }
2009         }
2010     }
2011     return $cats;
2014 /**
2015  * Prints the category info in indented fashion
2016  * This function is only used by print_whole_category_list() above
2017  */
2018 function print_category_info($category, $depth=0, $showcourses = false) {
2019     global $CFG, $DB, $OUTPUT;
2021     $strsummary = get_string('summary');
2023     $catlinkcss = null;
2024     if (!$category->visible) {
2025         $catlinkcss = array('class'=>'dimmed');
2026     }
2027     static $coursecount = null;
2028     if (null === $coursecount) {
2029         // only need to check this once
2030         $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2031     }
2033     if ($showcourses and $coursecount) {
2034         $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
2035     } else {
2036         $catimage = "&nbsp;";
2037     }
2039     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
2040     if ($showcourses and $coursecount) {
2041         echo '<div class="categorylist clearfix">';
2042         $cat = '';
2043         $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
2044         $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2045         $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2047         $html = '';
2048         if ($depth > 0) {
2049             for ($i=0; $i< $depth; $i++) {
2050                 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2051                 $cat = '';
2052             }
2053         } else {
2054             $html = $cat;
2055         }
2056         echo html_writer::tag('div', $html, array('class'=>'category'));
2057         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2059         // does the depth exceed maxcategorydepth
2060         // maxcategorydepth == 0 or unset meant no limit
2061         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2062         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2063             foreach ($courses as $course) {
2064                 $linkcss = null;
2065                 if (!$course->visible) {
2066                     $linkcss = array('class'=>'dimmed');
2067                 }
2069                 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2071                 // print enrol info
2072                 $courseicon = '';
2073                 if ($icons = enrol_get_course_info_icons($course)) {
2074                     foreach ($icons as $pix_icon) {
2075                         $courseicon = $OUTPUT->render($pix_icon).' ';
2076                     }
2077                 }
2079                 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2081                 if ($course->summary) {
2082                     $link = new moodle_url('/course/info.php?id='.$course->id);
2083                     $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
2084                         new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2085                         array('title'=>$strsummary));
2087                     $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2088                 }
2090                 $html = '';
2091                 for ($i=0; $i <= $depth; $i++) {
2092                     $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2093                     $coursecontent = '';
2094                 }
2095                 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2096             }
2097         }
2098         echo '</div>';
2099     } else {
2100         echo '<div class="categorylist">';
2101         $html = '';
2102         $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2103         $cat .= html_writer::tag('span', '('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2105         if ($depth > 0) {
2106             for ($i=0; $i< $depth; $i++) {
2107                 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2108                 $cat = '';
2109             }
2110         } else {
2111             $html = $cat;
2112         }
2114         echo html_writer::tag('div', $html, array('class'=>'category'));
2115         echo html_writer::tag('div', '', array('class'=>'clearfloat'));
2116         echo '</div>';
2117     }
2120 /**
2121  * Print the buttons relating to course requests.
2122  *
2123  * @param object $systemcontext the system context.
2124  */
2125 function print_course_request_buttons($systemcontext) {
2126     global $CFG, $DB, $OUTPUT;
2127     if (empty($CFG->enablecourserequests)) {
2128         return;
2129     }
2130     if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2131     /// Print a button to request a new course
2132         echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
2133     }
2134     /// Print a button to manage pending requests
2135     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2136         $disabled = !$DB->record_exists('course_request', array());
2137         echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
2138     }
2141 /**
2142  * Does the user have permission to edit things in this category?
2143  *
2144  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2145  * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2146  */
2147 function can_edit_in_category($categoryid = 0) {
2148     $context = get_category_or_system_context($categoryid);
2149     return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2152 /**
2153  * Prints the turn editing on/off button on course/index.php or course/category.php.
2154  *
2155  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2156  * @return string HTML of the editing button, or empty string, if this user is not allowed
2157  *      to see it.
2158  */
2159 function update_category_button($categoryid = 0) {
2160     global $CFG, $PAGE, $OUTPUT;
2162     // Check permissions.
2163     if (!can_edit_in_category($categoryid)) {
2164         return '';
2165     }
2167     // Work out the appropriate action.
2168     if ($PAGE->user_is_editing()) {
2169         $label = get_string('turneditingoff');
2170         $edit = 'off';
2171     } else {
2172         $label = get_string('turneditingon');
2173         $edit = 'on';
2174     }
2176     // Generate the button HTML.
2177     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2178     if ($categoryid) {
2179         $options['id'] = $categoryid;
2180         $page = 'category.php';
2181     } else {
2182         $page = 'index.php';
2183     }
2184     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2187 /**
2188  * Category is 0 (for all courses) or an object
2189  */
2190 function print_courses($category) {
2191     global $CFG, $OUTPUT;
2193     if (!is_object($category) && $category==0) {
2194         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2195         if (is_array($categories) && count($categories) == 1) {
2196             $category   = array_shift($categories);
2197             $courses    = get_courses_wmanagers($category->id,
2198                                                 'c.sortorder ASC',
2199                                                 array('summary','summaryformat'));
2200         } else {
2201             $courses    = get_courses_wmanagers('all',
2202                                                 'c.sortorder ASC',
2203                                                 array('summary','summaryformat'));
2204         }
2205         unset($categories);
2206     } else {
2207         $courses    = get_courses_wmanagers($category->id,
2208                                             'c.sortorder ASC',
2209                                             array('summary','summaryformat'));
2210     }
2212     if ($courses) {
2213         echo html_writer::start_tag('ul', array('class'=>'unlist'));
2214         foreach ($courses as $course) {
2215             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2216             if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2217                 echo html_writer::start_tag('li');
2218                 print_course($course);
2219                 echo html_writer::end_tag('li');
2220             }
2221         }
2222         echo html_writer::end_tag('ul');
2223     } else {
2224         echo $OUTPUT->heading(get_string("nocoursesyet"));
2225         $context = get_context_instance(CONTEXT_SYSTEM);
2226         if (has_capability('moodle/course:create', $context)) {
2227             $options = array();
2228             if (!empty($category->id)) {
2229                 $options['category'] = $category->id;
2230             } else {
2231                 $options['category'] = $CFG->defaultrequestcategory;
2232             }
2233             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
2234             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
2235             echo html_writer::end_tag('div');
2236         }
2237     }
2240 /**
2241  * Print a description of a course, suitable for browsing in a list.
2242  *
2243  * @param object $course the course object.
2244  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2245  */
2246 function print_course($course, $highlightterms = '') {
2247     global $CFG, $USER, $DB, $OUTPUT;
2249     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2251     // Rewrite file URLs so that they are correct
2252     $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
2254     echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2255     echo html_writer::start_tag('div', array('class'=>'info'));
2256     echo html_writer::start_tag('h3', array('class'=>'name'));
2258     $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2259     $linktext = highlight($highlightterms, format_string($course->fullname));
2260     $linkparams = array('title'=>get_string('entercourse'));
2261     if (empty($course->visible)) {
2262         $linkparams['class'] = 'dimmed';
2263     }
2264     echo html_writer::link($linkhref, $linktext, $linkparams);
2265     echo html_writer::end_tag('h3');
2267     /// first find all roles that are supposed to be displayed
2268     if (!empty($CFG->coursecontact)) {
2269         $managerroles = explode(',', $CFG->coursecontact);
2270         $namesarray = array();
2271         if (isset($course->managers)) {
2272             if (count($course->managers)) {
2273                 $rusers = $course->managers;
2274                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2276                  /// Rename some of the role names if needed
2277                 if (isset($context)) {
2278                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2279                 }
2281                 // keep a note of users displayed to eliminate duplicates
2282                 $usersshown = array();
2283                 foreach ($rusers as $ra) {
2285                     // if we've already displayed user don't again
2286                     if (in_array($ra->user->id,$usersshown)) {
2287                         continue;
2288                     }
2289                     $usersshown[] = $ra->user->id;
2291                     $fullname = fullname($ra->user, $canviewfullnames);
2293                     if (isset($aliasnames[$ra->roleid])) {
2294                         $ra->rolename = $aliasnames[$ra->roleid]->name;
2295                     }
2297                     $namesarray[] = format_string($ra->rolename).': '.
2298                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
2299                 }
2300             }
2301         } else {
2302             $rusers = get_role_users($managerroles, $context,
2303                                      true, '', 'r.sortorder ASC, u.lastname ASC');
2304             if (is_array($rusers) && count($rusers)) {
2305                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2307                 /// Rename some of the role names if needed
2308                 if (isset($context)) {
2309                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2310                 }
2312                 foreach ($rusers as $teacher) {
2313                     $fullname = fullname($teacher, $canviewfullnames);
2315                     /// Apply role names
2316                     if (isset($aliasnames[$teacher->roleid])) {
2317                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2318                     }
2320                     $namesarray[] = format_string($teacher->rolename).': '.
2321                                     html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
2322                 }
2323             }
2324         }
2326         if (!empty($namesarray)) {
2327             echo html_writer::start_tag('ul', array('class'=>'teachers'));
2328             foreach ($namesarray as $name) {
2329                 echo html_writer::tag('li', $name);
2330             }
2331             echo html_writer::end_tag('ul');
2332         }
2333     }
2334     echo html_writer::end_tag('div'); // End of info div
2336     echo html_writer::start_tag('div', array('class'=>'summary'));
2337     $options = NULL;
2338     $options->noclean = true;
2339     $options->para = false;
2340     $options->overflowdiv = true;
2341     if (!isset($course->summaryformat)) {
2342         $course->summaryformat = FORMAT_MOODLE;
2343     }
2344     echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options,  $course->id));
2345     if ((!isloggedin() || is_siteadmin()) && $icons = enrol_get_course_info_icons($course)) {
2346         echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2347         foreach ($icons as $icon) {
2348             echo $OUTPUT->render($icon);
2349         }
2350         echo html_writer::end_tag('div'); // End of enrolmenticons div
2351     }
2352     echo html_writer::end_tag('div'); // End of summary div
2353     echo html_writer::end_tag('div'); // End of coursebox div
2356 /**
2357  * Prints custom user information on the home page.
2358  * Over time this can include all sorts of information
2359  */
2360 function print_my_moodle() {
2361     global $USER, $CFG, $DB, $OUTPUT;
2363     if (!isloggedin() or isguestuser()) {
2364         print_error('nopermissions', '', '', 'See My Moodle');
2365     }
2367     $courses  = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
2368     $rhosts   = array();
2369     $rcourses = array();
2370     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2371         $rcourses = get_my_remotecourses($USER->id);
2372         $rhosts   = get_my_remotehosts();
2373     }
2375     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2377         if (!empty($courses)) {
2378             echo '<ul class="unlist">';
2379             foreach ($courses as $course) {
2380                 if ($course->id == SITEID) {
2381                     continue;
2382                 }
2383                 echo '<li>';
2384                 print_course($course);
2385                 echo "</li>\n";
2386             }
2387             echo "</ul>\n";
2388         }
2390         // MNET
2391         if (!empty($rcourses)) {
2392             // at the IDP, we know of all the remote courses
2393             foreach ($rcourses as $course) {
2394                 print_remote_course($course, "100%");
2395             }
2396         } elseif (!empty($rhosts)) {
2397             // non-IDP, we know of all the remote servers, but not courses
2398             foreach ($rhosts as $host) {
2399                 print_remote_host($host, "100%");
2400             }
2401         }
2402         unset($course);
2403         unset($host);
2405         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2406             echo "<table width=\"100%\"><tr><td align=\"center\">";
2407             print_course_search("", false, "short");
2408             echo "</td><td align=\"center\">";
2409             echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
2410             echo "</td></tr></table>\n";
2411         }
2413     } else {
2414         if ($DB->count_records("course_categories") > 1) {
2415             echo $OUTPUT->box_start("categorybox");
2416             print_whole_category_list();
2417             echo $OUTPUT->box_end();
2418         } else {
2419             print_courses(0);
2420         }
2421     }
2425 function print_course_search($value="", $return=false, $format="plain") {
2426     global $CFG;
2427     static $count = 0;
2429     $count++;
2431     $id = 'coursesearch';
2433     if ($count > 1) {
2434         $id .= $count;
2435     }
2437     $strsearchcourses= get_string("searchcourses");
2439     if ($format == 'plain') {
2440         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2441         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2442         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2443         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2444         $output .= '<input type="submit" value="'.get_string('go').'" />';
2445         $output .= '</fieldset></form>';
2446     } else if ($format == 'short') {
2447         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2448         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2449         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2450         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2451         $output .= '<input type="submit" value="'.get_string('go').'" />';
2452         $output .= '</fieldset></form>';
2453     } else if ($format == 'navbar') {
2454         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2455         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2456         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2457         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2458         $output .= '<input type="submit" value="'.get_string('go').'" />';
2459         $output .= '</fieldset></form>';
2460     }
2462     if ($return) {
2463         return $output;
2464     }
2465     echo $output;
2468 function print_remote_course($course, $width="100%") {
2469     global $CFG, $USER;
2471     $linkcss = '';
2473     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2475     echo '<div class="coursebox remotecoursebox clearfix">';
2476     echo '<div class="info">';
2477     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2478          $linkcss.' href="'.$url.'">'
2479         .  format_string($course->fullname) .'</a><br />'
2480         . format_string($course->hostname) . ' : '
2481         . format_string($course->cat_name) . ' : '
2482         . format_string($course->shortname). '</div>';
2483     echo '</div><div class="summary">';
2484     $options = NULL;
2485     $options->noclean = true;
2486     $options->para = false;
2487     $options->overflowdiv = true;
2488     echo format_text($course->summary, $course->summaryformat, $options);
2489     echo '</div>';
2490     echo '</div>';
2493 function print_remote_host($host, $width="100%") {
2494     global $OUTPUT;
2496     $linkcss = '';
2498     echo '<div class="coursebox clearfix">';
2499     echo '<div class="info">';
2500     echo '<div class="name">';
2501     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
2502     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2503         . s($host['name']).'</a> - ';
2504     echo $host['count'] . ' ' . get_string('courses');
2505     echo '</div>';
2506     echo '</div>';
2507     echo '</div>';
2511 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2513 function add_course_module($mod) {
2514     global $DB;
2516     $mod->added = time();
2517     unset($mod->id);
2519     return $DB->insert_record("course_modules", $mod);
2522 /**
2523  * Returns course section - creates new if does not exist yet.
2524  * @param int $relative section number
2525  * @param int $courseid
2526  * @return object $course_section object
2527  */
2528 function get_course_section($section, $courseid) {
2529     global $DB;
2531     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2532         return $cw;
2533     }
2534     $cw = new stdClass();
2535     $cw->course   = $courseid;
2536     $cw->section  = $section;
2537     $cw->summary  = "";
2538     $cw->summaryformat = FORMAT_HTML;
2539     $cw->sequence = "";
2540     $id = $DB->insert_record("course_sections", $cw);
2541     return $DB->get_record("course_sections", array("id"=>$id));
2543 /**
2544  * Given a full mod object with section and course already defined, adds this module to that section.
2545  *
2546  * @param object $mod
2547  * @param int $beforemod An existing ID which we will insert the new module before
2548  * @return int The course_sections ID where the mod is inserted
2549  */
2550 function add_mod_to_section($mod, $beforemod=NULL) {
2551     global $DB;
2553     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2555         $section->sequence = trim($section->sequence);
2557         if (empty($section->sequence)) {
2558             $newsequence = "$mod->coursemodule";
2560         } else if ($beforemod) {
2561             $modarray = explode(",", $section->sequence);
2563             if ($key = array_keys($modarray, $beforemod->id)) {
2564                 $insertarray = array($mod->id, $beforemod->id);
2565                 array_splice($modarray, $key[0], 1, $insertarray);
2566                 $newsequence = implode(",", $modarray);
2568             } else {  // Just tack it on the end anyway
2569                 $newsequence = "$section->sequence,$mod->coursemodule";
2570             }
2572         } else {
2573             $newsequence = "$section->sequence,$mod->coursemodule";
2574         }
2576         $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2577         return $section->id;     // Return course_sections ID that was used.
2579     } else {  // Insert a new record
2580         $section->course   = $mod->course;
2581         $section->section  = $mod->section;
2582         $section->summary  = "";
2583         $section->summaryformat = FORMAT_HTML;
2584         $section->sequence = $mod->coursemodule;
2585         return $DB->insert_record("course_sections", $section);
2586     }
2589 function set_coursemodule_groupmode($id, $groupmode) {
2590     global $DB;
2591     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2594 function set_coursemodule_idnumber($id, $idnumber) {
2595     global $DB;
2596     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2599 /**
2600 * $prevstateoverrides = true will set the visibility of the course module
2601 * to what is defined in visibleold. This enables us to remember the current
2602 * visibility when making a whole section hidden, so that when we toggle
2603 * that section back to visible, we are able to return the visibility of
2604 * the course module back to what it was originally.
2605 */
2606 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2607     global $DB, $CFG;
2608     require_once($CFG->libdir.'/gradelib.php');
2610     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2611         return false;
2612     }
2613     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2614         return false;
2615     }
2616     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2617         foreach($events as $event) {
2618             if ($visible) {
2619                 show_event($event);
2620             } else {
2621                 hide_event($event);
2622             }
2623         }
2624     }
2626     // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2627     $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2628     if ($grade_items) {
2629         foreach ($grade_items as $grade_item) {
2630             $grade_item->set_hidden(!$visible);
2631         }
2632     }
2634     if ($prevstateoverrides) {
2635         if ($visible == '0') {
2636             // Remember the current visible state so we can toggle this back.
2637             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2638         } else {
2639             // Get the previous saved visible states.
2640             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2641         }
2642     }
2643     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2646 /**
2647  * Delete a course module and any associated data at the course level (events)
2648  * Until 1.5 this function simply marked a deleted flag ... now it
2649  * deletes it completely.
2650  *
2651  */
2652 function delete_course_module($id) {
2653     global $CFG, $DB;
2654     require_once($CFG->libdir.'/gradelib.php');
2655     require_once($CFG->dirroot.'/blog/lib.php');
2657     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2658         return true;
2659     }
2660     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2661     //delete events from calendar
2662     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2663         foreach($events as $event) {
2664             delete_event($event->id);
2665         }
2666     }
2667     //delete grade items, outcome items and grades attached to modules
2668     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2669                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2670         foreach ($grade_items as $grade_item) {
2671             $grade_item->delete('moddelete');
2672         }
2673     }
2674     // Delete completion and availability data; it is better to do this even if the
2675     // features are not turned on, in case they were turned on previously (these will be
2676     // very quick on an empty table)
2677     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2678     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2680     delete_context(CONTEXT_MODULE, $cm->id);
2681     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2684 function delete_mod_from_section($mod, $section) {
2685     global $DB;
2687     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2689         $modarray = explode(",", $section->sequence);
2691         if ($key = array_keys ($modarray, $mod)) {
2692             array_splice($modarray, $key[0], 1);
2693             $newsequence = implode(",", $modarray);
2694             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2695         } else {
2696             return false;
2697         }
2699     }
2700     return false;
2703 /**
2704  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2705  *
2706  * @param object $course
2707  * @param int $section
2708  * @param int $move (-1 or 1)
2709  */
2710 function move_section($course, $section, $move) {
2711 /// Moves a whole course section up and down within the course
2712     global $USER, $DB;
2714     if (!$move) {
2715         return true;
2716     }
2718     $sectiondest = $section + $move;
2720     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2721         return false;
2722     }
2724     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2725         return false;
2726     }
2728     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2729         return false;
2730     }
2732     $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2733     $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2735     // if the focus is on the section that is being moved, then move the focus along
2736     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2737         course_set_display($course->id, $sectiondest);
2738     }
2740     // Check for duplicates and fix order if needed.
2741     // There is a very rare case that some sections in the same course have the same section id.
2742     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2743     $n = 0;
2744     foreach ($sections as $section) {
2745         if ($section->section != $n) {
2746             $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
2747         }
2748         $n++;
2749     }
2750     return true;
2753 /**
2754  * Moves a section within a course, from a position to another.
2755  * Be very careful: $section and $destination refer to section number,
2756  * not id!.
2757  *
2758  * @param object $course
2759  * @param int $section Section number (not id!!!)
2760  * @param int $destination
2761  * @return boolean Result
2762  */
2763 function move_section_to($course, $section, $destination) {
2764 /// Moves a whole course section up and down within the course
2765     global $USER, $DB;
2767     if (!$destination && $destination != 0) {
2768         return true;
2769     }
2771     if ($destination > $course->numsections) {
2772         return false;
2773     }
2775     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2776     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2777             'section ASC, id ASC', 'id, section')) {
2778         return false;
2779     }
2781     $sections = reorder_sections($sections, $section, $destination);
2783     // Update all sections
2784     foreach ($sections as $id => $position) {
2785         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2786     }
2788     // if the focus is on the section that is being moved, then move the focus along
2789     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2790         course_set_display($course->id, $destination);
2791     }
2792     return true;
2795 /**
2796  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2797  * an original position number and a target position number, rebuilds the array so that the
2798  * move is made without any duplication of section positions.
2799  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2800  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2801  *
2802  * @param array $sections
2803  * @param int $origin_position
2804  * @param int $target_position
2805  * @return array
2806  */
2807 function reorder_sections($sections, $origin_position, $target_position) {
2808     if (!is_array($sections)) {
2809         return false;
2810     }
2812     // We can't move section position 0
2813     if ($origin_position < 1) {
2814         echo "We can't move section position 0";
2815         return false;
2816     }
2818     // Locate origin section in sections array
2819     if (!$origin_key = array_search($origin_position, $sections)) {
2820         echo "searched position not in sections array";
2821         return false; // searched position not in sections array
2822     }
2824     // Extract origin section
2825     $origin_section = $sections[$origin_key];
2826     unset($sections[$origin_key]);
2828     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2829     $found = false;
2830     $append_array = array();
2831     foreach ($sections as $id => $position) {
2832         if ($found) {
2833             $append_array[$id] = $position;
2834             unset($sections[$id]);
2835         }
2836         if ($position == $target_position) {
2837             $found = true;
2838         }
2839     }
2841     // Append moved section
2842     $sections[$origin_key] = $origin_section;
2844     // Append rest of array (if applicable)
2845     if (!empty($append_array)) {
2846         foreach ($append_array as $id => $position) {
2847             $sections[$id] = $position;
2848         }
2849     }
2851     // Renumber positions
2852     $position = 0;
2853     foreach ($sections as $id => $p) {
2854         $sections[$id] = $position;
2855         $position++;
2856     }
2858     return $sections;
2862 /**
2863  * Move the module object $mod to the specified $section
2864  * If $beforemod exists then that is the module
2865  * before which $modid should be inserted
2866  * All parameters are objects
2867  */
2868 function moveto_module($mod, $section, $beforemod=NULL) {
2869     global $DB, $OUTPUT;
2871 /// Remove original module from original section
2872     if (! delete_mod_from_section($mod->id, $mod->section)) {
2873         echo $OUTPUT->notification("Could not delete module from existing section");
2874     }
2876 /// Update module itself if necessary
2878     if ($mod->section != $section->id) {
2879         $mod->section = $section->id;
2880         $DB->update_record("course_modules", $mod);
2881         // if moving to a hidden section then hide module
2882         if (!$section->visible) {
2883             set_coursemodule_visible($mod->id, 0);
2884         }
2885     }
2887 /// Add the module into the new section
2889     $mod->course       = $section->course;
2890     $mod->section      = $section->section;  // need relative reference
2891     $mod->coursemodule = $mod->id;
2893     if (! add_mod_to_section($mod, $beforemod)) {
2894         return false;
2895     }
2897     return true;
2900 function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
2901     global $CFG, $USER, $DB, $OUTPUT;
2903     static $str;
2904     static $sesskey;
2906     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
2907     // no permission to edit
2908     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
2909         return false;
2910     }
2912     if (!isset($str)) {
2913         $str->assign         = get_string("assignroles", 'role');
2914         $str->delete         = get_string("delete");
2915         $str->move           = get_string("move");
2916         $str->moveup         = get_string("moveup");
2917         $str->movedown       = get_string("movedown");
2918         $str->moveright      = get_string("moveright");
2919         $str->moveleft       = get_string("moveleft");
2920         $str->update         = get_string("update");
2921         $str->duplicate      = get_string("duplicate");
2922         $str->hide           = get_string("hide");
2923         $str->show           = get_string("show");
2924         $str->clicktochange  = get_string("clicktochange");
2925         $str->forcedmode     = get_string("forcedmode");
2926         $str->groupsnone     = get_string("groupsnone");
2927         $str->groupsseparate = get_string("groupsseparate");
2928         $str->groupsvisible  = get_string("groupsvisible");
2929         $sesskey = sesskey();
2930     }
2932     if ($section >= 0) {
2933         $section = '&amp;sr='.$section;   // Section return
2934     } else {
2935         $section = '';
2936     }
2938     if ($absolute) {
2939         $path = $CFG->wwwroot.'/course';
2940     } else {
2941         $path = '.';
2942     }
2943     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2944         if ($mod->visible) {
2945             $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
2946                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2947                         ' src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" '.
2948                         ' alt="'.$str->hide.'" /></a>'."\n";
2949         } else {
2950             $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
2951                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2952                         ' src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" '.
2953                         ' alt="'.$str->show.'" /></a>'."\n";
2954         }
2955     } else {
2956         $hideshow = '';
2957     }
2959     if ($mod->groupmode !== false) {
2960         if ($mod->groupmode == SEPARATEGROUPS) {
2961             $grouptitle = $str->groupsseparate;
2962             $groupclass = 'editing_groupsseparate';
2963             $groupimage = $OUTPUT->pix_url('t/groups') . '';
2964             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
2965         } else if ($mod->groupmode == VISIBLEGROUPS) {
2966             $grouptitle = $str->groupsvisible;
2967             $groupclass = 'editing_groupsvisible';
2968             $groupimage = $OUTPUT->pix_url('t/groupv') . '';
2969             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
2970         } else {
2971             $grouptitle = $str->groupsnone;
2972             $groupclass = 'editing_groupsnone';
2973             $groupimage = $OUTPUT->pix_url('t/groupn') . '';
2974             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
2975         }
2976         if ($mod->groupmodelink) {
2977             $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
2978                          '<img src="'.$groupimage.'" class="iconsmall" '.
2979                          'alt="'.$grouptitle.'" /></a>';
2980         } else {
2981             $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
2982                          ' src="'.$groupimage.'" class="iconsmall" '.
2983                          'alt="'.$grouptitle.'" />';
2984         }
2985     } else {
2986         $groupmode = "";
2987     }
2989     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2990         if ($moveselect) {
2991             $move =     '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
2992                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2993                         ' src="'.$OUTPUT->pix_url('t/move') . '" class="iconsmall" '.
2994                         ' alt="'.$str->move.'" /></a>'."\n";
2995         } else {
2996             $move =     '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
2997                         '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
2998                         ' src="'.$OUTPUT->pix_url('t/up') . '" class="iconsmall" '.
2999                         ' alt="'.$str->moveup.'" /></a>'."\n".
3000                         '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
3001                         '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
3002                         ' src="'.$OUTPUT->pix_url('t/down') . '" class="iconsmall" '.
3003                         ' alt="'.$str->movedown.'" /></a>'."\n";
3004         }
3005     } else {
3006         $move = '';
3007     }
3009     $leftright = '';
3010     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
3012         if (right_to_left()) {   // Exchange arrows on RTL
3013             $rightarrow = 't/left';
3014             $leftarrow  = 't/right';
3015         } else {
3016             $rightarrow = 't/right';
3017             $leftarrow  = 't/left';
3018         }
3020         if ($indent > 0) {
3021             $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
3022                         '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3023                         ' src="'.$OUTPUT->pix_url($leftarrow).'" class="iconsmall" '.
3024                         ' alt="'.$str->moveleft.'" /></a>'."\n";
3025         }
3026         if ($indent >= 0) {
3027             $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
3028                         '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
3029                         ' src="'.$OUTPUT->pix_url($rightarrow).'" class="iconsmall" '.
3030                         ' alt="'.$str->moveright.'" /></a>'."\n";
3031         }
3032     }
3033     if (has_capability('moodle/course:managegroups', $modcontext)){
3034         $context = get_context_instance(CONTEXT_MODULE, $mod->id);
3035         $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
3036             $context->id.'"><img src="'.$OUTPUT->pix_url('i/roles') . '" alt="'.$str->assign.'" class="iconsmall"/></a>';
3037     } else {
3038         $assign = '';
3039     }
3041     return '<span class="commands">'."\n".$leftright.$move.
3042            '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
3043            '&amp;sesskey='.$sesskey.$section.'"><img'.
3044            ' src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" '.
3045            ' alt="'.$str->update.'" /></a>'."\n".
3046            '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
3047            '&amp;sesskey='.$sesskey.$section.'"><img'.
3048            ' src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" '.
3049            ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
3052 /**
3053  * given a course object with shortname & fullname, this function will
3054  * truncate the the number of chars allowed and add ... if it was too long
3055  */
3056 function course_format_name ($course,$max=100) {
3058     $str = $course->shortname.': '. $course->fullname;
3059     if (strlen($str) <= $max) {
3060         return $str;
3061     }
3062     else {
3063         return substr($str,0,$max-3).'...';
3064     }
3067 function update_restricted_mods($course, $mods) {
3068     global $DB;
3070 /// Delete all the current restricted list
3071     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3073     if (empty($course->restrictmodules)) {
3074         return;   // We're done
3075     }
3077 /// Insert the new list of restricted mods
3078     foreach ($mods as $mod) {
3079         if ($mod == 0) {
3080             continue; // this is the 'allow none' option
3081         }
3082         $am = new stdClass();
3083         $am->course = $course->id;
3084         $am->module = $mod;
3085         $DB->insert_record('course_allowed_modules',$am);
3086     }
3089 /**
3090  * This function will take an int (module id) or a string (module name)
3091  * and return true or false, whether it's allowed in the given course (object)
3092  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3093  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3094  */
3096 function course_allowed_module($course,$mod) {
3097     global $DB;
3099     if (empty($course->restrictmodules)) {
3100         return true;
3101     }
3103     // Admins and admin-like people who can edit everything can also add anything.
3104     // Originally there was a course:update test only, but it did not match the test in course edit form
3105     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
3106         return true;
3107     }
3109     if (is_numeric($mod)) {
3110         $modid = $mod;
3111     } else if (is_string($mod)) {
3112         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3113     }
3114     if (empty($modid)) {
3115         return false;
3116     }
3118     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3121 /**
3122  * Recursively delete category including all subcategories and courses.
3123  * @param stdClass $category
3124  * @param boolean $showfeedback display some notices
3125  * @return array return deleted courses
3126  */
3127 function category_delete_full($category, $showfeedback=true) {
3128     global $CFG, $DB;
3129     require_once($CFG->libdir.'/gradelib.php');
3130     require_once($CFG->libdir.'/questionlib.php');
3131     require_once($CFG->dirroot.'/cohort/lib.php');
3133     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3134         foreach ($children as $childcat) {
3135             category_delete_full($childcat, $showfeedback);
3136         }
3137     }
3139     $deletedcourses = array();
3140     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3141         foreach ($courses as $course) {
3142             if (!delete_course($course, false)) {
3143                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3144             }
3145             $deletedcourses[] = $course;
3146         }
3147     }
3149     // move or delete cohorts in this context
3150     cohort_delete_category($category);
3152     // now delete anything that may depend on course category context
3153     grade_course_category_delete($category->id, 0, $showfeedback);
3154     if (!question_delete_course_category($category, 0, $showfeedback)) {
3155         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3156     }
3158     // finally delete the category and it's context
3159     $DB->delete_records('course_categories', array('id'=>$category->id));
3160     delete_context(CONTEXT_COURSECAT, $category->id);
3162     events_trigger('course_category_deleted', $category);
3164     return $deletedcourses;
3167 /**
3168  * Delete category, but move contents to another category.
3169  * @param object $ccategory
3170  * @param int $newparentid category id
3171  * @return bool status
3172  */
3173 function category_delete_move($category, $newparentid, $showfeedback=true) {
3174     global $CFG, $DB, $OUTPUT;
3175     require_once($CFG->libdir.'/gradelib.php');
3176     require_once($CFG->libdir.'/questionlib.php');
3177     require_once($CFG->dirroot.'/cohort/lib.php');
3179     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3180         return false;
3181     }
3183     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3184         foreach ($children as $childcat) {
3185             move_category($childcat, $newparentcat);
3186         }
3187     }
3189     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3190         if (!move_courses(array_keys($courses), $newparentid)) {
3191             echo $OUTPUT->notification("Error moving courses");
3192             return false;
3193         }
3194         echo $OUTPUT->notification(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3195     }
3197     // move or delete cohorts in this context
3198     cohort_delete_category($category);
3200     // now delete anything that may depend on course category context
3201     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3202     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3203         echo $OUTPUT->notification(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3204         return false;
3205     }
3207     // finally delete the category and it's context
3208     $DB->delete_records('course_categories', array('id'=>$category->id));
3209     delete_context(CONTEXT_COURSECAT, $category->id);
3211     events_trigger('course_category_deleted', $category);
3213     echo $OUTPUT->notification(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3215     return true;
3218 /**
3219  * Efficiently moves many courses around while maintaining
3220  * sortorder in order.
3221  *
3222  * @param array $courseids is an array of course ids
3223  * @param int $categoryid
3224  * @return bool success
3225  */
3226 function move_courses($courseids, $categoryid) {
3227     global $CFG, $DB, $OUTPUT;
3229     if (empty($courseids)) {
3230         // nothing to do
3231         return;
3232     }
3234     if (!$category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3235         return false;
3236     }
3238     $courseids = array_reverse($courseids);
3239     $i = 1;
3241     foreach ($courseids as $courseid) {
3242         if ($course = $DB->get_record('course', array('id'=>$courseid), 'id, category')) {
3243             $course->category  = $category->id;
3244             $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3245             if ($category->visible == 0) {
3246                 // hide the course when moving into hidden category,
3247                 // do not update the visibleold flag - we want to get to previous state if somebody unhides the category
3248                 $course->visible = 0;
3249             }
3251             $DB->update_record('course', $course);
3253             $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3254             $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3255             context_moved($context, $newparent);
3256         }
3257     }
3258     fix_course_sortorder();
3260     return true;
3263 /**
3264  * Hide course category and child course and subcategories
3265  * @param stdClass $category
3266  * @return void
3267  */
3268 function course_category_hide($category) {
3269     global $DB;
3271     $category->visible = 0;
3272     $DB->set_field('course_categories', 'visible', 0, array('id'=>$category->id));
3273     $DB->set_field('course_categories', 'visibleold', 0, array('id'=>$category->id));
3274     $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
3275     $DB->set_field('course', 'visible', 0, array('category' => $category->id));
3276     // get all child categories and hide too
3277     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3278         foreach ($subcats as $cat) {
3279             $DB->set_field('course_categories', 'visibleold', $cat->visible, array('id'=>$cat->id));
3280             $DB->set_field('course_categories', 'visible', 0, array('id'=>$cat->id));
3281             $DB->execute("UPDATE {course} SET visibleold = visible WHERE category = ?", array($cat->id));
3282             $DB->set_field('course', 'visible', 0, array('category' => $cat->id));
3283         }
3284     }
3287 /**
3288  * Show course category and child course and subcategories
3289  * @param stdClass $category
3290  * @return void
3291  */
3292 function course_category_show($category) {
3293     global $DB;
3295     $category->visible = 1;
3296     $DB->set_field('course_categories', 'visible', 1, array('id'=>$category->id));
3297     $DB->set_field('course_categories', 'visibleold', 1, array('id'=>$category->id));
3298     $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($category->id));
3299     // get all child categories and unhide too
3300     if ($subcats = $DB->get_records_select('course_categories', "path LIKE ?", array("$category->path/%"))) {
3301         foreach ($subcats as $cat) {
3302             if ($cat->visibleold) {
3303                 $DB->set_field('course_categories', 'visible', 1, array('id'=>$cat->id));
3304             }
3305             $DB->execute("UPDATE {course} SET visible = visibleold WHERE category = ?", array($cat->id));
3306         }
3307     }
3310 /**
3311  * Efficiently moves a category - NOTE that this can have
3312  * a huge impact access-control-wise...
3313  */
3314 function move_category($category, $newparentcat) {
3315     global $CFG, $DB;
3317     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3319     $hidecat = false;
3320     if (empty($newparentcat->id)) {
3321         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3323         $newparent = get_context_instance(CONTEXT_SYSTEM);
3325     } else {
3326         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3327         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3329         if (!$newparentcat->visible and $category->visible) {
3330             // better hide category when moving into hidden category, teachers may unhide afterwards and the hidden children will be restored properly
3331             $hidecat = true;
3332         }
3333     }
3335     context_moved($context, $newparent);
3337     // now make it last in new category
3338     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3340     // and fix the sortorders
3341     fix_course_sortorder();
3343     if ($hidecat) {
3344         course_category_hide($category);
3345     }
3348 /**
3349  * Returns the display name of the given section that the course prefers.
3350  *
3351  * This function utilizes a callback that can be implemented within the course
3352  * formats lib.php file to customize the display name that is used to reference
3353  * the section.
3354  *
3355  * By default (if callback is not defined) the method
3356  * {@see get_numeric_section_name} is called instead.
3357  *
3358  * @param stdClass $course The course to get the section name for
3359  * @param stdClass $section Section object from database
3360  * @return Display name that the course format prefers, e.g. "Week 2"
3361  *
3362  * @see get_generic_section_name
3363  */
3364 function get_section_name(stdClass $course, stdClass $section) {
3365     global $CFG;
3367     /// Inelegant hack for bug 3408
3368     if ($course->format == 'site') {
3369         return get_string('site');
3370     }
3372     // Use course formatter callback if it exists
3373     $namingfile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3374     $namingfunction = 'callback_'.$course->format.'_get_section_name';
3375     if (!function_exists($namingfunction) && file_exists($namingfile)) {
3376         require_once $namingfile;
3377     }
3378     if (function_exists($namingfunction)) {
3379         return $namingfunction($course, $section);
3380     }
3382     // else, default behavior:
3383     return get_generic_section_name($course->format, $section);
3386 /**
3387  * Gets the generic section name for a courses section.
3388  *
3389  * @param string $format Course format ID e.g. 'weeks' $course->format
3390  * @param stdClass $section Section object from database
3391  * @return Display name that the course format prefers, e.g. "Week 2"
3392  */
3393 function get_generic_section_name($format, stdClass $section) {
3394     return get_string('sectionname', "format_$format") . ' ' . $section->section;
3398 function course_format_uses_sections($format) {
3399     global $CFG;
3401     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3402     $featurefunction = 'callback_'.$format.'_uses_sections';
3403     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3404         require_once $featurefile;
3405     }
3406     if (function_exists($featurefunction)) {
3407         return $featurefunction();
3408     }
3410     return false;
3413 /**
3414  * Returns the information about the ajax support in the given source format
3415  *
3416  * The returned object's property (boolean)capable indicates that
3417  * the course format supports Moodle course ajax features.
3418  * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
3419  *
3420  * @param string $format
3421  * @return stdClass
3422  */
3423 function course_format_ajax_support($format) {
3424     global $CFG;
3426     // set up default values
3427     $ajaxsupport = new stdClass();
3428     $ajaxsupport->capable = false;
3429     $ajaxsupport->testedbrowsers = array();
3431     // get the information from the course format library
3432     $featurefile = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
3433     $featurefunction = 'callback_'.$format.'_ajax_support';
3434     if (!function_exists($featurefunction) && file_exists($featurefile)) {
3435         require_once $featurefile;
3436     }
3437     if (function_exists($featurefunction)) {
3438         $formatsupport = $featurefunction();
3439         if (isset($formatsupport->capable)) {
3440             $ajaxsupport->capable = $formatsupport->capable;
3441         }
3442         if (is_array($formatsupport->testedbrowsers)) {
3443             $ajaxsupport->testedbrowsers = $formatsupport->testedbrowsers;
3444         }
3445     }
3447     return $ajaxsupport;
3450 /**
3451  * Can the current user delete this course?
3452  * Course creators have exception,
3453  * 1 day after the creation they can sill delete the course.
3454  * @param int $courseid
3455  * @return boolean
3456  */
3457 function can_delete_course($courseid) {
3458     global $USER, $DB;
3460     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3462     if (has_capability('moodle/course:delete', $context)) {
3463         return true;
3464     }
3466     // hack: now try to find out if creator created this course recently (1 day)
3467     if (!has_capability('moodle/course:create', $context)) {
3468         return false;
3469     }
3471     $since = time() - 60*60*24;
3473     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3474     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3476     return $DB->record_exists_select('log', $select, $params);
3479 /**
3480  * Save the Your name for 'Some role' strings.
3481  *
3482  * @param integer $courseid the id of this course.
3483  * @param array $data the data that came from the course settings form.
3484  */
3485 function save_local_role_names($courseid, $data) {
3486     global $DB;
3487     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3489     foreach ($data as $fieldname => $value) {
3490         if (strpos($fieldname, 'role_') !== 0) {
3491             continue;
3492         }
3493         list($ignored, $roleid) = explode('_', $fieldname);
3495         // make up our mind whether we want to delete, update or insert
3496         if (!$value) {
3497             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3499         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3500             $rolename->name = $value;
3501             $DB->update_record('role_names', $rolename);
3503         } else {
3504             $rolename = new stdClass;
3505             $rolename->contextid = $context->id;
3506             $rolename->roleid = $roleid;
3507             $rolename->name = $value;
3508             $DB->insert_record('role_names', $rolename);
3509         }
3510     }
3513 /**
3514  * Create a course and either return a $course object
3515  *
3516  * Please note this functions does not verify any access control,
3517  * the calling code is responsible for all validation (usually it is the form definition).
3518  *
3519  * @param array $editoroptions course description editor options
3520  * @param object $data  - all the data needed for an entry in the 'course' table
3521  * @return object new course instance
3522  */
3523 function create_course($data, $editoroptions = NULL) {
3524     global $CFG, $DB;
3526     //check the categoryid - must be given for all new courses
3527     $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
3529     //check if the shortname already exist
3530     if (!empty($data->shortname)) {
3531         if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
3532             throw new moodle_exception('shortnametaken');
3533         }
3534     }
3536     //check if the id number already exist
3537     if (!empty($data->idnumber)) {
3538         if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
3539             throw new moodle_exception('idnumbertaken');
3540         }
3541     }
3543     $data->timecreated  = time();
3544     $data->timemodified = $data->timecreated;