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