MDL-25235 fixed param type for OS paths
[moodle.git] / course / lib.php
CommitLineData
d9cb06dc 1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * Library of useful functions
20 *
21 * @copyright 1999 Martin Dougiamas http://dougiamas.com
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
df997f84
PS
23 * @package core
24 * @subpackage course
d9cb06dc 25 */
f9903ed0 26
df997f84
PS
27defined('MOODLE_INTERNAL') || die;
28
4e781c7b 29require_once($CFG->libdir.'/completionlib.php');
8bdc9cac 30require_once($CFG->libdir.'/filelib.php');
f9903ed0 31
92890025 32define('COURSE_MAX_LOG_DISPLAY', 150); // days
33define('COURSE_MAX_LOGS_PER_PAGE', 1000); // records
34define('COURSE_LIVELOG_REFRESH', 60); // Seconds
35define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds
36define('COURSE_MAX_SUMMARIES_PER_PAGE', 10); // courses
950c35a9 37define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); // max courses in log dropdown before switching to optional
92890025 38define('COURSE_MAX_USERS_PER_DROPDOWN',1000); // max users in log dropdown before switching to optional
220a90c5 39define('FRONTPAGENEWS', '0');
40define('FRONTPAGECOURSELIST', '1');
41define('FRONTPAGECATEGORYNAMES', '2');
42define('FRONTPAGETOPICONLY', '3');
43define('FRONTPAGECATEGORYCOMBO', '4');
6f24e48e 44define('FRONTPAGECOURSELIMIT', 200); // maximum number of courses displayed on the frontpage
45define('EXCELROWS', 65535);
46define('FIRSTUSEDEXCELROW', 3);
60fdc714 47
89bfeee0 48define('MOD_CLASS_ACTIVITY', 0);
49define('MOD_CLASS_RESOURCE', 1);
50
2f48819b 51if (!defined('MAX_MODINFO_CACHE_SIZE')) {
4d10247f 52 define('MAX_MODINFO_CACHE_SIZE', 10);
53}
f9903ed0 54
600149be 55function make_log_url($module, $url) {
56 switch ($module) {
bd7be234 57 case 'course':
58 case 'file':
59 case 'login':
60 case 'lib':
61 case 'admin':
bd7be234 62 case 'calendar':
bd5d0ce5 63 case 'mnet course':
11003188 64 if (strpos($url, '../') === 0) {
65 $url = ltrim($url, '.');
66 } else {
67 $url = "/course/$url";
68 }
bd5d0ce5 69 break;
01d5d399 70 case 'user':
bd7be234 71 case 'blog':
11003188 72 $url = "/$module/$url";
600149be 73 break;
bd7be234 74 case 'upload':
11003188 75 $url = $url;
c80b7585 76 break;
38fb8190 77 case 'coursetags':
11003188 78 $url = '/'.$url;
38fb8190 79 break;
bd7be234 80 case 'library':
81 case '':
11003188 82 $url = '/';
de2dfe68 83 break;
4597d533 84 case 'message':
11003188 85 $url = "/message/$url";
86 break;
87 case 'notes':
88 $url = "/notes/$url";
4597d533 89 break;
b89e4ad8 90 case 'tag':
91 $url = "/tag/$url";
92 break;
dbcf271b 93 case 'role':
94 $url = '/'.$url;
95 break;
600149be 96 default:
11003188 97 $url = "/mod/$module/$url";
600149be 98 break;
99 }
11003188 100
101 //now let's sanitise urls - there might be some ugly nasties:-(
102 $parts = explode('?', $url);
103 $script = array_shift($parts);
104 if (strpos($script, 'http') === 0) {
105 $script = clean_param($script, PARAM_URL);
106 } else {
107 $script = clean_param($script, PARAM_PATH);
108 }
109
110 $query = '';
111 if ($parts) {
112 $query = implode('', $parts);
113 $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
114 $parts = explode('&', $query);
115 $eq = urlencode('=');
116 foreach ($parts as $key=>$part) {
117 $part = urlencode(urldecode($part));
118 $part = str_replace($eq, '=', $part);
119 $parts[$key] = $part;
120 }
121 $query = '?'.implode('&amp;', $parts);
122 }
123
124 return $script.$query;
600149be 125}
126
92890025 127
c215b32b 128function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
129 $modname="", $modid=0, $modaction="", $groupid=0) {
cb6fec1f 130 global $CFG, $DB;
c215b32b 131
132 // It is assumed that $date is the GMT time of midnight for that day,
133 // and so the next 86400 seconds worth of logs are printed.
134
135 /// Setup for group handling.
238c0dd9 136
137 // TODO: I don't understand group/context/etc. enough to be able to do
c215b32b 138 // something interesting with it here
139 // What is the context of a remote course?
238c0dd9 140
c215b32b 141 /// If the group mode is separate, and this user does not have editing privileges,
142 /// then only the user's group can be viewed.
143 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
144 // $groupid = get_current_group($course->id);
145 //}
146 /// If this course doesn't have groups, no groupid can be specified.
147 //else if (!$course->groupmode) {
148 // $groupid = 0;
149 //}
cb6fec1f 150
c215b32b 151 $groupid = 0;
152
153 $joins = array();
154
cb6fec1f 155 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
156 FROM {mnet_log} l
157 LEFT JOIN {user} u ON l.userid = u.id
158 WHERE ";
159 $params = array();
160
161 $where .= "l.hostid = :hostid";
162 $params['hostid'] = $hostid;
c215b32b 163
164 // TODO: Is 1 really a magic number referring to the sitename?
cb6fec1f 165 if ($course != SITEID || $modid != 0) {
166 $where .= " AND l.course=:courseid";
167 $params['courseid'] = $course;
c215b32b 168 }
169
170 if ($modname) {
cb6fec1f 171 $where .= " AND l.module = :modname";
172 $params['modname'] = $modname;
c215b32b 173 }
174
175 if ('site_errors' === $modid) {
cb6fec1f 176 $where .= " AND ( l.action='error' OR l.action='infected' )";
c215b32b 177 } else if ($modid) {
238c0dd9 178 //TODO: This assumes that modids are the same across sites... probably
c215b32b 179 //not true
cb6fec1f 180 $where .= " AND l.cmid = :modid";
181 $params['modid'] = $modid;
c215b32b 182 }
183
184 if ($modaction) {
185 $firstletter = substr($modaction, 0, 1);
8086b083 186 if ($firstletter == '-') {
47586394 187 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
8086b083
PS
188 $params['modaction'] = '%'.substr($modaction, 1).'%';
189 } else {
190 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
191 $params['modaction'] = '%'.$modaction.'%';
c215b32b 192 }
193 }
194
195 if ($user) {
cb6fec1f 196 $where .= " AND l.userid = :user";
197 $params['user'] = $user;
c215b32b 198 }
199
200 if ($date) {
201 $enddate = $date + 86400;
cb6fec1f 202 $where .= " AND l.time > :date AND l.time < :enddate";
203 $params['date'] = $date;
204 $params['enddate'] = $enddate;
c215b32b 205 }
206
207 $result = array();
cb6fec1f 208 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
c215b32b 209 if(!empty($result['totalcount'])) {
cb6fec1f 210 $where .= " ORDER BY $order";
211 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
c215b32b 212 } else {
213 $result['logs'] = array();
214 }
215 return $result;
216}
217
92890025 218function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
219 $modname="", $modid=0, $modaction="", $groupid=0) {
d5abe1b5 220 global $DB, $SESSION, $USER;
e0161bff 221 // It is assumed that $date is the GMT time of midnight for that day,
222 // and so the next 86400 seconds worth of logs are printed.
f9903ed0 223
69c76405 224 /// Setup for group handling.
264867fd 225
69c76405 226 /// If the group mode is separate, and this user does not have editing privileges,
227 /// then only the user's group can be viewed.
3924b988 228 if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
928d4738 229 if (isset($SESSION->currentgroup[$course->id])) {
230 $groupid = $SESSION->currentgroup[$course->id];
231 } else {
232 $groupid = groups_get_all_groups($course->id, $USER->id);
233 if (is_array($groupid)) {
234 $groupid = array_shift(array_keys($groupid));
235 $SESSION->currentgroup[$course->id] = $groupid;
236 } else {
237 $groupid = 0;
238 }
239 }
69c76405 240 }
241 /// If this course doesn't have groups, no groupid can be specified.
242 else if (!$course->groupmode) {
243 $groupid = 0;
244 }
245
e0161bff 246 $joins = array();
18f8a34f 247 $params = array();
a2ab3b05 248
e15ef260 249 if ($course->id != SITEID || $modid != 0) {
c3df0901 250 $joins[] = "l.course = :courseid";
251 $params['courseid'] = $course->id;
e15ef260 252 }
f9903ed0 253
c469a7ef 254 if ($modname) {
c3df0901 255 $joins[] = "l.module = :modname";
238c0dd9 256 $params['modname'] = $modname;
f24cffb9 257 }
258
e21922f0 259 if ('site_errors' === $modid) {
bf35eb15 260 $joins[] = "( l.action='error' OR l.action='infected' )";
e21922f0 261 } else if ($modid) {
c3df0901 262 $joins[] = "l.cmid = :modid";
263 $params['modid'] = $modid;
69d79bc3 264 }
265
266 if ($modaction) {
ee35e0b8 267 $firstletter = substr($modaction, 0, 1);
8086b083 268 if ($firstletter == '-') {
47586394 269 $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
c3df0901 270 $params['modaction'] = '%'.substr($modaction, 1).'%';
8086b083
PS
271 } else {
272 $joins[] = $DB->sql_like('l.action', ':modaction', false);
273 $params['modaction'] = '%'.$modaction.'%';
ee35e0b8 274 }
f24cffb9 275 }
276
238c0dd9 277
69c76405 278 /// Getting all members of a group.
279 if ($groupid and !$user) {
62d63838 280 if ($gusers = groups_get_members($groupid)) {
281 $gusers = array_keys($gusers);
1e95d7b7 282 $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
283 } else {
05a33439 284 $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
69c76405 285 }
286 }
287 else if ($user) {
c3df0901 288 $joins[] = "l.userid = :userid";
289 $params['userid'] = $user;
f9903ed0 290 }
291
292 if ($date) {
293 $enddate = $date + 86400;
c3df0901 294 $joins[] = "l.time > :date AND l.time < :enddate";
295 $params['date'] = $date;
296 $params['enddate'] = $enddate;
f9903ed0 297 }
298
1e95d7b7 299 $selector = implode(' AND ', $joins);
e0161bff 300
d09f3c80 301 $totalcount = 0; // Initialise
92890025 302 $result = array();
c3df0901 303 $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
92890025 304 $result['totalcount'] = $totalcount;
305 return $result;
306}
264867fd 307
308
92890025 309function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
310 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
264867fd 311
d60c1124 312 global $CFG, $DB, $OUTPUT;
264867fd 313
92890025 314 if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
315 $modname, $modid, $modaction, $groupid)) {
e6db3026 316 echo $OUTPUT->notification("No logs found!");
d60c1124 317 echo $OUTPUT->footer();
f9903ed0 318 exit;
319 }
264867fd 320
ea49a66c 321 $courses = array();
322
92890025 323 if ($course->id == SITEID) {
324 $courses[0] = '';
bf221aca 325 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
92890025 326 foreach ($ccc as $cc) {
bf221aca 327 $courses[$cc->id] = $cc->shortname;
92890025 328 }
329 }
ea49a66c 330 } else {
bf221aca 331 $courses[$course->id] = $course->shortname;
92890025 332 }
264867fd 333
92890025 334 $totalcount = $logs['totalcount'];
f9903ed0 335 $count=0;
2eb68e6f 336 $ldcache = array();
f9903ed0 337 $tt = getdate(time());
338 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
1c0200e0 339
dcde9f02 340 $strftimedatetime = get_string("strftimedatetime");
341
5577ceb3 342 echo "<div class=\"info\">\n";
519d369f 343 print_string("displayingrecords", "", $totalcount);
5577ceb3 344 echo "</div>\n";
1c0200e0 345
929d7a83 346 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
519d369f 347
337203a4 348 $table = new html_table();
90723839 349 $table->classes = array('logtable','generalbox');
337203a4
SH
350 $table->align = array('right', 'left', 'left');
351 $table->head = array(
352 get_string('time'),
353 get_string('ip_address'),
354 get_string('fullnamecourse'),
355 get_string('action'),
356 get_string('info')
357 );
358 $table->data = array();
1b048629 359
1548978d 360 if ($course->id == SITEID) {
337203a4
SH
361 array_unshift($table->align, 'left');
362 array_unshift($table->head, get_string('course'));
1548978d 363 }
1548978d 364
1e95d7b7 365 // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
2b2d182a 366 if (empty($logs['logs'])) {
1e95d7b7 367 $logs['logs'] = array();
2b2d182a 368 }
238c0dd9 369
92890025 370 foreach ($logs['logs'] as $log) {
600149be 371
2eb68e6f 372 if (isset($ldcache[$log->module][$log->action])) {
373 $ld = $ldcache[$log->module][$log->action];
374 } else {
cb6fec1f 375 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
2eb68e6f 376 $ldcache[$log->module][$log->action] = $ld;
377 }
edf3ef00 378 if ($ld && is_numeric($log->info)) {
181b888e 379 // ugly hack to make sure fullname is shown correctly
337203a4 380 if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
cb6fec1f 381 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
181b888e 382 } else {
cb6fec1f 383 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
181b888e 384 }
600149be 385 }
386
264867fd 387 //Filter log->info
c8b0a50b 388 $log->info = format_string($log->info);
389
6c5a2108 390 // If $log->url has been trimmed short by the db size restriction
391 // code in add_to_log, keep a note so we don't add a link to a broken url
392 $tl=textlib_get_instance();
393 $brokenurl=($tl->strlen($log->url)==100 && $tl->substr($log->url,97)=='...');
394
337203a4 395 $row = array();
1548978d 396 if ($course->id == SITEID) {
bd5d0ce5 397 if (empty($log->course)) {
337203a4 398 $row[] = get_string('site');
bd5d0ce5 399 } else {
337203a4 400 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
bd5d0ce5 401 }
720a43ce 402 }
1b048629 403
337203a4 404 $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
1b048629 405
75015e5f
PS
406 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
407 $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
337203a4 408
c63923bd 409 $row[] = html_writer::link(new moodle_url("/user/view.php?id={$log->userid}&course={$log->course}"), fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id))));
337203a4 410
6c5a2108 411 $displayaction="$log->module $log->action";
337203a4
SH
412 if ($brokenurl) {
413 $row[] = $displayaction;
6c5a2108 414 } else {
75015e5f
PS
415 $link = make_log_url($log->module,$log->url);
416 $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
6c5a2108 417 }
337203a4 418 $row[] = $log->info;
755ee6d8 419 $table->data[] = $row;
f9903ed0 420 }
519d369f 421
16be8974 422 echo html_writer::table($table);
929d7a83 423 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
f9903ed0 424}
425
426
c215b32b 427function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
428 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
238c0dd9 429
d60c1124 430 global $CFG, $DB, $OUTPUT;
238c0dd9 431
c215b32b 432 if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
433 $modname, $modid, $modaction, $groupid)) {
e6db3026 434 echo $OUTPUT->notification("No logs found!");
d60c1124 435 echo $OUTPUT->footer();
c215b32b 436 exit;
437 }
238c0dd9 438
c215b32b 439 if ($course->id == SITEID) {
440 $courses[0] = '';
441 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
442 foreach ($ccc as $cc) {
443 $courses[$cc->id] = $cc->shortname;
444 }
445 }
446 }
238c0dd9 447
c215b32b 448 $totalcount = $logs['totalcount'];
449 $count=0;
450 $ldcache = array();
451 $tt = getdate(time());
452 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
453
454 $strftimedatetime = get_string("strftimedatetime");
455
5577ceb3 456 echo "<div class=\"info\">\n";
c215b32b 457 print_string("displayingrecords", "", $totalcount);
5577ceb3 458 echo "</div>\n";
c215b32b 459
929d7a83 460 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
c215b32b 461
5577ceb3 462 echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
c215b32b 463 echo "<tr>";
464 if ($course->id == SITEID) {
465 echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
466 }
467 echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
468 echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
d6cc2341 469 echo "<th class=\"c3 header\">".get_string('fullnamecourse')."</th>\n";
c215b32b 470 echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
471 echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
472 echo "</tr>\n";
473
474 if (empty($logs['logs'])) {
475 echo "</table>\n";
476 return;
477 }
478
479 $row = 1;
480 foreach ($logs['logs'] as $log) {
238c0dd9 481
c215b32b 482 $log->info = $log->coursename;
483 $row = ($row + 1) % 2;
484
485 if (isset($ldcache[$log->module][$log->action])) {
486 $ld = $ldcache[$log->module][$log->action];
487 } else {
6bb08163 488 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
c215b32b 489 $ldcache[$log->module][$log->action] = $ld;
490 }
491 if (0 && $ld && !empty($log->info)) {
492 // ugly hack to make sure fullname is shown correctly
cb6fec1f 493 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
494 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
c215b32b 495 } else {
cb6fec1f 496 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
c215b32b 497 }
498 }
499
238c0dd9 500 //Filter log->info
c215b32b 501 $log->info = format_string($log->info);
502
c215b32b 503 echo '<tr class="r'.$row.'">';
504 if ($course->id == SITEID) {
5577ceb3 505 echo "<td class=\"r$row c0\" >\n";
c215b32b 506 echo " <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courses[$log->course]."</a>\n";
507 echo "</td>\n";
508 }
5577ceb3 509 echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
c215b32b 510 ' '.userdate($log->time, $strftimedatetime)."</td>\n";
5577ceb3 511 echo "<td class=\"r$row c2\" >\n";
75015e5f
PS
512 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
513 echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
c215b32b 514 echo "</td>\n";
515 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
5577ceb3 516 echo "<td class=\"r$row c3\" >\n";
c215b32b 517 echo " <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
518 echo "</td>\n";
5577ceb3 519 echo "<td class=\"r$row c4\">\n";
c215b32b 520 echo $log->action .': '.$log->module;
521 echo "</td>\n";;
5577ceb3 522 echo "<td class=\"r$row c5\">{$log->info}</td>\n";
c215b32b 523 echo "</tr>\n";
524 }
525 echo "</table>\n";
526
929d7a83 527 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
c215b32b 528}
529
530
92890025 531function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
532 $modid, $modaction, $groupid) {
cb6fec1f 533 global $DB;
4068bedb 534
954fdb42 535 $text = get_string('course')."\t".get_string('time')."\t".get_string('ip_address')."\t".
d6cc2341 536 get_string('fullnamecourse')."\t".get_string('action')."\t".get_string('info');
264867fd 537
954fdb42 538 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
92890025 539 $modname, $modid, $modaction, $groupid)) {
540 return false;
541 }
264867fd 542
ea49a66c 543 $courses = array();
544
92890025 545 if ($course->id == SITEID) {
546 $courses[0] = '';
547 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
548 foreach ($ccc as $cc) {
549 $courses[$cc->id] = $cc->shortname;
550 }
551 }
ea49a66c 552 } else {
553 $courses[$course->id] = $course->shortname;
92890025 554 }
264867fd 555
92890025 556 $count=0;
557 $ldcache = array();
558 $tt = getdate(time());
559 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
560
561 $strftimedatetime = get_string("strftimedatetime");
92890025 562
4248b15c 563 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
954fdb42 564 $filename .= '.txt';
264867fd 565 header("Content-Type: application/download\n");
954fdb42 566 header("Content-Disposition: attachment; filename=$filename");
567 header("Expires: 0");
568 header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
569 header("Pragma: public");
570
571 echo get_string('savedat').userdate(time(), $strftimedatetime)."\n";
572 echo $text;
573
2b2d182a 574 if (empty($logs['logs'])) {
575 return true;
576 }
577
954fdb42 578 foreach ($logs['logs'] as $log) {
579 if (isset($ldcache[$log->module][$log->action])) {
580 $ld = $ldcache[$log->module][$log->action];
581 } else {
6bb08163 582 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
954fdb42 583 $ldcache[$log->module][$log->action] = $ld;
584 }
585 if ($ld && !empty($log->info)) {
586 // ugly hack to make sure fullname is shown correctly
cb6fec1f 587 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
588 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
954fdb42 589 } else {
cb6fec1f 590 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
954fdb42 591 }
592 }
593
264867fd 594 //Filter log->info
954fdb42 595 $log->info = format_string($log->info);
954fdb42 596 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
954fdb42 597
598 $firstField = $courses[$log->course];
1c45e42e 599 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
954fdb42 600 $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action, $log->info);
601 $text = implode("\t", $row);
602 echo $text." \n";
603 }
604 return true;
92890025 605}
606
607
608function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
609 $modid, $modaction, $groupid) {
264867fd 610
cb6fec1f 611 global $CFG, $DB;
92890025 612
954fdb42 613 require_once("$CFG->libdir/excellib.class.php");
264867fd 614
954fdb42 615 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
92890025 616 $modname, $modid, $modaction, $groupid)) {
617 return false;
618 }
264867fd 619
ea49a66c 620 $courses = array();
621
92890025 622 if ($course->id == SITEID) {
623 $courses[0] = '';
624 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
625 foreach ($ccc as $cc) {
626 $courses[$cc->id] = $cc->shortname;
627 }
628 }
ea49a66c 629 } else {
630 $courses[$course->id] = $course->shortname;
92890025 631 }
264867fd 632
92890025 633 $count=0;
634 $ldcache = array();
635 $tt = getdate(time());
636 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
637
638 $strftimedatetime = get_string("strftimedatetime");
92890025 639
954fdb42 640 $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
4248b15c 641 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
954fdb42 642 $filename .= '.xls';
264867fd 643
92890025 644 $workbook = new MoodleExcelWorkbook('-');
645 $workbook->send($filename);
264867fd 646
954fdb42 647 $worksheet = array();
648 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
d6cc2341 649 get_string('fullnamecourse'), get_string('action'), get_string('info'));
264867fd 650
954fdb42 651 // Creating worksheets
652 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
0a013367 653 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
954fdb42 654 $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
655 $worksheet[$wsnumber]->set_column(1, 1, 30);
656 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
657 userdate(time(), $strftimedatetime));
658 $col = 0;
659 foreach ($headers as $item) {
660 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
661 $col++;
662 }
663 }
664
2b2d182a 665 if (empty($logs['logs'])) {
666 $workbook->close();
667 return true;
668 }
669
954fdb42 670 $formatDate =& $workbook->add_format();
671 $formatDate->set_num_format(get_string('log_excel_date_format'));
672
673 $row = FIRSTUSEDEXCELROW;
674 $wsnumber = 1;
675 $myxls =& $worksheet[$wsnumber];
676 foreach ($logs['logs'] as $log) {
677 if (isset($ldcache[$log->module][$log->action])) {
678 $ld = $ldcache[$log->module][$log->action];
679 } else {
cb6fec1f 680 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
954fdb42 681 $ldcache[$log->module][$log->action] = $ld;
682 }
683 if ($ld && !empty($log->info)) {
684 // ugly hack to make sure fullname is shown correctly
cb6fec1f 685 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
686 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
954fdb42 687 } else {
cb6fec1f 688 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
954fdb42 689 }
690 }
691
692 // Filter log->info
693 $log->info = format_string($log->info);
694 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
695
696 if ($nroPages>1) {
697 if ($row > EXCELROWS) {
698 $wsnumber++;
699 $myxls =& $worksheet[$wsnumber];
700 $row = FIRSTUSEDEXCELROW;
701 }
702 }
264867fd 703
954fdb42 704 $myxls->write($row, 0, $courses[$log->course], '');
5c34c4ba 705 $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
954fdb42 706 $myxls->write($row, 2, $log->ip, '');
1c45e42e 707 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
954fdb42 708 $myxls->write($row, 3, $fullname, '');
709 $myxls->write($row, 4, $log->module.' '.$log->action, '');
710 $myxls->write($row, 5, $log->info, '');
264867fd 711
954fdb42 712 $row++;
713 }
714
715 $workbook->close();
ea49a66c 716 return true;
717}
718
719function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
720 $modid, $modaction, $groupid) {
721
cb6fec1f 722 global $CFG, $DB;
ea49a66c 723
724 require_once("$CFG->libdir/odslib.class.php");
725
726 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
727 $modname, $modid, $modaction, $groupid)) {
728 return false;
729 }
730
731 $courses = array();
732
733 if ($course->id == SITEID) {
734 $courses[0] = '';
735 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
736 foreach ($ccc as $cc) {
737 $courses[$cc->id] = $cc->shortname;
738 }
739 }
740 } else {
741 $courses[$course->id] = $course->shortname;
742 }
743
744 $count=0;
745 $ldcache = array();
746 $tt = getdate(time());
747 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
748
749 $strftimedatetime = get_string("strftimedatetime");
750
751 $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
4248b15c 752 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
ea49a66c 753 $filename .= '.ods';
754
755 $workbook = new MoodleODSWorkbook('-');
756 $workbook->send($filename);
757
758 $worksheet = array();
759 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
d6cc2341 760 get_string('fullnamecourse'), get_string('action'), get_string('info'));
ea49a66c 761
762 // Creating worksheets
763 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
0a013367 764 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
ea49a66c 765 $worksheet[$wsnumber] =& $workbook->add_worksheet($sheettitle);
766 $worksheet[$wsnumber]->set_column(1, 1, 30);
767 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
768 userdate(time(), $strftimedatetime));
769 $col = 0;
770 foreach ($headers as $item) {
771 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
772 $col++;
773 }
774 }
775
776 if (empty($logs['logs'])) {
777 $workbook->close();
778 return true;
779 }
780
781 $formatDate =& $workbook->add_format();
782 $formatDate->set_num_format(get_string('log_excel_date_format'));
783
784 $row = FIRSTUSEDEXCELROW;
785 $wsnumber = 1;
786 $myxls =& $worksheet[$wsnumber];
787 foreach ($logs['logs'] as $log) {
788 if (isset($ldcache[$log->module][$log->action])) {
789 $ld = $ldcache[$log->module][$log->action];
790 } else {
cb6fec1f 791 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
ea49a66c 792 $ldcache[$log->module][$log->action] = $ld;
793 }
794 if ($ld && !empty($log->info)) {
795 // ugly hack to make sure fullname is shown correctly
7e60297f 796 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
cb6fec1f 797 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
ea49a66c 798 } else {
cb6fec1f 799 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
ea49a66c 800 }
801 }
802
803 // Filter log->info
804 $log->info = format_string($log->info);
805 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
806
807 if ($nroPages>1) {
808 if ($row > EXCELROWS) {
809 $wsnumber++;
810 $myxls =& $worksheet[$wsnumber];
811 $row = FIRSTUSEDEXCELROW;
812 }
813 }
814
d81b7ffb 815 $myxls->write_string($row, 0, $courses[$log->course]);
816 $myxls->write_date($row, 1, $log->time);
817 $myxls->write_string($row, 2, $log->ip);
ea49a66c 818 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
d81b7ffb 819 $myxls->write_string($row, 3, $fullname);
820 $myxls->write_string($row, 4, $log->module.' '.$log->action);
821 $myxls->write_string($row, 5, $log->info);
ea49a66c 822
823 $row++;
824 }
825
826 $workbook->close();
954fdb42 827 return true;
92890025 828}
829
92890025 830
c2cb4545 831function print_log_graph($course, $userid=0, $type="course.png", $date=0) {
a683deec 832 global $CFG, $USER;
c2cb4545 833 if (empty($CFG->gdversion)) {
834 echo "(".get_string("gdneed").")";
d887b5a7 835 } else {
a683deec 836 // MDL-10818, do not display broken graph when user has no permission to view graph
a2e4bf7f 837 if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $course->id)) ||
a683deec 838 ($course->showreports and $USER->id == $userid)) {
839 echo '<img src="'.$CFG->wwwroot.'/course/report/log/graph.php?id='.$course->id.
840 '&amp;user='.$userid.'&amp;type='.$type.'&amp;date='.$date.'" alt="" />';
841 }
d887b5a7 842 }
843}
844
845
185cfb09 846function print_overview($courses) {
7c5286cd 847 global $CFG, $USER, $DB, $OUTPUT;
0d6b9d4f 848
185cfb09 849 $htmlarray = array();
6bb08163 850 if ($modules = $DB->get_records('modules')) {
f8716988 851 foreach ($modules as $mod) {
852 if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
f461e8ec 853 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
f8716988 854 $fname = $mod->name.'_print_overview';
0d6b9d4f 855 if (function_exists($fname)) {
185cfb09 856 $fname($courses,$htmlarray);
0d6b9d4f 857 }
858 }
859 }
860 }
185cfb09 861 foreach ($courses as $course) {
e6db3026 862 echo $OUTPUT->box_start("coursebox");
185cfb09 863 $linkcss = '';
864 if (empty($course->visible)) {
865 $linkcss = 'class="dimmed"';
866 }
370f9570 867 echo $OUTPUT->heading('<a title="'. format_string($course->fullname).'" '.$linkcss.' href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'. format_string($course->fullname).'</a>', 3);
185cfb09 868 if (array_key_exists($course->id,$htmlarray)) {
869 foreach ($htmlarray[$course->id] as $modname => $html) {
870 echo $html;
871 }
872 }
e6db3026 873 echo $OUTPUT->box_end();
185cfb09 874 }
0d6b9d4f 875}
876
877
cb6fec1f 878/**
879 * This function trawls through the logs looking for
880 * anything new since the user's last login
881 */
600149be 882function print_recent_activity($course) {
883 // $course is an object
008350b5 884 global $CFG, $USER, $SESSION, $DB, $OUTPUT;
600149be 885
e2a3a0e7 886 $context = get_context_instance(CONTEXT_COURSE, $course->id);
2ac64806 887
dd97c328 888 $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
889
890 $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
0f87cb1d 891
4f0c2d00 892 if (!isguestuser()) {
e2a3a0e7 893 if (!empty($USER->lastcourseaccess[$course->id])) {
894 if ($USER->lastcourseaccess[$course->id] > $timestart) {
895 $timestart = $USER->lastcourseaccess[$course->id];
896 }
9e51847a 897 }
3d891989 898 }
0f87cb1d 899
de785682 900 echo '<div class="activitydate">';
27bf9e20 901 echo get_string('activitysince', '', userdate($timestart));
de785682 902 echo '</div>';
903 echo '<div class="activityhead">';
0f87cb1d 904
de785682 905 echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
0f87cb1d 906
5fc835a5 907 echo "</div>\n";
0f87cb1d 908
600149be 909 $content = false;
1b5910c4 910
dd97c328 911/// Firstly, have there been any new enrolments?
912
6c38b7e0 913 $users = get_recent_enrolments($course->id, $timestart);
1b5910c4 914
5fc835a5 915 //Accessibility: new users now appear in an <OL> list.
6c38b7e0 916 if ($users) {
27bf9e20 917 echo '<div class="newusers">';
008350b5 918 echo $OUTPUT->heading(get_string("newusers").':', 3);
dd97c328 919 $content = true;
5fc835a5 920 echo "<ol class=\"list\">\n";
6c38b7e0 921 foreach ($users as $user) {
dd97c328 922 $fullname = fullname($user, $viewfullnames);
923 echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
600149be 924 }
5fc835a5 925 echo "</ol>\n</div>\n";
600149be 926 }
927
dd97c328 928/// Next, have there been any modifications to the course structure?
929
930 $modinfo =& get_fast_modinfo($course);
931
932 $changelist = array();
1b5910c4 933
cb6fec1f 934 $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
935 module = 'course' AND
936 (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
937 array($timestart, $course->id), "id ASC");
1b5910c4 938
939 if ($logs) {
dd97c328 940 $actions = array('add mod', 'update mod', 'delete mod');
941 $newgones = array(); // added and later deleted items
1b5910c4 942 foreach ($logs as $key => $log) {
dd97c328 943 if (!in_array($log->action, $actions)) {
944 continue;
945 }
c71f3265 946 $info = explode(' ', $log->info);
c9f6251e 947
dd97c328 948 if ($info[0] == 'label') { // Labels are ignored in recent activity
c9f6251e 949 continue;
950 }
951
dd97c328 952 if (count($info) != 2) {
953 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
954 continue;
955 }
956
957 $modname = $info[0];
958 $instanceid = $info[1];
959
960 if ($log->action == 'delete mod') {
961 // unfortunately we do not know if the mod was visible
962 if (!array_key_exists($log->info, $newgones)) {
963 $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
964 $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
965 }
966 } else {
967 if (!isset($modinfo->instances[$modname][$instanceid])) {
968 if ($log->action == 'add mod') {
969 // do not display added and later deleted activities
970 $newgones[$log->info] = true;
971 }
972 continue;
973 }
974 $cm = $modinfo->instances[$modname][$instanceid];
975 if (!$cm->uservisible) {
ff96219d 976 continue;
dd97c328 977 }
978
979 if ($log->action == 'add mod') {
980 $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
981 $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
982
983 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
984 $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
985 $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
600149be 986 }
ef25340c 987 }
988 }
989 }
990
9c9f7d77 991 if (!empty($changelist)) {
008350b5 992 echo $OUTPUT->heading(get_string("courseupdates").':', 3);
dd97c328 993 $content = true;
ef25340c 994 foreach ($changelist as $changeinfo => $change) {
dd97c328 995 echo '<p class="activity">'.$change['text'].'</p>';
600149be 996 }
89adb174 997 }
bf40f9c1 998
dd97c328 999/// Now display new things from each module
0fd7da81 1000
dd97c328 1001 $usedmodules = array();
1002 foreach($modinfo->cms as $cm) {
1003 if (isset($usedmodules[$cm->modname])) {
1004 continue;
1005 }
1006 if (!$cm->uservisible) {
1007 continue;
1008 }
1009 $usedmodules[$cm->modname] = $cm->modname;
1010 }
e2a3a0e7 1011
dd97c328 1012 foreach ($usedmodules as $modname) { // Each module gets it's own logs and prints them
1013 if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1014 include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1015 $print_recent_activity = $modname.'_print_recent_activity';
296c6ac2 1016 if (function_exists($print_recent_activity)) {
dd97c328 1017 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1018 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
600149be 1019 }
296c6ac2 1020 } else {
238c0dd9 1021 debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
600149be 1022 }
1023 }
1024
1025 if (! $content) {
27bf9e20 1026 echo '<p class="message">'.get_string('nothingnew').'</p>';
600149be 1027 }
600149be 1028}
1029
cb6fec1f 1030/**
1031 * For a given course, returns an array of course activity objects
1032 * Each item in the array contains he following properties:
1033 */
d897cae4 1034function get_array_of_activities($courseid) {
d897cae4 1035// cm - course module id
1036// mod - name of the module (eg forum)
1037// section - the number of the section (eg week or topic)
1038// name - the name of the instance
5867bfb5 1039// visible - is the instance visible or not
13534ef7
ML
1040// groupingid - grouping id
1041// groupmembersonly - is this instance visible to group members only
86aa7ccf 1042// extra - contains extra string to include in any link
cb6fec1f 1043 global $CFG, $DB;
82bd6a5e 1044 if(!empty($CFG->enableavailability)) {
1045 require_once($CFG->libdir.'/conditionlib.php');
1046 }
8dddba42 1047
a0c30e1b 1048 $course = $DB->get_record('course', array('id'=>$courseid));
1049
1050 if (empty($course)) {
1051 throw new moodle_exception('courseidnotfound');
1052 }
1053
d897cae4 1054 $mod = array();
1055
a0c30e1b 1056 $rawmods = get_course_mods($courseid);
1057 if (empty($rawmods)) {
dd97c328 1058 return $mod; // always return array
d897cae4 1059 }
1060
cb6fec1f 1061 if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
d897cae4 1062 foreach ($sections as $section) {
74666583 1063 if (!empty($section->sequence)) {
d897cae4 1064 $sequence = explode(",", $section->sequence);
1065 foreach ($sequence as $seq) {
7af6281f 1066 if (empty($rawmods[$seq])) {
1067 continue;
1068 }
dd97c328 1069 $mod[$seq]->id = $rawmods[$seq]->instance;
1070 $mod[$seq]->cm = $rawmods[$seq]->id;
1071 $mod[$seq]->mod = $rawmods[$seq]->modname;
1072 $mod[$seq]->section = $section->section;
66b250fd 1073 $mod[$seq]->idnumber = $rawmods[$seq]->idnumber;
dd97c328 1074 $mod[$seq]->visible = $rawmods[$seq]->visible;
1075 $mod[$seq]->groupmode = $rawmods[$seq]->groupmode;
1076 $mod[$seq]->groupingid = $rawmods[$seq]->groupingid;
13534ef7 1077 $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
82bd6a5e 1078 $mod[$seq]->indent = $rawmods[$seq]->indent;
1079 $mod[$seq]->completion = $rawmods[$seq]->completion;
dd97c328 1080 $mod[$seq]->extra = "";
82bd6a5e 1081 if(!empty($CFG->enableavailability)) {
1082 condition_info::fill_availability_conditions($rawmods[$seq]);
1083 $mod[$seq]->availablefrom = $rawmods[$seq]->availablefrom;
1084 $mod[$seq]->availableuntil = $rawmods[$seq]->availableuntil;
1085 $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1086 $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1087 $mod[$seq]->conditionsgrade = $rawmods[$seq]->conditionsgrade;
1088 }
8dddba42 1089
1090 $modname = $mod[$seq]->mod;
1091 $functionname = $modname."_get_coursemodule_info";
1092
3a37b3f8 1093 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1094 continue;
1095 }
1096
8dddba42 1097 include_once("$CFG->dirroot/mod/$modname/lib.php");
1098
1099 if (function_exists($functionname)) {
9d361034 1100 if ($info = $functionname($rawmods[$seq])) {
1101 if (!empty($info->extra)) {
1102 $mod[$seq]->extra = $info->extra;
1103 }
1104 if (!empty($info->icon)) {
1105 $mod[$seq]->icon = $info->icon;
1106 }
9a9012dc
PS
1107 if (!empty($info->iconcomponent)) {
1108 $mod[$seq]->iconcomponent = $info->iconcomponent;
1109 }
1ea543df 1110 if (!empty($info->name)) {
9a9012dc 1111 $mod[$seq]->name = $info->name;
1ea543df 1112 }
c9f6251e 1113 }
1114 }
1ea543df 1115 if (!isset($mod[$seq]->name)) {
9a9012dc 1116 $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1ea543df 1117 }
d897cae4 1118 }
1119 }
1120 }
1121 }
1122 return $mod;
1123}
1124
1125
cb6fec1f 1126/**
1127 * Returns a number of useful structures for course displays
1128 */
90845098 1129function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
0edb4aad 1130 global $CFG, $DB, $COURSE;
7468bf01 1131
dd97c328 1132 $mods = array(); // course modules indexed by id
1133 $modnames = array(); // all course module names (except resource!)
1134 $modnamesplural= array(); // all course module names (plural form)
1135 $modnamesused = array(); // course module names used
7468bf01 1136
cb6fec1f 1137 if ($allmods = $DB->get_records("modules")) {
90845098 1138 foreach ($allmods as $mod) {
0edb4aad
PS
1139 if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1140 continue;
1141 }
5867bfb5 1142 if ($mod->visible) {
1143 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1144 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1145 }
90845098 1146 }
c6947ba7 1147 textlib_get_instance()->asort($modnames);
90845098 1148 } else {
ba6018a9 1149 print_error("nomodules", 'debug');
90845098 1150 }
1151
82bd6a5e 1152 $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1153 $modinfo = get_fast_modinfo($course);
1154
1155 if ($rawmods=$modinfo->cms) {
7468bf01 1156 foreach($rawmods as $mod) { // Index the mods
959ae824 1157 if (empty($modnames[$mod->modname])) {
1158 continue;
1159 }
dd97c328 1160 $mods[$mod->id] = $mod;
1161 $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1162 if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1163 continue;
1164 }
13534ef7
ML
1165 // Check groupings
1166 if (!groups_course_module_visible($mod)) {
1167 continue;
1168 }
dd97c328 1169 $modnamesused[$mod->modname] = $modnames[$mod->modname];
7468bf01 1170 }
c7da6f7a 1171 if ($modnamesused) {
c6947ba7 1172 textlib_get_instance()->asort($modnamesused);
c7da6f7a 1173 }
7468bf01 1174 }
7468bf01 1175}
1176
7487c856
SH
1177/**
1178 * Returns an array of sections for the requested course id
1179 *
1180 * This function stores the sections against the course id within a staticvar encase
1181 * of subsequent requests. This is used all over + in some standard libs and course
1182 * format callbacks so subsequent requests are a reality.
1183 *
1184 * @staticvar array $coursesections
1185 * @param int $courseid
1186 * @return array Array of sections
1187 */
7468bf01 1188function get_all_sections($courseid) {
cb6fec1f 1189 global $DB;
7487c856
SH
1190 static $coursesections = array();
1191 if (!array_key_exists($courseid, $coursesections)) {
1192 $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1193 "section, id, course, name, summary, summaryformat, sequence, visible");
1194 }
1195 return $coursesections[$courseid];
7468bf01 1196}
1197
b86fc0e2 1198function course_set_display($courseid, $display=0) {
cb6fec1f 1199 global $USER, $DB;
b86fc0e2 1200
b86fc0e2 1201 if ($display == "all" or empty($display)) {
1202 $display = 0;
1203 }
1204
4f0c2d00 1205 if (!isloggedin() or isguestuser()) {
7b678e0a 1206 //do not store settings in db for guests
238c0dd9 1207 } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
cb6fec1f 1208 $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
b86fc0e2 1209 } else {
fbaea88f 1210 $record = new stdClass();
b86fc0e2 1211 $record->userid = $USER->id;
1212 $record->course = $courseid;
1213 $record->display = $display;
fc29e51b 1214 $DB->insert_record("course_display", $record);
b86fc0e2 1215 }
1216
1217 return $USER->display[$courseid] = $display; // Note: = not ==
1218}
1219
cb6fec1f 1220/**
7e85563d 1221 * For a given course section, marks it visible or hidden,
cb6fec1f 1222 * and does the same for every activity in that section
1223 */
7d99d695 1224function set_section_visible($courseid, $sectionnumber, $visibility) {
cb6fec1f 1225 global $DB;
7d99d695 1226
cb6fec1f 1227 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1228 $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
7d99d695 1229 if (!empty($section->sequence)) {
1230 $modules = explode(",", $section->sequence);
1231 foreach ($modules as $moduleid) {
02f66c42 1232 set_coursemodule_visible($moduleid, $visibility, true);
7d99d695 1233 }
1234 }
5867bfb5 1235 rebuild_course_cache($courseid);
7d99d695 1236 }
1237}
ba2e5d73 1238
cb6fec1f 1239/**
1240 * Prints a section full of activity modules
1241 */
4e781c7b 1242function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
e63f88c9 1243 global $CFG, $USER, $DB, $PAGE, $OUTPUT;
7977cffd 1244
dd97c328 1245 static $initialised;
1246
3d575e6f 1247 static $groupbuttons;
32d03b7b 1248 static $groupbuttonslink;
52dcc2f9 1249 static $isediting;
7977cffd 1250 static $ismoving;
1251 static $strmovehere;
1252 static $strmovefull;
54669989 1253 static $strunreadpostsone;
a2d71d8e 1254 static $usetracking;
dd97c328 1255 static $groupings;
110a32e2 1256
dd97c328 1257 if (!isset($initialised)) {
9fd9c29b 1258 $groupbuttons = ($course->groupmode or (!$course->groupmodeforce));
32d03b7b 1259 $groupbuttonslink = (!$course->groupmodeforce);
830dd6e9 1260 $isediting = $PAGE->user_is_editing();
dd97c328 1261 $ismoving = $isediting && ismoving($course->id);
3d575e6f 1262 if ($ismoving) {
dd97c328 1263 $strmovehere = get_string("movehere");
1264 $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
3d575e6f 1265 }
94a6a70f 1266 include_once($CFG->dirroot.'/mod/forum/lib.php');
1267 if ($usetracking = forum_tp_can_track_forums()) {
dd97c328 1268 $strunreadpostsone = get_string('unreadpostsone', 'forum');
a2d71d8e 1269 }
dd97c328 1270 $initialised = true;
7977cffd 1271 }
dd97c328 1272
fbaea88f 1273 $labelformatoptions = new stdClass();
60bd11cf 1274 $labelformatoptions->noclean = true;
367a75fa 1275 $labelformatoptions->overflowdiv = true;
94361e02 1276
fea43a7f 1277/// Casting $course->modinfo to string prevents one notice when the field is null
dd97c328 1278 $modinfo = get_fast_modinfo($course);
984baa77 1279 $completioninfo = new completion_info($course);
94361e02 1280
7e85563d 1281 //Accessibility: replace table with list <ul>, but don't output empty list.
74666583 1282 if (!empty($section->sequence)) {
94361e02 1283
f2d660dc 1284 // Fix bug #5027, don't want style=\"width:$width\".
6285f8a8 1285 echo "<ul class=\"section img-text\">\n";
94361e02 1286 $sectionmods = explode(",", $section->sequence);
1287
1288 foreach ($sectionmods as $modnumber) {
9ae687af 1289 if (empty($mods[$modnumber])) {
1290 continue;
1291 }
dd97c328 1292
94361e02 1293 $mod = $mods[$modnumber];
c9f6251e 1294
dd97c328 1295 if ($ismoving and $mod->id == $USER->activitycopy) {
1296 // do not display moving mod
1297 continue;
1298 }
c9f6251e 1299
dd97c328 1300 if (isset($modinfo->cms[$modnumber])) {
85f55ba2 1301 // We can continue (because it will not be displayed at all)
1302 // if:
1303 // 1) The activity is not visible to users
1304 // and
1305 // 2a) The 'showavailability' option is not set (if that is set,
2f48819b 1306 // we need to display the activity so we can show
85f55ba2 1307 // availability info)
1308 // or
2f48819b 1309 // 2b) The 'availableinfo' is empty, i.e. the activity was
1310 // hidden in a way that leaves no info, such as using the
85f55ba2 1311 // eye icon.
82bd6a5e 1312 if (!$modinfo->cms[$modnumber]->uservisible &&
85f55ba2 1313 (empty($modinfo->cms[$modnumber]->showavailability) ||
1314 empty($modinfo->cms[$modnumber]->availableinfo))) {
dd97c328 1315 // visibility shortcut
1316 continue;
86aa7ccf 1317 }
dd97c328 1318 } else {
0f56c9da 1319 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1320 // module not installed
1321 continue;
1322 }
82bd6a5e 1323 if (!coursemodule_visible_for_user($mod) &&
1324 empty($mod->showavailability)) {
dd97c328 1325 // full visibility check
1326 continue;
9d361034 1327 }
dd97c328 1328 }
1329
2f48819b 1330 // In some cases the activity is visible to user, but it is
e8e50986 1331 // dimmed. This is done if viewhiddenactivities is true and if:
1332 // 1. the activity is not visible, or
1333 // 2. the activity has dates set which do not include current, or
1334 // 3. the activity has any other conditions set (regardless of whether
1335 // current user meets them)
1336 $canviewhidden = has_capability(
1337 'moodle/course:viewhiddenactivities',
1338 get_context_instance(CONTEXT_MODULE, $mod->id));
1339 $accessiblebutdim = false;
1340 if ($canviewhidden) {
1341 $accessiblebutdim = !$mod->visible;
1342 if (!empty($CFG->enableavailability)) {
1343 $accessiblebutdim = $accessiblebutdim ||
1344 $mod->availablefrom > time() ||
1345 ($mod->availableuntil && $mod->availableuntil < time()) ||
2f48819b 1346 count($mod->conditionsgrade) > 0 ||
e8e50986 1347 count($mod->conditionscompletion) > 0;
1348 }
1349 }
1350
b31b2d84 1351 echo '<li class="activity '.$mod->modname.' modtype_'.$mod->modname.'" id="module-'.$modnumber.'">'; // Unique ID
dd97c328 1352 if ($ismoving) {
1353 echo '<a title="'.$strmovefull.'"'.
d4a1fcaf 1354 ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
b5d0cafc 1355 '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
dd97c328 1356 ' alt="'.$strmovehere.'" /></a><br />
1357 ';
1358 }
9d361034 1359
dd97c328 1360 if ($mod->indent) {
1ba862ec 1361 echo $OUTPUT->spacer(array('height'=>12, 'width'=>(20 * $mod->indent))); // should be done with CSS instead
dd97c328 1362 }
1363
554606c7 1364 $extra = '';
1365 if (!empty($modinfo->cms[$modnumber]->extra)) {
82bd6a5e 1366 $extra = $modinfo->cms[$modnumber]->extra;
554606c7 1367 }
dd97c328 1368
1369 if ($mod->modname == "label") {
e8e50986 1370 if ($accessiblebutdim || !$mod->uservisible) {
85f55ba2 1371 echo '<div class="dimmed_text"><span class="accesshide">'.
4a087123 1372 get_string('hiddenfromstudents').'</span>';
722b4ce1
SH
1373 } else {
1374 echo '<div>';
dd97c328 1375 }
1376 echo format_text($extra, FORMAT_HTML, $labelformatoptions);
722b4ce1 1377 echo "</div>";
98da6021 1378 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
c4d989a1 1379 if (!isset($groupings)) {
1380 $groupings = groups_get_all_groupings($course->id);
1381 }
1470825e 1382 echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
c4d989a1 1383 }
aac94fd0 1384
dd97c328 1385 } else { // Normal activity
1386 $instancename = format_string($modinfo->cms[$modnumber]->name, true, $course->id);
c9f6251e 1387
c93dae38 1388 $customicon = $modinfo->cms[$modnumber]->icon;
1389 if (!empty($customicon)) {
1390 if (substr($customicon, 0, 4) === 'mod/') {
5ef44400 1391 list($modname, $iconname) = explode('/', substr($customicon, 4), 2);
472c1022 1392 $icon = $OUTPUT->pix_url($iconname, $modname);
c93dae38 1393 } else {
ede72522 1394 $icon = $OUTPUT->pix_url($customicon);
c93dae38 1395 }
dd97c328 1396 } else {
b5d0cafc 1397 $icon = $OUTPUT->pix_url('icon', $mod->modname);
dd97c328 1398 }
e0b033d5 1399
aa54ed7b 1400 //Accessibility: for files get description via icon, this is very ugly hack!
dd97c328 1401 $altname = '';
aa54ed7b 1402 $altname = $mod->modfullname;
1403 if (!empty($customicon)) {
1404 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1405 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
ede72522 1406 $mimetype = mimeinfo_from_icon('type', $customicon);
dd97c328 1407 $altname = get_mimetype_description($mimetype);
6285f8a8 1408 }
dd97c328 1409 }
1410 // Avoid unnecessary duplication.
aa54ed7b 1411 if (false !== stripos($instancename, $altname)) {
dd97c328 1412 $altname = '';
1413 }
1414 // File type after name, for alphabetic lists (screen reader).
1415 if ($altname) {
1416 $altname = get_accesshide(' '.$altname);
1417 }
6285f8a8 1418
82bd6a5e 1419 // We may be displaying this just in order to show information
2afcfc44 1420 // about visibility, without the actual link
52dbbcf6 1421 if ($mod->uservisible) {
82bd6a5e 1422 // Display normal module link
e8e50986 1423 if (!$accessiblebutdim) {
52dbbcf6 1424 $linkcss = '';
1425 $accesstext ='';
85f55ba2 1426 } else {
1427 $linkcss = ' class="dimmed" ';
52dbbcf6 1428 $accesstext = '<span class="accesshide">'.
85f55ba2 1429 get_string('hiddenfromstudents').': </span>';
1430 }
52dbbcf6 1431
85f55ba2 1432 echo '<a '.$linkcss.' '.$extra.
2f48819b 1433 ' href="'.$CFG->wwwroot.'/mod/'.$mod->modname.'/view.php?id='.$mod->id.'">'.
3aa11c75 1434 '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename',$mod->modname).'" /> '.
b31b2d84 1435 $accesstext.'<span class="instancename">'.$instancename.$altname.'</span></a>';
82bd6a5e 1436
98da6021 1437 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
82bd6a5e 1438 if (!isset($groupings)) {
1439 $groupings = groups_get_all_groupings($course->id);
1440 }
1441 echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
acf000b0 1442 }
82bd6a5e 1443 } else {
1444 // Display greyed-out text of link
85f55ba2 1445 echo '<span class="dimmed_text" '.$extra.' ><span class="accesshide">'.
1446 get_string('notavailableyet','condition').': </span>'.
3aa11c75 1447 '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename', $mod->modname).'" /> <span>'.
85f55ba2 1448 $instancename.$altname.'</span></span>';
c9f6251e 1449 }
dd97c328 1450 }
1451 if ($usetracking && $mod->modname == 'forum') {
90f4745c 1452 if ($unread = forum_tp_count_forum_unread_posts($mod, $course)) {
1453 echo '<span class="unread"> <a href="'.$CFG->wwwroot.'/mod/forum/view.php?id='.$mod->id.'">';
1454 if ($unread == 1) {
1455 echo $strunreadpostsone;
1456 } else {
1457 print_string('unreadpostsnumber', 'forum', $unread);
54669989 1458 }
90f4745c 1459 echo '</a></span>';
f37da850 1460 }
dd97c328 1461 }
f37da850 1462
dd97c328 1463 if ($isediting) {
525e16ce 1464 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
dd97c328 1465 if (! $mod->groupmodelink = $groupbuttonslink) {
1466 $mod->groupmode = $course->groupmode;
3d575e6f 1467 }
dd97c328 1468
1469 } else {
1470 $mod->groupmode = false;
c9f6251e 1471 }
dd97c328 1472 echo '&nbsp;&nbsp;';
1473 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
94361e02 1474 }
4e781c7b 1475
1476 // Completion
3982f0f8 1477 $completion = $hidecompletion
4e781c7b 1478 ? COMPLETION_TRACKING_NONE
1479 : $completioninfo->is_enabled($mod);
2f48819b 1480 if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
82bd6a5e 1481 !isguestuser() && $mod->uservisible) {
3982f0f8 1482 $completiondata = $completioninfo->get_data($mod,true);
1483 $completionicon = '';
1484 if ($isediting) {
1485 switch ($completion) {
ca255392 1486 case COMPLETION_TRACKING_MANUAL :
3982f0f8 1487 $completionicon = 'manual-enabled'; break;
ca255392 1488 case COMPLETION_TRACKING_AUTOMATIC :
3982f0f8 1489 $completionicon = 'auto-enabled'; break;
4e781c7b 1490 default: // wtf
1491 }
3982f0f8 1492 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
4e781c7b 1493 switch($completiondata->completionstate) {
1494 case COMPLETION_INCOMPLETE:
3982f0f8 1495 $completionicon = 'manual-n'; break;
4e781c7b 1496 case COMPLETION_COMPLETE:
3982f0f8 1497 $completionicon = 'manual-y'; break;
4e781c7b 1498 }
1499 } else { // Automatic
1500 switch($completiondata->completionstate) {
1501 case COMPLETION_INCOMPLETE:
3982f0f8 1502 $completionicon = 'auto-n'; break;
4e781c7b 1503 case COMPLETION_COMPLETE:
3982f0f8 1504 $completionicon = 'auto-y'; break;
4e781c7b 1505 case COMPLETION_COMPLETE_PASS:
3982f0f8 1506 $completionicon = 'auto-pass'; break;
4e781c7b 1507 case COMPLETION_COMPLETE_FAIL:
3982f0f8 1508 $completionicon = 'auto-fail'; break;
4e781c7b 1509 }
1510 }
3982f0f8 1511 if ($completionicon) {
b5d0cafc 1512 $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
76c0123b
PS
1513 $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1514 if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1515 $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
3982f0f8 1516 $newstate =
4e781c7b 1517 $completiondata->completionstate==COMPLETION_COMPLETE
ca255392 1518 ? COMPLETION_INCOMPLETE
1519 : COMPLETION_COMPLETE;
a343b13f 1520 // In manual mode the icon is a toggle form...
1521
1522 // If this completion state is used by the
1523 // conditional activities system, we need to turn
1524 // off the JS.
2f48819b 1525 if (!empty($CFG->enableavailability) &&
76c0123b 1526 condition_info::completion_value_used_as_condition($course, $mod)) {
a343b13f 1527 $extraclass = ' preventjs';
1528 } else {
1529 $extraclass = '';
1530 }
4e781c7b 1531 echo "
76c0123b 1532<form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>
4e781c7b 1533<input type='hidden' name='id' value='{$mod->id}' />
8c194133 1534<input type='hidden' name='sesskey' value='".sesskey()."' />
4e781c7b 1535<input type='hidden' name='completionstate' value='$newstate' />
1536<input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1537</div></form>";
1538 } else {
1539 // In auto mode, or when editing, the icon is just an image
f17a0360 1540 echo "<span class='autocompletion'>";
f17a0360 1541 echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
4e781c7b 1542 }
1543 }
1544 }
1545
2f48819b 1546 // Show availability information (for someone who isn't allowed to
82bd6a5e 1547 // see the activity itself, or for staff)
3982f0f8 1548 if (!$mod->uservisible) {
82bd6a5e 1549 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
e8e50986 1550 } else if ($canviewhidden && !empty($CFG->enableavailability)) {
82bd6a5e 1551 $ci = new condition_info($mod);
3982f0f8 1552 $fullinfo = $ci->get_full_information();
82bd6a5e 1553 if($fullinfo) {
2f48819b 1554 echo '<div class="availabilityinfo">'.get_string($mod->showavailability
82bd6a5e 1555 ? 'userrestriction_visible'
1556 : 'userrestriction_hidden','condition',
1557 $fullinfo).'</div>';
1558 }
1559 }
1560
dd97c328 1561 echo "</li>\n";
94361e02 1562 }
dd97c328 1563
f2d660dc 1564 } elseif ($ismoving) {
1565 echo "<ul class=\"section\">\n";
264867fd 1566 }
dd97c328 1567
7977cffd 1568 if ($ismoving) {
64fdc686 1569 echo '<li><a title="'.$strmovefull.'"'.
d4a1fcaf 1570 ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
b5d0cafc 1571 '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
c6a55371 1572 ' alt="'.$strmovehere.'" /></a></li>
1c919752 1573 ';
7977cffd 1574 }
c6a55371 1575 if (!empty($section->sequence) || $ismoving) {
1576 echo "</ul><!--class='section'-->\n\n";
1577 }
a7ad3ea6 1578}
1579
89bfeee0 1580/**
1581 * Prints the menus to add activities and resources.
1582 */
cb57e6f4 1583function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
64e12bb7 1584 global $CFG, $OUTPUT;
e0161bff 1585
217a8ee9 1586 // check to see if user can add menus
1587 if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
e2cd3ed0 1588 return false;
217a8ee9 1589 }
1590
31dadc6f
PS
1591 $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1592
017ab27c
DP
1593 $resources = array();
1594 $activities = array();
6da4b261 1595
017ab27c
DP
1596 foreach($modnames as $modname=>$modnamestr) {
1597 if (!course_allowed_module($course, $modname)) {
1598 continue;
1599 }
6da4b261 1600
017ab27c
DP
1601 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1602 if (!file_exists($libfile)) {
1603 continue;
1604 }
1605 include_once($libfile);
1606 $gettypesfunc = $modname.'_get_types';
1607 if (function_exists($gettypesfunc)) {
1608 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1609 if ($types = $gettypesfunc()) {
1610 $menu = array();
1611 $atype = null;
1612 $groupname = null;
1613 foreach($types as $type) {
31dadc6f 1614 if ($type->typestr === '--') {
017ab27c 1615 continue;
65bcf17b 1616 }
017ab27c
DP
1617 if (strpos($type->typestr, '--') === 0) {
1618 $groupname = str_replace('--', '', $type->typestr);
1619 continue;
89bfeee0 1620 }
017ab27c
DP
1621 $type->type = str_replace('&amp;', '&', $type->type);
1622 if ($type->modclass == MOD_CLASS_RESOURCE) {
1623 $atype = MOD_CLASS_RESOURCE;
1624 }
1625 $menu[$urlbase.$type->type] = $type->typestr;
89bfeee0 1626 }
017ab27c
DP
1627 if (!is_null($groupname)) {
1628 if ($atype == MOD_CLASS_RESOURCE) {
1629 $resources[] = array($groupname=>$menu);
1630 } else {
1631 $activities[] = array($groupname=>$menu);
1632 }
aa54ed7b 1633 } else {
017ab27c
DP
1634 if ($atype == MOD_CLASS_RESOURCE) {
1635 $resources = array_merge($resources, $menu);
1636 } else {
1637 $activities = array_merge($activities, $menu);
1638 }
aa54ed7b 1639 }
89bfeee0 1640 }
017ab27c
DP
1641 } else {
1642 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1643 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1644 $resources[$urlbase.$modname] = $modnamestr;
1645 } else {
1646 // all other archetypes are considered activity
1647 $activities[$urlbase.$modname] = $modnamestr;
1648 }
0705ff84 1649 }
e0161bff 1650 }
1651
89bfeee0 1652 $straddactivity = get_string('addactivity');
1653 $straddresource = get_string('addresource');
1654
4f24b3e3 1655 $output = '<div class="section_add_menus">';
1656
1657 if (!$vertical) {
1658 $output .= '<div class="horizontal">';
1659 }
82fcab32 1660
89bfeee0 1661 if (!empty($resources)) {
31dadc6f 1662 $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
d2265f13 1663 $select->set_help_icon('resources');
31dadc6f 1664 $output .= $OUTPUT->render($select);
0705ff84 1665 }
cb57e6f4 1666
89bfeee0 1667 if (!empty($activities)) {
31dadc6f 1668 $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
d2265f13 1669 $select->set_help_icon('activities');
31dadc6f 1670 $output .= $OUTPUT->render($select);
0705ff84 1671 }
1672
4f24b3e3 1673 if (!$vertical) {
d33d0cda 1674 $output .= '</div>';
1675 }
1676
cb57e6f4 1677 $output .= '</div>';
1678
1679 if ($return) {
1680 return $output;
1681 } else {
1682 echo $output;
1683 }
e0161bff 1684}
1685
8ed5dd63 1686/**
1687 * Return the course category context for the category with id $categoryid, except
1688 * that if $categoryid is 0, return the system context.
1689 *
1690 * @param integer $categoryid a category id or 0.
1691 * @return object the corresponding context
1692 */
1693function get_category_or_system_context($categoryid) {
1694 if ($categoryid) {
1695 return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1696 } else {
1697 return get_context_instance(CONTEXT_SYSTEM);
1698 }
1699}
1700
f36cbf1d 1701/**
1702 * Rebuilds the cached list of course activities stored in the database
7e85563d 1703 * @param int $courseid - id of course to rebuild, empty means all
f36cbf1d 1704 * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1705 */
1706function rebuild_course_cache($courseid=0, $clearonly=false) {
e6db3026 1707 global $COURSE, $DB, $OUTPUT;
f36cbf1d 1708
58d89c24
SH
1709 // Destroy navigation caches
1710 navigation_cache::destroy_volatile_caches();
1711
f36cbf1d 1712 if ($clearonly) {
1c69b885 1713 if (empty($courseid)) {
1714 $courseselect = array();
1715 } else {
1716 $courseselect = array('id'=>$courseid);
1717 }
1718 $DB->set_field('course', 'modinfo', null, $courseselect);
f36cbf1d 1719 // update cached global COURSE too ;-)
f80ee891 1720 if ($courseid == $COURSE->id or empty($courseid)) {
238c0dd9 1721 $COURSE->modinfo = null;
f36cbf1d 1722 }
1723 // reset the fast modinfo cache
1724 $reset = 'reset';
1725 get_fast_modinfo($reset);
1726 return;
1727 }
5867bfb5 1728
1729 if ($courseid) {
cb6fec1f 1730 $select = array('id'=>$courseid);
5867bfb5 1731 } else {
cb6fec1f 1732 $select = array();
6cf890e3 1733 @set_time_limit(0); // this could take a while! MDL-10954
5867bfb5 1734 }
1735
cb6fec1f 1736 if ($rs = $DB->get_recordset("course", $select,'','id,fullname')) {
1737 foreach ($rs as $course) {
5867bfb5 1738 $modinfo = serialize(get_array_of_activities($course->id));
f685e830 1739 $DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id));
dd97c328 1740 // update cached global COURSE too ;-)
1741 if ($course->id == $COURSE->id) {
238c0dd9 1742 $COURSE->modinfo = $modinfo;
dd97c328 1743 }
5867bfb5 1744 }
cb6fec1f 1745 $rs->close();
5867bfb5 1746 }
dd97c328 1747 // reset the fast modinfo cache
65a00c97 1748 $reset = 'reset';
1749 get_fast_modinfo($reset);
5867bfb5 1750}
1751
cb6fec1f 1752/**
7e85563d 1753 * Gets the child categories of a given courses category. Uses a static cache
8ed5dd63 1754 * to make repeat calls efficient.
1755 *
e92c39ca 1756 * @param int $parentid the id of a course category.
8ed5dd63 1757 * @return array all the child course categories.
cb6fec1f 1758 */
8ed5dd63 1759function get_child_categories($parentid) {
9bb19e58 1760 static $allcategories = null;
1761
1762 // only fill in this variable the first time
1763 if (null == $allcategories) {
1764 $allcategories = array();
1765
1766 $categories = get_categories();
1767 foreach ($categories as $category) {
1768 if (empty($allcategories[$category->parent])) {
1769 $allcategories[$category->parent] = array();
1770 }
1771 $allcategories[$category->parent][] = $category;
1772 }
1773 }
1774
8ed5dd63 1775 if (empty($allcategories[$parentid])) {
9bb19e58 1776 return array();
1777 } else {
8ed5dd63 1778 return $allcategories[$parentid];
9bb19e58 1779 }
1780}
1781
cb6fec1f 1782/**
8ed5dd63 1783 * This function recursively travels the categories, building up a nice list
1784 * for display. It also makes an array that list all the parents for each
1785 * category.
1786 *
1787 * For example, if you have a tree of categories like:
1788 * Miscellaneous (id = 1)
1789 * Subcategory (id = 2)
1790 * Sub-subcategory (id = 4)
1791 * Other category (id = 3)
1792 * Then after calling this function you will have
1793 * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1794 * 4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1795 * 3 => 'Other category');
1796 * $parents = array(2 => array(1), 4 => array(1, 2));
1797 *
1798 * If you specify $requiredcapability, then only categories where the current
1799 * user has that capability will be added to $list, although all categories
1800 * will still be added to $parents, and if you only have $requiredcapability
1801 * in a child category, not the parent, then the child catgegory will still be
1802 * included.
1803 *
1804 * If you specify the option $excluded, then that category, and all its children,
1805 * are omitted from the tree. This is useful when you are doing something like
1806 * moving categories, where you do not want to allow people to move a category
1807 * to be the child of itself.
1808 *
1809 * @param array $list For output, accumulates an array categoryid => full category path name
1810 * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
8a1b1c32 1811 * @param string/array $requiredcapability if given, only categories where the current
1812 * user has this capability will be added to $list. Can also be an array of capabilities,
1813 * in which case they are all required.
8ed5dd63 1814 * @param integer $excludeid Omit this category and its children from the lists built.
1815 * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1816 * @param string $path For internal use, as part of recursive calls.
cb6fec1f 1817 */
8ed5dd63 1818function make_categories_list(&$list, &$parents, $requiredcapability = '',
1819 $excludeid = 0, $category = NULL, $path = "") {
1820
9d866ae0 1821 // initialize the arrays if needed
1822 if (!is_array($list)) {
264867fd 1823 $list = array();
9d866ae0 1824 }
1825 if (!is_array($parents)) {
264867fd 1826 $parents = array();
9d866ae0 1827 }
1828
8ed5dd63 1829 if (empty($category)) {
1830 // Start at the top level.
1831 $category = new stdClass;
1832 $category->id = 0;
1833 } else {
1834 // This is the excluded category, don't include it.
1835 if ($excludeid > 0 && $excludeid == $category->id) {
1836 return;
1837 }
1838
1839 // Update $path.
c2cb4545 1840 if ($path) {
6ba65fa0 1841 $path = $path.' / '.format_string($category->name);
c2cb4545 1842 } else {
6ba65fa0 1843 $path = format_string($category->name);
c2cb4545 1844 }
8ed5dd63 1845
1846 // Add this category to $list, if the permissions check out.
3ce50127 1847 if (empty($requiredcapability)) {
8ed5dd63 1848 $list[$category->id] = $path;
3ce50127 1849
1850 } else {
1851 ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1852 $requiredcapability = (array)$requiredcapability;
1853 if (has_all_capabilities($requiredcapability, $category->context)) {
1854 $list[$category->id] = $path;
1855 }
8ed5dd63 1856 }
c2cb4545 1857 }
1858
8ed5dd63 1859 // Add all the children recursively, while updating the parents array.
1860 if ($categories = get_child_categories($category->id)) {
c2cb4545 1861 foreach ($categories as $cat) {
1862 if (!empty($category->id)) {
3bd4de22 1863 if (isset($parents[$category->id])) {
2832badf 1864 $parents[$cat->id] = $parents[$category->id];
1865 }
c2cb4545 1866 $parents[$cat->id][] = $category->id;
1867 }
8ed5dd63 1868 make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
c2cb4545 1869 }
1870 }
1871}
1872
24e27ac0
SH
1873/**
1874 * This function generates a structured array of courses and categories.
1875 *
1876 * The depth of categories is limited by $CFG->maxcategorydepth however there
1877 * is no limit on the number of courses!
1878 *
1879 * Suitable for use with the course renderers course_category_tree method:
1880 * $renderer = $PAGE->get_renderer('core','course');
1881 * echo $renderer->course_category_tree(get_course_category_tree());
1882 *
1883 * @global moodle_database $DB
1884 * @param int $id
1885 * @param int $depth
1886 */
1887function get_course_category_tree($id = 0, $depth = 0) {
cf41dc37 1888 global $DB, $CFG;
24e27ac0
SH
1889 $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
1890 $categories = get_child_categories($id);
1891 $categoryids = array();
1892 foreach ($categories as $key => &$category) {
1893 if (!$category->visible && !$viewhiddencats) {
1894 unset($categories[$key]);
1895 continue;
1896 }
1897 $categoryids[$category->id] = $category;
1898 if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1899 list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
3ebc548f
SH
1900 foreach ($subcategories as $subid=>$subcat) {
1901 $categoryids[$subid] = $subcat;
1902 }
24e27ac0
SH
1903 $category->courses = array();
1904 }
1905 }
1906
1907 if ($depth > 0) {
1908 // This is a recursive call so return the required array
1909 return array($categories, $categoryids);
1910 }
1911
1912 // The depth is 0 this function has just been called so we can finish it off
1913
1914 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1915 list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1916 $sql = "SELECT
df997f84 1917 c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
24e27ac0
SH
1918 $ccselect
1919 FROM {course} c
1920 $ccjoin
1921 WHERE c.category $catsql ORDER BY c.sortorder ASC";
1922 if ($courses = $DB->get_records_sql($sql, $catparams)) {
1923 // loop throught them
1924 foreach ($courses as $course) {
1925 if ($course->id == SITEID) {
1926 continue;
1927 }
1928 context_instance_preload($course);
1929 if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1930 $categoryids[$course->category]->courses[$course->id] = $course;
1931 }
1932 }
1933 }
1934 return $categories;
1935}
c2cb4545 1936
cb6fec1f 1937/**
1938 * Recursive function to print out all the categories in a nice format
1939 * with or without courses included
1940 */
8ed5dd63 1941function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
9ff5310a 1942 global $CFG;
e05bcf2f 1943
beeee4d2 1944 // maxcategorydepth == 0 meant no limit
1945 if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
e05bcf2f 1946 return;
9ff5310a 1947 }
c2cb4545 1948
1949 if (!$displaylist) {
e92fe848 1950 make_categories_list($displaylist, $parentslist);
c2cb4545 1951 }
1952
1953 if ($category) {
8ed5dd63 1954 if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
1955 print_category_info($category, $depth, $showcourses);
c2cb4545 1956 } else {
1957 return; // Don't bother printing children of invisible categories
1958 }
89adb174 1959
c2cb4545 1960 } else {
c2cb4545 1961 $category->id = "0";
1962 }
1963
9bb19e58 1964 if ($categories = get_child_categories($category->id)) { // Print all the children recursively
c2cb4545 1965 $countcats = count($categories);
1966 $count = 0;
1967 $first = true;
1968 $last = false;
1969 foreach ($categories as $cat) {
1970 $count++;
1971 if ($count == $countcats) {
1972 $last = true;
1973 }
1974 $up = $first ? false : true;
1975 $down = $last ? false : true;
1976 $first = false;
1977
8ed5dd63 1978 print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
c2cb4545 1979 }
1980 }
c2cb4545 1981}
1982
cb6fec1f 1983/**
af90698b 1984 * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
cb6fec1f 1985 */
0705ff84 1986function make_categories_options() {
1987 make_categories_list($cats,$parents);
1988 foreach ($cats as $key => $value) {
1989 if (array_key_exists($key,$parents)) {
1990 if ($indent = count($parents[$key])) {
1991 for ($i = 0; $i < $indent; $i++) {
1992 $cats[$key] = '&nbsp;'.$cats[$key];
1993 }
1994 }
1995 }
1996 }
1997 return $cats;
1998}
c2cb4545 1999
cb6fec1f 2000/**
2001 * Prints the category info in indented fashion
2002 * This function is only used by print_whole_category_list() above
2003 */
f3e5bf86 2004function print_category_info($category, $depth=0, $showcourses = false) {
6b608f8f 2005 global $CFG, $DB, $OUTPUT;
c2cb4545 2006
df997f84 2007 $strsummary = get_string('summary');
ba2e5d73 2008
ea831ceb
RW
2009 $catlinkcss = null;
2010 if (!$category->visible) {
2011 $catlinkcss = array('class'=>'dimmed');
2012 }
dc247e52 2013 static $coursecount = null;
2014 if (null === $coursecount) {
2015 // only need to check this once
2016 $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2017 }
2018
8ed5dd63 2019 if ($showcourses and $coursecount) {
b5d0cafc 2020 $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
b48f834c 2021 } else {
7b0b5c14 2022 $catimage = "&nbsp;";
8ef9cb56 2023 }
2afcfc44 2024
df997f84 2025 $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
8ed5dd63 2026 if ($showcourses and $coursecount) {
2a63b636 2027 echo '<div class="categorylist clearfix">';
2afcfc44 2028 $cat = '';
2a63b636 2029 $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
ea831ceb 2030 $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2afcfc44
RW
2031 $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2032
ea831ceb 2033 $html = '';
2afcfc44
RW
2034 if ($depth > 0) {
2035 for ($i=0; $i< $depth; $i++) {
ea831ceb 2036 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2afcfc44 2037 $cat = '';
cb184beb 2038 }
2afcfc44 2039 } else {
ea831ceb 2040 $html = $cat;
2afcfc44 2041 }
2a63b636 2042 echo html_writer::tag('div', $html, array('class'=>'category'));
2afcfc44 2043 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
b48f834c 2044
beeee4d2 2045 // does the depth exceed maxcategorydepth
2afcfc44 2046 // maxcategorydepth == 0 or unset meant no limit
beeee4d2 2047 $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
beeee4d2 2048 if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
c2cb4545 2049 foreach ($courses as $course) {
ea831ceb
RW
2050 $linkcss = null;
2051 if (!$course->visible) {
2052 $linkcss = array('class'=>'dimmed');
2053 }
2a63b636 2054
ea831ceb 2055 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2afcfc44 2056
bf423bb1 2057 // print enrol info
f3e5bf86 2058 $courseicon = '';
bf423bb1
PS
2059 if ($icons = enrol_get_course_info_icons($course)) {
2060 foreach ($icons as $pix_icon) {
f3e5bf86 2061 $courseicon = $OUTPUT->render($pix_icon).' ';
bf423bb1
PS
2062 }
2063 }
2064
f3e5bf86
SH
2065 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2066
b48f834c 2067 if ($course->summary) {
75015e5f 2068 $link = new moodle_url('/course/info.php?id='.$course->id);
2afcfc44 2069 $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
75015e5f
PS
2070 new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2071 array('title'=>$strsummary));
2afcfc44
RW
2072
2073 $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2074 }
2075
ea831ceb 2076 $html = '';
f3e5bf86 2077 for ($i=0; $i <= $depth; $i++) {
ea831ceb 2078 $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2afcfc44 2079 $coursecontent = '';
0c656181 2080 }
ea831ceb 2081 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2afcfc44 2082 }
ba2e5d73 2083 }
2afcfc44
RW
2084 echo '</div>';
2085 } else {
2a63b636 2086 echo '<div class="categorylist">';
ea831ceb
RW
2087 $html = '';
2088 $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2089 $cat .= html_writer::tag('span', '('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2a63b636 2090
ea831ceb
RW
2091 if ($depth > 0) {
2092 for ($i=0; $i< $depth; $i++) {
2093 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2094 $cat = '';
2095 }
2096 } else {
2097 $html = $cat;
2098 }
2a63b636
PS
2099
2100 echo html_writer::tag('div', $html, array('class'=>'category'));
ea831ceb 2101 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
cb184beb 2102 echo '</div>';
2afcfc44 2103 }
c2cb4545 2104}
2105
77eddcd5 2106/**
2107 * Print the buttons relating to course requests.
2108 *
2109 * @param object $systemcontext the system context.
2110 */
2111function print_course_request_buttons($systemcontext) {
b4531207 2112 global $CFG, $DB, $OUTPUT;
77eddcd5 2113 if (empty($CFG->enablecourserequests)) {
2114 return;
2115 }
4f0c2d00 2116 if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
77eddcd5 2117 /// Print a button to request a new course
5c2ed7e2 2118 echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
77eddcd5 2119 }
2120 /// Print a button to manage pending requests
2121 if (has_capability('moodle/site:approvecourse', $systemcontext)) {
5c2ed7e2
PS
2122 $disabled = !$DB->record_exists('course_request', array());
2123 echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
77eddcd5 2124 }
2125}
2126
5048e034 2127/**
2128 * Does the user have permission to edit things in this category?
2129 *
2130 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2131 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2132 */
2133function can_edit_in_category($categoryid = 0) {
2134 $context = get_category_or_system_context($categoryid);
2135 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2136}
2137
8ed5dd63 2138/**
2139 * Prints the turn editing on/off button on course/index.php or course/category.php.
2140 *
2141 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2142 * @return string HTML of the editing button, or empty string, if this user is not allowed
2143 * to see it.
2144 */
2145function update_category_button($categoryid = 0) {
b4531207 2146 global $CFG, $PAGE, $OUTPUT;
8ed5dd63 2147
2148 // Check permissions.
5048e034 2149 if (!can_edit_in_category($categoryid)) {
8ed5dd63 2150 return '';
2151 }
2152
2153 // Work out the appropriate action.
830dd6e9 2154 if ($PAGE->user_is_editing()) {
8ed5dd63 2155 $label = get_string('turneditingoff');
2156 $edit = 'off';
2157 } else {
2158 $label = get_string('turneditingon');
2159 $edit = 'on';
2160 }
c2cb4545 2161
8ed5dd63 2162 // Generate the button HTML.
2163 $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2164 if ($categoryid) {
2165 $options['id'] = $categoryid;
2166 $page = 'category.php';
2167 } else {
2168 $page = 'index.php';
2169 }
a6855934 2170 return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
8ed5dd63 2171}
e0b033d5 2172
cb6fec1f 2173/**
2174 * Category is 0 (for all courses) or an object
2175 */
6c54240a 2176function print_courses($category) {
2f48819b 2177 global $CFG, $OUTPUT;
c2cb4545 2178
4dde1463 2179 if (!is_object($category) && $category==0) {
9bb19e58 2180 $categories = get_child_categories(0); // Parent = 0 ie top-level categories only
4dde1463 2181 if (is_array($categories) && count($categories) == 1) {
90c2ca2e 2182 $category = array_shift($categories);
238c0dd9 2183 $courses = get_courses_wmanagers($category->id,
2184 'c.sortorder ASC',
df997f84 2185 array('summary','summaryformat'));
90c2ca2e 2186 } else {
238c0dd9 2187 $courses = get_courses_wmanagers('all',
2188 'c.sortorder ASC',
df997f84 2189 array('summary','summaryformat'));
90c2ca2e 2190 }
2191 unset($categories);
607809b3 2192 } else {
238c0dd9 2193 $courses = get_courses_wmanagers($category->id,
2194 'c.sortorder ASC',
df997f84 2195 array('summary','summaryformat'));
c2cb4545 2196 }
2197
49cd4d79 2198 if ($courses) {
002fc5ba 2199 echo html_writer::start_tag('ul', array('class'=>'unlist'));
c2cb4545 2200 foreach ($courses as $course) {
4f0c2d00
PS
2201 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2202 if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
002fc5ba 2203 echo html_writer::start_tag('li');
4dde1463 2204 print_course($course);
002fc5ba 2205 echo html_writer::end_tag('li');
4dde1463 2206 }
c2cb4545 2207 }
002fc5ba 2208 echo html_writer::end_tag('ul');
c2cb4545 2209 } else {
7c5286cd 2210 echo $OUTPUT->heading(get_string("nocoursesyet"));
8e480396 2211 $context = get_context_instance(CONTEXT_SYSTEM);
0468976c 2212 if (has_capability('moodle/course:create', $context)) {
255d1033 2213 $options = array();
4868e95f
DM
2214 if (!empty($category->id)) {
2215 $options['category'] = $category->id;
2216 } else {
2217 $options['category'] = $CFG->defaultrequestcategory;
2218 }
002fc5ba 2219 echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
a6855934 2220 echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
002fc5ba 2221 echo html_writer::end_tag('div');
255d1033 2222 }
c2cb4545 2223 }
c2cb4545 2224}
2225
04c53106 2226/**
2227 * Print a description of a course, suitable for browsing in a list.
2228 *
2229 * @param object $course the course object.
2230 * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2231 */
2232function print_course($course, $highlightterms = '') {
666e8458 2233 global $CFG, $USER, $DB, $OUTPUT;
c2cb4545 2234
4f0c2d00 2235 $context = get_context_instance(CONTEXT_COURSE, $course->id);
146bbb8f 2236
8bdc9cac 2237 // Rewrite file URLs so that they are correct
64f93798 2238 $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
8bdc9cac 2239
002fc5ba
SH
2240 echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2241 echo html_writer::start_tag('div', array('class'=>'info'));
2242 echo html_writer::start_tag('h3', array('class'=>'name'));
22288704 2243
002fc5ba
SH
2244 $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2245 $linktext = highlight($highlightterms, format_string($course->fullname));
2246 $linkparams = array('title'=>get_string('entercourse'));
2247 if (empty($course->visible)) {
2248 $linkparams['class'] = 'dimmed';
2249 }
2250 echo html_writer::link($linkhref, $linktext, $linkparams);
2251 echo html_writer::end_tag('h3');
238c0dd9 2252
d42c64ba 2253 /// first find all roles that are supposed to be displayed
df997f84 2254 if (!empty($CFG->coursecontact)) {
c71f3265 2255 $managerroles = explode(',', $CFG->coursecontact);
4dde1463 2256 $namesarray = array();
2257 if (isset($course->managers)) {
2258 if (count($course->managers)) {
2259 $rusers = $course->managers;
2260 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
238c0dd9 2261
b682cee9 2262 /// Rename some of the role names if needed
2263 if (isset($context)) {
cb6fec1f 2264 $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
b682cee9 2265 }
2266
9d5a4b23 2267 // keep a note of users displayed to eliminate duplicates
2268 $usersshown = array();
4dde1463 2269 foreach ($rusers as $ra) {
9d5a4b23 2270
2271 // if we've already displayed user don't again
2272 if (in_array($ra->user->id,$usersshown)) {
2273 continue;
2274 }
2275 $usersshown[] = $ra->user->id;
2276
4f0c2d00 2277 $fullname = fullname($ra->user, $canviewfullnames);
b682cee9 2278
4f0c2d00
PS
2279 if (isset($aliasnames[$ra->roleid])) {
2280 $ra->rolename = $aliasnames[$ra->roleid]->name;
4dde1463 2281 }
4f0c2d00 2282
002fc5ba
SH
2283 $namesarray[] = format_string($ra->rolename).': '.
2284 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
4dde1463 2285 }
2286 }
2287 } else {
238c0dd9 2288 $rusers = get_role_users($managerroles, $context,
4f0c2d00 2289 true, '', 'r.sortorder ASC, u.lastname ASC');
4dde1463 2290 if (is_array($rusers) && count($rusers)) {
2291 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
165d25cc 2292
2293 /// Rename some of the role names if needed
2294 if (isset($context)) {
2295 $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2296 }
2297
4dde1463 2298 foreach ($rusers as $teacher) {
238c0dd9 2299 $fullname = fullname($teacher, $canviewfullnames);
165d25cc 2300
2301 /// Apply role names
2302 if (isset($aliasnames[$teacher->roleid])) {
2303 $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2304 }
2305
002fc5ba
SH
2306 $namesarray[] = format_string($teacher->rolename).': '.
2307 html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
4dde1463 2308 }
431cad0d 2309 }
c2cb4545 2310 }
431cad0d 2311
d42c64ba 2312 if (!empty($namesarray)) {
002fc5ba
SH
2313 echo html_writer::start_tag('ul', array('class'=>'teachers'));
2314 foreach ($namesarray as $name) {
2315 echo html_writer::tag('li', $name);
2316 }
2317 echo html_writer::end_tag('ul');
88768091 2318 }
c2cb4545 2319 }
002fc5ba 2320 echo html_writer::end_tag('div'); // End of info div
238c0dd9 2321
002fc5ba 2322 echo html_writer::start_tag('div', array('class'=>'summary'));
9f39c190 2323 $options = NULL;
2324 $options->noclean = true;
34b5847a 2325 $options->para = false;
367a75fa 2326 $options->overflowdiv = true;
8bdc9cac
SH
2327 if (!isset($course->summaryformat)) {
2328 $course->summaryformat = FORMAT_MOODLE;
2329 }
2330 echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options, $course->id));
002fc5ba
SH
2331 if ((!isloggedin() || is_siteadmin()) && $icons = enrol_get_course_info_icons($course)) {
2332 echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2333 foreach ($icons as $icon) {
2334 echo $OUTPUT->render($icon);
2335 }
2336 echo html_writer::end_tag('div'); // End of enrolmenticons div
2337 }
2338 echo html_writer::end_tag('div'); // End of summary div
2339 echo html_writer::end_tag('div'); // End of coursebox div
c2cb4545 2340}
2341
cb6fec1f 2342/**
2343 * Prints custom user information on the home page.
2344 * Over time this can include all sorts of information
2345 */
c2cb4545 2346function print_my_moodle() {
e6db3026 2347 global $USER, $CFG, $DB, $OUTPUT;
c2cb4545 2348
4f0c2d00 2349 if (!isloggedin() or isguestuser()) {
ba6018a9 2350 print_error('nopermissions', '', '', 'See My Moodle');
c2cb4545 2351 }
2352
df997f84 2353 $courses = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
0a127169 2354 $rhosts = array();
2355 $rcourses = array();
2356 if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2357 $rcourses = get_my_remotecourses($USER->id);
2358 $rhosts = get_my_remotehosts();
2359 }
2360
2361 if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2362
2363 if (!empty($courses)) {
2364 echo '<ul class="unlist">';
2365 foreach ($courses as $course) {
2366 if ($course->id == SITEID) {
2367 continue;
2368 }
2369 echo '<li>';
2370 print_course($course);
2371 echo "</li>\n";
86dd62a7 2372 }
0a127169 2373 echo "</ul>\n";
86dd62a7 2374 }
2375
0a127169 2376 // MNET
2377 if (!empty($rcourses)) {
2378 // at the IDP, we know of all the remote courses
2379 foreach ($rcourses as $course) {
2380 print_remote_course($course, "100%");
2381 }
2382 } elseif (!empty($rhosts)) {
2383 // non-IDP, we know of all the remote servers, but not courses
2384 foreach ($rhosts as $host) {
2385 print_remote_host($host, "100%");
2386 }
2387 }
86dd62a7 2388 unset($course);
0a127169 2389 unset($host);
38a10939 2390
cb6fec1f 2391 if ($DB->count_records("course") > (count($courses) + 1) ) { // Some courses not being displayed
7f989948 2392 echo "<table width=\"100%\"><tr><td align=\"center\">";
2393 print_course_search("", false, "short");
2394 echo "</td><td align=\"center\">";
5c2ed7e2 2395 echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
7f989948 2396 echo "</td></tr></table>\n";
2397 }
86dd62a7 2398
26330001 2399 } else {
cb6fec1f 2400 if ($DB->count_records("course_categories") > 1) {
e6db3026 2401 echo $OUTPUT->box_start("categorybox");
26330001 2402 print_whole_category_list();
e6db3026 2403 echo $OUTPUT->box_end();
26330001 2404 } else {
35d0244a 2405 print_courses(0);
26330001 2406 }
607809b3 2407 }
2b8cef80 2408}
2409
11b0c469 2410
a8b56716 2411function print_course_search($value="", $return=false, $format="plain") {
38a10939 2412 global $CFG;
1e0fb105 2413 static $count = 0;
2414
2415 $count++;
2416
2417 $id = 'coursesearch';
2418
2419 if ($count > 1) {
2420 $id .= $count;
2421 }
38a10939 2422
2423 $strsearchcourses= get_string("searchcourses");
2424
1c919752 2425 if ($format == 'plain') {
1e0fb105 2426 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
fcf9577a 2427 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
e42f4d92 2428 $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2429 $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
e42f4d92 2430 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2431 $output .= '</fieldset></form>';
1c919752 2432 } else if ($format == 'short') {
1e0fb105 2433 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
fcf9577a 2434 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
b1f97418 2435 $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2436 $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
e42f4d92 2437 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2438 $output .= '</fieldset></form>';
1c919752 2439 } else if ($format == 'navbar') {
fcf9577a 2440 $output = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2441 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
b1f97418 2442 $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2443 $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
e42f4d92 2444 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2445 $output .= '</fieldset></form>';
a8b56716 2446 }
2447
2448 if ($return) {
2449 return $output;
2450 }
2451 echo $output;
38a10939 2452}
11b0c469 2453
86dd62a7 2454function print_remote_course($course, $width="100%") {
86dd62a7 2455 global $CFG, $USER;
2456
2457 $linkcss = '';
2458
2459 $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2460
7cd266e9 2461 echo '<div class="coursebox remotecoursebox clearfix">';
86dd62a7 2462 echo '<div class="info">';
2463 echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2464 $linkcss.' href="'.$url.'">'
6ba65fa0 2465 . format_string($course->fullname) .'</a><br />'
2466 . format_string($course->hostname) . ' : '
238c0dd9 2467 . format_string($course->cat_name) . ' : '
2468 . format_string($course->shortname). '</div>';
86dd62a7 2469 echo '</div><div class="summary">';
2470 $options = NULL;
2471 $options->noclean = true;
2472 $options->para = false;
367a75fa 2473 $options->overflowdiv = true;
152a2273 2474 echo format_text($course->summary, $course->summaryformat, $options);
86dd62a7 2475 echo '</div>';
2476 echo '</div>';
86dd62a7 2477}
2478
643b67b8 2479function print_remote_host($host, $width="100%") {
6b608f8f 2480 global $OUTPUT;
643b67b8 2481
2482 $linkcss = '';
2483
7cd266e9 2484 echo '<div class="coursebox clearfix">';
643b67b8 2485 echo '<div class="info">';
2486 echo '<div class="name">';
b5d0cafc 2487 echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
643b67b8 2488 echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2489 . s($host['name']).'</a> - ';
1fd80ad3 2490 echo $host['count'] . ' ' . get_string('courses');
643b67b8 2491 echo '</div>';
2492 echo '</div>';
caa90d56 2493 echo '</div>';
643b67b8 2494}
2495
86dd62a7 2496
11b0c469 2497/// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2498
2499function add_course_module($mod) {
cb6fec1f 2500 global $DB;
11b0c469 2501
e5dfd0f3 2502 $mod->added = time();
53f4ad2c 2503 unset($mod->id);
11b0c469 2504
cb6fec1f 2505 return $DB->insert_record("course_modules", $mod);
11b0c469 2506}
2507
97928ddf 2508/**
2509 * Returns course section - creates new if does not exist yet.
2510 * @param int $relative section number
2511 * @param int $courseid
2512 * @return object $course_section object
2513 */
2514function get_course_section($section, $courseid) {
cb6fec1f 2515 global $DB;
2516
2517 if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
97928ddf 2518 return $cw;
2519 }
fbaea88f 2520 $cw = new stdClass();
cb6fec1f 2521 $cw->course = $courseid;
2522 $cw->section = $section;
2523 $cw->summary = "";
09eb2151 2524 $cw->summaryformat = FORMAT_HTML;
97928ddf 2525 $cw->sequence = "";
cb6fec1f 2526 $id = $DB->insert_record("course_sections", $cw);
dc5af91a 2527 return $DB->get_record("course_sections", array("id"=>$id));
97928ddf 2528}
ece966f0 2529/**
2530 * Given a full mod object with section and course already defined, adds this module to that section.
2531 *
2532 * @param object $mod
2533 * @param int $beforemod An existing ID which we will insert the new module before
2534 * @return int The course_sections ID where the mod is inserted
2535 */
7977cffd 2536function add_mod_to_section($mod, $beforemod=NULL) {
cb6fec1f 2537 global $DB;
11b0c469 2538
cb6fec1f 2539 if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
7977cffd 2540
2541 $section->sequence = trim($section->sequence);
2542
2543 if (empty($section->sequence)) {
11b0c469 2544 $newsequence = "$mod->coursemodule";
7977cffd 2545
2546 } else if ($beforemod) {
2547 $modarray = explode(",", $section->sequence);
2548
d857e8b6 2549 if ($key = array_keys($modarray, $beforemod->id)) {
7977cffd 2550 $insertarray = array($mod->id, $beforemod->id);
2551 array_splice($modarray, $key[0], 1, $insertarray);
2552 $newsequence = implode(",", $modarray);
2553
2554 } else { // Just tack it on the end anyway
2555 $newsequence = "$section->sequence,$mod->coursemodule";
2556 }
2557
2558 } else {
2559 $newsequence = "$section->sequence,$mod->coursemodule";
11b0c469 2560 }
89adb174 2561
f685e830
PS
2562 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2563 return $section->id; // Return course_sections ID that was used.
89adb174 2564
11b0c469 2565 } else { // Insert a new record
cb6fec1f 2566 $section->course = $mod->course;
2567 $section->section = $mod->section;
2568 $section->summary = "";
09eb2151 2569 $section->summaryformat = FORMAT_HTML;
e5dfd0f3 2570 $section->sequence = $mod->coursemodule;
cb6fec1f 2571 return $DB->insert_record("course_sections", $section);
11b0c469 2572 }
2573}
2574
48e535bc 2575function set_coursemodule_groupmode($id, $groupmode) {
cb6fec1f 2576 global $DB;
a5d424df 2577 return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
3d575e6f 2578}
2579
177d4abf 2580function set_coursemodule_idnumber($id, $idnumber) {
cb6fec1f 2581 global $DB;
238c0dd9 2582 return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
177d4abf 2583}
4e781c7b 2584
02f66c42 2585/**
2586* $prevstateoverrides = true will set the visibility of the course module
2587* to what is defined in visibleold. This enables us to remember the current
2588* visibility when making a whole section hidden, so that when we toggle
2589* that section back to visible, we are able to return the visibility of
2590* the course module back to what it was originally.
2591*/
2592function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
f5e2602a 2593 global $DB, $CFG;
0f078024
DM
2594 require_once($CFG->libdir.'/gradelib.php');
2595
cb6fec1f 2596 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
978abb42 2597 return false;
2598 }
cb6fec1f 2599 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
978abb42 2600 return false;
2601 }
cb6fec1f 2602 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 2603 foreach($events as $event) {
48e535bc 2604 if ($visible) {
2605 show_event($event);
2606 } else {
2607 hide_event($event);
2608 }
dcd338ff 2609 }
2610 }
f5e2602a 2611
0f078024
DM
2612 // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2613 $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2614 if ($grade_items) {
2615 foreach ($grade_items as $grade_item) {
2616 $grade_item->set_hidden(!$visible);
2617 }
f5e2602a 2618 }
f685e830 2619
02f66c42 2620 if ($prevstateoverrides) {
2621 if ($visible == '0') {
2622 // Remember the current visible state so we can toggle this back.
cb6fec1f 2623 $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
02f66c42 2624 } else {
2625 // Get the previous saved visible states.
cb6fec1f 2626 return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
02f66c42 2627 }
2628 }
cb6fec1f 2629 return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
1acfbce5 2630}
2631
cb6fec1f 2632/**
290130b3 2633 * Delete a course module and any associated data at the course level (events)
264867fd 2634 * Until 1.5 this function simply marked a deleted flag ... now it
290130b3 2635 * deletes it completely.
2636 *
2637 */
48e535bc 2638function delete_course_module($id) {
cb6fec1f 2639 global $CFG, $DB;
f615fbab 2640 require_once($CFG->libdir.'/gradelib.php');
cae83708 2641 require_once($CFG->dirroot.'/blog/lib.php');
f615fbab 2642
cb6fec1f 2643 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
290130b3 2644 return true;
2645 }
cb6fec1f 2646 $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
f615fbab 2647 //delete events from calendar
cb6fec1f 2648 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 2649 foreach($events as $event) {
0ea03696 2650 delete_event($event->id);
dcd338ff 2651 }
2652 }
f615fbab 2653 //delete grade items, outcome items and grades attached to modules
2654 if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2655 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2656 foreach ($grade_items as $grade_item) {
2657 $grade_item->delete('moddelete');
2658 }
f615fbab 2659 }
46e12372
SM
2660 // Delete completion and availability data; it is better to do this even if the
2661 // features are not turned on, in case they were turned on previously (these will be
2662 // very quick on an empty table)
2663 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2664 $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
06b3a6b2 2665
2666 delete_context(CONTEXT_MODULE, $cm->id);
bf66a674 2667 return $DB->delete_records('course_modules', array('id'=>$cm->id));
11b0c469 2668}
2669
2670function delete_mod_from_section($mod, $section) {
cb6fec1f 2671 global $DB;
11b0c469 2672
cb6fec1f 2673 if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
11b0c469 2674
e5dfd0f3 2675 $modarray = explode(",", $section->sequence);
11b0c469 2676
2677 if ($key = array_keys ($modarray, $mod)) {
2678 array_splice($modarray, $key[0], 1);
2679 $newsequence = implode(",", $modarray);
cb6fec1f 2680 return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
11b0c469 2681 } else {
2682 return false;
2683 }
89adb174 2684
11b0c469 2685 }
7977cffd 2686 return false;
11b0c469 2687}
2688
3440ec12 2689/**
2690 * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2691 *
2692 * @param object $course
2693 * @param int $section
2694 * @param int $move (-1 or 1)
2695 */
12905134 2696function move_section($course, $section, $move) {
2697/// Moves a whole course section up and down within the course
cb6fec1f 2698 global $USER, $DB;
12905134 2699
2700 if (!$move) {
2701 return true;
2702 }
2703
2704 $sectiondest = $section + $move;
2705
2706 if ($sectiondest > $course->numsections or $sectiondest < 1) {
2707 return false;
2708 }
2709
cb6fec1f 2710 if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
12905134 2711 return false;
2712 }
2713
cb6fec1f 2714 if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
12905134 2715 return false;
2716 }
2717
f685e830
PS
2718 $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2719 $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2720
798b70a1 2721 // if the focus is on the section that is being moved, then move the focus along
2722 if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2723 course_set_display($course->id, $sectiondest);
2724 }
5390cbb7 2725
a987106d 2726 // Check for duplicates and fix order if needed.
5390cbb7 2727 // There is a very rare case that some sections in the same course have the same section id.
cb6fec1f 2728 $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
a987106d 2729 $n = 0;
2730 foreach ($sections as $section) {
2731 if ($section->section != $n) {
f685e830 2732 $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
5390cbb7 2733 }
a987106d 2734 $n++;
5390cbb7 2735 }
12905134 2736 return true;
2737}
2738
3440ec12 2739/**
2740 * Moves a section within a course, from a position to another.
2741 * Be very careful: $section and $destination refer to section number,
2742 * not id!.
2743 *
2744 * @param object $course
2745 * @param int $section Section number (not id!!!)
2746 * @param int $destination
2747 * @return boolean Result
2748 */
2749function move_section_to($course, $section, $destination) {
2750/// Moves a whole course section up and down within the course
2751 global $USER, $DB;
2752
ca255392 2753 if (!$destination && $destination != 0) {
3440ec12 2754 return true;
2755 }
2756
ca255392 2757 if ($destination > $course->numsections) {
3440ec12 2758 return false;
2759 }
2760
2761 // Get all sections for this course and re-order them (2 of them should now share the same section number)
2762 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2763 'section ASC, id ASC', 'id, section')) {
2764 return false;
2765 }
2766
2767 $sections = reorder_sections($sections, $section, $destination);
2768
2769 // Update all sections
2770 foreach ($sections as $id => $position) {
2771 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2772 }
2773
2774 // if the focus is on the section that is being moved, then move the focus along
2775 if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2776 course_set_display($course->id, $destination);
2777 }
2778 return true;
2779}
2780
2781/**
2782 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2783 * an original position number and a target position number, rebuilds the array so that the
2784 * move is made without any duplication of section positions.
2785 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2786 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2787 *
2788 * @param array $sections
2789 * @param int $origin_position
2790 * @param int $target_position
2791 * @return array
2792 */
2793function reorder_sections($sections, $origin_position, $target_position) {
2794 if (!is_array($sections)) {
2795 return false;
2796 }
2797
2798 // We can't move section position 0
2799 if ($origin_position < 1) {
2800 echo "We can't move section position 0";
2801 return false;
2802 }
2803
2804 // Locate origin section in sections array
2805 if (!$origin_key = array_search($origin_position, $sections)) {
2806 echo "searched position not in sections array";
2807 return false; // searched position not in sections array
2808 }
2809
2810 // Extract origin section
2811 $origin_section = $sections[$origin_key];
2812 unset($sections[$origin_key]);
2813
2814 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2815 $found = false;
2816 $append_array = array();
2817 foreach ($sections as $id => $position) {
2818 if ($found) {
2819 $append_array[$id] = $position;
2820 unset($sections[$id]);
2821 }
2822 if ($position == $target_position) {
2823 $found = true;
2824 }
2825 }
2826
2827 // Append moved section
2828 $sections[$origin_key] = $origin_section;
2829
2830 // Append rest of array (if applicable)
2831 if (!empty($append_array)) {
2832 foreach ($append_array as $id => $position) {
2833 $sections[$id] = $position;
2834 }
2835 }
2836
2837 // Renumber positions
2838 $position = 0;
2839 foreach ($sections as $id => $p) {
2840 $sections[$id] = $position;
2841 $position++;
2842 }
2843
2844 return $sections;
2845
2846}
2847
cb6fec1f 2848/**
2849 * Move the module object $mod to the specified $section
2850 * If $beforemod exists then that is the module
2851 * before which $modid should be inserted
2852 * All parameters are objects
2853 */
7977cffd 2854function moveto_module($mod, $section, $beforemod=NULL) {
e6db3026 2855 global $DB, $OUTPUT;
7977cffd 2856
2857/// Remove original module from original section
7977cffd 2858 if (! delete_mod_from_section($mod->id, $mod->section)) {
e6db3026 2859 echo $OUTPUT->notification("Could not delete module from existing section");
7977cffd 2860 }
2861
2862/// Update module itself if necessary
2863
2864 if ($mod->section != $section->id) {
89adb174 2865 $mod->section = $section->id;
bb4b6010 2866 $DB->update_record("course_modules", $mod);
48e535bc 2867 // if moving to a hidden section then hide module
2868 if (!$section->visible) {
2869 set_coursemodule_visible($mod->id, 0);
2870 }
7977cffd 2871 }
2872
2873/// Add the module into the new section
2874
2875 $mod->course = $section->course;
2876 $mod->section = $section->section; // need relative reference
2877 $mod->coursemodule = $mod->id;
2878
2879 if (! add_mod_to_section($mod, $beforemod)) {
2880 return false;
2881 }
2882
2883 return true;
7977cffd 2884}
2885
24e1eae4 2886function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
6b608f8f 2887 global $CFG, $USER, $DB, $OUTPUT;
94361e02 2888
3d575e6f 2889 static $str;
37a88449 2890 static $sesskey;
3d575e6f 2891
217a8ee9 2892 $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
2893 // no permission to edit
2894 if (!has_capability('moodle/course:manageactivities', $modcontext)) {
e2cd3ed0 2895 return false;
217a8ee9 2896 }
2897
3d575e6f 2898 if (!isset($str)) {
9534a8cb 2899 $str->assign = get_string("assignroles", 'role');
90ebdf65 2900 $str->delete = get_string("delete");
2901 $str->move = get_string("move");
2902 $str->moveup = get_string("moveup");
2903 $str->movedown = get_string("movedown");
2904 $str->moveright = get_string("moveright");
2905 $str->moveleft = get_string("moveleft");
2906 $str->update = get_string("update");
2907 $str->duplicate = get_string("duplicate");
2908 $str->hide = get_string("hide");
2909 $str->show = get_string("show");
3d575e6f 2910 $str->clicktochange = get_string("clicktochange");
32d03b7b 2911 $str->forcedmode = get_string("forcedmode");
3d575e6f 2912 $str->groupsnone = get_string("groupsnone");
2913 $str->groupsseparate = get_string("groupsseparate");
2914 $str->groupsvisible = get_string("groupsvisible");
37a88449 2915 $sesskey = sesskey();
1acfbce5 2916 }
94361e02 2917
24e1eae4 2918 if ($section >= 0) {
75f087b6 2919 $section = '&amp;sr='.$section; // Section return
24e1eae4 2920 } else {
2921 $section = '';
2922 }
2923
94361e02 2924 if ($absolute) {
37a88449 2925 $path = $CFG->wwwroot.'/course';
dc0dc7d5 2926 } else {
37a88449 2927 $path = '.';
dc0dc7d5 2928 }
217a8ee9 2929 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2930 if ($mod->visible) {
2931 $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
2932 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2933 ' src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" '.
217a8ee9 2934 ' alt="'.$str->hide.'" /></a>'."\n";
2935 } else {
2936 $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
2937 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2938 ' src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" '.
217a8ee9 2939 ' alt="'.$str->show.'" /></a>'."\n";
2940 }
530db4cd 2941 } else {
2942 $hideshow = '';
7977cffd 2943 }
530db4cd 2944
3d575e6f 2945 if ($mod->groupmode !== false) {
2946 if ($mod->groupmode == SEPARATEGROUPS) {
32d03b7b 2947 $grouptitle = $str->groupsseparate;
cddbd5d5 2948 $groupclass = 'editing_groupsseparate';
b5d0cafc 2949 $groupimage = $OUTPUT->pix_url('t/groups') . '';
37a88449 2950 $grouplink = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
3d575e6f 2951 } else if ($mod->groupmode == VISIBLEGROUPS) {
32d03b7b 2952 $grouptitle = $str->groupsvisible;
cddbd5d5 2953 $groupclass = 'editing_groupsvisible';
b5d0cafc 2954 $groupimage = $OUTPUT->pix_url('t/groupv') . '';
37a88449 2955 $grouplink = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
32d03b7b 2956 } else {
2957 $grouptitle = $str->groupsnone;
90ebdf65 2958 $groupclass = 'editing_groupsnone';
b5d0cafc 2959 $groupimage = $OUTPUT->pix_url('t/groupn') . '';
37a88449 2960 $grouplink = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
32d03b7b 2961 }
2962 if ($mod->groupmodelink) {
90ebdf65 2963 $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
0d905d9f 2964 '<img src="'.$groupimage.'" class="iconsmall" '.
2965 'alt="'.$grouptitle.'" /></a>';
3d575e6f 2966 } else {
37a88449 2967 $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
0d905d9f 2968 ' src="'.$groupimage.'" class="iconsmall" '.
2969 'alt="'.$grouptitle.'" />';
3d575e6f 2970 }
2971 } else {
2972 $groupmode = "";
2973 }
e2cd3ed0 2974
217a8ee9 2975 if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2976 if ($moveselect) {
2977 $move = '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
2978 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2979 ' src="'.$OUTPUT->pix_url('t/move') . '" class="iconsmall" '.
217a8ee9 2980 ' alt="'.$str->move.'" /></a>'."\n";
2981 } else {
2982 $move = '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
2983 '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2984 ' src="'.$OUTPUT->pix_url('t/up') . '" class="iconsmall" '.
217a8ee9 2985 ' alt="'.$str->moveup.'" /></a>'."\n".
2986 '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
2987 '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2988 ' src="'.$OUTPUT->pix_url('t/down') . '" class="iconsmall" '.
217a8ee9 2989 ' alt="'.$str->movedown.'" /></a>'."\n";
2990 }
7b44777e 2991 } else {
238c0dd9 2992 $move = '';
7977cffd 2993 }
2994
932be046 2995 $leftright = '';
217a8ee9 2996 if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
932be046 2997
78946b9b
PS
2998 if (right_to_left()) { // Exchange arrows on RTL
2999 $rightarrow = 't/left';
3000 $leftarrow = 't/right';
3001 } else {
3002 $rightarrow = 't/right';
3003 $leftarrow = 't/left';
932be046 3004 }
238c0dd9 3005
217a8ee9 3006 if ($indent > 0) {
3007 $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
3008 '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3009 ' src="'.$OUTPUT->pix_url($leftarrow).'" class="iconsmall" '.
217a8ee9 3010 ' alt="'.$str->moveleft.'" /></a>'."\n";
3011 }
3012 if ($indent >= 0) {
3013 $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
3014 '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3015 ' src="'.$OUTPUT->pix_url($rightarrow).'" class="iconsmall" '.
217a8ee9 3016 ' alt="'.$str->moveright.'" /></a>'."\n";
3017 }
37a88449 3018 }
9534a8cb 3019 if (has_capability('moodle/course:managegroups', $modcontext)){
3020 $context = get_context_instance(CONTEXT_MODULE, $mod->id);
d1aa1e48 3021 $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
b5d0cafc 3022 $context->id.'"><img src="'.$OUTPUT->pix_url('i/roles') . '" alt="'.$str->assign.'" class="iconsmall"/></a>';
8634e001 3023 } else {
3024 $assign = '';
9534a8cb 3025 }
8634e001 3026
90ebdf65 3027 return '<span class="commands">'."\n".$leftright.$move.
3028 '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
37a88449 3029 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3030 ' src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" '.
90ebdf65 3031 ' alt="'.$str->update.'" /></a>'."\n".
3032 '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
37a88449 3033 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3034 ' src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" '.
9534a8cb 3035 ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
90845098 3036}
3037
b61efafb 3038/**
264867fd 3039 * given a course object with shortname & fullname, this function will
b61efafb 3040 * truncate the the number of chars allowed and add ... if it was too long
3041 */
3042function course_format_name ($course,$max=100) {
264867fd 3043
6ba65fa0 3044 $str = $course->shortname.': '. $course->fullname;
b61efafb 3045 if (strlen($str) <= $max) {
3046 return $str;
3047 }
3048 else {
3049 return substr($str,0,$max-3).'...';
3050 }
3051}
3052
cb6fec1f 3053function update_restricted_mods($course, $mods) {
3054 global $DB;
ddb0a19f 3055
3056/// Delete all the current restricted list
cb6fec1f 3057 $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
ddb0a19f 3058
0705ff84 3059 if (empty($course->restrictmodules)) {
ddb0a19f 3060 return; // We're done
0705ff84 3061 }
ddb0a19f 3062
3063/// Insert the new list of restricted mods
3064 foreach ($mods as $mod) {
3065 if ($mod == 0) {
3066 continue; // this is the 'allow none' option
0705ff84 3067 }
fbaea88f 3068 $am = new stdClass();
ddb0a19f 3069 $am->course = $course->id;
3070 $am->module = $mod;
cb6fec1f 3071 $DB->insert_record('course_allowed_modules',$am);
0705ff84 3072 }
3073}
3074
3075/**
3076 * This function will take an int (module id) or a string (module name)
3077 * and return true or false, whether it's allowed in the given course (object)
264867fd 3078 * $mod is not allowed to be an object, as the field for the module id is inconsistent
0705ff84 3079 * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3080 */
3081
3082function course_allowed_module($course,$mod) {
cb6fec1f 3083 global $DB;
238c0dd9 3084
0705ff84 3085 if (empty($course->restrictmodules)) {
3086 return true;
3087 }
264867fd 3088
ddb0a19f 3089 // Admins and admin-like people who can edit everything can also add anything.
7e85563d 3090 // Originally there was a course:update test only, but it did not match the test in course edit form
df997f84 3091 if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
0705ff84 3092 return true;
3093 }
ddb0a19f 3094
0705ff84 3095 if (is_numeric($mod)) {
3096 $modid = $mod;
3097 } else if (is_string($mod)) {
cb6fec1f 3098 $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
0705ff84 3099 }
3100 if (empty($modid)) {
3101 return false;
3102 }
238c0dd9 3103
cb6fec1f 3104 return $DB->record_exists('course_allowed_modules', array('course'=>$course->id, 'module'=>$modid));
0705ff84 3105}
3106
e2b347e9 3107/**
3108 * Recursively delete category including all subcategories and courses.
e92c39ca 3109 * @param stdClass $category
a3a1708f 3110 * @param boolean $showfeedback display some notices
3111 * @return array return deleted courses
e2b347e9 3112 */
3113function category_delete_full($category, $showfeedback=true) {
cb6fec1f 3114 global $CFG, $DB;
e2b347e9