moodle_page: MDL-12212 reimplement user_is_editing, deprecate isediting
[moodle.git] / course / lib.php
1 <?php  // $Id$
2    // Library of useful functions
4 require_once($CFG->libdir.'/completionlib.php');
6 define('COURSE_MAX_LOG_DISPLAY', 150);          // days
7 define('COURSE_MAX_LOGS_PER_PAGE', 1000);       // records
8 define('COURSE_LIVELOG_REFRESH', 60);           // Seconds
9 define('COURSE_MAX_RECENT_PERIOD', 172800);     // Two days, in seconds
10 define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);    // courses
11 define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); //  max courses in log dropdown before switching to optional
12 define('COURSE_MAX_USERS_PER_DROPDOWN',1000);   //  max users in log dropdown before switching to optional
13 define('FRONTPAGENEWS',           '0');
14 define('FRONTPAGECOURSELIST',     '1');
15 define('FRONTPAGECATEGORYNAMES',  '2');
16 define('FRONTPAGETOPICONLY',      '3');
17 define('FRONTPAGECATEGORYCOMBO',  '4');
18 define('FRONTPAGECOURSELIMIT',    200);         // maximum number of courses displayed on the frontpage
19 define('EXCELROWS', 65535);
20 define('FIRSTUSEDEXCELROW', 3);
22 define('MOD_CLASS_ACTIVITY', 0);
23 define('MOD_CLASS_RESOURCE', 1);
25 if (!defined('MAX_MODINFO_CACHE_SIZE')) { 
26     define('MAX_MODINFO_CACHE_SIZE', 10);
27 }
29 function make_log_url($module, $url) {
30     switch ($module) {
31         case 'course':
32         case 'file':
33         case 'login':
34         case 'lib':
35         case 'admin':
36         case 'calendar':
37         case 'mnet course':
38             if (strpos($url, '../') === 0) {
39                 $url = ltrim($url, '.');
40             } else {
41                 $url = "/course/$url";
42             }
43             break;
44         case 'user':
45         case 'blog':
46             $url = "/$module/$url";
47             break;
48         case 'upload':
49             $url = $url;
50             break;
51         case 'coursetags':
52             $url = '/'.$url;
53             break;
54         case 'library':
55         case '':
56             $url = '/';
57             break;
58         case 'message':
59             $url = "/message/$url";
60             break;
61         case 'notes':
62             $url = "/notes/$url";
63             break;
64         default:
65             $url = "/mod/$module/$url";
66             break;
67     }
69     //now let's sanitise urls - there might be some ugly nasties:-(
70     $parts = explode('?', $url);
71     $script = array_shift($parts);
72     if (strpos($script, 'http') === 0) {
73         $script = clean_param($script, PARAM_URL);
74     } else {
75         $script = clean_param($script, PARAM_PATH);
76     }
78     $query = '';
79     if ($parts) {
80         $query = implode('', $parts);
81         $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
82         $parts = explode('&', $query);
83         $eq = urlencode('=');
84         foreach ($parts as $key=>$part) {
85             $part = urlencode(urldecode($part));
86             $part = str_replace($eq, '=', $part);
87             $parts[$key] = $part;
88         }
89         $query = '?'.implode('&amp;', $parts);
90     }
92     return $script.$query;
93 }
96 function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
97                    $modname="", $modid=0, $modaction="", $groupid=0) {
98     global $CFG, $DB;
100     // It is assumed that $date is the GMT time of midnight for that day,
101     // and so the next 86400 seconds worth of logs are printed.
103     /// Setup for group handling.
105     // TODO: I don't understand group/context/etc. enough to be able to do
106     // something interesting with it here
107     // What is the context of a remote course?
109     /// If the group mode is separate, and this user does not have editing privileges,
110     /// then only the user's group can be viewed.
111     //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
112     //    $groupid = get_current_group($course->id);
113     //}
114     /// If this course doesn't have groups, no groupid can be specified.
115     //else if (!$course->groupmode) {
116     //    $groupid = 0;
117     //}
119     $ILIKE = $DB->sql_ilike();
121     $groupid = 0;
123     $joins = array();
125     $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
126               FROM {mnet_log} l
127                LEFT JOIN {user} u ON l.userid = u.id
128               WHERE ";
129     $params = array();
131     $where .= "l.hostid = :hostid";
132     $params['hostid'] = $hostid;
134     // TODO: Is 1 really a magic number referring to the sitename?
135     if ($course != SITEID || $modid != 0) {
136         $where .= " AND l.course=:courseid";
137         $params['courseid'] = $course;
138     }
140     if ($modname) {
141         $where .= " AND l.module = :modname";
142         $params['modname'] = $modname;
143     }
145     if ('site_errors' === $modid) {
146         $where .= " AND ( l.action='error' OR l.action='infected' )";
147     } else if ($modid) {
148         //TODO: This assumes that modids are the same across sites... probably
149         //not true
150         $where .= " AND l.cmid = :modid";
151         $params['modid'] = $modid;
152     }
154     if ($modaction) {
155         $firstletter = substr($modaction, 0, 1);
156         if (preg_match('/[[:alpha:]]/', $firstletter)) {
157             $where .= " AND lower(l.action) $ILIKE :modaction";
158             $params['modaction'] = "%$modaction%";
159         } else if ($firstletter == '-') {
160             $where .= " AND lower(l.action) NOT $ILIKE :modaction";
161             $params['modaction'] = "%$modaction%";
162         }
163     }
165     if ($user) {
166         $where .= " AND l.userid = :user";
167         $params['user'] = $user;
168     }
170     if ($date) {
171         $enddate = $date + 86400;
172         $where .= " AND l.time > :date AND l.time < :enddate";
173         $params['date'] = $date;
174         $params['enddate'] = $enddate;
175     }
177     $result = array();
178     $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
179     if(!empty($result['totalcount'])) {
180         $where .= " ORDER BY $order";
181         $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
182     } else {
183         $result['logs'] = array();
184     }
185     return $result;
188 function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
189                    $modname="", $modid=0, $modaction="", $groupid=0) {
190     global $DB;
191     // It is assumed that $date is the GMT time of midnight for that day,
192     // and so the next 86400 seconds worth of logs are printed.
194     /// Setup for group handling.
196     /// If the group mode is separate, and this user does not have editing privileges,
197     /// then only the user's group can be viewed.
198     if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
199         $groupid = get_current_group($course->id);
200     }
201     /// If this course doesn't have groups, no groupid can be specified.
202     else if (!$course->groupmode) {
203         $groupid = 0;
204     }
206     $joins = array();
207     $oarams = array();
209     if ($course->id != SITEID || $modid != 0) {
210         $joins[] = "l.course = :courseid";
211         $params['courseid'] = $course->id;
212     }
214     if ($modname) {
215         $joins[] = "l.module = :modname";
216         $params['modname'] = $modname;
217     }
219     if ('site_errors' === $modid) {
220         $joins[] = "( l.action='error' OR l.action='infected' )";
221     } else if ($modid) {
222         $joins[] = "l.cmid = :modid";
223         $params['modid'] = $modid;
224     }
226     if ($modaction) {
227         $ILIKE = $DB->sql_ilike();
228         $firstletter = substr($modaction, 0, 1);
229         if (preg_match('/[[:alpha:]]/', $firstletter)) {
230             $joins[] = "l.action $ILIKE :modaction";
231             $params['modaction'] = '%'.$modaction.'%';
232         } else if ($firstletter == '-') {
233             $joins[] = "l.action NOT $ILIKE :modaction";
234             $params['modaction'] = '%'.substr($modaction, 1).'%';
235         }
236     }
239     /// Getting all members of a group.
240     if ($groupid and !$user) {
241         if ($gusers = groups_get_members($groupid)) {
242             $gusers = array_keys($gusers);
243             $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
244         } else {
245             $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
246         }
247     }
248     else if ($user) {
249         $joins[] = "l.userid = :userid";
250         $params['userid'] = $user;
251     }
253     if ($date) {
254         $enddate = $date + 86400;
255         $joins[] = "l.time > :date AND l.time < :enddate";
256         $params['date'] = $date;
257         $params['enddate'] = $enddate;
258     }
260     $selector = implode(' AND ', $joins);
262     $totalcount = 0;  // Initialise
263     $result = array();
264     $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
265     $result['totalcount'] = $totalcount;
266     return $result;
270 function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
271                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
273     global $CFG, $DB;
275     if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
276                        $modname, $modid, $modaction, $groupid)) {
277         notify("No logs found!");
278         print_footer($course);
279         exit;
280     }
282     $courses = array();
284     if ($course->id == SITEID) {
285         $courses[0] = '';
286         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
287             foreach ($ccc as $cc) {
288                 $courses[$cc->id] = $cc->shortname;
289             }
290         }
291     } else {
292         $courses[$course->id] = $course->shortname;
293     }
295     $totalcount = $logs['totalcount'];
296     $count=0;
297     $ldcache = array();
298     $tt = getdate(time());
299     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
301     $strftimedatetime = get_string("strftimedatetime");
303     echo "<div class=\"info\">\n";
304     print_string("displayingrecords", "", $totalcount);
305     echo "</div>\n";
307     print_paging_bar($totalcount, $page, $perpage, "$url&amp;perpage=$perpage&amp;");
309     echo '<table class="logtable generalbox boxaligncenter" summary="">'."\n";
310     // echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\" summary=\"\">\n";
311     echo "<tr>";
312     if ($course->id == SITEID) {
313         echo "<th class=\"c0 header\" scope=\"col\">".get_string('course')."</th>\n";
314     }
315     echo "<th class=\"c1 header\" scope=\"col\">".get_string('time')."</th>\n";
316     echo "<th class=\"c2 header\" scope=\"col\">".get_string('ip_address')."</th>\n";
317     echo "<th class=\"c3 header\" scope=\"col\">".get_string('fullnamecourse')."</th>\n";
318     echo "<th class=\"c4 header\" scope=\"col\">".get_string('action')."</th>\n";
319     echo "<th class=\"c5 header\" scope=\"col\">".get_string('info')."</th>\n";
320     echo "</tr>\n";
322     // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
323     if (empty($logs['logs'])) {
324         $logs['logs'] = array();
325     }
327     $row = 1;
328     foreach ($logs['logs'] as $log) {
330         $row = ($row + 1) % 2;
332         if (isset($ldcache[$log->module][$log->action])) {
333             $ld = $ldcache[$log->module][$log->action];
334         } else {
335             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
336             $ldcache[$log->module][$log->action] = $ld;
337         }
338         if ($ld && is_numeric($log->info)) {
339             // ugly hack to make sure fullname is shown correctly
340             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
341                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
342             } else {
343                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
344             }
345         }
347         //Filter log->info
348         $log->info = format_string($log->info);
350         // If $log->url has been trimmed short by the db size restriction
351         // code in add_to_log, keep a note so we don't add a link to a broken url
352         $tl=textlib_get_instance();
353         $brokenurl=($tl->strlen($log->url)==100 && $tl->substr($log->url,97)=='...');
355         echo '<tr class="r'.$row.'">';
356         if ($course->id == SITEID) {
357             echo "<td class=\"cell c0\">\n";
358             if (empty($log->course)) {
359                 echo get_string('site') . "\n";
360             } else {
361                 echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>\n";
362             }
363             echo "</td>\n";
364         }
365         echo "<td class=\"cell c1\" align=\"right\">".userdate($log->time, '%a').
366              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
367         echo "<td class=\"cell c2\">\n";
368         link_to_popup_window("/iplookup/index.php?ip=$log->ip&amp;user=$log->userid", 'iplookup',$log->ip, 440, 700);
369         echo "</td>\n";
370         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
371         echo "<td class=\"cell c3\">\n";
372         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}&amp;course={$log->course}\">$fullname</a>\n";
373         echo "</td>\n";
374         echo "<td class=\"cell c4\">\n";
375         $displayaction="$log->module $log->action";
376         if($brokenurl) {
377             echo $displayaction;
378         } else {
379             link_to_popup_window( make_log_url($log->module,$log->url), 'fromloglive',$displayaction, 440, 700);
380         }
381         echo "</td>\n";;
382         echo "<td class=\"cell c5\">{$log->info}</td>\n";
383         echo "</tr>\n";
384     }
385     echo "</table>\n";
387     print_paging_bar($totalcount, $page, $perpage, "$url&amp;perpage=$perpage&amp;");
391 function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
392                    $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
394     global $CFG, $DB;
396     if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
397                        $modname, $modid, $modaction, $groupid)) {
398         notify("No logs found!");
399         print_footer($course);
400         exit;
401     }
403     if ($course->id == SITEID) {
404         $courses[0] = '';
405         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
406             foreach ($ccc as $cc) {
407                 $courses[$cc->id] = $cc->shortname;
408             }
409         }
410     }
412     $totalcount = $logs['totalcount'];
413     $count=0;
414     $ldcache = array();
415     $tt = getdate(time());
416     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
418     $strftimedatetime = get_string("strftimedatetime");
420     echo "<div class=\"info\">\n";
421     print_string("displayingrecords", "", $totalcount);
422     echo "</div>\n";
424     print_paging_bar($totalcount, $page, $perpage, "$url&amp;perpage=$perpage&amp;");
426     echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
427     echo "<tr>";
428     if ($course->id == SITEID) {
429         echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
430     }
431     echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
432     echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
433     echo "<th class=\"c3 header\">".get_string('fullnamecourse')."</th>\n";
434     echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
435     echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
436     echo "</tr>\n";
438     if (empty($logs['logs'])) {
439         echo "</table>\n";
440         return;
441     }
443     $row = 1;
444     foreach ($logs['logs'] as $log) {
446         $log->info = $log->coursename;
447         $row = ($row + 1) % 2;
449         if (isset($ldcache[$log->module][$log->action])) {
450             $ld = $ldcache[$log->module][$log->action];
451         } else {
452             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
453             $ldcache[$log->module][$log->action] = $ld;
454         }
455         if (0 && $ld && !empty($log->info)) {
456             // ugly hack to make sure fullname is shown correctly
457             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
458                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
459             } else {
460                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
461             }
462         }
464         //Filter log->info
465         $log->info = format_string($log->info);
467         echo '<tr class="r'.$row.'">';
468         if ($course->id == SITEID) {
469             echo "<td class=\"r$row c0\" >\n";
470             echo "    <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courses[$log->course]."</a>\n";
471             echo "</td>\n";
472         }
473         echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
474              ' '.userdate($log->time, $strftimedatetime)."</td>\n";
475         echo "<td class=\"r$row c2\" >\n";
476         link_to_popup_window("/iplookup/index.php?ip=$log->ip&amp;user=$log->userid", 'iplookup',$log->ip, 400, 700);
477         echo "</td>\n";
478         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
479         echo "<td class=\"r$row c3\" >\n";
480         echo "    <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
481         echo "</td>\n";
482         echo "<td class=\"r$row c4\">\n";
483         echo $log->action .': '.$log->module;
484         echo "</td>\n";;
485         echo "<td class=\"r$row c5\">{$log->info}</td>\n";
486         echo "</tr>\n";
487     }
488     echo "</table>\n";
490     print_paging_bar($totalcount, $page, $perpage, "$url&amp;perpage=$perpage&amp;");
494 function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
495                         $modid, $modaction, $groupid) {
496     global $DB;
498     $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
499             get_string('fullnamecourse')."\t".get_string('action')."\t".get_string('info');
501     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
502                        $modname, $modid, $modaction, $groupid)) {
503         return false;
504     }
506     $courses = array();
508     if ($course->id == SITEID) {
509         $courses[0] = '';
510         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
511             foreach ($ccc as $cc) {
512                 $courses[$cc->id] = $cc->shortname;
513             }
514         }
515     } else {
516         $courses[$course->id] = $course->shortname;
517     }
519     $count=0;
520     $ldcache = array();
521     $tt = getdate(time());
522     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
524     $strftimedatetime = get_string("strftimedatetime");
526     $filename = 'logs_'.userdate(time(),get_string('backupnameformat'),99,false);
527     $filename .= '.txt';
528     header("Content-Type: application/download\n");
529     header("Content-Disposition: attachment; filename=$filename");
530     header("Expires: 0");
531     header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
532     header("Pragma: public");
534     echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
535     echo $text;
537     if (empty($logs['logs'])) {
538         return true;
539     }
541     foreach ($logs['logs'] as $log) {
542         if (isset($ldcache[$log->module][$log->action])) {
543             $ld = $ldcache[$log->module][$log->action];
544         } else {
545             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
546             $ldcache[$log->module][$log->action] = $ld;
547         }
548         if ($ld && !empty($log->info)) {
549             // ugly hack to make sure fullname is shown correctly
550             if (($ld->mtable == 'user') and ($ld->field ==  $DB->sql_concat('firstname', "' '" , 'lastname'))) {
551                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
552             } else {
553                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
554             }
555         }
557         //Filter log->info
558         $log->info = format_string($log->info);
559         $log->info = strip_tags(urldecode($log->info));    // Some XSS protection
561         $firstField = $courses[$log->course];
562         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
563         $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
564         $text = implode("\t", $row);
565         echo $text." \n";
566     }
567     return true;
571 function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
572                         $modid, $modaction, $groupid) {
574     global $CFG, $DB;
576     require_once("$CFG->libdir/excellib.class.php");
578     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
579                        $modname, $modid, $modaction, $groupid)) {
580         return false;
581     }
583     $courses = array();
585     if ($course->id == SITEID) {
586         $courses[0] = '';
587         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
588             foreach ($ccc as $cc) {
589                 $courses[$cc->id] = $cc->shortname;
590             }
591         }
592     } else {
593         $courses[$course->id] = $course->shortname;
594     }
596     $count=0;
597     $ldcache = array();
598     $tt = getdate(time());
599     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
601     $strftimedatetime = get_string("strftimedatetime");
603     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
604     $filename = 'logs_'.userdate(time(),get_string('backupnameformat'),99,false);
605     $filename .= '.xls';
607     $workbook = new MoodleExcelWorkbook('-');
608     $workbook->send($filename);
610     $worksheet = array();
611     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
612                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
614     // Creating worksheets
615     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
616         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
617         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
618         $worksheet[$wsnumber]->set_column(1, 1, 30);
619         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
620                                     userdate(time(), $strftimedatetime));
621         $col = 0;
622         foreach ($headers as $item) {
623             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
624             $col++;
625         }
626     }
628     if (empty($logs['logs'])) {
629         $workbook->close();
630         return true;
631     }
633     $formatDate =& $workbook->add_format();
634     $formatDate->set_num_format(get_string('log_excel_date_format'));
636     $row = FIRSTUSEDEXCELROW;
637     $wsnumber = 1;
638     $myxls =& $worksheet[$wsnumber];
639     foreach ($logs['logs'] as $log) {
640         if (isset($ldcache[$log->module][$log->action])) {
641             $ld = $ldcache[$log->module][$log->action];
642         } else {
643             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
644             $ldcache[$log->module][$log->action] = $ld;
645         }
646         if ($ld && !empty($log->info)) {
647             // ugly hack to make sure fullname is shown correctly
648             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
649                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
650             } else {
651                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
652             }
653         }
655         // Filter log->info
656         $log->info = format_string($log->info);
657         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
659         if ($nroPages>1) {
660             if ($row > EXCELROWS) {
661                 $wsnumber++;
662                 $myxls =& $worksheet[$wsnumber];
663                 $row = FIRSTUSEDEXCELROW;
664             }
665         }
667         $myxls->write($row, 0, $courses[$log->course], '');
668         // Excel counts from 1/1/1900
669         $excelTime=25569+$log->time/(3600*24);
670         $myxls->write($row, 1, $excelTime, $formatDate);
671         $myxls->write($row, 2, $log->ip, '');
672         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
673         $myxls->write($row, 3, $fullname, '');
674         $myxls->write($row, 4, $log->module.' '.$log->action, '');
675         $myxls->write($row, 5, $log->info, '');
677         $row++;
678     }
680     $workbook->close();
681     return true;
684 function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
685                         $modid, $modaction, $groupid) {
687     global $CFG, $DB;
689     require_once("$CFG->libdir/odslib.class.php");
691     if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
692                        $modname, $modid, $modaction, $groupid)) {
693         return false;
694     }
696     $courses = array();
698     if ($course->id == SITEID) {
699         $courses[0] = '';
700         if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
701             foreach ($ccc as $cc) {
702                 $courses[$cc->id] = $cc->shortname;
703             }
704         }
705     } else {
706         $courses[$course->id] = $course->shortname;
707     }
709     $count=0;
710     $ldcache = array();
711     $tt = getdate(time());
712     $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
714     $strftimedatetime = get_string("strftimedatetime");
716     $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
717     $filename = 'logs_'.userdate(time(),get_string('backupnameformat'),99,false);
718     $filename .= '.ods';
720     $workbook = new MoodleODSWorkbook('-');
721     $workbook->send($filename);
723     $worksheet = array();
724     $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
725                         get_string('fullnamecourse'),    get_string('action'), get_string('info'));
727     // Creating worksheets
728     for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
729         $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
730         $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
731         $worksheet[$wsnumber]->set_column(1, 1, 30);
732         $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
733                                     userdate(time(), $strftimedatetime));
734         $col = 0;
735         foreach ($headers as $item) {
736             $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
737             $col++;
738         }
739     }
741     if (empty($logs['logs'])) {
742         $workbook->close();
743         return true;
744     }
746     $formatDate =& $workbook->add_format();
747     $formatDate->set_num_format(get_string('log_excel_date_format'));
749     $row = FIRSTUSEDEXCELROW;
750     $wsnumber = 1;
751     $myxls =& $worksheet[$wsnumber];
752     foreach ($logs['logs'] as $log) {
753         if (isset($ldcache[$log->module][$log->action])) {
754             $ld = $ldcache[$log->module][$log->action];
755         } else {
756             $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
757             $ldcache[$log->module][$log->action] = $ld;
758         }
759         if ($ld && !empty($log->info)) {
760             // ugly hack to make sure fullname is shown correctly
761             if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
762                 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
763             } else {
764                 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
765             }
766         }
768         // Filter log->info
769         $log->info = format_string($log->info);
770         $log->info = strip_tags(urldecode($log->info));  // Some XSS protection
772         if ($nroPages>1) {
773             if ($row > EXCELROWS) {
774                 $wsnumber++;
775                 $myxls =& $worksheet[$wsnumber];
776                 $row = FIRSTUSEDEXCELROW;
777             }
778         }
780         $myxls->write_string($row, 0, $courses[$log->course]);
781         $myxls->write_date($row, 1, $log->time);
782         $myxls->write_string($row, 2, $log->ip);
783         $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
784         $myxls->write_string($row, 3, $fullname);
785         $myxls->write_string($row, 4, $log->module.' '.$log->action);
786         $myxls->write_string($row, 5, $log->info);
788         $row++;
789     }
791     $workbook->close();
792     return true;
796 function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
797     global $CFG, $USER;
798     if (empty($CFG->gdversion)) {
799         echo "(".get_string("gdneed").")";
800     } else {
801         // MDL-10818, do not display broken graph when user has no permission to view graph
802         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
803             ($course->showreports and $USER->id == $userid)) {
804             echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
805                  '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
806         }
807     }
811 function print_overview($courses) {
812     global $CFG, $USER, $DB;
814     $htmlarray = array();
815     if ($modules = $DB->get_records('modules')) {
816         foreach ($modules as $mod) {
817             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
818                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
819                 $fname = $mod->name.'_print_overview';
820                 if (function_exists($fname)) {
821                     $fname($courses,$htmlarray);
822                 }
823             }
824         }
825     }
826     foreach ($courses as $course) {
827         print_simple_box_start('center', '100%', '', 5, "coursebox");
828         $linkcss = '';
829         if (empty($course->visible)) {
830             $linkcss = 'class="dimmed"';
831         }
832         print_heading('<a title="'. format_string($course->fullname).'" '.$linkcss.' href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'. format_string($course->fullname).'</a>');
833         if (array_key_exists($course->id,$htmlarray)) {
834             foreach ($htmlarray[$course->id] as $modname => $html) {
835                 echo $html;
836             }
837         }
838         print_simple_box_end();
839     }
843 /**
844  * This function trawls through the logs looking for
845  * anything new since the user's last login
846  */
847 function print_recent_activity($course) {
848     // $course is an object
849     global $CFG, $USER, $SESSION, $DB;
851     $context = get_context_instance(CONTEXT_COURSE, $course->id);
853     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
855     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
857     if (!has_capability('moodle/legacy:guest', $context, NULL, false)) {
858         if (!empty($USER->lastcourseaccess[$course->id])) {
859             if ($USER->lastcourseaccess[$course->id] > $timestart) {
860                 $timestart = $USER->lastcourseaccess[$course->id];
861             }
862         }
863     }
865     echo '<div class="activitydate">';
866     echo get_string('activitysince', '', userdate($timestart));
867     echo '</div>';
868     echo '<div class="activityhead">';
870     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
872     echo "</div>\n";
874     $content = false;
876 /// Firstly, have there been any new enrolments?
878     $users = get_recent_enrolments($course->id, $timestart);
880     //Accessibility: new users now appear in an <OL> list.
881     if ($users) {
882         echo '<div class="newusers">';
883         print_headline(get_string("newusers").':', 3);
884         $content = true;
885         echo "<ol class=\"list\">\n";
886         foreach ($users as $user) {
887             $fullname = fullname($user, $viewfullnames);
888             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
889         }
890         echo "</ol>\n</div>\n";
891     }
893 /// Next, have there been any modifications to the course structure?
895     $modinfo =& get_fast_modinfo($course);
897     $changelist = array();
899     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
900                                             module = 'course' AND
901                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
902                                     array($timestart, $course->id), "id ASC");
904     if ($logs) {
905         $actions  = array('add mod', 'update mod', 'delete mod');
906         $newgones = array(); // added and later deleted items
907         foreach ($logs as $key => $log) {
908             if (!in_array($log->action, $actions)) {
909                 continue;
910             }
911             $info = split(' ', $log->info);
913             if ($info[0] == 'label') {     // Labels are ignored in recent activity
914                 continue;
915             }
917             if (count($info) != 2) {
918                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
919                 continue;
920             }
922             $modname    = $info[0];
923             $instanceid = $info[1];
925             if ($log->action == 'delete mod') {
926                 // unfortunately we do not know if the mod was visible
927                 if (!array_key_exists($log->info, $newgones)) {
928                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
929                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
930                 }
931             } else {
932                 if (!isset($modinfo->instances[$modname][$instanceid])) {
933                     if ($log->action == 'add mod') {
934                         // do not display added and later deleted activities
935                         $newgones[$log->info] = true;
936                     }
937                     continue;
938                 }
939                 $cm = $modinfo->instances[$modname][$instanceid];
940                 if (!$cm->uservisible) {
941                     continue;
942                 }
944                 if ($log->action == 'add mod') {
945                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
946                     $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>");
948                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
949                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
950                     $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>");
951                 }
952             }
953         }
954     }
956     if (!empty($changelist)) {
957         print_headline(get_string('courseupdates').':', 3);
958         $content = true;
959         foreach ($changelist as $changeinfo => $change) {
960             echo '<p class="activity">'.$change['text'].'</p>';
961         }
962     }
964 /// Now display new things from each module
966     $usedmodules = array();
967     foreach($modinfo->cms as $cm) {
968         if (isset($usedmodules[$cm->modname])) {
969             continue;
970         }
971         if (!$cm->uservisible) {
972             continue;
973         }
974         $usedmodules[$cm->modname] = $cm->modname;
975     }
977     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
978         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
979             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
980             $print_recent_activity = $modname.'_print_recent_activity';
981             if (function_exists($print_recent_activity)) {
982                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
983                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
984             }
985         } else {
986             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
987         }
988     }
990     if (! $content) {
991         echo '<p class="message">'.get_string('nothingnew').'</p>';
992     }
995 /**
996  * For a given course, returns an array of course activity objects
997  * Each item in the array contains he following properties:
998  */
999 function get_array_of_activities($courseid) {
1000 //  cm - course module id
1001 //  mod - name of the module (eg forum)
1002 //  section - the number of the section (eg week or topic)
1003 //  name - the name of the instance
1004 //  visible - is the instance visible or not
1005 //  groupingid - grouping id
1006 //  groupmembersonly - is this instance visible to group members only
1007 //  extra - contains extra string to include in any link
1008     global $CFG, $DB;
1009     if(!empty($CFG->enableavailability)) {
1010         require_once($CFG->libdir.'/conditionlib.php');
1011     }
1013     $course = $DB->get_record('course', array('id'=>$courseid));
1015     if (empty($course)) {
1016         throw new moodle_exception('courseidnotfound');
1017     }
1019     $mod = array();
1021     $rawmods = get_course_mods($courseid);
1022     if (empty($rawmods)) {
1023         return $mod; // always return array
1024     }
1026     if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
1027        foreach ($sections as $section) {
1028            if (!empty($section->sequence)) {
1029                $sequence = explode(",", $section->sequence);
1030                foreach ($sequence as $seq) {
1031                    if (empty($rawmods[$seq])) {
1032                        continue;
1033                    }
1034                    $mod[$seq]->id               = $rawmods[$seq]->instance;
1035                    $mod[$seq]->cm               = $rawmods[$seq]->id;
1036                    $mod[$seq]->mod              = $rawmods[$seq]->modname;
1037                    $mod[$seq]->section          = $section->section;
1038                    $mod[$seq]->visible          = $rawmods[$seq]->visible;
1039                    $mod[$seq]->groupmode        = $rawmods[$seq]->groupmode;
1040                    $mod[$seq]->groupingid       = $rawmods[$seq]->groupingid;
1041                    $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
1042                    $mod[$seq]->indent           = $rawmods[$seq]->indent;
1043                    $mod[$seq]->completion       = $rawmods[$seq]->completion;
1044                    $mod[$seq]->extra            = "";
1045                    if(!empty($CFG->enableavailability)) {
1046                        condition_info::fill_availability_conditions($rawmods[$seq]);
1047                        $mod[$seq]->availablefrom    = $rawmods[$seq]->availablefrom;
1048                        $mod[$seq]->availableuntil   = $rawmods[$seq]->availableuntil;
1049                        $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1050                        $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1051                        $mod[$seq]->conditionsgrade  = $rawmods[$seq]->conditionsgrade;
1052                    }
1054                    $modname = $mod[$seq]->mod;
1055                    $functionname = $modname."_get_coursemodule_info";
1057                    if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1058                        continue;
1059                    }
1061                    include_once("$CFG->dirroot/mod/$modname/lib.php");
1063                    if (function_exists($functionname)) {
1064                        if ($info = $functionname($rawmods[$seq])) {
1065                            if (!empty($info->extra)) {
1066                                $mod[$seq]->extra = $info->extra;
1067                            }
1068                            if (!empty($info->icon)) {
1069                                $mod[$seq]->icon = $info->icon;
1070                            }
1071                            if (!empty($info->name)) {
1072                                $mod[$seq]->name = urlencode($info->name);
1073                            }
1074                        }
1075                    }
1076                    if (!isset($mod[$seq]->name)) {
1077                        $mod[$seq]->name = urlencode($DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance)));
1078                    }
1079                }
1080             }
1081         }
1082     }
1083     return $mod;
1087 /**
1088  * Returns reference to full info about modules in course (including visibility).
1089  * Cached and as fast as possible (0 or 1 db query).
1090  * @param $course object or 'reset' string to reset caches, modinfo may be updated in db
1091  * @return mixed courseinfo object or nothing if resetting
1092  */
1093 function &get_fast_modinfo(&$course, $userid=0) {
1094     global $CFG, $USER, $DB;
1095     if (!empty($CFG->enableavailability)) {
1096         require_once($CFG->libdir.'/conditionlib.php');
1097     }
1099     static $cache = array();
1101     if ($course === 'reset') {
1102         $cache = array();
1103         $nothing = null;
1104         return $nothing; // we must return some reference
1105     }
1107     if (empty($userid)) {
1108         $userid = $USER->id;
1109     }
1111     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
1112         return $cache[$course->id];
1113     }
1115     if (empty($course->modinfo)) {
1116         // no modinfo yet - load it
1117         rebuild_course_cache($course->id);
1118         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
1119     }
1121     $modinfo = new object();
1122     $modinfo->courseid  = $course->id;
1123     $modinfo->userid    = $userid;
1124     $modinfo->sections  = array();
1125     $modinfo->cms       = array();
1126     $modinfo->instances = array();
1127     $modinfo->groups    = null; // loaded only when really needed - the only one db query
1129     $info = unserialize($course->modinfo);
1130     if (!is_array($info)) {
1131         // hmm, something is wrong - lets try to fix it
1132         rebuild_course_cache($course->id);
1133         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
1134         $info = unserialize($course->modinfo);
1135         if (!is_array($info)) {
1136             return $modinfo;
1137         }
1138     }
1140     if ($info) {
1141         // detect if upgrade required
1142         $first = reset($info);
1143         if (!isset($first->id)) {
1144             rebuild_course_cache($course->id);
1145             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
1146             $info = unserialize($course->modinfo);
1147             if (!is_array($info)) {
1148                 return $modinfo;
1149             }
1150         }
1151     }
1153     $modlurals = array();
1155     // If we haven't already preloaded contexts for the course, do it now
1156     preload_course_contexts($course->id);
1158     foreach ($info as $mod) {
1159         if (empty($mod->name)) {
1160             // something is wrong here
1161             continue;
1162         }
1163         // reconstruct minimalistic $cm
1164         $cm = new object();
1165         $cm->id               = $mod->cm;
1166         $cm->instance         = $mod->id;
1167         $cm->course           = $course->id;
1168         $cm->modname          = $mod->mod;
1169         $cm->name             = urldecode($mod->name);
1170         $cm->visible          = $mod->visible;
1171         $cm->sectionnum       = $mod->section;
1172         $cm->groupmode        = $mod->groupmode;
1173         $cm->groupingid       = $mod->groupingid;
1174         $cm->groupmembersonly = $mod->groupmembersonly;
1175         $cm->indent           = $mod->indent;
1176         $cm->completion       = $mod->completion;
1177         $cm->extra            = isset($mod->extra) ? urldecode($mod->extra) : '';
1178         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
1179         $cm->uservisible      = true;
1180         if(!empty($CFG->enableavailability)) {
1181             // We must have completion information from modinfo. If it's not
1182             // there, cache needs rebuilding
1183             if(!isset($mod->availablefrom)) {
1184                 debugging('enableavailability option was changed; rebuilding '.
1185                     'cache for course '.$course->id);
1186                 rebuild_course_cache($course->id,true);
1187                 // Re-enter this routine to do it all properly
1188                 return get_fast_modinfo($course,$userid);
1189             }
1190             $cm->availablefrom    = $mod->availablefrom;
1191             $cm->availableuntil   = $mod->availableuntil;
1192             $cm->showavailability = $mod->showavailability;
1193             $cm->conditionscompletion = $mod->conditionscompletion;
1194             $cm->conditionsgrade  = $mod->conditionsgrade;
1195         }
1197         // preload long names plurals and also check module is installed properly
1198         if (!isset($modlurals[$cm->modname])) {
1199             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
1200                 continue;
1201             }
1202             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
1203         }
1204         $cm->modplural = $modlurals[$cm->modname];
1205         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
1206         
1207         if(!empty($CFG->enableavailability)) {
1208             // Unfortunately the next call really wants to call 
1209             // get_fast_modinfo, but that would be recursive, so we fake up a 
1210             // modinfo for it already
1211             if(empty($minimalmodinfo)) {
1212                 $minimalmodinfo=new stdClass();
1213                 $minimalmodinfo->cms=array();
1214                 foreach($info as $mod) {
1215                     $minimalcm=new stdClass();
1216                     $minimalcm->id=$mod->cm;
1217                     $minimalcm->name=urldecode($mod->name);
1218                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
1219                 }
1220             }
1222             // Get availability information
1223             $ci = new condition_info($cm);
1224             $cm->available=$ci->is_available($cm->availableinfo,true,$userid,
1225                 $minimalmodinfo);
1226         } else {
1227             $cm->available=true;
1228         }
1229         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
1230             $cm->uservisible = false;
1232         } else if (!empty($CFG->enablegroupings) and !empty($cm->groupmembersonly)
1233                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
1234             if (is_null($modinfo->groups)) {
1235                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
1236             }
1237             if (empty($modinfo->groups[$cm->groupingid])) {
1238                 $cm->uservisible = false;
1239             }
1240         }
1242         if (!isset($modinfo->instances[$cm->modname])) {
1243             $modinfo->instances[$cm->modname] = array();
1244         }
1245         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
1246         $modinfo->cms[$cm->id] =& $cm;
1248         // reconstruct sections
1249         if (!isset($modinfo->sections[$cm->sectionnum])) {
1250             $modinfo->sections[$cm->sectionnum] = array();
1251         }
1252         $modinfo->sections[$cm->sectionnum][] = $cm->id;
1254         unset($cm);
1255     }
1257     unset($cache[$course->id]); // prevent potential reference problems when switching users
1258     $cache[$course->id] = $modinfo;
1260     // Ensure cache does not use too much RAM
1261     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
1262         array_shift($cache);
1263     }
1265     return $cache[$course->id];
1268 /**
1269  * Returns a number of useful structures for course displays
1270  */
1271 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1272     global $DB,$COURSE;
1274     $mods          = array();    // course modules indexed by id
1275     $modnames      = array();    // all course module names (except resource!)
1276     $modnamesplural= array();    // all course module names (plural form)
1277     $modnamesused  = array();    // course module names used
1279     if ($allmods = $DB->get_records("modules")) {
1280         foreach ($allmods as $mod) {
1281             if ($mod->visible) {
1282                 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1283                 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1284             }
1285         }
1286         asort($modnames, SORT_LOCALE_STRING);
1287     } else {
1288         print_error("nomodules", 'debug');
1289     }
1291     $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1292     $modinfo = get_fast_modinfo($course);
1294     if ($rawmods=$modinfo->cms) {
1295         foreach($rawmods as $mod) {    // Index the mods
1296             if (empty($modnames[$mod->modname])) {
1297                 continue;
1298             }
1299             $mods[$mod->id] = $mod;
1300             $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1301             if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1302                 continue;
1303             }
1304             // Check groupings
1305             if (!groups_course_module_visible($mod)) {
1306                 continue;
1307             }
1308             $modnamesused[$mod->modname] = $modnames[$mod->modname];
1309         }
1310         if ($modnamesused) {
1311             asort($modnamesused, SORT_LOCALE_STRING);
1312         }
1313     }
1317 function get_all_sections($courseid) {
1318     global $DB;
1319     return $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1320                        "section, id, course, summary, sequence, visible");
1323 function course_set_display($courseid, $display=0) {
1324     global $USER, $DB;
1326     if ($display == "all" or empty($display)) {
1327         $display = 0;
1328     }
1330     if (empty($USER->id) or $USER->username == 'guest') {
1331         //do not store settings in db for guests
1332     } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
1333         $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
1334     } else {
1335         $record = new object();
1336         $record->userid = $USER->id;
1337         $record->course = $courseid;
1338         $record->display = $display;
1339         if (!$DB->insert_record("course_display", $record)) {
1340             notify("Could not save your course display!");
1341         }
1342     }
1344     return $USER->display[$courseid] = $display;  // Note: = not ==
1347 /**
1348  * For a given course section, markes it visible or hidden,
1349  * and does the same for every activity in that section
1350  */
1351 function set_section_visible($courseid, $sectionnumber, $visibility) {
1352     global $DB;
1354     if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1355         $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1356         if (!empty($section->sequence)) {
1357             $modules = explode(",", $section->sequence);
1358             foreach ($modules as $moduleid) {
1359                 set_coursemodule_visible($moduleid, $visibility, true);
1360             }
1361         }
1362         rebuild_course_cache($courseid);
1363     }
1366 /**
1367  * Prints a section full of activity modules
1368  */
1369 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
1370     global $CFG, $USER, $DB, $PAGE;
1372     static $initialised;
1374     static $groupbuttons;
1375     static $groupbuttonslink;
1376     static $isediting;
1377     static $ismoving;
1378     static $strmovehere;
1379     static $strmovefull;
1380     static $strunreadpostsone;
1381     static $usetracking;
1382     static $groupings;
1385     if (!isset($initialised)) {
1386         $groupbuttons     = ($course->groupmode or (!$course->groupmodeforce));
1387         $groupbuttonslink = (!$course->groupmodeforce);
1388         $isediting        = $PAGE->user_is_editing();
1389         $ismoving         = $isediting && ismoving($course->id);
1390         if ($ismoving) {
1391             $strmovehere  = get_string("movehere");
1392             $strmovefull  = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
1393         }
1394         include_once($CFG->dirroot.'/mod/forum/lib.php');
1395         if ($usetracking = forum_tp_can_track_forums()) {
1396             $strunreadpostsone = get_string('unreadpostsone', 'forum');
1397         }
1398         $initialised = true;
1399     }
1401     $labelformatoptions = new object();
1402     $labelformatoptions->noclean = true;
1404 /// Casting $course->modinfo to string prevents one notice when the field is null
1405     $modinfo = get_fast_modinfo($course);
1408     //Acccessibility: replace table with list <ul>, but don't output empty list.
1409     if (!empty($section->sequence)) {
1411         // Fix bug #5027, don't want style=\"width:$width\".
1412         echo "<ul class=\"section img-text\">\n";
1413         $sectionmods = explode(",", $section->sequence);
1415         foreach ($sectionmods as $modnumber) {
1416             if (empty($mods[$modnumber])) {
1417                 continue;
1418             }
1420             $mod = $mods[$modnumber];
1422             if ($ismoving and $mod->id == $USER->activitycopy) {
1423                 // do not display moving mod
1424                 continue;
1425             }
1427             if (isset($modinfo->cms[$modnumber])) {
1428                 // We can continue (because it will not be displayed at all)
1429                 // if:
1430                 // 1) The activity is not visible to users
1431                 // and
1432                 // 2a) The 'showavailability' option is not set (if that is set,
1433                 //     we need to display the activity so we can show 
1434                 //     availability info)
1435                 // or
1436                 // 2b) The 'availableinfo' is empty, i.e. the activity was 
1437                 //     hidden in a way that leaves no info, such as using the 
1438                 //     eye icon.
1439                 if (!$modinfo->cms[$modnumber]->uservisible &&
1440                     (empty($modinfo->cms[$modnumber]->showavailability) ||
1441                       empty($modinfo->cms[$modnumber]->availableinfo))) {
1442                     // visibility shortcut
1443                     continue;
1444                 }
1445             } else {
1446                 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1447                     // module not installed
1448                     continue;
1449                 }
1450                 if (!coursemodule_visible_for_user($mod) &&
1451                     empty($mod->showavailability)) {
1452                     // full visibility check
1453                     continue;
1454                 }
1455             }
1457             // In some cases the activity is visible to user, but it is 
1458             // dimmed. This is done if viewhiddenactivities is true and if:
1459             // 1. the activity is not visible, or
1460             // 2. the activity has dates set which do not include current, or
1461             // 3. the activity has any other conditions set (regardless of whether
1462             //    current user meets them)
1463             $canviewhidden = has_capability(
1464                 'moodle/course:viewhiddenactivities',
1465                 get_context_instance(CONTEXT_MODULE, $mod->id));
1466             $accessiblebutdim = false;
1467             if ($canviewhidden) {
1468                 $accessiblebutdim = !$mod->visible;
1469                 if (!empty($CFG->enableavailability)) {
1470                     $accessiblebutdim = $accessiblebutdim ||
1471                         $mod->availablefrom > time() ||
1472                         ($mod->availableuntil && $mod->availableuntil < time()) ||
1473                         count($mod->conditionsgrade) > 0 || 
1474                         count($mod->conditionscompletion) > 0;
1475                 }
1476             }
1478             echo '<li class="activity '.$mod->modname.'" id="module-'.$modnumber.'">';  // Unique ID
1479             if ($ismoving) {
1480                 echo '<a title="'.$strmovefull.'"'.
1481                      ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
1482                      '<img class="movetarget" src="'.$CFG->pixpath.'/movehere.gif" '.
1483                      ' alt="'.$strmovehere.'" /></a><br />
1484                      ';
1485             }
1487             if ($mod->indent) {
1488                 print_spacer(12, 20 * $mod->indent, false);
1489             }
1491             $extra = '';
1492             if (!empty($modinfo->cms[$modnumber]->extra)) {
1493                 $extra = $modinfo->cms[$modnumber]->extra;
1494             }
1496             if ($mod->modname == "label") {
1497                 if ($accessiblebutdim || !$mod->uservisible) {
1498                     echo '<div class="dimmed_text"><span class="accesshide">'.
1499                         get_string('hiddenfromstudents').'</span>';
1500                 }
1501                 echo format_text($extra, FORMAT_HTML, $labelformatoptions);
1502                 if ($accessiblebutdim || !$mod->uservisible) {
1503                     echo "</div>";
1504                 }
1505                 if (!empty($CFG->enablegroupings) && !empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1506                     if (!isset($groupings)) {
1507                         $groupings = groups_get_all_groupings($course->id);
1508                     }
1509                     echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1510                 }
1512             } else { // Normal activity
1513                 $instancename = format_string($modinfo->cms[$modnumber]->name, true,  $course->id);
1515                 $customicon = $modinfo->cms[$modnumber]->icon;
1516                 if (!empty($customicon)) {
1517                     if (substr($customicon, 0, 4) === 'mod/') {
1518                         $icon = "$CFG->modpixpath/".substr($customicon, 4);
1519                     } else {
1520                         $icon = "$CFG->pixpath/".$customicon;
1521                     }
1522                 } else {
1523                     $icon = "$CFG->modpixpath/$mod->modname/icon.gif";
1524                 }
1526                 //Accessibility: for files get description via icon.
1527                 $altname = '';
1528                 if ('resource'==$mod->modname) {
1529                     if (!empty($customicon)) {
1530                         $possaltname = $customicon;
1532                         $mimetype = mimeinfo_from_icon('type', $possaltname);
1533                         $altname = get_mimetype_description($mimetype);
1534                     } else {
1535                         $altname = $mod->modfullname;
1536                     }
1537                 } else {
1538                     $altname = $mod->modfullname;
1539                 }
1540                 // Avoid unnecessary duplication.
1541                 if (false!==stripos($instancename, $altname)) {
1542                     $altname = '';
1543                 }
1544                 // File type after name, for alphabetic lists (screen reader).
1545                 if ($altname) {
1546                     $altname = get_accesshide(' '.$altname);
1547                 }
1549                 // We may be displaying this just in order to show information
1550                 // about visibility, without the actual link
1551                 if ($mod->uservisible) {
1552                     // Display normal module link
1553                     if (!$accessiblebutdim) {
1554                         $linkcss = '';
1555                         $accesstext  ='';
1556                     } else {
1557                         $linkcss = ' class="dimmed" ';
1558                         $accesstext = '<span class="accesshide">'.
1559                             get_string('hiddenfromstudents').': </span>';
1560                     }
1562                     echo '<a '.$linkcss.' '.$extra.
1563                          ' href="'.$CFG->wwwroot.'/mod/'.$mod->modname.'/view.php?id='.$mod->id.'">'.                         
1564                          '<img src="'.$icon.'" class="activityicon" alt="" /> '.
1565                          $accesstext.'<span>'.$instancename.$altname.'</span></a>';
1567                     if (!empty($CFG->enablegroupings) && !empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
1568                         if (!isset($groupings)) {
1569                             $groupings = groups_get_all_groupings($course->id);
1570                         }
1571                         echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
1572                     }
1573                 } else {
1574                     // Display greyed-out text of link
1575                     echo '<span class="dimmed_text" '.$extra.' ><span class="accesshide">'.
1576                         get_string('notavailableyet','condition').': </span>'.
1577                         '<img src="'.$icon.'" class="activityicon" alt="" /> <span>'.
1578                         $instancename.$altname.'</span></span>';
1579                 }
1580             }
1581             if ($usetracking && $mod->modname == 'forum') {
1582                 if ($unread = forum_tp_count_forum_unread_posts($mod, $course)) {
1583                     echo '<span class="unread"> <a href="'.$CFG->wwwroot.'/mod/forum/view.php?id='.$mod->id.'">';
1584                     if ($unread == 1) {
1585                         echo $strunreadpostsone;
1586                     } else {
1587                         print_string('unreadpostsnumber', 'forum', $unread);
1588                     }
1589                     echo '</a></span>';
1590                 }
1591             }
1593             if ($isediting) {
1594                 // TODO: we must define this as mod property!
1595                 if ($groupbuttons and $mod->modname != 'label' and $mod->modname != 'resource' and $mod->modname != 'glossary') {
1596                     if (! $mod->groupmodelink = $groupbuttonslink) {
1597                         $mod->groupmode = $course->groupmode;
1598                     }
1600                 } else {
1601                     $mod->groupmode = false;
1602                 }
1603                 echo '&nbsp;&nbsp;';
1604                 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
1605             }
1607             // Completion
1608             $completioninfo = new completion_info($course);
1609             $completion = $hidecompletion
1610                 ? COMPLETION_TRACKING_NONE
1611                 : $completioninfo->is_enabled($mod);
1612             if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() && 
1613                 !isguestuser() && $mod->uservisible) {
1614                 $completiondata = $completioninfo->get_data($mod,true);
1615                 $completionicon = '';
1616                 if ($isediting) {
1617                     switch ($completion) {
1618                         case COMPLETION_TRACKING_MANUAL :
1619                             $completionicon = 'manual-enabled'; break;
1620                         case COMPLETION_TRACKING_AUTOMATIC :
1621                             $completionicon = 'auto-enabled'; break;
1622                         default: // wtf
1623                     }
1624                 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
1625                     switch($completiondata->completionstate) {
1626                         case COMPLETION_INCOMPLETE:
1627                             $completionicon = 'manual-n'; break;
1628                         case COMPLETION_COMPLETE:
1629                             $completionicon = 'manual-y'; break;
1630                     }
1631                 } else { // Automatic
1632                     switch($completiondata->completionstate) {
1633                         case COMPLETION_INCOMPLETE:
1634                             $completionicon = 'auto-n'; break;
1635                         case COMPLETION_COMPLETE:
1636                             $completionicon = 'auto-y'; break;
1637                         case COMPLETION_COMPLETE_PASS:
1638                             $completionicon = 'auto-pass'; break;
1639                         case COMPLETION_COMPLETE_FAIL:
1640                             $completionicon = 'auto-fail'; break;
1641                     }
1642                 }
1643                 if ($completionicon) {
1644                     static $shownhelp=false;
1645                     $imgsrc = $CFG->pixpath.'/i/completion-'.$completionicon.'.gif';
1646                     $imgalt = get_string('completion-alt-'.$completionicon,'completion');
1647                     if ($completion==COMPLETION_TRACKING_MANUAL && !$isediting) {
1648                         $imgtitle = get_string('completion-title-'.$completionicon,'completion');
1649                         $newstate =
1650                             $completiondata->completionstate==COMPLETION_COMPLETE
1651                             ? COMPLETION_INCOMPLETE
1652                             : COMPLETION_COMPLETE;
1653                         // In manual mode the icon is a toggle form...
1655                         // If this completion state is used by the
1656                         // conditional activities system, we need to turn
1657                         // off the JS.
1658                         if (!empty($CFG->enableavailability) && 
1659                             condition_info::completion_value_used_as_condition(
1660                             $course, $mod)) {
1661                             $extraclass = ' preventjs';
1662                         } else {
1663                             $extraclass = '';
1664                         }
1665                         echo "
1666 <form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>";
1667                         if(!$shownhelp && !$isediting) {
1668                             helpbutton('completionicons',get_string('completionicons','completion'),'completion');
1669                             $shownhelp = true;
1670                         }
1671                         echo "
1672 <input type='hidden' name='id' value='{$mod->id}' />
1673 <input type='hidden' name='completionstate' value='$newstate' />
1674 <input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1675 </div></form>";
1676                     } else {
1677                         // In auto mode, or when editing, the icon is just an image
1678                         echo "<span class='autocompletion'>";
1679                         if (!$shownhelp && !$isediting) {
1680                             helpbutton('completionicons',get_string('completionicons','completion'),'completion');
1681                             $shownhelp = true;
1682                         }
1683                         echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
1684                     }
1685                 }
1686             }
1688             // Show availability information (for someone who isn't allowed to 
1689             // see the activity itself, or for staff)
1690             if (!$mod->uservisible) {
1691                 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
1692             } else if ($canviewhidden && !empty($CFG->enableavailability)) {
1693                 $ci = new condition_info($mod);
1694                 $fullinfo = $ci->get_full_information();
1695                 if($fullinfo) {
1696                     echo '<div class="availabilityinfo">'.get_string($mod->showavailability 
1697                         ? 'userrestriction_visible'
1698                         : 'userrestriction_hidden','condition',
1699                         $fullinfo).'</div>';
1700                 }
1701             }
1703             echo "</li>\n";
1704         }
1706     } elseif ($ismoving) {
1707         echo "<ul class=\"section\">\n";
1708     }
1710     if ($ismoving) {
1711         echo '<li><a title="'.$strmovefull.'"'.
1712              ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
1713              '<img class="movetarget" src="'.$CFG->pixpath.'/movehere.gif" '.
1714              ' alt="'.$strmovehere.'" /></a></li>
1715              ';
1716     }
1717     if (!empty($section->sequence) || $ismoving) {
1718         echo "</ul><!--class='section'-->\n\n";
1719     }
1722 /**
1723  * Prints the menus to add activities and resources.
1724  */
1725 function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
1726     global $CFG;
1728     // check to see if user can add menus
1729     if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
1730         return false;
1731     }
1733     static $resources = false;
1734     static $activities = false;
1736     if ($resources === false) {
1737         $resources = array();
1738         $activities = array();
1740         foreach($modnames as $modname=>$modnamestr) {
1741             if (!course_allowed_module($course, $modname)) {
1742                 continue;
1743             }
1745             $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1746             if (!file_exists($libfile)) {
1747                 continue;
1748             }
1749             include_once($libfile);
1750             $gettypesfunc =  $modname.'_get_types';
1751             if (function_exists($gettypesfunc)) {
1752                 $types = $gettypesfunc();
1753                 foreach($types as $type) {
1754                     if (!isset($type->modclass) or !isset($type->typestr)) {
1755                         debugging('Incorrect activity type in '.$modname);
1756                         continue;
1757                     }
1758                     if ($type->modclass == MOD_CLASS_RESOURCE) {
1759                         $resources[$type->type] = $type->typestr;
1760                     } else {
1761                         $activities[$type->type] = $type->typestr;
1762                     }
1763                 }
1764             } else {
1765                 // all mods without type are considered activity
1766                 $activities[$modname] = $modnamestr;
1767             }
1768         }
1769     }
1771     $straddactivity = get_string('addactivity');
1772     $straddresource = get_string('addresource');
1774     $output  = '<div class="section_add_menus">';
1776     if (!$vertical) {
1777         $output .= '<div class="horizontal">';
1778     }
1780     if (!empty($resources)) {
1781         $output .= popup_form("$CFG->wwwroot/course/mod.php?id=$course->id&amp;section=$section&amp;sesskey=".sesskey()."&amp;add=",
1782                               $resources, "ressection$section", "", $straddresource, 'resource/types', $straddresource, true);
1783     }
1785     if (!empty($activities)) {
1786         $output .= ' ';
1787         $output .= popup_form("$CFG->wwwroot/course/mod.php?id=$course->id&amp;section=$section&amp;sesskey=".sesskey()."&amp;add=",
1788                     $activities, "section$section", "", $straddactivity, 'mods', $straddactivity, true);
1789     }
1791     if (!$vertical) {
1792         $output .= '</div>';
1793     }
1795     $output .= '</div>';
1797     if ($return) {
1798         return $output;
1799     } else {
1800         echo $output;
1801     }
1804 /**
1805  * Return the course category context for the category with id $categoryid, except
1806  * that if $categoryid is 0, return the system context.
1807  *
1808  * @param integer $categoryid a category id or 0.
1809  * @return object the corresponding context
1810  */
1811 function get_category_or_system_context($categoryid) {
1812     if ($categoryid) {
1813         return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1814     } else {
1815         return get_context_instance(CONTEXT_SYSTEM);
1816     }
1819 /**
1820  * Rebuilds the cached list of course activities stored in the database
1821  * @param int $courseid - id of course to rebuil, empty means all
1822  * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1823  */
1824 function rebuild_course_cache($courseid=0, $clearonly=false) {
1825     global $COURSE, $DB;
1827     if ($clearonly) {
1828         if (empty($courseid)) {
1829             $courseselect = array();
1830         } else {
1831             $courseselect = array('id'=>$courseid);
1832         }
1833         $DB->set_field('course', 'modinfo', null, $courseselect);
1834         // update cached global COURSE too ;-)
1835         if ($courseid == $COURSE->id) {
1836             $COURSE->modinfo = null;
1837         }
1838         // reset the fast modinfo cache
1839         $reset = 'reset';
1840         get_fast_modinfo($reset);
1841         return;
1842     }
1844     if ($courseid) {
1845         $select = array('id'=>$courseid);
1846     } else {
1847         $select = array();
1848         @set_time_limit(0);  // this could take a while!   MDL-10954
1849     }
1851     if ($rs = $DB->get_recordset("course", $select,'','id,fullname')) {
1852         foreach ($rs as $course) {
1853             $modinfo = serialize(get_array_of_activities($course->id));
1854             if (!$DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id))) {
1855                 notify("Could not cache module information for course '" . format_string($course->fullname) . "'!");
1856             }
1857             // update cached global COURSE too ;-)
1858             if ($course->id == $COURSE->id) {
1859                 $COURSE->modinfo = $modinfo;
1860             }
1861         }
1862         $rs->close();
1863     }
1864     // reset the fast modinfo cache
1865     $reset = 'reset';
1866     get_fast_modinfo($reset);
1869 /**
1870  * Gets the child categories of a given coures category. Uses a static cache
1871  * to make repeat calls efficient.
1872  *
1873  * @param unknown_type $parentid the id of a course category.
1874  * @return array all the child course categories.
1875  */
1876 function get_child_categories($parentid) {
1877     static $allcategories = null;
1879     // only fill in this variable the first time
1880     if (null == $allcategories) {
1881         $allcategories = array();
1883         $categories = get_categories();
1884         foreach ($categories as $category) {
1885             if (empty($allcategories[$category->parent])) {
1886                 $allcategories[$category->parent] = array();
1887             }
1888             $allcategories[$category->parent][] = $category;
1889         }
1890     }
1892     if (empty($allcategories[$parentid])) {
1893         return array();
1894     } else {
1895         return $allcategories[$parentid];
1896     }
1899 /**
1900  * This function recursively travels the categories, building up a nice list
1901  * for display. It also makes an array that list all the parents for each
1902  * category.
1903  *
1904  * For example, if you have a tree of categories like:
1905  *   Miscellaneous (id = 1)
1906  *      Subcategory (id = 2)
1907  *         Sub-subcategory (id = 4)
1908  *   Other category (id = 3)
1909  * Then after calling this function you will have
1910  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1911  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1912  *      3 => 'Other category');
1913  * $parents = array(2 => array(1), 4 => array(1, 2));
1914  *
1915  * If you specify $requiredcapability, then only categories where the current
1916  * user has that capability will be added to $list, although all categories
1917  * will still be added to $parents, and if you only have $requiredcapability
1918  * in a child category, not the parent, then the child catgegory will still be
1919  * included.
1920  *
1921  * If you specify the option $excluded, then that category, and all its children,
1922  * are omitted from the tree. This is useful when you are doing something like
1923  * moving categories, where you do not want to allow people to move a category
1924  * to be the child of itself.
1925  *
1926  * @param array $list For output, accumulates an array categoryid => full category path name
1927  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
1928  * @param string/array $requiredcapability if given, only categories where the current
1929  *      user has this capability will be added to $list. Can also be an array of capabilities,
1930  *      in which case they are all required.
1931  * @param integer $excludeid Omit this category and its children from the lists built.
1932  * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1933  * @param string $path For internal use, as part of recursive calls.
1934  */
1935 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1936         $excludeid = 0, $category = NULL, $path = "") {
1938     // initialize the arrays if needed
1939     if (!is_array($list)) {
1940         $list = array();
1941     }
1942     if (!is_array($parents)) {
1943         $parents = array();
1944     }
1946     if (empty($category)) {
1947         // Start at the top level.
1948         $category = new stdClass;
1949         $category->id = 0;
1950     } else {
1951         // This is the excluded category, don't include it.
1952         if ($excludeid > 0 && $excludeid == $category->id) {
1953             return;
1954         }
1956         // Update $path.
1957         if ($path) {
1958             $path = $path.' / '.format_string($category->name);
1959         } else {
1960             $path = format_string($category->name);
1961         }
1963         // Add this category to $list, if the permissions check out.
1964         if (empty($requiredcapability)) {
1965             $list[$category->id] = $path;
1967         } else {
1968             ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1969             $requiredcapability = (array)$requiredcapability;
1970             if (has_all_capabilities($requiredcapability, $category->context)) {
1971                 $list[$category->id] = $path;
1972             }
1973         }
1974     }
1976     // Add all the children recursively, while updating the parents array.
1977     if ($categories = get_child_categories($category->id)) {
1978         foreach ($categories as $cat) {
1979             if (!empty($category->id)) {
1980                 if (isset($parents[$category->id])) {
1981                     $parents[$cat->id]   = $parents[$category->id];
1982                 }
1983                 $parents[$cat->id][] = $category->id;
1984             }
1985             make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
1986         }
1987     }
1991 /**
1992  * Recursive function to print out all the categories in a nice format
1993  * with or without courses included
1994  */
1995 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
1996     global $CFG;
1998     // maxcategorydepth == 0 meant no limit
1999     if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
2000         return;
2001     }
2003     if (!$displaylist) {
2004         make_categories_list($displaylist, $parentslist);
2005     }
2007     if ($category) {
2008         if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
2009             print_category_info($category, $depth, $showcourses);
2010         } else {
2011             return;  // Don't bother printing children of invisible categories
2012         }
2014     } else {
2015         $category->id = "0";
2016     }
2018     if ($categories = get_child_categories($category->id)) {   // Print all the children recursively
2019         $countcats = count($categories);
2020         $count = 0;
2021         $first = true;
2022         $last = false;
2023         foreach ($categories as $cat) {
2024             $count++;
2025             if ($count == $countcats) {
2026                 $last = true;
2027             }
2028             $up = $first ? false : true;
2029             $down = $last ? false : true;
2030             $first = false;
2032             print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
2033         }
2034     }
2037 /**
2038  * This function will return $options array for choose_from_menu, with whitespace to denote nesting.
2039  */
2040 function make_categories_options() {
2041     make_categories_list($cats,$parents);
2042     foreach ($cats as $key => $value) {
2043         if (array_key_exists($key,$parents)) {
2044             if ($indent = count($parents[$key])) {
2045                 for ($i = 0; $i < $indent; $i++) {
2046                     $cats[$key] = '&nbsp;'.$cats[$key];
2047                 }
2048             }
2049         }
2050     }
2051     return $cats;
2054 /**
2055  * Prints the category info in indented fashion
2056  * This function is only used by print_whole_category_list() above
2057  */
2058 function print_category_info($category, $depth, $showcourses = false) {
2059     global $CFG, $DB;
2060     static $strallowguests, $strrequireskey, $strsummary;
2062     if (empty($strsummary)) {
2063         $strallowguests = get_string('allowguests');
2064         $strrequireskey = get_string('requireskey');
2065         $strsummary = get_string('summary');
2066     }
2068     $catlinkcss = $category->visible ? '' : ' class="dimmed" ';
2070     $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2071     if ($showcourses and $coursecount) {
2072         $catimage = '<img src="'.$CFG->pixpath.'/i/course.gif" alt="" />';
2073     } else {
2074         $catimage = "&nbsp;";
2075     }
2077     echo "\n\n".'<table class="categorylist">';
2079     $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.password,c.summary,c.guest,c.cost,c.currency');
2080     if ($showcourses and $coursecount) {
2082         echo '<tr>';
2084         if ($depth) {
2085             $indent = $depth*30;
2086             $rows = count($courses) + 1;
2087             echo '<td class="category indentation" rowspan="'.$rows.'" valign="top">';
2088             print_spacer(10, $indent);
2089             echo '</td>';
2090         }
2092         echo '<td valign="top" class="category image">'.$catimage.'</td>';
2093         echo '<td valign="top" class="category name">';
2094         echo '<a '.$catlinkcss.' href="'.$CFG->wwwroot.'/course/category.php?id='.$category->id.'">'. format_string($category->name).'</a>';
2095         echo '</td>';
2096         echo '<td class="category info">&nbsp;</td>';
2097         echo '</tr>';
2099         // does the depth exceed maxcategorydepth
2100         // maxcategorydepth == 0 or unset meant no limit
2102         $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
2104         if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
2105             foreach ($courses as $course) {
2106                 $linkcss = $course->visible ? '' : ' class="dimmed" ';
2107                 echo '<tr><td valign="top">&nbsp;';
2108                 echo '</td><td valign="top" class="course name">';
2109                 echo '<a '.$linkcss.' href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'. format_string($course->fullname).'</a>';
2110                 echo '</td><td align="right" valign="top" class="course info">';
2111                 if ($course->guest ) {
2112                     echo '<a title="'.$strallowguests.'" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">';
2113                     echo '<img alt="'.$strallowguests.'" src="'.$CFG->pixpath.'/i/guest.gif" /></a>';
2114                 } else {
2115                     echo '<img alt="" style="width:18px;height:16px;" src="'.$CFG->pixpath.'/spacer.gif" />';
2116                 }
2117                 if ($course->password) {
2118                     echo '<a title="'.$strrequireskey.'" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">';
2119                     echo '<img alt="'.$strrequireskey.'" src="'.$CFG->pixpath.'/i/key.gif" /></a>';
2120                 } else {
2121                     echo '<img alt="" style="width:18px;height:16px;" src="'.$CFG->pixpath.'/spacer.gif" />';
2122                 }
2123                 if ($course->summary) {
2124                     link_to_popup_window ('/course/info.php?id='.$course->id, 'courseinfo',
2125                                           '<img alt="'.$strsummary.'" src="'.$CFG->pixpath.'/i/info.gif" />',
2126                                            400, 500, $strsummary);
2127                 } else {
2128                     echo '<img alt="" style="width:18px;height:16px;" src="'.$CFG->pixpath.'/spacer.gif" />';
2129                 }
2130                 echo '</td></tr>';
2131             }
2132         }
2133     } else {
2135         echo '<tr>';
2137         if ($depth) {
2138             $indent = $depth*20;
2139             echo '<td class="category indentation" valign="top">';
2140             print_spacer(10, $indent);
2141             echo '</td>';
2142         }
2144         echo '<td valign="top" class="category name">';
2145         echo '<a '.$catlinkcss.' href="'.$CFG->wwwroot.'/course/category.php?id='.$category->id.'">'. format_string($category->name).'</a>';
2146         echo '</td>';
2147         echo '<td valign="top" class="category number">';
2148         if (count($courses)) {
2149            echo count($courses);
2150         }
2151         echo '</td></tr>';
2152     }
2153     echo '</table>';
2156 /**
2157  * Print the buttons relating to course requests.
2158  *
2159  * @param object $systemcontext the system context.
2160  */
2161 function print_course_request_buttons($systemcontext) {
2162     global $CFG, $DB;
2163     if (empty($CFG->enablecourserequests)) {
2164         return;
2165     }
2166     if (isloggedin() && !isguestuser() && !has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
2167     /// Print a button to request a new course
2168         print_single_button('request.php', NULL, get_string('requestcourse'), 'get');
2169     }
2170     /// Print a button to manage pending requests
2171     if (has_capability('moodle/site:approvecourse', $systemcontext)) {
2172         print_single_button('pending.php', NULL, get_string('coursespending'), 'get', '_self', false, '', !$DB->record_exists('course_request', array()));
2173     }
2176 /**
2177  * Prints the turn editing on/off button on course/index.php or course/category.php.
2178  *
2179  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2180  * @return string HTML of the editing button, or empty string, if this user is not allowed
2181  *      to see it.
2182  */
2183 function update_category_button($categoryid = 0) {
2184     global $CFG, $PAGE;
2186     // Check permissions.
2187     $context = get_category_or_system_context($categoryid);
2188     if (!has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context)) {
2189         return '';
2190     }
2192     // Work out the appropriate action.
2193     if ($PAGE->user_is_editing()) {
2194         $label = get_string('turneditingoff');
2195         $edit = 'off';
2196     } else {
2197         $label = get_string('turneditingon');
2198         $edit = 'on';
2199     }
2201     // Generate the button HTML.
2202     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2203     if ($categoryid) {
2204         $options['id'] = $categoryid;
2205         $page = 'category.php';
2206     } else {
2207         $page = 'index.php';
2208     }
2209     return print_single_button($CFG->wwwroot . '/course/' . $page, $options,
2210             $label, 'get', '', true);
2213 /**
2214  * Category is 0 (for all courses) or an object
2215  */
2216 function print_courses($category) {
2217     global $CFG;
2219     if (!is_object($category) && $category==0) {
2220         $categories = get_child_categories(0);  // Parent = 0   ie top-level categories only
2221         if (is_array($categories) && count($categories) == 1) {
2222             $category   = array_shift($categories);
2223             $courses    = get_courses_wmanagers($category->id,
2224                                                 'c.sortorder ASC',
2225                                                 array('password','summary','currency'));
2226         } else {
2227             $courses    = get_courses_wmanagers('all',
2228                                                 'c.sortorder ASC',
2229                                                 array('password','summary','currency'));
2230         }
2231         unset($categories);
2232     } else {
2233         $courses    = get_courses_wmanagers($category->id,
2234                                             'c.sortorder ASC',
2235                                             array('password','summary','currency'));
2236     }
2238     if ($courses) {
2239         echo '<ul class="unlist">';
2240         foreach ($courses as $course) {
2241             if ($course->visible == 1
2242                 || has_capability('moodle/course:viewhiddencourses',$course->context)) {
2243                 echo '<li>';
2244                 print_course($course);
2245                 echo "</li>\n";
2246             }
2247         }
2248         echo "</ul>\n";
2249     } else {
2250         print_heading(get_string("nocoursesyet"));
2251         $context = get_context_instance(CONTEXT_SYSTEM);
2252         if (has_capability('moodle/course:create', $context)) {
2253             $options = array();
2254             $options['category'] = $category->id;
2255             echo '<div class="addcoursebutton">';
2256             print_single_button($CFG->wwwroot.'/course/edit.php', $options, get_string("addnewcourse"));
2257             echo '</div>';
2258         }
2259     }
2262 /**
2263  * Print a description of a course, suitable for browsing in a list.
2264  *
2265  * @param object $course the course object.
2266  * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2267  */
2268 function print_course($course, $highlightterms = '') {
2269     global $CFG, $USER, $DB;
2271     if (isset($course->context)) {
2272         $context = $course->context;
2273     } else {
2274         $context = get_context_instance(CONTEXT_COURSE, $course->id);
2275     }
2277     $linkcss = $course->visible ? '' : ' class="dimmed" ';
2279     echo '<div class="coursebox clearfix">';
2280     echo '<div class="info">';
2281     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2282          $linkcss.' href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.
2283          highlight($highlightterms, format_string($course->fullname)).'</a></div>';
2285     /// first find all roles that are supposed to be displayed
2287     if (!empty($CFG->coursemanager)) {
2288         $managerroles = split(',', $CFG->coursemanager);
2289         $canseehidden = has_capability('moodle/role:viewhiddenassigns', $context);
2290         $namesarray = array();
2291         if (isset($course->managers)) {
2292             if (count($course->managers)) {
2293                 $rusers = $course->managers;
2294                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2296                  /// Rename some of the role names if needed
2297                 if (isset($context)) {
2298                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2299                 }
2301                 // keep a note of users displayed to eliminate duplicates
2302                 $usersshown = array();
2303                 foreach ($rusers as $ra) {
2305                     // if we've already displayed user don't again
2306                     if (in_array($ra->user->id,$usersshown)) {
2307                         continue;
2308                     }
2309                     $usersshown[] = $ra->user->id;
2311                     if ($ra->hidden == 0 || $canseehidden) {
2312                         $fullname = fullname($ra->user, $canviewfullnames);
2313                         if ($ra->hidden == 1) {
2314                             $status = " <img src=\"{$CFG->pixpath}/t/show.gif\" title=\"".get_string('userhashiddenassignments', 'role')."\" alt=\"".get_string('hiddenassign')."\" class=\"hide-show-image\"/>";
2315                         } else {
2316                             $status = '';
2317                         }
2319                         if (isset($aliasnames[$ra->roleid])) {
2320                             $ra->rolename = $aliasnames[$ra->roleid]->name;
2321                         }
2323                         $namesarray[] = format_string($ra->rolename)
2324                             . ': <a href="'.$CFG->wwwroot.'/user/view.php?id='.$ra->user->id.'&amp;course='.SITEID.'">'
2325                             . $fullname . '</a>' . $status;
2326                     }
2327                 }
2328             }
2329         } else {
2330             $rusers = get_role_users($managerroles, $context,
2331                                      true, '', 'r.sortorder ASC, u.lastname ASC', $canseehidden);
2332             if (is_array($rusers) && count($rusers)) {
2333                 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2335                 /// Rename some of the role names if needed
2336                 if (isset($context)) {
2337                     $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2338                 }
2340                 foreach ($rusers as $teacher) {
2341                     $fullname = fullname($teacher, $canviewfullnames);
2343                     /// Apply role names
2344                     if (isset($aliasnames[$teacher->roleid])) {
2345                         $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2346                     }
2348                     $namesarray[] = format_string($teacher->rolename)
2349                         . ': <a href="'.$CFG->wwwroot.'/user/view.php?id='.$teacher->id.'&amp;course='.SITEID.'">'
2350                         . $fullname . '</a>';
2351                 }
2352             }
2353         }
2355         if (!empty($namesarray)) {
2356             echo "<ul class=\"teachers\">\n<li>";
2357             echo implode('</li><li>', $namesarray);
2358             echo "</li></ul>";
2359         }
2360     }
2362     require_once("$CFG->dirroot/enrol/enrol.class.php");
2363     $enrol = enrolment_factory::factory($course->enrol);
2364     echo $enrol->get_access_icons($course);
2366     echo '</div><div class="summary">';
2367     $options = NULL;
2368     $options->noclean = true;
2369     $options->para = false;
2370     echo highlight($highlightterms, format_text($course->summary, FORMAT_MOODLE, $options,  $course->id));
2371     echo '</div>';
2372     echo '</div>';
2375 /**
2376  * Prints custom user information on the home page.
2377  * Over time this can include all sorts of information
2378  */
2379 function print_my_moodle() {
2380     global $USER, $CFG, $DB;
2382     if (empty($USER->id)) {
2383         print_error('nopermissions', '', '', 'See My Moodle');
2384     }
2386     $courses  = get_my_courses($USER->id, 'visible DESC,sortorder ASC', array('summary'));
2387     $rhosts   = array();
2388     $rcourses = array();
2389     if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2390         $rcourses = get_my_remotecourses($USER->id);
2391         $rhosts   = get_my_remotehosts();
2392     }
2394     if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2396         if (!empty($courses)) {
2397             echo '<ul class="unlist">';
2398             foreach ($courses as $course) {
2399                 if ($course->id == SITEID) {
2400                     continue;
2401                 }
2402                 echo '<li>';
2403                 print_course($course);
2404                 echo "</li>\n";
2405             }
2406             echo "</ul>\n";
2407         }
2409         // MNET
2410         if (!empty($rcourses)) {
2411             // at the IDP, we know of all the remote courses
2412             foreach ($rcourses as $course) {
2413                 print_remote_course($course, "100%");
2414             }
2415         } elseif (!empty($rhosts)) {
2416             // non-IDP, we know of all the remote servers, but not courses
2417             foreach ($rhosts as $host) {
2418                 print_remote_host($host, "100%");
2419             }
2420         }
2421         unset($course);
2422         unset($host);
2424         if ($DB->count_records("course") > (count($courses) + 1) ) {  // Some courses not being displayed
2425             echo "<table width=\"100%\"><tr><td align=\"center\">";
2426             print_course_search("", false, "short");
2427             echo "</td><td align=\"center\">";
2428             print_single_button("$CFG->wwwroot/course/index.php", NULL, get_string("fulllistofcourses"), "get");
2429             echo "</td></tr></table>\n";
2430         }
2432     } else {
2433         if ($DB->count_records("course_categories") > 1) {
2434             print_simple_box_start("center", "100%", "#FFFFFF", 5, "categorybox");
2435             print_whole_category_list();
2436             print_simple_box_end();
2437         } else {
2438             print_courses(0);
2439         }
2440     }
2444 function print_course_search($value="", $return=false, $format="plain") {
2445     global $CFG;
2446     static $count = 0;
2448     $count++;
2450     $id = 'coursesearch';
2452     if ($count > 1) {
2453         $id .= $count;
2454     }
2456     $strsearchcourses= get_string("searchcourses");
2458     if ($format == 'plain') {
2459         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2460         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2461         $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
2462         $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
2463         $output .= '<input type="submit" value="'.get_string('go').'" />';
2464         $output .= '</fieldset></form>';
2465     } else if ($format == 'short') {
2466         $output  = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2467         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2468         $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
2469         $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2470         $output .= '<input type="submit" value="'.get_string('go').'" />';
2471         $output .= '</fieldset></form>';
2472     } else if ($format == 'navbar') {
2473         $output  = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2474         $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
2475         $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
2476         $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
2477         $output .= '<input type="submit" value="'.get_string('go').'" />';
2478         $output .= '</fieldset></form>';
2479     }
2481     if ($return) {
2482         return $output;
2483     }
2484     echo $output;
2487 function print_remote_course($course, $width="100%") {
2488     global $CFG, $USER;
2490     $linkcss = '';
2492     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2494     echo '<div class="coursebox remotecoursebox clearfix">';
2495     echo '<div class="info">';
2496     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2497          $linkcss.' href="'.$url.'">'
2498         .  format_string($course->fullname) .'</a><br />'
2499         . format_string($course->hostname) . ' : '
2500         . format_string($course->cat_name) . ' : '
2501         . format_string($course->shortname). '</div>';
2502     echo '</div><div class="summary">';
2503     $options = NULL;
2504     $options->noclean = true;
2505     $options->para = false;
2506     echo format_text($course->summary, FORMAT_MOODLE, $options);
2507     echo '</div>';
2508     echo '</div>';
2511 function print_remote_host($host, $width="100%") {
2512     global $CFG, $USER;
2514     $linkcss = '';
2516     echo '<div class="coursebox clearfix">';
2517     echo '<div class="info">';
2518     echo '<div class="name">';
2519     echo '<img src="'.$CFG->pixpath.'/i/mnethost.gif" class="icon" alt="'.get_string('course').'" />';
2520     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2521         . s($host['name']).'</a> - ';
2522     echo $host['count'] . ' ' . get_string('courses');
2523     echo '</div>';
2524     echo '</div>';
2525     echo '</div>';
2529 /// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2531 function add_course_module($mod) {
2532     global $DB;
2534     $mod->added = time();
2535     unset($mod->id);
2537     return $DB->insert_record("course_modules", $mod);
2540 /**
2541  * Returns course section - creates new if does not exist yet.
2542  * @param int $relative section number
2543  * @param int $courseid
2544  * @return object $course_section object
2545  */
2546 function get_course_section($section, $courseid) {
2547     global $DB;
2549     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2550         return $cw;
2551     }
2552     $cw = new object();
2553     $cw->course   = $courseid;
2554     $cw->section  = $section;
2555     $cw->summary  = "";
2556     $cw->sequence = "";
2557     $id = $DB->insert_record("course_sections", $cw);
2558     return $DB->get_record("course_sections", array("id"=>$id));
2560 /**
2561  * Given a full mod object with section and course already defined, adds this module to that section.
2562  *
2563  * @param object $mod
2564  * @param int $beforemod An existing ID which we will insert the new module before
2565  * @return int The course_sections ID where the mod is inserted
2566  */
2567 function add_mod_to_section($mod, $beforemod=NULL) {
2568     global $DB;
2570     if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
2572         $section->sequence = trim($section->sequence);
2574         if (empty($section->sequence)) {
2575             $newsequence = "$mod->coursemodule";
2577         } else if ($beforemod) {
2578             $modarray = explode(",", $section->sequence);
2580             if ($key = array_keys($modarray, $beforemod->id)) {
2581                 $insertarray = array($mod->id, $beforemod->id);
2582                 array_splice($modarray, $key[0], 1, $insertarray);
2583                 $newsequence = implode(",", $modarray);
2585             } else {  // Just tack it on the end anyway
2586                 $newsequence = "$section->sequence,$mod->coursemodule";
2587             }
2589         } else {
2590             $newsequence = "$section->sequence,$mod->coursemodule";
2591         }
2593         if ($DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id))) {
2594             return $section->id;     // Return course_sections ID that was used.
2595         } else {
2596             return 0;
2597         }
2599     } else {  // Insert a new record
2600         $section->course   = $mod->course;
2601         $section->section  = $mod->section;
2602         $section->summary  = "";
2603         $section->sequence = $mod->coursemodule;
2604         return $DB->insert_record("course_sections", $section);
2605     }
2608 function set_coursemodule_groupmode($id, $groupmode) {
2609     global $DB;
2610     return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
2613 function set_coursemodule_idnumber($id, $idnumber) {
2614     global $DB;
2615     return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
2618 /**
2619 * $prevstateoverrides = true will set the visibility of the course module
2620 * to what is defined in visibleold. This enables us to remember the current
2621 * visibility when making a whole section hidden, so that when we toggle
2622 * that section back to visible, we are able to return the visibility of
2623 * the course module back to what it was originally.
2624 */
2625 function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
2626     global $DB;
2627     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2628         return false;
2629     }
2630     if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
2631         return false;
2632     }
2633     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2634         foreach($events as $event) {
2635             if ($visible) {
2636                 show_event($event);
2637             } else {
2638                 hide_event($event);
2639             }
2640         }
2641     }
2642     if ($prevstateoverrides) {
2643         if ($visible == '0') {
2644             // Remember the current visible state so we can toggle this back.
2645             $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
2646         } else {
2647             // Get the previous saved visible states.
2648             return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
2649         }
2650     }
2651     return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
2654 /**
2655  * Delete a course module and any associated data at the course level (events)
2656  * Until 1.5 this function simply marked a deleted flag ... now it
2657  * deletes it completely.
2658  *
2659  */
2660 function delete_course_module($id) {
2661     global $CFG, $DB;
2662     require_once($CFG->libdir.'/gradelib.php');
2664     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2665         return true;
2666     }
2667     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2668     //delete events from calendar
2669     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2670         foreach($events as $event) {
2671             delete_event($event->id);
2672         }
2673     }
2674     //delete grade items, outcome items and grades attached to modules
2675     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2676                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2677         foreach ($grade_items as $grade_item) {
2678             $grade_item->delete('moddelete');
2679         }
2680     }
2682     delete_context(CONTEXT_MODULE, $cm->id);
2683     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2686 function delete_mod_from_section($mod, $section) {
2687     global $DB;
2689     if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
2691         $modarray = explode(",", $section->sequence);
2693         if ($key = array_keys ($modarray, $mod)) {
2694             array_splice($modarray, $key[0], 1);
2695             $newsequence = implode(",", $modarray);
2696             return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2697         } else {
2698             return false;
2699         }
2701     }
2702     return false;
2705 /**
2706  * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2707  *
2708  * @param object $course
2709  * @param int $section
2710  * @param int $move (-1 or 1)
2711  */
2712 function move_section($course, $section, $move) {
2713 /// Moves a whole course section up and down within the course
2714     global $USER, $DB;
2716     if (!$move) {
2717         return true;
2718     }
2720     $sectiondest = $section + $move;
2722     if ($sectiondest > $course->numsections or $sectiondest < 1) {
2723         return false;
2724     }
2726     if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
2727         return false;
2728     }
2730     if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
2731         return false;
2732     }
2734     if (!$DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id))) {
2735         return false;
2736     }
2737     if (!$DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id))) {
2738         return false;
2739     }
2740     // if the focus is on the section that is being moved, then move the focus along
2741     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2742         course_set_display($course->id, $sectiondest);
2743     }
2745     // Check for duplicates and fix order if needed.
2746     // There is a very rare case that some sections in the same course have the same section id.
2747     $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
2748     $n = 0;
2749     foreach ($sections as $section) {
2750         if ($section->section != $n) {
2751             if (!$DB->set_field('course_sections', 'section', $n, array('id'=>$section->id))) {
2752                 return false;
2753             }
2754         }
2755         $n++;
2756     }
2757     return true;
2760 /**
2761  * Moves a section within a course, from a position to another.
2762  * Be very careful: $section and $destination refer to section number,
2763  * not id!.
2764  *
2765  * @param object $course
2766  * @param int $section Section number (not id!!!)
2767  * @param int $destination
2768  * @return boolean Result
2769  */
2770 function move_section_to($course, $section, $destination) {
2771 /// Moves a whole course section up and down within the course
2772     global $USER, $DB;
2774     if (!$destination && $destination != 0) {
2775         return true;
2776     }
2778     if ($destination > $course->numsections) {
2779         return false;
2780     }
2782     // Get all sections for this course and re-order them (2 of them should now share the same section number)
2783     if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2784             'section ASC, id ASC', 'id, section')) {
2785         return false;
2786     }
2788     $sections = reorder_sections($sections, $section, $destination);
2790     // Update all sections
2791     foreach ($sections as $id => $position) {
2792         $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2793     }
2795     // if the focus is on the section that is being moved, then move the focus along
2796     if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2797         course_set_display($course->id, $destination);
2798     }
2799     return true;
2802 /**
2803  * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2804  * an original position number and a target position number, rebuilds the array so that the
2805  * move is made without any duplication of section positions.
2806  * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2807  * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2808  *
2809  * @param array $sections
2810  * @param int $origin_position
2811  * @param int $target_position
2812  * @return array
2813  */
2814 function reorder_sections($sections, $origin_position, $target_position) {
2815     if (!is_array($sections)) {
2816         return false;
2817     }
2819     // We can't move section position 0
2820     if ($origin_position < 1) {
2821         echo "We can't move section position 0";
2822         return false;
2823     }
2825     // Locate origin section in sections array
2826     if (!$origin_key = array_search($origin_position, $sections)) {
2827         echo "searched position not in sections array";
2828         return false; // searched position not in sections array
2829     }
2831     // Extract origin section
2832     $origin_section = $sections[$origin_key];
2833     unset($sections[$origin_key]);
2835     // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2836     $found = false;
2837     $append_array = array();
2838     foreach ($sections as $id => $position) {
2839         if ($found) {
2840             $append_array[$id] = $position;
2841             unset($sections[$id]);
2842         }
2843         if ($position == $target_position) {
2844             $found = true;
2845         }
2846     }
2848     // Append moved section
2849     $sections[$origin_key] = $origin_section;
2851     // Append rest of array (if applicable)
2852     if (!empty($append_array)) {
2853         foreach ($append_array as $id => $position) {
2854             $sections[$id] = $position;
2855         }
2856     }
2858     // Renumber positions
2859     $position = 0;
2860     foreach ($sections as $id => $p) {
2861         $sections[$id] = $position;
2862         $position++;
2863     }
2865     return $sections;
2869 /**
2870  * Move the module object $mod to the specified $section
2871  * If $beforemod exists then that is the module
2872  * before which $modid should be inserted
2873  * All parameters are objects
2874  */
2875 function moveto_module($mod, $section, $beforemod=NULL) {
2876     global $DB;
2878 /// Remove original module from original section
2879     if (! delete_mod_from_section($mod->id, $mod->section)) {
2880         notify("Could not delete module from existing section");
2881     }
2883 /// Update module itself if necessary
2885     if ($mod->section != $section->id) {
2886         $mod->section = $section->id;
2887         if (!$DB->update_record("course_modules", $mod)) {
2888             return false;
2889         }
2890         // if moving to a hidden section then hide module
2891         if (!$section->visible) {
2892             set_coursemodule_visible($mod->id, 0);
2893         }
2894     }
2896 /// Add the module into the new section
2898     $mod->course       = $section->course;
2899     $mod->section      = $section->section;  // need relative reference
2900     $mod->coursemodule = $mod->id;
2902     if (! add_mod_to_section($mod, $beforemod)) {
2903         return false;
2904     }
2906     return true;
2909 function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
2910     global $CFG, $USER, $DB;
2912     static $str;
2913     static $sesskey;
2915     $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
2916     // no permission to edit
2917     if (!has_capability('moodle/course:manageactivities', $modcontext)) {
2918         return false;
2919     }
2921     if (!isset($str)) {
2922         $str->assign         = get_string("assignroles", 'role');
2923         $str->delete         = get_string("delete");
2924         $str->move           = get_string("move");
2925         $str->moveup         = get_string("moveup");
2926         $str->movedown       = get_string("movedown");
2927         $str->moveright      = get_string("moveright");
2928         $str->moveleft       = get_string("moveleft");
2929         $str->update         = get_string("update");
2930         $str->duplicate      = get_string("duplicate");
2931         $str->hide           = get_string("hide");
2932         $str->show           = get_string("show");
2933         $str->clicktochange  = get_string("clicktochange");
2934         $str->forcedmode     = get_string("forcedmode");
2935         $str->groupsnone     = get_string("groupsnone");
2936         $str->groupsseparate = get_string("groupsseparate");
2937         $str->groupsvisible  = get_string("groupsvisible");
2938         $sesskey = sesskey();
2939     }
2941     if ($section >= 0) {
2942         $section = '&amp;sr='.$section;   // Section return
2943     } else {
2944         $section = '';
2945     }
2947     if ($absolute) {
2948         $path = $CFG->wwwroot.'/course';
2949     } else {
2950         $path = '.';
2951     }
2952     if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2953         if ($mod->visible) {
2954             $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
2955                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2956                         ' src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" '.
2957                         ' alt="'.$str->hide.'" /></a>'."\n";
2958         } else {
2959             $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
2960                         '&amp;sesskey='.$sesskey.$section.'"><img'.
2961                         ' src="'.$CFG->pixpath.'/t/show.gif" class="iconsmall" '.
2962                         ' alt="'.$str->show.'" /></a>'."\n";
2963         }
2964     } else {
2965         $hideshow = '';
2966     }
2968     if ($mod->groupmode !== false) {
2969         if ($mod->groupmode == SEPARATEGROUPS) {
2970             $grouptitle = $str->groupsseparate;
2971             $groupclass = 'editing_groupsseparate';
2972             $groupimage = $CFG->pixpath.'/t/groups.gif';
2973             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
2974         } else if ($mod->groupmode == VISIBLEGROUPS) {
2975             $grouptitle = $str->groupsvisible;
2976             $groupclass = 'editing_groupsvisible';
2977             $groupimage = $CFG->pixpath.'/t/groupv.gif';
2978             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
2979         } else {
2980             $grouptitle = $str->groupsnone;
2981             $groupclass = 'editing_groupsnone';
2982             $groupimage = $CFG->pixpath.'/t/groupn.gif';
2983             $grouplink  = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
2984         }
2985         if ($mod->groupmodelink) {
2986             $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
2987                          '<img src="'.$groupimage.'" class="iconsmall" '.
2988                          'alt="'.$grouptitle.'" /></a>';
2989         } else {
2990             $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
2991                          ' src="'.$groupimage.'" class="iconsmall" '.
2992                          'alt="'.$grouptitle.'" />';
2993         }
2994     } else {
2995         $groupmode = "";
2996     }
2998     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2999         if ($moveselect) {
3000             $move =     '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
3001                         '&amp;sesskey='.$sesskey.$section.'"><img'.
3002                         ' src="'.$CFG->pixpath.'/t/move.gif" class="iconsmall" '.
3003                         ' alt="'.$str->move.'" /></a>'."\n";
3004         } else {
3005             $move =     '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
3006                         '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3007                         ' src="'.$CFG->pixpath.'/t/up.gif" class="iconsmall" '.
3008                         ' alt="'.$str->moveup.'" /></a>'."\n".
3009                         '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
3010                         '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
3011                         ' src="'.$CFG->pixpath.'/t/down.gif" class="iconsmall" '.
3012                         ' alt="'.$str->movedown.'" /></a>'."\n";
3013         }
3014     } else {
3015         $move = '';
3016     }
3018     $leftright = '';
3019     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
3021             if (right_to_left()) {   // Exchange arrows on RTL
3022                     $rightarrow = 'left.gif';
3023                     $leftarrow  = 'right.gif';
3024             } else {
3025                 $rightarrow = 'right.gif';
3026                 $leftarrow  = 'left.gif';
3027         }
3029         if ($indent > 0) {
3030             $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
3031                         '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
3032                         ' src="'.$CFG->pixpath.'/t/'.$leftarrow.'" class="iconsmall" '.
3033                         ' alt="'.$str->moveleft.'" /></a>'."\n";
3034         }
3035         if ($indent >= 0) {
3036             $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
3037                         '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
3038                         ' src="'.$CFG->pixpath.'/t/'.$rightarrow.'" class="iconsmall" '.
3039                         ' alt="'.$str->moveright.'" /></a>'."\n";
3040         }
3041     }
3042     if (has_capability('moodle/course:managegroups', $modcontext)){
3043         $context = get_context_instance(CONTEXT_MODULE, $mod->id);
3044         $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
3045             $context->id.'"><img src="'.$CFG->pixpath.'/i/roles.gif" alt="'.$str->assign.'" class="iconsmall"/></a>';
3046     } else {
3047         $assign = '';
3048     }
3050     return '<span class="commands">'."\n".$leftright.$move.
3051            '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
3052            '&amp;sesskey='.$sesskey.$section.'"><img'.
3053            ' src="'.$CFG->pixpath.'/t/edit.gif" class="iconsmall" '.
3054            ' alt="'.$str->update.'" /></a>'."\n".
3055            '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
3056            '&amp;sesskey='.$sesskey.$section.'"><img'.
3057            ' src="'.$CFG->pixpath.'/t/delete.gif" class="iconsmall" '.
3058            ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
3061 /**
3062  * given a course object with shortname & fullname, this function will
3063  * truncate the the number of chars allowed and add ... if it was too long
3064  */
3065 function course_format_name ($course,$max=100) {
3067     $str = $course->shortname.': '. $course->fullname;
3068     if (strlen($str) <= $max) {
3069         return $str;
3070     }
3071     else {
3072         return substr($str,0,$max-3).'...';
3073     }
3076 /**
3077  * This function will return true if the given course is a child course at all
3078  */
3079 function course_in_meta ($course) {
3080     global $DB;
3081     return $DB->record_exists("course_meta", array("child_course"=>$course->id));
3085 /**
3086  * Print standard form elements on module setup forms in mod/.../mod_form.php
3087  */
3088 function print_standard_coursemodule_settings($form, $features=null) {
3089     global $DB;
3090     if (!$course = $DB->get_record('course', array('id'=>$form->course))) {
3091         print_error("invalidcourseid");
3092     }
3093     print_groupmode_setting($form, $course);
3094     if (!empty($features->groupings)) {
3095         print_grouping_settings($form, $course);
3096     }
3097     print_visible_setting($form, $course);
3100 /**
3101  * Print groupmode form element on module setup forms in mod/.../mod_form.php
3102  */
3103 function print_groupmode_setting($form, $course=NULL) {
3104     global $DB;
3106     if (empty($course)) {
3107         if (!$course = $DB->get_record('course', array('id'=>$form->course))) {
3108             print_error("invalidcourseid");
3109         }
3110     }
3111     if ($form->coursemodule) {
3112         if (!$cm = $DB->get_record('course_modules', array('id'=>$form->coursemodule))) {
3113             print_error('invalidcoursemodule');
3114         }
3115         $groupmode = groups_get_activity_groupmode($cm);
3116     } else {
3117         $cm = null;
3118         $groupmode = groups_get_course_groupmode($course);
3119     }
3120     if ($course->groupmode or (!$course->groupmodeforce)) {
3121         echo '<tr valign="top">';
3122         echo '<td align="right"><b>'.get_string('groupmode').':</b></td>';
3123         echo '<td align="left">';
3124         $choices = array();
3125         $choices[NOGROUPS] = get_string('groupsnone');
3126         $choices[SEPARATEGROUPS] = get_string('groupsseparate');
3127         $choices[VISIBLEGROUPS] = get_string('groupsvisible');
3128         choose_from_menu($choices, 'groupmode', $groupmode, '', '', 0, false, $course->groupmodeforce);
3129         helpbutton('groupmode', get_string('groupmode'));
3130         echo '</td></tr>';
3131     }
3134 /**
3135  * Print groupmode form element on module setup forms in mod/.../mod_form.php
3136  */
3137 function print_grouping_settings($form, $course=NULL) {
3138     global $DB;
3140     if (empty($course)) {
3141         if (! $course = $DB->get_record('course', array('id'=>$form->course))) {
3142             print_error("invalidcourseid");
3143         }
3144     }
3145     if ($form->coursemodule) {
3146         if (!$cm = $DB->get_record('course_modules', array('id'=>$form->coursemodule))) {
3147             print_error('invalidcoursemodule');
3148         }
3149     } else {
3150         $cm = null;
3151     }
3153     $groupings = $DB->get_records_menu('groupings', array('courseid'=>$course->id), 'name', 'id, name');
3154     if (!empty($groupings)) {
3155         echo '<tr valign="top">';
3156         echo '<td align="right"><b>'.get_string('grouping', 'group').':</b></td>';
3157         echo '<td align="left">';
3159         $groupingid = isset($cm->groupingid) ? $cm->groupingid : 0;
3161         choose_from_menu($groupings, 'groupingid', $groupingid, get_string('none'), '', 0, false);
3162         echo '</td></tr>';
3164         $checked = empty($cm->groupmembersonly) ? '':'checked="checked"';
3165         echo '<tr valign="top">';
3166         echo '<td align="right"><b>'.get_string('groupmembersonly', 'group').':</b></td>';
3167         echo '<td align="left">';
3168         echo "<input type=\"checkbox\" name=\"groupmembersonly\" value=\"1\" $checked />";
3169         echo '</td></tr>';
3171     }
3174 /**
3175  * Print visibility setting form element on module setup forms in mod/.../mod_form.php
3176  */
3177 function print_visible_setting($form, $course=NULL) {
3178     global $DB;
3179     if (empty($course)) {
3180         if (!$course = $DB->get_record('course', array('id'=>$form->course))) {
3181             print_error("invalidcourseid");
3182         }
3183     }
3184     if ($form->coursemodule) {
3185         $visible = $DB->get_field('course_modules', 'visible', array('id'=>$form->coursemodule));
3186     } else {
3187         $visible = true;
3188     }
3190     if ($form->mode == 'add') { // in this case $form->section is the section number, not the id
3191         $hiddensection = !$DB->get_field('course_sections', 'visible', array('section'=>$form->section, 'course'=>$form->course));
3192     } else {
3193         $hiddensection = !$DB->get_field('course_sections', 'visible', array('id'=>$form->section));
3194     }
3195     if ($hiddensection) {
3196         $visible = false;
3197     }
3199     echo '<tr valign="top">';
3200     echo '<td align="right"><b>'.get_string('visible', '').':</b></td>';
3201     echo '<td align="left">';
3202     $choices = array(1 => get_string('show'), 0 => get_string('hide'));
3203     choose_from_menu($choices, 'visible', $visible, '', '', 0, false, $hiddensection);
3204     echo '</td></tr>';
3207 function update_restricted_mods($course, $mods) {
3208     global $DB;
3210 /// Delete all the current restricted list
3211     $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
3213     if (empty($course->restrictmodules)) {
3214         return;   // We're done
3215     }
3217 /// Insert the new list of restricted mods
3218     foreach ($mods as $mod) {
3219         if ($mod == 0) {
3220             continue; // this is the 'allow none' option
3221         }
3222         $am = new object();
3223         $am->course = $course->id;
3224         $am->module = $mod;
3225         $DB->insert_record('course_allowed_modules',$am);
3226     }
3229 /**
3230  * This function will take an int (module id) or a string (module name)
3231  * and return true or false, whether it's allowed in the given course (object)
3232  * $mod is not allowed to be an object, as the field for the module id is inconsistent
3233  * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3234  */
3236 function course_allowed_module($course,$mod) {
3237     global $DB;
3239     if (empty($course->restrictmodules)) {
3240         return true;
3241     }
3243     // Admins and admin-like people who can edit everything can also add anything.
3244     // This is a bit wierd, really.  I debated taking it out but it's enshrined in help for the setting.
3245     if (has_capability('moodle/course:update', get_context_instance(CONTEXT_SYSTEM))) {
3246         return true;
3247     }
3249     if (is_numeric($mod)) {
3250         $modid = $mod;
3251     } else if (is_string($mod)) {
3252         $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
3253     }
3254     if (empty($modid)) {
3255         return false;
3256     }
3258     return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
3261 /**
3262  * Recursively delete category including all subcategories and courses.
3263  * @param object $category
3264  * @param boolean $showfeedback display some notices
3265  * @return array return deleted courses
3266  */
3267 function category_delete_full($category, $showfeedback=true) {
3268     global $CFG, $DB;
3269     require_once($CFG->libdir.'/gradelib.php');
3270     require_once($CFG->libdir.'/questionlib.php');
3272     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3273         foreach ($children as $childcat) {
3274             category_delete_full($childcat, $showfeedback);
3275         }
3276     }
3278     $deletedcourses = array();
3279     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC')) {
3280         foreach ($courses as $course) {
3281             if (!delete_course($course, false)) {
3282                 throw new moodle_exception('cannotdeletecategorycourse','','',$course->shortname);
3283             }
3284             $deletedcourses[] = $course;
3285         }
3286     }
3288     // now delete anything that may depend on course category context
3289     grade_course_category_delete($category->id, 0, $showfeedback);
3290     if (!question_delete_course_category($category, 0, $showfeedback)) {
3291         throw new moodle_exception('cannotdeletecategoryquestions','','',$category->name);
3292     }
3294     // finally delete the category and it's context
3295     $DB->delete_records('course_categories', array('id'=>$category->id));
3296     delete_context(CONTEXT_COURSECAT, $category->id);
3298     events_trigger('course_category_deleted', $category);
3300     return $deletedcourses; 
3303 /**
3304  * Delete category, but move contents to another category.
3305  * @param object $ccategory
3306  * @param int $newparentid category id
3307  * @return bool status
3308  */
3309 function category_delete_move($category, $newparentid, $showfeedback=true) {
3310     global $CFG, $DB;
3311     require_once($CFG->libdir.'/gradelib.php');
3312     require_once($CFG->libdir.'/questionlib.php');
3314     if (!$newparentcat = $DB->get_record('course_categories', array('id'=>$newparentid))) {
3315         return false;
3316     }
3318     if ($children = $DB->get_records('course_categories', array('parent'=>$category->id), 'sortorder ASC')) {
3319         foreach ($children as $childcat) {
3320             move_category($childcat, $newparentcat);
3321         }
3322     }
3324     if ($courses = $DB->get_records('course', array('category'=>$category->id), 'sortorder ASC', 'id')) {
3325         if (!move_courses(array_keys($courses), $newparentid)) {
3326             notify("Error moving courses");
3327             return false;
3328         }
3329         notify(get_string('coursesmovedout', '', format_string($category->name)), 'notifysuccess');
3330     }
3332     // now delete anything that may depend on course category context
3333     grade_course_category_delete($category->id, $newparentid, $showfeedback);
3334     if (!question_delete_course_category($category, $newparentcat, $showfeedback)) {
3335         notify(get_string('errordeletingquestionsfromcategory', 'question', $category), 'notifysuccess');
3336         return false;
3337     }
3339     // finally delete the category and it's context
3340     $DB->delete_records('course_categories', array('id'=>$category->id));
3341     delete_context(CONTEXT_COURSECAT, $category->id);
3343     events_trigger('course_category_deleted', $category);
3345     notify(get_string('coursecategorydeleted', '', format_string($category->name)), 'notifysuccess');
3347     return true;
3350 /**
3351  * Efficiently moves many courses around while maintaining
3352  * sortorder in order.
3353  *
3354  * @param $courseids is an array of course ids
3355  */
3356 function move_courses($courseids, $categoryid) {
3357     global $CFG, $DB;
3359     if (!empty($courseids) and $category = $DB->get_record('course_categories', array('id'=>$categoryid))) {
3360         $courseids = array_reverse($courseids);
3361         $i = 1;
3363         foreach ($courseids as $courseid) {
3364             if (!$course  = $DB->get_record("course", array("id"=>$courseid))) {
3365                 notify("Error finding course $courseid");
3366             } else {
3367                 $course->category  = $categoryid;
3368                 $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
3370                 if (!$DB->update_record('course', $course)) {
3371                     notify("An error occurred - course not moved!");
3372                 }
3374                 $context   = get_context_instance(CONTEXT_COURSE, $course->id);
3375                 $newparent = get_context_instance(CONTEXT_COURSECAT, $course->category);
3376                 context_moved($context, $newparent);
3377             }
3378         }
3379         fix_course_sortorder();
3380     }
3381     return true;
3384 /**
3385  * Efficiently moves a category - NOTE that this can have
3386  * a huge impact access-control-wise...
3387  */
3388 function move_category($category, $newparentcat) {
3389     global $CFG, $DB;
3391     $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
3393     if (empty($newparentcat->id)) {
3394         $DB->set_field('course_categories', 'parent', 0, array('id'=>$category->id));
3396         $newparent = get_context_instance(CONTEXT_SYSTEM);
3398     } else {
3399         $DB->set_field('course_categories', 'parent', $newparentcat->id, array('id'=>$category->id));
3400         $newparent = get_context_instance(CONTEXT_COURSECAT, $newparentcat->id);
3401     }
3403     context_moved($context, $newparent);
3405     // now make it last in new category
3406     $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('id'=>$category->id));
3408     // and fix the sortorders
3409     fix_course_sortorder();
3412 /**
3413  * @param string $format Course format ID e.g. 'weeks'
3414  * @return Name that the course format prefers for sections
3415  */
3416 function get_section_name($format) {
3417     $sectionname = get_string("name$format","format_$format");
3418     if($sectionname == "[[name$format]]") {
3419         $sectionname = get_string("name$format");
3420     }
3421     return $sectionname;
3424 /**
3425  * Can the current user delete this course?
3426  * Course creators have exception,
3427  * 1 day after the creation they can sill delete the course.
3428  * @param int $courseid
3429  * @return boolean
3430  */
3431 function can_delete_course($courseid) {
3432     global $USER, $DB;
3434     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3436     if (has_capability('moodle/course:delete', $context)) {
3437         return true;
3438     }
3440     // hack: now try to find out if creator created this course recently (1 day)
3441     if (!has_capability('moodle/course:create', $context)) {
3442         return false;
3443     }
3445     $since = time() - 60*60*24;
3447     $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
3448     $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
3450     return $DB->record_exists_select('log', $select, $params);
3453 /**
3454  * Save the Your name for 'Some role' strings.
3455  *
3456  * @param integer $courseid the id of this course.
3457  * @param array $data the data that came from the course settings form.
3458  */
3459 function save_local_role_names($courseid, $data) {
3460     global $DB;
3461     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3463     foreach ($data as $fieldname => $value) {
3464         if (!strstr($fieldname, 'role_')) {
3465             continue;
3466         }
3467         list($ignored, $roleid) = explode('_', $fieldname);
3469         // make up our mind whether we want to delete, update or insert
3470         if (!$value) {
3471             $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
3473         } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
3474             $rolename->name = $value;
3475             $DB->update_record('role_names', $rolename);
3477         } else {
3478             $rolename = new stdClass;
3479             $rolename->contextid = $context->id;
3480             $rolename->roleid = $roleid;
3481             $rolename->name = $value;
3482             $DB->insert_record('role_names', $rolename);
3483         }
3484     }
3487 /**
3488  * Create a course and either return a $course object or false
3489  *
3490  * @param object $data  - all the data needed for an entry in the 'course' table
3491  */
3492 function create_course($data) {
3493     global $CFG, $USER, $DB;
3495     //check the categoryid
3496     if (!empty($data->category) && !$data->category==0) {
3497         $category = $DB->get_record('course_categories', array('id'=>$data->category));
3498         if (empty($category)) {
3499             throw new moodle_exception('noexistingcategory');
3500         }
3501     }
3503     //check if the shortname already exist
3504     if(!empty($data->shortname)) {
3505         $course = $DB->get_record('course', array('shortname' => $data->shortname));
3506         if (!empty($course)) {
3507             throw new moodle_exception('shortnametaken');
3508         }
3509     }
3511     //check if the id number already exist
3512     if(!empty($data->idnumber)) {
3513         $course = $DB->get_record('course', array('idnumber' => $data->idnumber));
3514         if (!empty($course)) {
3515             throw new moodle_exception('idnumbertaken');
3516         }
3517     }
3518     
3520     // preprocess allowed mods
3521     $allowedmods = empty($data->allowedmods) ? array() : $data->allowedmods;
3522     unset($data->allowedmods);
3523     if ($CFG->restrictmodulesfor == 'all') {
3524         $data->restrictmodules = 1;
3525     } else {
3526         $data->restrictmodules = 0;
3527     }
3529     $data->timecreated = time();
3531     // place at beginning of any category