MDL-52370 course: purge contacts cache on role rename
[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))) {
1201 $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
1f6988bb
FM
1202
1203 $event = \core\event\course_section_updated::create(array(
1204 'context' => context_course::instance($courseid),
1205 'objectid' => $section->id,
1206 'other' => array(
1207 'sectionnum' => $sectionnumber
1208 )
1209 ));
1210 $event->add_record_snapshot('course_sections', $section);
1211 $event->trigger();
1212
7d99d695 1213 if (!empty($section->sequence)) {
1214 $modules = explode(",", $section->sequence);
1215 foreach ($modules as $moduleid) {
9e533215 1216 if ($cm = get_coursemodule_from_id(null, $moduleid, $courseid)) {
00a34234
FM
1217 if ($visibility) {
1218 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1219 set_coursemodule_visible($moduleid, $cm->visibleold);
1220 } else {
1221 // We hide the section, so we hide the module but we store the original state in visibleold.
1222 set_coursemodule_visible($moduleid, 0);
1223 $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1224 }
9e533215 1225 \core\event\course_module_updated::create_from_cm($cm)->trigger();
00a34234 1226 }
7d99d695 1227 }
1228 }
38b19bbc 1229 rebuild_course_cache($courseid, true);
ebaa29d1
ARN
1230
1231 // Determine which modules are visible for AJAX update
1232 if (!empty($modules)) {
1233 list($insql, $params) = $DB->get_in_or_equal($modules);
1234 $select = 'id ' . $insql . ' AND visible = ?';
1235 array_push($params, $visibility);
1236 if (!$visibility) {
1237 $select .= ' AND visibleold = 1';
1238 }
1239 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1240 }
7d99d695 1241 }
ebaa29d1 1242 return $resourcestotoggle;
7d99d695 1243}
ba2e5d73 1244
59155a3f
ARN
1245/**
1246 * Retrieve all metadata for the requested modules
1247 *
1248 * @param object $course The Course
1249 * @param array $modnames An array containing the list of modules and their
1250 * names
a41b1d96 1251 * @param int $sectionreturn The section to return to
59155a3f
ARN
1252 * @return array A list of stdClass objects containing metadata about each
1253 * module
1254 */
923451c5 1255function get_module_metadata($course, $modnames, $sectionreturn = null) {
59155a3f
ARN
1256 global $CFG, $OUTPUT;
1257
1258 // get_module_metadata will be called once per section on the page and courses may show
1259 // different modules to one another
1260 static $modlist = array();
1261 if (!isset($modlist[$course->id])) {
1262 $modlist[$course->id] = array();
1263 }
1264
1265 $return = array();
17079335
MG
1266 $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1267 if ($sectionreturn !== null) {
1268 $urlbase->param('sr', $sectionreturn);
1269 }
59155a3f
ARN
1270 foreach($modnames as $modname => $modnamestr) {
1271 if (!course_allowed_module($course, $modname)) {
1272 continue;
1273 }
ad47d025 1274 if (isset($modlist[$course->id][$modname])) {
59155a3f
ARN
1275 // This module is already cached
1276 $return[$modname] = $modlist[$course->id][$modname];
1277 continue;
1278 }
1279
1280 // Include the module lib
1281 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1282 if (!file_exists($libfile)) {
1283 continue;
1284 }
1285 include_once($libfile);
1286
1287 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1288 $gettypesfunc = $modname.'_get_types';
50ae8814 1289 $types = MOD_SUBTYPE_NO_CHILDREN;
59155a3f 1290 if (function_exists($gettypesfunc)) {
56c0878b 1291 $types = $gettypesfunc();
50ae8814
MN
1292 }
1293 if ($types !== MOD_SUBTYPE_NO_CHILDREN) {
56c0878b 1294 if (is_array($types) && count($types) > 0) {
59155a3f
ARN
1295 $group = new stdClass();
1296 $group->name = $modname;
1297 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1298 foreach($types as $type) {
1299 if ($type->typestr === '--') {
1300 continue;
1301 }
1302 if (strpos($type->typestr, '--') === 0) {
1303 $group->title = str_replace('--', '', $type->typestr);
1304 continue;
1305 }
1306 // Set the Sub Type metadata
1307 $subtype = new stdClass();
1308 $subtype->title = $type->typestr;
1309 $subtype->type = str_replace('&amp;', '&', $type->type);
1310 $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1311 $subtype->archetype = $type->modclass;
1312
1313 // The group archetype should match the subtype archetypes and all subtypes
1314 // should have the same archetype
1315 $group->archetype = $subtype->archetype;
1316
50ae8814
MN
1317 if (!empty($type->help)) {
1318 $subtype->help = $type->help;
1319 } else if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
59155a3f
ARN
1320 $subtype->help = get_string('help' . $subtype->name, $modname);
1321 }
cf003abc 1322 $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
59155a3f
ARN
1323 $group->types[] = $subtype;
1324 }
1325 $modlist[$course->id][$modname] = $group;
1326 }
1327 } else {
1328 $module = new stdClass();
17079335 1329 $module->title = $modnamestr;
59155a3f 1330 $module->name = $modname;
17079335 1331 $module->link = new moodle_url($urlbase, array('add' => $modname));
59155a3f 1332 $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
01e0e704
ARN
1333 $sm = get_string_manager();
1334 if ($sm->string_exists('modulename_help', $modname)) {
59155a3f 1335 $module->help = get_string('modulename_help', $modname);
01e0e704
ARN
1336 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs
1337 $link = get_string('modulename_link', $modname);
1338 $linktext = get_string('morehelp');
afe3566c 1339 $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
01e0e704 1340 }
59155a3f
ARN
1341 }
1342 $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1343 $modlist[$course->id][$modname] = $module;
1344 }
56c0878b
SC
1345 if (isset($modlist[$course->id][$modname])) {
1346 $return[$modname] = $modlist[$course->id][$modname];
1347 } else {
1348 debugging("Invalid module metadata configuration for {$modname}");
1349 }
59155a3f
ARN
1350 }
1351
1352 return $return;
1353}
1354
8ed5dd63 1355/**
1356 * Return the course category context for the category with id $categoryid, except
1357 * that if $categoryid is 0, return the system context.
1358 *
1359 * @param integer $categoryid a category id or 0.
5dc361e1 1360 * @return context the corresponding context
8ed5dd63 1361 */
1362function get_category_or_system_context($categoryid) {
1363 if ($categoryid) {
4658aec5 1364 return context_coursecat::instance($categoryid, IGNORE_MISSING);
8ed5dd63 1365 } else {
9a5e297b 1366 return context_system::instance();
8ed5dd63 1367 }
1368}
1369
cb6fec1f 1370/**
4e0b6025
MG
1371 * Returns full course categories trees to be used in html_writer::select()
1372 *
1373 * Calls {@link coursecat::make_categories_list()} to build the tree and
1374 * adds whitespace to denote nesting
1375 *
1376 * @return array array mapping coursecat id to the display name
cb6fec1f 1377 */
0705ff84 1378function make_categories_options() {
4e0b6025
MG
1379 global $CFG;
1380 require_once($CFG->libdir. '/coursecatlib.php');
a7a04f6d 1381 $cats = coursecat::make_categories_list('', 0, ' / ');
0705ff84 1382 foreach ($cats as $key => $value) {
a7a04f6d
MG
1383 // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1384 $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
0705ff84 1385 }
1386 return $cats;
1387}
c2cb4545 1388
77eddcd5 1389/**
1390 * Print the buttons relating to course requests.
1391 *
8e57a6df 1392 * @param object $context current page context.
77eddcd5 1393 */
8e57a6df 1394function print_course_request_buttons($context) {
b4531207 1395 global $CFG, $DB, $OUTPUT;
77eddcd5 1396 if (empty($CFG->enablecourserequests)) {
1397 return;
1398 }
8e57a6df 1399 if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
77eddcd5 1400 /// Print a button to request a new course
8e57a6df 1401 echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
77eddcd5 1402 }
1403 /// Print a button to manage pending requests
8e57a6df 1404 if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
5c2ed7e2 1405 $disabled = !$DB->record_exists('course_request', array());
8e57a6df 1406 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
77eddcd5 1407 }
1408}
1409
5048e034 1410/**
1411 * Does the user have permission to edit things in this category?
1412 *
1413 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1414 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1415 */
1416function can_edit_in_category($categoryid = 0) {
1417 $context = get_category_or_system_context($categoryid);
1418 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1419}
1420
11b0c469 1421/// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1422
1423function add_course_module($mod) {
cb6fec1f 1424 global $DB;
11b0c469 1425
e5dfd0f3 1426 $mod->added = time();
53f4ad2c 1427 unset($mod->id);
11b0c469 1428
38b19bbc
MG
1429 $cmid = $DB->insert_record("course_modules", $mod);
1430 rebuild_course_cache($mod->course, true);
1431 return $cmid;
11b0c469 1432}
1433
97928ddf 1434/**
4ede27b2 1435 * Creates missing course section(s) and rebuilds course cache
99e9f9a6 1436 *
b46be6ad 1437 * @param int|stdClass $courseorid course id or course object
4ede27b2
MG
1438 * @param int|array $sections list of relative section numbers to create
1439 * @return bool if there were any sections created
97928ddf 1440 */
b46be6ad 1441function course_create_sections_if_missing($courseorid, $sections) {
cb6fec1f 1442 global $DB;
4ede27b2
MG
1443 if (!is_array($sections)) {
1444 $sections = array($sections);
1445 }
b46be6ad
MG
1446 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1447 if (is_object($courseorid)) {
1448 $courseorid = $courseorid->id;
1449 }
4ede27b2
MG
1450 $coursechanged = false;
1451 foreach ($sections as $sectionnum) {
1452 if (!in_array($sectionnum, $existing)) {
1453 $cw = new stdClass();
b46be6ad 1454 $cw->course = $courseorid;
4ede27b2
MG
1455 $cw->section = $sectionnum;
1456 $cw->summary = '';
1457 $cw->summaryformat = FORMAT_HTML;
1458 $cw->sequence = '';
1459 $id = $DB->insert_record("course_sections", $cw);
1460 $coursechanged = true;
1461 }
1462 }
1463 if ($coursechanged) {
b46be6ad 1464 rebuild_course_cache($courseorid, true);
4ede27b2
MG
1465 }
1466 return $coursechanged;
97928ddf 1467}
52f14061 1468
ece966f0 1469/**
722e6ba9 1470 * Adds an existing module to the section
ece966f0 1471 *
722e6ba9
MG
1472 * Updates both tables {course_sections} and {course_modules}
1473 *
5523c344 1474 * Note: This function does not use modinfo PROVIDED that the section you are
1475 * adding the module to already exists. If the section does not exist, it will
1476 * build modinfo if necessary and create the section.
1477 *
722e6ba9 1478 * @param int|stdClass $courseorid course id or course object
46453565 1479 * @param int $cmid id of the module already existing in course_modules table
722e6ba9
MG
1480 * @param int $sectionnum relative number of the section (field course_sections.section)
1481 * If section does not exist it will be created
1482 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1483 * before which the module needs to be included. Null for inserting in the
1484 * end of the section
1485 * @return int The course_sections ID where the module is inserted
ece966f0 1486 */
46453565 1487function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
722e6ba9
MG
1488 global $DB, $COURSE;
1489 if (is_object($beforemod)) {
1490 $beforemod = $beforemod->id;
1491 }
46453565
PS
1492 if (is_object($courseorid)) {
1493 $courseid = $courseorid->id;
1494 } else {
1495 $courseid = $courseorid;
1496 }
46453565 1497 // Do not try to use modinfo here, there is no guarantee it is valid!
5523c344 1498 $section = $DB->get_record('course_sections',
1499 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
1500 if (!$section) {
1501 // This function call requires modinfo.
1502 course_create_sections_if_missing($courseorid, $sectionnum);
1503 $section = $DB->get_record('course_sections',
1504 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
1505 }
1506
722e6ba9 1507 $modarray = explode(",", trim($section->sequence));
281d730e 1508 if (empty($section->sequence)) {
46453565 1509 $newsequence = "$cmid";
722e6ba9 1510 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
46453565 1511 $insertarray = array($cmid, $beforemod);
722e6ba9
MG
1512 array_splice($modarray, $key[0], 1, $insertarray);
1513 $newsequence = implode(",", $modarray);
1514 } else {
46453565 1515 $newsequence = "$section->sequence,$cmid";
722e6ba9
MG
1516 }
1517 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
46453565 1518 $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
b46be6ad
MG
1519 if (is_object($courseorid)) {
1520 rebuild_course_cache($courseorid->id, true);
1521 } else {
1522 rebuild_course_cache($courseorid, true);
1523 }
722e6ba9 1524 return $section->id; // Return course_sections ID that was used.
11b0c469 1525}
1526
9e533215
SL
1527/**
1528 * Change the group mode of a course module.
1529 *
1530 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1531 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1532 *
1533 * @param int $id course module ID.
1534 * @param int $groupmode the new groupmode value.
1535 * @return bool True if the $groupmode was updated.
1536 */
48e535bc 1537function set_coursemodule_groupmode($id, $groupmode) {
cb6fec1f 1538 global $DB;
38b19bbc
MG
1539 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1540 if ($cm->groupmode != $groupmode) {
1541 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1542 rebuild_course_cache($cm->course, true);
1543 }
1544 return ($cm->groupmode != $groupmode);
3d575e6f 1545}
1546
177d4abf 1547function set_coursemodule_idnumber($id, $idnumber) {
cb6fec1f 1548 global $DB;
38b19bbc
MG
1549 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1550 if ($cm->idnumber != $idnumber) {
1551 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1552 rebuild_course_cache($cm->course, true);
1553 }
1554 return ($cm->idnumber != $idnumber);
177d4abf 1555}
4e781c7b 1556
02f66c42 1557/**
00a34234
FM
1558 * Set the visibility of a module and inherent properties.
1559 *
9e533215
SL
1560 * Note: Do not forget to trigger the event \core\event\course_module_updated as it needs
1561 * to be triggered manually, refer to {@link \core\event\course_module_updated::create_from_cm()}.
1562 *
00a34234
FM
1563 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1564 * has been moved to {@link set_section_visible()} which was the only place from which
1565 * the parameter was used.
1566 *
1567 * @param int $id of the module
1568 * @param int $visible state of the module
1569 * @return bool false when the module was not found, true otherwise
1570 */
1571function set_coursemodule_visible($id, $visible) {
f5e2602a 1572 global $DB, $CFG;
0f078024 1573 require_once($CFG->libdir.'/gradelib.php');
c5ceaeaf 1574 require_once($CFG->dirroot.'/calendar/lib.php');
0f078024 1575
00a34234
FM
1576 // Trigger developer's attention when using the previously removed argument.
1577 if (func_num_args() > 2) {
1578 debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1579 has been removed.', DEBUG_DEVELOPER);
1580 }
1581
cb6fec1f 1582 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
978abb42 1583 return false;
1584 }
40fcc261
AD
1585
1586 // Create events and propagate visibility to associated grade items if the value has changed.
1587 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1588 if ($cm->visible == $visible) {
1589 return true;
1590 }
1591
cb6fec1f 1592 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
978abb42 1593 return false;
1594 }
cb6fec1f 1595 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 1596 foreach($events as $event) {
48e535bc 1597 if ($visible) {
379cd2d4
EL
1598 $event = new calendar_event($event);
1599 $event->toggle_visibility(true);
48e535bc 1600 } else {
379cd2d4
EL
1601 $event = new calendar_event($event);
1602 $event->toggle_visibility(false);
48e535bc 1603 }
dcd338ff 1604 }
1605 }
f5e2602a 1606
00a34234
FM
1607 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1608 // affect visibleold to allow for an original visibility restore. See set_section_visible().
1609 $cminfo = new stdClass();
1610 $cminfo->id = $id;
1611 $cminfo->visible = $visible;
1612 $cminfo->visibleold = $visible;
1613 $DB->update_record('course_modules', $cminfo);
1614
1c73df9e
TH
1615 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
1616 // Note that this must be done after updating the row in course_modules, in case
1617 // the modules grade_item_update function needs to access $cm->visible.
1618 if (plugin_supports('mod', $modulename, FEATURE_CONTROLS_GRADE_VISIBILITY) &&
1619 component_callback_exists('mod_' . $modulename, 'grade_item_update')) {
1620 $instance = $DB->get_record($modulename, array('id' => $cm->instance), '*', MUST_EXIST);
1621 component_callback('mod_' . $modulename, 'grade_item_update', array($instance));
1622 } else {
1623 $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1624 if ($grade_items) {
1625 foreach ($grade_items as $grade_item) {
1626 $grade_item->set_hidden(!$visible);
1627 }
1628 }
1629 }
1630
38b19bbc
MG
1631 rebuild_course_cache($cm->course, true);
1632 return true;
1acfbce5 1633}
1634
cb6fec1f 1635/**
7f7144fd 1636 * This function will handle the whole deletion process of a module. This includes calling
a347aee3
MN
1637 * the modules delete_instance function, deleting files, events, grades, conditional data,
1638 * the data in the course_module and course_sections table and adding a module deletion
1639 * event to the DB.
290130b3 1640 *
a347aee3 1641 * @param int $cmid the course module id
5bcfd504 1642 * @since Moodle 2.5
290130b3 1643 */
a347aee3 1644function course_delete_module($cmid) {
63deb5c3 1645 global $CFG, $DB;
a347aee3 1646
f615fbab 1647 require_once($CFG->libdir.'/gradelib.php');
7f7144fd 1648 require_once($CFG->libdir.'/questionlib.php');
cae83708 1649 require_once($CFG->dirroot.'/blog/lib.php');
c5ceaeaf 1650 require_once($CFG->dirroot.'/calendar/lib.php');
7f7144fd 1651 require_once($CFG->dirroot.'/tag/lib.php');
f615fbab 1652
a347aee3
MN
1653 // Get the course module.
1654 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
290130b3 1655 return true;
1656 }
a347aee3
MN
1657
1658 // Get the module context.
1659 $modcontext = context_module::instance($cm->id);
1660
1661 // Get the course module name.
1662 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1663
1664 // Get the file location of the delete_instance function for this module.
1665 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1666
1667 // Include the file required to call the delete_instance function for this module.
1668 if (file_exists($modlib)) {
1669 require_once($modlib);
1670 } else {
9a9cb741
MN
1671 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1672 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
a347aee3
MN
1673 }
1674
9a9cb741 1675 $deleteinstancefunction = $modulename . '_delete_instance';
a347aee3 1676
9a9cb741
MN
1677 // Ensure the delete_instance function exists for this module.
1678 if (!function_exists($deleteinstancefunction)) {
1679 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1680 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1681 }
1682
7f7144fd
TB
1683 // Delete activity context questions and question categories.
1684 question_delete_activity($cm);
1685
9a9cb741 1686 // Call the delete_instance function, if it returns false throw an exception.
a347aee3 1687 if (!$deleteinstancefunction($cm->instance)) {
9a9cb741
MN
1688 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1689 "Cannot delete the module $modulename (instance).");
a347aee3
MN
1690 }
1691
1692 // Remove all module files in case modules forget to do that.
1693 $fs = get_file_storage();
1694 $fs->delete_area_files($modcontext->id);
1695
1696 // Delete events from calendar.
1697 if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
dcd338ff 1698 foreach($events as $event) {
c5ceaeaf
DP
1699 $calendarevent = calendar_event::load($event->id);
1700 $calendarevent->delete();
dcd338ff 1701 }
1702 }
a347aee3
MN
1703
1704 // Delete grade items, outcome items and grades attached to modules.
1705 if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1706 'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
f615fbab 1707 foreach ($grade_items as $grade_item) {
1708 $grade_item->delete('moddelete');
1709 }
f615fbab 1710 }
a347aee3 1711
46e12372
SM
1712 // Delete completion and availability data; it is better to do this even if the
1713 // features are not turned on, in case they were turned on previously (these will be
a347aee3 1714 // very quick on an empty table).
46e12372 1715 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
ede323e2
ARN
1716 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1717 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
06b3a6b2 1718
d9994071
MN
1719 // Delete all tag instances associated with the instance of this module.
1720 tag_delete_instances('mod_' . $modulename, $modcontext->id);
cc033d48 1721
a347aee3 1722 // Delete the context.
c592eea2 1723 context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
a347aee3
MN
1724
1725 // Delete the module from the course_modules table.
1726 $DB->delete_records('course_modules', array('id' => $cm->id));
1727
1728 // Delete module from that section.
1729 if (!delete_mod_from_section($cm->id, $cm->section)) {
9a9cb741
MN
1730 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1731 "Cannot delete the module $modulename (instance) from section.");
a347aee3
MN
1732 }
1733
63deb5c3
AA
1734 // Trigger event for course module delete action.
1735 $event = \core\event\course_module_deleted::create(array(
1736 'courseid' => $cm->course,
1737 'context' => $modcontext,
1738 'objectid' => $cm->id,
1739 'other' => array(
1740 'modulename' => $modulename,
1741 'instanceid' => $cm->instance,
1742 )
1743 ));
1744 $event->add_record_snapshot('course_modules', $cm);
1745 $event->trigger();
38b19bbc 1746 rebuild_course_cache($cm->course, true);
11b0c469 1747}
1748
722e6ba9 1749function delete_mod_from_section($modid, $sectionid) {
cb6fec1f 1750 global $DB;
11b0c469 1751
722e6ba9 1752 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
11b0c469 1753
e5dfd0f3 1754 $modarray = explode(",", $section->sequence);
11b0c469 1755
722e6ba9 1756 if ($key = array_keys ($modarray, $modid)) {
11b0c469 1757 array_splice($modarray, $key[0], 1);
1758 $newsequence = implode(",", $modarray);
38b19bbc
MG
1759 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1760 rebuild_course_cache($section->course, true);
1761 return true;
11b0c469 1762 } else {
1763 return false;
1764 }
89adb174 1765
11b0c469 1766 }
7977cffd 1767 return false;
11b0c469 1768}
1769
3440ec12 1770/**
1771 * Moves a section within a course, from a position to another.
1772 * Be very careful: $section and $destination refer to section number,
1773 * not id!.
1774 *
1775 * @param object $course
1776 * @param int $section Section number (not id!!!)
1777 * @param int $destination
ca9cae84 1778 * @param bool $ignorenumsections
3440ec12 1779 * @return boolean Result
1780 */
ca9cae84 1781function move_section_to($course, $section, $destination, $ignorenumsections = false) {
3440ec12 1782/// Moves a whole course section up and down within the course
1783 global $USER, $DB;
1784
ca255392 1785 if (!$destination && $destination != 0) {
3440ec12 1786 return true;
1787 }
1788
850acb35
MG
1789 // compartibility with course formats using field 'numsections'
1790 $courseformatoptions = course_get_format($course)->get_format_options();
ca9cae84 1791 if ((!$ignorenumsections && array_key_exists('numsections', $courseformatoptions) &&
850acb35 1792 ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
3440ec12 1793 return false;
1794 }
1795
1796 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1797 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1798 'section ASC, id ASC', 'id, section')) {
1799 return false;
1800 }
1801
cf76b335 1802 $movedsections = reorder_sections($sections, $section, $destination);
3440ec12 1803
cf76b335 1804 // Update all sections. Do this in 2 steps to avoid breaking database
1805 // uniqueness constraint
1806 $transaction = $DB->start_delegated_transaction();
1807 foreach ($movedsections as $id => $position) {
1808 if ($sections[$id] !== $position) {
1809 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1810 }
1811 }
e7e0f8d2
DP
1812 foreach ($movedsections as $id => $position) {
1813 if ($sections[$id] !== $position) {
1814 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1815 }
3440ec12 1816 }
1817
15e2552f
RK
1818 // If we move the highlighted section itself, then just highlight the destination.
1819 // Adjust the higlighted section location if we move something over it either direction.
1820 if ($section == $course->marker) {
e7b6e6b9 1821 course_set_marker($course->id, $destination);
2365213f 1822 } elseif ($section > $course->marker && $course->marker >= $destination) {
e7b6e6b9 1823 course_set_marker($course->id, $course->marker+1);
2365213f 1824 } elseif ($section < $course->marker && $course->marker <= $destination) {
e7b6e6b9 1825 course_set_marker($course->id, $course->marker-1);
15e2552f
RK
1826 }
1827
cf76b335 1828 $transaction->allow_commit();
38b19bbc 1829 rebuild_course_cache($course->id, true);
3440ec12 1830 return true;
1831}
1832
ca9cae84
MG
1833/**
1834 * This method will delete a course section and may delete all modules inside it.
1835 *
1836 * No permissions are checked here, use {@link course_can_delete_section()} to
1837 * check if section can actually be deleted.
1838 *
1839 * @param int|stdClass $course
1840 * @param int|stdClass|section_info $section
1841 * @param bool $forcedeleteifnotempty if set to false section will not be deleted if it has modules in it.
1842 * @return bool whether section was deleted
1843 */
1844function course_delete_section($course, $section, $forcedeleteifnotempty = true) {
1845 return course_get_format($course)->delete_section($section, $forcedeleteifnotempty);
1846}
1847
1848/**
1849 * Checks if the current user can delete a section (if course format allows it and user has proper permissions).
1850 *
1851 * @param int|stdClass $course
1852 * @param int|stdClass|section_info $section
1853 * @return bool
1854 */
1855function course_can_delete_section($course, $section) {
1856 if (is_object($section)) {
1857 $section = $section->section;
1858 }
1859 if (!$section) {
1860 // Not possible to delete 0-section.
1861 return false;
1862 }
1863 // Course format should allow to delete sections.
1864 if (!course_get_format($course)->can_delete_section($section)) {
1865 return false;
1866 }
1867 // Make sure user has capability to update course and move sections.
1868 $context = context_course::instance(is_object($course) ? $course->id : $course);
1869 if (!has_all_capabilities(array('moodle/course:movesections', 'moodle/course:update'), $context)) {
1870 return false;
1871 }
1872 // Make sure user has capability to delete each activity in this section.
1873 $modinfo = get_fast_modinfo($course);
1874 if (!empty($modinfo->sections[$section])) {
1875 foreach ($modinfo->sections[$section] as $cmid) {
1876 if (!has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1877 return false;
1878 }
1879 }
1880 }
1881 return true;
1882}
1883
3440ec12 1884/**
1885 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1886 * an original position number and a target position number, rebuilds the array so that the
1887 * move is made without any duplication of section positions.
1888 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1889 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1890 *
1891 * @param array $sections
1892 * @param int $origin_position
1893 * @param int $target_position
1894 * @return array
1895 */
1896function reorder_sections($sections, $origin_position, $target_position) {
1897 if (!is_array($sections)) {
1898 return false;
1899 }
1900
1901 // We can't move section position 0
1902 if ($origin_position < 1) {
1903 echo "We can't move section position 0";
1904 return false;
1905 }
1906
1907 // Locate origin section in sections array
1908 if (!$origin_key = array_search($origin_position, $sections)) {
1909 echo "searched position not in sections array";
1910 return false; // searched position not in sections array
1911 }
1912
1913 // Extract origin section
1914 $origin_section = $sections[$origin_key];
1915 unset($sections[$origin_key]);
1916
1917 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1918 $found = false;
1919 $append_array = array();
1920 foreach ($sections as $id => $position) {
1921 if ($found) {
1922 $append_array[$id] = $position;
1923 unset($sections[$id]);
1924 }
1925 if ($position == $target_position) {
eb01aa2c
RT
1926 if ($target_position < $origin_position) {
1927 $append_array[$id] = $position;
1928 unset($sections[$id]);
1929 }
3440ec12 1930 $found = true;
1931 }
1932 }
1933
1934 // Append moved section
1935 $sections[$origin_key] = $origin_section;
1936
1937 // Append rest of array (if applicable)
1938 if (!empty($append_array)) {
1939 foreach ($append_array as $id => $position) {
1940 $sections[$id] = $position;
1941 }
1942 }
1943
1944 // Renumber positions
1945 $position = 0;
1946 foreach ($sections as $id => $p) {
1947 $sections[$id] = $position;
1948 $position++;
1949 }
1950
1951 return $sections;
1952
1953}
1954
cb6fec1f 1955/**
1956 * Move the module object $mod to the specified $section
1957 * If $beforemod exists then that is the module
1958 * before which $modid should be inserted
d55f05ef
MG
1959 *
1960 * @param stdClass|cm_info $mod
1961 * @param stdClass|section_info $section
1962 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1963 * before which the module needs to be included. Null for inserting in the
1964 * end of the section
1965 * @return int new value for module visibility (0 or 1)
cb6fec1f 1966 */
7977cffd 1967function moveto_module($mod, $section, $beforemod=NULL) {
a83dd077 1968 global $OUTPUT, $DB;
7977cffd 1969
d55f05ef
MG
1970 // Current module visibility state - return value of this function.
1971 $modvisible = $mod->visible;
1972
1973 // Remove original module from original section.
7977cffd 1974 if (! delete_mod_from_section($mod->id, $mod->section)) {
e6db3026 1975 echo $OUTPUT->notification("Could not delete module from existing section");
7977cffd 1976 }
1977
d55f05ef 1978 // If moving to a hidden section then hide module.
bb1592c8
CF
1979 if ($mod->section != $section->id) {
1980 if (!$section->visible && $mod->visible) {
d55f05ef
MG
1981 // Module was visible but must become hidden after moving to hidden section.
1982 $modvisible = 0;
bb1592c8
CF
1983 set_coursemodule_visible($mod->id, 0);
1984 // Set visibleold to 1 so module will be visible when section is made visible.
1985 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1986 }
1987 if ($section->visible && !$mod->visible) {
d55f05ef 1988 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
bb1592c8 1989 set_coursemodule_visible($mod->id, $mod->visibleold);
d55f05ef 1990 $modvisible = $mod->visibleold;
bb1592c8 1991 }
7977cffd 1992 }
1993
d55f05ef 1994 // Add the module into the new section.
722e6ba9 1995 course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
d55f05ef 1996 return $modvisible;
7977cffd 1997}
1998
f558b291
MG
1999/**
2000 * Returns the list of all editing actions that current user can perform on the module
2001 *
2002 * @param cm_info $mod The module to produce editing buttons for
2003 * @param int $indent The current indenting (default -1 means no move left-right actions)
2004 * @param int $sr The section to link back to (used for creating the links)
2005 * @return array array of action_link or pix_icon objects
2006 */
2007function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
2008 global $COURSE, $SITE;
94361e02 2009
3d575e6f 2010 static $str;
2011
9a5e297b
AA
2012 $coursecontext = context_course::instance($mod->course);
2013 $modcontext = context_module::instance($mod->id);
7749e187 2014
af189935
PS
2015 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
2016 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
2017
cf69a00a 2018 // No permission to edit anything.
af189935 2019 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
f558b291 2020 return array();
217a8ee9 2021 }
2022
af189935
PS
2023 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2024
3d575e6f 2025 if (!isset($str)) {
f558b291 2026 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
a83d83e4 2027 'editsettings', 'duplicate', 'hide', 'show'), 'moodle');
f558b291 2028 $str->assign = get_string('assignroles', 'role');
6dc5908e
ARN
2029 $str->groupsnone = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
2030 $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
2031 $str->groupsvisible = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1acfbce5 2032 }
94361e02 2033
af189935 2034 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
24e1eae4 2035
f558b291
MG
2036 if ($sr !== null) {
2037 $baseurl->param('sr', $sr);
7749e187
SH
2038 }
2039 $actions = array();
2040
a83d83e4
AN
2041 // Update.
2042 if ($hasmanageactivities) {
2043 $actions['update'] = new action_menu_link_secondary(
7a9a07d2 2044 new moodle_url($baseurl, array('update' => $mod->id)),
a83d83e4
AN
2045 new pix_icon('t/edit', $str->editsettings, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2046 $str->editsettings,
2047 array('class' => 'editing_update', 'data-action' => 'update')
7a9a07d2
ARN
2048 );
2049 }
2050
cf69a00a 2051 // Indent.
639d9904 2052 if ($hasmanageactivities && $indent >= 0) {
a83d83e4
AN
2053 $indentlimits = new stdClass();
2054 $indentlimits->min = 0;
2055 $indentlimits->max = 16;
7749e187
SH
2056 if (right_to_left()) { // Exchange arrows on RTL
2057 $rightarrow = 't/left';
2058 $leftarrow = 't/right';
2059 } else {
2060 $rightarrow = 't/right';
2061 $leftarrow = 't/left';
2062 }
2063
a83d83e4
AN
2064 if ($indent >= $indentlimits->max) {
2065 $enabledclass = 'hidden';
2066 } else {
2067 $enabledclass = '';
2068 }
2069 $actions['moveright'] = new action_menu_link_secondary(
2070 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
2071 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2072 $str->moveright,
11f8ef10 2073 array('class' => 'editing_moveright ' . $enabledclass, 'data-action' => 'moveright', 'data-keepopen' => true)
a83d83e4
AN
2074 );
2075
2076 if ($indent <= $indentlimits->min) {
2077 $enabledclass = 'hidden';
2078 } else {
2079 $enabledclass = '';
7749e187 2080 }
3665af78 2081 $actions['moveleft'] = new action_menu_link_secondary(
e282c679 2082 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
cf69a00a 2083 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 2084 $str->moveleft,
11f8ef10 2085 array('class' => 'editing_moveleft ' . $enabledclass, 'data-action' => 'moveleft', 'data-keepopen' => true)
e282c679 2086 );
a83d83e4
AN
2087
2088 }
2089
2090 // Hide/Show.
2091 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
2092 if ($mod->visible) {
2093 $actions['hide'] = new action_menu_link_secondary(
2094 new moodle_url($baseurl, array('hide' => $mod->id)),
2095 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2096 $str->hide,
2097 array('class' => 'editing_hide', 'data-action' => 'hide')
2098 );
2099 } else {
2100 $actions['show'] = new action_menu_link_secondary(
2101 new moodle_url($baseurl, array('show' => $mod->id)),
2102 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2103 $str->show,
2104 array('class' => 'editing_show', 'data-action' => 'show')
2105 );
7749e187 2106 }
dc0dc7d5 2107 }
7749e187 2108
8a1a951f 2109 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
03c39daa 2110 if (has_all_capabilities($dupecaps, $coursecontext) &&
f558b291 2111 plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3665af78 2112 $actions['duplicate'] = new action_menu_link_secondary(
8645a28f 2113 new moodle_url($baseurl, array('duplicate' => $mod->id)),
cf69a00a 2114 new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 2115 $str->duplicate,
6982618e 2116 array('class' => 'editing_duplicate', 'data-action' => 'duplicate', 'data-sr' => $sr)
8645a28f
EL
2117 );
2118 }
7749e187 2119
cf69a00a 2120 // Groupmode.
9ac099a1
AN
2121 if ($hasmanageactivities && !$mod->coursegroupmodeforce) {
2122 if (plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
2123 if ($mod->effectivegroupmode == SEPARATEGROUPS) {
2124 $nextgroupmode = VISIBLEGROUPS;
2125 $grouptitle = $str->groupsseparate;
2126 $actionname = 'groupsseparate';
6272fce6 2127 $groupimage = 'i/groups';
9ac099a1
AN
2128 } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
2129 $nextgroupmode = NOGROUPS;
2130 $grouptitle = $str->groupsvisible;
2131 $actionname = 'groupsvisible';
6272fce6 2132 $groupimage = 'i/groupv';
9ac099a1
AN
2133 } else {
2134 $nextgroupmode = SEPARATEGROUPS;
2135 $grouptitle = $str->groupsnone;
2136 $actionname = 'groupsnone';
6272fce6 2137 $groupimage = 'i/groupn';
9ac099a1
AN
2138 }
2139
2140 $actions[$actionname] = new action_menu_link_primary(
2141 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
4c0664b9 2142 new pix_icon($groupimage, null, 'moodle', array('class' => 'iconsmall')),
9ac099a1 2143 $grouptitle,
4c0664b9 2144 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode, 'aria-live' => 'assertive')
9ac099a1 2145 );
32d03b7b 2146 } else {
9ac099a1 2147 $actions['nogroupsupport'] = new action_menu_filler();
32d03b7b 2148 }
7977cffd 2149 }
2150
cf69a00a 2151 // Assign.
af189935 2152 if (has_capability('moodle/role:assign', $modcontext)){
3665af78 2153 $actions['assign'] = new action_menu_link_secondary(
f558b291 2154 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
cf69a00a 2155 new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 2156 $str->assign,
cf69a00a 2157 array('class' => 'editing_assign', 'data-action' => 'assignroles')
7749e187
SH
2158 );
2159 }
2160
a83d83e4
AN
2161 // Delete.
2162 if ($hasmanageactivities) {
2163 $actions['delete'] = new action_menu_link_secondary(
2164 new moodle_url($baseurl, array('delete' => $mod->id)),
2165 new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2166 $str->delete,
2167 array('class' => 'editing_delete', 'data-action' => 'delete')
2168 );
2169 }
2170
f558b291 2171 return $actions;
90845098 2172}
2173
a83d83e4
AN
2174/**
2175 * Returns the rename action.
2176 *
2177 * @param cm_info $mod The module to produce editing buttons for
2178 * @param int $sr The section to link back to (used for creating the links)
2179 * @return The markup for the rename action, or an empty string if not available.
2180 */
2181function course_get_cm_rename_action(cm_info $mod, $sr = null) {
2182 global $COURSE, $OUTPUT;
2183
2184 static $str;
2185 static $baseurl;
2186
2187 $modcontext = context_module::instance($mod->id);
2188 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2189
2190 if (!isset($str)) {
2191 $str = get_strings(array('edittitle'));
2192 }
2193
2194 if (!isset($baseurl)) {
2195 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2196 }
2197
2198 if ($sr !== null) {
2199 $baseurl->param('sr', $sr);
2200 }
2201
2202 // AJAX edit title.
2203 if ($mod->has_view() && $hasmanageactivities && course_ajax_enabled($COURSE) &&
2204 (($mod->course == $COURSE->id) || ($mod->course == SITEID))) {
2205 // we will not display link if we are on some other-course page (where we should not see this module anyway)
2206 return html_writer::span(
2207 html_writer::link(
2208 new moodle_url($baseurl, array('update' => $mod->id)),
2209 $OUTPUT->pix_icon('t/editstring', '', 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
2210 array(
2211 'class' => 'editing_title',
2212 'data-action' => 'edittitle',
2213 'title' => $str->edittitle,
2214 )
2215 )
2216 );
2217 }
2218 return '';
2219}
2220
4657ba81
AN
2221/**
2222 * Returns the move action.
2223 *
2224 * @param cm_info $mod The module to produce a move button for
2225 * @param int $sr The section to link back to (used for creating the links)
2226 * @return The markup for the move action, or an empty string if not available.
2227 */
2228function course_get_cm_move(cm_info $mod, $sr = null) {
2229 global $OUTPUT;
2230
2231 static $str;
2232 static $baseurl;
2233
2234 $modcontext = context_module::instance($mod->id);
2235 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
2236
2237 if (!isset($str)) {
2238 $str = get_strings(array('move'));
2239 }
2240
2241 if (!isset($baseurl)) {
2242 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
2243
2244 if ($sr !== null) {
2245 $baseurl->param('sr', $sr);
2246 }
2247 }
2248
2249 if ($hasmanageactivities) {
2250 $pixicon = 'i/dragdrop';
2251
69353dce 2252 if (!course_ajax_enabled($mod->get_course())) {
4657ba81
AN
2253 // Override for course frontpage until we get drag/drop working there.
2254 $pixicon = 't/move';
2255 }
2256
2257 return html_writer::link(
2258 new moodle_url($baseurl, array('copy' => $mod->id)),
2259 $OUTPUT->pix_icon($pixicon, $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
2260 array('class' => 'editing_move', 'data-action' => 'move')
2261 );
2262 }
2263 return '';
2264}
2265
b61efafb 2266/**
264867fd 2267 * given a course object with shortname & fullname, this function will
b61efafb 2268 * truncate the the number of chars allowed and add ... if it was too long
2269 */
2270function course_format_name ($course,$max=100) {
264867fd 2271
9a5e297b 2272 $context = context_course::instance($course->id);
8ebbb06a 2273 $shortname = format_string($course->shortname, true, array('context' => $context));
9a5e297b 2274 $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
d1e36240 2275 $str = $shortname.': '. $fullname;
2f1e464a 2276 if (core_text::strlen($str) <= $max) {
b61efafb 2277 return $str;
2278 }
2279 else {
2f1e464a 2280 return core_text::substr($str,0,$max-3).'...';
b61efafb 2281 }
2282}
2283
0705ff84 2284/**
9665ecd2
TH
2285 * Is the user allowed to add this type of module to this course?
2286 * @param object $course the course settings. Only $course->id is used.
2287 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
2288 * @return bool whether the current user is allowed to add this type of module to this course.
0705ff84 2289 */
9665ecd2 2290function course_allowed_module($course, $modname) {
9665ecd2
TH
2291 if (is_numeric($modname)) {
2292 throw new coding_exception('Function course_allowed_module no longer
2293 supports numeric module ids. Please update your code to pass the module name.');
0705ff84 2294 }
264867fd 2295
9665ecd2
TH
2296 $capability = 'mod/' . $modname . ':addinstance';
2297 if (!get_capability_info($capability)) {
2298 // Debug warning that the capability does not exist, but no more than once per page.
2299 static $warned = array();
2300 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2301 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2302 debugging('The module ' . $modname . ' does not define the standard capability ' .
2303 $capability , DEBUG_DEVELOPER);
2304 $warned[$modname] = 1;
2305 }
ddb0a19f 2306
9665ecd2
TH
2307 // If the capability does not exist, the module can always be added.
2308 return true;
0705ff84 2309 }
238c0dd9 2310
9665ecd2
TH
2311 $coursecontext = context_course::instance($course->id);
2312 return has_capability($capability, $coursecontext);
0705ff84 2313}
2314
cb6fec1f 2315/**
2316 * Efficiently moves many courses around while maintaining
2317 * sortorder in order.
2318 *
e92c39ca
PS
2319 * @param array $courseids is an array of course ids
2320 * @param int $categoryid
df997f84 2321 * @return bool success
cb6fec1f 2322 */
2323function move_courses($courseids, $categoryid) {
ed54cb41 2324 global $DB;
861efb19 2325
df997f84 2326 if (empty($courseids)) {
ed54cb41 2327 // Nothing to do.
5dc361e1 2328 return false;
df997f84 2329 }
264867fd 2330
ed54cb41 2331 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
df997f84
PS
2332 return false;
2333 }
19f601d1 2334
df997f84 2335 $courseids = array_reverse($courseids);
9a5e297b 2336 $newparent = context_coursecat::instance($category->id);
df997f84 2337 $i = 1;
0cbe8111 2338
aec8fe2f 2339 list($where, $params) = $DB->get_in_or_equal($courseids);
3a11e2d2 2340 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
30fe1181
MG
2341 foreach ($dbcourses as $dbcourse) {
2342 $course = new stdClass();
2343 $course->id = $dbcourse->id;
2344 $course->category = $category->id;
2345 $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2346 if ($category->visible == 0) {
2347 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2348 // to previous state if somebody unhides the category.
2349 $course->visible = 0;
2350 }
ed54cb41 2351
30fe1181 2352 $DB->update_record('course', $course);
ed54cb41 2353
3a11e2d2 2354 // Update context, so it can be passed to event.
30fe1181 2355 $context = context_course::instance($course->id);
3a11e2d2 2356 $context->update_moved($newparent);
30fe1181
MG
2357
2358 // Trigger a course updated event.
2359 $event = \core\event\course_updated::create(array(
2360 'objectid' => $course->id,
3a11e2d2 2361 'context' => context_course::instance($course->id),
30fe1181
MG
2362 'other' => array('shortname' => $dbcourse->shortname,
2363 'fullname' => $dbcourse->fullname)
2364 ));
30fe1181
MG
2365 $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2366 $event->trigger();
0cbe8111 2367 }
df997f84 2368 fix_course_sortorder();
eabbfa82 2369 cache_helper::purge_by_event('changesincourse');
df997f84 2370
861efb19 2371 return true;
2372}
2373
ae628043 2374/**
ee7084e9 2375 * Returns the display name of the given section that the course prefers
7487c856 2376 *
ee7084e9
MG
2377 * Implementation of this function is provided by course format
2378 * @see format_base::get_section_name()
7487c856 2379 *
ee7084e9
MG
2380 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2381 * @param int|stdClass $section Section object from database or just field course_sections.section
2382 * @return string Display name that the course format prefers, e.g. "Week 2"
ae628043 2383 */
ee7084e9
MG
2384function get_section_name($courseorid, $section) {
2385 return course_get_format($courseorid)->get_section_name($section);
7487c856
SH
2386}
2387
2388/**
ee7084e9 2389 * Tells if current course format uses sections
1b048629 2390 *
7487c856 2391 * @param string $format Course format ID e.g. 'weeks' $course->format
ee7084e9 2392 * @return bool
7487c856 2393 */
7487c856 2394function course_format_uses_sections($format) {
ee7084e9
MG
2395 $course = new stdClass();
2396 $course->format = $format;
2397 return course_get_format($course)->uses_sections();
ae628043 2398}
2399
c0b5d925
DM
2400/**
2401 * Returns the information about the ajax support in the given source format
2402 *
2403 * The returned object's property (boolean)capable indicates that
2404 * the course format supports Moodle course ajax features.
c0b5d925
DM
2405 *
2406 * @param string $format
2407 * @return stdClass
2408 */
2409function course_format_ajax_support($format) {
ee7084e9
MG
2410 $course = new stdClass();
2411 $course->format = $format;
2412 return course_get_format($course)->supports_ajax();
c0b5d925
DM
2413}
2414
2585a68d 2415/**
2416 * Can the current user delete this course?
8b449a39 2417 * Course creators have exception,
2418 * 1 day after the creation they can sill delete the course.
2585a68d 2419 * @param int $courseid
2420 * @return boolean
2585a68d 2421 */
2422function can_delete_course($courseid) {
536c0865 2423 global $USER;
2585a68d 2424
9a5e297b 2425 $context = context_course::instance($courseid);
2585a68d 2426
8b449a39 2427 if (has_capability('moodle/course:delete', $context)) {
2428 return true;
2429 }
2430
2431 // hack: now try to find out if creator created this course recently (1 day)
2432 if (!has_capability('moodle/course:create', $context)) {
2433 return false;
2434 }
2435
2436 $since = time() - 60*60*24;
536c0865
AA
2437 $course = get_course($courseid);
2438
2439 if ($course->timecreated < $since) {
2440 return false; // Return if the course was not created in last 24 hours.
2441 }
2442
2443 $logmanger = get_log_manager();
59aebbed 2444 $readers = $logmanger->get_readers('\core\log\sql_reader');
536c0865
AA
2445 $reader = reset($readers);
2446
2447 if (empty($reader)) {
2448 return false; // No log reader found.
2449 }
8b449a39 2450
536c0865
AA
2451 // A proper reader.
2452 $select = "userid = :userid AND courseid = :courseid AND eventname = :eventname AND timecreated > :since";
2453 $params = array('userid' => $USER->id, 'since' => $since, 'courseid' => $course->id, 'eventname' => '\core\event\course_created');
8b449a39 2454
536c0865 2455 return (bool)$reader->get_events_select_count($select, $params);
2585a68d 2456}
2457
bef12c99 2458/**
2459 * Save the Your name for 'Some role' strings.
2460 *
2461 * @param integer $courseid the id of this course.
2462 * @param array $data the data that came from the course settings form.
2463 */
2464function save_local_role_names($courseid, $data) {
2465 global $DB;
9a5e297b 2466 $context = context_course::instance($courseid);
bef12c99 2467
2468 foreach ($data as $fieldname => $value) {
df997f84 2469 if (strpos($fieldname, 'role_') !== 0) {
bef12c99 2470 continue;
2471 }
2472 list($ignored, $roleid) = explode('_', $fieldname);
2473
2474 // make up our mind whether we want to delete, update or insert
2475 if (!$value) {
2476 $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2477
2478 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2479 $rolename->name = $value;
2480 $DB->update_record('role_names', $rolename);
2481
2482 } else {
2483 $rolename = new stdClass;
2484 $rolename->contextid = $context->id;
2485 $rolename->roleid = $roleid;
2486 $rolename->name = $value;
2487 $DB->insert_record('role_names', $rolename);
2488 }
29d4cc65
DP
2489 // This will ensure the course contacts cache is purged..
2490 coursecat::role_assignment_changed($roleid, $context);
bef12c99 2491 }
2492}
2585a68d 2493
d1f8c1bd
MG
2494/**
2495 * Returns options to use in course overviewfiles filemanager
2496 *
2497 * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2498 * may be empty if course does not exist yet (course create form)
2499 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2500 * or null if overviewfiles are disabled
2501 */
2502function course_overviewfiles_options($course) {
2503 global $CFG;
2504 if (empty($CFG->courseoverviewfileslimit)) {
2505 return null;
2506 }
2507 $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2508 if (in_array('*', $accepted_types) || empty($accepted_types)) {
2509 $accepted_types = '*';
2510 } else {
2511 // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2512 // Make sure extensions are prefixed with dot unless they are valid typegroups
2513 foreach ($accepted_types as $i => $type) {
2514 if (substr($type, 0, 1) !== '.') {
2515 require_once($CFG->libdir. '/filelib.php');
2516 if (!count(file_get_typegroup('extension', $type))) {
2517 // It does not start with dot and is not a valid typegroup, this is most likely extension.
2518 $accepted_types[$i] = '.'. $type;
2519 $corrected = true;
2520 }
2521 }
2522 }
2523 if (!empty($corrected)) {
2524 set_config('courseoverviewfilesext', join(',', $accepted_types));
2525 }
2526 }
2527 $options = array(
2528 'maxfiles' => $CFG->courseoverviewfileslimit,
2529 'maxbytes' => $CFG->maxbytes,
2530 'subdirs' => 0,
2531 'accepted_types' => $accepted_types
2532 );
2533 if (!empty($course->id)) {
2534 $options['context'] = context_course::instance($course->id);
2535 } else if (is_int($course) && $course > 0) {
2536 $options['context'] = context_course::instance($course);
2537 }
2538 return $options;
2539}
2540
c3df0901 2541/**
df997f84
PS
2542 * Create a course and either return a $course object
2543 *
2544 * Please note this functions does not verify any access control,
2545 * the calling code is responsible for all validation (usually it is the form definition).
bfefa87e 2546 *
df997f84 2547 * @param array $editoroptions course description editor options
bfefa87e 2548 * @param object $data - all the data needed for an entry in the 'course' table
df997f84 2549 * @return object new course instance
bfefa87e 2550 */
df997f84 2551function create_course($data, $editoroptions = NULL) {
0d1e5456 2552 global $DB, $CFG;
33001202 2553 require_once($CFG->dirroot.'/tag/lib.php');
bfefa87e 2554
df997f84
PS
2555 //check the categoryid - must be given for all new courses
2556 $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
71b77297 2557
9930e426 2558 // Check if the shortname already exists.
df997f84
PS
2559 if (!empty($data->shortname)) {
2560 if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
9930e426 2561 throw new moodle_exception('shortnametaken', '', '', $data->shortname);
71b77297 2562 }
2563 }
2564
9930e426 2565 // Check if the idnumber already exists.
df997f84
PS
2566 if (!empty($data->idnumber)) {
2567 if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
9930e426 2568 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
71b77297 2569 }
2570 }
2f48819b 2571
9a4231e9
S
2572 // Check if timecreated is given.
2573 $data->timecreated = !empty($data->timecreated) ? $data->timecreated : time();
df997f84 2574 $data->timemodified = $data->timecreated;
71b77297 2575
df997f84
PS
2576 // place at beginning of any category
2577 $data->sortorder = 0;
00f270bc 2578
df997f84
PS
2579 if ($editoroptions) {
2580 // summary text is updated later, we need context to store the files first
2581 $data->summary = '';
2582 $data->summary_format = FORMAT_HTML;
2583 }
2584
db1218a9
PS
2585 if (!isset($data->visible)) {
2586 // data not from form, add missing visibility info
54a01598 2587 $data->visible = $category->visible;
bfefa87e 2588 }
db1218a9 2589 $data->visibleold = $data->visible;
2585a68d 2590
df997f84 2591 $newcourseid = $DB->insert_record('course', $data);
9a5e297b 2592 $context = context_course::instance($newcourseid, MUST_EXIST);
bfefa87e 2593
df997f84
PS
2594 if ($editoroptions) {
2595 // Save the files used in the summary editor and store
64f93798 2596 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
df997f84
PS
2597 $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2598 $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2599 }
d1f8c1bd
MG
2600 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2601 // Save the course overviewfiles
2602 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2603 }
bfefa87e 2604
fc79ede5
MG
2605 // update course format options
2606 course_get_format($newcourseid)->update_course_format_options($data);
2607
2608 $course = course_get_format($newcourseid)->get_course();
bfefa87e 2609
df997f84 2610 fix_course_sortorder();
eabbfa82
MG
2611 // purge appropriate caches in case fix_course_sortorder() did not change anything
2612 cache_helper::purge_by_event('changesincourse');
bfefa87e 2613
df997f84 2614 // new context created - better mark it as dirty
1de02d62 2615 $context->mark_dirty();
bfefa87e 2616
2542cb54
MG
2617 // Trigger a course created event.
2618 $event = \core\event\course_created::create(array(
2619 'objectid' => $course->id,
2620 'context' => context_course::instance($course->id),
2621 'other' => array('shortname' => $course->shortname,
2622 'fullname' => $course->fullname)
2623 ));
2624 $event->trigger();
2625
2626 // Setup the blocks
2627 blocks_add_default_course_blocks($course);
2628
2629 // Create a default section.
2630 course_create_sections_if_missing($course, 0);
2631
df997f84 2632 // Save any custom role names.
e92c39ca 2633 save_local_role_names($course->id, (array)$data);
bfefa87e 2634
df997f84
PS
2635 // set up enrolments
2636 enrol_course_updated(true, $course, $data);
bef12c99 2637
0d1e5456
MG
2638 // Update course tags.
2639 if ($CFG->usetags && isset($data->tags)) {
2640 tag_set('course', $course->id, $data->tags, 'core', context_course::instance($course->id)->id);
2641 }
2642
df997f84 2643 return $course;
bfefa87e 2644}
2645
c3df0901 2646/**
df997f84
PS
2647 * Update a course.
2648 *
2649 * Please note this functions does not verify any access control,
2650 * the calling code is responsible for all validation (usually it is the form definition).
bfefa87e 2651 *
2652 * @param object $data - all the data needed for an entry in the 'course' table
df997f84
PS
2653 * @param array $editoroptions course description editor options
2654 * @return void
bfefa87e 2655 */
df997f84 2656function update_course($data, $editoroptions = NULL) {
0d1e5456 2657 global $DB, $CFG;
33001202 2658 require_once($CFG->dirroot.'/tag/lib.php');
bfefa87e 2659
df997f84 2660 $data->timemodified = time();
ddb0a19f 2661
fc79ede5 2662 $oldcourse = course_get_format($data->id)->get_course();
9a5e297b 2663 $context = context_course::instance($oldcourse->id);
bfefa87e 2664
df997f84 2665 if ($editoroptions) {
64f93798 2666 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
71b77297 2667 }
d1f8c1bd
MG
2668 if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2669 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2670 }
71b77297 2671
5536a561
FD
2672 // Check we don't have a duplicate shortname.
2673 if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
e1301685 2674 if ($DB->record_exists_sql('SELECT id from {course} WHERE shortname = ? AND id <> ?', array($data->shortname, $data->id))) {
5536a561
FD
2675 throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2676 }
2677 }
2678
2679 // Check we don't have a duplicate idnumber.
2680 if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
e1301685 2681 if ($DB->record_exists_sql('SELECT id from {course} WHERE idnumber = ? AND id <> ?', array($data->idnumber, $data->id))) {
5536a561
FD
2682 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2683 }
2684 }
2685
df997f84
PS
2686 if (!isset($data->category) or empty($data->category)) {
2687 // prevent nulls and 0 in category field
bfefa87e 2688 unset($data->category);
2689 }
b80a50f7 2690 $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
bfefa87e 2691
db1218a9
PS
2692 if (!isset($data->visible)) {
2693 // data not from form, add missing visibility info
df997f84
PS
2694 $data->visible = $oldcourse->visible;
2695 }
bfefa87e 2696
df997f84
PS
2697 if ($data->visible != $oldcourse->visible) {
2698 // reset the visibleold flag when manually hiding/unhiding course
2699 $data->visibleold = $data->visible;
b55248d5 2700 $changesincoursecat = true;
df997f84 2701 } else {
a372aab5 2702 if ($movecat) {
df997f84
PS
2703 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2704 if (empty($newcategory->visible)) {
2705 // make sure when moving into hidden category the course is hidden automatically
2706 $data->visible = 0;
2707 }
a372aab5 2708 }
df997f84 2709 }
a372aab5 2710
df997f84 2711 // Update with the new data
487caf6b 2712 $DB->update_record('course', $data);
38b19bbc
MG
2713 // make sure the modinfo cache is reset
2714 rebuild_course_cache($data->id);
bfefa87e 2715
fc79ede5
MG
2716 // update course format options with full course data
2717 course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2718
df997f84 2719 $course = $DB->get_record('course', array('id'=>$data->id));
bfefa87e 2720
df997f84 2721 if ($movecat) {
9a5e297b 2722 $newparent = context_coursecat::instance($course->category);
2c5b0eb7 2723 $context->update_moved($newparent);
df997f84 2724 }
3a11e2d2
RT
2725 $fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
2726 if ($fixcoursesortorder) {
24f824b9
MG
2727 fix_course_sortorder();
2728 }
2729
eabbfa82
MG
2730 // purge appropriate caches in case fix_course_sortorder() did not change anything
2731 cache_helper::purge_by_event('changesincourse');
b55248d5 2732 if ($changesincoursecat) {
b80a50f7
MG
2733 cache_helper::purge_by_event('changesincoursecat');
2734 }
bfefa87e 2735
df997f84
PS
2736 // Test for and remove blocks which aren't appropriate anymore
2737 blocks_remove_inappropriate($course);
bfefa87e 2738
df997f84
PS
2739 // Save any custom role names.
2740 save_local_role_names($course->id, $data);
2741
2742 // update enrol settings
2743 enrol_course_updated(false, $course, $data);
2744
0d1e5456
MG
2745 // Update course tags.
2746 if ($CFG->usetags && isset($data->tags)) {
2747 tag_set('course', $course->id, $data->tags, 'core', context_course::instance($course->id)->id);
2748 }
2749
53a8e678
MN
2750 // Trigger a course updated event.
2751 $event = \core\event\course_updated::create(array(
2752 'objectid' => $course->id,
3a11e2d2 2753 'context' => context_course::instance($course->id),
53a8e678
MN
2754 'other' => array('shortname' => $course->shortname,
2755 'fullname' => $course->fullname)
2756 ));
3a11e2d2 2757
2bf2f359 2758 $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
53a8e678 2759 $event->trigger();
fc79ede5
MG
2760
2761 if ($oldcourse->format !== $course->format) {
2762 // Remove all options stored for the previous format
2763 // We assume that new course format migrated everything it needed watching trigger
2764 // 'course_updated' and in method format_XXX::update_course_format_options()
2765 $DB->delete_records('course_format_options',
2766 array('courseid' => $course->id, 'format' => $oldcourse->format));
2767 }
bfefa87e 2768}
2585a68d 2769
07ab0c80 2770/**
fcb4decd 2771 * Average number of participants
07ab0c80 2772 * @return integer
2773 */
2774function average_number_of_participants() {
fcb4decd 2775 global $DB, $SITE;
2776
2777 //count total of enrolments for visible course (except front page)
2778 $sql = 'SELECT COUNT(*) FROM (
2779 SELECT DISTINCT ue.userid, e.courseid
2780 FROM {user_enrolments} ue, {enrol} e, {course} c
516c5eca 2781 WHERE ue.enrolid = e.id
fcb4decd 2782 AND e.courseid <> :siteid
2783 AND c.id = e.courseid
9f247093 2784 AND c.visible = 1) total';
fcb4decd 2785 $params = array('siteid' => $SITE->id);
2786 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2787
2788
2789 //count total of visible courses (minus front page)
2790 $coursetotal = $DB->count_records('course', array('visible' => 1));
2791 $coursetotal = $coursetotal - 1 ;
2792
2793 //average of enrolment
2794 if (empty($coursetotal)) {
2795 $participantaverage = 0;
2796 } else {
2797 $participantaverage = $enrolmenttotal / $coursetotal;
2798 }
2799
2800 return $participantaverage;
07ab0c80 2801}
2802
2803/**
fcb4decd 2804 * Average number of course modules
07ab0c80 2805 * @return integer
2806 */
2807function average_number_of_courses_modules() {
fcb4decd 2808 global $DB, $SITE;
2809
2810 //count total of visible course module (except front page)
2811 $sql = 'SELECT COUNT(*) FROM (
2812 SELECT cm.course, cm.module
2813 FROM {course} c, {course_modules} cm
516c5eca 2814 WHERE c.id = cm.course
fcb4decd 2815 AND c.id <> :siteid
2816 AND cm.visible = 1
9f247093 2817 AND c.visible = 1) total';
fcb4decd 2818 $params = array('siteid' => $SITE->id);
2819 $moduletotal = $DB->count_records_sql($sql, $params);
2820
2821
2822 //count total of visible courses (minus front page)
2823 $coursetotal = $DB->count_records('course', array('visible' => 1));
2824 $coursetotal = $coursetotal - 1 ;
2825
2826 //average of course module
2827 if (empty($coursetotal)) {
2828 $coursemoduleaverage = 0;
2829 } else {
2830 $coursemoduleaverage = $moduletotal / $coursetotal;
2831 }
2832
2833 return $coursemoduleaverage;
07ab0c80 2834}
2835
8bdc9cac
SH
2836/**
2837 * This class pertains to course requests and contains methods associated with
2838 * create, approving, and removing course requests.
2839 *
64f93798
PS
2840 * Please note we do not allow embedded images here because there is no context
2841 * to store them with proper access control.
2842 *
8bdc9cac
SH
2843 * @copyright 2009 Sam Hemelryk
2844 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2845 * @since Moodle 2.0
2846 *
2847 * @property-read int $id
2848 * @property-read string $fullname
2849 * @property-read string $shortname
2850 * @property-read string $summary
2851 * @property-read int $summaryformat
2852 * @property-read int $summarytrust
2853 * @property-read string $reason
2854 * @property-read int $requester
8bdc9cac
SH
2855 */
2856class course_request {
2857
2858 /**
2859 * This is the stdClass that stores the properties for the course request
7e85563d 2860 * and is externally accessed through the __get magic method
8bdc9cac
SH
2861 * @var stdClass
2862 */
2863 protected $properties;
2864
2865 /**
2866 * An array of options for the summary editor used by course request forms.
2867 * This is initially set by {@link summary_editor_options()}
2868 * @var array
2869 * @static
2870 */
2871 protected static $summaryeditoroptions;
2872
8bdc9cac
SH
2873 /**
2874 * Static function to prepare the summary editor for working with a course
2875 * request.
2876 *
2877 * @static
2878 * @param null|stdClass $data Optional, an object containing the default values
2879 * for the form, these may be modified when preparing the
2880 * editor so this should be called before creating the form
2881 * @return stdClass An object that can be used to set the default values for
2882 * an mforms form
2883 */
2884 public static function prepare($data=null) {
2885 if ($data === null) {
2886 $data = new stdClass;
2887 }
64f93798 2888 $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
8bdc9cac
SH
2889 return $data;
2890 }
2891
2892 /**
2893 * Static function to create a new course request when passed an array of properties
2894 * for it.
2895 *
2896 * This function also handles saving any files that may have been used in the editor
2897 *
2898 * @static
2899 * @param stdClass $data
2900 * @return course_request The newly created course request
2901 */
2902 public static function create($data) {
2903 global $USER, $DB, $CFG;
2904 $data->requester = $USER->id;
64f93798 2905
d347f304 2906 // Setting the default category if none set.
59b9a140
FM
2907 if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2908 $data->category = $CFG->defaultrequestcategory;
2909 }
2910
64f93798
PS
2911 // Summary is a required field so copy the text over
2912 $data->summary = $data->summary_editor['text'];
2913 $data->summaryformat = $data->summary_editor['format'];
2914
8bdc9cac 2915 $data->id = $DB->insert_record('course_request', $data);
64f93798 2916
8bdc9cac
SH
2917 // Create a new course_request object and return it
2918 $request = new course_request($data);
2919
2920 // Notify the admin if required.
adf176d7 2921 if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
aa6c1ced 2922
8bdc9cac
SH
2923 $a = new stdClass;
2924 $a->link = "$CFG->wwwroot/course/pending.php";
2925 $a->user = fullname($USER);
2926 $subject = get_string('courserequest');
2927 $message = get_string('courserequestnotifyemail', 'admin', $a);
2928 foreach ($users as $user) {
2a63b636 2929 $request->notify($user, $USER, 'courserequested', $subject, $message);
8bdc9cac
SH
2930 }
2931 }
2932
2933 return $request;
2934 }
2935
2936 /**
2937 * Returns an array of options to use with a summary editor
2938 *
2939 * @uses course_request::$summaryeditoroptions
2940 * @return array An array of options to use with the editor
2941 */
2942 public static function summary_editor_options() {
2943 global $CFG;
2944 if (self::$summaryeditoroptions === null) {
64f93798 2945 self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
8bdc9cac
SH
2946 }
2947 return self::$summaryeditoroptions;
2948 }
2949
8bdc9cac
SH
2950 /**
2951 * Loads the properties for this course request object. Id is required and if
2952 * only id is provided then we load the rest of the properties from the database
2953 *
2954 * @param stdClass|int $properties Either an object containing properties
2955 * or the course_request id to load
2956 */
2957 public function __construct($properties) {
2958 global $DB;
2959 if (empty($properties->id)) {
2960 if (empty($properties)) {
2961 throw new coding_exception('You must provide a course request id when creating a course_request object');
2962 }
2963 $id = $properties;
2964 $properties = new stdClass;
2965 $properties->id = (int)$id;
2966 unset($id);
2967 }
2968 if (empty($properties->requester)) {
2969 if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2970 print_error('unknowncourserequest');
2971 }
2972 } else {
2973 $this->properties = $properties;
2974 }
2975 $this->properties->collision = null;
2976 }
2977
2978 /**
2979 * Returns the requested property
2980 *
2981 * @param string $key
2982 * @return mixed
2983 */
2984 public function __get($key) {
8bdc9cac
SH
2985 return $this->properties->$key;
2986 }
2987
2988 /**
2989 * Override this to ensure empty($request->blah) calls return a reliable answer...
2990 *
2991 * This is required because we define the __get method
2992 *
2993 * @param mixed $key
2994 * @return bool True is it not empty, false otherwise
2995 */
2996 public function __isset($key) {
2997 return (!empty($this->properties->$key));
2998 }
2999
3000 /**
3001 * Returns the user who requested this course
3002 *
3003 * Uses a static var to cache the results and cut down the number of db queries
3004 *
3005 * @staticvar array $requesters An array of cached users
3006 * @return stdClass The user who requested the course
3007 */
3008 public function get_requester() {
3009 global $DB;
3010 static $requesters= array();
3011 if (!array_key_exists($this->properties->requester, $requesters)) {
3012 $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
3013 }
3014 return $requesters[$this->properties->requester];
3015 }
3016
3017 /**
3018 * Checks that the shortname used by the course does not conflict with any other
3019 * courses that exist
3020 *
3021 * @param string|null $shortnamemark The string to append to the requests shortname
3022 * should a conflict be found
3023 * @return bool true is there is a conflict, false otherwise
3024 */
3025 public function check_shortname_collision($shortnamemark = '[*]') {
3026 global $DB;
3027
3028 if ($this->properties->collision !== null) {
3029 return $this->properties->collision;
3030 }
3031
3032 if (empty($this->properties->shortname)) {
3033 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
3034 $this->properties->collision = false;
3035 } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
3036 if (!empty($shortnamemark)) {
3037 $this->properties->shortname .= ' '.$shortnamemark;
3038 }
3039 $this->properties->collision = true;
3040 } else {
3041 $this->properties->collision = false;
3042 }
3043 return $this->properties->collision;
3044 }
3045
2d8a275b
MG
3046 /**
3047 * Returns the category where this course request should be created
3048 *
3049 * Note that we don't check here that user has a capability to view
3050 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
3051 * 'moodle/course:changecategory'
3052 *
3053 * @return coursecat
3054 */
3055 public function get_category() {
3056 global $CFG;
3057 require_once($CFG->libdir.'/coursecatlib.php');
3058 // If the category is not set, if the current user does not have the rights to change the category, or if the
3059 // category does not exist, we set the default category to the course to be approved.
3060 // The system level is used because the capability moodle/site:approvecourse is based on a system level.
3061 if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
3062 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
3063 $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
3064 }
3065 if (!$category) {
3066 $category = coursecat::get_default();
3067 }
3068 return $category;
3069 }
3070
8bdc9cac
SH
3071 /**
3072 * This function approves the request turning it into a course
3073 *
3074 * This function converts the course request into a course, at the same time
7e85563d 3075 * transferring any files used in the summary to the new course and then removing
8bdc9cac
SH
3076 * the course request and the files associated with it.
3077 *
3078 * @return int The id of the course that was created from this request
3079 */
3080 public function approve() {
3081 global $CFG, $DB, $USER;
70740405
PS
3082
3083 $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
3084
8bdc9cac
SH
3085 $courseconfig = get_config('moodlecourse');
3086
3087 // Transfer appropriate settings
70740405
PS
3088 $data = clone($this->properties);
3089 unset($data->id);
3090 unset($data->reason);
3091 unset($data->requester);
8bdc9cac
SH
3092
3093 // Set category
2d8a275b 3094 $category = $this->get_category();
70740405 3095 $data->category = $category->id;
8bdc9cac 3096 // Set misc settings
70740405 3097 $data->requested = 1;
8bdc9cac
SH
3098
3099 // Apply course default settings
70740405 3100 $data->format = $courseconfig->format;
70740405
PS
3101 $data->newsitems = $courseconfig->newsitems;
3102 $data->showgrades = $courseconfig->showgrades;
3103 $data->showreports = $courseconfig->showreports;
3104 $data->maxbytes = $courseconfig->maxbytes;
3105 $data->groupmode = $courseconfig->groupmode;
3106 $data->groupmodeforce = $courseconfig->groupmodeforce;
3107 $data->visible = $courseconfig->visible;
3108 $data->visibleold = $data->visible;
3109 $data->lang = $courseconfig->lang;
8bdc9cac 3110
70740405 3111 $course = create_course($data);
1f364c87 3112 $context = context_course::instance($course->id, MUST_EXIST);
8bdc9cac 3113
70740405
PS
3114 // add enrol instances
3115 if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
3116 if ($manual = enrol_get_plugin('manual')) {
3117 $manual->add_default_instance($course);
3118 }
8bdc9cac 3119 }
70740405
PS
3120
3121 // enrol the requester as teacher if necessary
3122 if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
3123 enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
3124 }
3125
3126 $this->delete();
3127
fbaea88f 3128 $a = new stdClass();
9a5e297b 3129 $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
70740405
PS
3130 $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
3131 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
3132
3133 return $course->id;
8bdc9cac
SH
3134 }
3135
3136 /**
3137 * Reject a course request
3138 *
3139 * This function rejects a course request, emailing the requesting user the
3140 * provided notice and then removing the request from the database
3141 *
3142 * @param string $notice The message to display to the user
3143 */
3144 public function reject($notice) {
70740405
PS
3145 global $USER, $DB;
3146 $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
8bdc9cac
SH
3147 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
3148 $this->delete();
3149 }
3150
3151 /**
3152 * Deletes the course request and any associated files
3153 */
3154 public function delete() {
3155 global $DB;
3156 $DB->delete_records('course_request', array('id' => $this->properties->id));
8bdc9cac
SH
3157 }
3158
3159 /**
3160 * Send a message from one user to another using events_trigger
3161 *
3162 * @param object $touser
3163 * @param object $fromuser
3164 * @param string $name
3165 * @param string $subject
3166 * @param string $message
3167 */
3168 protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
fbaea88f 3169 $eventdata = new stdClass();
a1708181 3170 $eventdata->component = 'moodle';
8bdc9cac
SH
3171 $eventdata->name = $name;
3172 $eventdata->userfrom = $fromuser;
3173 $eventdata->userto = $touser;
3174 $eventdata->subject = $subject;
3175 $eventdata->fullmessage = $message;
3176 $eventdata->fullmessageformat = FORMAT_PLAIN;
3177 $eventdata->fullmessagehtml = '';
3178 $eventdata->smallmessage = '';
a1708181 3179 $eventdata->notification = 1;
7c7d3afa 3180 message_send($eventdata);
8bdc9cac 3181 }
5c34c4ba 3182}
b1627a92
DC
3183
3184/**
3185 * Return a list of page types
3186 * @param string $pagetype current page type
9dd85edf
MG
3187 * @param context $parentcontext Block's parent context
3188 * @param context $currentcontext Current context of block
3189 * @return array array of page types
b1627a92 3190 */
b38e2e28 3191function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
9dd85edf
MG
3192 if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
3193 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
3194 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3195 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
3196 );
3197 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
3198 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
3199 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
3200 } else {
3201 // Otherwise consider it a page inside a course even if $currentcontext is null
3202 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
3203 'course-*' => get_string('page-course-x', 'pagetype'),
3204 'course-view-*' => get_string('page-course-view-x', 'pagetype')
3205 );
b1627a92 3206 }
9dd85edf 3207 return $pagetypes;
af27c69e 3208}
ebaa29d1 3209
5720019d
ARN
3210/**
3211 * Determine whether course ajax should be enabled for the specified course
3212 *
924c34df 3213 * @param stdClass $course The course to test against
5720019d
ARN
3214 * @return boolean Whether course ajax is enabled or note
3215 */
3216function course_ajax_enabled($course) {
3217 global $CFG, $PAGE, $SITE;
3218
5720019d
ARN
3219 // The user must be editing for AJAX to be included
3220 if (!$PAGE->user_is_editing()) {
3221 return false;
3222 }
3223
3224 // Check that the theme suports
3225 if (!$PAGE->theme->enablecourseajax) {
3226 return false;
3227 }
3228
3229 // Check that the course format supports ajax functionality
3230 // The site 'format' doesn't have information on course format support
3231 if ($SITE->id !== $course->id) {
3232 $courseformatajaxsupport = course_format_ajax_support($course->format);
3233 if (!$courseformatajaxsupport->capable) {
3234 return false;
3235 }
3236 }
3237
3238 // All conditions have been met so course ajax should be enabled
3239 return true;
3240}
3241
ebaa29d1
ARN
3242/**
3243 * Include the relevant javascript and language strings for the resource
3244 * toolbox YUI module
3245 *
3246 * @param integer $id The ID of the course being applied to
7b061512
SH
3247 * @param array $usedmodules An array containing the names of the modules in use on the page
3248 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
924c34df 3249 * @param stdClass $config An object containing configuration parameters for ajax modules including:
ebaa29d1
ARN
3250 * * resourceurl The URL to post changes to for resource changes
3251 * * sectionurl The URL to post changes to for section changes
3252 * * pageparams Additional parameters to pass through in the post
7b061512 3253 * @return bool
ebaa29d1 3254 */
7b061512 3255function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
52973369 3256 global $CFG, $PAGE, $SITE;
ebaa29d1
ARN
3257
3258 // Ensure that ajax should be included
5720019d
ARN
3259 if (!course_ajax_enabled($course)) {
3260 return false;
ebaa29d1
ARN
3261 }
3262
3263 if (!$config) {
3264 $config = new stdClass();
3265 }
3266
3267 // The URL to use for resource changes
3268 if (!isset($config->resourceurl)) {
3269 $config->resourceurl = '/course/rest.php';
3270 }
3271
3272 // The URL to use for section changes
3273 if (!isset($config->sectionurl)) {
3274 $config->sectionurl = '/course/rest.php';
3275 }
3276
3277 // Any additional parameters which need to be included on page submission
3278 if (!isset($config->pageparams)) {
3279 $config->pageparams = array();
3280 }
3281
3282 // Include toolboxes
3283 $PAGE->requires->yui_module('moodle-course-toolboxes',
3284 'M.course.init_resource_toolbox',
3285 array(array(
3286 'courseid' => $course->id,
3287 'ajaxurl' => $config->resourceurl,
3288 'config' => $config,
3289 ))
3290 );
3291 $PAGE->requires->yui_module('moodle-course-toolboxes',
3292 'M.course.init_section_toolbox',
3293 array(array(
3294 'courseid' => $course->id,
3295 'format' => $course->format,
3296 'ajaxurl' => $config->sectionurl,
3297 'config' => $config,
3298 ))
3299 );
3300
15e2552f 3301 // Include course dragdrop
47281f7e 3302 if (course_format_uses_sections($course->format)) {
c77582fe 3303 $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
15e2552f
RK
3304 array(array(
3305 'courseid' => $course->id,
56838156 3306 'ajaxurl' => $config->sectionurl,
15e2552f
RK
3307 'config' => $config,
3308 )), null, true);