MDL-13379 mnet: course overview at my home page displays remote courses, too
[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
45e87759 846function print_overview($courses, array $remote_courses=array()) {
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) {
45e87759
DM
862 echo $OUTPUT->box_start('coursebox');
863 $attributes = array('title' => s($course->fullname));
185cfb09 864 if (empty($course->visible)) {
45e87759 865 $attributes['class'] = 'dimmed';
185cfb09 866 }
45e87759
DM
867 echo $OUTPUT->heading(html_writer::link(
868 new moodle_url('/course/view.php', array('id' => $course->id)), format_string($course->fullname), $attributes), 3);
185cfb09 869 if (array_key_exists($course->id,$htmlarray)) {
870 foreach ($htmlarray[$course->id] as $modname => $html) {
871 echo $html;
872 }
873 }
e6db3026 874 echo $OUTPUT->box_end();
185cfb09 875 }
45e87759
DM
876
877 if (!empty($remote_courses)) {
878 echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
879 }
880 foreach ($remote_courses as $course) {
881 echo $OUTPUT->box_start('coursebox');
882 $attributes = array('title' => s($course->fullname));
883 echo $OUTPUT->heading(html_writer::link(
884 new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
885 format_string($course->shortname),
886 $attributes) . ' (' . format_string($course->hostname) . ')', 3);
887 echo $OUTPUT->box_end();
888 }
0d6b9d4f 889}
890
891
cb6fec1f 892/**
893 * This function trawls through the logs looking for
894 * anything new since the user's last login
895 */
600149be 896function print_recent_activity($course) {
897 // $course is an object
008350b5 898 global $CFG, $USER, $SESSION, $DB, $OUTPUT;
600149be 899
e2a3a0e7 900 $context = get_context_instance(CONTEXT_COURSE, $course->id);
2ac64806 901
dd97c328 902 $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
903
904 $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
0f87cb1d 905
4f0c2d00 906 if (!isguestuser()) {
e2a3a0e7 907 if (!empty($USER->lastcourseaccess[$course->id])) {
908 if ($USER->lastcourseaccess[$course->id] > $timestart) {
909 $timestart = $USER->lastcourseaccess[$course->id];
910 }
9e51847a 911 }
3d891989 912 }
0f87cb1d 913
de785682 914 echo '<div class="activitydate">';
27bf9e20 915 echo get_string('activitysince', '', userdate($timestart));
de785682 916 echo '</div>';
917 echo '<div class="activityhead">';
0f87cb1d 918
de785682 919 echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
0f87cb1d 920
5fc835a5 921 echo "</div>\n";
0f87cb1d 922
600149be 923 $content = false;
1b5910c4 924
dd97c328 925/// Firstly, have there been any new enrolments?
926
6c38b7e0 927 $users = get_recent_enrolments($course->id, $timestart);
1b5910c4 928
5fc835a5 929 //Accessibility: new users now appear in an <OL> list.
6c38b7e0 930 if ($users) {
27bf9e20 931 echo '<div class="newusers">';
008350b5 932 echo $OUTPUT->heading(get_string("newusers").':', 3);
dd97c328 933 $content = true;
5fc835a5 934 echo "<ol class=\"list\">\n";
6c38b7e0 935 foreach ($users as $user) {
dd97c328 936 $fullname = fullname($user, $viewfullnames);
937 echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
600149be 938 }
5fc835a5 939 echo "</ol>\n</div>\n";
600149be 940 }
941
dd97c328 942/// Next, have there been any modifications to the course structure?
943
944 $modinfo =& get_fast_modinfo($course);
945
946 $changelist = array();
1b5910c4 947
cb6fec1f 948 $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
949 module = 'course' AND
950 (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
951 array($timestart, $course->id), "id ASC");
1b5910c4 952
953 if ($logs) {
dd97c328 954 $actions = array('add mod', 'update mod', 'delete mod');
955 $newgones = array(); // added and later deleted items
1b5910c4 956 foreach ($logs as $key => $log) {
dd97c328 957 if (!in_array($log->action, $actions)) {
958 continue;
959 }
c71f3265 960 $info = explode(' ', $log->info);
c9f6251e 961
dd97c328 962 if ($info[0] == 'label') { // Labels are ignored in recent activity
c9f6251e 963 continue;
964 }
965
dd97c328 966 if (count($info) != 2) {
967 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
968 continue;
969 }
970
971 $modname = $info[0];
972 $instanceid = $info[1];
973
974 if ($log->action == 'delete mod') {
975 // unfortunately we do not know if the mod was visible
976 if (!array_key_exists($log->info, $newgones)) {
977 $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
978 $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
979 }
980 } else {
981 if (!isset($modinfo->instances[$modname][$instanceid])) {
982 if ($log->action == 'add mod') {
983 // do not display added and later deleted activities
984 $newgones[$log->info] = true;
985 }
986 continue;
987 }
988 $cm = $modinfo->instances[$modname][$instanceid];
989 if (!$cm->uservisible) {
ff96219d 990 continue;
dd97c328 991 }
992
993 if ($log->action == 'add mod') {
994 $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
995 $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
996
997 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
998 $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
999 $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
600149be 1000 }
ef25340c 1001 }
1002 }
1003 }
1004
9c9f7d77 1005 if (!empty($changelist)) {
008350b5 1006 echo $OUTPUT->heading(get_string("courseupdates").':', 3);
dd97c328 1007 $content = true;
ef25340c 1008 foreach ($changelist as $changeinfo => $change) {
dd97c328 1009 echo '<p class="activity">'.$change['text'].'</p>';
600149be 1010 }
89adb174 1011 }
bf40f9c1 1012
dd97c328 1013/// Now display new things from each module
0fd7da81 1014
dd97c328 1015 $usedmodules = array();
1016 foreach($modinfo->cms as $cm) {
1017 if (isset($usedmodules[$cm->modname])) {
1018 continue;
1019 }
1020 if (!$cm->uservisible) {
1021 continue;
1022 }
1023 $usedmodules[$cm->modname] = $cm->modname;
1024 }
e2a3a0e7 1025
dd97c328 1026 foreach ($usedmodules as $modname) { // Each module gets it's own logs and prints them
1027 if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
1028 include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
1029 $print_recent_activity = $modname.'_print_recent_activity';
296c6ac2 1030 if (function_exists($print_recent_activity)) {
dd97c328 1031 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
1032 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
600149be 1033 }
296c6ac2 1034 } else {
238c0dd9 1035 debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
600149be 1036 }
1037 }
1038
1039 if (! $content) {
27bf9e20 1040 echo '<p class="message">'.get_string('nothingnew').'</p>';
600149be 1041 }
600149be 1042}
1043
cb6fec1f 1044/**
1045 * For a given course, returns an array of course activity objects
1046 * Each item in the array contains he following properties:
1047 */
d897cae4 1048function get_array_of_activities($courseid) {
d897cae4 1049// cm - course module id
1050// mod - name of the module (eg forum)
1051// section - the number of the section (eg week or topic)
1052// name - the name of the instance
5867bfb5 1053// visible - is the instance visible or not
13534ef7
ML
1054// groupingid - grouping id
1055// groupmembersonly - is this instance visible to group members only
86aa7ccf 1056// extra - contains extra string to include in any link
cb6fec1f 1057 global $CFG, $DB;
82bd6a5e 1058 if(!empty($CFG->enableavailability)) {
1059 require_once($CFG->libdir.'/conditionlib.php');
1060 }
8dddba42 1061
a0c30e1b 1062 $course = $DB->get_record('course', array('id'=>$courseid));
1063
1064 if (empty($course)) {
1065 throw new moodle_exception('courseidnotfound');
1066 }
1067
d897cae4 1068 $mod = array();
1069
a0c30e1b 1070 $rawmods = get_course_mods($courseid);
1071 if (empty($rawmods)) {
dd97c328 1072 return $mod; // always return array
d897cae4 1073 }
1074
cb6fec1f 1075 if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
d897cae4 1076 foreach ($sections as $section) {
74666583 1077 if (!empty($section->sequence)) {
d897cae4 1078 $sequence = explode(",", $section->sequence);
1079 foreach ($sequence as $seq) {
7af6281f 1080 if (empty($rawmods[$seq])) {
1081 continue;
1082 }
dd97c328 1083 $mod[$seq]->id = $rawmods[$seq]->instance;
1084 $mod[$seq]->cm = $rawmods[$seq]->id;
1085 $mod[$seq]->mod = $rawmods[$seq]->modname;
1086 $mod[$seq]->section = $section->section;
66b250fd 1087 $mod[$seq]->idnumber = $rawmods[$seq]->idnumber;
dd97c328 1088 $mod[$seq]->visible = $rawmods[$seq]->visible;
1089 $mod[$seq]->groupmode = $rawmods[$seq]->groupmode;
1090 $mod[$seq]->groupingid = $rawmods[$seq]->groupingid;
13534ef7 1091 $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
82bd6a5e 1092 $mod[$seq]->indent = $rawmods[$seq]->indent;
1093 $mod[$seq]->completion = $rawmods[$seq]->completion;
dd97c328 1094 $mod[$seq]->extra = "";
82bd6a5e 1095 if(!empty($CFG->enableavailability)) {
1096 condition_info::fill_availability_conditions($rawmods[$seq]);
1097 $mod[$seq]->availablefrom = $rawmods[$seq]->availablefrom;
1098 $mod[$seq]->availableuntil = $rawmods[$seq]->availableuntil;
1099 $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
1100 $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
1101 $mod[$seq]->conditionsgrade = $rawmods[$seq]->conditionsgrade;
1102 }
8dddba42 1103
1104 $modname = $mod[$seq]->mod;
1105 $functionname = $modname."_get_coursemodule_info";
1106
3a37b3f8 1107 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1108 continue;
1109 }
1110
8dddba42 1111 include_once("$CFG->dirroot/mod/$modname/lib.php");
1112
1113 if (function_exists($functionname)) {
9d361034 1114 if ($info = $functionname($rawmods[$seq])) {
1115 if (!empty($info->extra)) {
1116 $mod[$seq]->extra = $info->extra;
1117 }
1118 if (!empty($info->icon)) {
1119 $mod[$seq]->icon = $info->icon;
1120 }
9a9012dc
PS
1121 if (!empty($info->iconcomponent)) {
1122 $mod[$seq]->iconcomponent = $info->iconcomponent;
1123 }
1ea543df 1124 if (!empty($info->name)) {
9a9012dc 1125 $mod[$seq]->name = $info->name;
1ea543df 1126 }
c9f6251e 1127 }
1128 }
1ea543df 1129 if (!isset($mod[$seq]->name)) {
9a9012dc 1130 $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1ea543df 1131 }
d897cae4 1132 }
1133 }
1134 }
1135 }
1136 return $mod;
1137}
1138
1139
cb6fec1f 1140/**
1141 * Returns a number of useful structures for course displays
1142 */
90845098 1143function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
0edb4aad 1144 global $CFG, $DB, $COURSE;
7468bf01 1145
dd97c328 1146 $mods = array(); // course modules indexed by id
1147 $modnames = array(); // all course module names (except resource!)
1148 $modnamesplural= array(); // all course module names (plural form)
1149 $modnamesused = array(); // course module names used
7468bf01 1150
cb6fec1f 1151 if ($allmods = $DB->get_records("modules")) {
90845098 1152 foreach ($allmods as $mod) {
0edb4aad
PS
1153 if (!file_exists("$CFG->dirroot/mod/$mod->name/lib.php")) {
1154 continue;
1155 }
5867bfb5 1156 if ($mod->visible) {
1157 $modnames[$mod->name] = get_string("modulename", "$mod->name");
1158 $modnamesplural[$mod->name] = get_string("modulenameplural", "$mod->name");
1159 }
90845098 1160 }
c6947ba7 1161 textlib_get_instance()->asort($modnames);
90845098 1162 } else {
ba6018a9 1163 print_error("nomodules", 'debug');
90845098 1164 }
1165
82bd6a5e 1166 $course = ($courseid==$COURSE->id) ? $COURSE : $DB->get_record('course',array('id'=>$courseid));
1167 $modinfo = get_fast_modinfo($course);
1168
1169 if ($rawmods=$modinfo->cms) {
7468bf01 1170 foreach($rawmods as $mod) { // Index the mods
959ae824 1171 if (empty($modnames[$mod->modname])) {
1172 continue;
1173 }
dd97c328 1174 $mods[$mod->id] = $mod;
1175 $mods[$mod->id]->modfullname = $modnames[$mod->modname];
1176 if (!$mod->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $courseid))) {
1177 continue;
1178 }
13534ef7
ML
1179 // Check groupings
1180 if (!groups_course_module_visible($mod)) {
1181 continue;
1182 }
dd97c328 1183 $modnamesused[$mod->modname] = $modnames[$mod->modname];
7468bf01 1184 }
c7da6f7a 1185 if ($modnamesused) {
c6947ba7 1186 textlib_get_instance()->asort($modnamesused);
c7da6f7a 1187 }
7468bf01 1188 }
7468bf01 1189}
1190
7487c856
SH
1191/**
1192 * Returns an array of sections for the requested course id
1193 *
1194 * This function stores the sections against the course id within a staticvar encase
1195 * of subsequent requests. This is used all over + in some standard libs and course
1196 * format callbacks so subsequent requests are a reality.
1197 *
1198 * @staticvar array $coursesections
1199 * @param int $courseid
1200 * @return array Array of sections
1201 */
7468bf01 1202function get_all_sections($courseid) {
cb6fec1f 1203 global $DB;
7487c856
SH
1204 static $coursesections = array();
1205 if (!array_key_exists($courseid, $coursesections)) {
1206 $coursesections[$courseid] = $DB->get_records("course_sections", array("course"=>"$courseid"), "section",
1207 "section, id, course, name, summary, summaryformat, sequence, visible");
1208 }
1209 return $coursesections[$courseid];
7468bf01 1210}
1211
b86fc0e2 1212function course_set_display($courseid, $display=0) {
cb6fec1f 1213 global $USER, $DB;
b86fc0e2 1214
b86fc0e2 1215 if ($display == "all" or empty($display)) {
1216 $display = 0;
1217 }
1218
4f0c2d00 1219 if (!isloggedin() or isguestuser()) {
7b678e0a 1220 //do not store settings in db for guests
238c0dd9 1221 } else if ($DB->record_exists("course_display", array("userid" => $USER->id, "course"=>$courseid))) {
cb6fec1f 1222 $DB->set_field("course_display", "display", $display, array("userid"=>$USER->id, "course"=>$courseid));
b86fc0e2 1223 } else {
fbaea88f 1224 $record = new stdClass();
b86fc0e2 1225 $record->userid = $USER->id;
1226 $record->course = $courseid;
1227 $record->display = $display;
fc29e51b 1228 $DB->insert_record("course_display", $record);
b86fc0e2 1229 }
1230
1231 return $USER->display[$courseid] = $display; // Note: = not ==
1232}
1233
cb6fec1f 1234/**
7e85563d 1235 * For a given course section, marks it visible or hidden,
cb6fec1f 1236 * and does the same for every activity in that section
1237 */
7d99d695 1238function set_section_visible($courseid, $sectionnumber, $visibility) {
cb6fec1f 1239 global $DB;
7d99d695 1240
cb6fec1f 1241 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1242 $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
7d99d695 1243 if (!empty($section->sequence)) {
1244 $modules = explode(",", $section->sequence);
1245 foreach ($modules as $moduleid) {
02f66c42 1246 set_coursemodule_visible($moduleid, $visibility, true);
7d99d695 1247 }
1248 }
5867bfb5 1249 rebuild_course_cache($courseid);
7d99d695 1250 }
1251}
ba2e5d73 1252
cb6fec1f 1253/**
1254 * Prints a section full of activity modules
1255 */
4e781c7b 1256function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false) {
e63f88c9 1257 global $CFG, $USER, $DB, $PAGE, $OUTPUT;
7977cffd 1258
dd97c328 1259 static $initialised;
1260
3d575e6f 1261 static $groupbuttons;
32d03b7b 1262 static $groupbuttonslink;
52dcc2f9 1263 static $isediting;
7977cffd 1264 static $ismoving;
1265 static $strmovehere;
1266 static $strmovefull;
54669989 1267 static $strunreadpostsone;
a2d71d8e 1268 static $usetracking;
dd97c328 1269 static $groupings;
110a32e2 1270
dd97c328 1271 if (!isset($initialised)) {
9fd9c29b 1272 $groupbuttons = ($course->groupmode or (!$course->groupmodeforce));
32d03b7b 1273 $groupbuttonslink = (!$course->groupmodeforce);
830dd6e9 1274 $isediting = $PAGE->user_is_editing();
dd97c328 1275 $ismoving = $isediting && ismoving($course->id);
3d575e6f 1276 if ($ismoving) {
dd97c328 1277 $strmovehere = get_string("movehere");
1278 $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
3d575e6f 1279 }
94a6a70f 1280 include_once($CFG->dirroot.'/mod/forum/lib.php');
1281 if ($usetracking = forum_tp_can_track_forums()) {
dd97c328 1282 $strunreadpostsone = get_string('unreadpostsone', 'forum');
a2d71d8e 1283 }
dd97c328 1284 $initialised = true;
7977cffd 1285 }
dd97c328 1286
fbaea88f 1287 $labelformatoptions = new stdClass();
60bd11cf 1288 $labelformatoptions->noclean = true;
367a75fa 1289 $labelformatoptions->overflowdiv = true;
94361e02 1290
fea43a7f 1291/// Casting $course->modinfo to string prevents one notice when the field is null
dd97c328 1292 $modinfo = get_fast_modinfo($course);
984baa77 1293 $completioninfo = new completion_info($course);
94361e02 1294
7e85563d 1295 //Accessibility: replace table with list <ul>, but don't output empty list.
74666583 1296 if (!empty($section->sequence)) {
94361e02 1297
f2d660dc 1298 // Fix bug #5027, don't want style=\"width:$width\".
6285f8a8 1299 echo "<ul class=\"section img-text\">\n";
94361e02 1300 $sectionmods = explode(",", $section->sequence);
1301
1302 foreach ($sectionmods as $modnumber) {
9ae687af 1303 if (empty($mods[$modnumber])) {
1304 continue;
1305 }
dd97c328 1306
94361e02 1307 $mod = $mods[$modnumber];
c9f6251e 1308
dd97c328 1309 if ($ismoving and $mod->id == $USER->activitycopy) {
1310 // do not display moving mod
1311 continue;
1312 }
c9f6251e 1313
dd97c328 1314 if (isset($modinfo->cms[$modnumber])) {
85f55ba2 1315 // We can continue (because it will not be displayed at all)
1316 // if:
1317 // 1) The activity is not visible to users
1318 // and
1319 // 2a) The 'showavailability' option is not set (if that is set,
2f48819b 1320 // we need to display the activity so we can show
85f55ba2 1321 // availability info)
1322 // or
2f48819b 1323 // 2b) The 'availableinfo' is empty, i.e. the activity was
1324 // hidden in a way that leaves no info, such as using the
85f55ba2 1325 // eye icon.
82bd6a5e 1326 if (!$modinfo->cms[$modnumber]->uservisible &&
85f55ba2 1327 (empty($modinfo->cms[$modnumber]->showavailability) ||
1328 empty($modinfo->cms[$modnumber]->availableinfo))) {
dd97c328 1329 // visibility shortcut
1330 continue;
86aa7ccf 1331 }
dd97c328 1332 } else {
0f56c9da 1333 if (!file_exists("$CFG->dirroot/mod/$mod->modname/lib.php")) {
1334 // module not installed
1335 continue;
1336 }
82bd6a5e 1337 if (!coursemodule_visible_for_user($mod) &&
1338 empty($mod->showavailability)) {
dd97c328 1339 // full visibility check
1340 continue;
9d361034 1341 }
dd97c328 1342 }
1343
2f48819b 1344 // In some cases the activity is visible to user, but it is
e8e50986 1345 // dimmed. This is done if viewhiddenactivities is true and if:
1346 // 1. the activity is not visible, or
1347 // 2. the activity has dates set which do not include current, or
1348 // 3. the activity has any other conditions set (regardless of whether
1349 // current user meets them)
1350 $canviewhidden = has_capability(
1351 'moodle/course:viewhiddenactivities',
1352 get_context_instance(CONTEXT_MODULE, $mod->id));
1353 $accessiblebutdim = false;
1354 if ($canviewhidden) {
1355 $accessiblebutdim = !$mod->visible;
1356 if (!empty($CFG->enableavailability)) {
1357 $accessiblebutdim = $accessiblebutdim ||
1358 $mod->availablefrom > time() ||
1359 ($mod->availableuntil && $mod->availableuntil < time()) ||
2f48819b 1360 count($mod->conditionsgrade) > 0 ||
e8e50986 1361 count($mod->conditionscompletion) > 0;
1362 }
1363 }
1364
b31b2d84 1365 echo '<li class="activity '.$mod->modname.' modtype_'.$mod->modname.'" id="module-'.$modnumber.'">'; // Unique ID
dd97c328 1366 if ($ismoving) {
1367 echo '<a title="'.$strmovefull.'"'.
d4a1fcaf 1368 ' href="'.$CFG->wwwroot.'/course/mod.php?moveto='.$mod->id.'&amp;sesskey='.sesskey().'">'.
b5d0cafc 1369 '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
dd97c328 1370 ' alt="'.$strmovehere.'" /></a><br />
1371 ';
1372 }
9d361034 1373
dd97c328 1374 if ($mod->indent) {
1ba862ec 1375 echo $OUTPUT->spacer(array('height'=>12, 'width'=>(20 * $mod->indent))); // should be done with CSS instead
dd97c328 1376 }
1377
554606c7 1378 $extra = '';
1379 if (!empty($modinfo->cms[$modnumber]->extra)) {
82bd6a5e 1380 $extra = $modinfo->cms[$modnumber]->extra;
554606c7 1381 }
dd97c328 1382
1383 if ($mod->modname == "label") {
e8e50986 1384 if ($accessiblebutdim || !$mod->uservisible) {
85f55ba2 1385 echo '<div class="dimmed_text"><span class="accesshide">'.
4a087123 1386 get_string('hiddenfromstudents').'</span>';
722b4ce1
SH
1387 } else {
1388 echo '<div>';
dd97c328 1389 }
1390 echo format_text($extra, FORMAT_HTML, $labelformatoptions);
722b4ce1 1391 echo "</div>";
98da6021 1392 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
c4d989a1 1393 if (!isset($groupings)) {
1394 $groupings = groups_get_all_groupings($course->id);
1395 }
1470825e 1396 echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
c4d989a1 1397 }
aac94fd0 1398
dd97c328 1399 } else { // Normal activity
1400 $instancename = format_string($modinfo->cms[$modnumber]->name, true, $course->id);
c9f6251e 1401
c93dae38 1402 $customicon = $modinfo->cms[$modnumber]->icon;
1403 if (!empty($customicon)) {
1404 if (substr($customicon, 0, 4) === 'mod/') {
5ef44400 1405 list($modname, $iconname) = explode('/', substr($customicon, 4), 2);
472c1022 1406 $icon = $OUTPUT->pix_url($iconname, $modname);
c93dae38 1407 } else {
ede72522 1408 $icon = $OUTPUT->pix_url($customicon);
c93dae38 1409 }
dd97c328 1410 } else {
b5d0cafc 1411 $icon = $OUTPUT->pix_url('icon', $mod->modname);
dd97c328 1412 }
e0b033d5 1413
aa54ed7b 1414 //Accessibility: for files get description via icon, this is very ugly hack!
dd97c328 1415 $altname = '';
aa54ed7b 1416 $altname = $mod->modfullname;
1417 if (!empty($customicon)) {
1418 $archetype = plugin_supports('mod', $mod->modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1419 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
ede72522 1420 $mimetype = mimeinfo_from_icon('type', $customicon);
dd97c328 1421 $altname = get_mimetype_description($mimetype);
6285f8a8 1422 }
dd97c328 1423 }
1424 // Avoid unnecessary duplication.
aa54ed7b 1425 if (false !== stripos($instancename, $altname)) {
dd97c328 1426 $altname = '';
1427 }
1428 // File type after name, for alphabetic lists (screen reader).
1429 if ($altname) {
1430 $altname = get_accesshide(' '.$altname);
1431 }
6285f8a8 1432
82bd6a5e 1433 // We may be displaying this just in order to show information
2afcfc44 1434 // about visibility, without the actual link
52dbbcf6 1435 if ($mod->uservisible) {
82bd6a5e 1436 // Display normal module link
e8e50986 1437 if (!$accessiblebutdim) {
52dbbcf6 1438 $linkcss = '';
1439 $accesstext ='';
85f55ba2 1440 } else {
1441 $linkcss = ' class="dimmed" ';
52dbbcf6 1442 $accesstext = '<span class="accesshide">'.
85f55ba2 1443 get_string('hiddenfromstudents').': </span>';
1444 }
52dbbcf6 1445
85f55ba2 1446 echo '<a '.$linkcss.' '.$extra.
2f48819b 1447 ' href="'.$CFG->wwwroot.'/mod/'.$mod->modname.'/view.php?id='.$mod->id.'">'.
3aa11c75 1448 '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename',$mod->modname).'" /> '.
b31b2d84 1449 $accesstext.'<span class="instancename">'.$instancename.$altname.'</span></a>';
82bd6a5e 1450
98da6021 1451 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', get_context_instance(CONTEXT_COURSE, $course->id))) {
82bd6a5e 1452 if (!isset($groupings)) {
1453 $groupings = groups_get_all_groupings($course->id);
1454 }
1455 echo " <span class=\"groupinglabel\">(".format_string($groupings[$mod->groupingid]->name).')</span>';
acf000b0 1456 }
82bd6a5e 1457 } else {
1458 // Display greyed-out text of link
85f55ba2 1459 echo '<span class="dimmed_text" '.$extra.' ><span class="accesshide">'.
1460 get_string('notavailableyet','condition').': </span>'.
3aa11c75 1461 '<img src="'.$icon.'" class="activityicon" alt="'.get_string('modulename', $mod->modname).'" /> <span>'.
85f55ba2 1462 $instancename.$altname.'</span></span>';
c9f6251e 1463 }
dd97c328 1464 }
1465 if ($usetracking && $mod->modname == 'forum') {
90f4745c 1466 if ($unread = forum_tp_count_forum_unread_posts($mod, $course)) {
1467 echo '<span class="unread"> <a href="'.$CFG->wwwroot.'/mod/forum/view.php?id='.$mod->id.'">';
1468 if ($unread == 1) {
1469 echo $strunreadpostsone;
1470 } else {
1471 print_string('unreadpostsnumber', 'forum', $unread);
54669989 1472 }
90f4745c 1473 echo '</a></span>';
f37da850 1474 }
dd97c328 1475 }
f37da850 1476
dd97c328 1477 if ($isediting) {
525e16ce 1478 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
dd97c328 1479 if (! $mod->groupmodelink = $groupbuttonslink) {
1480 $mod->groupmode = $course->groupmode;
3d575e6f 1481 }
dd97c328 1482
1483 } else {
1484 $mod->groupmode = false;
c9f6251e 1485 }
dd97c328 1486 echo '&nbsp;&nbsp;';
1487 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $section->section);
94361e02 1488 }
4e781c7b 1489
1490 // Completion
3982f0f8 1491 $completion = $hidecompletion
4e781c7b 1492 ? COMPLETION_TRACKING_NONE
1493 : $completioninfo->is_enabled($mod);
2f48819b 1494 if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
82bd6a5e 1495 !isguestuser() && $mod->uservisible) {
3982f0f8 1496 $completiondata = $completioninfo->get_data($mod,true);
1497 $completionicon = '';
1498 if ($isediting) {
1499 switch ($completion) {
ca255392 1500 case COMPLETION_TRACKING_MANUAL :
3982f0f8 1501 $completionicon = 'manual-enabled'; break;
ca255392 1502 case COMPLETION_TRACKING_AUTOMATIC :
3982f0f8 1503 $completionicon = 'auto-enabled'; break;
4e781c7b 1504 default: // wtf
1505 }
3982f0f8 1506 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
4e781c7b 1507 switch($completiondata->completionstate) {
1508 case COMPLETION_INCOMPLETE:
3982f0f8 1509 $completionicon = 'manual-n'; break;
4e781c7b 1510 case COMPLETION_COMPLETE:
3982f0f8 1511 $completionicon = 'manual-y'; break;
4e781c7b 1512 }
1513 } else { // Automatic
1514 switch($completiondata->completionstate) {
1515 case COMPLETION_INCOMPLETE:
3982f0f8 1516 $completionicon = 'auto-n'; break;
4e781c7b 1517 case COMPLETION_COMPLETE:
3982f0f8 1518 $completionicon = 'auto-y'; break;
4e781c7b 1519 case COMPLETION_COMPLETE_PASS:
3982f0f8 1520 $completionicon = 'auto-pass'; break;
4e781c7b 1521 case COMPLETION_COMPLETE_FAIL:
3982f0f8 1522 $completionicon = 'auto-fail'; break;
4e781c7b 1523 }
1524 }
3982f0f8 1525 if ($completionicon) {
b5d0cafc 1526 $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
76c0123b
PS
1527 $imgalt = s(get_string('completion-alt-'.$completionicon, 'completion'));
1528 if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
1529 $imgtitle = s(get_string('completion-title-'.$completionicon, 'completion'));
3982f0f8 1530 $newstate =
4e781c7b 1531 $completiondata->completionstate==COMPLETION_COMPLETE
ca255392 1532 ? COMPLETION_INCOMPLETE
1533 : COMPLETION_COMPLETE;
a343b13f 1534 // In manual mode the icon is a toggle form...
1535
1536 // If this completion state is used by the
1537 // conditional activities system, we need to turn
1538 // off the JS.
2f48819b 1539 if (!empty($CFG->enableavailability) &&
76c0123b 1540 condition_info::completion_value_used_as_condition($course, $mod)) {
a343b13f 1541 $extraclass = ' preventjs';
1542 } else {
1543 $extraclass = '';
1544 }
4e781c7b 1545 echo "
76c0123b 1546<form class='togglecompletion$extraclass' method='post' action='togglecompletion.php'><div>
4e781c7b 1547<input type='hidden' name='id' value='{$mod->id}' />
8c194133 1548<input type='hidden' name='sesskey' value='".sesskey()."' />
4e781c7b 1549<input type='hidden' name='completionstate' value='$newstate' />
1550<input type='image' src='$imgsrc' alt='$imgalt' title='$imgtitle' />
1551</div></form>";
1552 } else {
1553 // In auto mode, or when editing, the icon is just an image
f17a0360 1554 echo "<span class='autocompletion'>";
f17a0360 1555 echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
4e781c7b 1556 }
1557 }
1558 }
1559
2f48819b 1560 // Show availability information (for someone who isn't allowed to
82bd6a5e 1561 // see the activity itself, or for staff)
3982f0f8 1562 if (!$mod->uservisible) {
82bd6a5e 1563 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
e8e50986 1564 } else if ($canviewhidden && !empty($CFG->enableavailability)) {
82bd6a5e 1565 $ci = new condition_info($mod);
3982f0f8 1566 $fullinfo = $ci->get_full_information();
82bd6a5e 1567 if($fullinfo) {
2f48819b 1568 echo '<div class="availabilityinfo">'.get_string($mod->showavailability
82bd6a5e 1569 ? 'userrestriction_visible'
1570 : 'userrestriction_hidden','condition',
1571 $fullinfo).'</div>';
1572 }
1573 }
1574
dd97c328 1575 echo "</li>\n";
94361e02 1576 }
dd97c328 1577
f2d660dc 1578 } elseif ($ismoving) {
1579 echo "<ul class=\"section\">\n";
264867fd 1580 }
dd97c328 1581
7977cffd 1582 if ($ismoving) {
64fdc686 1583 echo '<li><a title="'.$strmovefull.'"'.
d4a1fcaf 1584 ' href="'.$CFG->wwwroot.'/course/mod.php?movetosection='.$section->id.'&amp;sesskey='.sesskey().'">'.
b5d0cafc 1585 '<img class="movetarget" src="'.$OUTPUT->pix_url('movehere') . '" '.
c6a55371 1586 ' alt="'.$strmovehere.'" /></a></li>
1c919752 1587 ';
7977cffd 1588 }
c6a55371 1589 if (!empty($section->sequence) || $ismoving) {
1590 echo "</ul><!--class='section'-->\n\n";
1591 }
a7ad3ea6 1592}
1593
89bfeee0 1594/**
1595 * Prints the menus to add activities and resources.
1596 */
cb57e6f4 1597function print_section_add_menus($course, $section, $modnames, $vertical=false, $return=false) {
64e12bb7 1598 global $CFG, $OUTPUT;
e0161bff 1599
217a8ee9 1600 // check to see if user can add menus
1601 if (!has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $course->id))) {
e2cd3ed0 1602 return false;
217a8ee9 1603 }
1604
31dadc6f
PS
1605 $urlbase = "/course/mod.php?id=$course->id&section=$section&sesskey=".sesskey().'&add=';
1606
017ab27c
DP
1607 $resources = array();
1608 $activities = array();
6da4b261 1609
017ab27c
DP
1610 foreach($modnames as $modname=>$modnamestr) {
1611 if (!course_allowed_module($course, $modname)) {
1612 continue;
1613 }
6da4b261 1614
017ab27c
DP
1615 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1616 if (!file_exists($libfile)) {
1617 continue;
1618 }
1619 include_once($libfile);
1620 $gettypesfunc = $modname.'_get_types';
1621 if (function_exists($gettypesfunc)) {
1622 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1623 if ($types = $gettypesfunc()) {
1624 $menu = array();
1625 $atype = null;
1626 $groupname = null;
1627 foreach($types as $type) {
31dadc6f 1628 if ($type->typestr === '--') {
017ab27c 1629 continue;
65bcf17b 1630 }
017ab27c
DP
1631 if (strpos($type->typestr, '--') === 0) {
1632 $groupname = str_replace('--', '', $type->typestr);
1633 continue;
89bfeee0 1634 }
017ab27c
DP
1635 $type->type = str_replace('&amp;', '&', $type->type);
1636 if ($type->modclass == MOD_CLASS_RESOURCE) {
1637 $atype = MOD_CLASS_RESOURCE;
1638 }
1639 $menu[$urlbase.$type->type] = $type->typestr;
89bfeee0 1640 }
017ab27c
DP
1641 if (!is_null($groupname)) {
1642 if ($atype == MOD_CLASS_RESOURCE) {
1643 $resources[] = array($groupname=>$menu);
1644 } else {
1645 $activities[] = array($groupname=>$menu);
1646 }
aa54ed7b 1647 } else {
017ab27c
DP
1648 if ($atype == MOD_CLASS_RESOURCE) {
1649 $resources = array_merge($resources, $menu);
1650 } else {
1651 $activities = array_merge($activities, $menu);
1652 }
aa54ed7b 1653 }
89bfeee0 1654 }
017ab27c
DP
1655 } else {
1656 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1657 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
1658 $resources[$urlbase.$modname] = $modnamestr;
1659 } else {
1660 // all other archetypes are considered activity
1661 $activities[$urlbase.$modname] = $modnamestr;
1662 }
0705ff84 1663 }
e0161bff 1664 }
1665
89bfeee0 1666 $straddactivity = get_string('addactivity');
1667 $straddresource = get_string('addresource');
1668
4f24b3e3 1669 $output = '<div class="section_add_menus">';
1670
1671 if (!$vertical) {
1672 $output .= '<div class="horizontal">';
1673 }
82fcab32 1674
89bfeee0 1675 if (!empty($resources)) {
31dadc6f 1676 $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
d2265f13 1677 $select->set_help_icon('resources');
31dadc6f 1678 $output .= $OUTPUT->render($select);
0705ff84 1679 }
cb57e6f4 1680
89bfeee0 1681 if (!empty($activities)) {
31dadc6f 1682 $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
d2265f13 1683 $select->set_help_icon('activities');
31dadc6f 1684 $output .= $OUTPUT->render($select);
0705ff84 1685 }
1686
4f24b3e3 1687 if (!$vertical) {
d33d0cda 1688 $output .= '</div>';
1689 }
1690
cb57e6f4 1691 $output .= '</div>';
1692
1693 if ($return) {
1694 return $output;
1695 } else {
1696 echo $output;
1697 }
e0161bff 1698}
1699
8ed5dd63 1700/**
1701 * Return the course category context for the category with id $categoryid, except
1702 * that if $categoryid is 0, return the system context.
1703 *
1704 * @param integer $categoryid a category id or 0.
1705 * @return object the corresponding context
1706 */
1707function get_category_or_system_context($categoryid) {
1708 if ($categoryid) {
1709 return get_context_instance(CONTEXT_COURSECAT, $categoryid);
1710 } else {
1711 return get_context_instance(CONTEXT_SYSTEM);
1712 }
1713}
1714
f36cbf1d 1715/**
1716 * Rebuilds the cached list of course activities stored in the database
7e85563d 1717 * @param int $courseid - id of course to rebuild, empty means all
f36cbf1d 1718 * @param boolean $clearonly - only clear the modinfo fields, gets rebuild automatically on the fly
1719 */
1720function rebuild_course_cache($courseid=0, $clearonly=false) {
e6db3026 1721 global $COURSE, $DB, $OUTPUT;
f36cbf1d 1722
58d89c24
SH
1723 // Destroy navigation caches
1724 navigation_cache::destroy_volatile_caches();
1725
f36cbf1d 1726 if ($clearonly) {
1c69b885 1727 if (empty($courseid)) {
1728 $courseselect = array();
1729 } else {
1730 $courseselect = array('id'=>$courseid);
1731 }
1732 $DB->set_field('course', 'modinfo', null, $courseselect);
f36cbf1d 1733 // update cached global COURSE too ;-)
f80ee891 1734 if ($courseid == $COURSE->id or empty($courseid)) {
238c0dd9 1735 $COURSE->modinfo = null;
f36cbf1d 1736 }
1737 // reset the fast modinfo cache
1738 $reset = 'reset';
1739 get_fast_modinfo($reset);
1740 return;
1741 }
5867bfb5 1742
1743 if ($courseid) {
cb6fec1f 1744 $select = array('id'=>$courseid);
5867bfb5 1745 } else {
cb6fec1f 1746 $select = array();
6cf890e3 1747 @set_time_limit(0); // this could take a while! MDL-10954
5867bfb5 1748 }
1749
cb6fec1f 1750 if ($rs = $DB->get_recordset("course", $select,'','id,fullname')) {
1751 foreach ($rs as $course) {
5867bfb5 1752 $modinfo = serialize(get_array_of_activities($course->id));
f685e830 1753 $DB->set_field("course", "modinfo", $modinfo, array("id"=>$course->id));
dd97c328 1754 // update cached global COURSE too ;-)
1755 if ($course->id == $COURSE->id) {
238c0dd9 1756 $COURSE->modinfo = $modinfo;
dd97c328 1757 }
5867bfb5 1758 }
cb6fec1f 1759 $rs->close();
5867bfb5 1760 }
dd97c328 1761 // reset the fast modinfo cache
65a00c97 1762 $reset = 'reset';
1763 get_fast_modinfo($reset);
5867bfb5 1764}
1765
cb6fec1f 1766/**
7e85563d 1767 * Gets the child categories of a given courses category. Uses a static cache
8ed5dd63 1768 * to make repeat calls efficient.
1769 *
e92c39ca 1770 * @param int $parentid the id of a course category.
8ed5dd63 1771 * @return array all the child course categories.
cb6fec1f 1772 */
8ed5dd63 1773function get_child_categories($parentid) {
9bb19e58 1774 static $allcategories = null;
1775
1776 // only fill in this variable the first time
1777 if (null == $allcategories) {
1778 $allcategories = array();
1779
1780 $categories = get_categories();
1781 foreach ($categories as $category) {
1782 if (empty($allcategories[$category->parent])) {
1783 $allcategories[$category->parent] = array();
1784 }
1785 $allcategories[$category->parent][] = $category;
1786 }
1787 }
1788
8ed5dd63 1789 if (empty($allcategories[$parentid])) {
9bb19e58 1790 return array();
1791 } else {
8ed5dd63 1792 return $allcategories[$parentid];
9bb19e58 1793 }
1794}
1795
cb6fec1f 1796/**
8ed5dd63 1797 * This function recursively travels the categories, building up a nice list
1798 * for display. It also makes an array that list all the parents for each
1799 * category.
1800 *
1801 * For example, if you have a tree of categories like:
1802 * Miscellaneous (id = 1)
1803 * Subcategory (id = 2)
1804 * Sub-subcategory (id = 4)
1805 * Other category (id = 3)
1806 * Then after calling this function you will have
1807 * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1808 * 4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1809 * 3 => 'Other category');
1810 * $parents = array(2 => array(1), 4 => array(1, 2));
1811 *
1812 * If you specify $requiredcapability, then only categories where the current
1813 * user has that capability will be added to $list, although all categories
1814 * will still be added to $parents, and if you only have $requiredcapability
1815 * in a child category, not the parent, then the child catgegory will still be
1816 * included.
1817 *
1818 * If you specify the option $excluded, then that category, and all its children,
1819 * are omitted from the tree. This is useful when you are doing something like
1820 * moving categories, where you do not want to allow people to move a category
1821 * to be the child of itself.
1822 *
1823 * @param array $list For output, accumulates an array categoryid => full category path name
1824 * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
8a1b1c32 1825 * @param string/array $requiredcapability if given, only categories where the current
1826 * user has this capability will be added to $list. Can also be an array of capabilities,
1827 * in which case they are all required.
8ed5dd63 1828 * @param integer $excludeid Omit this category and its children from the lists built.
1829 * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1830 * @param string $path For internal use, as part of recursive calls.
cb6fec1f 1831 */
8ed5dd63 1832function make_categories_list(&$list, &$parents, $requiredcapability = '',
1833 $excludeid = 0, $category = NULL, $path = "") {
1834
9d866ae0 1835 // initialize the arrays if needed
1836 if (!is_array($list)) {
264867fd 1837 $list = array();
9d866ae0 1838 }
1839 if (!is_array($parents)) {
264867fd 1840 $parents = array();
9d866ae0 1841 }
1842
8ed5dd63 1843 if (empty($category)) {
1844 // Start at the top level.
1845 $category = new stdClass;
1846 $category->id = 0;
1847 } else {
1848 // This is the excluded category, don't include it.
1849 if ($excludeid > 0 && $excludeid == $category->id) {
1850 return;
1851 }
1852
1853 // Update $path.
c2cb4545 1854 if ($path) {
6ba65fa0 1855 $path = $path.' / '.format_string($category->name);
c2cb4545 1856 } else {
6ba65fa0 1857 $path = format_string($category->name);
c2cb4545 1858 }
8ed5dd63 1859
1860 // Add this category to $list, if the permissions check out.
3ce50127 1861 if (empty($requiredcapability)) {
8ed5dd63 1862 $list[$category->id] = $path;
3ce50127 1863
1864 } else {
1865 ensure_context_subobj_present($category, CONTEXT_COURSECAT);
1866 $requiredcapability = (array)$requiredcapability;
1867 if (has_all_capabilities($requiredcapability, $category->context)) {
1868 $list[$category->id] = $path;
1869 }
8ed5dd63 1870 }
c2cb4545 1871 }
1872
8ed5dd63 1873 // Add all the children recursively, while updating the parents array.
1874 if ($categories = get_child_categories($category->id)) {
c2cb4545 1875 foreach ($categories as $cat) {
1876 if (!empty($category->id)) {
3bd4de22 1877 if (isset($parents[$category->id])) {
2832badf 1878 $parents[$cat->id] = $parents[$category->id];
1879 }
c2cb4545 1880 $parents[$cat->id][] = $category->id;
1881 }
8ed5dd63 1882 make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
c2cb4545 1883 }
1884 }
1885}
1886
24e27ac0
SH
1887/**
1888 * This function generates a structured array of courses and categories.
1889 *
1890 * The depth of categories is limited by $CFG->maxcategorydepth however there
1891 * is no limit on the number of courses!
1892 *
1893 * Suitable for use with the course renderers course_category_tree method:
1894 * $renderer = $PAGE->get_renderer('core','course');
1895 * echo $renderer->course_category_tree(get_course_category_tree());
1896 *
1897 * @global moodle_database $DB
1898 * @param int $id
1899 * @param int $depth
1900 */
1901function get_course_category_tree($id = 0, $depth = 0) {
cf41dc37 1902 global $DB, $CFG;
24e27ac0
SH
1903 $viewhiddencats = has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM));
1904 $categories = get_child_categories($id);
1905 $categoryids = array();
1906 foreach ($categories as $key => &$category) {
1907 if (!$category->visible && !$viewhiddencats) {
1908 unset($categories[$key]);
1909 continue;
1910 }
1911 $categoryids[$category->id] = $category;
1912 if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
1913 list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
3ebc548f
SH
1914 foreach ($subcategories as $subid=>$subcat) {
1915 $categoryids[$subid] = $subcat;
1916 }
24e27ac0
SH
1917 $category->courses = array();
1918 }
1919 }
1920
1921 if ($depth > 0) {
1922 // This is a recursive call so return the required array
1923 return array($categories, $categoryids);
1924 }
1925
1926 // The depth is 0 this function has just been called so we can finish it off
1927
1928 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1929 list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
1930 $sql = "SELECT
df997f84 1931 c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
24e27ac0
SH
1932 $ccselect
1933 FROM {course} c
1934 $ccjoin
1935 WHERE c.category $catsql ORDER BY c.sortorder ASC";
1936 if ($courses = $DB->get_records_sql($sql, $catparams)) {
1937 // loop throught them
1938 foreach ($courses as $course) {
1939 if ($course->id == SITEID) {
1940 continue;
1941 }
1942 context_instance_preload($course);
1943 if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1944 $categoryids[$course->category]->courses[$course->id] = $course;
1945 }
1946 }
1947 }
1948 return $categories;
1949}
c2cb4545 1950
cb6fec1f 1951/**
1952 * Recursive function to print out all the categories in a nice format
1953 * with or without courses included
1954 */
8ed5dd63 1955function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
9ff5310a 1956 global $CFG;
e05bcf2f 1957
beeee4d2 1958 // maxcategorydepth == 0 meant no limit
1959 if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
e05bcf2f 1960 return;
9ff5310a 1961 }
c2cb4545 1962
1963 if (!$displaylist) {
e92fe848 1964 make_categories_list($displaylist, $parentslist);
c2cb4545 1965 }
1966
1967 if ($category) {
8ed5dd63 1968 if ($category->visible or has_capability('moodle/category:viewhiddencategories', get_context_instance(CONTEXT_SYSTEM))) {
1969 print_category_info($category, $depth, $showcourses);
c2cb4545 1970 } else {
1971 return; // Don't bother printing children of invisible categories
1972 }
89adb174 1973
c2cb4545 1974 } else {
c2cb4545 1975 $category->id = "0";
1976 }
1977
9bb19e58 1978 if ($categories = get_child_categories($category->id)) { // Print all the children recursively
c2cb4545 1979 $countcats = count($categories);
1980 $count = 0;
1981 $first = true;
1982 $last = false;
1983 foreach ($categories as $cat) {
1984 $count++;
1985 if ($count == $countcats) {
1986 $last = true;
1987 }
1988 $up = $first ? false : true;
1989 $down = $last ? false : true;
1990 $first = false;
1991
8ed5dd63 1992 print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
c2cb4545 1993 }
1994 }
c2cb4545 1995}
1996
cb6fec1f 1997/**
af90698b 1998 * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
cb6fec1f 1999 */
0705ff84 2000function make_categories_options() {
2001 make_categories_list($cats,$parents);
2002 foreach ($cats as $key => $value) {
2003 if (array_key_exists($key,$parents)) {
2004 if ($indent = count($parents[$key])) {
2005 for ($i = 0; $i < $indent; $i++) {
2006 $cats[$key] = '&nbsp;'.$cats[$key];
2007 }
2008 }
2009 }
2010 }
2011 return $cats;
2012}
c2cb4545 2013
cb6fec1f 2014/**
2015 * Prints the category info in indented fashion
2016 * This function is only used by print_whole_category_list() above
2017 */
f3e5bf86 2018function print_category_info($category, $depth=0, $showcourses = false) {
6b608f8f 2019 global $CFG, $DB, $OUTPUT;
c2cb4545 2020
df997f84 2021 $strsummary = get_string('summary');
ba2e5d73 2022
ea831ceb
RW
2023 $catlinkcss = null;
2024 if (!$category->visible) {
2025 $catlinkcss = array('class'=>'dimmed');
2026 }
dc247e52 2027 static $coursecount = null;
2028 if (null === $coursecount) {
2029 // only need to check this once
2030 $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2031 }
2032
8ed5dd63 2033 if ($showcourses and $coursecount) {
b5d0cafc 2034 $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
b48f834c 2035 } else {
7b0b5c14 2036 $catimage = "&nbsp;";
8ef9cb56 2037 }
2afcfc44 2038
df997f84 2039 $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
8ed5dd63 2040 if ($showcourses and $coursecount) {
2a63b636 2041 echo '<div class="categorylist clearfix">';
2afcfc44 2042 $cat = '';
2a63b636 2043 $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
ea831ceb 2044 $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2afcfc44
RW
2045 $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2046
ea831ceb 2047 $html = '';
2afcfc44
RW
2048 if ($depth > 0) {
2049 for ($i=0; $i< $depth; $i++) {
ea831ceb 2050 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2afcfc44 2051 $cat = '';
cb184beb 2052 }
2afcfc44 2053 } else {
ea831ceb 2054 $html = $cat;
2afcfc44 2055 }
2a63b636 2056 echo html_writer::tag('div', $html, array('class'=>'category'));
2afcfc44 2057 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
b48f834c 2058
beeee4d2 2059 // does the depth exceed maxcategorydepth
2afcfc44 2060 // maxcategorydepth == 0 or unset meant no limit
beeee4d2 2061 $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
beeee4d2 2062 if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
c2cb4545 2063 foreach ($courses as $course) {
ea831ceb
RW
2064 $linkcss = null;
2065 if (!$course->visible) {
2066 $linkcss = array('class'=>'dimmed');
2067 }
2a63b636 2068
ea831ceb 2069 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), $linkcss);
2afcfc44 2070
bf423bb1 2071 // print enrol info
f3e5bf86 2072 $courseicon = '';
bf423bb1
PS
2073 if ($icons = enrol_get_course_info_icons($course)) {
2074 foreach ($icons as $pix_icon) {
f3e5bf86 2075 $courseicon = $OUTPUT->render($pix_icon).' ';
bf423bb1
PS
2076 }
2077 }
2078
f3e5bf86
SH
2079 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2080
b48f834c 2081 if ($course->summary) {
75015e5f 2082 $link = new moodle_url('/course/info.php?id='.$course->id);
2afcfc44 2083 $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
75015e5f
PS
2084 new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2085 array('title'=>$strsummary));
2afcfc44
RW
2086
2087 $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2088 }
2089
ea831ceb 2090 $html = '';
f3e5bf86 2091 for ($i=0; $i <= $depth; $i++) {
ea831ceb 2092 $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2afcfc44 2093 $coursecontent = '';
0c656181 2094 }
ea831ceb 2095 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2afcfc44 2096 }
ba2e5d73 2097 }
2afcfc44
RW
2098 echo '</div>';
2099 } else {
2a63b636 2100 echo '<div class="categorylist">';
ea831ceb
RW
2101 $html = '';
2102 $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), format_string($category->name), $catlinkcss);
2103 $cat .= html_writer::tag('span', '('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2a63b636 2104
ea831ceb
RW
2105 if ($depth > 0) {
2106 for ($i=0; $i< $depth; $i++) {
2107 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2108 $cat = '';
2109 }
2110 } else {
2111 $html = $cat;
2112 }
2a63b636
PS
2113
2114 echo html_writer::tag('div', $html, array('class'=>'category'));
ea831ceb 2115 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
cb184beb 2116 echo '</div>';
2afcfc44 2117 }
c2cb4545 2118}
2119
77eddcd5 2120/**
2121 * Print the buttons relating to course requests.
2122 *
2123 * @param object $systemcontext the system context.
2124 */
2125function print_course_request_buttons($systemcontext) {
b4531207 2126 global $CFG, $DB, $OUTPUT;
77eddcd5 2127 if (empty($CFG->enablecourserequests)) {
2128 return;
2129 }
4f0c2d00 2130 if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
77eddcd5 2131 /// Print a button to request a new course
5c2ed7e2 2132 echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
77eddcd5 2133 }
2134 /// Print a button to manage pending requests
2135 if (has_capability('moodle/site:approvecourse', $systemcontext)) {
5c2ed7e2
PS
2136 $disabled = !$DB->record_exists('course_request', array());
2137 echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
77eddcd5 2138 }
2139}
2140
5048e034 2141/**
2142 * Does the user have permission to edit things in this category?
2143 *
2144 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2145 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2146 */
2147function can_edit_in_category($categoryid = 0) {
2148 $context = get_category_or_system_context($categoryid);
2149 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2150}
2151
8ed5dd63 2152/**
2153 * Prints the turn editing on/off button on course/index.php or course/category.php.
2154 *
2155 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2156 * @return string HTML of the editing button, or empty string, if this user is not allowed
2157 * to see it.
2158 */
2159function update_category_button($categoryid = 0) {
b4531207 2160 global $CFG, $PAGE, $OUTPUT;
8ed5dd63 2161
2162 // Check permissions.
5048e034 2163 if (!can_edit_in_category($categoryid)) {
8ed5dd63 2164 return '';
2165 }
2166
2167 // Work out the appropriate action.
830dd6e9 2168 if ($PAGE->user_is_editing()) {
8ed5dd63 2169 $label = get_string('turneditingoff');
2170 $edit = 'off';
2171 } else {
2172 $label = get_string('turneditingon');
2173 $edit = 'on';
2174 }
c2cb4545 2175
8ed5dd63 2176 // Generate the button HTML.
2177 $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2178 if ($categoryid) {
2179 $options['id'] = $categoryid;
2180 $page = 'category.php';
2181 } else {
2182 $page = 'index.php';
2183 }
a6855934 2184 return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
8ed5dd63 2185}
e0b033d5 2186
cb6fec1f 2187/**
2188 * Category is 0 (for all courses) or an object
2189 */
6c54240a 2190function print_courses($category) {
2f48819b 2191 global $CFG, $OUTPUT;
c2cb4545 2192
4dde1463 2193 if (!is_object($category) && $category==0) {
9bb19e58 2194 $categories = get_child_categories(0); // Parent = 0 ie top-level categories only
4dde1463 2195 if (is_array($categories) && count($categories) == 1) {
90c2ca2e 2196 $category = array_shift($categories);
238c0dd9 2197 $courses = get_courses_wmanagers($category->id,
2198 'c.sortorder ASC',
df997f84 2199 array('summary','summaryformat'));
90c2ca2e 2200 } else {
238c0dd9 2201 $courses = get_courses_wmanagers('all',
2202 'c.sortorder ASC',
df997f84 2203 array('summary','summaryformat'));
90c2ca2e 2204 }
2205 unset($categories);
607809b3 2206 } else {
238c0dd9 2207 $courses = get_courses_wmanagers($category->id,
2208 'c.sortorder ASC',
df997f84 2209 array('summary','summaryformat'));
c2cb4545 2210 }
2211
49cd4d79 2212 if ($courses) {
002fc5ba 2213 echo html_writer::start_tag('ul', array('class'=>'unlist'));
c2cb4545 2214 foreach ($courses as $course) {
4f0c2d00
PS
2215 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2216 if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
002fc5ba 2217 echo html_writer::start_tag('li');
4dde1463 2218 print_course($course);
002fc5ba 2219 echo html_writer::end_tag('li');
4dde1463 2220 }
c2cb4545 2221 }
002fc5ba 2222 echo html_writer::end_tag('ul');
c2cb4545 2223 } else {
7c5286cd 2224 echo $OUTPUT->heading(get_string("nocoursesyet"));
8e480396 2225 $context = get_context_instance(CONTEXT_SYSTEM);
0468976c 2226 if (has_capability('moodle/course:create', $context)) {
255d1033 2227 $options = array();
4868e95f
DM
2228 if (!empty($category->id)) {
2229 $options['category'] = $category->id;
2230 } else {
2231 $options['category'] = $CFG->defaultrequestcategory;
2232 }
002fc5ba 2233 echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
a6855934 2234 echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
002fc5ba 2235 echo html_writer::end_tag('div');
255d1033 2236 }
c2cb4545 2237 }
c2cb4545 2238}
2239
04c53106 2240/**
2241 * Print a description of a course, suitable for browsing in a list.
2242 *
2243 * @param object $course the course object.
2244 * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2245 */
2246function print_course($course, $highlightterms = '') {
666e8458 2247 global $CFG, $USER, $DB, $OUTPUT;
c2cb4545 2248
4f0c2d00 2249 $context = get_context_instance(CONTEXT_COURSE, $course->id);
146bbb8f 2250
8bdc9cac 2251 // Rewrite file URLs so that they are correct
64f93798 2252 $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
8bdc9cac 2253
002fc5ba
SH
2254 echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2255 echo html_writer::start_tag('div', array('class'=>'info'));
2256 echo html_writer::start_tag('h3', array('class'=>'name'));
22288704 2257
002fc5ba
SH
2258 $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
2259 $linktext = highlight($highlightterms, format_string($course->fullname));
2260 $linkparams = array('title'=>get_string('entercourse'));
2261 if (empty($course->visible)) {
2262 $linkparams['class'] = 'dimmed';
2263 }
2264 echo html_writer::link($linkhref, $linktext, $linkparams);
2265 echo html_writer::end_tag('h3');
238c0dd9 2266
d42c64ba 2267 /// first find all roles that are supposed to be displayed
df997f84 2268 if (!empty($CFG->coursecontact)) {
c71f3265 2269 $managerroles = explode(',', $CFG->coursecontact);
4dde1463 2270 $namesarray = array();
2271 if (isset($course->managers)) {
2272 if (count($course->managers)) {
2273 $rusers = $course->managers;
2274 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
238c0dd9 2275
b682cee9 2276 /// Rename some of the role names if needed
2277 if (isset($context)) {
cb6fec1f 2278 $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
b682cee9 2279 }
2280
9d5a4b23 2281 // keep a note of users displayed to eliminate duplicates
2282 $usersshown = array();
4dde1463 2283 foreach ($rusers as $ra) {
9d5a4b23 2284
2285 // if we've already displayed user don't again
2286 if (in_array($ra->user->id,$usersshown)) {
2287 continue;
2288 }
2289 $usersshown[] = $ra->user->id;
2290
4f0c2d00 2291 $fullname = fullname($ra->user, $canviewfullnames);
b682cee9 2292
4f0c2d00
PS
2293 if (isset($aliasnames[$ra->roleid])) {
2294 $ra->rolename = $aliasnames[$ra->roleid]->name;
4dde1463 2295 }
4f0c2d00 2296
002fc5ba
SH
2297 $namesarray[] = format_string($ra->rolename).': '.
2298 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->user->id, 'course'=>SITEID)), $fullname);
4dde1463 2299 }
2300 }
2301 } else {
238c0dd9 2302 $rusers = get_role_users($managerroles, $context,
4f0c2d00 2303 true, '', 'r.sortorder ASC, u.lastname ASC');
4dde1463 2304 if (is_array($rusers) && count($rusers)) {
2305 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
165d25cc 2306
2307 /// Rename some of the role names if needed
2308 if (isset($context)) {
2309 $aliasnames = $DB->get_records('role_names', array('contextid'=>$context->id), '', 'roleid,contextid,name');
2310 }
2311
4dde1463 2312 foreach ($rusers as $teacher) {
238c0dd9 2313 $fullname = fullname($teacher, $canviewfullnames);
165d25cc 2314
2315 /// Apply role names
2316 if (isset($aliasnames[$teacher->roleid])) {
2317 $teacher->rolename = $aliasnames[$teacher->roleid]->name;
2318 }
2319
002fc5ba
SH
2320 $namesarray[] = format_string($teacher->rolename).': '.
2321 html_writer::link(new moodle_url('/user/view.php', array('id'=>$teacher->id, 'course'=>SITEID)), $fullname);
4dde1463 2322 }
431cad0d 2323 }
c2cb4545 2324 }
431cad0d 2325
d42c64ba 2326 if (!empty($namesarray)) {
002fc5ba
SH
2327 echo html_writer::start_tag('ul', array('class'=>'teachers'));
2328 foreach ($namesarray as $name) {
2329 echo html_writer::tag('li', $name);
2330 }
2331 echo html_writer::end_tag('ul');
88768091 2332 }
c2cb4545 2333 }
002fc5ba 2334 echo html_writer::end_tag('div'); // End of info div
238c0dd9 2335
002fc5ba 2336 echo html_writer::start_tag('div', array('class'=>'summary'));
9f39c190 2337 $options = NULL;
2338 $options->noclean = true;
34b5847a 2339 $options->para = false;
367a75fa 2340 $options->overflowdiv = true;
8bdc9cac
SH
2341 if (!isset($course->summaryformat)) {
2342 $course->summaryformat = FORMAT_MOODLE;
2343 }
2344 echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options, $course->id));
002fc5ba
SH
2345 if ((!isloggedin() || is_siteadmin()) && $icons = enrol_get_course_info_icons($course)) {
2346 echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2347 foreach ($icons as $icon) {
2348 echo $OUTPUT->render($icon);
2349 }
2350 echo html_writer::end_tag('div'); // End of enrolmenticons div
2351 }
2352 echo html_writer::end_tag('div'); // End of summary div
2353 echo html_writer::end_tag('div'); // End of coursebox div
c2cb4545 2354}
2355
cb6fec1f 2356/**
2357 * Prints custom user information on the home page.
2358 * Over time this can include all sorts of information
2359 */
c2cb4545 2360function print_my_moodle() {
e6db3026 2361 global $USER, $CFG, $DB, $OUTPUT;
c2cb4545 2362
4f0c2d00 2363 if (!isloggedin() or isguestuser()) {
ba6018a9 2364 print_error('nopermissions', '', '', 'See My Moodle');
c2cb4545 2365 }
2366
df997f84 2367 $courses = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
0a127169 2368 $rhosts = array();
2369 $rcourses = array();
2370 if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2371 $rcourses = get_my_remotecourses($USER->id);
2372 $rhosts = get_my_remotehosts();
2373 }
2374
2375 if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2376
2377 if (!empty($courses)) {
2378 echo '<ul class="unlist">';
2379 foreach ($courses as $course) {
2380 if ($course->id == SITEID) {
2381 continue;
2382 }
2383 echo '<li>';
2384 print_course($course);
2385 echo "</li>\n";
86dd62a7 2386 }
0a127169 2387 echo "</ul>\n";
86dd62a7 2388 }
2389
0a127169 2390 // MNET
2391 if (!empty($rcourses)) {
2392 // at the IDP, we know of all the remote courses
2393 foreach ($rcourses as $course) {
2394 print_remote_course($course, "100%");
2395 }
2396 } elseif (!empty($rhosts)) {
2397 // non-IDP, we know of all the remote servers, but not courses
2398 foreach ($rhosts as $host) {
2399 print_remote_host($host, "100%");
2400 }
2401 }
86dd62a7 2402 unset($course);
0a127169 2403 unset($host);
38a10939 2404
cb6fec1f 2405 if ($DB->count_records("course") > (count($courses) + 1) ) { // Some courses not being displayed
7f989948 2406 echo "<table width=\"100%\"><tr><td align=\"center\">";
2407 print_course_search("", false, "short");
2408 echo "</td><td align=\"center\">";
5c2ed7e2 2409 echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
7f989948 2410 echo "</td></tr></table>\n";
2411 }
86dd62a7 2412
26330001 2413 } else {
cb6fec1f 2414 if ($DB->count_records("course_categories") > 1) {
e6db3026 2415 echo $OUTPUT->box_start("categorybox");
26330001 2416 print_whole_category_list();
e6db3026 2417 echo $OUTPUT->box_end();
26330001 2418 } else {
35d0244a 2419 print_courses(0);
26330001 2420 }
607809b3 2421 }
2b8cef80 2422}
2423
11b0c469 2424
a8b56716 2425function print_course_search($value="", $return=false, $format="plain") {
38a10939 2426 global $CFG;
1e0fb105 2427 static $count = 0;
2428
2429 $count++;
2430
2431 $id = 'coursesearch';
2432
2433 if ($count > 1) {
2434 $id .= $count;
2435 }
38a10939 2436
2437 $strsearchcourses= get_string("searchcourses");
2438
1c919752 2439 if ($format == 'plain') {
1e0fb105 2440 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
fcf9577a 2441 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
e42f4d92 2442 $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2443 $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
e42f4d92 2444 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2445 $output .= '</fieldset></form>';
1c919752 2446 } else if ($format == 'short') {
1e0fb105 2447 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
fcf9577a 2448 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
b1f97418 2449 $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2450 $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
e42f4d92 2451 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2452 $output .= '</fieldset></form>';
1c919752 2453 } else if ($format == 'navbar') {
fcf9577a 2454 $output = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2455 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
b1f97418 2456 $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2457 $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
e42f4d92 2458 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2459 $output .= '</fieldset></form>';
a8b56716 2460 }
2461
2462 if ($return) {
2463 return $output;
2464 }
2465 echo $output;
38a10939 2466}
11b0c469 2467
86dd62a7 2468function print_remote_course($course, $width="100%") {
86dd62a7 2469 global $CFG, $USER;
2470
2471 $linkcss = '';
2472
2473 $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2474
7cd266e9 2475 echo '<div class="coursebox remotecoursebox clearfix">';
86dd62a7 2476 echo '<div class="info">';
2477 echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2478 $linkcss.' href="'.$url.'">'
6ba65fa0 2479 . format_string($course->fullname) .'</a><br />'
2480 . format_string($course->hostname) . ' : '
238c0dd9 2481 . format_string($course->cat_name) . ' : '
2482 . format_string($course->shortname). '</div>';
86dd62a7 2483 echo '</div><div class="summary">';
2484 $options = NULL;
2485 $options->noclean = true;
2486 $options->para = false;
367a75fa 2487 $options->overflowdiv = true;
152a2273 2488 echo format_text($course->summary, $course->summaryformat, $options);
86dd62a7 2489 echo '</div>';
2490 echo '</div>';
86dd62a7 2491}
2492
643b67b8 2493function print_remote_host($host, $width="100%") {
6b608f8f 2494 global $OUTPUT;
643b67b8 2495
2496 $linkcss = '';
2497
7cd266e9 2498 echo '<div class="coursebox clearfix">';
643b67b8 2499 echo '<div class="info">';
2500 echo '<div class="name">';
b5d0cafc 2501 echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
643b67b8 2502 echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2503 . s($host['name']).'</a> - ';
1fd80ad3 2504 echo $host['count'] . ' ' . get_string('courses');
643b67b8 2505 echo '</div>';
2506 echo '</div>';
caa90d56 2507 echo '</div>';
643b67b8 2508}
2509
86dd62a7 2510
11b0c469 2511/// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2512
2513function add_course_module($mod) {
cb6fec1f 2514 global $DB;
11b0c469 2515
e5dfd0f3 2516 $mod->added = time();
53f4ad2c 2517 unset($mod->id);
11b0c469 2518
cb6fec1f 2519 return $DB->insert_record("course_modules", $mod);
11b0c469 2520}
2521
97928ddf 2522/**
2523 * Returns course section - creates new if does not exist yet.
2524 * @param int $relative section number
2525 * @param int $courseid
2526 * @return object $course_section object
2527 */
2528function get_course_section($section, $courseid) {
cb6fec1f 2529 global $DB;
2530
2531 if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
97928ddf 2532 return $cw;
2533 }
fbaea88f 2534 $cw = new stdClass();
cb6fec1f 2535 $cw->course = $courseid;
2536 $cw->section = $section;
2537 $cw->summary = "";
09eb2151 2538 $cw->summaryformat = FORMAT_HTML;
97928ddf 2539 $cw->sequence = "";
cb6fec1f 2540 $id = $DB->insert_record("course_sections", $cw);
dc5af91a 2541 return $DB->get_record("course_sections", array("id"=>$id));
97928ddf 2542}
ece966f0 2543/**
2544 * Given a full mod object with section and course already defined, adds this module to that section.
2545 *
2546 * @param object $mod
2547 * @param int $beforemod An existing ID which we will insert the new module before
2548 * @return int The course_sections ID where the mod is inserted
2549 */
7977cffd 2550function add_mod_to_section($mod, $beforemod=NULL) {
cb6fec1f 2551 global $DB;
11b0c469 2552
cb6fec1f 2553 if ($section = $DB->get_record("course_sections", array("course"=>$mod->course, "section"=>$mod->section))) {
7977cffd 2554
2555 $section->sequence = trim($section->sequence);
2556
2557 if (empty($section->sequence)) {
11b0c469 2558 $newsequence = "$mod->coursemodule";
7977cffd 2559
2560 } else if ($beforemod) {
2561 $modarray = explode(",", $section->sequence);
2562
d857e8b6 2563 if ($key = array_keys($modarray, $beforemod->id)) {
7977cffd 2564 $insertarray = array($mod->id, $beforemod->id);
2565 array_splice($modarray, $key[0], 1, $insertarray);
2566 $newsequence = implode(",", $modarray);
2567
2568 } else { // Just tack it on the end anyway
2569 $newsequence = "$section->sequence,$mod->coursemodule";
2570 }
2571
2572 } else {
2573 $newsequence = "$section->sequence,$mod->coursemodule";
11b0c469 2574 }
89adb174 2575
f685e830
PS
2576 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2577 return $section->id; // Return course_sections ID that was used.
89adb174 2578
11b0c469 2579 } else { // Insert a new record
cb6fec1f 2580 $section->course = $mod->course;
2581 $section->section = $mod->section;
2582 $section->summary = "";
09eb2151 2583 $section->summaryformat = FORMAT_HTML;
e5dfd0f3 2584 $section->sequence = $mod->coursemodule;
cb6fec1f 2585 return $DB->insert_record("course_sections", $section);
11b0c469 2586 }
2587}
2588
48e535bc 2589function set_coursemodule_groupmode($id, $groupmode) {
cb6fec1f 2590 global $DB;
a5d424df 2591 return $DB->set_field("course_modules", "groupmode", $groupmode, array("id"=>$id));
3d575e6f 2592}
2593
177d4abf 2594function set_coursemodule_idnumber($id, $idnumber) {
cb6fec1f 2595 global $DB;
238c0dd9 2596 return $DB->set_field("course_modules", "idnumber", $idnumber, array("id"=>$id));
177d4abf 2597}
4e781c7b 2598
02f66c42 2599/**
2600* $prevstateoverrides = true will set the visibility of the course module
2601* to what is defined in visibleold. This enables us to remember the current
2602* visibility when making a whole section hidden, so that when we toggle
2603* that section back to visible, we are able to return the visibility of
2604* the course module back to what it was originally.
2605*/
2606function set_coursemodule_visible($id, $visible, $prevstateoverrides=false) {
f5e2602a 2607 global $DB, $CFG;
0f078024
DM
2608 require_once($CFG->libdir.'/gradelib.php');
2609
cb6fec1f 2610 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
978abb42 2611 return false;
2612 }
cb6fec1f 2613 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
978abb42 2614 return false;
2615 }
cb6fec1f 2616 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 2617 foreach($events as $event) {
48e535bc 2618 if ($visible) {
2619 show_event($event);
2620 } else {
2621 hide_event($event);
2622 }
dcd338ff 2623 }
2624 }
f5e2602a 2625
0f078024
DM
2626 // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2627 $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2628 if ($grade_items) {
2629 foreach ($grade_items as $grade_item) {
2630 $grade_item->set_hidden(!$visible);
2631 }
f5e2602a 2632 }
f685e830 2633
02f66c42 2634 if ($prevstateoverrides) {
2635 if ($visible == '0') {
2636 // Remember the current visible state so we can toggle this back.
cb6fec1f 2637 $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id'=>$id));
02f66c42 2638 } else {
2639 // Get the previous saved visible states.
cb6fec1f 2640 return $DB->set_field('course_modules', 'visible', $cm->visibleold, array('id'=>$id));
02f66c42 2641 }
2642 }
cb6fec1f 2643 return $DB->set_field("course_modules", "visible", $visible, array("id"=>$id));
1acfbce5 2644}
2645
cb6fec1f 2646/**
290130b3 2647 * Delete a course module and any associated data at the course level (events)
264867fd 2648 * Until 1.5 this function simply marked a deleted flag ... now it
290130b3 2649 * deletes it completely.
2650 *
2651 */
48e535bc 2652function delete_course_module($id) {
cb6fec1f 2653 global $CFG, $DB;
f615fbab 2654 require_once($CFG->libdir.'/gradelib.php');
cae83708 2655 require_once($CFG->dirroot.'/blog/lib.php');
f615fbab 2656
cb6fec1f 2657 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
290130b3 2658 return true;
2659 }
cb6fec1f 2660 $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
f615fbab 2661 //delete events from calendar
cb6fec1f 2662 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 2663 foreach($events as $event) {
0ea03696 2664 delete_event($event->id);
dcd338ff 2665 }
2666 }
f615fbab 2667 //delete grade items, outcome items and grades attached to modules
2668 if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2669 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2670 foreach ($grade_items as $grade_item) {
2671 $grade_item->delete('moddelete');
2672 }
f615fbab 2673 }
46e12372
SM
2674 // Delete completion and availability data; it is better to do this even if the
2675 // features are not turned on, in case they were turned on previously (these will be
2676 // very quick on an empty table)
2677 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2678 $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
06b3a6b2 2679
2680 delete_context(CONTEXT_MODULE, $cm->id);
bf66a674 2681 return $DB->delete_records('course_modules', array('id'=>$cm->id));
11b0c469 2682}
2683
2684function delete_mod_from_section($mod, $section) {
cb6fec1f 2685 global $DB;
11b0c469 2686
cb6fec1f 2687 if ($section = $DB->get_record("course_sections", array("id"=>$section)) ) {
11b0c469 2688
e5dfd0f3 2689 $modarray = explode(",", $section->sequence);
11b0c469 2690
2691 if ($key = array_keys ($modarray, $mod)) {
2692 array_splice($modarray, $key[0], 1);
2693 $newsequence = implode(",", $modarray);
cb6fec1f 2694 return $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
11b0c469 2695 } else {
2696 return false;
2697 }
89adb174 2698
11b0c469 2699 }
7977cffd 2700 return false;
11b0c469 2701}
2702
3440ec12 2703/**
2704 * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2705 *
2706 * @param object $course
2707 * @param int $section
2708 * @param int $move (-1 or 1)
2709 */
12905134 2710function move_section($course, $section, $move) {
2711/// Moves a whole course section up and down within the course
cb6fec1f 2712 global $USER, $DB;
12905134 2713
2714 if (!$move) {
2715 return true;
2716 }
2717
2718 $sectiondest = $section + $move;
2719
2720 if ($sectiondest > $course->numsections or $sectiondest < 1) {
2721 return false;
2722 }
2723
cb6fec1f 2724 if (!$sectionrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$section))) {
12905134 2725 return false;
2726 }
2727
cb6fec1f 2728 if (!$sectiondestrecord = $DB->get_record("course_sections", array("course"=>$course->id, "section"=>$sectiondest))) {
12905134 2729 return false;
2730 }
2731
f685e830
PS
2732 $DB->set_field("course_sections", "section", $sectiondest, array("id"=>$sectionrecord->id));
2733 $DB->set_field("course_sections", "section", $section, array("id"=>$sectiondestrecord->id));
2734
798b70a1 2735 // if the focus is on the section that is being moved, then move the focus along
2736 if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2737 course_set_display($course->id, $sectiondest);
2738 }
5390cbb7 2739
a987106d 2740 // Check for duplicates and fix order if needed.
5390cbb7 2741 // There is a very rare case that some sections in the same course have the same section id.
cb6fec1f 2742 $sections = $DB->get_records('course_sections', array('course'=>$course->id), 'section ASC');
a987106d 2743 $n = 0;
2744 foreach ($sections as $section) {
2745 if ($section->section != $n) {
f685e830 2746 $DB->set_field('course_sections', 'section', $n, array('id'=>$section->id));
5390cbb7 2747 }
a987106d 2748 $n++;
5390cbb7 2749 }
12905134 2750 return true;
2751}
2752
3440ec12 2753/**
2754 * Moves a section within a course, from a position to another.
2755 * Be very careful: $section and $destination refer to section number,
2756 * not id!.
2757 *
2758 * @param object $course
2759 * @param int $section Section number (not id!!!)
2760 * @param int $destination
2761 * @return boolean Result
2762 */
2763function move_section_to($course, $section, $destination) {
2764/// Moves a whole course section up and down within the course
2765 global $USER, $DB;
2766
ca255392 2767 if (!$destination && $destination != 0) {
3440ec12 2768 return true;
2769 }
2770
ca255392 2771 if ($destination > $course->numsections) {
3440ec12 2772 return false;
2773 }
2774
2775 // Get all sections for this course and re-order them (2 of them should now share the same section number)
2776 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2777 'section ASC, id ASC', 'id, section')) {
2778 return false;
2779 }
2780
2781 $sections = reorder_sections($sections, $section, $destination);
2782
2783 // Update all sections
2784 foreach ($sections as $id => $position) {
2785 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2786 }
2787
2788 // if the focus is on the section that is being moved, then move the focus along
2789 if (isset($USER->display[$course->id]) and ($USER->display[$course->id] == $section)) {
2790 course_set_display($course->id, $destination);
2791 }
2792 return true;
2793}
2794
2795/**
2796 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
2797 * an original position number and a target position number, rebuilds the array so that the
2798 * move is made without any duplication of section positions.
2799 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
2800 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
2801 *
2802 * @param array $sections
2803 * @param int $origin_position
2804 * @param int $target_position
2805 * @return array
2806 */
2807function reorder_sections($sections, $origin_position, $target_position) {
2808 if (!is_array($sections)) {
2809 return false;
2810 }
2811
2812 // We can't move section position 0
2813 if ($origin_position < 1) {
2814 echo "We can't move section position 0";
2815 return false;
2816 }
2817
2818 // Locate origin section in sections array
2819 if (!$origin_key = array_search($origin_position, $sections)) {
2820 echo "searched position not in sections array";
2821 return false; // searched position not in sections array
2822 }
2823
2824 // Extract origin section
2825 $origin_section = $sections[$origin_key];
2826 unset($sections[$origin_key]);
2827
2828 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
2829 $found = false;
2830 $append_array = array();
2831 foreach ($sections as $id => $position) {
2832 if ($found) {
2833 $append_array[$id] = $position;
2834 unset($sections[$id]);
2835 }
2836 if ($position == $target_position) {
2837 $found = true;
2838 }
2839 }
2840
2841 // Append moved section
2842 $sections[$origin_key] = $origin_section;
2843
2844 // Append rest of array (if applicable)
2845 if (!empty($append_array)) {
2846 foreach ($append_array as $id => $position) {
2847 $sections[$id] = $position;
2848 }
2849 }
2850
2851 // Renumber positions
2852 $position = 0;
2853 foreach ($sections as $id => $p) {
2854 $sections[$id] = $position;
2855 $position++;
2856 }
2857
2858 return $sections;
2859
2860}
2861
cb6fec1f 2862/**
2863 * Move the module object $mod to the specified $section
2864 * If $beforemod exists then that is the module
2865 * before which $modid should be inserted
2866 * All parameters are objects
2867 */
7977cffd 2868function moveto_module($mod, $section, $beforemod=NULL) {
e6db3026 2869 global $DB, $OUTPUT;
7977cffd 2870
2871/// Remove original module from original section
7977cffd 2872 if (! delete_mod_from_section($mod->id, $mod->section)) {
e6db3026 2873 echo $OUTPUT->notification("Could not delete module from existing section");
7977cffd 2874 }
2875
2876/// Update module itself if necessary
2877
2878 if ($mod->section != $section->id) {
89adb174 2879 $mod->section = $section->id;
bb4b6010 2880 $DB->update_record("course_modules", $mod);
48e535bc 2881 // if moving to a hidden section then hide module
2882 if (!$section->visible) {
2883 set_coursemodule_visible($mod->id, 0);
2884 }
7977cffd 2885 }
2886
2887/// Add the module into the new section
2888
2889 $mod->course = $section->course;
2890 $mod->section = $section->section; // need relative reference
2891 $mod->coursemodule = $mod->id;
2892
2893 if (! add_mod_to_section($mod, $beforemod)) {
2894 return false;
2895 }
2896
2897 return true;
7977cffd 2898}
2899
24e1eae4 2900function make_editing_buttons($mod, $absolute=false, $moveselect=true, $indent=-1, $section=-1) {
6b608f8f 2901 global $CFG, $USER, $DB, $OUTPUT;
94361e02 2902
3d575e6f 2903 static $str;
37a88449 2904 static $sesskey;
3d575e6f 2905
217a8ee9 2906 $modcontext = get_context_instance(CONTEXT_MODULE, $mod->id);
2907 // no permission to edit
2908 if (!has_capability('moodle/course:manageactivities', $modcontext)) {
e2cd3ed0 2909 return false;
217a8ee9 2910 }
2911
3d575e6f 2912 if (!isset($str)) {
9534a8cb 2913 $str->assign = get_string("assignroles", 'role');
90ebdf65 2914 $str->delete = get_string("delete");
2915 $str->move = get_string("move");
2916 $str->moveup = get_string("moveup");
2917 $str->movedown = get_string("movedown");
2918 $str->moveright = get_string("moveright");
2919 $str->moveleft = get_string("moveleft");
2920 $str->update = get_string("update");
2921 $str->duplicate = get_string("duplicate");
2922 $str->hide = get_string("hide");
2923 $str->show = get_string("show");
3d575e6f 2924 $str->clicktochange = get_string("clicktochange");
32d03b7b 2925 $str->forcedmode = get_string("forcedmode");
3d575e6f 2926 $str->groupsnone = get_string("groupsnone");
2927 $str->groupsseparate = get_string("groupsseparate");
2928 $str->groupsvisible = get_string("groupsvisible");
37a88449 2929 $sesskey = sesskey();
1acfbce5 2930 }
94361e02 2931
24e1eae4 2932 if ($section >= 0) {
75f087b6 2933 $section = '&amp;sr='.$section; // Section return
24e1eae4 2934 } else {
2935 $section = '';
2936 }
2937
94361e02 2938 if ($absolute) {
37a88449 2939 $path = $CFG->wwwroot.'/course';
dc0dc7d5 2940 } else {
37a88449 2941 $path = '.';
dc0dc7d5 2942 }
217a8ee9 2943 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2944 if ($mod->visible) {
2945 $hideshow = '<a class="editing_hide" title="'.$str->hide.'" href="'.$path.'/mod.php?hide='.$mod->id.
2946 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2947 ' src="'.$OUTPUT->pix_url('t/hide') . '" class="iconsmall" '.
217a8ee9 2948 ' alt="'.$str->hide.'" /></a>'."\n";
2949 } else {
2950 $hideshow = '<a class="editing_show" title="'.$str->show.'" href="'.$path.'/mod.php?show='.$mod->id.
2951 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2952 ' src="'.$OUTPUT->pix_url('t/show') . '" class="iconsmall" '.
217a8ee9 2953 ' alt="'.$str->show.'" /></a>'."\n";
2954 }
530db4cd 2955 } else {
2956 $hideshow = '';
7977cffd 2957 }
530db4cd 2958
3d575e6f 2959 if ($mod->groupmode !== false) {
2960 if ($mod->groupmode == SEPARATEGROUPS) {
32d03b7b 2961 $grouptitle = $str->groupsseparate;
cddbd5d5 2962 $groupclass = 'editing_groupsseparate';
b5d0cafc 2963 $groupimage = $OUTPUT->pix_url('t/groups') . '';
37a88449 2964 $grouplink = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=0&amp;sesskey='.$sesskey;
3d575e6f 2965 } else if ($mod->groupmode == VISIBLEGROUPS) {
32d03b7b 2966 $grouptitle = $str->groupsvisible;
cddbd5d5 2967 $groupclass = 'editing_groupsvisible';
b5d0cafc 2968 $groupimage = $OUTPUT->pix_url('t/groupv') . '';
37a88449 2969 $grouplink = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=1&amp;sesskey='.$sesskey;
32d03b7b 2970 } else {
2971 $grouptitle = $str->groupsnone;
90ebdf65 2972 $groupclass = 'editing_groupsnone';
b5d0cafc 2973 $groupimage = $OUTPUT->pix_url('t/groupn') . '';
37a88449 2974 $grouplink = $path.'/mod.php?id='.$mod->id.'&amp;groupmode=2&amp;sesskey='.$sesskey;
32d03b7b 2975 }
2976 if ($mod->groupmodelink) {
90ebdf65 2977 $groupmode = '<a class="'.$groupclass.'" title="'.$grouptitle.' ('.$str->clicktochange.')" href="'.$grouplink.'">'.
0d905d9f 2978 '<img src="'.$groupimage.'" class="iconsmall" '.
2979 'alt="'.$grouptitle.'" /></a>';
3d575e6f 2980 } else {
37a88449 2981 $groupmode = '<img title="'.$grouptitle.' ('.$str->forcedmode.')" '.
0d905d9f 2982 ' src="'.$groupimage.'" class="iconsmall" '.
2983 'alt="'.$grouptitle.'" />';
3d575e6f 2984 }
2985 } else {
2986 $groupmode = "";
2987 }
e2cd3ed0 2988
217a8ee9 2989 if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
2990 if ($moveselect) {
2991 $move = '<a class="editing_move" title="'.$str->move.'" href="'.$path.'/mod.php?copy='.$mod->id.
2992 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2993 ' src="'.$OUTPUT->pix_url('t/move') . '" class="iconsmall" '.
217a8ee9 2994 ' alt="'.$str->move.'" /></a>'."\n";
2995 } else {
2996 $move = '<a class="editing_moveup" title="'.$str->moveup.'" href="'.$path.'/mod.php?id='.$mod->id.
2997 '&amp;move=-1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 2998 ' src="'.$OUTPUT->pix_url('t/up') . '" class="iconsmall" '.
217a8ee9 2999 ' alt="'.$str->moveup.'" /></a>'."\n".
3000 '<a class="editing_movedown" title="'.$str->movedown.'" href="'.$path.'/mod.php?id='.$mod->id.
3001 '&amp;move=1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3002 ' src="'.$OUTPUT->pix_url('t/down') . '" class="iconsmall" '.
217a8ee9 3003 ' alt="'.$str->movedown.'" /></a>'."\n";
3004 }
7b44777e 3005 } else {
238c0dd9 3006 $move = '';
7977cffd 3007 }
3008
932be046 3009 $leftright = '';
217a8ee9 3010 if (has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $mod->course))) {
932be046 3011
78946b9b
PS
3012 if (right_to_left()) { // Exchange arrows on RTL
3013 $rightarrow = 't/left';
3014 $leftarrow = 't/right';
3015 } else {
3016 $rightarrow = 't/right';
3017 $leftarrow = 't/left';
932be046 3018 }
238c0dd9 3019
217a8ee9 3020 if ($indent > 0) {
3021 $leftright .= '<a class="editing_moveleft" title="'.$str->moveleft.'" href="'.$path.'/mod.php?id='.$mod->id.
3022 '&amp;indent=-1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3023 ' src="'.$OUTPUT->pix_url($leftarrow).'" class="iconsmall" '.
217a8ee9 3024 ' alt="'.$str->moveleft.'" /></a>'."\n";
3025 }
3026 if ($indent >= 0) {
3027 $leftright .= '<a class="editing_moveright" title="'.$str->moveright.'" href="'.$path.'/mod.php?id='.$mod->id.
3028 '&amp;indent=1&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3029 ' src="'.$OUTPUT->pix_url($rightarrow).'" class="iconsmall" '.
217a8ee9 3030 ' alt="'.$str->moveright.'" /></a>'."\n";
3031 }
37a88449 3032 }
9534a8cb 3033 if (has_capability('moodle/course:managegroups', $modcontext)){
3034 $context = get_context_instance(CONTEXT_MODULE, $mod->id);
d1aa1e48 3035 $assign = '<a class="editing_assign" title="'.$str->assign.'" href="'.$CFG->wwwroot.'/'.$CFG->admin.'/roles/assign.php?contextid='.
b5d0cafc 3036 $context->id.'"><img src="'.$OUTPUT->pix_url('i/roles') . '" alt="'.$str->assign.'" class="iconsmall"/></a>';
8634e001 3037 } else {
3038 $assign = '';
9534a8cb 3039 }
8634e001 3040
90ebdf65 3041 return '<span class="commands">'."\n".$leftright.$move.
3042 '<a class="editing_update" title="'.$str->update.'" href="'.$path.'/mod.php?update='.$mod->id.
37a88449 3043 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3044 ' src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" '.
90ebdf65 3045 ' alt="'.$str->update.'" /></a>'."\n".
3046 '<a class="editing_delete" title="'.$str->delete.'" href="'.$path.'/mod.php?delete='.$mod->id.
37a88449 3047 '&amp;sesskey='.$sesskey.$section.'"><img'.
b5d0cafc 3048 ' src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" '.
9534a8cb 3049 ' alt="'.$str->delete.'" /></a>'."\n".$hideshow.$groupmode."\n".$assign.'</span>';
90845098 3050}
3051
b61efafb 3052/**
264867fd 3053 * given a course object with shortname & fullname, this function will
b61efafb 3054 * truncate the the number of chars allowed and add ... if it was too long
3055 */
3056function course_format_name ($course,$max=100) {
264867fd 3057
6ba65fa0 3058 $str = $course->shortname.': '. $course->fullname;
b61efafb 3059 if (strlen($str) <= $max) {
3060 return $str;
3061 }
3062 else {
3063 return substr($str,0,$max-3).'...';
3064 }
3065}
3066
cb6fec1f 3067function update_restricted_mods($course, $mods) {
3068 global $DB;
ddb0a19f 3069
3070/// Delete all the current restricted list
cb6fec1f 3071 $DB->delete_records('course_allowed_modules', array('course'=>$course->id));
ddb0a19f 3072
0705ff84 3073 if (empty($course->restrictmodules)) {
ddb0a19f 3074 return; // We're done
0705ff84 3075 }
ddb0a19f 3076
3077/// Insert the new list of restricted mods
3078 foreach ($mods as $mod) {
3079 if ($mod == 0) {
3080 continue; // this is the 'allow none' option
0705ff84 3081 }
fbaea88f 3082 $am = new stdClass();
ddb0a19f 3083 $am->course = $course->id;
3084 $am->module = $mod;
cb6fec1f 3085 $DB->insert_record('course_allowed_modules',$am);
0705ff84 3086 }
3087}
3088
3089/**
3090 * This function will take an int (module id) or a string (module name)
3091 * and return true or false, whether it's allowed in the given course (object)
264867fd 3092 * $mod is not allowed to be an object, as the field for the module id is inconsistent
0705ff84 3093 * depending on where in the code it's called from (sometimes $mod->id, sometimes $mod->module)
3094 */
3095
3096function course_allowed_module($course,$mod) {
cb6fec1f 3097 global $DB;
238c0dd9 3098
0705ff84 3099 if (empty($course->restrictmodules)) {
3100 return true;
3101 }
264867fd 3102
ddb0a19f 3103 // Admins and admin-like people who can edit everything can also add anything.
7e85563d 3104 // Originally there was a course:update test only, but it did not match the test in course edit form
df997f84 3105 if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {
0705ff84 3106 return true;
3107 }
ddb0a19f 3108
0705ff84 3109 if (is_numeric($mod)) {
3110 $modid = $mod;
3111 } else if (is_string($mod)) {
cb6fec1f 3112 $modid = $DB->get_field('modules', 'id', array('name'=>$mod));
0705ff84 3113 }
3114 if (empty($modid)) {
3115 return false;
3116 }
238c0dd9 3117