MDL-37085 get_module_metadata() now returns link as moodle_url instead of string
[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;
0e35ba6f 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 }
3186c124 597 if ($ld && is_numeric($log->info)) {
954fdb42 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;
75427a82 668 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
954fdb42 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 }
3186c124 697 if ($ld && is_numeric($log->info)) {
954fdb42 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;
75427a82 782 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
ea49a66c 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 }
3186c124 811 if ($ld && is_numeric($log->info)) {
ea49a66c 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 *
f89c53f6
MG
1310 * @deprecated since 2.5
1311 *
0d8b6a69 1312 * This data is also used in other areas of the code.
1313 * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
f89c53f6 1314 * @param object $course (argument not used)
0d8b6a69 1315 * @return array An array with the following values in this order:
1316 * $content (optional extra content for after link),
1317 * $instancename (text of link)
1318 */
1319function get_print_section_cm_text(cm_info $cm, $course) {
f89c53f6
MG
1320 return array($cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true)),
1321 $cm->get_formatted_name());
0d8b6a69 1322}
1323
cb6fec1f 1324/**
1325 * Prints a section full of activity modules
5946d376
FM
1326 *
1327 * @param stdClass $course The course
eda43c7d
MG
1328 * @param stdClass|section_info $section The section object containing properties id and section
1329 * @param array $mods (argument not used)
1330 * @param array $modnamesused (argument not used)
5946d376 1331 * @param bool $absolute All links are absolute
49aa038b 1332 * @param string $width (argument not used)
5946d376 1333 * @param bool $hidecompletion Hide completion status
b8514b6a 1334 * @param int $sectionreturn The section to return to
5946d376 1335 * @return void
cb6fec1f 1336 */
923451c5 1337function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
e63f88c9 1338 global $CFG, $USER, $DB, $PAGE, $OUTPUT;
7977cffd 1339
dd97c328 1340 static $initialised;
1341
3d575e6f 1342 static $groupbuttons;
32d03b7b 1343 static $groupbuttonslink;
52dcc2f9 1344 static $isediting;
7977cffd 1345 static $ismoving;
49aa038b 1346 static $movingpix;
7977cffd 1347 static $strmovefull;
54669989 1348 static $strunreadpostsone;
110a32e2 1349
dd97c328 1350 if (!isset($initialised)) {
9fd9c29b 1351 $groupbuttons = ($course->groupmode or (!$course->groupmodeforce));
32d03b7b 1352 $groupbuttonslink = (!$course->groupmodeforce);
830dd6e9 1353 $isediting = $PAGE->user_is_editing();
dd97c328 1354 $ismoving = $isediting && ismoving($course->id);
3d575e6f 1355 if ($ismoving) {
49aa038b 1356 $movingpix = new pix_icon('movehere', get_string('movehere'), 'moodle', array('class' => 'movetarget'));
dd97c328 1357 $strmovefull = strip_tags(get_string("movefull", "", "'$USER->activitycopyname'"));
3d575e6f 1358 }
dd97c328 1359 $initialised = true;
7977cffd 1360 }
dd97c328 1361
dd97c328 1362 $modinfo = get_fast_modinfo($course);
984baa77 1363 $completioninfo = new completion_info($course);
f558b291 1364 $courserenderer = $PAGE->get_renderer('core', 'course');
94361e02 1365
49aa038b
MG
1366 // Get the list of modules visible to user (excluding the module being moved if there is one)
1367 $moduleslist = array();
eda43c7d 1368 if (!empty($modinfo->sections[$section->section])) {
eda43c7d
MG
1369 foreach ($modinfo->sections[$section->section] as $modnumber) {
1370 $mod = $modinfo->cms[$modnumber];
c9f6251e 1371
dd97c328 1372 if ($ismoving and $mod->id == $USER->activitycopy) {
1373 // do not display moving mod
1374 continue;
1375 }
eda43c7d
MG
1376 // We can continue (because it will not be displayed at all)
1377 // if:
1378 // 1) The activity is not visible to users
1379 // and
1380 // 2a) The 'showavailability' option is not set (if that is set,
1381 // we need to display the activity so we can show
1382 // availability info)
1383 // or
1384 // 2b) The 'availableinfo' is empty, i.e. the activity was
1385 // hidden in a way that leaves no info, such as using the
1386 // eye icon.
1387 if (!$mod->uservisible &&
1388 (empty($mod->showavailability) ||
1389 empty($mod->availableinfo))) {
1390 // visibility shortcut
1391 continue;
0d8b6a69 1392 }
0d8b6a69 1393
49aa038b
MG
1394 $moduleslist[$modnumber] = $mod;
1395 }
1396 }
1397
1398 if (!empty($moduleslist) || $ismoving) {
1399
1400 echo html_writer::start_tag('ul', array('class' => 'section img-text'));
1401
1402 foreach ($moduleslist as $modnumber => $mod) {
1403
2f48819b 1404 // In some cases the activity is visible to user, but it is
e8e50986 1405 // dimmed. This is done if viewhiddenactivities is true and if:
1406 // 1. the activity is not visible, or
1407 // 2. the activity has dates set which do not include current, or
1408 // 3. the activity has any other conditions set (regardless of whether
1409 // current user meets them)
110f73ad 1410 $modcontext = context_module::instance($mod->id);
1411 $canviewhidden = has_capability('moodle/course:viewhiddenactivities', $modcontext);
49aa038b 1412 $accessiblebutdim = !$mod->uservisible;
64020473 1413 $conditionalhidden = false;
49aa038b 1414 if (!$accessiblebutdim && $canviewhidden) {
e8e50986 1415 $accessiblebutdim = !$mod->visible;
1416 if (!empty($CFG->enableavailability)) {
64020473 1417 $conditionalhidden = $mod->availablefrom > time() ||
e8e50986 1418 ($mod->availableuntil && $mod->availableuntil < time()) ||
2f48819b 1419 count($mod->conditionsgrade) > 0 ||
e8e50986 1420 count($mod->conditionscompletion) > 0;
1421 }
64020473 1422 $accessiblebutdim = $conditionalhidden || $accessiblebutdim;
e8e50986 1423 }
1424
49aa038b 1425 $modclasses = 'activity '. $mod->modname. 'modtype_'.$mod->modname. ' '. $mod->get_extra_classes();
dd97c328 1426 if ($ismoving) {
49aa038b
MG
1427 $movingurl = new moodle_url('/course/mod.php', array('moveto' => $mod->id, 'sesskey' => sesskey()));
1428 echo html_writer::tag('li', html_writer::link($movingurl, $OUTPUT->render($movingpix)), array('class' => 'movehere'));
dd97c328 1429 }
9d361034 1430
49aa038b
MG
1431 echo html_writer::start_tag('li', array('class' => $modclasses, 'id' => 'module-'. $modnumber));
1432 $indentclasses = 'mod-indent';
060cd0c8 1433 if (!empty($mod->indent)) {
49aa038b 1434 $indentclasses .= ' mod-indent-'.$mod->indent;
060cd0c8 1435 if ($mod->indent > 15) {
49aa038b 1436 $indentclasses .= ' mod-indent-huge';
060cd0c8 1437 }
dd97c328 1438 }
49aa038b 1439 echo html_writer::start_tag('div', array('class' => $indentclasses));
dd97c328 1440
0d8b6a69 1441 // Get data about this course-module
f89c53f6
MG
1442 $content = $mod->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1443 $instancename = $mod->get_formatted_name();
0d8b6a69 1444
1445 //Accessibility: for files get description via icon, this is very ugly hack!
1446 $altname = '';
1447 $altname = $mod->modfullname;
0d8b6a69 1448 // Avoid unnecessary duplication: if e.g. a forum name already
1449 // includes the word forum (or Forum, etc) then it is unhelpful
1450 // to include that in the accessible description that is added.
f8311def
PS
1451 if (false !== strpos(textlib::strtolower($instancename),
1452 textlib::strtolower($altname))) {
0d8b6a69 1453 $altname = '';
1454 }
1455 // File type after name, for alphabetic lists (screen reader).
1456 if ($altname) {
1457 $altname = get_accesshide(' '.$altname);
554606c7 1458 }
dd97c328 1459
e40bd746
FM
1460 // Start the div for the activity title, excluding the edit icons.
1461 echo html_writer::start_tag('div', array('class' => 'activityinstance'));
1462
0d8b6a69 1463 // We may be displaying this just in order to show information
49aa038b 1464 // about visibility, without the actual link ($mod->uservisible)
0d8b6a69 1465 $contentpart = '';
0d8b6a69 1466 $linkclasses = '';
1467 $textclasses = '';
49aa038b 1468 $accesstext = '';
0d8b6a69 1469 if ($accessiblebutdim) {
64020473
RT
1470 $linkclasses .= ' dimmed';
1471 $textclasses .= ' dimmed_text';
1472 if ($conditionalhidden) {
1473 $linkclasses .= ' conditionalhidden';
1474 $textclasses .= ' conditionalhidden';
1475 }
49aa038b
MG
1476 if ($mod->uservisible) {
1477 // show accessibility note only if user can access the module himself
1478 $accesstext = get_accesshide(get_string('hiddenfromstudents').': ');
1479 }
c4d989a1 1480 }
aac94fd0 1481
e5ad278a
RT
1482 // Get on-click attribute value if specified and decode the onclick - it
1483 // has already been encoded for display (puke).
1484 $onclick = htmlspecialchars_decode($mod->get_on_click(), ENT_QUOTES);
e40bd746
FM
1485
1486 $groupinglabel = '';
1487 if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
1488 $groupings = groups_get_all_groupings($course->id);
1489 $groupinglabel = html_writer::tag('span', '('.format_string($groupings[$mod->groupingid]->name).')',
49aa038b 1490 array('class' => 'groupinglabel '.$textclasses));
0d8b6a69 1491 }
c9f6251e 1492
0d8b6a69 1493 if ($url = $mod->get_url()) {
e40bd746
FM
1494 // Display link itself.
1495 $activitylink = html_writer::empty_tag('img', array('src' => $mod->get_icon_url(),
1496 'class' => 'iconlarge activityicon', 'alt' => $mod->modfullname)) . $accesstext .
1497 html_writer::tag('span', $instancename . $altname, array('class' => 'instancename'));
49aa038b
MG
1498 if ($mod->uservisible) {
1499 echo html_writer::link($url, $activitylink, array('class' => $linkclasses, 'onclick' => $onclick)) .
1500 $groupinglabel;
1501 } else {
1502 echo html_writer::tag('div', $activitylink, array('class' => $textclasses)) .
1503 $groupinglabel;
1504 }
e40bd746
FM
1505
1506 // If specified, display extra content after link.
0d8b6a69 1507 if ($content) {
e40bd746
FM
1508 $contentpart = html_writer::tag('div', $content, array('class' =>
1509 trim('contentafterlink ' . $textclasses)));
c93dae38 1510 }
dd97c328 1511 } else {
e40bd746 1512 // No link, so display only content.
49aa038b 1513 $contentpart = html_writer::tag('div', $accesstext . $content, array('class' => $textclasses));
f37da850 1514 }
1515
0d8b6a69 1516 // Module can put text after the link (e.g. forum unread)
1517 echo $mod->get_after_link();
1518
e40bd746
FM
1519 // Closing the tag which contains everything but edit icons. $contentpart should not be part of this.
1520 echo html_writer::end_tag('div');
1521
611684a8 1522 // If there is content but NO link (eg label), then display the
1523 // content here (BEFORE any icons). In this case cons must be
1524 // displayed after the content so that it makes more sense visually
1525 // and for accessibility reasons, e.g. if you have a one-line label
1526 // it should work similarly (at least in terms of ordering) to an
1527 // activity.
1528 if (empty($url)) {
1529 echo $contentpart;
1530 }
1531
dd97c328 1532 if ($isediting) {
525e16ce 1533 if ($groupbuttons and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
dd97c328 1534 if (! $mod->groupmodelink = $groupbuttonslink) {
1535 $mod->groupmode = $course->groupmode;
3d575e6f 1536 }
dd97c328 1537
1538 } else {
1539 $mod->groupmode = false;
c9f6251e 1540 }
b8514b6a 1541 echo make_editing_buttons($mod, $absolute, true, $mod->indent, $sectionreturn);
0d8b6a69 1542 echo $mod->get_after_edit_icons();
94361e02 1543 }
4e781c7b 1544
1545 // Completion
3982f0f8 1546 $completion = $hidecompletion
4e781c7b 1547 ? COMPLETION_TRACKING_NONE
1548 : $completioninfo->is_enabled($mod);
2f48819b 1549 if ($completion!=COMPLETION_TRACKING_NONE && isloggedin() &&
82bd6a5e 1550 !isguestuser() && $mod->uservisible) {
3982f0f8 1551 $completiondata = $completioninfo->get_data($mod,true);
1552 $completionicon = '';
1553 if ($isediting) {
1554 switch ($completion) {
ca255392 1555 case COMPLETION_TRACKING_MANUAL :
3982f0f8 1556 $completionicon = 'manual-enabled'; break;
ca255392 1557 case COMPLETION_TRACKING_AUTOMATIC :
3982f0f8 1558 $completionicon = 'auto-enabled'; break;
4e781c7b 1559 default: // wtf
1560 }
3982f0f8 1561 } else if ($completion==COMPLETION_TRACKING_MANUAL) {
4e781c7b 1562 switch($completiondata->completionstate) {
1563 case COMPLETION_INCOMPLETE:
3982f0f8 1564 $completionicon = 'manual-n'; break;
4e781c7b 1565 case COMPLETION_COMPLETE:
3982f0f8 1566 $completionicon = 'manual-y'; break;
4e781c7b 1567 }
1568 } else { // Automatic
1569 switch($completiondata->completionstate) {
1570 case COMPLETION_INCOMPLETE:
3982f0f8 1571 $completionicon = 'auto-n'; break;
4e781c7b 1572 case COMPLETION_COMPLETE:
3982f0f8 1573 $completionicon = 'auto-y'; break;
4e781c7b 1574 case COMPLETION_COMPLETE_PASS:
3982f0f8 1575 $completionicon = 'auto-pass'; break;
4e781c7b 1576 case COMPLETION_COMPLETE_FAIL:
3982f0f8 1577 $completionicon = 'auto-fail'; break;
4e781c7b 1578 }
1579 }
3982f0f8 1580 if ($completionicon) {
b5d0cafc 1581 $imgsrc = $OUTPUT->pix_url('i/completion-'.$completionicon);
110f73ad 1582 $formattedname = format_string($mod->name, true, array('context' => $modcontext));
1583 $imgalt = get_string('completion-alt-' . $completionicon, 'completion', $formattedname);
76c0123b 1584 if ($completion == COMPLETION_TRACKING_MANUAL && !$isediting) {
110f73ad 1585 $imgtitle = get_string('completion-title-' . $completionicon, 'completion', $formattedname);
3982f0f8 1586 $newstate =
4e781c7b 1587 $completiondata->completionstate==COMPLETION_COMPLETE
ca255392 1588 ? COMPLETION_INCOMPLETE
1589 : COMPLETION_COMPLETE;
a343b13f 1590 // In manual mode the icon is a toggle form...
1591
1592 // If this completion state is used by the
1593 // conditional activities system, we need to turn
1594 // off the JS.
2f48819b 1595 if (!empty($CFG->enableavailability) &&
76c0123b 1596 condition_info::completion_value_used_as_condition($course, $mod)) {
a343b13f 1597 $extraclass = ' preventjs';
1598 } else {
1599 $extraclass = '';
1600 }
da6076f1 1601 echo html_writer::start_tag('form', array(
1602 'class' => 'togglecompletion' . $extraclass,
1603 'method' => 'post',
1604 'action' => $CFG->wwwroot . '/course/togglecompletion.php'));
1605 echo html_writer::start_tag('div');
1606 echo html_writer::empty_tag('input', array(
1607 'type' => 'hidden', 'name' => 'id', 'value' => $mod->id));
1608 echo html_writer::empty_tag('input', array(
1609 'type' => 'hidden', 'name' => 'modulename',
1610 'value' => $mod->name));
1611 echo html_writer::empty_tag('input', array(
1612 'type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey()));
1613 echo html_writer::empty_tag('input', array(
1614 'type' => 'hidden', 'name' => 'completionstate',
1615 'value' => $newstate));
1616 echo html_writer::empty_tag('input', array(
1617 'type' => 'image', 'src' => $imgsrc, 'alt' => $imgalt, 'title' => $imgtitle));
1618 echo html_writer::end_tag('div');
1619 echo html_writer::end_tag('form');
4e781c7b 1620 } else {
1621 // In auto mode, or when editing, the icon is just an image
f17a0360 1622 echo "<span class='autocompletion'>";
f17a0360 1623 echo "<img src='$imgsrc' alt='$imgalt' title='$imgalt' /></span>";
4e781c7b 1624 }
1625 }
1626 }
1627
611684a8 1628 // If there is content AND a link, then display the content here
1629 // (AFTER any icons). Otherwise it was displayed before
1630 if (!empty($url)) {
1631 echo $contentpart;
1632 }
0d8b6a69 1633
2f48819b 1634 // Show availability information (for someone who isn't allowed to
82bd6a5e 1635 // see the activity itself, or for staff)
3982f0f8 1636 if (!$mod->uservisible) {
82bd6a5e 1637 echo '<div class="availabilityinfo">'.$mod->availableinfo.'</div>';
57bda785 1638 } else if ($canviewhidden && !empty($CFG->enableavailability)) {
588b94ac
RT
1639 // Don't add availability information if user is not editing and activity is hidden.
1640 if ($mod->visible || $PAGE->user_is_editing()) {
1641 $hidinfoclass = '';
1642 if (!$mod->visible) {
1643 $hidinfoclass = 'hide';
1644 }
1645 $ci = new condition_info($mod);
1646 $fullinfo = $ci->get_full_information();
1647 if($fullinfo) {
1648 echo '<div class="availabilityinfo '.$hidinfoclass.'">'.get_string($mod->showavailability
1649 ? 'userrestriction_visible'
1650 : 'userrestriction_hidden','condition',
1651 $fullinfo).'</div>';
1652 }
82bd6a5e 1653 }
1654 }
1655
060cd0c8
SH
1656 echo html_writer::end_tag('div');
1657 echo html_writer::end_tag('li')."\n";
94361e02 1658 }
dd97c328 1659
49aa038b
MG
1660 if ($ismoving) {
1661 $movingurl = new moodle_url('/course/mod.php', array('movetosection' => $section->id, 'sesskey' => sesskey()));
1662 echo html_writer::tag('li', html_writer::link($movingurl, $OUTPUT->render($movingpix)), array('class' => 'movehere'));
1663 }
dd97c328 1664
49aa038b 1665 echo html_writer::end_tag('ul'); // .section
c6a55371 1666 }
a7ad3ea6 1667}
1668
89bfeee0 1669/**
1670 * Prints the menus to add activities and resources.
5946d376
FM
1671 *
1672 * @param stdClass $course The course
923451c5 1673 * @param int $section relative section number (field course_sections.section)
d57aa283
MG
1674 * @param null|array $modnames An array containing the list of modules and their names
1675 * if omitted will be taken from get_module_types_names()
5946d376
FM
1676 * @param bool $vertical Vertical orientation
1677 * @param bool $return Return the menus or send them to output
b8514b6a 1678 * @param int $sectionreturn The section to link back to
5946d376 1679 * @return void|string depending on $return
89bfeee0 1680 */
d57aa283 1681function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
17079335
MG
1682 global $PAGE, $CFG, $OUTPUT;
1683 if ($course->id != $PAGE->course->id) {
1684 debugging('print_section_add_menus() can be called only for the course set on the page', DEBUG_DEVELOPER);
1685 return;
1686 }
e0161bff 1687
d57aa283
MG
1688 if ($modnames === null) {
1689 $modnames = get_module_types_names();
1690 }
1691
1692 // check to see if user can add menus and there are modules to add
1693 if (!has_capability('moodle/course:manageactivities', context_course::instance($course->id))
17079335 1694 || !$PAGE->user_is_editing()
d57aa283
MG
1695 || empty($modnames)) {
1696 if ($return) {
1697 return '';
1698 } else {
1699 return false;
1700 }
217a8ee9 1701 }
1702
59155a3f 1703 // Retrieve all modules with associated metadata
923451c5 1704 $modules = get_module_metadata($course, $modnames, $sectionreturn);
31dadc6f 1705
59155a3f 1706 // We'll sort resources and activities into two lists
017ab27c
DP
1707 $resources = array();
1708 $activities = array();
6da4b261 1709
59155a3f
ARN
1710 foreach ($modules as $module) {
1711 if (isset($module->types)) {
1712 // This module has a subtype
017ab27c 1713 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
59155a3f
ARN
1714 $subtypes = array();
1715 foreach ($module->types as $subtype) {
17079335
MG
1716 $link = $subtype->link->out(true, array('section' => $section));
1717 $subtypes[$link] = $subtype->title;
59155a3f
ARN
1718 }
1719
1720 // Sort module subtypes into the list
1721 if (!empty($module->title)) {
1722 // This grouping has a name
1723 if ($module->archetype == MOD_CLASS_RESOURCE) {
1724 $resources[] = array($module->title=>$subtypes);
1725 } else {
1726 $activities[] = array($module->title=>$subtypes);
89bfeee0 1727 }
59155a3f
ARN
1728 } else {
1729 // This grouping does not have a name
1730 if ($module->archetype == MOD_CLASS_RESOURCE) {
1731 $resources = array_merge($resources, $subtypes);
aa54ed7b 1732 } else {
59155a3f 1733 $activities = array_merge($activities, $subtypes);
aa54ed7b 1734 }
89bfeee0 1735 }
017ab27c 1736 } else {
59155a3f
ARN
1737 // This module has no subtypes
1738 if ($module->archetype == MOD_ARCHETYPE_RESOURCE) {
17079335
MG
1739 $link = $module->link->out(true, array('section' => $section));
1740 $resources[$link] = $module->title;
59155a3f 1741 } else if ($module->archetype === MOD_ARCHETYPE_SYSTEM) {
5813c7f7 1742 // System modules cannot be added by user, do not add to dropdown
017ab27c 1743 } else {
17079335
MG
1744 $link = $module->link->out(true, array('section' => $section));
1745 $activities[$link] = $module->title;
017ab27c 1746 }
0705ff84 1747 }
e0161bff 1748 }
1749
89bfeee0 1750 $straddactivity = get_string('addactivity');
1751 $straddresource = get_string('addresource');
4c897a81
FM
1752 $sectionname = get_section_name($course, $section);
1753 $strresourcelabel = get_string('addresourcetosection', null, $sectionname);
1754 $stractivitylabel = get_string('addactivitytosection', null, $sectionname);
89bfeee0 1755
01e0e704 1756 $output = html_writer::start_tag('div', array('class' => 'section_add_menus', 'id' => 'add_menus-section-' . $section));
4f24b3e3 1757
1758 if (!$vertical) {
01e0e704 1759 $output .= html_writer::start_tag('div', array('class' => 'horizontal'));
4f24b3e3 1760 }
82fcab32 1761
89bfeee0 1762 if (!empty($resources)) {
31dadc6f 1763 $select = new url_select($resources, '', array(''=>$straddresource), "ressection$section");
d2265f13 1764 $select->set_help_icon('resources');
4c897a81 1765 $select->set_label($strresourcelabel, array('class' => 'accesshide'));
31dadc6f 1766 $output .= $OUTPUT->render($select);
0705ff84 1767 }
cb57e6f4 1768
89bfeee0 1769 if (!empty($activities)) {
31dadc6f 1770 $select = new url_select($activities, '', array(''=>$straddactivity), "section$section");
d2265f13 1771 $select->set_help_icon('activities');
4c897a81 1772 $select->set_label($stractivitylabel, array('class' => 'accesshide'));
31dadc6f 1773 $output .= $OUTPUT->render($select);
0705ff84 1774 }
1775
4f24b3e3 1776 if (!$vertical) {
01e0e704 1777 $output .= html_writer::end_tag('div');
d33d0cda 1778 }
1779
01e0e704
ARN
1780 $output .= html_writer::end_tag('div');
1781
1782 if (course_ajax_enabled($course)) {
1783 $straddeither = get_string('addresourceoractivity');
1784 // The module chooser link
46e046b7
DP
1785 $modchooser = html_writer::start_tag('div', array('class' => 'mdl-right'));
1786 $modchooser.= html_writer::start_tag('div', array('class' => 'section-modchooser'));
ceb35517 1787 $icon = $OUTPUT->pix_icon('t/add', '');
46e046b7 1788 $span = html_writer::tag('span', $straddeither, array('class' => 'section-modchooser-text'));
928cc791 1789 $modchooser .= html_writer::tag('span', $icon . $span, array('class' => 'section-modchooser-link'));
46e046b7
DP
1790 $modchooser.= html_writer::end_tag('div');
1791 $modchooser.= html_writer::end_tag('div');
01e0e704
ARN
1792
1793 // Wrap the normal output in a noscript div
945a81a9 1794 $usemodchooser = get_user_preferences('usemodchooser', $CFG->modchooserdefault);
01e0e704
ARN
1795 if ($usemodchooser) {
1796 $output = html_writer::tag('div', $output, array('class' => 'hiddenifjs addresourcedropdown'));
1797 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'visibleifjs addresourcemodchooser'));
1798 } else {
2757a205
ARN
1799 // If the module chooser is disabled, we need to ensure that the dropdowns are shown even if javascript is disabled
1800 $output = html_writer::tag('div', $output, array('class' => 'show addresourcedropdown'));
1801 $modchooser = html_writer::tag('div', $modchooser, array('class' => 'hide addresourcemodchooser'));
01e0e704
ARN
1802 }
1803 $output = $modchooser . $output;
1804 }
cb57e6f4 1805
1806 if ($return) {
1807 return $output;
1808 } else {
1809 echo $output;
1810 }
e0161bff 1811}
1812
59155a3f
ARN
1813/**
1814 * Retrieve all metadata for the requested modules
1815 *
1816 * @param object $course The Course
1817 * @param array $modnames An array containing the list of modules and their
1818 * names
a41b1d96 1819 * @param int $sectionreturn The section to return to
59155a3f
ARN
1820 * @return array A list of stdClass objects containing metadata about each
1821 * module
1822 */
923451c5 1823function get_module_metadata($course, $modnames, $sectionreturn = null) {
59155a3f
ARN
1824 global $CFG, $OUTPUT;
1825
1826 // get_module_metadata will be called once per section on the page and courses may show
1827 // different modules to one another
1828 static $modlist = array();
1829 if (!isset($modlist[$course->id])) {
1830 $modlist[$course->id] = array();
1831 }
1832
1833 $return = array();
17079335
MG
1834 $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1835 if ($sectionreturn !== null) {
1836 $urlbase->param('sr', $sectionreturn);
1837 }
59155a3f
ARN
1838 foreach($modnames as $modname => $modnamestr) {
1839 if (!course_allowed_module($course, $modname)) {
1840 continue;
1841 }
ad47d025 1842 if (isset($modlist[$course->id][$modname])) {
59155a3f
ARN
1843 // This module is already cached
1844 $return[$modname] = $modlist[$course->id][$modname];
1845 continue;
1846 }
1847
1848 // Include the module lib
1849 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1850 if (!file_exists($libfile)) {
1851 continue;
1852 }
1853 include_once($libfile);
1854
1855 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1856 $gettypesfunc = $modname.'_get_types';
1857 if (function_exists($gettypesfunc)) {
1858 if ($types = $gettypesfunc()) {
1859 $group = new stdClass();
1860 $group->name = $modname;
1861 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1862 foreach($types as $type) {
1863 if ($type->typestr === '--') {
1864 continue;
1865 }
1866 if (strpos($type->typestr, '--') === 0) {
1867 $group->title = str_replace('--', '', $type->typestr);
1868 continue;
1869 }
1870 // Set the Sub Type metadata
1871 $subtype = new stdClass();
1872 $subtype->title = $type->typestr;
1873 $subtype->type = str_replace('&amp;', '&', $type->type);
1874 $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1875 $subtype->archetype = $type->modclass;
1876
1877 // The group archetype should match the subtype archetypes and all subtypes
1878 // should have the same archetype
1879 $group->archetype = $subtype->archetype;
1880
1881 if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1882 $subtype->help = get_string('help' . $subtype->name, $modname);
1883 }
17079335 1884 $subtype->link = new moodle_url($urlbase, array('add' => $subtype->type));
59155a3f
ARN
1885 $group->types[] = $subtype;
1886 }
1887 $modlist[$course->id][$modname] = $group;
1888 }
1889 } else {
1890 $module = new stdClass();
17079335 1891 $module->title = $modnamestr;
59155a3f 1892 $module->name = $modname;
17079335 1893 $module->link = new moodle_url($urlbase, array('add' => $modname));
59155a3f 1894 $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
01e0e704
ARN
1895 $sm = get_string_manager();
1896 if ($sm->string_exists('modulename_help', $modname)) {
59155a3f 1897 $module->help = get_string('modulename_help', $modname);
01e0e704
ARN
1898 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs
1899 $link = get_string('modulename_link', $modname);
1900 $linktext = get_string('morehelp');
afe3566c 1901 $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
01e0e704 1902 }
59155a3f
ARN
1903 }
1904 $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1905 $modlist[$course->id][$modname] = $module;
1906 }
1907 $return[$modname] = $modlist[$course->id][$modname];
1908 }
1909
1910 return $return;
1911}
1912
8ed5dd63 1913/**
1914 * Return the course category context for the category with id $categoryid, except
1915 * that if $categoryid is 0, return the system context.
1916 *
1917 * @param integer $categoryid a category id or 0.
1918 * @return object the corresponding context
1919 */
1920function get_category_or_system_context($categoryid) {
1921 if ($categoryid) {
4658aec5 1922 return context_coursecat::instance($categoryid, IGNORE_MISSING);
8ed5dd63 1923 } else {
9a5e297b 1924 return context_system::instance();
8ed5dd63 1925 }
1926}
1927
cb6fec1f 1928/**
7e85563d 1929 * Gets the child categories of a given courses category. Uses a static cache
8ed5dd63 1930 * to make repeat calls efficient.
1931 *
e92c39ca 1932 * @param int $parentid the id of a course category.
8ed5dd63 1933 * @return array all the child course categories.
cb6fec1f 1934 */
8ed5dd63 1935function get_child_categories($parentid) {
9bb19e58 1936 static $allcategories = null;
1937
1938 // only fill in this variable the first time
1939 if (null == $allcategories) {
1940 $allcategories = array();
1941
1942 $categories = get_categories();
1943 foreach ($categories as $category) {
1944 if (empty($allcategories[$category->parent])) {
1945 $allcategories[$category->parent] = array();
1946 }
1947 $allcategories[$category->parent][] = $category;
1948 }
1949 }
1950
8ed5dd63 1951 if (empty($allcategories[$parentid])) {
9bb19e58 1952 return array();
1953 } else {
8ed5dd63 1954 return $allcategories[$parentid];
9bb19e58 1955 }
1956}
1957
cb6fec1f 1958/**
8ed5dd63 1959 * This function recursively travels the categories, building up a nice list
1960 * for display. It also makes an array that list all the parents for each
1961 * category.
1962 *
1963 * For example, if you have a tree of categories like:
1964 * Miscellaneous (id = 1)
1965 * Subcategory (id = 2)
1966 * Sub-subcategory (id = 4)
1967 * Other category (id = 3)
1968 * Then after calling this function you will have
1969 * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
1970 * 4 => 'Miscellaneous / Subcategory / Sub-subcategory',
1971 * 3 => 'Other category');
1972 * $parents = array(2 => array(1), 4 => array(1, 2));
1973 *
1974 * If you specify $requiredcapability, then only categories where the current
1975 * user has that capability will be added to $list, although all categories
1976 * will still be added to $parents, and if you only have $requiredcapability
1977 * in a child category, not the parent, then the child catgegory will still be
1978 * included.
1979 *
1980 * If you specify the option $excluded, then that category, and all its children,
1981 * are omitted from the tree. This is useful when you are doing something like
1982 * moving categories, where you do not want to allow people to move a category
1983 * to be the child of itself.
1984 *
1985 * @param array $list For output, accumulates an array categoryid => full category path name
1986 * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
8a1b1c32 1987 * @param string/array $requiredcapability if given, only categories where the current
1988 * user has this capability will be added to $list. Can also be an array of capabilities,
1989 * in which case they are all required.
8ed5dd63 1990 * @param integer $excludeid Omit this category and its children from the lists built.
1991 * @param object $category Build the tree starting at this category - otherwise starts at the top level.
1992 * @param string $path For internal use, as part of recursive calls.
cb6fec1f 1993 */
8ed5dd63 1994function make_categories_list(&$list, &$parents, $requiredcapability = '',
1995 $excludeid = 0, $category = NULL, $path = "") {
1996
9d866ae0 1997 // initialize the arrays if needed
1998 if (!is_array($list)) {
264867fd 1999 $list = array();
9d866ae0 2000 }
2001 if (!is_array($parents)) {
264867fd 2002 $parents = array();
9d866ae0 2003 }
2004
8ed5dd63 2005 if (empty($category)) {
2006 // Start at the top level.
2007 $category = new stdClass;
2008 $category->id = 0;
2009 } else {
2010 // This is the excluded category, don't include it.
2011 if ($excludeid > 0 && $excludeid == $category->id) {
2012 return;
2013 }
2014
9a5e297b 2015 $context = context_coursecat::instance($category->id);
63390481
SH
2016 $categoryname = format_string($category->name, true, array('context' => $context));
2017
8ed5dd63 2018 // Update $path.
c2cb4545 2019 if ($path) {
63390481 2020 $path = $path.' / '.$categoryname;
c2cb4545 2021 } else {
63390481 2022 $path = $categoryname;
c2cb4545 2023 }
8ed5dd63 2024
2025 // Add this category to $list, if the permissions check out.
3ce50127 2026 if (empty($requiredcapability)) {
8ed5dd63 2027 $list[$category->id] = $path;
3ce50127 2028
2029 } else {
3ce50127 2030 $requiredcapability = (array)$requiredcapability;
63390481 2031 if (has_all_capabilities($requiredcapability, $context)) {
3ce50127 2032 $list[$category->id] = $path;
2033 }
8ed5dd63 2034 }
c2cb4545 2035 }
2036
8ed5dd63 2037 // Add all the children recursively, while updating the parents array.
2038 if ($categories = get_child_categories($category->id)) {
c2cb4545 2039 foreach ($categories as $cat) {
2040 if (!empty($category->id)) {
3bd4de22 2041 if (isset($parents[$category->id])) {
2832badf 2042 $parents[$cat->id] = $parents[$category->id];
2043 }
c2cb4545 2044 $parents[$cat->id][] = $category->id;
2045 }
8ed5dd63 2046 make_categories_list($list, $parents, $requiredcapability, $excludeid, $cat, $path);
c2cb4545 2047 }
2048 }
2049}
2050
24e27ac0
SH
2051/**
2052 * This function generates a structured array of courses and categories.
2053 *
2054 * The depth of categories is limited by $CFG->maxcategorydepth however there
2055 * is no limit on the number of courses!
2056 *
2057 * Suitable for use with the course renderers course_category_tree method:
2058 * $renderer = $PAGE->get_renderer('core','course');
2059 * echo $renderer->course_category_tree(get_course_category_tree());
2060 *
2061 * @global moodle_database $DB
2062 * @param int $id
2063 * @param int $depth
2064 */
2065function get_course_category_tree($id = 0, $depth = 0) {
cf41dc37 2066 global $DB, $CFG;
9a5e297b 2067 $viewhiddencats = has_capability('moodle/category:viewhiddencategories', context_system::instance());
24e27ac0
SH
2068 $categories = get_child_categories($id);
2069 $categoryids = array();
2070 foreach ($categories as $key => &$category) {
2071 if (!$category->visible && !$viewhiddencats) {
2072 unset($categories[$key]);
2073 continue;
2074 }
2075 $categoryids[$category->id] = $category;
2076 if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
2077 list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
3ebc548f
SH
2078 foreach ($subcategories as $subid=>$subcat) {
2079 $categoryids[$subid] = $subcat;
2080 }
24e27ac0
SH
2081 $category->courses = array();
2082 }
2083 }
2084
2085 if ($depth > 0) {
2086 // This is a recursive call so return the required array
2087 return array($categories, $categoryids);
2088 }
2089
7f88c426
DP
2090 if (empty($categoryids)) {
2091 // No categories available (probably all hidden).
2092 return array();
2093 }
2094
24e27ac0
SH
2095 // The depth is 0 this function has just been called so we can finish it off
2096
2097 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
2098 list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
2099 $sql = "SELECT
df997f84 2100 c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
24e27ac0
SH
2101 $ccselect
2102 FROM {course} c
2103 $ccjoin
2104 WHERE c.category $catsql ORDER BY c.sortorder ASC";
2105 if ($courses = $DB->get_records_sql($sql, $catparams)) {
2106 // loop throught them
2107 foreach ($courses as $course) {
2108 if ($course->id == SITEID) {
2109 continue;
2110 }
2111 context_instance_preload($course);
9a5e297b 2112 if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
24e27ac0
SH
2113 $categoryids[$course->category]->courses[$course->id] = $course;
2114 }
2115 }
2116 }
2117 return $categories;
2118}
c2cb4545 2119
cb6fec1f 2120/**
2121 * Recursive function to print out all the categories in a nice format
2122 * with or without courses included
2123 */
8ed5dd63 2124function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true) {
9ff5310a 2125 global $CFG;
e05bcf2f 2126
beeee4d2 2127 // maxcategorydepth == 0 meant no limit
2128 if (!empty($CFG->maxcategorydepth) && $depth >= $CFG->maxcategorydepth) {
e05bcf2f 2129 return;
9ff5310a 2130 }
c2cb4545 2131
2132 if (!$displaylist) {
e92fe848 2133 make_categories_list($displaylist, $parentslist);
c2cb4545 2134 }
2135
2136 if ($category) {
9a5e297b 2137 if ($category->visible or has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
8ed5dd63 2138 print_category_info($category, $depth, $showcourses);
c2cb4545 2139 } else {
2140 return; // Don't bother printing children of invisible categories
2141 }
89adb174 2142
c2cb4545 2143 } else {
b85b25eb 2144 $category = new stdClass();
c2cb4545 2145 $category->id = "0";
2146 }
2147
9bb19e58 2148 if ($categories = get_child_categories($category->id)) { // Print all the children recursively
c2cb4545 2149 $countcats = count($categories);
2150 $count = 0;
2151 $first = true;
2152 $last = false;
2153 foreach ($categories as $cat) {
2154 $count++;
2155 if ($count == $countcats) {
2156 $last = true;
2157 }
2158 $up = $first ? false : true;
2159 $down = $last ? false : true;
2160 $first = false;
2161
8ed5dd63 2162 print_whole_category_list($cat, $displaylist, $parentslist, $depth + 1, $showcourses);
c2cb4545 2163 }
2164 }
c2cb4545 2165}
2166
cb6fec1f 2167/**
af90698b 2168 * This function will return $options array for html_writer::select(), with whitespace to denote nesting.
cb6fec1f 2169 */
0705ff84 2170function make_categories_options() {
2171 make_categories_list($cats,$parents);
2172 foreach ($cats as $key => $value) {
2173 if (array_key_exists($key,$parents)) {
2174 if ($indent = count($parents[$key])) {
2175 for ($i = 0; $i < $indent; $i++) {
2176 $cats[$key] = '&nbsp;'.$cats[$key];
2177 }
2178 }
2179 }
2180 }
2181 return $cats;
2182}
c2cb4545 2183
cb6fec1f 2184/**
2185 * Prints the category info in indented fashion
2186 * This function is only used by print_whole_category_list() above
2187 */
f3e5bf86 2188function print_category_info($category, $depth=0, $showcourses = false) {
6b608f8f 2189 global $CFG, $DB, $OUTPUT;
c2cb4545 2190
df997f84 2191 $strsummary = get_string('summary');
ba2e5d73 2192
ea831ceb
RW
2193 $catlinkcss = null;
2194 if (!$category->visible) {
2195 $catlinkcss = array('class'=>'dimmed');
2196 }
dc247e52 2197 static $coursecount = null;
2198 if (null === $coursecount) {
2199 // only need to check this once
2200 $coursecount = $DB->count_records('course') <= FRONTPAGECOURSELIMIT;
2201 }
2202
8ed5dd63 2203 if ($showcourses and $coursecount) {
b5d0cafc 2204 $catimage = '<img src="'.$OUTPUT->pix_url('i/course') . '" alt="" />';
b48f834c 2205 } else {
7b0b5c14 2206 $catimage = "&nbsp;";
8ef9cb56 2207 }
2afcfc44 2208
df997f84 2209 $courses = get_courses($category->id, 'c.sortorder ASC', 'c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary');
9a5e297b 2210 $context = context_coursecat::instance($category->id);
63390481
SH
2211 $fullname = format_string($category->name, true, array('context' => $context));
2212
8ed5dd63 2213 if ($showcourses and $coursecount) {
2a63b636 2214 echo '<div class="categorylist clearfix">';
2afcfc44 2215 $cat = '';
2a63b636 2216 $cat .= html_writer::tag('div', $catimage, array('class'=>'image'));
63390481 2217 $catlink = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
2afcfc44
RW
2218 $cat .= html_writer::tag('div', $catlink, array('class'=>'name'));
2219
ea831ceb 2220 $html = '';
2afcfc44
RW
2221 if ($depth > 0) {
2222 for ($i=0; $i< $depth; $i++) {
ea831ceb 2223 $html = html_writer::tag('div', $html . $cat, array('class'=>'indentation'));
2afcfc44 2224 $cat = '';
cb184beb 2225 }
2afcfc44 2226 } else {
ea831ceb 2227 $html = $cat;
2afcfc44 2228 }
2a63b636 2229 echo html_writer::tag('div', $html, array('class'=>'category'));
2afcfc44 2230 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
b48f834c 2231
beeee4d2 2232 // does the depth exceed maxcategorydepth
2afcfc44 2233 // maxcategorydepth == 0 or unset meant no limit
beeee4d2 2234 $limit = !(isset($CFG->maxcategorydepth) && ($depth >= $CFG->maxcategorydepth-1));
beeee4d2 2235 if ($courses && ($limit || $CFG->maxcategorydepth == 0)) {
c2cb4545 2236 foreach ($courses as $course) {
ea831ceb
RW
2237 $linkcss = null;
2238 if (!$course->visible) {
2239 $linkcss = array('class'=>'dimmed');
2240 }
2a63b636 2241
7fb46992 2242 $coursename = get_course_display_name_for_list($course);
2243 $courselink = html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($coursename), $linkcss);
2afcfc44 2244
bf423bb1 2245 // print enrol info
f3e5bf86 2246 $courseicon = '';
bf423bb1
PS
2247 if ($icons = enrol_get_course_info_icons($course)) {
2248 foreach ($icons as $pix_icon) {
65edd8ad 2249 $courseicon = $OUTPUT->render($pix_icon);
bf423bb1
PS
2250 }
2251 }
2252
f3e5bf86
SH
2253 $coursecontent = html_writer::tag('div', $courseicon.$courselink, array('class'=>'name'));
2254
b48f834c 2255 if ($course->summary) {
75015e5f 2256 $link = new moodle_url('/course/info.php?id='.$course->id);
2afcfc44 2257 $actionlink = $OUTPUT->action_link($link, '<img alt="'.$strsummary.'" src="'.$OUTPUT->pix_url('i/info') . '" />',
75015e5f
PS
2258 new popup_action('click', $link, 'courseinfo', array('height' => 400, 'width' => 500)),
2259 array('title'=>$strsummary));
2afcfc44
RW
2260
2261 $coursecontent .= html_writer::tag('div', $actionlink, array('class'=>'info'));
2262 }
2263
ea831ceb 2264 $html = '';
f3e5bf86 2265 for ($i=0; $i <= $depth; $i++) {
ea831ceb 2266 $html = html_writer::tag('div', $html . $coursecontent , array('class'=>'indentation'));
2afcfc44 2267 $coursecontent = '';
0c656181 2268 }
ea831ceb 2269 echo html_writer::tag('div', $html, array('class'=>'course clearfloat'));
2afcfc44 2270 }
ba2e5d73 2271 }
2afcfc44
RW
2272 echo '</div>';
2273 } else {
2a63b636 2274 echo '<div class="categorylist">';
ea831ceb 2275 $html = '';
63390481 2276 $cat = html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $fullname, $catlinkcss);
eea78ebc
DP
2277 if (count($courses) > 0) {
2278 $cat .= html_writer::tag('span', ' ('.count($courses).')', array('title'=>get_string('numberofcourses'), 'class'=>'numberofcourse'));
2279 }
2a63b636 2280
ea831ceb
RW
2281 if ($depth > 0) {
2282 for ($i=0; $i< $depth; $i++) {
2283 $html = html_writer::tag('div', $html .$cat, array('class'=>'indentation'));
2284 $cat = '';
2285 }
2286 } else {
2287 $html = $cat;
2288 }
2a63b636
PS
2289
2290 echo html_writer::tag('div', $html, array('class'=>'category'));
ea831ceb 2291 echo html_writer::tag('div', '', array('class'=>'clearfloat'));
cb184beb 2292 echo '</div>';
2afcfc44 2293 }
c2cb4545 2294}
2295
77eddcd5 2296/**
2297 * Print the buttons relating to course requests.
2298 *
2299 * @param object $systemcontext the system context.
2300 */
2301function print_course_request_buttons($systemcontext) {
b4531207 2302 global $CFG, $DB, $OUTPUT;
77eddcd5 2303 if (empty($CFG->enablecourserequests)) {
2304 return;
2305 }
4f0c2d00 2306 if (!has_capability('moodle/course:create', $systemcontext) && has_capability('moodle/course:request', $systemcontext)) {
77eddcd5 2307 /// Print a button to request a new course
5c2ed7e2 2308 echo $OUTPUT->single_button('request.php', get_string('requestcourse'), 'get');
77eddcd5 2309 }
2310 /// Print a button to manage pending requests
2311 if (has_capability('moodle/site:approvecourse', $systemcontext)) {
5c2ed7e2
PS
2312 $disabled = !$DB->record_exists('course_request', array());
2313 echo $OUTPUT->single_button('pending.php', get_string('coursespending'), 'get', array('disabled'=>$disabled));
77eddcd5 2314 }
2315}
2316
5048e034 2317/**
2318 * Does the user have permission to edit things in this category?
2319 *
2320 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2321 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
2322 */
2323function can_edit_in_category($categoryid = 0) {
2324 $context = get_category_or_system_context($categoryid);
2325 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
2326}
2327
8ed5dd63 2328/**
2329 * Prints the turn editing on/off button on course/index.php or course/category.php.
2330 *
2331 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2332 * @return string HTML of the editing button, or empty string, if this user is not allowed
2333 * to see it.
2334 */
2335function update_category_button($categoryid = 0) {
b4531207 2336 global $CFG, $PAGE, $OUTPUT;
8ed5dd63 2337
2338 // Check permissions.
5048e034 2339 if (!can_edit_in_category($categoryid)) {
8ed5dd63 2340 return '';
2341 }
2342
2343 // Work out the appropriate action.
830dd6e9 2344 if ($PAGE->user_is_editing()) {
8ed5dd63 2345 $label = get_string('turneditingoff');
2346 $edit = 'off';
2347 } else {
2348 $label = get_string('turneditingon');
2349 $edit = 'on';
2350 }
c2cb4545 2351
8ed5dd63 2352 // Generate the button HTML.
2353 $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2354 if ($categoryid) {
2355 $options['id'] = $categoryid;
2356 $page = 'category.php';
2357 } else {
2358 $page = 'index.php';
2359 }
a6855934 2360 return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
8ed5dd63 2361}
e0b033d5 2362
cb6fec1f 2363/**
2364 * Category is 0 (for all courses) or an object
2365 */
6c54240a 2366function print_courses($category) {
2f48819b 2367 global $CFG, $OUTPUT;
c2cb4545 2368
4dde1463 2369 if (!is_object($category) && $category==0) {
9bb19e58 2370 $categories = get_child_categories(0); // Parent = 0 ie top-level categories only
4dde1463 2371 if (is_array($categories) && count($categories) == 1) {
90c2ca2e 2372 $category = array_shift($categories);
238c0dd9 2373 $courses = get_courses_wmanagers($category->id,
2374 'c.sortorder ASC',
df997f84 2375 array('summary','summaryformat'));
90c2ca2e 2376 } else {
238c0dd9 2377 $courses = get_courses_wmanagers('all',
2378 'c.sortorder ASC',
df997f84 2379 array('summary','summaryformat'));
90c2ca2e 2380 }
2381 unset($categories);
607809b3 2382 } else {
238c0dd9 2383 $courses = get_courses_wmanagers($category->id,
2384 'c.sortorder ASC',
df997f84 2385 array('summary','summaryformat'));
c2cb4545 2386 }
2387
49cd4d79 2388 if ($courses) {
002fc5ba 2389 echo html_writer::start_tag('ul', array('class'=>'unlist'));
c2cb4545 2390 foreach ($courses as $course) {
9a5e297b 2391 $coursecontext = context_course::instance($course->id);
4f0c2d00 2392 if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
002fc5ba 2393 echo html_writer::start_tag('li');
4dde1463 2394 print_course($course);
002fc5ba 2395 echo html_writer::end_tag('li');
4dde1463 2396 }
c2cb4545 2397 }
002fc5ba 2398 echo html_writer::end_tag('ul');
c2cb4545 2399 } else {
7c5286cd 2400 echo $OUTPUT->heading(get_string("nocoursesyet"));
9a5e297b 2401 $context = context_system::instance();
0468976c 2402 if (has_capability('moodle/course:create', $context)) {
255d1033 2403 $options = array();
4868e95f
DM
2404 if (!empty($category->id)) {
2405 $options['category'] = $category->id;
2406 } else {
2407 $options['category'] = $CFG->defaultrequestcategory;
2408 }
002fc5ba 2409 echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
a6855934 2410 echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
002fc5ba 2411 echo html_writer::end_tag('div');
255d1033 2412 }
c2cb4545 2413 }
c2cb4545 2414}
2415
04c53106 2416/**
2417 * Print a description of a course, suitable for browsing in a list.
2418 *
2419 * @param object $course the course object.
2420 * @param string $highlightterms (optional) some search terms that should be highlighted in the display.
2421 */
2422function print_course($course, $highlightterms = '') {
666e8458 2423 global $CFG, $USER, $DB, $OUTPUT;
c2cb4545 2424
9a5e297b 2425 $context = context_course::instance($course->id);
146bbb8f 2426
8bdc9cac 2427 // Rewrite file URLs so that they are correct
64f93798 2428 $course->summary = file_rewrite_pluginfile_urls($course->summary, 'pluginfile.php', $context->id, 'course', 'summary', NULL);
8bdc9cac 2429
002fc5ba
SH
2430 echo html_writer::start_tag('div', array('class'=>'coursebox clearfix'));
2431 echo html_writer::start_tag('div', array('class'=>'info'));
2432 echo html_writer::start_tag('h3', array('class'=>'name'));
22288704 2433
002fc5ba 2434 $linkhref = new moodle_url('/course/view.php', array('id'=>$course->id));
7fb46992 2435
2436 $coursename = get_course_display_name_for_list($course);
2437 $linktext = highlight($highlightterms, format_string($coursename));
002fc5ba
SH
2438 $linkparams = array('title'=>get_string('entercourse'));
2439 if (empty($course->visible)) {
2440 $linkparams['class'] = 'dimmed';
2441 }
2442 echo html_writer::link($linkhref, $linktext, $linkparams);
2443 echo html_writer::end_tag('h3');
238c0dd9 2444
d42c64ba 2445 /// first find all roles that are supposed to be displayed
df997f84 2446 if (!empty($CFG->coursecontact)) {
c71f3265 2447 $managerroles = explode(',', $CFG->coursecontact);
e52a8ebd 2448 $rusers = array();
9d5a4b23 2449
e52a8ebd 2450 if (!isset($course->managers)) {
9695ff81 2451 list($sort, $sortparams) = users_order_by_sql('u');
e52a8ebd 2452 $rusers = get_role_users($managerroles, $context, true,
c52551dc
PS
2453 'ra.id AS raid, u.id, u.username, u.firstname, u.lastname, rn.name AS rolecoursealias,
2454 r.name AS rolename, r.sortorder, r.id AS roleid, r.shortname AS roleshortname',
9695ff81 2455 'r.sortorder ASC, ' . $sort, null, '', '', '', '', $sortparams);
e52a8ebd
DP
2456 } else {
2457 // use the managers array if we have it for perf reasosn
2458 // populate the datastructure like output of get_role_users();
2459 foreach ($course->managers as $manager) {
c52551dc
PS
2460 $user = clone($manager->user);
2461 $user->roleid = $manager->roleid;
2462 $user->rolename = $manager->rolename;
2463 $user->roleshortname = $manager->roleshortname;
2464 $user->rolecoursealias = $manager->rolecoursealias;
2465 $rusers[$user->id] = $user;
4dde1463 2466 }
e52a8ebd 2467 }
165d25cc 2468
e52a8ebd
DP
2469 $namesarray = array();
2470 $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
2471 foreach ($rusers as $ra) {
2472 if (isset($namesarray[$ra->id])) {
2473 // only display a user once with the higest sortorder role
2474 continue;
2475 }
165d25cc 2476
c52551dc
PS
2477 $role = new stdClass();
2478 $role->id = $ra->roleid;
2479 $role->name = $ra->rolename;
2480 $role->shortname = $ra->roleshortname;
2481 $role->coursealias = $ra->rolecoursealias;
2482 $rolename = role_get_name($role, $context, ROLENAME_ALIAS);
e52a8ebd
DP
2483
2484 $fullname = fullname($ra, $canviewfullnames);
c52551dc 2485 $namesarray[$ra->id] = $rolename.': '.
e52a8ebd 2486 html_writer::link(new moodle_url('/user/view.php', array('id'=>$ra->id, 'course'=>SITEID)), $fullname);
c2cb4545 2487 }
431cad0d 2488
d42c64ba 2489 if (!empty($namesarray)) {
002fc5ba
SH
2490 echo html_writer::start_tag('ul', array('class'=>'teachers'));
2491 foreach ($namesarray as $name) {
2492 echo html_writer::tag('li', $name);
2493 }
2494 echo html_writer::end_tag('ul');
88768091 2495 }
c2cb4545 2496 }
002fc5ba 2497 echo html_writer::end_tag('div'); // End of info div
238c0dd9 2498
002fc5ba 2499 echo html_writer::start_tag('div', array('class'=>'summary'));
b85b25eb 2500 $options = new stdClass();
9f39c190 2501 $options->noclean = true;
34b5847a 2502 $options->para = false;
367a75fa 2503 $options->overflowdiv = true;
8bdc9cac
SH
2504 if (!isset($course->summaryformat)) {
2505 $course->summaryformat = FORMAT_MOODLE;
2506 }
2507 echo highlight($highlightterms, format_text($course->summary, $course->summaryformat, $options, $course->id));
e877160d 2508 if ($icons = enrol_get_course_info_icons($course)) {
002fc5ba
SH
2509 echo html_writer::start_tag('div', array('class'=>'enrolmenticons'));
2510 foreach ($icons as $icon) {
2511 echo $OUTPUT->render($icon);
2512 }
2513 echo html_writer::end_tag('div'); // End of enrolmenticons div
2514 }
2515 echo html_writer::end_tag('div'); // End of summary div
2516 echo html_writer::end_tag('div'); // End of coursebox div
c2cb4545 2517}
2518
cb6fec1f 2519/**
2520 * Prints custom user information on the home page.
2521 * Over time this can include all sorts of information
2522 */
c2cb4545 2523function print_my_moodle() {
e6db3026 2524 global $USER, $CFG, $DB, $OUTPUT;
c2cb4545 2525
4f0c2d00 2526 if (!isloggedin() or isguestuser()) {
ba6018a9 2527 print_error('nopermissions', '', '', 'See My Moodle');
c2cb4545 2528 }
2529
df997f84 2530 $courses = enrol_get_my_courses('summary', 'visible DESC,sortorder ASC');
0a127169 2531 $rhosts = array();
2532 $rcourses = array();
2533 if (!empty($CFG->mnet_dispatcher_mode) && $CFG->mnet_dispatcher_mode==='strict') {
2534 $rcourses = get_my_remotecourses($USER->id);
2535 $rhosts = get_my_remotehosts();
2536 }
2537
2538 if (!empty($courses) || !empty($rcourses) || !empty($rhosts)) {
2539
2540 if (!empty($courses)) {
2541 echo '<ul class="unlist">';
2542 foreach ($courses as $course) {
2543 if ($course->id == SITEID) {
2544 continue;
2545 }
2546 echo '<li>';
2547 print_course($course);
2548 echo "</li>\n";
86dd62a7 2549 }
0a127169 2550 echo "</ul>\n";
86dd62a7 2551 }
2552
0a127169 2553 // MNET
2554 if (!empty($rcourses)) {
2555 // at the IDP, we know of all the remote courses
2556 foreach ($rcourses as $course) {
2557 print_remote_course($course, "100%");
2558 }
2559 } elseif (!empty($rhosts)) {
2560 // non-IDP, we know of all the remote servers, but not courses
2561 foreach ($rhosts as $host) {
2562 print_remote_host($host, "100%");
2563 }
2564 }
86dd62a7 2565 unset($course);
0a127169 2566 unset($host);
38a10939 2567
cb6fec1f 2568 if ($DB->count_records("course") > (count($courses) + 1) ) { // Some courses not being displayed
7f989948 2569 echo "<table width=\"100%\"><tr><td align=\"center\">";
2570 print_course_search("", false, "short");
2571 echo "</td><td align=\"center\">";
5c2ed7e2 2572 echo $OUTPUT->single_button("$CFG->wwwroot/course/index.php", get_string("fulllistofcourses"), "get");
7f989948 2573 echo "</td></tr></table>\n";
2574 }
86dd62a7 2575
26330001 2576 } else {
cb6fec1f 2577 if ($DB->count_records("course_categories") > 1) {
e6db3026 2578 echo $OUTPUT->box_start("categorybox");
26330001 2579 print_whole_category_list();
e6db3026 2580 echo $OUTPUT->box_end();
26330001 2581 } else {
35d0244a 2582 print_courses(0);
26330001 2583 }
607809b3 2584 }
2b8cef80 2585}
2586
11b0c469 2587
a8b56716 2588function print_course_search($value="", $return=false, $format="plain") {
38a10939 2589 global $CFG;
1e0fb105 2590 static $count = 0;
2591
2592 $count++;
2593
2594 $id = 'coursesearch';
2595
2596 if ($count > 1) {
2597 $id .= $count;
2598 }
38a10939 2599
2600 $strsearchcourses= get_string("searchcourses");
2601
1c919752 2602 if ($format == 'plain') {
1e0fb105 2603 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
fcf9577a 2604 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
e42f4d92 2605 $output .= '<label for="coursesearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2606 $output .= '<input type="text" id="coursesearchbox" size="30" name="search" value="'.s($value).'" />';
e42f4d92 2607 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2608 $output .= '</fieldset></form>';
1c919752 2609 } else if ($format == 'short') {
1e0fb105 2610 $output = '<form id="'.$id.'" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
fcf9577a 2611 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
b1f97418 2612 $output .= '<label for="shortsearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2613 $output .= '<input type="text" id="shortsearchbox" size="12" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
e42f4d92 2614 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2615 $output .= '</fieldset></form>';
1c919752 2616 } else if ($format == 'navbar') {
fcf9577a 2617 $output = '<form id="coursesearchnavbar" action="'.$CFG->wwwroot.'/course/search.php" method="get">';
2618 $output .= '<fieldset class="coursesearchbox invisiblefieldset">';
b1f97418 2619 $output .= '<label for="navsearchbox">'.$strsearchcourses.': </label>';
cb6fec1f 2620 $output .= '<input type="text" id="navsearchbox" size="20" name="search" alt="'.s($strsearchcourses).'" value="'.s($value).'" />';
e42f4d92 2621 $output .= '<input type="submit" value="'.get_string('go').'" />';
fcf9577a 2622 $output .= '</fieldset></form>';
a8b56716 2623 }
2624
2625 if ($return) {
2626 return $output;
2627 }
2628 echo $output;
38a10939 2629}
11b0c469 2630
86dd62a7 2631function print_remote_course($course, $width="100%") {
86dd62a7 2632 global $CFG, $USER;
2633
2634 $linkcss = '';
2635
2636 $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
2637
7cd266e9 2638 echo '<div class="coursebox remotecoursebox clearfix">';
86dd62a7 2639 echo '<div class="info">';
2640 echo '<div class="name"><a title="'.get_string('entercourse').'"'.
2641 $linkcss.' href="'.$url.'">'
6ba65fa0 2642 . format_string($course->fullname) .'</a><br />'
2643 . format_string($course->hostname) . ' : '
238c0dd9 2644 . format_string($course->cat_name) . ' : '
2645 . format_string($course->shortname). '</div>';
86dd62a7 2646 echo '</div><div class="summary">';
b85b25eb 2647 $options = new stdClass();
86dd62a7 2648 $options->noclean = true;
2649 $options->para = false;
367a75fa 2650 $options->overflowdiv = true;
152a2273 2651 echo format_text($course->summary, $course->summaryformat, $options);
86dd62a7 2652 echo '</div>';
2653 echo '</div>';
86dd62a7 2654}
2655
643b67b8 2656function print_remote_host($host, $width="100%") {
6b608f8f 2657 global $OUTPUT;
643b67b8 2658
2659 $linkcss = '';
2660
7cd266e9 2661 echo '<div class="coursebox clearfix">';
643b67b8 2662 echo '<div class="info">';
2663 echo '<div class="name">';
b5d0cafc 2664 echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
643b67b8 2665 echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
2666 . s($host['name']).'</a> - ';
1fd80ad3 2667 echo $host['count'] . ' ' . get_string('courses');
643b67b8 2668 echo '</div>';
2669 echo '</div>';
caa90d56 2670 echo '</div>';
643b67b8 2671}
2672
86dd62a7 2673
11b0c469 2674/// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
2675
2676function add_course_module($mod) {
cb6fec1f 2677 global $DB;
11b0c469 2678
e5dfd0f3 2679 $mod->added = time();
53f4ad2c 2680 unset($mod->id);
11b0c469 2681
38b19bbc
MG
2682 $cmid = $DB->insert_record("course_modules", $mod);
2683 rebuild_course_cache($mod->course, true);
2684 return $cmid;
11b0c469 2685}
2686
97928ddf 2687/**
4ede27b2 2688 * Creates missing course section(s) and rebuilds course cache
99e9f9a6 2689 *
b46be6ad 2690 * @param int|stdClass $courseorid course id or course object
4ede27b2
MG
2691 * @param int|array $sections list of relative section numbers to create
2692 * @return bool if there were any sections created
97928ddf 2693 */
b46be6ad 2694function course_create_sections_if_missing($courseorid, $sections) {
cb6fec1f 2695 global $DB;
4ede27b2
MG
2696 if (!is_array($sections)) {
2697 $sections = array($sections);
2698 }
b46be6ad
MG
2699 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
2700 if (is_object($courseorid)) {
2701 $courseorid = $courseorid->id;
2702 }
4ede27b2
MG
2703 $coursechanged = false;
2704 foreach ($sections as $sectionnum) {
2705 if (!in_array($sectionnum, $existing)) {
2706 $cw = new stdClass();
b46be6ad 2707 $cw->course = $courseorid;
4ede27b2
MG
2708 $cw->section = $sectionnum;
2709 $cw->summary = '';
2710 $cw->summaryformat = FORMAT_HTML;
2711 $cw->sequence = '';
2712 $id = $DB->insert_record("course_sections", $cw);
2713 $coursechanged = true;
2714 }
2715 }
2716 if ($coursechanged) {
b46be6ad 2717 rebuild_course_cache($courseorid, true);
4ede27b2
MG
2718 }
2719 return $coursechanged;
97928ddf 2720}
52f14061 2721
ece966f0 2722/**
722e6ba9 2723 * Adds an existing module to the section
ece966f0 2724 *
722e6ba9
MG
2725 * Updates both tables {course_sections} and {course_modules}
2726 *
2727 * @param int|stdClass $courseorid course id or course object
46453565 2728 * @param int $cmid id of the module already existing in course_modules table
722e6ba9
MG
2729 * @param int $sectionnum relative number of the section (field course_sections.section)
2730 * If section does not exist it will be created
2731 * @param int|stdClass $beforemod id or object with field id corresponding to the module
2732 * before which the module needs to be included. Null for inserting in the
2733 * end of the section
2734 * @return int The course_sections ID where the module is inserted
ece966f0 2735 */
46453565 2736function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
722e6ba9
MG
2737 global $DB, $COURSE;
2738 if (is_object($beforemod)) {
2739 $beforemod = $beforemod->id;
2740 }
46453565
PS
2741 if (is_object($courseorid)) {
2742 $courseid = $courseorid->id;
2743 } else {
2744 $courseid = $courseorid;
2745 }
b46be6ad 2746 course_create_sections_if_missing($courseorid, $sectionnum);
46453565
PS
2747 // Do not try to use modinfo here, there is no guarantee it is valid!
2748 $section = $DB->get_record('course_sections', array('course'=>$courseid, 'section'=>$sectionnum), '*', MUST_EXIST);
722e6ba9 2749 $modarray = explode(",", trim($section->sequence));
281d730e 2750 if (empty($section->sequence)) {
46453565 2751 $newsequence = "$cmid";
722e6ba9 2752 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
46453565 2753 $insertarray = array($cmid, $beforemod);
722e6ba9
MG
2754 array_splice($modarray, $key[0], 1, $insertarray);
2755 $newsequence = implode(",", $modarray);
2756 } else {
46453565 2757 $newsequence = "$section->sequence,$cmid";
722e6ba9
MG
2758 }
2759 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
46453565 2760 $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
b46be6ad
MG
2761 if (is_object($courseorid)) {
2762 rebuild_course_cache($courseorid->id, true);
2763 } else {
2764 rebuild_course_cache($courseorid, true);
2765 }
722e6ba9 2766 return $section->id; // Return course_sections ID that was used.
11b0c469 2767}
2768
48e535bc 2769function set_coursemodule_groupmode($id, $groupmode) {
cb6fec1f 2770 global $DB;
38b19bbc
MG
2771 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
2772 if ($cm->groupmode != $groupmode) {
2773 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
2774 rebuild_course_cache($cm->course, true);
2775 }
2776 return ($cm->groupmode != $groupmode);
3d575e6f 2777}
2778
177d4abf 2779function set_coursemodule_idnumber($id, $idnumber) {
cb6fec1f 2780 global $DB;
38b19bbc
MG
2781 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
2782 if ($cm->idnumber != $idnumber) {
2783 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
2784 rebuild_course_cache($cm->course, true);
2785 }
2786 return ($cm->idnumber != $idnumber);
177d4abf 2787}
4e781c7b 2788
02f66c42 2789/**
00a34234
FM
2790 * Set the visibility of a module and inherent properties.
2791 *
2792 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
2793 * has been moved to {@link set_section_visible()} which was the only place from which
2794 * the parameter was used.
2795 *
2796 * @param int $id of the module
2797 * @param int $visible state of the module
2798 * @return bool false when the module was not found, true otherwise
2799 */
2800function set_coursemodule_visible($id, $visible) {
f5e2602a 2801 global $DB, $CFG;
0f078024
DM
2802 require_once($CFG->libdir.'/gradelib.php');
2803
00a34234
FM
2804 // Trigger developer's attention when using the previously removed argument.
2805 if (func_num_args() > 2) {
2806 debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
2807 has been removed.', DEBUG_DEVELOPER);
2808 }
2809
cb6fec1f 2810 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
978abb42 2811 return false;
2812 }
cb6fec1f 2813 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
978abb42 2814 return false;
2815 }
cb6fec1f 2816 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 2817 foreach($events as $event) {
48e535bc 2818 if ($visible) {
2819 show_event($event);
2820 } else {
2821 hide_event($event);
2822 }
dcd338ff 2823 }
2824 }
f5e2602a 2825
0f078024
DM
2826 // hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there
2827 $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
2828 if ($grade_items) {
2829 foreach ($grade_items as $grade_item) {
2830 $grade_item->set_hidden(!$visible);
2831 }
f5e2602a 2832 }
f685e830 2833
00a34234
FM
2834 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
2835 // affect visibleold to allow for an original visibility restore. See set_section_visible().
2836 $cminfo = new stdClass();
2837 $cminfo->id = $id;
2838 $cminfo->visible = $visible;
2839 $cminfo->visibleold = $visible;
2840 $DB->update_record('course_modules', $cminfo);
2841
38b19bbc
MG
2842 rebuild_course_cache($cm->course, true);
2843 return true;
1acfbce5 2844}
2845
cb6fec1f 2846/**
290130b3 2847 * Delete a course module and any associated data at the course level (events)
264867fd 2848 * Until 1.5 this function simply marked a deleted flag ... now it
290130b3 2849 * deletes it completely.
2850 *
2851 */
48e535bc 2852function delete_course_module($id) {
cb6fec1f 2853 global $CFG, $DB;
f615fbab 2854 require_once($CFG->libdir.'/gradelib.php');
cae83708 2855 require_once($CFG->dirroot.'/blog/lib.php');
f615fbab 2856
cb6fec1f 2857 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
290130b3 2858 return true;
2859 }
cb6fec1f 2860 $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
f615fbab 2861 //delete events from calendar
cb6fec1f 2862 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 2863 foreach($events as $event) {
0ea03696 2864 delete_event($event->id);
dcd338ff 2865 }
2866 }
f615fbab 2867 //delete grade items, outcome items and grades attached to modules
2868 if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2869 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2870 foreach ($grade_items as $grade_item) {
2871 $grade_item->delete('moddelete');
2872 }
f615fbab 2873 }
46e12372
SM
2874 // Delete completion and availability data; it is better to do this even if the
2875 // features are not turned on, in case they were turned on previously (these will be
2876 // very quick on an empty table)
2877 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2878 $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
a8f84c28 2879 $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
ede323e2
ARN
2880 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2881 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
06b3a6b2 2882
2883 delete_context(CONTEXT_MODULE, $cm->id);
38b19bbc
MG
2884 $DB->delete_records('course_modules', array('id'=>$cm->id));
2885 rebuild_course_cache($cm->course, true);
2886 return true;
11b0c469 2887}
2888
722e6ba9 2889function delete_mod_from_section($modid, $sectionid) {
cb6fec1f 2890 global $DB;
11b0c469 2891
722e6ba9 2892 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
11b0c469 2893
e5dfd0f3 2894 $modarray = explode(",", $section->sequence);
11b0c469 2895
722e6ba9 2896 if ($key = array_keys ($modarray, $modid)) {
11b0c469 2897 array_splice($modarray, $key[0], 1);
2898 $newsequence = implode(",", $modarray);
38b19bbc
MG
2899 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
2900 rebuild_course_cache($section->course, true);
2901 return true;
11b0c469 2902 } else {
2903 return false;
2904 }
89adb174 2905
11b0c469 2906 }
7977cffd 2907 return false;
11b0c469 2908}
2909
3440ec12 2910/**
2911 * Moves a section up or down by 1. CANNOT BE USED DIRECTLY BY AJAX!
2912 *
93d46f48
RK
2913 * @param object $course course object
2914 * @param int $section Section number (not id!!!)
3440ec12 2915 * @param int $move (-1 or 1)
93d46f48 2916 * @return boolean true if section moved successfully
ac5f6414 2917 * @todo MDL-33379 remove this function in 2.5
3440ec12 2918 */
12905134 2919function move_section($course, $section, $move) {
ac5f6414
RT
2920 debugging('This function will be removed before 2.5 is released please use move_section_to', DEBUG_DEVELOPER);
2921
12905134 2922/// Moves a whole course section up and down within the course
38b19bbc 2923 global $USER;
12905134 2924
2925 if (!$move) {
2926 return true;
2927 }
2928
2929 $sectiondest = $section + $move;
2930
850acb35
MG
2931 // compartibility with course formats using field 'numsections'
2932 $courseformatoptions = course_get_format($course)->get_format_options();
2933 if (array_key_exists('numsections', $courseformatoptions) &&
2934 $sectiondest > $courseformatoptions['numsections'] or $sectiondest < 1) {
12905134 2935 return false;
2936 }
2937
eb01aa2c 2938 $retval = move_section_to($course, $section, $sectiondest);
eb01aa2c 2939 return $retval;
12905134 2940}
2941
3440ec12 2942/**
2943 * Moves a section within a course, from a position to another.
2944 * Be very careful: $section and $destination refer to section number,
2945 * not id!.
2946 *
2947 * @param object $course
2948 * @param int $section Section number (not id!!!)
2949 * @param int $destination
2950 * @return boolean Result
2951 */
2952function move_section_to($course, $section, $destination) {
2953/// Moves a whole course section up and down within the course
2954 global $USER, $DB;
2955
ca255392 2956 if (!$destination && $destination != 0) {
3440ec12 2957 return true;
2958 }
2959
850acb35
MG
2960 // compartibility with course formats using field 'numsections'
2961 $courseformatoptions = course_get_format($course)->get_format_options();
2962 if ((array_key_exists('numsections', $courseformatoptions) &&
2963 ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
3440ec12 2964 return false;
2965 }
2966
2967 // Get all sections for this course and re-order them (2 of them should now share the same section number)
2968 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
2969 'section ASC, id ASC', 'id, section')) {
2970 return false;
2971 }
2972
cf76b335 2973 $movedsections = reorder_sections($sections, $section, $destination);
3440ec12 2974
cf76b335 2975 // Update all sections. Do this in 2 steps to avoid breaking database
2976 // uniqueness constraint
2977 $transaction = $DB->start_delegated_transaction();
2978 foreach ($movedsections as $id => $position) {
2979 if ($sections[$id] !== $position) {
2980 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
2981 }
2982 }
e7e0f8d2
DP
2983 foreach ($movedsections as $id => $position) {
2984 if ($sections[$id] !== $position) {
2985 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
2986 }
3440ec12 2987 }
2988
15e2552f
RK
2989 // If we move the highlighted section itself, then just highlight the destination.
2990 // Adjust the higlighted section location if we move something over it either direction.
2991 if ($section == $course->marker) {
e7b6e6b9 2992 course_set_marker($course->id, $destination);
2365213f 2993 } elseif ($section > $course->marker && $course->marker >= $destination) {
e7b6e6b9 2994 course_set_marker($course->id, $course->marker+1);
2365213f 2995 } elseif ($section < $course->marker && $course->marker <= $destination) {
e7b6e6b9 2996 course_set_marker($course->id, $course->marker-1);
15e2552f
RK
2997 }
2998
cf76b335 2999 $transaction->allow_commit();
38b19bbc 3000 rebuild_course_cache($course->id, true);
3440ec12 3001 return true;
3002}
3003
3004/**
3005 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
3006 * an original position number and a target position number, rebuilds the array so that the
3007 * move is made without any duplication of section positions.
3008 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
3009 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
3010 *
3011 * @param array $sections
3012 * @param int $origin_position
3013 * @param int $target_position
3014 * @return array
3015 */
3016function reorder_sections($sections, $origin_position, $target_position) {
3017 if (!is_array($sections)) {
3018 return false;
3019 }
3020
3021 // We can't move section position 0
3022 if ($origin_position < 1) {
3023 echo "We can't move section position 0";
3024 return false;
3025 }
3026
3027 // Locate origin section in sections array
3028 if (!$origin_key = array_search($origin_position, $sections)) {
3029 echo "searched position not in sections array";
3030 return false; // searched position not in sections array
3031 }
3032
3033 // Extract origin section
3034 $origin_section = $sections[$origin_key];
3035 unset($sections[$origin_key]);
3036
3037 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
3038 $found = false;
3039 $append_array = array();
3040 foreach ($sections as $id => $position) {
3041 if ($found) {
3042 $append_array[$id] = $position;
3043 unset($sections[$id]);
3044 }
3045 if ($position == $target_position) {
eb01aa2c
RT
3046 if ($target_position < $origin_position) {
3047 $append_array[$id] = $position;
3048 unset($sections[$id]);
3049 }
3440ec12 3050 $found = true;
3051 }
3052 }
3053
3054 // Append moved section
3055 $sections[$origin_key] = $origin_section;
3056
3057 // Append rest of array (if applicable)
3058 if (!empty($append_array)) {
3059 foreach ($append_array as $id => $position) {
3060 $sections[$id] = $position;
3061 }
3062 }
3063
3064 // Renumber positions
3065 $position = 0;
3066 foreach ($sections as $id => $p) {
3067 $sections[$id] = $position;
3068 $position++;
3069 }
3070
3071 return $sections;
3072
3073}
3074
cb6fec1f 3075/**
3076 * Move the module object $mod to the specified $section
3077 * If $beforemod exists then that is the module
3078 * before which $modid should be inserted
3079 * All parameters are objects
3080 */
7977cffd 3081function moveto_module($mod, $section, $beforemod=NULL) {
38b19bbc 3082 global $OUTPUT;
7977cffd 3083
3084/// Remove original module from original section
7977cffd 3085 if (! delete_mod_from_section($mod->id, $mod->section)) {
e6db3026 3086 echo $OUTPUT->notification("Could not delete module from existing section");
7977cffd 3087 }
3088
722e6ba9
MG
3089 // if moving to a hidden section then hide module
3090 if (!$section->visible && $mod->visible) {
3091 set_coursemodule_visible($mod->id, 0);
7977cffd 3092 }
3093
3094/// Add the module into the new section
722e6ba9 3095 course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
7977cffd 3096 return true;
7977cffd 3097}
3098
7749e187
SH
3099/**
3100 * Produces the editing buttons for a module
3101 *
3102 * @global core_renderer $OUTPUT
3103 * @staticvar type $str
3104 * @param stdClass $mod The module to produce editing buttons for
f558b291
MG
3105 * @param bool $absolute_ignored (argument ignored) - all links are absolute
3106 * @param bool $moveselect (argument ignored)
7749e187
SH
3107 * @param int $indent The current indenting
3108 * @param int $section The section to link back to
3109 * @return string XHTML for the editing buttons
3110 */
923451c5 3111function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
f558b291
MG
3112 global $PAGE;
3113 if (!($mod instanceof cm_info)) {
3114 $modinfo = get_fast_modinfo($mod->course);
3115 $mod = $modinfo->get_cm($mod->id);
3116 }
3117 $actions = course_get_cm_edit_actions($mod, $indent, $section);
3118
3119 $courserenderer = $PAGE->get_renderer('core', 'course');
3120 // The space added before the <span> is a ugly hack but required to set the CSS property white-space: nowrap
3121 // and having it to work without attaching the preceding text along with it. Hopefully the refactoring of
3122 // the course page HTML will allow this to be removed.
3123 return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
3124}
3125
3126/**
3127 * Returns the list of all editing actions that current user can perform on the module
3128 *
3129 * @param cm_info $mod The module to produce editing buttons for
3130 * @param int $indent The current indenting (default -1 means no move left-right actions