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