MDL-52252 Tags: Add tags to modules (Resources and Activities)
[moodle.git] / course / lib.php
CommitLineData
d9cb06dc 1<?php
d9cb06dc 2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Library of useful functions
19 *
20 * @copyright 1999 Martin Dougiamas http://dougiamas.com
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5dc361e1 22 * @package core_course
d9cb06dc 23 */
f9903ed0 24
df997f84
PS
25defined('MOODLE_INTERNAL') || die;
26
4e781c7b 27require_once($CFG->libdir.'/completionlib.php');
8bdc9cac 28require_once($CFG->libdir.'/filelib.php');
ee7084e9 29require_once($CFG->dirroot.'/course/format/lib.php');
f9903ed0 30
5dc361e1
SH
31define('COURSE_MAX_LOGS_PER_PAGE', 1000); // Records.
32define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds.
3b7bfbb5
FM
33
34/**
35 * Number of courses to display when summaries are included.
36 * @var int
37 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
38 */
39define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
40
5dc361e1
SH
41// Max courses in log dropdown before switching to optional.
42define('COURSE_MAX_COURSES_PER_DROPDOWN', 1000);
43// Max users in log dropdown before switching to optional.
44define('COURSE_MAX_USERS_PER_DROPDOWN', 1000);
45define('FRONTPAGENEWS', '0');
5dc361e1 46define('FRONTPAGECATEGORYNAMES', '2');
5dc361e1 47define('FRONTPAGECATEGORYCOMBO', '4');
0fd26350 48define('FRONTPAGEENROLLEDCOURSELIST', '5');
5dc361e1
SH
49define('FRONTPAGEALLCOURSELIST', '6');
50define('FRONTPAGECOURSESEARCH', '7');
51// Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage.
6f24e48e 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':
95d1d037 70 case 'category':
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;
e662454a
AA
78 case 'calendar':
79 $url = "/calendar/$url";
80 break;
01d5d399 81 case 'user':
bd7be234 82 case 'blog':
11003188 83 $url = "/$module/$url";
600149be 84 break;
bd7be234 85 case 'upload':
11003188 86 $url = $url;
c80b7585 87 break;
38fb8190 88 case 'coursetags':
11003188 89 $url = '/'.$url;
38fb8190 90 break;
bd7be234 91 case 'library':
92 case '':
11003188 93 $url = '/';
de2dfe68 94 break;
4597d533 95 case 'message':
11003188 96 $url = "/message/$url";
97 break;
98 case 'notes':
99 $url = "/notes/$url";
4597d533 100 break;
b89e4ad8 101 case 'tag':
102 $url = "/tag/$url";
103 break;
dbcf271b 104 case 'role':
105 $url = '/'.$url;
106 break;
afd2efc0
AD
107 case 'grade':
108 $url = "/grade/$url";
109 break;
600149be 110 default:
11003188 111 $url = "/mod/$module/$url";
600149be 112 break;
113 }
11003188 114
115 //now let's sanitise urls - there might be some ugly nasties:-(
116 $parts = explode('?', $url);
117 $script = array_shift($parts);
118 if (strpos($script, 'http') === 0) {
119 $script = clean_param($script, PARAM_URL);
120 } else {
121 $script = clean_param($script, PARAM_PATH);
122 }
123
124 $query = '';
125 if ($parts) {
126 $query = implode('', $parts);
127 $query = str_replace('&amp;', '&', $query); // both & and &amp; are stored in db :-|
128 $parts = explode('&', $query);
129 $eq = urlencode('=');
130 foreach ($parts as $key=>$part) {
131 $part = urlencode(urldecode($part));
132 $part = str_replace($eq, '=', $part);
133 $parts[$key] = $part;
134 }
135 $query = '?'.implode('&amp;', $parts);
136 }
137
138 return $script.$query;
600149be 139}
140
92890025 141
c215b32b 142function build_mnet_logs_array($hostid, $course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
143 $modname="", $modid=0, $modaction="", $groupid=0) {
cb6fec1f 144 global $CFG, $DB;
c215b32b 145
146 // It is assumed that $date is the GMT time of midnight for that day,
147 // and so the next 86400 seconds worth of logs are printed.
148
149 /// Setup for group handling.
238c0dd9 150
151 // TODO: I don't understand group/context/etc. enough to be able to do
c215b32b 152 // something interesting with it here
153 // What is the context of a remote course?
238c0dd9 154
c215b32b 155 /// If the group mode is separate, and this user does not have editing privileges,
156 /// then only the user's group can be viewed.
9a5e297b 157 //if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
c215b32b 158 // $groupid = get_current_group($course->id);
159 //}
160 /// If this course doesn't have groups, no groupid can be specified.
161 //else if (!$course->groupmode) {
162 // $groupid = 0;
163 //}
cb6fec1f 164
c215b32b 165 $groupid = 0;
166
167 $joins = array();
92701024 168 $where = '';
c215b32b 169
cb6fec1f 170 $qry = "SELECT l.*, u.firstname, u.lastname, u.picture
171 FROM {mnet_log} l
172 LEFT JOIN {user} u ON l.userid = u.id
173 WHERE ";
174 $params = array();
175
176 $where .= "l.hostid = :hostid";
177 $params['hostid'] = $hostid;
c215b32b 178
179 // TODO: Is 1 really a magic number referring to the sitename?
cb6fec1f 180 if ($course != SITEID || $modid != 0) {
181 $where .= " AND l.course=:courseid";
182 $params['courseid'] = $course;
c215b32b 183 }
184
185 if ($modname) {
cb6fec1f 186 $where .= " AND l.module = :modname";
187 $params['modname'] = $modname;
c215b32b 188 }
189
190 if ('site_errors' === $modid) {
cb6fec1f 191 $where .= " AND ( l.action='error' OR l.action='infected' )";
c215b32b 192 } else if ($modid) {
238c0dd9 193 //TODO: This assumes that modids are the same across sites... probably
c215b32b 194 //not true
cb6fec1f 195 $where .= " AND l.cmid = :modid";
196 $params['modid'] = $modid;
c215b32b 197 }
198
199 if ($modaction) {
200 $firstletter = substr($modaction, 0, 1);
8086b083 201 if ($firstletter == '-') {
47586394 202 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false, true, true);
8086b083
PS
203 $params['modaction'] = '%'.substr($modaction, 1).'%';
204 } else {
205 $where .= " AND ".$DB->sql_like('l.action', ':modaction', false);
206 $params['modaction'] = '%'.$modaction.'%';
c215b32b 207 }
208 }
209
210 if ($user) {
cb6fec1f 211 $where .= " AND l.userid = :user";
212 $params['user'] = $user;
c215b32b 213 }
214
215 if ($date) {
216 $enddate = $date + 86400;
cb6fec1f 217 $where .= " AND l.time > :date AND l.time < :enddate";
218 $params['date'] = $date;
219 $params['enddate'] = $enddate;
c215b32b 220 }
221
222 $result = array();
cb6fec1f 223 $result['totalcount'] = $DB->count_records_sql("SELECT COUNT('x') FROM {mnet_log} l WHERE $where", $params);
c215b32b 224 if(!empty($result['totalcount'])) {
cb6fec1f 225 $where .= " ORDER BY $order";
226 $result['logs'] = $DB->get_records_sql("$qry $where", $params, $limitfrom, $limitnum);
c215b32b 227 } else {
228 $result['logs'] = array();
229 }
230 return $result;
231}
232
92890025 233function build_logs_array($course, $user=0, $date=0, $order="l.time ASC", $limitfrom='', $limitnum='',
234 $modname="", $modid=0, $modaction="", $groupid=0) {
d5abe1b5 235 global $DB, $SESSION, $USER;
e0161bff 236 // It is assumed that $date is the GMT time of midnight for that day,
237 // and so the next 86400 seconds worth of logs are printed.
f9903ed0 238
69c76405 239 /// Setup for group handling.
264867fd 240
69c76405 241 /// If the group mode is separate, and this user does not have editing privileges,
242 /// then only the user's group can be viewed.
9a5e297b 243 if ($course->groupmode == SEPARATEGROUPS and !has_capability('moodle/course:managegroups', context_course::instance($course->id))) {
928d4738 244 if (isset($SESSION->currentgroup[$course->id])) {
245 $groupid = $SESSION->currentgroup[$course->id];
246 } else {
247 $groupid = groups_get_all_groups($course->id, $USER->id);
248 if (is_array($groupid)) {
249 $groupid = array_shift(array_keys($groupid));
250 $SESSION->currentgroup[$course->id] = $groupid;
251 } else {
252 $groupid = 0;
253 }
254 }
69c76405 255 }
256 /// If this course doesn't have groups, no groupid can be specified.
257 else if (!$course->groupmode) {
258 $groupid = 0;
259 }
260
e0161bff 261 $joins = array();
18f8a34f 262 $params = array();
a2ab3b05 263
e15ef260 264 if ($course->id != SITEID || $modid != 0) {
c3df0901 265 $joins[] = "l.course = :courseid";
266 $params['courseid'] = $course->id;
e15ef260 267 }
f9903ed0 268
c469a7ef 269 if ($modname) {
c3df0901 270 $joins[] = "l.module = :modname";
238c0dd9 271 $params['modname'] = $modname;
f24cffb9 272 }
273
e21922f0 274 if ('site_errors' === $modid) {
bf35eb15 275 $joins[] = "( l.action='error' OR l.action='infected' )";
e21922f0 276 } else if ($modid) {
c3df0901 277 $joins[] = "l.cmid = :modid";
278 $params['modid'] = $modid;
69d79bc3 279 }
280
281 if ($modaction) {
ee35e0b8 282 $firstletter = substr($modaction, 0, 1);
8086b083 283 if ($firstletter == '-') {
47586394 284 $joins[] = $DB->sql_like('l.action', ':modaction', false, true, true);
c3df0901 285 $params['modaction'] = '%'.substr($modaction, 1).'%';
8086b083
PS
286 } else {
287 $joins[] = $DB->sql_like('l.action', ':modaction', false);
288 $params['modaction'] = '%'.$modaction.'%';
ee35e0b8 289 }
f24cffb9 290 }
291
238c0dd9 292
69c76405 293 /// Getting all members of a group.
294 if ($groupid and !$user) {
62d63838 295 if ($gusers = groups_get_members($groupid)) {
296 $gusers = array_keys($gusers);
1e95d7b7 297 $joins[] = 'l.userid IN (' . implode(',', $gusers) . ')';
298 } else {
05a33439 299 $joins[] = 'l.userid = 0'; // No users in groups, so we want something that will always be false.
69c76405 300 }
301 }
302 else if ($user) {
c3df0901 303 $joins[] = "l.userid = :userid";
304 $params['userid'] = $user;
f9903ed0 305 }
306
307 if ($date) {
308 $enddate = $date + 86400;
c3df0901 309 $joins[] = "l.time > :date AND l.time < :enddate";
310 $params['date'] = $date;
311 $params['enddate'] = $enddate;
f9903ed0 312 }
313
1e95d7b7 314 $selector = implode(' AND ', $joins);
e0161bff 315
d09f3c80 316 $totalcount = 0; // Initialise
92890025 317 $result = array();
c3df0901 318 $result['logs'] = get_logs($selector, $params, $order, $limitfrom, $limitnum, $totalcount);
92890025 319 $result['totalcount'] = $totalcount;
320 return $result;
321}
264867fd 322
323
92890025 324function print_log($course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
325 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
264867fd 326
d60c1124 327 global $CFG, $DB, $OUTPUT;
264867fd 328
92890025 329 if (!$logs = build_logs_array($course, $user, $date, $order, $page*$perpage, $perpage,
330 $modname, $modid, $modaction, $groupid)) {
e6db3026 331 echo $OUTPUT->notification("No logs found!");
d60c1124 332 echo $OUTPUT->footer();
f9903ed0 333 exit;
334 }
264867fd 335
ea49a66c 336 $courses = array();
337
92890025 338 if ($course->id == SITEID) {
339 $courses[0] = '';
bf221aca 340 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
92890025 341 foreach ($ccc as $cc) {
bf221aca 342 $courses[$cc->id] = $cc->shortname;
92890025 343 }
344 }
ea49a66c 345 } else {
bf221aca 346 $courses[$course->id] = $course->shortname;
92890025 347 }
264867fd 348
92890025 349 $totalcount = $logs['totalcount'];
f9903ed0 350 $count=0;
2eb68e6f 351 $ldcache = array();
f9903ed0 352 $tt = getdate(time());
353 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
1c0200e0 354
dcde9f02 355 $strftimedatetime = get_string("strftimedatetime");
356
5577ceb3 357 echo "<div class=\"info\">\n";
519d369f 358 print_string("displayingrecords", "", $totalcount);
5577ceb3 359 echo "</div>\n";
1c0200e0 360
929d7a83 361 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
519d369f 362
337203a4 363 $table = new html_table();
eb610eb9 364 $table->classes = array('logtable','generaltable');
337203a4
SH
365 $table->align = array('right', 'left', 'left');
366 $table->head = array(
367 get_string('time'),
368 get_string('ip_address'),
af27c69e 369 get_string('fullnameuser'),
337203a4
SH
370 get_string('action'),
371 get_string('info')
372 );
373 $table->data = array();
1b048629 374
1548978d 375 if ($course->id == SITEID) {
337203a4
SH
376 array_unshift($table->align, 'left');
377 array_unshift($table->head, get_string('course'));
1548978d 378 }
1548978d 379
1e95d7b7 380 // Make sure that the logs array is an array, even it is empty, to avoid warnings from the foreach.
2b2d182a 381 if (empty($logs['logs'])) {
1e95d7b7 382 $logs['logs'] = array();
2b2d182a 383 }
238c0dd9 384
92890025 385 foreach ($logs['logs'] as $log) {
600149be 386
2eb68e6f 387 if (isset($ldcache[$log->module][$log->action])) {
388 $ld = $ldcache[$log->module][$log->action];
389 } else {
cb6fec1f 390 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
2eb68e6f 391 $ldcache[$log->module][$log->action] = $ld;
392 }
edf3ef00 393 if ($ld && is_numeric($log->info)) {
181b888e 394 // ugly hack to make sure fullname is shown correctly
337203a4 395 if ($ld->mtable == 'user' && $ld->field == $DB->sql_concat('firstname', "' '" , 'lastname')) {
cb6fec1f 396 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
181b888e 397 } else {
cb6fec1f 398 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
181b888e 399 }
600149be 400 }
401
264867fd 402 //Filter log->info
c8b0a50b 403 $log->info = format_string($log->info);
404
6c5a2108 405 // If $log->url has been trimmed short by the db size restriction
406 // code in add_to_log, keep a note so we don't add a link to a broken url
2f1e464a 407 $brokenurl=(core_text::strlen($log->url)==100 && core_text::substr($log->url,97)=='...');
6c5a2108 408
337203a4 409 $row = array();
1548978d 410 if ($course->id == SITEID) {
bd5d0ce5 411 if (empty($log->course)) {
337203a4 412 $row[] = get_string('site');
bd5d0ce5 413 } else {
337203a4 414 $row[] = "<a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">". format_string($courses[$log->course])."</a>";
bd5d0ce5 415 }
720a43ce 416 }
1b048629 417
337203a4 418 $row[] = userdate($log->time, '%a').' '.userdate($log->time, $strftimedatetime);
1b048629 419
75015e5f
PS
420 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
421 $row[] = $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 440, 'width' => 700)));
337203a4 422
9a5e297b 423 $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 424
6c5a2108 425 $displayaction="$log->module $log->action";
337203a4
SH
426 if ($brokenurl) {
427 $row[] = $displayaction;
6c5a2108 428 } else {
75015e5f
PS
429 $link = make_log_url($log->module,$log->url);
430 $row[] = $OUTPUT->action_link($link, $displayaction, new popup_action('click', $link, 'fromloglive'), array('height' => 440, 'width' => 700));
6c5a2108 431 }
337203a4 432 $row[] = $log->info;
755ee6d8 433 $table->data[] = $row;
f9903ed0 434 }
519d369f 435
16be8974 436 echo html_writer::table($table);
929d7a83 437 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
f9903ed0 438}
439
440
c215b32b 441function print_mnet_log($hostid, $course, $user=0, $date=0, $order="l.time ASC", $page=0, $perpage=100,
442 $url="", $modname="", $modid=0, $modaction="", $groupid=0) {
238c0dd9 443
d60c1124 444 global $CFG, $DB, $OUTPUT;
238c0dd9 445
c215b32b 446 if (!$logs = build_mnet_logs_array($hostid, $course, $user, $date, $order, $page*$perpage, $perpage,
447 $modname, $modid, $modaction, $groupid)) {
e6db3026 448 echo $OUTPUT->notification("No logs found!");
d60c1124 449 echo $OUTPUT->footer();
c215b32b 450 exit;
451 }
238c0dd9 452
c215b32b 453 if ($course->id == SITEID) {
454 $courses[0] = '';
455 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname,c.visible')) {
456 foreach ($ccc as $cc) {
457 $courses[$cc->id] = $cc->shortname;
458 }
459 }
460 }
238c0dd9 461
c215b32b 462 $totalcount = $logs['totalcount'];
463 $count=0;
464 $ldcache = array();
465 $tt = getdate(time());
466 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
467
468 $strftimedatetime = get_string("strftimedatetime");
469
5577ceb3 470 echo "<div class=\"info\">\n";
c215b32b 471 print_string("displayingrecords", "", $totalcount);
5577ceb3 472 echo "</div>\n";
c215b32b 473
929d7a83 474 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
c215b32b 475
5577ceb3 476 echo "<table class=\"logtable\" cellpadding=\"3\" cellspacing=\"0\">\n";
c215b32b 477 echo "<tr>";
478 if ($course->id == SITEID) {
479 echo "<th class=\"c0 header\">".get_string('course')."</th>\n";
480 }
481 echo "<th class=\"c1 header\">".get_string('time')."</th>\n";
482 echo "<th class=\"c2 header\">".get_string('ip_address')."</th>\n";
af27c69e 483 echo "<th class=\"c3 header\">".get_string('fullnameuser')."</th>\n";
c215b32b 484 echo "<th class=\"c4 header\">".get_string('action')."</th>\n";
485 echo "<th class=\"c5 header\">".get_string('info')."</th>\n";
486 echo "</tr>\n";
487
488 if (empty($logs['logs'])) {
489 echo "</table>\n";
490 return;
491 }
492
493 $row = 1;
494 foreach ($logs['logs'] as $log) {
238c0dd9 495
c215b32b 496 $log->info = $log->coursename;
497 $row = ($row + 1) % 2;
498
499 if (isset($ldcache[$log->module][$log->action])) {
500 $ld = $ldcache[$log->module][$log->action];
501 } else {
6bb08163 502 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
c215b32b 503 $ldcache[$log->module][$log->action] = $ld;
504 }
505 if (0 && $ld && !empty($log->info)) {
506 // ugly hack to make sure fullname is shown correctly
cb6fec1f 507 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
508 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
c215b32b 509 } else {
cb6fec1f 510 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
c215b32b 511 }
512 }
513
238c0dd9 514 //Filter log->info
c215b32b 515 $log->info = format_string($log->info);
516
c215b32b 517 echo '<tr class="r'.$row.'">';
518 if ($course->id == SITEID) {
9a5e297b 519 $courseshortname = format_string($courses[$log->course], true, array('context' => context_course::instance(SITEID)));
5577ceb3 520 echo "<td class=\"r$row c0\" >\n";
8ebbb06a 521 echo " <a href=\"{$CFG->wwwroot}/course/view.php?id={$log->course}\">".$courseshortname."</a>\n";
c215b32b 522 echo "</td>\n";
523 }
5577ceb3 524 echo "<td class=\"r$row c1\" align=\"right\">".userdate($log->time, '%a').
c215b32b 525 ' '.userdate($log->time, $strftimedatetime)."</td>\n";
5577ceb3 526 echo "<td class=\"r$row c2\" >\n";
75015e5f
PS
527 $link = new moodle_url("/iplookup/index.php?ip=$log->ip&user=$log->userid");
528 echo $OUTPUT->action_link($link, $log->ip, new popup_action('click', $link, 'iplookup', array('height' => 400, 'width' => 700)));
c215b32b 529 echo "</td>\n";
9a5e297b 530 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', context_course::instance($course->id)));
5577ceb3 531 echo "<td class=\"r$row c3\" >\n";
c215b32b 532 echo " <a href=\"$CFG->wwwroot/user/view.php?id={$log->userid}\">$fullname</a>\n";
533 echo "</td>\n";
5577ceb3 534 echo "<td class=\"r$row c4\">\n";
c215b32b 535 echo $log->action .': '.$log->module;
0e35ba6f 536 echo "</td>\n";
5577ceb3 537 echo "<td class=\"r$row c5\">{$log->info}</td>\n";
c215b32b 538 echo "</tr>\n";
539 }
540 echo "</table>\n";
541
929d7a83 542 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, "$url&perpage=$perpage");
c215b32b 543}
544
545
92890025 546function print_log_csv($course, $user, $date, $order='l.time DESC', $modname,
547 $modid, $modaction, $groupid) {
941c2513 548 global $DB, $CFG;
4068bedb 549
941c2513
AG
550 require_once($CFG->libdir . '/csvlib.class.php');
551
552 $csvexporter = new csv_export_writer('tab');
553
554 $header = array();
555 $header[] = get_string('course');
556 $header[] = get_string('time');
557 $header[] = get_string('ip_address');
558 $header[] = get_string('fullnameuser');
559 $header[] = get_string('action');
560 $header[] = get_string('info');
264867fd 561
954fdb42 562 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
92890025 563 $modname, $modid, $modaction, $groupid)) {
564 return false;
565 }
264867fd 566
ea49a66c 567 $courses = array();
568
92890025 569 if ($course->id == SITEID) {
570 $courses[0] = '';
571 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
572 foreach ($ccc as $cc) {
573 $courses[$cc->id] = $cc->shortname;
574 }
575 }
ea49a66c 576 } else {
577 $courses[$course->id] = $course->shortname;
92890025 578 }
264867fd 579
92890025 580 $count=0;
581 $ldcache = array();
582 $tt = getdate(time());
583 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
584
585 $strftimedatetime = get_string("strftimedatetime");
92890025 586
941c2513
AG
587 $csvexporter->set_filename('logs', '.txt');
588 $title = array(get_string('savedat').userdate(time(), $strftimedatetime));
13a20081 589 $csvexporter->add_data($title);
941c2513 590 $csvexporter->add_data($header);
954fdb42 591
2b2d182a 592 if (empty($logs['logs'])) {
593 return true;
594 }
595
954fdb42 596 foreach ($logs['logs'] as $log) {
597 if (isset($ldcache[$log->module][$log->action])) {
598 $ld = $ldcache[$log->module][$log->action];
599 } else {
6bb08163 600 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
954fdb42 601 $ldcache[$log->module][$log->action] = $ld;
602 }
3186c124 603 if ($ld && is_numeric($log->info)) {
954fdb42 604 // ugly hack to make sure fullname is shown correctly
cb6fec1f 605 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
606 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
954fdb42 607 } else {
cb6fec1f 608 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
954fdb42 609 }
610 }
611
264867fd 612 //Filter log->info
954fdb42 613 $log->info = format_string($log->info);
954fdb42 614 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
954fdb42 615
9a5e297b 616 $coursecontext = context_course::instance($course->id);
8ebbb06a
SH
617 $firstField = format_string($courses[$log->course], true, array('context' => $coursecontext));
618 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
2e4c0d05 619 $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
e85a3412 620 $row = array($firstField, userdate($log->time, $strftimedatetime), $log->ip, $fullname, $log->module.' '.$log->action.' ('.$actionurl.')', $log->info);
941c2513 621 $csvexporter->add_data($row);
954fdb42 622 }
941c2513 623 $csvexporter->download_file();
954fdb42 624 return true;
92890025 625}
626
627
628function print_log_xls($course, $user, $date, $order='l.time DESC', $modname,
629 $modid, $modaction, $groupid) {
264867fd 630
cb6fec1f 631 global $CFG, $DB;
92890025 632
954fdb42 633 require_once("$CFG->libdir/excellib.class.php");
264867fd 634
954fdb42 635 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
92890025 636 $modname, $modid, $modaction, $groupid)) {
637 return false;
638 }
264867fd 639
ea49a66c 640 $courses = array();
641
92890025 642 if ($course->id == SITEID) {
643 $courses[0] = '';
644 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
645 foreach ($ccc as $cc) {
646 $courses[$cc->id] = $cc->shortname;
647 }
648 }
ea49a66c 649 } else {
650 $courses[$course->id] = $course->shortname;
92890025 651 }
264867fd 652
92890025 653 $count=0;
654 $ldcache = array();
655 $tt = getdate(time());
656 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
657
658 $strftimedatetime = get_string("strftimedatetime");
92890025 659
954fdb42 660 $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
4248b15c 661 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
954fdb42 662 $filename .= '.xls';
264867fd 663
92890025 664 $workbook = new MoodleExcelWorkbook('-');
665 $workbook->send($filename);
264867fd 666
954fdb42 667 $worksheet = array();
668 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
af27c69e 669 get_string('fullnameuser'), get_string('action'), get_string('info'));
264867fd 670
954fdb42 671 // Creating worksheets
672 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
0a013367 673 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
75427a82 674 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
954fdb42 675 $worksheet[$wsnumber]->set_column(1, 1, 30);
676 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
677 userdate(time(), $strftimedatetime));
678 $col = 0;
679 foreach ($headers as $item) {
680 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
681 $col++;
682 }
683 }
684
2b2d182a 685 if (empty($logs['logs'])) {
686 $workbook->close();
687 return true;
688 }
689
954fdb42 690 $formatDate =& $workbook->add_format();
691 $formatDate->set_num_format(get_string('log_excel_date_format'));
692
693 $row = FIRSTUSEDEXCELROW;
694 $wsnumber = 1;
695 $myxls =& $worksheet[$wsnumber];
696 foreach ($logs['logs'] as $log) {
697 if (isset($ldcache[$log->module][$log->action])) {
698 $ld = $ldcache[$log->module][$log->action];
699 } else {
cb6fec1f 700 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
954fdb42 701 $ldcache[$log->module][$log->action] = $ld;
702 }
3186c124 703 if ($ld && is_numeric($log->info)) {
954fdb42 704 // ugly hack to make sure fullname is shown correctly
cb6fec1f 705 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
706 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
954fdb42 707 } else {
cb6fec1f 708 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
954fdb42 709 }
710 }
711
712 // Filter log->info
713 $log->info = format_string($log->info);
714 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
715
716 if ($nroPages>1) {
717 if ($row > EXCELROWS) {
718 $wsnumber++;
719 $myxls =& $worksheet[$wsnumber];
720 $row = FIRSTUSEDEXCELROW;
721 }
722 }
264867fd 723
9a5e297b 724 $coursecontext = context_course::instance($course->id);
8ebbb06a
SH
725
726 $myxls->write($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)), '');
5c34c4ba 727 $myxls->write_date($row, 1, $log->time, $formatDate); // write_date() does conversion/timezone support. MDL-14934
954fdb42 728 $myxls->write($row, 2, $log->ip, '');
8ebbb06a 729 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
954fdb42 730 $myxls->write($row, 3, $fullname, '');
e85a3412
JG
731 $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
732 $myxls->write($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')', '');
954fdb42 733 $myxls->write($row, 5, $log->info, '');
264867fd 734
954fdb42 735 $row++;
736 }
737
738 $workbook->close();
ea49a66c 739 return true;
740}
741
742function print_log_ods($course, $user, $date, $order='l.time DESC', $modname,
743 $modid, $modaction, $groupid) {
744
cb6fec1f 745 global $CFG, $DB;
ea49a66c 746
747 require_once("$CFG->libdir/odslib.class.php");
748
749 if (!$logs = build_logs_array($course, $user, $date, $order, '', '',
750 $modname, $modid, $modaction, $groupid)) {
751 return false;
752 }
753
754 $courses = array();
755
756 if ($course->id == SITEID) {
757 $courses[0] = '';
758 if ($ccc = get_courses('all', 'c.id ASC', 'c.id,c.shortname')) {
759 foreach ($ccc as $cc) {
760 $courses[$cc->id] = $cc->shortname;
761 }
762 }
763 } else {
764 $courses[$course->id] = $course->shortname;
765 }
766
767 $count=0;
768 $ldcache = array();
769 $tt = getdate(time());
770 $today = mktime (0, 0, 0, $tt["mon"], $tt["mday"], $tt["year"]);
771
772 $strftimedatetime = get_string("strftimedatetime");
773
774 $nroPages = ceil(count($logs)/(EXCELROWS-FIRSTUSEDEXCELROW+1));
4248b15c 775 $filename = 'logs_'.userdate(time(),get_string('backupnameformat', 'langconfig'),99,false);
ea49a66c 776 $filename .= '.ods';
777
778 $workbook = new MoodleODSWorkbook('-');
779 $workbook->send($filename);
780
781 $worksheet = array();
782 $headers = array(get_string('course'), get_string('time'), get_string('ip_address'),
af27c69e 783 get_string('fullnameuser'), get_string('action'), get_string('info'));
ea49a66c 784
785 // Creating worksheets
786 for ($wsnumber = 1; $wsnumber <= $nroPages; $wsnumber++) {
0a013367 787 $sheettitle = get_string('logs').' '.$wsnumber.'-'.$nroPages;
75427a82 788 $worksheet[$wsnumber] = $workbook->add_worksheet($sheettitle);
ea49a66c 789 $worksheet[$wsnumber]->set_column(1, 1, 30);
790 $worksheet[$wsnumber]->write_string(0, 0, get_string('savedat').
791 userdate(time(), $strftimedatetime));
792 $col = 0;
793 foreach ($headers as $item) {
794 $worksheet[$wsnumber]->write(FIRSTUSEDEXCELROW-1,$col,$item,'');
795 $col++;
796 }
797 }
798
799 if (empty($logs['logs'])) {
800 $workbook->close();
801 return true;
802 }
803
804 $formatDate =& $workbook->add_format();
805 $formatDate->set_num_format(get_string('log_excel_date_format'));
806
807 $row = FIRSTUSEDEXCELROW;
808 $wsnumber = 1;
809 $myxls =& $worksheet[$wsnumber];
810 foreach ($logs['logs'] as $log) {
811 if (isset($ldcache[$log->module][$log->action])) {
812 $ld = $ldcache[$log->module][$log->action];
813 } else {
cb6fec1f 814 $ld = $DB->get_record('log_display', array('module'=>$log->module, 'action'=>$log->action));
ea49a66c 815 $ldcache[$log->module][$log->action] = $ld;
816 }
3186c124 817 if ($ld && is_numeric($log->info)) {
ea49a66c 818 // ugly hack to make sure fullname is shown correctly
7e60297f 819 if (($ld->mtable == 'user') and ($ld->field == $DB->sql_concat('firstname', "' '" , 'lastname'))) {
cb6fec1f 820 $log->info = fullname($DB->get_record($ld->mtable, array('id'=>$log->info)), true);
ea49a66c 821 } else {
cb6fec1f 822 $log->info = $DB->get_field($ld->mtable, $ld->field, array('id'=>$log->info));
ea49a66c 823 }
824 }
825
826 // Filter log->info
827 $log->info = format_string($log->info);
828 $log->info = strip_tags(urldecode($log->info)); // Some XSS protection
829
830 if ($nroPages>1) {
831 if ($row > EXCELROWS) {
832 $wsnumber++;
833 $myxls =& $worksheet[$wsnumber];
834 $row = FIRSTUSEDEXCELROW;
835 }
836 }
837
9a5e297b 838 $coursecontext = context_course::instance($course->id);
8ebbb06a 839
dc767040 840 $myxls->write_string($row, 0, format_string($courses[$log->course], true, array('context' => $coursecontext)));
d81b7ffb 841 $myxls->write_date($row, 1, $log->time);
842 $myxls->write_string($row, 2, $log->ip);
8ebbb06a 843 $fullname = fullname($log, has_capability('moodle/site:viewfullnames', $coursecontext));
d81b7ffb 844 $myxls->write_string($row, 3, $fullname);
e85a3412
JG
845 $actionurl = $CFG->wwwroot. make_log_url($log->module,$log->url);
846 $myxls->write_string($row, 4, $log->module.' '.$log->action.' ('.$actionurl.')');
d81b7ffb 847 $myxls->write_string($row, 5, $log->info);
ea49a66c 848
849 $row++;
850 }
851
852 $workbook->close();
954fdb42 853 return true;
92890025 854}
855
749ce98e
DW
856/**
857 * Checks the integrity of the course data.
858 *
859 * In summary - compares course_sections.sequence and course_modules.section.
860 *
861 * More detailed, checks that:
862 * - course_sections.sequence contains each module id not more than once in the course
863 * - for each moduleid from course_sections.sequence the field course_modules.section
864 * refers to the same section id (this means course_sections.sequence is more
865 * important if they are different)
866 * - ($fullcheck only) each module in the course is present in one of
867 * course_sections.sequence
868 * - ($fullcheck only) removes non-existing course modules from section sequences
869 *
870 * If there are any mismatches, the changes are made and records are updated in DB.
871 *
872 * Course cache is NOT rebuilt if there are any errors!
873 *
874 * This function is used each time when course cache is being rebuilt with $fullcheck = false
875 * and in CLI script admin/cli/fix_course_sequence.php with $fullcheck = true
876 *
877 * @param int $courseid id of the course
878 * @param array $rawmods result of funciton {@link get_course_mods()} - containst
879 * the list of enabled course modules in the course. Retrieved from DB if not specified.
880 * Argument ignored in cashe of $fullcheck, the list is retrieved form DB anyway.
881 * @param array $sections records from course_sections table for this course.
882 * Retrieved from DB if not specified
883 * @param bool $fullcheck Will add orphaned modules to their sections and remove non-existing
884 * course modules from sequences. Only to be used in site maintenance mode when we are
885 * sure that another user is not in the middle of the process of moving/removing a module.
886 * @param bool $checkonly Only performs the check without updating DB, outputs all errors as debug messages.
887 * @return array array of messages with found problems. Empty output means everything is ok
888 */
889function course_integrity_check($courseid, $rawmods = null, $sections = null, $fullcheck = false, $checkonly = false) {
890 global $DB;
891 $messages = array();
892 if ($sections === null) {
893 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section', 'id,section,sequence');
894 }
895 if ($fullcheck) {
896 // Retrieve all records from course_modules regardless of module type visibility.
897 $rawmods = $DB->get_records('course_modules', array('course' => $courseid), 'id', 'id,section');
898 }
899 if ($rawmods === null) {
900 $rawmods = get_course_mods($courseid);
901 }
902 if (!$fullcheck && (empty($sections) || empty($rawmods))) {
903 // If either of the arrays is empty, no modules are displayed anyway.
904 return true;
905 }
906 $debuggingprefix = 'Failed integrity check for course ['.$courseid.']. ';
907
908 // First make sure that each module id appears in section sequences only once.
909 // If it appears in several section sequences the last section wins.
910 // If it appears twice in one section sequence, the first occurence wins.
911 $modsection = array();
912 foreach ($sections as $sectionid => $section) {
913 $sections[$sectionid]->newsequence = $section->sequence;
914 if (!empty($section->sequence)) {
915 $sequence = explode(",", $section->sequence);
916 $sequenceunique = array_unique($sequence);
917 if (count($sequenceunique) != count($sequence)) {
918 // Some course module id appears in this section sequence more than once.
919 ksort($sequenceunique); // Preserve initial order of modules.
920 $sequence = array_values($sequenceunique);
921 $sections[$sectionid]->newsequence = join(',', $sequence);
922 $messages[] = $debuggingprefix.'Sequence for course section ['.
923 $sectionid.'] is "'.$sections[$sectionid]->sequence.'", must be "'.$sections[$sectionid]->newsequence.'"';
924 }
925 foreach ($sequence as $cmid) {
926 if (array_key_exists($cmid, $modsection) && isset($rawmods[$cmid])) {
927 // Some course module id appears to be in more than one section's sequences.
928 $wrongsectionid = $modsection[$cmid];
929 $sections[$wrongsectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$wrongsectionid]->newsequence. ','), ',');
930 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] must be removed from sequence of section ['.
931 $wrongsectionid.'] because it is also present in sequence of section ['.$sectionid.']';
932 }
933 $modsection[$cmid] = $sectionid;
934 }
935 }
936 }
937
938 // Add orphaned modules to their sections if they exist or to section 0 otherwise.
939 if ($fullcheck) {
940 foreach ($rawmods as $cmid => $mod) {
941 if (!isset($modsection[$cmid])) {
942 // This is a module that is not mentioned in course_section.sequence at all.
943 // Add it to the section $mod->section or to the last available section.
944 if ($mod->section && isset($sections[$mod->section])) {
945 $modsection[$cmid] = $mod->section;
946 } else {
947 $firstsection = reset($sections);
948 $modsection[$cmid] = $firstsection->id;
949 }
950 $sections[$modsection[$cmid]]->newsequence = trim($sections[$modsection[$cmid]]->newsequence.','.$cmid, ',');
951 $messages[] = $debuggingprefix.'Course module ['.$cmid.'] is missing from sequence of section ['.
e2e9cb6a 952 $modsection[$cmid].']';
749ce98e
DW
953 }
954 }
955 foreach ($modsection as $cmid => $sectionid) {
956 if (!isset($rawmods[$cmid])) {
957 // Section $sectionid refers to module id that does not exist.
958 $sections[$sectionid]->newsequence = trim(preg_replace("/,$cmid,/", ',', ','.$sections[$sectionid]->newsequence.','), ',');
959 $messages[] = $debuggingprefix.'Course module ['.$cmid.
960 '] does not exist but is present in the sequence of section ['.$sectionid.']';
961 }
962 }
963 }
964
965 // Update changed sections.
966 if (!$checkonly && !empty($messages)) {
967 foreach ($sections as $sectionid => $section) {
968 if ($section->newsequence !== $section->sequence) {
969 $DB->update_record('course_sections', array('id' => $sectionid, 'sequence' => $section->newsequence));
970 }
971 }
972 }
973
974 // Now make sure that all modules point to the correct sections.
975 foreach ($rawmods as $cmid => $mod) {
976 if (isset($modsection[$cmid]) && $modsection[$cmid] != $mod->section) {
977 if (!$checkonly) {
978 $DB->update_record('course_modules', array('id' => $cmid, 'section' => $modsection[$cmid]));
979 }
980 $messages[] = $debuggingprefix.'Course module ['.$cmid.
981 '] points to section ['.$mod->section.'] instead of ['.$modsection[$cmid].']';
982 }
983 }
984
985 return $messages;
986}
987
cb6fec1f 988/**
989 * For a given course, returns an array of course activity objects
990 * Each item in the array contains he following properties:
991 */
d897cae4 992function get_array_of_activities($courseid) {
d897cae4 993// cm - course module id
994// mod - name of the module (eg forum)
995// section - the number of the section (eg week or topic)
996// name - the name of the instance
5867bfb5 997// visible - is the instance visible or not
13534ef7 998// groupingid - grouping id
86aa7ccf 999// extra - contains extra string to include in any link
cb6fec1f 1000 global $CFG, $DB;
8dddba42 1001
a0c30e1b 1002 $course = $DB->get_record('course', array('id'=>$courseid));
1003
1004 if (empty($course)) {
1005 throw new moodle_exception('courseidnotfound');
1006 }
1007
d897cae4 1008 $mod = array();
1009
a0c30e1b 1010 $rawmods = get_course_mods($courseid);
1011 if (empty($rawmods)) {
dd97c328 1012 return $mod; // always return array
d897cae4 1013 }
1014
749ce98e
DW
1015 if ($sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence')) {
1016 // First check and correct obvious mismatches between course_sections.sequence and course_modules.section.
1017 if ($errormessages = course_integrity_check($courseid, $rawmods, $sections)) {
1018 debugging(join('<br>', $errormessages));
1019 $rawmods = get_course_mods($courseid);
1020 $sections = $DB->get_records('course_sections', array('course' => $courseid), 'section ASC', 'id,section,sequence');
1021 }
1022 // Build array of activities.
d897cae4 1023 foreach ($sections as $section) {
74666583 1024 if (!empty($section->sequence)) {
d897cae4 1025 $sequence = explode(",", $section->sequence);
1026 foreach ($sequence as $seq) {
7af6281f 1027 if (empty($rawmods[$seq])) {
1028 continue;
1029 }
b85b25eb 1030 $mod[$seq] = new stdClass();
dd97c328 1031 $mod[$seq]->id = $rawmods[$seq]->instance;
1032 $mod[$seq]->cm = $rawmods[$seq]->id;
1033 $mod[$seq]->mod = $rawmods[$seq]->modname;
adaeccb6 1034
1035 // Oh dear. Inconsistent names left here for backward compatibility.
dd97c328 1036 $mod[$seq]->section = $section->section;
adaeccb6 1037 $mod[$seq]->sectionid = $rawmods[$seq]->section;
1038
1039 $mod[$seq]->module = $rawmods[$seq]->module;
1040 $mod[$seq]->added = $rawmods[$seq]->added;
1041 $mod[$seq]->score = $rawmods[$seq]->score;
66b250fd 1042 $mod[$seq]->idnumber = $rawmods[$seq]->idnumber;
dd97c328 1043 $mod[$seq]->visible = $rawmods[$seq]->visible;
adaeccb6 1044 $mod[$seq]->visibleold = $rawmods[$seq]->visibleold;
dd97c328 1045 $mod[$seq]->groupmode = $rawmods[$seq]->groupmode;
1046 $mod[$seq]->groupingid = $rawmods[$seq]->groupingid;
82bd6a5e 1047 $mod[$seq]->indent = $rawmods[$seq]->indent;
1048 $mod[$seq]->completion = $rawmods[$seq]->completion;
dd97c328 1049 $mod[$seq]->extra = "";
adaeccb6 1050 $mod[$seq]->completiongradeitemnumber =
1051 $rawmods[$seq]->completiongradeitemnumber;
1052 $mod[$seq]->completionview = $rawmods[$seq]->completionview;
1053 $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
8c40662e 1054 $mod[$seq]->showdescription = $rawmods[$seq]->showdescription;
8d1f33e1 1055 $mod[$seq]->availability = $rawmods[$seq]->availability;
8dddba42 1056
1057 $modname = $mod[$seq]->mod;
1058 $functionname = $modname."_get_coursemodule_info";
1059
3a37b3f8 1060 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
1061 continue;
1062 }
1063
8dddba42 1064 include_once("$CFG->dirroot/mod/$modname/lib.php");
1065
b3a89232 1066 if ($hasfunction = function_exists($functionname)) {
9d361034 1067 if ($info = $functionname($rawmods[$seq])) {
9d361034 1068 if (!empty($info->icon)) {
1069 $mod[$seq]->icon = $info->icon;
1070 }
9a9012dc
PS
1071 if (!empty($info->iconcomponent)) {
1072 $mod[$seq]->iconcomponent = $info->iconcomponent;
1073 }
1ea543df 1074 if (!empty($info->name)) {
9a9012dc 1075 $mod[$seq]->name = $info->name;
1ea543df 1076 }
0d8b6a69 1077 if ($info instanceof cached_cm_info) {
1078 // When using cached_cm_info you can include three new fields
1079 // that aren't available for legacy code
1080 if (!empty($info->content)) {
1081 $mod[$seq]->content = $info->content;
1082 }
1083 if (!empty($info->extraclasses)) {
1084 $mod[$seq]->extraclasses = $info->extraclasses;
1085 }
c443a1cd 1086 if (!empty($info->iconurl)) {
4fcdb012
MG
1087 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
1088 $url = new moodle_url($info->iconurl);
1089 $mod[$seq]->iconurl = $url->out(false);
c443a1cd 1090 }
0d8b6a69 1091 if (!empty($info->onclick)) {
1092 $mod[$seq]->onclick = $info->onclick;
1093 }
1094 if (!empty($info->customdata)) {
1095 $mod[$seq]->customdata = $info->customdata;
1096 }
1097 } else {
1098 // When using a stdclass, the (horrible) deprecated ->extra field
1099 // is available for BC
1100 if (!empty($info->extra)) {
1101 $mod[$seq]->extra = $info->extra;
1102 }
1103 }
c9f6251e 1104 }
1105 }
b3a89232 1106 // When there is no modname_get_coursemodule_info function,
1107 // but showdescriptions is enabled, then we use the 'intro'
1108 // and 'introformat' fields in the module table
1109 if (!$hasfunction && $rawmods[$seq]->showdescription) {
1110 if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
1111 array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
1112 // Set content from intro and introformat. Filters are disabled
1113 // because we filter it with format_text at display time
1114 $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
1115 $modvalues, $rawmods[$seq]->id, false);
1116
1117 // To save making another query just below, put name in here
1118 $mod[$seq]->name = $modvalues->name;
1119 }
1120 }
1ea543df 1121 if (!isset($mod[$seq]->name)) {
9a9012dc 1122 $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1ea543df 1123 }
0d8b6a69 1124
061e6b28 1125 // Minimise the database size by unsetting default options when they are
1126 // 'empty'. This list corresponds to code in the cm_info constructor.
1127 foreach (array('idnumber', 'groupmode', 'groupingid',
1128 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
1129 'icon', 'iconcomponent', 'customdata', 'availability', 'completionview',
1130 'completionexpected', 'score', 'showdescription') as $property) {
0d8b6a69 1131 if (property_exists($mod[$seq], $property) &&
1132 empty($mod[$seq]->{$property})) {
1133 unset($mod[$seq]->{$property});
1134 }
1135 }
adaeccb6 1136 // Special case: this value is usually set to null, but may be 0
1137 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1138 is_null($mod[$seq]->completiongradeitemnumber)) {
1139 unset($mod[$seq]->completiongradeitemnumber);
1140 }
d897cae4 1141 }
1142 }
1143 }
1144 }
1145 return $mod;
1146}
1147
cb6fec1f 1148/**
d57aa283
MG
1149 * Returns the localised human-readable names of all used modules
1150 *
1151 * @param bool $plural if true returns the plural forms of the names
1152 * @return array where key is the module name (component name without 'mod_') and
1153 * the value is the human-readable string. Array sorted alphabetically by value
cb6fec1f 1154 */
d57aa283
MG
1155function get_module_types_names($plural = false) {
1156 static $modnames = null;
1157 global $DB, $CFG;
1158 if ($modnames === null) {
1159 $modnames = array(0 => array(), 1 => array());
1160 if ($allmods = $DB->get_records("modules")) {
1161 foreach ($allmods as $mod) {
1162 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1163 $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1164 $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1165 }
13534ef7 1166 }
2f1e464a
PS
1167 core_collator::asort($modnames[0]);
1168 core_collator::asort($modnames[1]);
c7da6f7a 1169 }
7468bf01 1170 }
d57aa283 1171 return $modnames[(int)$plural];
7468bf01 1172}
1173
93d46f48
RK
1174/**
1175 * Set highlighted section. Only one section can be highlighted at the time.
1176 *
1177 * @param int $courseid course id
1178 * @param int $marker highlight section with this number, 0 means remove higlightin
1179 * @return void
1180 */
1181function course_set_marker($courseid, $marker) {
1182 global $DB;
1183 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
a062c97c 1184 format_base::reset_course_cache($courseid);
93d46f48
RK
1185}
1186
cb6fec1f 1187/**
7e85563d 1188 * For a given course section, marks it visible or hidden,
cb6fec1f 1189 * and does the same for every activity in that section
ebaa29d1
ARN
1190 *
1191 * @param int $courseid course id
1192 * @param int $sectionnumber The section number to adjust
1193 * @param int $visibility The new visibility
1194 * @return array A list of resources which were hidden in the section
cb6fec1f 1195 */
7d99d695 1196function set_section_visible($courseid, $sectionnumber, $visibility) {
cb6fec1f 1197 global $DB;
7d99d695 1198
ebaa29d1 1199 $resourcestotoggle = array();
cb6fec1f 1200 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
f26481c2 1201 course_update_section($courseid, $section, array('visible' => $visibility));
ebaa29d1
ARN
1202
1203 // Determine which modules are visible for AJAX update
f26481c2 1204 $modules = !empty($section->sequence) ? explode(',', $section->sequence) : array();
ebaa29d1
ARN
1205 if (!empty($modules)) {
1206 list($insql, $params) = $DB->get_in_or_equal($modules);
1207 $select = 'id ' . $insql . ' AND visible = ?';
1208 array_push($params, $visibility);
1209 if (!$visibility) {
1210 $select .= ' AND visibleold = 1';
1211 }
1212 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1213 }
7d99d695 1214 }
ebaa29d1 1215 return $resourcestotoggle;
7d99d695 1216}
ba2e5d73 1217
59155a3f
ARN
1218/**
1219 * Retrieve all metadata for the requested modules
1220 *
1221 * @param object $course The Course
1222 * @param array $modnames An array containing the list of modules and their
1223 * names
a41b1d96 1224 * @param int $sectionreturn The section to return to
59155a3f
ARN
1225 * @return array A list of stdClass objects containing metadata about each
1226 * module
1227 */
923451c5 1228function get_module_metadata($course, $modnames, $sectionreturn = null) {
59155a3f
ARN
1229 global $CFG, $OUTPUT;
1230
1231 // get_module_metadata will be called once per section on the page and courses may show
1232 // different modules to one another
1233 static $modlist = array();
1234 if (!isset($modlist[$course->id])) {
1235 $modlist[$course->id] = array();
1236 }
1237
1238 $return = array();
17079335
MG
1239 $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1240 if ($sectionreturn !== null) {
1241 $urlbase->param('sr', $sectionreturn);
1242 }
59155a3f
ARN
1243 foreach($modnames as $modname => $modnamestr) {
1244 if (!course_allowed_module($course, $modname)) {
1245 continue;
1246 }
ad47d025 1247 if (isset($modlist[$course->id][$modname])) {
59155a3f
ARN
1248 // This module is already cached
1249 $return[$modname] = $modlist[$course->id][$modname];
1250 continue;
1251 }
1252
1253 // Include the module lib
1254 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1255 if (!file_exists($libfile)) {
1256 continue;
1257 }
1258 include_once($libfile);
1259
1260 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1261 $gettypesfunc = $modname.'_get_types';
50ae8814 1262 $types = MOD_SUBTYPE_NO_CHILDREN;
59155a3f 1263 if (function_exists($gettypesfunc)) {
56c0878b 1264 $types = $gettypesfunc();
50ae8814
MN
1265 }
1266 if ($types !== MOD_SUBTYPE_NO_CHILDREN) {
56c0878b 1267 if (is_array($types) && count($types) > 0) {
59155a3f
ARN
1268 $group = new stdClass();
1269 $group->name = $modname;
1270 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1271 foreach($types as $type) {
1272 if ($type->typestr === '--') {
1273 continue;
1274 }
1275 if (strpos($type->typestr, '--') === 0) {
1276 $group->title = str_replace('--', '', $type->typestr);
1277 continue;
1278 }
1279 // Set the Sub Type metadata
1280 $subtype = new stdClass();
1281 $subtype->title = $type->typestr;
1282 $subtype->type = str_replace('&amp;', '&', $type->type);
1283 $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1284 $subtype->archetype = $type->modclass;
1285
1286 // The group archetype should match the subtype archetypes and all subtypes
1287 // should have the same archetype
1288 $group->archetype = $subtype->archetype;
1289
50ae8814
MN
1290 if (!empty($type->help)) {
1291 $subtype->help = $type->help;
1292 } else if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
59155a3f
ARN
1293 $subtype->help = get_string('help' . $subtype->name, $modname);
1294 }
cf003abc 1295 $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
59155a3f
ARN
1296 $group->types[] = $subtype;
1297 }
1298 $modlist[$course->id][$modname] = $group;
1299 }
1300 } else {
1301 $module = new stdClass();
17079335 1302 $module->title = $modnamestr;
59155a3f 1303 $module->name = $modname;
17079335 1304 $module->link = new moodle_url($urlbase, array('add' => $modname));
59155a3f 1305 $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
01e0e704
ARN
1306 $sm = get_string_manager();
1307 if ($sm->string_exists('modulename_help', $modname)) {
59155a3f 1308 $module->help = get_string('modulename_help', $modname);
01e0e704
ARN
1309 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs
1310 $link = get_string('modulename_link', $modname);
1311 $linktext = get_string('morehelp');
afe3566c 1312 $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
01e0e704 1313 }
59155a3f
ARN
1314 }
1315 $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1316 $modlist[$course->id][$modname] = $module;
1317 }
56c0878b
SC
1318 if (isset($modlist[$course->id][$modname])) {
1319 $return[$modname] = $modlist[$course->id][$modname];
1320 } else {
1321 debugging("Invalid module metadata configuration for {$modname}");
1322 }
59155a3f
ARN
1323 }
1324
1325 return $return;
1326}
1327
8ed5dd63 1328/**
1329 * Return the course category context for the category with id $categoryid, except
1330 * that if $categoryid is 0, return the system context.
1331 *
1332 * @param integer $categoryid a category id or 0.
5dc361e1 1333 * @return context the corresponding context
8ed5dd63 1334 */
1335function get_category_or_system_context($categoryid) {
1336 if ($categoryid) {
4658aec5 1337 return context_coursecat::instance($categoryid, IGNORE_MISSING);
8ed5dd63 1338 } else {
9a5e297b 1339 return context_system::instance();
8ed5dd63 1340 }
1341}
1342
cb6fec1f 1343/**
4e0b6025
MG
1344 * Returns full course categories trees to be used in html_writer::select()
1345 *
1346 * Calls {@link coursecat::make_categories_list()} to build the tree and
1347 * adds whitespace to denote nesting
1348 *
1349 * @return array array mapping coursecat id to the display name
cb6fec1f 1350 */
0705ff84 1351function make_categories_options() {
4e0b6025
MG
1352 global $CFG;
1353 require_once($CFG->libdir. '/coursecatlib.php');
a7a04f6d 1354 $cats = coursecat::make_categories_list('', 0, ' / ');
0705ff84 1355 foreach ($cats as $key => $value) {
a7a04f6d
MG
1356 // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1357 $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
0705ff84 1358 }
1359 return $cats;
1360}
c2cb4545 1361
77eddcd5 1362/**
1363 * Print the buttons relating to course requests.
1364 *
8e57a6df 1365 * @param object $context current page context.
77eddcd5 1366 */
8e57a6df 1367function print_course_request_buttons($context) {
b4531207 1368 global $CFG, $DB, $OUTPUT;
77eddcd5 1369 if (empty($CFG->enablecourserequests)) {
1370 return;
1371 }
8e57a6df 1372 if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
77eddcd5 1373 /// Print a button to request a new course
8e57a6df 1374 echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
77eddcd5 1375 }
1376 /// Print a button to manage pending requests
8e57a6df 1377 if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
5c2ed7e2 1378 $disabled = !$DB->record_exists('course_request', array());
8e57a6df 1379 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
77eddcd5 1380 }
1381}
1382
5048e034 1383/**
1384 * Does the user have permission to edit things in this category?
1385 *
1386 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1387 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1388 */
1389function can_edit_in_category($categoryid = 0) {
1390 $context = get_category_or_system_context($categoryid);
1391 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1392}
1393
11b0c469 1394/// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1395
1396function add_course_module($mod) {
cb6fec1f 1397 global $DB;
11b0c469 1398
e5dfd0f3 1399 $mod->added = time();
53f4ad2c 1400 unset($mod->id);
11b0c469 1401
38b19bbc
MG
1402 $cmid = $DB->insert_record("course_modules", $mod);
1403 rebuild_course_cache($mod->course, true);
1404 return $cmid;
11b0c469 1405}
1406
97928ddf 1407/**
4ede27b2 1408 * Creates missing course section(s) and rebuilds course cache
99e9f9a6 1409 *
b46be6ad 1410 * @param int|stdClass $courseorid course id or course object
4ede27b2
MG
1411 * @param int|array $sections list of relative section numbers to create
1412 * @return bool if there were any sections created
97928ddf 1413 */
b46be6ad 1414function course_create_sections_if_missing($courseorid, $sections) {
cb6fec1f 1415 global $DB;
4ede27b2
MG
1416 if (!is_array($sections)) {
1417 $sections = array($sections);
1418 }
b46be6ad
MG
1419 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1420 if (is_object($courseorid)) {
1421 $courseorid = $courseorid->id;
1422 }
4ede27b2
MG
1423 $coursechanged = false;
1424 foreach ($sections as $sectionnum) {
1425 if (!in_array($sectionnum, $existing)) {
1426 $cw = new stdClass();
b46be6ad 1427 $cw->course = $courseorid;
4ede27b2
MG
1428 $cw->section = $sectionnum;
1429 $cw->summary = '';
1430 $cw->summaryformat = FORMAT_HTML;
1431 $cw->sequence = '';
1432 $id = $DB->insert_record("course_sections", $cw);
1433 $coursechanged = true;
1434 }
1435 }
1436 if ($coursechanged) {
b46be6ad 1437 rebuild_course_cache($courseorid, true);
4ede27b2
MG
1438 }
1439 return $coursechanged;
97928ddf 1440}
52f14061 1441
ece966f0 1442/**
722e6ba9 1443 * Adds an existing module to the section
ece966f0 1444 *
722e6ba9
MG
1445 * Updates both tables {course_sections} and {course_modules}
1446 *
5523c344 1447 * Note: This function does not use modinfo PROVIDED that the section you are
1448 * adding the module to already exists. If the section does not exist, it will
1449 * build modinfo if necessary and create the section.
1450 *
722e6ba9 1451 * @param int|stdClass $courseorid course id or course object
46453565 1452 * @param int $cmid id of the module already existing in course_modules table
722e6ba9
MG
1453 * @param int $sectionnum relative number of the section (field course_sections.section)
1454 * If section does not exist it will be created
1455 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1456 * before which the module needs to be included. Null for inserting in the
1457 * end of the section
1458 * @return int The course_sections ID where the module is inserted
ece966f0 1459 */
46453565 1460function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
722e6ba9
MG
1461 global $DB, $COURSE;
1462 if (is_object($beforemod)) {
1463 $beforemod = $beforemod->id;
1464 }
46453565
PS
1465 if (is_object($courseorid)) {
1466 $courseid = $courseorid->id;
1467 } else {
1468 $courseid = $courseorid;
1469 }
46453565 1470 // Do not try to use modinfo here, there is no guarantee it is valid!
5523c344 1471 $section = $DB->get_record('course_sections',
1472 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
1473 if (!$section) {
1474 // This function call requires modinfo.
1475 course_create_sections_if_missing($courseorid, $sectionnum);
1476 $section = $DB->get_record('course_sections',
1477 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
1478 }
1479
722e6ba9 1480 $modarray = explode(",", trim($section->sequence));
281d730e 1481 if (empty($section->sequence)) {
46453565 1482 $newsequence = "$cmid";
722e6ba9 1483 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
46453565 1484 $insertarray = array($cmid, $beforemod);
722e6ba9
MG
1485 array_splice($modarray, $key[0], 1, $insertarray);
1486 $newsequence = implode(",", $modarray);
1487 } else {
46453565 1488 $newsequence = "$section->sequence,$cmid";
722e6ba9
MG
1489 }
1490 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
46453565 1491 $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
b46be6ad
MG
1492 if (is_object($courseorid)) {
1493 rebuild_course_cache($courseorid->id, true);
1494 } else {
1495 rebuild_course_cache($courseorid, true);
1496 }
722e6ba9 1497 return $section->id; // Return course_sections ID that was used.
11b0c469 1498}
1499
9e533215
SL
1500/**
1501 * Change the group mode of a course module.
1502 *
1503 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1504 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1505 *
1506 * @param int $id course module ID.
1507 * @param int $groupmode the new groupmode value.
1508 * @return bool True if the $groupmode was updated.
1509 */
48e535bc 1510function set_coursemodule_groupmode($id, $groupmode) {
cb6fec1f 1511 global $DB;
38b19bbc
MG
1512 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1513 if ($cm->groupmode != $groupmode) {
1514 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1515 rebuild_course_cache($cm->course, true);
1516 }
1517 return ($cm->groupmode != $groupmode);
3d575e6f 1518}
1519
177d4abf 1520function set_coursemodule_idnumber($id, $idnumber) {
cb6fec1f 1521 global $DB;
38b19bbc
MG
1522 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1523 if ($cm->idnumber != $idnumber) {
1524 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1525 rebuild_course_cache($cm->course, true);
1526 }
1527 return ($cm->idnumber != $idnumber);
177d4abf 1528}
4e781c7b 1529
02f66c42 1530/**
00a34234
FM
1531 * Set the visibility of a module and inherent properties.
1532 *
9e533215
SL
1533 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1534 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1535 *
00a34234
FM
1536 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1537 * has been moved to {@link set_section_visible()} which was the only place from which
1538 * the parameter was used.
1539 *
1540 * @param int $id of the module
1541 * @param int $visible state of the module
1542 * @return bool false when the module was not found, true otherwise
1543 */
1544function set_coursemodule_visible($id, $visible) {
f5e2602a 1545 global $DB, $CFG;
0f078024 1546 require_once($CFG->libdir.'/gradelib.php');
c5ceaeaf 1547 require_once($CFG->dirroot.'/calendar/lib.php');
0f078024 1548
00a34234
FM
1549 // Trigger developer's attention when using the previously removed argument.
1550 if (func_num_args() > 2) {
1551 debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1552 has been removed.', DEBUG_DEVELOPER);
1553 }
1554
cb6fec1f 1555 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
978abb42 1556 return false;
1557 }
40fcc261
AD
1558
1559 // Create events and propagate visibility to associated grade items if the value has changed.
1560 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1561 if ($cm->visible == $visible) {
1562 return true;
1563 }
1564
cb6fec1f 1565 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
978abb42 1566 return false;
1567 }
cb6fec1f 1568 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 1569 foreach($events as $event) {
48e535bc 1570 if ($visible) {
379cd2d4
EL
1571 $event = new calendar_event($event);
1572 $event->toggle_visibility(true);
48e535bc 1573 } else {
379cd2d4
EL
1574 $event = new calendar_event($event);
1575 $event->toggle_visibility(false);
48e535bc 1576 }
dcd338ff 1577 }
1578 }
f5e2602a 1579
00a34234
FM
1580 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1581 // affect visibleold to allow for an original visibility restore. See set_section_visible().
1582 $cminfo = new stdClass();
1583 $cminfo->id = $id;
1584 $cminfo->visible = $visible;
1585 $cminfo->visibleold = $visible;
1586 $DB->update_record('course_modules', $cminfo);
1587
1c73df9e
TH
1588 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1589 // Note that this must be done after updating the row in course_modules, in case
1590 // the modules grade_item_update function needs to access $cm->visible.
1591 if (plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY) &&
1592 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1593 $instance = $DB->get_record($modulename, array('id' => $cm->instance), '*', MUST_EXIST);
1594 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1595 } else {
1596 $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1597 if ($grade_items) {
1598 foreach ($grade_items as $grade_item) {
1599 $grade_item->set_hidden(!$visible);
1600 }
1601 }
1602 }
1603
38b19bbc
MG
1604 rebuild_course_cache($cm->course, true);
1605 return true;
1acfbce5 1606}
1607
cb6fec1f 1608/**
7f7144fd 1609 * This function will handle the whole deletion process of a module. This includes calling
a347aee3
MN
1610 * the modules delete_instance function, deleting files, events, grades, conditional data,
1611 * the data in the course_module and course_sections table and adding a module deletion
1612 * event to the DB.
290130b3 1613 *
a347aee3 1614 * @param int $cmid the course module id
5bcfd504 1615 * @since Moodle 2.5
290130b3 1616 */
a347aee3 1617function course_delete_module($cmid) {
63deb5c3 1618 global $CFG, $DB;
a347aee3 1619
f615fbab 1620 require_once($CFG->libdir.'/gradelib.php');
7f7144fd 1621 require_once($CFG->libdir.'/questionlib.php');
cae83708 1622 require_once($CFG->dirroot.'/blog/lib.php');
c5ceaeaf 1623 require_once($CFG->dirroot.'/calendar/lib.php');
f615fbab 1624
a347aee3
MN
1625 // Get the course module.
1626 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
290130b3 1627 return true;
1628 }
a347aee3
MN
1629
1630 // Get the module context.
1631 $modcontext = context_module::instance($cm->id);
1632
1633 // Get the course module name.
1634 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1635
1636 // Get the file location of the delete_instance function for this module.
1637 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1638
1639 // Include the file required to call the delete_instance function for this module.
1640 if (file_exists($modlib)) {
1641 require_once($modlib);
1642 } else {
9a9cb741
MN
1643 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1644 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
a347aee3
MN
1645 }
1646
9a9cb741 1647 $deleteinstancefunction = $modulename . '_delete_instance';
a347aee3 1648
9a9cb741
MN
1649 // Ensure the delete_instance function exists for this module.
1650 if (!function_exists($deleteinstancefunction)) {
1651 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1652 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1653 }
1654
7f7144fd
TB
1655 // Delete activity context questions and question categories.
1656 question_delete_activity($cm);
1657
9a9cb741 1658 // Call the delete_instance function, if it returns false throw an exception.
a347aee3 1659 if (!$deleteinstancefunction($cm->instance)) {
9a9cb741
MN
1660 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1661 "Cannot delete the module $modulename (instance).");
a347aee3
MN
1662 }
1663
1664 // Remove all module files in case modules forget to do that.
1665 $fs = get_file_storage();
1666 $fs->delete_area_files($modcontext->id);
1667
1668 // Delete events from calendar.
1669 if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
dcd338ff 1670 foreach($events as $event) {
c5ceaeaf
DP
1671 $calendarevent = calendar_event::load($event->id);
1672 $calendarevent->delete();
dcd338ff 1673 }
1674 }
a347aee3
MN
1675
1676 // Delete grade items, outcome items and grades attached to modules.
1677 if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1678 'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
f615fbab 1679 foreach ($grade_items as $grade_item) {
1680 $grade_item->delete('moddelete');
1681 }
f615fbab 1682 }
a347aee3 1683
46e12372
SM
1684 // Delete completion and availability data; it is better to do this even if the
1685 // features are not turned on, in case they were turned on previously (these will be
a347aee3 1686 // very quick on an empty table).
46e12372 1687 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
ede323e2
ARN
1688 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1689 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
06b3a6b2 1690
d9994071 1691 // Delete all tag instances associated with the instance of this module.
74fa9f76 1692 core_tag_tag::delete_instances('mod_' . $modulename, null, $modcontext->id);
dffcf46f 1693 core_tag_tag::remove_all_item_tags('core', 'course_modules', $cm->id);
cc033d48 1694
a347aee3 1695 // Delete the context.
c592eea2 1696 context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
a347aee3
MN
1697
1698 // Delete the module from the course_modules table.
1699 $DB->delete_records('course_modules', array('id' => $cm->id));
1700
1701 // Delete module from that section.
1702 if (!delete_mod_from_section($cm->id, $cm->section)) {
9a9cb741
MN
1703 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1704 "Cannot delete the module $modulename (instance) from section.");
a347aee3
MN
1705 }
1706
63deb5c3
AA
1707 // Trigger event for course module delete action.
1708 $event = \core\event\course_module_deleted::create(array(
1709 'courseid' => $cm->course,
1710 'context' => $modcontext,
1711 'objectid' => $cm->id,
1712 'other' => array(
1713 'modulename' => $modulename,
1714 'instanceid' => $cm->instance,
1715 )
1716 ));
1717 $event->add_record_snapshot('course_modules', $cm);
1718 $event->trigger();
38b19bbc 1719 rebuild_course_cache($cm->course, true);
11b0c469 1720}
1721
722e6ba9 1722function delete_mod_from_section($modid, $sectionid) {
cb6fec1f 1723 global $DB;
11b0c469 1724
722e6ba9 1725 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
11b0c469 1726
e5dfd0f3 1727 $modarray = explode(",", $section->sequence);
11b0c469 1728
722e6ba9 1729 if ($key = array_keys ($modarray, $modid)) {
11b0c469 1730 array_splice($modarray, $key[0], 1);
1731 $newsequence = implode(",", $modarray);
38b19bbc
MG
1732 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1733 rebuild_course_cache($section->course, true);
1734 return true;
11b0c469 1735 } else {
1736 return false;
1737 }
89adb174 1738
11b0c469 1739 }
7977cffd 1740 return false;
11b0c469 1741}
1742
3440ec12 1743/**
1744 * Moves a section within a course, from a position to another.
1745 * Be very careful: $section and $destination refer to section number,
1746 * not id!.
1747 *
1748 * @param object $course
1749 * @param int $section Section number (not id!!!)
1750 * @param int $destination
ca9cae84 1751 * @param bool $ignorenumsections
3440ec12 1752 * @return boolean Result
1753 */
ca9cae84 1754function move_section_to($course, $section, $destination, $ignorenumsections = false) {
3440ec12 1755/// Moves a whole course section up and down within the course
1756 global $USER, $DB;
1757
ca255392 1758 if (!$destination && $destination != 0) {
3440ec12 1759 return true;
1760 }
1761
850acb35
MG
1762 // compartibility with course formats using field 'numsections'
1763 $courseformatoptions = course_get_format($course)->get_format_options();
ca9cae84 1764 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
850acb35 1765 ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
3440ec12 1766 return false;
1767 }
1768
1769 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1770 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1771 'section ASC, id ASC', 'id, section')) {
1772 return false;
1773 }
1774
cf76b335 1775 $movedsections = reorder_sections($sections, $section, $destination);
3440ec12 1776
cf76b335 1777 // Update all sections. Do this in 2 steps to avoid breaking database
1778 // uniqueness constraint
1779 $transaction = $DB->start_delegated_transaction();
1780 foreach ($movedsections as $id => $position) {
1781 if ($sections[$id] !== $position) {
1782 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1783 }
1784 }
e7e0f8d2
DP
1785 foreach ($movedsections as $id => $position) {
1786 if ($sections[$id] !== $position) {
1787 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1788 }
3440ec12 1789 }
1790
15e2552f
RK
1791 // If we move the highlighted section itself, then just highlight the destination.
1792 // Adjust the higlighted section location if we move something over it either direction.
1793 if ($section == $course->marker) {
e7b6e6b9 1794 course_set_marker($course->id, $destination);
2365213f 1795 } elseif ($section > $course->marker && $course->marker >= $destination) {
e7b6e6b9 1796 course_set_marker($course->id, $course->marker+1);
2365213f 1797 } elseif ($section < $course->marker && $course->marker <= $destination) {
e7b6e6b9 1798 course_set_marker($course->id, $course->marker-1);
15e2552f
RK
1799 }
1800
cf76b335 1801 $transaction->allow_commit();
38b19bbc 1802 rebuild_course_cache($course->id, true);
3440ec12 1803 return true;
1804}
1805
ca9cae84
MG
1806/**
1807 * This method will delete a course section and may delete all modules inside it.
1808 *
1809 * No permissions are checked here, use {@link course_can_delete_section()} to
1810 * check if section can actually be deleted.
1811 *
1812 * @param int|stdClass $course
1813 * @param int|stdClass|section_info $section
1814 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1815 * @return bool whether section was deleted
1816 */
1817function course_delete_section($course, $section, $forcedeleteifnotempty = true) {
fa29c0c3
RK
1818 global $DB;
1819
1820 // Prepare variables.
1821 $courseid = (is_object($course)) ? $course->id : (int)$course;
1822 $sectionnum = (is_object($section)) ? $section->section : (int)$section;
1823 $section = $DB->get_record('course_sections', array('course' => $courseid, 'section' => $sectionnum));
1824 if (!$section) {
1825 // No section exists, can't proceed.
1826 return false;
1827 }
1828 $format = course_get_format($course);
1829 $sectionname = $format->get_section_name($section);
1830
1831 // Delete section.
1832 $result = $format->delete_section($section, $forcedeleteifnotempty);
1833
1834 // Trigger an event for course section deletion.
1835 if ($result) {
1836 $context = context_course::instance($courseid);
1837 $event = \core\event\course_section_deleted::create(
1838 array(
1839 'objectid' => $section->id,
1840 'courseid' => $courseid,
1841 'context' => $context,
1842 'other' => array(
1843 'sectionnum' => $section->section,
1844 'sectionname' => $sectionname,
1845 )
1846 )
1847 );
1848 $event->add_record_snapshot('course_sections', $section);
1849 $event->trigger();
1850 }
1851 return $result;
ca9cae84
MG
1852}
1853
f26481c2
MG
1854/**
1855 * Updates the course section
1856 *
1857 * This function does not check permissions or clean values - this has to be done prior to calling it.
1858 *
1859 * @param int|stdClass $course
1860 * @param stdClass $section record from course_sections table - it will be updated with the new values
1861 * @param array|stdClass $data
1862 */
1863function course_update_section($course, $section, $data) {
1864 global $DB;
1865
1866 $courseid = (is_object($course)) ? $course->id : (int)$course;
1867
1868 // Some fields can not be updated using this method.
1869 $data = array_diff_key((array)$data, array('id', 'course', 'section', 'sequence'));
1870 $changevisibility = (array_key_exists('visible', $data) && (bool)$data['visible'] != (bool)$section->visible);
1871 if (array_key_exists('name', $data) && \core_text::strlen($data['name']) > 255) {
1872 throw new moodle_exception('maximumchars', 'moodle', '', 255);
1873 }
1874
1875 // Update record in the DB and course format options.
1876 $data['id'] = $section->id;
1877 $DB->update_record('course_sections', $data);
1878 rebuild_course_cache($courseid, true);
1879 course_get_format($courseid)->update_section_format_options($data);
1880
1881 // Update fields of the $section object.
1882 foreach ($data as $key => $value) {
1883 if (property_exists($section, $key)) {
1884 $section->$key = $value;
1885 }
1886 }
1887
1888 // Trigger an event for course section update.
1889 $event = \core\event\course_section_updated::create(
1890 array(
1891 'objectid' => $section->id,
1892 'courseid' => $courseid,
1893 'context' => context_course::instance($courseid),
1894 'other' => array('sectionnum' => $section->section)
1895 )
1896 );
1897 $event->trigger();
1898
1899 // If section visibility was changed, hide the modules in this section too.
1900 if ($changevisibility && !empty($section->sequence)) {
1901 $modules = explode(',', $section->sequence);
1902 foreach ($modules as $moduleid) {
1903 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
1904 if ($data['visible']) {
1905 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1906 set_coursemodule_visible($moduleid, $cm->visibleold);
1907 } else {
1908 // We hide the section, so we hide the module but we store the original state in visibleold.
1909 set_coursemodule_visible($moduleid, 0);
1910 $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1911 }
1912 \core\event\course_module_updated::create_from_cm($cm)->trigger();
1913 }
1914 }
1915 }
1916}
1917
ca9cae84
MG
1918/**
1919 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1920 *
1921 * @param int|stdClass $course
1922 * @param int|stdClass|section_info $section
1923 * @return bool
1924 */
1925function course_can_delete_section($course, $section) {
1926 if (is_object($section)) {
1927 $section = $section->section;
1928 }
1929 if (!$section) {
1930 // Not possible to delete 0-section.
1931 return false;
1932 }
1933 // Course format should allow to delete sections.
1934 if (!course_get_format($course)->can_delete_section($section)) {
1935 return false;
1936 }
1937 // Make sure user has capability to update course and move sections.
1938 $context = context_course::instance(is_object($course) ? $course->id : $course);
1939 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1940 return false;
1941 }
1942 // Make sure user has capability to delete each activity in this section.
1943 $modinfo = get_fast_modinfo($course);
1944 if (!empty($modinfo->sections[$section])) {
1945 foreach ($modinfo->sections[$section] as $cmid) {
1946 if (!has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1947 return false;
1948 }
1949 }
1950 }
1951 return true;
1952}
1953
3440ec12 1954/**
1955 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1956 * an original position number and a target position number, rebuilds the array so that the
1957 * move is made without any duplication of section positions.
1958 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1959 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1960 *
1961 * @param array $sections
1962 * @param int $origin_position
1963 * @param int $target_position
1964 * @return array
1965 */
1966function reorder_sections($sections, $origin_position, $target_position) {
1967 if (!is_array($sections)) {
1968 return false;
1969 }
1970
1971 // We can't move section position 0
1972 if ($origin_position < 1) {
1973 echo "We can't move section position 0";
1974 return false;
1975 }
1976
1977 // Locate origin section in sections array
1978 if (!$origin_key = array_search($origin_position, $sections)) {
1979 echo "searched position not in sections array";
1980 return false; // searched position not in sections array
1981 }
1982
1983 // Extract origin section
1984 $origin_section = $sections[$origin_key];
1985 unset($sections[$origin_key]);
1986
1987 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1988 $found = false;
1989 $append_array = array();
1990 foreach ($sections as $id => $position) {
1991 if ($found) {
1992 $append_array[$id] = $position;
1993 unset($sections[$id]);
1994 }
1995 if ($position == $target_position) {
eb01aa2c
RT
1996 if ($target_position < $origin_position) {
1997 $append_array[$id] = $position;
1998 unset($sections[$id]);
1999 }
3440ec12 2000 $found = true;
2001 }
2002 }
2003
2004 // Append moved section
2005 $sections[$origin_key] = $origin_section;
2006
2007 // Append rest of array (if applicable)
2008 if (!empty($append_array)) {
2009 foreach ($append_array as $id => $position) {
2010 $sections[$id] = $position;
2011 }
2012 }
2013
2014 // Renumber positions
2015 $position = 0;
2016 foreach ($sections as $id => $p) {
2017 $sections[$id] = $position;
2018 $position++;
2019 }
2020
2021 return $sections;
2022
2023}
2024
cb6fec1f 2025/**
2026 * Move the module object $mod to the specified $section
2027 * If $beforemod exists then that is the module
2028 * before which $modid should be inserted
d55f05ef
MG
2029 *
2030 * @param stdClass|cm_info $mod
2031 * @param stdClass|section_info $section
2032 * @param int|stdClass $beforemod id or object with field id corresponding to the module
2033 * before which the module needs to be included. Null for inserting in the
2034 * end of the section
2035 * @return int new value for module visibility (0 or 1)
cb6fec1f 2036 */
7977cffd 2037function moveto_module($mod, $section, $beforemod=NULL) {
a83dd077 2038 global $OUTPUT, $DB;
7977cffd 2039
d55f05ef
MG
2040 // Current module visibility state - return value of this function.
2041 $modvisible = $mod->visible;
2042
2043 // Remove original module from original section.
7977cffd 2044 if (! delete_mod_from_section($mod->id, $mod->section)) {
e6db3026 2045 echo $OUTPUT->notification("Could not delete module from existing section");
7977cffd 2046 }
2047
d55f05ef 2048 // If moving to a hidden section then hide module.
bb1592c8
CF
2049 if ($mod->section != $section->id) {
2050 if (!$section->visible && $mod->visible) {
d55f05ef
MG
2051 // Module was visible but must become hidden after moving to hidden section.
2052 $modvisible = 0;
bb1592c8
CF
2053 set_coursemodule_visible($mod->id, 0);
2054 // Set visibleold to 1 so module will be visible when section is made visible.
2055 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
2056 }
2057 if ($section->visible && !$mod->visible) {
d55f05ef 2058 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
bb1592c8 2059 set_coursemodule_visible($mod->id, $mod->visibleold);
d55f05ef 2060 $modvisible = $mod->visibleold;
bb1592c8 2061 }
7977cffd 2062 }
2063
d55f05ef 2064 // Add the module into the new section.
722e6ba9 2065 course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
d55f05ef 2066 return $modvisible;
7977cffd 2067}
2068
f558b291
MG
2069/**
2070 * Returns the list of all editing actions that current user can perform on the module
2071 *
2072 * @param cm_info $mod The module to produce editing buttons for
2073 * @param int $indent The current indenting (default -1 means no move left-right actions)
2074 * @param int $sr The section to link back to (used for creating the links)
2075 * @return array array of action_link or pix_icon objects
2076 */
2077function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2078 global $COURSE, $SITE;
94361e02 2079
3d575e6f 2080 static $str;
2081
9a5e297b
AA
2082 $coursecontext = context_course::instance($mod->course);
2083 $modcontext = context_module::instance($mod->id);
7749e187 2084
af189935
PS
2085 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2086 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2087
cf69a00a 2088 // No permission to edit anything.
af189935 2089 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
f558b291 2090 return array();
217a8ee9 2091 }
2092
af189935
PS
2093 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2094
3d575e6f 2095 if (!isset($str)) {
f558b291 2096 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
a83d83e4 2097 'editsettings', 'duplicate', 'hide', 'show'), 'moodle');
f558b291 2098 $str->assign = get_string('assignroles', 'role');
6dc5908e
ARN
2099 $str->groupsnone = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2100 $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2101 $str->groupsvisible = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1acfbce5 2102 }
94361e02 2103
af189935 2104 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
24e1eae4 2105
f558b291
MG
2106 if ($sr !== null) {
2107 $baseurl->param('sr', $sr);
7749e187
SH
2108 }
2109 $actions = array();
2110
a83d83e4
AN
2111 // Update.
2112 if ($hasmanageactivities) {
2113 $actions['update'] = new action_menu_link_secondary(
7a9a07d2 2114 new moodle_url($baseurl, array('update' => $mod->id)),
a83d83e4
AN
2115 new pix_icon('t/edit', $str->editsettings, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2116 $str->editsettings,
2117 array('class' => 'editing_update', 'data-action' => 'update')
7a9a07d2
ARN
2118 );
2119 }
2120
cf69a00a 2121 // Indent.
639d9904 2122 if ($hasmanageactivities && $indent >= 0) {
a83d83e4
AN
2123 $indentlimits = new stdClass();
2124 $indentlimits->min = 0;
2125 $indentlimits->max = 16;
7749e187
SH
2126 if (right_to_left()) { // Exchange arrows on RTL
2127 $rightarrow = 't/left';
2128 $leftarrow = 't/right';
2129 } else {
2130 $rightarrow = 't/right';
2131 $leftarrow = 't/left';
2132 }
2133
a83d83e4
AN
2134 if ($indent >= $indentlimits->max) {
2135 $enabledclass = 'hidden';
2136 } else {
2137 $enabledclass = '';
2138 }
2139 $actions['moveright'] = new action_menu_link_secondary(
2140 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2141 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2142 $str->moveright,
11f8ef10 2143 array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright', 'data-keepopen' => true)
a83d83e4
AN
2144 );
2145
2146 if ($indent <= $indentlimits->min) {
2147 $enabledclass = 'hidden';
2148 } else {
2149 $enabledclass = '';
7749e187 2150 }
3665af78 2151 $actions['moveleft'] = new action_menu_link_secondary(
e282c679 2152 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
cf69a00a 2153 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 2154 $str->moveleft,
11f8ef10 2155 array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft', 'data-keepopen' => true)
e282c679 2156 );
a83d83e4
AN
2157
2158 }
2159
2160 // Hide/Show.
2161 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2162 if ($mod->visible) {
2163 $actions['hide'] = new action_menu_link_secondary(
2164 new moodle_url($baseurl, array('hide' => $mod->id)),
2165 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2166 $str->hide,
2167 array('class' => 'editing_hide', 'data-action' => 'hide')
2168 );
2169 } else {
2170 $actions['show'] = new action_menu_link_secondary(
2171 new moodle_url($baseurl, array('show' => $mod->id)),
2172 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2173 $str->show,
2174 array('class' => 'editing_show', 'data-action' => 'show')
2175 );
7749e187 2176 }
dc0dc7d5 2177 }
7749e187 2178
8a1a951f 2179 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
03c39daa 2180 if (has_all_capabilities($dupecaps, $coursecontext) &&
f558b291 2181 plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3665af78 2182 $actions['duplicate'] = new action_menu_link_secondary(
8645a28f 2183 new moodle_url($baseurl, array('duplicate' => $mod->id)),
cf69a00a 2184 new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 2185 $str->duplicate,
6982618e 2186 array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sr' => $sr)
8645a28f
EL
2187 );
2188 }
7749e187 2189
cf69a00a 2190 // Groupmode.
9ac099a1
AN
2191 if ($hasmanageactivities && !$mod->coursegroupmodeforce) {
2192 if (plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2193 if ($mod->effectivegroupmode == SEPARATEGROUPS) {
2194 $nextgroupmode = VISIBLEGROUPS;
2195 $grouptitle = $str->groupsseparate;
2196 $actionname = 'groupsseparate';
6272fce6 2197 $groupimage = 'i/groups';
9ac099a1
AN
2198 } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
2199 $nextgroupmode = NOGROUPS;
2200 $grouptitle = $str->groupsvisible;
2201 $actionname = 'groupsvisible';
6272fce6 2202 $groupimage = 'i/groupv';
9ac099a1
AN
2203 } else {
2204 $nextgroupmode = SEPARATEGROUPS;
2205 $grouptitle = $str->groupsnone;
2206 $actionname = 'groupsnone';
6272fce6 2207 $groupimage = 'i/groupn';
9ac099a1
AN
2208 }
2209
2210 $actions[$actionname] = new action_menu_link_primary(
2211 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
4c0664b9 2212 new pix_icon($groupimage, null, 'moodle', array('class' => 'iconsmall')),
9ac099a1 2213 $grouptitle,
4c0664b9 2214 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode, 'aria-live' => 'assertive')
9ac099a1 2215 );
32d03b7b 2216 } else {
9ac099a1 2217 $actions['nogroupsupport'] = new action_menu_filler();
32d03b7b 2218 }
7977cffd 2219 }
2220
cf69a00a 2221 // Assign.
af189935 2222 if (has_capability('moodle/role:assign', $modcontext)){
3665af78 2223 $actions['assign'] = new action_menu_link_secondary(
f558b291 2224 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
cf69a00a 2225 new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 2226 $str->assign,
cf69a00a 2227 array('class' => 'editing_assign', 'data-action' => 'assignroles')
7749e187
SH
2228 );
2229 }
2230
a83d83e4
AN
2231 // Delete.
2232 if ($hasmanageactivities) {
2233 $actions['delete'] = new action_menu_link_secondary(
2234 new moodle_url($baseurl, array('delete' => $mod->id)),
2235 new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2236 $str->delete,
2237 array('class' => 'editing_delete', 'data-action' => 'delete')
2238 );
2239 }
2240
f558b291 2241 return $actions;
90845098 2242}
2243
a83d83e4
AN
2244/**
2245 * Returns the rename action.
2246 *
2247 * @param cm_info $mod The module to produce editing buttons for
2248 * @param int $sr The section to link back to (used for creating the links)
2249 * @return The markup for the rename action, or an empty string if not available.
2250 */
2251function course_get_cm_rename_action(cm_info $mod, $sr = null) {
2252 global $COURSE, $OUTPUT;
2253
2254 static $str;
2255 static $baseurl;
2256
2257 $modcontext = context_module::instance($mod->id);
2258 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2259
2260 if (!isset($str)) {
2261 $str = get_strings(array('edittitle'));
2262 }
2263
2264 if (!isset($baseurl)) {
2265 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2266 }
2267
2268 if ($sr !== null) {
2269 $baseurl->param('sr', $sr);
2270 }
2271
2272 // AJAX edit title.
2273 if ($mod->has_view() && $hasmanageactivities && course_ajax_enabled($COURSE) &&
2274 (($mod->course == $COURSE->id) || ($mod->course == SITEID))) {
2275 // we will not display link if we are on some other-course page (where we should not see this module anyway)
2276 return html_writer::span(
2277 html_writer::link(
2278 new moodle_url($baseurl, array('update' => $mod->id)),
2279 $OUTPUT->pix_icon('t/editstring', '', 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2280 array(
2281 'class' => 'editing_title',
2282 'data-action' => 'edittitle',
2283 'title' => $str->edittitle,
2284 )
2285 )
2286 );
2287 }
2288 return '';
2289}
2290
4657ba81
AN
2291/**
2292 * Returns the move action.
2293 *
2294 * @param cm_info $mod The module to produce a move button for
2295 * @param int $sr The section to link back to (used for creating the links)
2296 * @return The markup for the move action, or an empty string if not available.
2297 */
2298function course_get_cm_move(cm_info $mod, $sr = null) {
2299 global $OUTPUT;
2300
2301 static $str;
2302 static $baseurl;
2303
2304 $modcontext = context_module::instance($mod->id);
2305 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2306
2307 if (!isset($str)) {
2308 $str = get_strings(array('move'));
2309 }
2310
2311 if (!isset($baseurl)) {
2312 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2313
2314 if ($sr !== null) {
2315 $baseurl->param('sr', $sr);
2316 }
2317 }
2318
2319 if ($hasmanageactivities) {
2320 $pixicon = 'i/dragdrop';
2321
69353dce 2322 if (!course_ajax_enabled($mod->get_course())) {
4657ba81
AN
2323 // Override for course frontpage until we get drag/drop working there.
2324 $pixicon = 't/move';
2325 }
2326
2327 return html_writer::link(
2328 new moodle_url($baseurl, array('copy' => $mod->id)),
2329 $OUTPUT->pix_icon($pixicon, $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2330 array('class' => 'editing_move', 'data-action' => 'move')
2331 );
2332 }
2333 return '';
2334}
2335
b61efafb 2336/**
264867fd 2337 * given a course object with shortname & fullname, this function will
b61efafb 2338 * truncate the the number of chars allowed and add ... if it was too long
2339 */
2340function course_format_name ($course,$max=100) {
264867fd 2341
9a5e297b 2342 $context = context_course::instance($course->id);
8ebbb06a 2343 $shortname = format_string($course->shortname, true, array('context' => $context));
9a5e297b 2344 $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
d1e36240 2345 $str = $shortname.': '. $fullname;
2f1e464a 2346 if (core_text::strlen($str) <= $max) {
b61efafb 2347 return $str;
2348 }
2349 else {
2f1e464a 2350 return core_text::substr($str,0,$max-3).'...';
b61efafb 2351 }
2352}
2353
0705ff84 2354/**
9665ecd2
TH
2355 * Is the user allowed to add this type of module to this course?
2356 * @param object $course the course settings. Only $course->id is used.
2357 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2358 * @return bool whether the current user is allowed to add this type of module to this course.
0705ff84 2359 */
9665ecd2 2360function course_allowed_module($course, $modname) {
9665ecd2
TH
2361 if (is_numeric($modname)) {
2362 throw new coding_exception('Function course_allowed_module no longer
2363 supports numeric module ids. Please update your code to pass the module name.');
0705ff84 2364 }
264867fd 2365
9665ecd2
TH
2366 $capability = 'mod/' . $modname . ':addinstance';
2367 if (!get_capability_info($capability)) {
2368 // Debug warning that the capability does not exist, but no more than once per page.
2369 static $warned = array();
2370 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2371 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2372 debugging('The module ' . $modname . ' does not define the standard capability ' .
2373 $capability , DEBUG_DEVELOPER);
2374 $warned[$modname] = 1;
2375 }
ddb0a19f 2376
9665ecd2
TH
2377 // If the capability does not exist, the module can always be added.
2378 return true;
0705ff84 2379 }
238c0dd9 2380
9665ecd2
TH
2381 $coursecontext = context_course::instance($course->id);
2382 return has_capability($capability, $coursecontext);
0705ff84 2383}
2384
cb6fec1f 2385/**
2386 * Efficiently moves many courses around while maintaining
2387 * sortorder in order.
2388 *
e92c39ca
PS
2389 * @param array $courseids is an array of course ids
2390 * @param int $categoryid
df997f84 2391 * @return bool success
cb6fec1f 2392 */
2393function move_courses($courseids, $categoryid) {
ed54cb41 2394 global $DB;
861efb19 2395
df997f84 2396 if (empty($courseids)) {
ed54cb41 2397 // Nothing to do.
5dc361e1 2398 return false;
df997f84 2399 }
264867fd 2400
ed54cb41 2401 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
df997f84
PS
2402 return false;
2403 }
19f601d1 2404
df997f84 2405 $courseids = array_reverse($courseids);
9a5e297b 2406 $newparent = context_coursecat::instance($category->id);
df997f84 2407 $i = 1;
0cbe8111 2408
aec8fe2f 2409 list($where, $params) = $DB->get_in_or_equal($courseids);
3a11e2d2 2410 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
30fe1181
MG
2411 foreach ($dbcourses as $dbcourse) {
2412 $course = new stdClass();
2413 $course->id = $dbcourse->id;
2414 $course->category = $category->id;
2415 $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2416 if ($category->visible == 0) {
2417 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2418 // to previous state if somebody unhides the category.
2419 $course->visible = 0;
2420 }
ed54cb41 2421
30fe1181 2422 $DB->update_record('course', $course);
ed54cb41 2423
3a11e2d2 2424 // Update context, so it can be passed to event.
30fe1181 2425 $context = context_course::instance($course->id);
3a11e2d2 2426 $context->update_moved($newparent);
30fe1181
MG
2427
2428 // Trigger a course updated event.
2429 $event = \core\event\course_updated::create(array(
2430 'objectid' => $course->id,
3a11e2d2 2431 'context' => context_course::instance($course->id),
30fe1181
MG
2432 'other' => array('shortname' => $dbcourse->shortname,
2433 'fullname' => $dbcourse->fullname)
2434 ));
30fe1181
MG
2435 $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2436 $event->trigger();
0cbe8111 2437 }
df997f84 2438 fix_course_sortorder();
eabbfa82 2439 cache_helper::purge_by_event('changesincourse');
df997f84 2440
861efb19 2441 return true;
2442}
2443
ae628043 2444/**
ee7084e9 2445 * Returns the display name of the given section that the course prefers
7487c856 2446 *
ee7084e9
MG
2447 * Implementation of this function is provided by course format
2448 * @see format_base::get_section_name()
7487c856 2449 *
ee7084e9
MG
2450 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2451 * @param int|stdClass $section Section object from database or just field course_sections.section
2452 * @return string Display name that the course format prefers, e.g. "Week 2"
ae628043 2453 */
ee7084e9
MG
2454function get_section_name($courseorid, $section) {
2455 return course_get_format($courseorid)->get_section_name($section);
7487c856
SH
2456}
2457
2458/**
ee7084e9 2459 * Tells if current course format uses sections
1b048629 2460 *
7487c856 2461 * @param string $format Course format ID e.g. 'weeks' $course->format
ee7084e9 2462 * @return bool
7487c856 2463 */
7487c856 2464function course_format_uses_sections($format) {
ee7084e9
MG
2465 $course = new stdClass();
2466 $course->format = $format;
2467 return course_get_format($course)->uses_sections();
ae628043 2468}
2469
c0b5d925
DM
2470/**
2471 * Returns the information about the ajax support in the given source format
2472 *
2473 * The returned object's property (boolean)capable indicates that
2474 * the course format supports Moodle course ajax features.
c0b5d925
DM
2475 *
2476 * @param string $format
2477 * @return stdClass
2478 */
2479function course_format_ajax_support($format) {
ee7084e9
MG
2480 $course = new stdClass();
2481 $course->format = $format;
2482 return course_get_format($course)->supports_ajax();
c0b5d925
DM
2483}
2484
2585a68d 2485/**
2486 * Can the current user delete this course?
8b449a39 2487 * Course creators have exception,
2488 * 1 day after the creation they can sill delete the course.
2585a68d 2489 * @param int $courseid
2490 * @return boolean
2585a68d 2491 */
2492function can_delete_course($courseid) {
536c0865 2493 global $USER;
2585a68d 2494
9a5e297b 2495 $context = context_course::instance($courseid);
2585a68d 2496
8b449a39 2497 if (has_capability('moodle/course:delete', $context)) {
2498 return true;
2499 }
2500
2501 // hack: now try to find out if creator created this course recently (1 day)
2502 if (!has_capability('moodle/course:create', $context)) {
2503 return false;
2504 }
2505
2506 $since = time() - 60*60*24;
536c0865
AA
2507 $course = get_course($courseid);
2508
2509 if ($course->timecreated < $since) {
2510 return false; // Return if the course was not created in last 24 hours.
2511 }
2512
2513 $logmanger = get_log_manager();
59aebbed 2514 $readers = $logmanger->get_readers('\core\log\sql_reader');
536c0865
AA
2515 $reader = reset($readers);
2516
2517 if (empty($reader)) {
2518 return false; // No log reader found.
2519 }
8b449a39 2520
536c0865
AA
2521 // A proper reader.
2522 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2523 $params = array('userid' => $USER->id, 'since' => $since, 'courseid' => $course->id, 'eventname' => '\core\event\course_created');
8b449a39 2524
536c0865 2525 return (bool)$reader->get_events_select_count($select, $params);
2585a68d 2526}
2527
bef12c99 2528/**
2529 * Save the Your name for 'Some role' strings.
2530 *
2531 * @param integer $courseid the id of this course.
2532 * @param array $data the data that came from the course settings form.
2533 */
2534function save_local_role_names($courseid, $data) {
2535 global $DB;
9a5e297b 2536 $context = context_course::instance($courseid);
bef12c99 2537
2538 foreach ($data as $fieldname => $value) {
df997f84 2539 if (strpos($fieldname, 'role_') !== 0) {
bef12c99 2540 continue;
2541 }
2542 list($ignored, $roleid) = explode('_', $fieldname);
2543
2544 // make up our mind whether we want to delete, update or insert
2545 if (!$value) {
2546 $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2547
2548 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2549 $rolename->name = $value;
2550 $DB->update_record('role_names', $rolename);
2551
2552 } else {
2553 $rolename = new stdClass;
2554 $rolename->contextid = $context->id;
2555 $rolename->roleid = $roleid;
2556 $rolename->name = $value;
2557 $DB->insert_record('role_names', $rolename);
2558 }
29d4cc65
DP
2559 // This will ensure the course contacts cache is purged..
2560 coursecat::role_assignment_changed($roleid, $context);
bef12c99 2561 }
2562}
2585a68d 2563
d1f8c1bd
MG
2564/**
2565 * Returns options to use in course overviewfiles filemanager
2566 *
2567 * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2568 * may be empty if course does not exist yet (course create form)
2569 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2570 * or null if overviewfiles are disabled
2571 */
2572function course_overviewfiles_options($course) {
2573 global $CFG;
2574 if (empty($CFG->courseoverviewfileslimit)) {
2575 return null;
2576 }
2577 $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2578 if (in_array('*', $accepted_types) || empty($accepted_types)) {
2579 $accepted_types = '*';
2580 } else {
2581 // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2582 // Make sure extensions are prefixed with dot unless they are valid typegroups
2583 foreach ($accepted_types as $i => $type) {
2584 if (substr($type, 0, 1) !== '.') {
2585 require_once($CFG->libdir. '/filelib.php');
2586 if (!count(file_get_typegroup('extension', $type))) {
2587 // It does not start with dot and is not a valid typegroup, this is most likely extension.
2588 $accepted_types[$i] = '.'. $type;
2589 $corrected = true;
2590 }
2591 }
2592 }
2593 if (!empty($corrected)) {
2594 set_config('courseoverviewfilesext', join(',', $accepted_types));
2595 }
2596 }
2597 $options = array(
2598 'maxfiles' => $CFG->courseoverviewfileslimit,
2599 'maxbytes' => $CFG->maxbytes,
2600 'subdirs' => 0,
2601 'accepted_types' => $accepted_types
2602 );
2603 if (!empty($course->id)) {
2604 $options['context'] = context_course::instance($course->id);
2605 } else if (is_int($course) && $course > 0) {
2606 $options['context'] = context_course::instance($course);
2607 }
2608 return $options;
2609}
2610
c3df0901 2611/**
df997f84
PS
2612 * Create a course and either return a $course object
2613 *
2614 * Please note this functions does not verify any access control,
2615 * the calling code is responsible for all validation (usually it is the form definition).
bfefa87e 2616 *
df997f84 2617 * @param array $editoroptions course description editor options
bfefa87e 2618 * @param object $data - all the data needed for an entry in the 'course' table
df997f84 2619 * @return object new course instance
bfefa87e 2620 */
df997f84 2621function create_course($data, $editoroptions = NULL) {
0d1e5456 2622 global $DB, $CFG;
bfefa87e 2623
df997f84
PS
2624 //check the categoryid - must be given for all new courses
2625 $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
71b77297 2626
9930e426 2627 // Check if the shortname already exists.
df997f84
PS
2628 if (!empty($data->shortname)) {
2629 if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
9930e426 2630 throw new moodle_exception('shortnametaken', '', '', $data->shortname);
71b77297 2631 }
2632 }
2633
9930e426 2634 // Check if the idnumber already exists.
df997f84
PS
2635 if (!empty($data->idnumber)) {
2636 if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
9930e426 2637 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
71b77297 2638 }
2639 }
2f48819b 2640
9a4231e9
S
2641 // Check if timecreated is given.
2642 $data->timecreated = !empty($data->timecreated) ? $data->timecreated : time();
df997f84 2643 $data->timemodified = $data->timecreated;
71b77297 2644
df997f84
PS
2645 // place at beginning of any category
2646 $data->sortorder = 0;
00f270bc 2647
df997f84
PS
2648 if ($editoroptions) {
2649 // summary text is updated later, we need context to store the files first
2650 $data->summary = '';
2651 $data->summary_format = FORMAT_HTML;
2652 }
2653
db1218a9
PS
2654 if (!isset($data->visible)) {
2655 // data not from form, add missing visibility info
54a01598 2656 $data->visible = $category->visible;
bfefa87e 2657 }
db1218a9 2658 $data->visibleold = $data->visible;
2585a68d 2659
df997f84 2660 $newcourseid = $DB->insert_record('course', $data);
9a5e297b 2661 $context = context_course::instance($newcourseid, MUST_EXIST);
bfefa87e 2662
df997f84
PS
2663 if ($editoroptions) {
2664 // Save the files used in the summary editor and store
64f93798 2665 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
df997f84
PS
2666 $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2667 $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2668 }
d1f8c1bd
MG
2669 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2670 // Save the course overviewfiles
2671 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2672 }
bfefa87e 2673
fc79ede5
MG
2674 // update course format options
2675 course_get_format($newcourseid)->update_course_format_options($data);
2676
2677 $course = course_get_format($newcourseid)->get_course();
bfefa87e 2678
df997f84 2679 fix_course_sortorder();
eabbfa82
MG
2680 // purge appropriate caches in case fix_course_sortorder() did not change anything
2681 cache_helper::purge_by_event('changesincourse');
bfefa87e 2682
df997f84 2683 // new context created - better mark it as dirty
1de02d62 2684 $context->mark_dirty();
bfefa87e 2685
2542cb54
MG
2686 // Trigger a course created event.
2687 $event = \core\event\course_created::create(array(
2688 'objectid' => $course->id,
2689 'context' => context_course::instance($course->id),
2690 'other' => array('shortname' => $course->shortname,
2691 'fullname' => $course->fullname)
2692 ));
2693 $event->trigger();
2694
2695 // Setup the blocks
2696 blocks_add_default_course_blocks($course);
2697
2698 // Create a default section.
2699 course_create_sections_if_missing($course, 0);
2700
df997f84 2701 // Save any custom role names.
e92c39ca 2702 save_local_role_names($course->id, (array)$data);
bfefa87e 2703
df997f84
PS
2704 // set up enrolments
2705 enrol_course_updated(true, $course, $data);
bef12c99 2706
0d1e5456 2707 // Update course tags.
74fa9f76
MG
2708 if (isset($data->tags)) {
2709 core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
0d1e5456
MG
2710 }
2711
df997f84 2712 return $course;
bfefa87e 2713}
2714
c3df0901 2715/**
df997f84
PS
2716 * Update a course.
2717 *
2718 * Please note this functions does not verify any access control,
2719 * the calling code is responsible for all validation (usually it is the form definition).
bfefa87e 2720 *
2721 * @param object $data - all the data needed for an entry in the 'course' table
df997f84
PS
2722 * @param array $editoroptions course description editor options
2723 * @return void
bfefa87e 2724 */
df997f84 2725function update_course($data, $editoroptions = NULL) {
0d1e5456 2726 global $DB, $CFG;
bfefa87e 2727
df997f84 2728 $data->timemodified = time();
ddb0a19f 2729
fc79ede5 2730 $oldcourse = course_get_format($data->id)->get_course();
9a5e297b 2731 $context = context_course::instance($oldcourse->id);
bfefa87e 2732
df997f84 2733 if ($editoroptions) {
64f93798 2734 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
71b77297 2735 }
d1f8c1bd
MG
2736 if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2737 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2738 }
71b77297 2739
5536a561
FD
2740 // Check we don't have a duplicate shortname.
2741 if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
e1301685 2742 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname, $data->id))) {
5536a561
FD
2743 throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2744 }
2745 }
2746
2747 // Check we don't have a duplicate idnumber.
2748 if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
e1301685 2749 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber, $data->id))) {
5536a561
FD
2750 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2751 }
2752 }
2753
df997f84
PS
2754 if (!isset($data->category) or empty($data->category)) {
2755 // prevent nulls and 0 in category field
bfefa87e 2756 unset($data->category);
2757 }
b80a50f7 2758 $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
bfefa87e 2759
db1218a9
PS
2760 if (!isset($data->visible)) {
2761 // data not from form, add missing visibility info
df997f84
PS
2762 $data->visible = $oldcourse->visible;
2763 }
bfefa87e 2764
df997f84
PS
2765 if ($data->visible != $oldcourse->visible) {
2766 // reset the visibleold flag when manually hiding/unhiding course
2767 $data->visibleold = $data->visible;
b55248d5 2768 $changesincoursecat = true;
df997f84 2769 } else {
a372aab5 2770 if ($movecat) {
df997f84
PS
2771 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2772 if (empty($newcategory->visible)) {
2773 // make sure when moving into hidden category the course is hidden automatically
2774 $data->visible = 0;
2775 }
a372aab5 2776 }
df997f84 2777 }
a372aab5 2778
df997f84 2779 // Update with the new data
487caf6b 2780 $DB->update_record('course', $data);
38b19bbc
MG
2781 // make sure the modinfo cache is reset
2782 rebuild_course_cache($data->id);
bfefa87e 2783
fc79ede5
MG
2784 // update course format options with full course data
2785 course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2786
df997f84 2787 $course = $DB->get_record('course', array('id'=>$data->id));
bfefa87e 2788
df997f84 2789 if ($movecat) {
9a5e297b 2790 $newparent = context_coursecat::instance($course->category);
2c5b0eb7 2791 $context->update_moved($newparent);
df997f84 2792 }
3a11e2d2
RT
2793 $fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
2794 if ($fixcoursesortorder) {
24f824b9
MG
2795 fix_course_sortorder();
2796 }
2797
eabbfa82
MG
2798 // purge appropriate caches in case fix_course_sortorder() did not change anything
2799 cache_helper::purge_by_event('changesincourse');
b55248d5 2800 if ($changesincoursecat) {
b80a50f7
MG
2801 cache_helper::purge_by_event('changesincoursecat');
2802 }
bfefa87e 2803
df997f84
PS
2804 // Test for and remove blocks which aren't appropriate anymore
2805 blocks_remove_inappropriate($course);
bfefa87e 2806
df997f84
PS
2807 // Save any custom role names.
2808 save_local_role_names($course->id, $data);
2809
2810 // update enrol settings
2811 enrol_course_updated(false, $course, $data);
2812
0d1e5456 2813 // Update course tags.
74fa9f76
MG
2814 if (isset($data->tags)) {
2815 core_tag_tag::set_item_tags('core', 'course', $course->id, context_course::instance($course->id), $data->tags);
0d1e5456
MG
2816 }
2817
53a8e678
MN
2818 // Trigger a course updated event.
2819 $event = \core\event\course_updated::create(array(
2820 'objectid' => $course->id,
3a11e2d2 2821 'context' => context_course::instance($course->id),
53a8e678
MN
2822 'other' => array('shortname' => $course->shortname,
2823 'fullname' => $course->fullname)
2824 ));
3a11e2d2 2825
2bf2f359 2826 $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
53a8e678 2827 $event->trigger();
fc79ede5
MG
2828
2829 if ($oldcourse->format !== $course->format) {
2830 // Remove all options stored for the previous format
2831 // We assume that new course format migrated everything it needed watching trigger
2832 // 'course_updated' and in method format_XXX::update_course_format_options()
2833 $DB->delete_records('course_format_options',
2834 array('courseid' => $course->id, 'format' => $oldcourse->format));
2835 }
bfefa87e 2836}
2585a68d 2837
07ab0c80 2838/**
fcb4decd 2839 * Average number of participants
07ab0c80 2840 * @return integer
2841 */
2842function average_number_of_participants() {
fcb4decd 2843 global $DB, $SITE;
2844
2845 //count total of enrolments for visible course (except front page)
2846 $sql = 'SELECT COUNT(*) FROM (
2847 SELECT DISTINCT ue.userid, e.courseid
2848 FROM {user_enrolments} ue, {enrol} e, {course} c
516c5eca 2849 WHERE ue.enrolid = e.id
fcb4decd 2850 AND e.courseid <> :siteid
2851 AND c.id = e.courseid
9f247093 2852 AND c.visible = 1) total';
fcb4decd 2853 $params = array('siteid' => $SITE->id);
2854 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2855
2856
2857 //count total of visible courses (minus front page)
2858 $coursetotal = $DB->count_records('course', array('visible' => 1));
2859 $coursetotal = $coursetotal - 1 ;
2860
2861 //average of enrolment
2862 if (empty($coursetotal)) {
2863 $participantaverage = 0;
2864 } else {
2865 $participantaverage = $enrolmenttotal / $coursetotal;
2866 }
2867
2868 return $participantaverage;
07ab0c80 2869}
2870
2871/**
fcb4decd 2872 * Average number of course modules
07ab0c80 2873 * @return integer
2874 */
2875function average_number_of_courses_modules() {
fcb4decd 2876 global $DB, $SITE;
2877
2878 //count total of visible course module (except front page)
2879 $sql = 'SELECT COUNT(*) FROM (
2880 SELECT cm.course, cm.module
2881 FROM {course} c, {course_modules} cm
516c5eca 2882 WHERE c.id = cm.course
fcb4decd 2883 AND c.id <> :siteid
2884 AND cm.visible = 1
9f247093 2885 AND c.visible = 1) total';
fcb4decd 2886 $params = array('siteid' => $SITE->id);
2887 $moduletotal = $DB->count_records_sql($sql, $params);
2888
2889
2890 //count total of visible courses (minus front page)
2891 $coursetotal = $DB->count_records('course', array('visible' => 1));
2892 $coursetotal = $coursetotal - 1 ;
2893
2894 //average of course module
2895 if (empty($coursetotal)) {
2896 $coursemoduleaverage = 0;
2897 } else {
2898 $coursemoduleaverage = $moduletotal / $coursetotal;
2899 }
2900
2901 return $coursemoduleaverage;
07ab0c80 2902}
2903
8bdc9cac
SH
2904/**
2905 * This class pertains to course requests and contains methods associated with
2906 * create, approving, and removing course requests.
2907 *
64f93798
PS
2908 * Please note we do not allow embedded images here because there is no context
2909 * to store them with proper access control.
2910 *
8bdc9cac
SH
2911 * @copyright 2009 Sam Hemelryk
2912 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2913 * @since Moodle 2.0
2914 *
2915 * @property-read int $id
2916 * @property-read string $fullname
2917 * @property-read string $shortname
2918 * @property-read string $summary
2919 * @property-read int $summaryformat
2920 * @property-read int $summarytrust
2921 * @property-read string $reason
2922 * @property-read int $requester
8bdc9cac
SH
2923 */
2924class course_request {
2925
2926 /**
2927 * This is the stdClass that stores the properties for the course request
7e85563d 2928 * and is externally accessed through the __get magic method
8bdc9cac
SH
2929 * @var stdClass
2930 */
2931 protected $properties;
2932
2933 /**
2934 * An array of options for the summary editor used by course request forms.
2935 * This is initially set by {@link summary_editor_options()}
2936 * @var array
2937 * @static
2938 */
2939 protected static $summaryeditoroptions;
2940
8bdc9cac
SH
2941 /**
2942 * Static function to prepare the summary editor for working with a course
2943 * request.
2944 *
2945 * @static
2946 * @param null|stdClass $data Optional, an object containing the default values
2947 * for the form, these may be modified when preparing the
2948 * editor so this should be called before creating the form
2949 * @return stdClass An object that can be used to set the default values for
2950 * an mforms form
2951 */
2952 public static function prepare($data=null) {
2953 if ($data === null) {
2954 $data = new stdClass;
2955 }
64f93798 2956 $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
8bdc9cac
SH
2957 return $data;
2958 }
2959
2960 /**
2961 * Static function to create a new course request when passed an array of properties
2962 * for it.
2963 *
2964 * This function also handles saving any files that may have been used in the editor
2965 *
2966 * @static
2967 * @param stdClass $data
2968 * @return course_request The newly created course request
2969 */
2970 public static function create($data) {
2971 global $USER, $DB, $CFG;
2972 $data->requester = $USER->id;
64f93798 2973
d347f304 2974 // Setting the default category if none set.
59b9a140
FM
2975 if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2976 $data->category = $CFG->defaultrequestcategory;
2977 }
2978
64f93798
PS
2979 // Summary is a required field so copy the text over
2980 $data->summary = $data->summary_editor['text'];
2981 $data->summaryformat = $data->summary_editor['format'];
2982
8bdc9cac 2983 $data->id = $DB->insert_record('course_request', $data);
64f93798 2984
8bdc9cac
SH
2985 // Create a new course_request object and return it
2986 $request = new course_request($data);
2987
2988 // Notify the admin if required.
adf176d7 2989 if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
aa6c1ced 2990
8bdc9cac
SH
2991 $a = new stdClass;
2992 $a->link = "$CFG->wwwroot/course/pending.php";
2993 $a->user = fullname($USER);
2994 $subject = get_string('courserequest');
2995 $message = get_string('courserequestnotifyemail', 'admin', $a);
2996 foreach ($users as $user) {
2a63b636 2997 $request->notify($user, $USER, 'courserequested', $subject, $message);
8bdc9cac
SH
2998 }
2999 }
3000
3001 return $request;
3002 }
3003
3004 /**
3005 * Returns an array of options to use with a summary editor
3006 *
3007 * @uses course_request::$summaryeditoroptions
3008 * @return array An array of options to use with the editor
3009 */
3010 public static function summary_editor_options() {
3011 global $CFG;
3012 if (self::$summaryeditoroptions === null) {
64f93798 3013 self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
8bdc9cac
SH
3014 }
3015 return self::$summaryeditoroptions;
3016 }
3017
8bdc9cac
SH
3018 /**
3019 * Loads the properties for this course request object. Id is required and if
3020 * only id is provided then we load the rest of the properties from the database
3021 *
3022 * @param stdClass|int $properties Either an object containing properties
3023 * or the course_request id to load
3024 */
3025 public function __construct($properties) {
3026 global $DB;
3027 if (empty($properties->id)) {
3028 if (empty($properties)) {
3029 throw new coding_exception('You must provide a course request id when creating a course_request object');
3030 }
3031 $id = $properties;
3032 $properties = new stdClass;
3033 $properties->id = (int)$id;
3034 unset($id);
3035 }
3036 if (empty($properties->requester)) {
3037 if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
3038 print_error('unknowncourserequest');
3039 }
3040 } else {
3041 $this->properties = $properties;
3042 }
3043 $this->properties->collision = null;
3044 }
3045
3046 /**
3047 * Returns the requested property
3048 *
3049 * @param string $key
3050 * @return mixed
3051 */
3052 public function __get($key) {
8bdc9cac
SH
3053 return $this->properties->$key;
3054 }
3055
3056 /**
3057 * Override this to ensure empty($request->blah) calls return a reliable answer...
3058 *
3059 * This is required because we define the __get method
3060 *
3061 * @param mixed $key
3062 * @return bool True is it not empty, false otherwise
3063 */
3064 public function __isset($key) {
3065 return (!empty($this->properties->$key));
3066 }
3067
3068 /**
3069 * Returns the user who requested this course
3070 *
3071 * Uses a static var to cache the results and cut down the number of db queries
3072 *
3073 * @staticvar array $requesters An array of cached users
3074 * @return stdClass The user who requested the course
3075 */
3076 public function get_requester() {
3077 global $DB;
3078 static $requesters= array();
3079 if (!array_key_exists($this->properties->requester, $requesters)) {
3080 $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3081 }
3082 return $requesters[$this->properties->requester];
3083 }
3084
3085 /**
3086 * Checks that the shortname used by the course does not conflict with any other
3087 * courses that exist
3088 *
3089 * @param string|null $shortnamemark The string to append to the requests shortname
3090 * should a conflict be found
3091 * @return bool true is there is a conflict, false otherwise
3092 */
3093 public function check_shortname_collision($shortnamemark = '[*]') {
3094 global $DB;
3095
3096 if ($this->properties->collision !== null) {
3097 return $this->properties->collision;
3098 }
3099
3100 if (empty($this->properties->shortname)) {
3101 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3102 $this->properties->collision = false;
3103 } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3104 if (!empty($shortnamemark)) {
3105 $this->properties->shortname .= ' '.$shortnamemark;
3106 }
3107 $this->properties->collision = true;
3108 } else {
3109 $this->properties->collision = false;
3110 }
3111 return $this->properties->collision;
3112 }
3113
2d8a275b
MG
3114 /**
3115 * Returns the category where this course request should be created
3116 *
3117 * Note that we don't check here that user has a capability to view
3118 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
3119 * 'moodle/course:changecategory'
3120 *
3121 * @return coursecat
3122 */
3123 public function get_category() {
3124 global $CFG;
3125 require_once($CFG->libdir.'/coursecatlib.php');
3126 // If the category is not set, if the current user does not have the rights to change the category, or if the
3127 // category does not exist, we set the default category to the course to be approved.
3128 // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3129 if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
3130 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
3131 $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
3132 }
3133 if (!$category) {
3134 $category = coursecat::get_default();
3135 }
3136 return $category;
3137 }
3138
8bdc9cac
SH
3139 /**
3140 * This function approves the request turning it into a course
3141 *
3142 * This function converts the course request into a course, at the same time
7e85563d 3143 * transferring any files used in the summary to the new course and then removing
8bdc9cac
SH
3144 * the course request and the files associated with it.
3145 *
3146 * @return int The id of the course that was created from this request
3147 */
3148 public function approve() {
3149 global $CFG, $DB, $USER;
70740405
PS
3150
3151 $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3152
8bdc9cac
SH
3153 $courseconfig = get_config('moodlecourse');
3154
3155 // Transfer appropriate settings
70740405
PS
3156 $data = clone($this->properties);
3157 unset($data->id);
3158 unset($data->reason);
3159 unset($data->requester);
8bdc9cac
SH
3160
3161 // Set category
2d8a275b 3162 $category = $this->get_category();
70740405 3163 $data->category = $category->id;
8bdc9cac 3164 // Set misc settings
70740405 3165 $data->requested = 1;
8bdc9cac
SH
3166
3167 // Apply course default settings
70740405 3168 $data->format = $courseconfig->format;
70740405
PS
3169 $data->newsitems = $courseconfig->newsitems;
3170 $data->showgrades = $courseconfig->showgrades;
3171 $data->showreports = $courseconfig->showreports;
3172 $data->maxbytes = $courseconfig->maxbytes;
3173 $data->groupmode = $courseconfig->groupmode;
3174 $data->groupmodeforce = $courseconfig->groupmodeforce;
3175 $data->visible = $courseconfig->visible;
3176 $data->visibleold = $data->visible;
3177 $data->lang = $courseconfig->lang;
8bdc9cac 3178
70740405 3179 $course = create_course($data);
1f364c87 3180 $context = context_course::instance($course->id, MUST_EXIST);
8bdc9cac 3181
70740405
PS
3182 // add enrol instances
3183 if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3184 if ($manual = enrol_get_plugin('manual')) {
3185 $manual->add_default_instance($course);
3186 }
8bdc9cac 3187 }
70740405
PS
3188
3189 // enrol the requester as teacher if necessary
3190 if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3191 enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3192 }
3193
3194 $this->delete();
3195
fbaea88f 3196 $a = new stdClass();
9a5e297b 3197 $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
70740405
PS
3198 $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3199 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3200
3201 return $course->id;
8bdc9cac
SH
3202 }
3203
3204 /**
3205 * Reject a course request
3206 *
3207 * This function rejects a course request, emailing the requesting user the
3208 * provided notice and then removing the request from the database
3209 *
3210 * @param string $notice The message to display to the user
3211 */
3212 public function reject($notice) {
70740405
PS
3213 global $USER, $DB;
3214 $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
8bdc9cac
SH
3215 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3216 $this->delete();
3217 }
3218
3219 /**
3220 * Deletes the course request and any associated files
3221 */
3222 public function delete() {
3223 global $DB;
3224 $DB->delete_records('course_request', array('id' => $this->properties->id));
8bdc9cac
SH
3225 }
3226
3227 /**
3228 * Send a message from one user to another using events_trigger
3229 *
3230 * @param object $touser
3231 * @param object $fromuser
3232 * @param string $name
3233 * @param string $subject
3234 * @param string $message
3235 */
3236 protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
fbaea88f 3237 $eventdata = new stdClass();
a1708181 3238 $eventdata->component = 'moodle';
8bdc9cac
SH
3239 $eventdata->name = $name;
3240 $eventdata->userfrom = $fromuser;
3241 $eventdata->userto = $touser;
3242 $eventdata->subject = $subject;
3243 $eventdata->fullmessage = $message;
3244 $eventdata->fullmessageformat = FORMAT_PLAIN;
3245 $eventdata->fullmessagehtml = '';
3246 $eventdata->smallmessage = '';
a1708181 3247 $eventdata->notification = 1;
7c7d3afa 3248 message_send($eventdata);
8bdc9cac 3249 }
5c34c4ba 3250}
b1627a92
DC
3251
3252/**
3253 * Return a list of page types
3254 * @param string $pagetype current page type
9dd85edf
MG
3255 * @param context $parentcontext Block's parent context
3256 * @param context $currentcontext Current context of block
3257 * @return array array of page types
b1627a92 3258 */
b38e2e28 3259function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
9dd85edf
MG
3260 if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
3261 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3262 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3263 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3264 );
3265 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
3266 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3267 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3268 } else {
3269 // Otherwise consider it a page inside a course even if $currentcontext is null
3270 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3271 'course-*' => get_string('page-course-x', 'pagetype'),
3272 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3273 );
b1627a92 3274 }
9dd85edf 3275 return $pagetypes;
af27c69e 3276}
ebaa29d1 3277
5720019d
ARN
3278/**
3279 * Determine whether course ajax should be enabled for the specified course
3280 *
924c34df 3281 * @param stdClass $course The course to test against
5720019d
ARN
3282 * @return boolean Whether course ajax is enabled or note
3283 */
3284function course_ajax_enabled($course) {
3285 global $CFG, $PAGE, $SITE;
3286
5720019d
ARN
3287 // The user must be editing for AJAX to be included
3288 if (!$PAGE->user_is_editing()) {
3289 return false;
3290 }
3291
3292 // Check that the theme suports
3293 if (!$PAGE->theme->enablecourseajax) {
3294 return false;
3295 }
3296
3297 // Check that the course format supports ajax functionality
3298 // The site 'format' doesn't have information on course format support
3299 if ($SITE->id !== $course->id) {
3300 $courseformatajaxsupport = course_format_ajax_support($course->format);
3301 if (!$courseformatajaxsupport->capable) {
3302 return false;
3303 }
3304 }
3305
3306 // All conditions have been met so course ajax should be enabled
3307 return true;
3308}
3309
ebaa29d1
ARN
3310/**
3311 * Include the relevant javascript and language strings for the resource
3312 * toolbox YUI module
3313 *
3314 * @param integer $id The ID of the course being applied to
7b061512
SH
3315 * @param array $usedmodules An array containing the names of the modules in use on the page
3316 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
924c34df 3317 * @param stdClass $config An obj