MDL-41565 events: fix unit test
[moodle.git] / course / lib.php
CommitLineData
d9cb06dc 1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * Library of useful functions
20 *
21 * @copyright 1999 Martin Dougiamas http://dougiamas.com
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
df997f84
PS
23 * @package core
24 * @subpackage course
d9cb06dc 25 */
f9903ed0 26
df997f84
PS
27defined('MOODLE_INTERNAL') || die;
28
4e781c7b 29require_once($CFG->libdir.'/completionlib.php');
8bdc9cac 30require_once($CFG->libdir.'/filelib.php');
ee7084e9 31require_once($CFG->dirroot.'/course/format/lib.php');
f9903ed0 32
92890025 33define('COURSE_MAX_LOGS_PER_PAGE', 1000); // records
92890025 34define('COURSE_MAX_RECENT_PERIOD', 172800); // Two days, in seconds
3b7bfbb5
FM
35
36/**
37 * Number of courses to display when summaries are included.
38 * @var int
39 * @deprecated since 2.4, use $CFG->courseswithsummarieslimit instead.
40 */
41define('COURSE_MAX_SUMMARIES_PER_PAGE', 10);
42
950c35a9 43define('COURSE_MAX_COURSES_PER_DROPDOWN',1000); // max courses in log dropdown before switching to optional
92890025 44define('COURSE_MAX_USERS_PER_DROPDOWN',1000); // max users in log dropdown before switching to optional
220a90c5 45define('FRONTPAGENEWS', '0');
0fd26350 46define('FRONTPAGECOURSELIST', '1'); // Not used. TODO MDL-38832 remove
220a90c5 47define('FRONTPAGECATEGORYNAMES', '2');
0fd26350 48define('FRONTPAGETOPICONLY', '3'); // Not used. TODO MDL-38832 remove
220a90c5 49define('FRONTPAGECATEGORYCOMBO', '4');
0fd26350
MG
50define('FRONTPAGEENROLLEDCOURSELIST', '5');
51define('FRONTPAGEALLCOURSELIST', '6');
52define('FRONTPAGECOURSESEARCH', '7');
53define('FRONTPAGECOURSELIMIT', 200); // Important! Replaced with $CFG->frontpagecourselimit - maximum number of courses displayed on the frontpage. TODO MDL-38832 remove
6f24e48e 54define('EXCELROWS', 65535);
55define('FIRSTUSEDEXCELROW', 3);
60fdc714 56
89bfeee0 57define('MOD_CLASS_ACTIVITY', 0);
58define('MOD_CLASS_RESOURCE', 1);
59
600149be 60function make_log_url($module, $url) {
61 switch ($module) {
bd7be234 62 case 'course':
d48f6068 63 if (strpos($url, 'report/') === 0) {
3ce3bb88 64 // there is only one report type, course reports are deprecated
d48f6068
PS
65 $url = "/$url";
66 break;
67 }
bd7be234 68 case 'file':
69 case 'login':
70 case 'lib':
71 case 'admin':
bd7be234 72 case 'calendar':
95d1d037 73 case 'category':
bd5d0ce5 74 case 'mnet course':
11003188 75 if (strpos($url, '../') === 0) {
76 $url = ltrim($url, '.');
77 } else {
78 $url = "/course/$url";
79 }
bd5d0ce5 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
cb6fec1f 856/**
857 * For a given course, returns an array of course activity objects
858 * Each item in the array contains he following properties:
859 */
d897cae4 860function get_array_of_activities($courseid) {
d897cae4 861// cm - course module id
862// mod - name of the module (eg forum)
863// section - the number of the section (eg week or topic)
864// name - the name of the instance
5867bfb5 865// visible - is the instance visible or not
13534ef7
ML
866// groupingid - grouping id
867// groupmembersonly - is this instance visible to group members only
86aa7ccf 868// extra - contains extra string to include in any link
cb6fec1f 869 global $CFG, $DB;
82bd6a5e 870 if(!empty($CFG->enableavailability)) {
871 require_once($CFG->libdir.'/conditionlib.php');
872 }
8dddba42 873
a0c30e1b 874 $course = $DB->get_record('course', array('id'=>$courseid));
875
876 if (empty($course)) {
877 throw new moodle_exception('courseidnotfound');
878 }
879
d897cae4 880 $mod = array();
881
a0c30e1b 882 $rawmods = get_course_mods($courseid);
883 if (empty($rawmods)) {
dd97c328 884 return $mod; // always return array
d897cae4 885 }
886
eceecb72 887 if ($sections = $DB->get_records("course_sections", array("course"=>$courseid), "section ASC")) {
d897cae4 888 foreach ($sections as $section) {
74666583 889 if (!empty($section->sequence)) {
d897cae4 890 $sequence = explode(",", $section->sequence);
891 foreach ($sequence as $seq) {
7af6281f 892 if (empty($rawmods[$seq])) {
893 continue;
894 }
b85b25eb 895 $mod[$seq] = new stdClass();
dd97c328 896 $mod[$seq]->id = $rawmods[$seq]->instance;
897 $mod[$seq]->cm = $rawmods[$seq]->id;
898 $mod[$seq]->mod = $rawmods[$seq]->modname;
adaeccb6 899
900 // Oh dear. Inconsistent names left here for backward compatibility.
dd97c328 901 $mod[$seq]->section = $section->section;
adaeccb6 902 $mod[$seq]->sectionid = $rawmods[$seq]->section;
903
904 $mod[$seq]->module = $rawmods[$seq]->module;
905 $mod[$seq]->added = $rawmods[$seq]->added;
906 $mod[$seq]->score = $rawmods[$seq]->score;
66b250fd 907 $mod[$seq]->idnumber = $rawmods[$seq]->idnumber;
dd97c328 908 $mod[$seq]->visible = $rawmods[$seq]->visible;
adaeccb6 909 $mod[$seq]->visibleold = $rawmods[$seq]->visibleold;
dd97c328 910 $mod[$seq]->groupmode = $rawmods[$seq]->groupmode;
911 $mod[$seq]->groupingid = $rawmods[$seq]->groupingid;
13534ef7 912 $mod[$seq]->groupmembersonly = $rawmods[$seq]->groupmembersonly;
82bd6a5e 913 $mod[$seq]->indent = $rawmods[$seq]->indent;
914 $mod[$seq]->completion = $rawmods[$seq]->completion;
dd97c328 915 $mod[$seq]->extra = "";
adaeccb6 916 $mod[$seq]->completiongradeitemnumber =
917 $rawmods[$seq]->completiongradeitemnumber;
918 $mod[$seq]->completionview = $rawmods[$seq]->completionview;
919 $mod[$seq]->completionexpected = $rawmods[$seq]->completionexpected;
920 $mod[$seq]->availablefrom = $rawmods[$seq]->availablefrom;
921 $mod[$seq]->availableuntil = $rawmods[$seq]->availableuntil;
922 $mod[$seq]->showavailability = $rawmods[$seq]->showavailability;
8c40662e 923 $mod[$seq]->showdescription = $rawmods[$seq]->showdescription;
adaeccb6 924 if (!empty($CFG->enableavailability)) {
82bd6a5e 925 condition_info::fill_availability_conditions($rawmods[$seq]);
82bd6a5e 926 $mod[$seq]->conditionscompletion = $rawmods[$seq]->conditionscompletion;
927 $mod[$seq]->conditionsgrade = $rawmods[$seq]->conditionsgrade;
76af15bb 928 $mod[$seq]->conditionsfield = $rawmods[$seq]->conditionsfield;
82bd6a5e 929 }
8dddba42 930
931 $modname = $mod[$seq]->mod;
932 $functionname = $modname."_get_coursemodule_info";
933
3a37b3f8 934 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
935 continue;
936 }
937
8dddba42 938 include_once("$CFG->dirroot/mod/$modname/lib.php");
939
b3a89232 940 if ($hasfunction = function_exists($functionname)) {
9d361034 941 if ($info = $functionname($rawmods[$seq])) {
9d361034 942 if (!empty($info->icon)) {
943 $mod[$seq]->icon = $info->icon;
944 }
9a9012dc
PS
945 if (!empty($info->iconcomponent)) {
946 $mod[$seq]->iconcomponent = $info->iconcomponent;
947 }
1ea543df 948 if (!empty($info->name)) {
9a9012dc 949 $mod[$seq]->name = $info->name;
1ea543df 950 }
0d8b6a69 951 if ($info instanceof cached_cm_info) {
952 // When using cached_cm_info you can include three new fields
953 // that aren't available for legacy code
954 if (!empty($info->content)) {
955 $mod[$seq]->content = $info->content;
956 }
957 if (!empty($info->extraclasses)) {
958 $mod[$seq]->extraclasses = $info->extraclasses;
959 }
c443a1cd 960 if (!empty($info->iconurl)) {
4fcdb012
MG
961 // Convert URL to string as it's easier to store. Also serialized object contains \0 byte and can not be written to Postgres DB.
962 $url = new moodle_url($info->iconurl);
963 $mod[$seq]->iconurl = $url->out(false);
c443a1cd 964 }
0d8b6a69 965 if (!empty($info->onclick)) {
966 $mod[$seq]->onclick = $info->onclick;
967 }
968 if (!empty($info->customdata)) {
969 $mod[$seq]->customdata = $info->customdata;
970 }
971 } else {
972 // When using a stdclass, the (horrible) deprecated ->extra field
973 // is available for BC
974 if (!empty($info->extra)) {
975 $mod[$seq]->extra = $info->extra;
976 }
977 }
c9f6251e 978 }
979 }
b3a89232 980 // When there is no modname_get_coursemodule_info function,
981 // but showdescriptions is enabled, then we use the 'intro'
982 // and 'introformat' fields in the module table
983 if (!$hasfunction && $rawmods[$seq]->showdescription) {
984 if ($modvalues = $DB->get_record($rawmods[$seq]->modname,
985 array('id' => $rawmods[$seq]->instance), 'name, intro, introformat')) {
986 // Set content from intro and introformat. Filters are disabled
987 // because we filter it with format_text at display time
988 $mod[$seq]->content = format_module_intro($rawmods[$seq]->modname,
989 $modvalues, $rawmods[$seq]->id, false);
990
991 // To save making another query just below, put name in here
992 $mod[$seq]->name = $modvalues->name;
993 }
994 }
1ea543df 995 if (!isset($mod[$seq]->name)) {
9a9012dc 996 $mod[$seq]->name = $DB->get_field($rawmods[$seq]->modname, "name", array("id"=>$rawmods[$seq]->instance));
1ea543df 997 }
0d8b6a69 998
999 // Minimise the database size by unsetting default options when they are
1000 // 'empty'. This list corresponds to code in the cm_info constructor.
8c40662e 1001 foreach (array('idnumber', 'groupmode', 'groupingid', 'groupmembersonly',
c443a1cd 1002 'indent', 'completion', 'extra', 'extraclasses', 'iconurl', 'onclick', 'content',
adaeccb6 1003 'icon', 'iconcomponent', 'customdata', 'showavailability', 'availablefrom',
1004 'availableuntil', 'conditionscompletion', 'conditionsgrade',
8c40662e 1005 'completionview', 'completionexpected', 'score', 'showdescription')
1006 as $property) {
0d8b6a69 1007 if (property_exists($mod[$seq], $property) &&
1008 empty($mod[$seq]->{$property})) {
1009 unset($mod[$seq]->{$property});
1010 }
1011 }
adaeccb6 1012 // Special case: this value is usually set to null, but may be 0
1013 if (property_exists($mod[$seq], 'completiongradeitemnumber') &&
1014 is_null($mod[$seq]->completiongradeitemnumber)) {
1015 unset($mod[$seq]->completiongradeitemnumber);
1016 }
d897cae4 1017 }
1018 }
1019 }
1020 }
1021 return $mod;
1022}
1023
cb6fec1f 1024/**
d57aa283
MG
1025 * Returns the localised human-readable names of all used modules
1026 *
1027 * @param bool $plural if true returns the plural forms of the names
1028 * @return array where key is the module name (component name without 'mod_') and
1029 * the value is the human-readable string. Array sorted alphabetically by value
cb6fec1f 1030 */
d57aa283
MG
1031function get_module_types_names($plural = false) {
1032 static $modnames = null;
1033 global $DB, $CFG;
1034 if ($modnames === null) {
1035 $modnames = array(0 => array(), 1 => array());
1036 if ($allmods = $DB->get_records("modules")) {
1037 foreach ($allmods as $mod) {
1038 if (file_exists("$CFG->dirroot/mod/$mod->name/lib.php") && $mod->visible) {
1039 $modnames[0][$mod->name] = get_string("modulename", "$mod->name");
1040 $modnames[1][$mod->name] = get_string("modulenameplural", "$mod->name");
1041 }
13534ef7 1042 }
2f1e464a
PS
1043 core_collator::asort($modnames[0]);
1044 core_collator::asort($modnames[1]);
c7da6f7a 1045 }
7468bf01 1046 }
d57aa283 1047 return $modnames[(int)$plural];
7468bf01 1048}
1049
93d46f48
RK
1050/**
1051 * Set highlighted section. Only one section can be highlighted at the time.
1052 *
1053 * @param int $courseid course id
1054 * @param int $marker highlight section with this number, 0 means remove higlightin
1055 * @return void
1056 */
1057function course_set_marker($courseid, $marker) {
1058 global $DB;
1059 $DB->set_field("course", "marker", $marker, array('id' => $courseid));
a062c97c 1060 format_base::reset_course_cache($courseid);
93d46f48
RK
1061}
1062
cb6fec1f 1063/**
7e85563d 1064 * For a given course section, marks it visible or hidden,
cb6fec1f 1065 * and does the same for every activity in that section
ebaa29d1
ARN
1066 *
1067 * @param int $courseid course id
1068 * @param int $sectionnumber The section number to adjust
1069 * @param int $visibility The new visibility
1070 * @return array A list of resources which were hidden in the section
cb6fec1f 1071 */
7d99d695 1072function set_section_visible($courseid, $sectionnumber, $visibility) {
cb6fec1f 1073 global $DB;
7d99d695 1074
ebaa29d1 1075 $resourcestotoggle = array();
cb6fec1f 1076 if ($section = $DB->get_record("course_sections", array("course"=>$courseid, "section"=>$sectionnumber))) {
1077 $DB->set_field("course_sections", "visible", "$visibility", array("id"=>$section->id));
7d99d695 1078 if (!empty($section->sequence)) {
1079 $modules = explode(",", $section->sequence);
1080 foreach ($modules as $moduleid) {
00a34234
FM
1081 if ($cm = $DB->get_record('course_modules', array('id' => $moduleid), 'visible, visibleold')) {
1082 if ($visibility) {
1083 // As we unhide the section, we use the previously saved visibility stored in visibleold.
1084 set_coursemodule_visible($moduleid, $cm->visibleold);
1085 } else {
1086 // We hide the section, so we hide the module but we store the original state in visibleold.
1087 set_coursemodule_visible($moduleid, 0);
1088 $DB->set_field('course_modules', 'visibleold', $cm->visible, array('id' => $moduleid));
1089 }
1090 }
7d99d695 1091 }
1092 }
38b19bbc 1093 rebuild_course_cache($courseid, true);
ebaa29d1
ARN
1094
1095 // Determine which modules are visible for AJAX update
1096 if (!empty($modules)) {
1097 list($insql, $params) = $DB->get_in_or_equal($modules);
1098 $select = 'id ' . $insql . ' AND visible = ?';
1099 array_push($params, $visibility);
1100 if (!$visibility) {
1101 $select .= ' AND visibleold = 1';
1102 }
1103 $resourcestotoggle = $DB->get_fieldset_select('course_modules', 'id', $select, $params);
1104 }
7d99d695 1105 }
ebaa29d1 1106 return $resourcestotoggle;
7d99d695 1107}
ba2e5d73 1108
59155a3f
ARN
1109/**
1110 * Retrieve all metadata for the requested modules
1111 *
1112 * @param object $course The Course
1113 * @param array $modnames An array containing the list of modules and their
1114 * names
a41b1d96 1115 * @param int $sectionreturn The section to return to
59155a3f
ARN
1116 * @return array A list of stdClass objects containing metadata about each
1117 * module
1118 */
923451c5 1119function get_module_metadata($course, $modnames, $sectionreturn = null) {
59155a3f
ARN
1120 global $CFG, $OUTPUT;
1121
1122 // get_module_metadata will be called once per section on the page and courses may show
1123 // different modules to one another
1124 static $modlist = array();
1125 if (!isset($modlist[$course->id])) {
1126 $modlist[$course->id] = array();
1127 }
1128
1129 $return = array();
17079335
MG
1130 $urlbase = new moodle_url('/course/mod.php', array('id' => $course->id, 'sesskey' => sesskey()));
1131 if ($sectionreturn !== null) {
1132 $urlbase->param('sr', $sectionreturn);
1133 }
59155a3f
ARN
1134 foreach($modnames as $modname => $modnamestr) {
1135 if (!course_allowed_module($course, $modname)) {
1136 continue;
1137 }
ad47d025 1138 if (isset($modlist[$course->id][$modname])) {
59155a3f
ARN
1139 // This module is already cached
1140 $return[$modname] = $modlist[$course->id][$modname];
1141 continue;
1142 }
1143
1144 // Include the module lib
1145 $libfile = "$CFG->dirroot/mod/$modname/lib.php";
1146 if (!file_exists($libfile)) {
1147 continue;
1148 }
1149 include_once($libfile);
1150
1151 // NOTE: this is legacy stuff, module subtypes are very strongly discouraged!!
1152 $gettypesfunc = $modname.'_get_types';
1153 if (function_exists($gettypesfunc)) {
56c0878b
SC
1154 $types = $gettypesfunc();
1155 if (is_array($types) && count($types) > 0) {
59155a3f
ARN
1156 $group = new stdClass();
1157 $group->name = $modname;
1158 $group->icon = $OUTPUT->pix_icon('icon', '', $modname, array('class' => 'icon'));
1159 foreach($types as $type) {
1160 if ($type->typestr === '--') {
1161 continue;
1162 }
1163 if (strpos($type->typestr, '--') === 0) {
1164 $group->title = str_replace('--', '', $type->typestr);
1165 continue;
1166 }
1167 // Set the Sub Type metadata
1168 $subtype = new stdClass();
1169 $subtype->title = $type->typestr;
1170 $subtype->type = str_replace('&amp;', '&', $type->type);
1171 $subtype->name = preg_replace('/.*type=/', '', $subtype->type);
1172 $subtype->archetype = $type->modclass;
1173
1174 // The group archetype should match the subtype archetypes and all subtypes
1175 // should have the same archetype
1176 $group->archetype = $subtype->archetype;
1177
1178 if (get_string_manager()->string_exists('help' . $subtype->name, $modname)) {
1179 $subtype->help = get_string('help' . $subtype->name, $modname);
1180 }
cf003abc 1181 $subtype->link = new moodle_url($urlbase, array('add' => $modname, 'type' => $subtype->name));
59155a3f
ARN
1182 $group->types[] = $subtype;
1183 }
1184 $modlist[$course->id][$modname] = $group;
1185 }
1186 } else {
1187 $module = new stdClass();
17079335 1188 $module->title = $modnamestr;
59155a3f 1189 $module->name = $modname;
17079335 1190 $module->link = new moodle_url($urlbase, array('add' => $modname));
59155a3f 1191 $module->icon = $OUTPUT->pix_icon('icon', '', $module->name, array('class' => 'icon'));
01e0e704
ARN
1192 $sm = get_string_manager();
1193 if ($sm->string_exists('modulename_help', $modname)) {
59155a3f 1194 $module->help = get_string('modulename_help', $modname);
01e0e704
ARN
1195 if ($sm->string_exists('modulename_link', $modname)) { // Link to further info in Moodle docs
1196 $link = get_string('modulename_link', $modname);
1197 $linktext = get_string('morehelp');
afe3566c 1198 $module->help .= html_writer::tag('div', $OUTPUT->doc_link($link, $linktext, true), array('class' => 'helpdoclink'));
01e0e704 1199 }
59155a3f
ARN
1200 }
1201 $module->archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
1202 $modlist[$course->id][$modname] = $module;
1203 }
56c0878b
SC
1204 if (isset($modlist[$course->id][$modname])) {
1205 $return[$modname] = $modlist[$course->id][$modname];
1206 } else {
1207 debugging("Invalid module metadata configuration for {$modname}");
1208 }
59155a3f
ARN
1209 }
1210
1211 return $return;
1212}
1213
8ed5dd63 1214/**
1215 * Return the course category context for the category with id $categoryid, except
1216 * that if $categoryid is 0, return the system context.
1217 *
1218 * @param integer $categoryid a category id or 0.
1219 * @return object the corresponding context
1220 */
1221function get_category_or_system_context($categoryid) {
1222 if ($categoryid) {
4658aec5 1223 return context_coursecat::instance($categoryid, IGNORE_MISSING);
8ed5dd63 1224 } else {
9a5e297b 1225 return context_system::instance();
8ed5dd63 1226 }
1227}
1228
cb6fec1f 1229/**
4e0b6025
MG
1230 * Returns full course categories trees to be used in html_writer::select()
1231 *
1232 * Calls {@link coursecat::make_categories_list()} to build the tree and
1233 * adds whitespace to denote nesting
1234 *
1235 * @return array array mapping coursecat id to the display name
cb6fec1f 1236 */
0705ff84 1237function make_categories_options() {
4e0b6025
MG
1238 global $CFG;
1239 require_once($CFG->libdir. '/coursecatlib.php');
a7a04f6d 1240 $cats = coursecat::make_categories_list('', 0, ' / ');
0705ff84 1241 foreach ($cats as $key => $value) {
a7a04f6d
MG
1242 // Prefix the value with the number of spaces equal to category depth (number of separators in the value).
1243 $cats[$key] = str_repeat('&nbsp;', substr_count($value, ' / ')). $value;
0705ff84 1244 }
1245 return $cats;
1246}
c2cb4545 1247
77eddcd5 1248/**
1249 * Print the buttons relating to course requests.
1250 *
8e57a6df 1251 * @param object $context current page context.
77eddcd5 1252 */
8e57a6df 1253function print_course_request_buttons($context) {
b4531207 1254 global $CFG, $DB, $OUTPUT;
77eddcd5 1255 if (empty($CFG->enablecourserequests)) {
1256 return;
1257 }
8e57a6df 1258 if (!has_capability('moodle/course:create', $context) && has_capability('moodle/course:request', $context)) {
77eddcd5 1259 /// Print a button to request a new course
8e57a6df 1260 echo $OUTPUT->single_button(new moodle_url('/course/request.php'), get_string('requestcourse'), 'get');
77eddcd5 1261 }
1262 /// Print a button to manage pending requests
8e57a6df 1263 if ($context->contextlevel == CONTEXT_SYSTEM && has_capability('moodle/site:approvecourse', $context)) {
5c2ed7e2 1264 $disabled = !$DB->record_exists('course_request', array());
8e57a6df 1265 echo $OUTPUT->single_button(new moodle_url('/course/pending.php'), get_string('coursespending'), 'get', array('disabled' => $disabled));
77eddcd5 1266 }
1267}
1268
5048e034 1269/**
1270 * Does the user have permission to edit things in this category?
1271 *
1272 * @param integer $categoryid The id of the category we are showing, or 0 for system context.
1273 * @return boolean has_any_capability(array(...), ...); in the appropriate context.
1274 */
1275function can_edit_in_category($categoryid = 0) {
1276 $context = get_category_or_system_context($categoryid);
1277 return has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $context);
1278}
1279
11b0c469 1280/// MODULE FUNCTIONS /////////////////////////////////////////////////////////////////
1281
1282function add_course_module($mod) {
cb6fec1f 1283 global $DB;
11b0c469 1284
e5dfd0f3 1285 $mod->added = time();
53f4ad2c 1286 unset($mod->id);
11b0c469 1287
38b19bbc
MG
1288 $cmid = $DB->insert_record("course_modules", $mod);
1289 rebuild_course_cache($mod->course, true);
1290 return $cmid;
11b0c469 1291}
1292
97928ddf 1293/**
4ede27b2 1294 * Creates missing course section(s) and rebuilds course cache
99e9f9a6 1295 *
b46be6ad 1296 * @param int|stdClass $courseorid course id or course object
4ede27b2
MG
1297 * @param int|array $sections list of relative section numbers to create
1298 * @return bool if there were any sections created
97928ddf 1299 */
b46be6ad 1300function course_create_sections_if_missing($courseorid, $sections) {
cb6fec1f 1301 global $DB;
4ede27b2
MG
1302 if (!is_array($sections)) {
1303 $sections = array($sections);
1304 }
b46be6ad
MG
1305 $existing = array_keys(get_fast_modinfo($courseorid)->get_section_info_all());
1306 if (is_object($courseorid)) {
1307 $courseorid = $courseorid->id;
1308 }
4ede27b2
MG
1309 $coursechanged = false;
1310 foreach ($sections as $sectionnum) {
1311 if (!in_array($sectionnum, $existing)) {
1312 $cw = new stdClass();
b46be6ad 1313 $cw->course = $courseorid;
4ede27b2
MG
1314 $cw->section = $sectionnum;
1315 $cw->summary = '';
1316 $cw->summaryformat = FORMAT_HTML;
1317 $cw->sequence = '';
1318 $id = $DB->insert_record("course_sections", $cw);
1319 $coursechanged = true;
1320 }
1321 }
1322 if ($coursechanged) {
b46be6ad 1323 rebuild_course_cache($courseorid, true);
4ede27b2
MG
1324 }
1325 return $coursechanged;
97928ddf 1326}
52f14061 1327
ece966f0 1328/**
722e6ba9 1329 * Adds an existing module to the section
ece966f0 1330 *
722e6ba9
MG
1331 * Updates both tables {course_sections} and {course_modules}
1332 *
5523c344 1333 * Note: This function does not use modinfo PROVIDED that the section you are
1334 * adding the module to already exists. If the section does not exist, it will
1335 * build modinfo if necessary and create the section.
1336 *
722e6ba9 1337 * @param int|stdClass $courseorid course id or course object
46453565 1338 * @param int $cmid id of the module already existing in course_modules table
722e6ba9
MG
1339 * @param int $sectionnum relative number of the section (field course_sections.section)
1340 * If section does not exist it will be created
1341 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1342 * before which the module needs to be included. Null for inserting in the
1343 * end of the section
1344 * @return int The course_sections ID where the module is inserted
ece966f0 1345 */
46453565 1346function course_add_cm_to_section($courseorid, $cmid, $sectionnum, $beforemod = null) {
722e6ba9
MG
1347 global $DB, $COURSE;
1348 if (is_object($beforemod)) {
1349 $beforemod = $beforemod->id;
1350 }
46453565
PS
1351 if (is_object($courseorid)) {
1352 $courseid = $courseorid->id;
1353 } else {
1354 $courseid = $courseorid;
1355 }
46453565 1356 // Do not try to use modinfo here, there is no guarantee it is valid!
5523c344 1357 $section = $DB->get_record('course_sections',
1358 array('course' => $courseid, 'section' => $sectionnum), '*', IGNORE_MISSING);
1359 if (!$section) {
1360 // This function call requires modinfo.
1361 course_create_sections_if_missing($courseorid, $sectionnum);
1362 $section = $DB->get_record('course_sections',
1363 array('course' => $courseid, 'section' => $sectionnum), '*', MUST_EXIST);
1364 }
1365
722e6ba9 1366 $modarray = explode(",", trim($section->sequence));
281d730e 1367 if (empty($section->sequence)) {
46453565 1368 $newsequence = "$cmid";
722e6ba9 1369 } else if ($beforemod && ($key = array_keys($modarray, $beforemod))) {
46453565 1370 $insertarray = array($cmid, $beforemod);
722e6ba9
MG
1371 array_splice($modarray, $key[0], 1, $insertarray);
1372 $newsequence = implode(",", $modarray);
1373 } else {
46453565 1374 $newsequence = "$section->sequence,$cmid";
722e6ba9
MG
1375 }
1376 $DB->set_field("course_sections", "sequence", $newsequence, array("id" => $section->id));
46453565 1377 $DB->set_field('course_modules', 'section', $section->id, array('id' => $cmid));
b46be6ad
MG
1378 if (is_object($courseorid)) {
1379 rebuild_course_cache($courseorid->id, true);
1380 } else {
1381 rebuild_course_cache($courseorid, true);
1382 }
722e6ba9 1383 return $section->id; // Return course_sections ID that was used.
11b0c469 1384}
1385
48e535bc 1386function set_coursemodule_groupmode($id, $groupmode) {
cb6fec1f 1387 global $DB;
38b19bbc
MG
1388 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,groupmode', MUST_EXIST);
1389 if ($cm->groupmode != $groupmode) {
1390 $DB->set_field('course_modules', 'groupmode', $groupmode, array('id' => $cm->id));
1391 rebuild_course_cache($cm->course, true);
1392 }
1393 return ($cm->groupmode != $groupmode);
3d575e6f 1394}
1395
177d4abf 1396function set_coursemodule_idnumber($id, $idnumber) {
cb6fec1f 1397 global $DB;
38b19bbc
MG
1398 $cm = $DB->get_record('course_modules', array('id' => $id), 'id,course,idnumber', MUST_EXIST);
1399 if ($cm->idnumber != $idnumber) {
1400 $DB->set_field('course_modules', 'idnumber', $idnumber, array('id' => $cm->id));
1401 rebuild_course_cache($cm->course, true);
1402 }
1403 return ($cm->idnumber != $idnumber);
177d4abf 1404}
4e781c7b 1405
02f66c42 1406/**
00a34234
FM
1407 * Set the visibility of a module and inherent properties.
1408 *
1409 * From 2.4 the parameter $prevstateoverrides has been removed, the logic it triggered
1410 * has been moved to {@link set_section_visible()} which was the only place from which
1411 * the parameter was used.
1412 *
1413 * @param int $id of the module
1414 * @param int $visible state of the module
1415 * @return bool false when the module was not found, true otherwise
1416 */
1417function set_coursemodule_visible($id, $visible) {
f5e2602a 1418 global $DB, $CFG;
0f078024 1419 require_once($CFG->libdir.'/gradelib.php');
c5ceaeaf 1420 require_once($CFG->dirroot.'/calendar/lib.php');
0f078024 1421
00a34234
FM
1422 // Trigger developer's attention when using the previously removed argument.
1423 if (func_num_args() > 2) {
1424 debugging('Wrong number of arguments passed to set_coursemodule_visible(), $prevstateoverrides
1425 has been removed.', DEBUG_DEVELOPER);
1426 }
1427
cb6fec1f 1428 if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
978abb42 1429 return false;
1430 }
40fcc261
AD
1431
1432 // Create events and propagate visibility to associated grade items if the value has changed.
1433 // Only do this if it's changed to avoid accidently overwriting manual showing/hiding of student grades.
1434 if ($cm->visible == $visible) {
1435 return true;
1436 }
1437
cb6fec1f 1438 if (!$modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module))) {
978abb42 1439 return false;
1440 }
cb6fec1f 1441 if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
dcd338ff 1442 foreach($events as $event) {
48e535bc 1443 if ($visible) {
379cd2d4
EL
1444 $event = new calendar_event($event);
1445 $event->toggle_visibility(true);
48e535bc 1446 } else {
379cd2d4
EL
1447 $event = new calendar_event($event);
1448 $event->toggle_visibility(false);
48e535bc 1449 }
dcd338ff 1450 }
1451 }
f5e2602a 1452
40fcc261 1453 // Hide the associated grade items so the teacher doesn't also have to go to the gradebook and hide them there.
0f078024
DM
1454 $grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename, 'iteminstance'=>$cm->instance, 'courseid'=>$cm->course));
1455 if ($grade_items) {
1456 foreach ($grade_items as $grade_item) {
1457 $grade_item->set_hidden(!$visible);
1458 }
f5e2602a 1459 }
f685e830 1460
00a34234
FM
1461 // Updating visible and visibleold to keep them in sync. Only changing a section visibility will
1462 // affect visibleold to allow for an original visibility restore. See set_section_visible().
1463 $cminfo = new stdClass();
1464 $cminfo->id = $id;
1465 $cminfo->visible = $visible;
1466 $cminfo->visibleold = $visible;
1467 $DB->update_record('course_modules', $cminfo);
1468
38b19bbc
MG
1469 rebuild_course_cache($cm->course, true);
1470 return true;
1acfbce5 1471}
1472
cb6fec1f 1473/**
a347aee3
MN
1474 * This function will handles the whole deletion process of a module. This includes calling
1475 * the modules delete_instance function, deleting files, events, grades, conditional data,
1476 * the data in the course_module and course_sections table and adding a module deletion
1477 * event to the DB.
290130b3 1478 *
a347aee3
MN
1479 * @param int $cmid the course module id
1480 * @since 2.5
290130b3 1481 */
a347aee3
MN
1482function course_delete_module($cmid) {
1483 global $CFG, $DB, $USER;
1484
f615fbab 1485 require_once($CFG->libdir.'/gradelib.php');
cae83708 1486 require_once($CFG->dirroot.'/blog/lib.php');
c5ceaeaf 1487 require_once($CFG->dirroot.'/calendar/lib.php');
f615fbab 1488
a347aee3
MN
1489 // Get the course module.
1490 if (!$cm = $DB->get_record('course_modules', array('id' => $cmid))) {
290130b3 1491 return true;
1492 }
a347aee3
MN
1493
1494 // Get the module context.
1495 $modcontext = context_module::instance($cm->id);
1496
1497 // Get the course module name.
1498 $modulename = $DB->get_field('modules', 'name', array('id' => $cm->module), MUST_EXIST);
1499
1500 // Get the file location of the delete_instance function for this module.
1501 $modlib = "$CFG->dirroot/mod/$modulename/lib.php";
1502
1503 // Include the file required to call the delete_instance function for this module.
1504 if (file_exists($modlib)) {
1505 require_once($modlib);
1506 } else {
9a9cb741
MN
1507 throw new moodle_exception('cannotdeletemodulemissinglib', '', '', null,
1508 "Cannot delete this module as the file mod/$modulename/lib.php is missing.");
a347aee3
MN
1509 }
1510
9a9cb741 1511 $deleteinstancefunction = $modulename . '_delete_instance';
a347aee3 1512
9a9cb741
MN
1513 // Ensure the delete_instance function exists for this module.
1514 if (!function_exists($deleteinstancefunction)) {
1515 throw new moodle_exception('cannotdeletemodulemissingfunc', '', '', null,
1516 "Cannot delete this module as the function {$modulename}_delete_instance is missing in mod/$modulename/lib.php.");
1517 }
1518
1519 // Call the delete_instance function, if it returns false throw an exception.
a347aee3 1520 if (!$deleteinstancefunction($cm->instance)) {
9a9cb741
MN
1521 throw new moodle_exception('cannotdeletemoduleinstance', '', '', null,
1522 "Cannot delete the module $modulename (instance).");
a347aee3
MN
1523 }
1524
1525 // Remove all module files in case modules forget to do that.
1526 $fs = get_file_storage();
1527 $fs->delete_area_files($modcontext->id);
1528
1529 // Delete events from calendar.
1530 if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $modulename))) {
dcd338ff 1531 foreach($events as $event) {
c5ceaeaf
DP
1532 $calendarevent = calendar_event::load($event->id);
1533 $calendarevent->delete();
dcd338ff 1534 }
1535 }
a347aee3
MN
1536
1537 // Delete grade items, outcome items and grades attached to modules.
1538 if ($grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $modulename,
1539 'iteminstance' => $cm->instance, 'courseid' => $cm->course))) {
f615fbab 1540 foreach ($grade_items as $grade_item) {
1541 $grade_item->delete('moddelete');
1542 }
f615fbab 1543 }
a347aee3 1544
46e12372
SM
1545 // Delete completion and availability data; it is better to do this even if the
1546 // features are not turned on, in case they were turned on previously (these will be
a347aee3 1547 // very quick on an empty table).
46e12372
SM
1548 $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
1549 $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
a8f84c28 1550 $DB->delete_records('course_modules_avail_fields', array('coursemoduleid' => $cm->id));
ede323e2
ARN
1551 $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
1552 'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
06b3a6b2 1553
a347aee3 1554 // Delete the context.
c592eea2 1555 context_helper::delete_instance(CONTEXT_MODULE, $cm->id);
a347aee3
MN
1556
1557 // Delete the module from the course_modules table.
1558 $DB->delete_records('course_modules', array('id' => $cm->id));
1559
1560 // Delete module from that section.
1561 if (!delete_mod_from_section($cm->id, $cm->section)) {
9a9cb741
MN
1562 throw new moodle_exception('cannotdeletemodulefromsection', '', '', null,
1563 "Cannot delete the module $modulename (instance) from section.");
a347aee3
MN
1564 }
1565
1566 // Trigger a mod_deleted event with information about this module.
1567 $eventdata = new stdClass();
1568 $eventdata->modulename = $modulename;
1569 $eventdata->cmid = $cm->id;
1570 $eventdata->courseid = $cm->course;
1571 $eventdata->userid = $USER->id;
1572 events_trigger('mod_deleted', $eventdata);
1573
1574 add_to_log($cm->course, 'course', "delete mod",
1575 "view.php?id=$cm->course",
1576 "$modulename $cm->instance", $cm->id);
1577
38b19bbc 1578 rebuild_course_cache($cm->course, true);
11b0c469 1579}
1580
722e6ba9 1581function delete_mod_from_section($modid, $sectionid) {
cb6fec1f 1582 global $DB;
11b0c469 1583
722e6ba9 1584 if ($section = $DB->get_record("course_sections", array("id"=>$sectionid)) ) {
11b0c469 1585
e5dfd0f3 1586 $modarray = explode(",", $section->sequence);
11b0c469 1587
722e6ba9 1588 if ($key = array_keys ($modarray, $modid)) {
11b0c469 1589 array_splice($modarray, $key[0], 1);
1590 $newsequence = implode(",", $modarray);
38b19bbc
MG
1591 $DB->set_field("course_sections", "sequence", $newsequence, array("id"=>$section->id));
1592 rebuild_course_cache($section->course, true);
1593 return true;
11b0c469 1594 } else {
1595 return false;
1596 }
89adb174 1597
11b0c469 1598 }
7977cffd 1599 return false;
11b0c469 1600}
1601
3440ec12 1602/**
1603 * Moves a section within a course, from a position to another.
1604 * Be very careful: $section and $destination refer to section number,
1605 * not id!.
1606 *
1607 * @param object $course
1608 * @param int $section Section number (not id!!!)
1609 * @param int $destination
1610 * @return boolean Result
1611 */
1612function move_section_to($course, $section, $destination) {
1613/// Moves a whole course section up and down within the course
1614 global $USER, $DB;
1615
ca255392 1616 if (!$destination && $destination != 0) {
3440ec12 1617 return true;
1618 }
1619
850acb35
MG
1620 // compartibility with course formats using field 'numsections'
1621 $courseformatoptions = course_get_format($course)->get_format_options();
1622 if ((array_key_exists('numsections', $courseformatoptions) &&
1623 ($destination > $courseformatoptions['numsections'])) || ($destination < 1)) {
3440ec12 1624 return false;
1625 }
1626
1627 // Get all sections for this course and re-order them (2 of them should now share the same section number)
1628 if (!$sections = $DB->get_records_menu('course_sections', array('course' => $course->id),
1629 'section ASC, id ASC', 'id, section')) {
1630 return false;
1631 }
1632
cf76b335 1633 $movedsections = reorder_sections($sections, $section, $destination);
3440ec12 1634
cf76b335 1635 // Update all sections. Do this in 2 steps to avoid breaking database
1636 // uniqueness constraint
1637 $transaction = $DB->start_delegated_transaction();
1638 foreach ($movedsections as $id => $position) {
1639 if ($sections[$id] !== $position) {
1640 $DB->set_field('course_sections', 'section', -$position, array('id' => $id));
1641 }
1642 }
e7e0f8d2
DP
1643 foreach ($movedsections as $id => $position) {
1644 if ($sections[$id] !== $position) {
1645 $DB->set_field('course_sections', 'section', $position, array('id' => $id));
1646 }
3440ec12 1647 }
1648
15e2552f
RK
1649 // If we move the highlighted section itself, then just highlight the destination.
1650 // Adjust the higlighted section location if we move something over it either direction.
1651 if ($section == $course->marker) {
e7b6e6b9 1652 course_set_marker($course->id, $destination);
2365213f 1653 } elseif ($section > $course->marker && $course->marker >= $destination) {
e7b6e6b9 1654 course_set_marker($course->id, $course->marker+1);
2365213f 1655 } elseif ($section < $course->marker && $course->marker <= $destination) {
e7b6e6b9 1656 course_set_marker($course->id, $course->marker-1);
15e2552f
RK
1657 }
1658
cf76b335 1659 $transaction->allow_commit();
38b19bbc 1660 rebuild_course_cache($course->id, true);
3440ec12 1661 return true;
1662}
1663
1664/**
1665 * Reordering algorithm for course sections. Given an array of section->section indexed by section->id,
1666 * an original position number and a target position number, rebuilds the array so that the
1667 * move is made without any duplication of section positions.
1668 * Note: The target_position is the position AFTER WHICH the moved section will be inserted. If you want to
1669 * insert a section before the first one, you must give 0 as the target (section 0 can never be moved).
1670 *
1671 * @param array $sections
1672 * @param int $origin_position
1673 * @param int $target_position
1674 * @return array
1675 */
1676function reorder_sections($sections, $origin_position, $target_position) {
1677 if (!is_array($sections)) {
1678 return false;
1679 }
1680
1681 // We can't move section position 0
1682 if ($origin_position < 1) {
1683 echo "We can't move section position 0";
1684 return false;
1685 }
1686
1687 // Locate origin section in sections array
1688 if (!$origin_key = array_search($origin_position, $sections)) {
1689 echo "searched position not in sections array";
1690 return false; // searched position not in sections array
1691 }
1692
1693 // Extract origin section
1694 $origin_section = $sections[$origin_key];
1695 unset($sections[$origin_key]);
1696
1697 // Find offset of target position (stupid PHP's array_splice requires offset instead of key index!)
1698 $found = false;
1699 $append_array = array();
1700 foreach ($sections as $id => $position) {
1701 if ($found) {
1702 $append_array[$id] = $position;
1703 unset($sections[$id]);
1704 }
1705 if ($position == $target_position) {
eb01aa2c
RT
1706 if ($target_position < $origin_position) {
1707 $append_array[$id] = $position;
1708 unset($sections[$id]);
1709 }
3440ec12 1710 $found = true;
1711 }
1712 }
1713
1714 // Append moved section
1715 $sections[$origin_key] = $origin_section;
1716
1717 // Append rest of array (if applicable)
1718 if (!empty($append_array)) {
1719 foreach ($append_array as $id => $position) {
1720 $sections[$id] = $position;
1721 }
1722 }
1723
1724 // Renumber positions
1725 $position = 0;
1726 foreach ($sections as $id => $p) {
1727 $sections[$id] = $position;
1728 $position++;
1729 }
1730
1731 return $sections;
1732
1733}
1734
cb6fec1f 1735/**
1736 * Move the module object $mod to the specified $section
1737 * If $beforemod exists then that is the module
1738 * before which $modid should be inserted
d55f05ef
MG
1739 *
1740 * @param stdClass|cm_info $mod
1741 * @param stdClass|section_info $section
1742 * @param int|stdClass $beforemod id or object with field id corresponding to the module
1743 * before which the module needs to be included. Null for inserting in the
1744 * end of the section
1745 * @return int new value for module visibility (0 or 1)
cb6fec1f 1746 */
7977cffd 1747function moveto_module($mod, $section, $beforemod=NULL) {
a83dd077 1748 global $OUTPUT, $DB;
7977cffd 1749
d55f05ef
MG
1750 // Current module visibility state - return value of this function.
1751 $modvisible = $mod->visible;
1752
1753 // Remove original module from original section.
7977cffd 1754 if (! delete_mod_from_section($mod->id, $mod->section)) {
e6db3026 1755 echo $OUTPUT->notification("Could not delete module from existing section");
7977cffd 1756 }
1757
d55f05ef 1758 // If moving to a hidden section then hide module.
bb1592c8
CF
1759 if ($mod->section != $section->id) {
1760 if (!$section->visible && $mod->visible) {
d55f05ef
MG
1761 // Module was visible but must become hidden after moving to hidden section.
1762 $modvisible = 0;
bb1592c8
CF
1763 set_coursemodule_visible($mod->id, 0);
1764 // Set visibleold to 1 so module will be visible when section is made visible.
1765 $DB->set_field('course_modules', 'visibleold', 1, array('id' => $mod->id));
1766 }
1767 if ($section->visible && !$mod->visible) {
d55f05ef 1768 // Hidden module was moved to the visible section, restore the module visibility from visibleold.
bb1592c8 1769 set_coursemodule_visible($mod->id, $mod->visibleold);
d55f05ef 1770 $modvisible = $mod->visibleold;
bb1592c8 1771 }
7977cffd 1772 }
1773
d55f05ef 1774 // Add the module into the new section.
722e6ba9 1775 course_add_cm_to_section($section->course, $mod->id, $section->section, $beforemod);
d55f05ef 1776 return $modvisible;
7977cffd 1777}
1778
f558b291
MG
1779/**
1780 * Returns the list of all editing actions that current user can perform on the module
1781 *
1782 * @param cm_info $mod The module to produce editing buttons for
1783 * @param int $indent The current indenting (default -1 means no move left-right actions)
1784 * @param int $sr The section to link back to (used for creating the links)
1785 * @return array array of action_link or pix_icon objects
1786 */
1787function course_get_cm_edit_actions(cm_info $mod, $indent = -1, $sr = null) {
1788 global $COURSE, $SITE;
94361e02 1789
3d575e6f 1790 static $str;
1791
9a5e297b
AA
1792 $coursecontext = context_course::instance($mod->course);
1793 $modcontext = context_module::instance($mod->id);
7749e187 1794
af189935
PS
1795 $editcaps = array('moodle/course:manageactivities', 'moodle/course:activityvisibility', 'moodle/role:assign');
1796 $dupecaps = array('moodle/backup:backuptargetimport', 'moodle/restore:restoretargetimport');
1797
cf69a00a 1798 // No permission to edit anything.
af189935 1799 if (!has_any_capability($editcaps, $modcontext) and !has_all_capabilities($dupecaps, $coursecontext)) {
f558b291 1800 return array();
217a8ee9 1801 }
1802
af189935
PS
1803 $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
1804
3d575e6f 1805 if (!isset($str)) {
f558b291
MG
1806 $str = get_strings(array('delete', 'move', 'moveright', 'moveleft',
1807 'update', 'duplicate', 'hide', 'show', 'edittitle'), 'moodle');
1808 $str->assign = get_string('assignroles', 'role');
6dc5908e
ARN
1809 $str->groupsnone = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsnone"));
1810 $str->groupsseparate = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsseparate"));
1811 $str->groupsvisible = get_string('clicktochangeinbrackets', 'moodle', get_string("groupsvisible"));
1812 $str->forcedgroupsnone = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsnone"));
1813 $str->forcedgroupsseparate = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsseparate"));
1814 $str->forcedgroupsvisible = get_string('forcedmodeinbrackets', 'moodle', get_string("groupsvisible"));
1acfbce5 1815 }
94361e02 1816
af189935 1817 $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
24e1eae4 1818
f558b291
MG
1819 if ($sr !== null) {
1820 $baseurl->param('sr', $sr);
7749e187
SH
1821 }
1822 $actions = array();
1823
cf69a00a 1824 // AJAX edit title.
9ecb50e6 1825 if ($mod->has_view() && $hasmanageactivities &&
f558b291
MG
1826 (($mod->course == $COURSE->id && course_ajax_enabled($COURSE)) ||
1827 ($mod->course == SITEID && course_ajax_enabled($SITE)))) {
1828 // we will not display link if we are on some other-course page (where we should not see this module anyway)
3665af78 1829 $actions['title'] = new action_menu_link_secondary(
7a9a07d2 1830 new moodle_url($baseurl, array('update' => $mod->id)),
cf69a00a 1831 new pix_icon('t/editstring', $str->edittitle, 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
e282c679 1832 $str->edittitle,
cf69a00a 1833 array('class' => 'editing_title', 'data-action' => 'edittitle')
7a9a07d2
ARN
1834 );
1835 }
1836
cf69a00a 1837 // Indent.
af189935 1838 if ($hasmanageactivities) {
7749e187
SH
1839 if (right_to_left()) { // Exchange arrows on RTL
1840 $rightarrow = 't/left';
1841 $leftarrow = 't/right';
1842 } else {
1843 $rightarrow = 't/right';
1844 $leftarrow = 't/left';
1845 }
1846
e282c679 1847 $hiddenclass = 'hidden';
7749e187 1848 if ($indent > 0) {
e282c679 1849 $hiddenclass = '';
7749e187 1850 }
3665af78 1851 $actions['moveleft'] = new action_menu_link_secondary(
e282c679 1852 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '-1')),
cf69a00a 1853 new pix_icon($leftarrow, $str->moveleft, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1854 $str->moveleft,
cf69a00a 1855 array('class' => 'editing_moveleft ' . $hiddenclass, 'data-action' => 'moveleft')
e282c679
SH
1856 );
1857 $hiddenclass = 'hidden';
7749e187 1858 if ($indent >= 0) {
e282c679 1859 $hiddenclass = '';
7749e187 1860 }
3665af78 1861 $actions['moveright'] = new action_menu_link_secondary(
e282c679 1862 new moodle_url($baseurl, array('id' => $mod->id, 'indent' => '1')),
cf69a00a 1863 new pix_icon($rightarrow, $str->moveright, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1864 $str->moveright,
cf69a00a 1865 array('class' => 'editing_moveright ' . $hiddenclass, 'data-action' => 'moveright')
e282c679 1866 );
dc0dc7d5 1867 }
7749e187 1868
cf69a00a 1869 // Move.
af189935 1870 if ($hasmanageactivities) {
3665af78 1871 $actions['move'] = new action_menu_link_primary(
f558b291 1872 new moodle_url($baseurl, array('copy' => $mod->id)),
cf69a00a 1873 new pix_icon('t/move', $str->move, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1874 $str->move,
cf69a00a 1875 array('class' => 'editing_move status', 'data-action' => 'move')
f558b291 1876 );
7749e187
SH
1877 }
1878
cf69a00a 1879 // Update.
af189935 1880 if ($hasmanageactivities) {
3665af78 1881 $actions['update'] = new action_menu_link_secondary(
af189935 1882 new moodle_url($baseurl, array('update' => $mod->id)),
cf69a00a 1883 new pix_icon('t/edit', $str->update, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1884 $str->update,
cf69a00a 1885 array('class' => 'editing_update', 'data-action' => 'update')
af189935
PS
1886 );
1887 }
7749e187 1888
8a1a951f 1889 // Duplicate (require both target import caps to be able to duplicate and backup2 support, see modduplicate.php)
e5de4933 1890 // Note that restoring on front page is never allowed.
f558b291
MG
1891 if ($mod->course != SITEID && has_all_capabilities($dupecaps, $coursecontext) &&
1892 plugin_supports('mod', $mod->modname, FEATURE_BACKUP_MOODLE2)) {
3665af78 1893 $actions['duplicate'] = new action_menu_link_secondary(
8645a28f 1894 new moodle_url($baseurl, array('duplicate' => $mod->id)),
cf69a00a 1895 new pix_icon('t/copy', $str->duplicate, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1896 $str->duplicate,
cf69a00a 1897 array('class' => 'editing_duplicate', 'data-action' => 'duplicate')
8645a28f
EL
1898 );
1899 }
7749e187 1900
cf69a00a 1901 // Delete.
af189935 1902 if ($hasmanageactivities) {
3665af78 1903 $actions['delete'] = new action_menu_link_secondary(
af189935 1904 new moodle_url($baseurl, array('delete' => $mod->id)),
cf69a00a 1905 new pix_icon('t/delete', $str->delete, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1906 $str->delete,
cf69a00a 1907 array('class' => 'editing_delete', 'data-action' => 'delete')
af189935
PS
1908 );
1909 }
7749e187 1910
cf69a00a 1911 // Hide/Show.
217a8ee9 1912 if (has_capability('moodle/course:activityvisibility', $modcontext)) {
1913 if ($mod->visible) {
3665af78 1914 $actions['hide'] = new action_menu_link_primary(
7749e187 1915 new moodle_url($baseurl, array('hide' => $mod->id)),
cf69a00a 1916 new pix_icon('t/hide', $str->hide, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1917 $str->hide,
cf69a00a 1918 array('class' => 'editing_hide', 'data-action' => 'hide')
7749e187 1919 );
217a8ee9 1920 } else {
3665af78 1921 $actions['show'] = new action_menu_link_primary(
7749e187 1922 new moodle_url($baseurl, array('show' => $mod->id)),
cf69a00a 1923 new pix_icon('t/show', $str->show, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1924 $str->show,
cf69a00a 1925 array('class' => 'editing_show', 'data-action' => 'show')
7749e187 1926 );
217a8ee9 1927 }
7977cffd 1928 }
530db4cd 1929
cf69a00a 1930 // Groupmode.
5c016ab3 1931 if ($hasmanageactivities and plugin_supports('mod', $mod->modname, FEATURE_GROUPS, 0)) {
6d04c4f2 1932 if ($mod->effectivegroupmode == SEPARATEGROUPS) {
e5de4933 1933 $nextgroupmode = VISIBLEGROUPS;
32d03b7b 1934 $grouptitle = $str->groupsseparate;
6dc5908e 1935 $forcedgrouptitle = $str->forcedgroupsseparate;
f558b291 1936 $actionname = 'groupsseparate';
7749e187 1937 $groupimage = 't/groups';
6d04c4f2 1938 } else if ($mod->effectivegroupmode == VISIBLEGROUPS) {
e5de4933 1939 $nextgroupmode = NOGROUPS;
32d03b7b 1940 $grouptitle = $str->groupsvisible;
6dc5908e 1941 $forcedgrouptitle = $str->forcedgroupsvisible;
f558b291 1942 $actionname = 'groupsvisible';
7749e187 1943 $groupimage = 't/groupv';
32d03b7b 1944 } else {
e5de4933 1945 $nextgroupmode = SEPARATEGROUPS;
32d03b7b 1946 $grouptitle = $str->groupsnone;
6dc5908e 1947 $forcedgrouptitle = $str->forcedgroupsnone;
f558b291 1948 $actionname = 'groupsnone';
7749e187 1949 $groupimage = 't/groupn';
32d03b7b 1950 }
5c016ab3 1951 if (!$mod->coursegroupmodeforce) {
3665af78 1952 $actions[$actionname] = new action_menu_link_primary(
e5de4933 1953 new moodle_url($baseurl, array('id' => $mod->id, 'groupmode' => $nextgroupmode)),
cf69a00a 1954 new pix_icon($groupimage, $grouptitle, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1955 $grouptitle,
e5de4933 1956 array('class' => 'editing_'. $actionname, 'data-action' => $actionname, 'data-nextgroupmode' => $nextgroupmode)
7749e187 1957 );
3d575e6f 1958 } else {
25c605a5 1959 $actions[$actionname] = new pix_icon($groupimage, $forcedgrouptitle, 'moodle', array('class' => 'iconsmall'));
3d575e6f 1960 }
7977cffd 1961 }
1962
cf69a00a 1963 // Assign.
af189935 1964 if (has_capability('moodle/role:assign', $modcontext)){
3665af78 1965 $actions['assign'] = new action_menu_link_secondary(
f558b291 1966 new moodle_url('/admin/roles/assign.php', array('contextid' => $modcontext->id)),
cf69a00a 1967 new pix_icon('t/assignroles', $str->assign, 'moodle', array('class' => 'iconsmall', 'title' => '')),
e282c679 1968 $str->assign,
cf69a00a 1969 array('class' => 'editing_assign', 'data-action' => 'assignroles')
7749e187
SH
1970 );
1971 }
1972
f558b291 1973 return $actions;
90845098 1974}
1975
b61efafb 1976/**
264867fd 1977 * given a course object with shortname & fullname, this function will
b61efafb 1978 * truncate the the number of chars allowed and add ... if it was too long
1979 */
1980function course_format_name ($course,$max=100) {
264867fd 1981
9a5e297b 1982 $context = context_course::instance($course->id);
8ebbb06a 1983 $shortname = format_string($course->shortname, true, array('context' => $context));
9a5e297b 1984 $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
d1e36240 1985 $str = $shortname.': '. $fullname;
2f1e464a 1986 if (core_text::strlen($str) <= $max) {
b61efafb 1987 return $str;
1988 }
1989 else {
2f1e464a 1990 return core_text::substr($str,0,$max-3).'...';
b61efafb 1991 }
1992}
1993
0705ff84 1994/**
9665ecd2
TH
1995 * Is the user allowed to add this type of module to this course?
1996 * @param object $course the course settings. Only $course->id is used.
1997 * @param string $modname the module name. E.g. 'forum' or 'quiz'.
1998 * @return bool whether the current user is allowed to add this type of module to this course.
0705ff84 1999 */
9665ecd2 2000function course_allowed_module($course, $modname) {
9665ecd2
TH
2001 if (is_numeric($modname)) {
2002 throw new coding_exception('Function course_allowed_module no longer
2003 supports numeric module ids. Please update your code to pass the module name.');
0705ff84 2004 }
264867fd 2005
9665ecd2
TH
2006 $capability = 'mod/' . $modname . ':addinstance';
2007 if (!get_capability_info($capability)) {
2008 // Debug warning that the capability does not exist, but no more than once per page.
2009 static $warned = array();
2010 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2011 if (!isset($warned[$modname]) && $archetype !== MOD_ARCHETYPE_SYSTEM) {
2012 debugging('The module ' . $modname . ' does not define the standard capability ' .
2013 $capability , DEBUG_DEVELOPER);
2014 $warned[$modname] = 1;
2015 }
ddb0a19f 2016
9665ecd2
TH
2017 // If the capability does not exist, the module can always be added.
2018 return true;
0705ff84 2019 }
238c0dd9 2020
9665ecd2
TH
2021 $coursecontext = context_course::instance($course->id);
2022 return has_capability($capability, $coursecontext);
0705ff84 2023}
2024
cb6fec1f 2025/**
2026 * Efficiently moves many courses around while maintaining
2027 * sortorder in order.
2028 *
e92c39ca
PS
2029 * @param array $courseids is an array of course ids
2030 * @param int $categoryid
df997f84 2031 * @return bool success
cb6fec1f 2032 */
2033function move_courses($courseids, $categoryid) {
ed54cb41 2034 global $DB;
861efb19 2035
df997f84 2036 if (empty($courseids)) {
ed54cb41 2037 // Nothing to do.
df997f84
PS
2038 return;
2039 }
264867fd 2040
ed54cb41 2041 if (!$category = $DB->get_record('course_categories', array('id' => $categoryid))) {
df997f84
PS
2042 return false;
2043 }
19f601d1 2044
df997f84 2045 $courseids = array_reverse($courseids);
9a5e297b 2046 $newparent = context_coursecat::instance($category->id);
df997f84 2047 $i = 1;
0cbe8111 2048
aec8fe2f 2049 list($where, $params) = $DB->get_in_or_equal($courseids);
30fe1181
MG
2050 $dbcourses = $DB->get_records_select('course', 'id ' . $where, $params);
2051 foreach ($dbcourses as $dbcourse) {
2052 $course = new stdClass();
2053 $course->id = $dbcourse->id;
2054 $course->category = $category->id;
2055 $course->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - $i++;
2056 if ($category->visible == 0) {
2057 // Hide the course when moving into hidden category, do not update the visibleold flag - we want to get
2058 // to previous state if somebody unhides the category.
2059 $course->visible = 0;
2060 }
ed54cb41 2061
30fe1181 2062 $DB->update_record('course', $course);
ed54cb41 2063
30fe1181
MG
2064 // Store the context.
2065 $context = context_course::instance($course->id);
ed54cb41 2066
30fe1181
MG
2067 // Update the course object we are passing to the event.
2068 $dbcourse->category = $course->category;
2069 $dbcourse->sortorder = $course->sortorder;
2070 if (isset($course->visible)) {
2071 $dbcourse->visible = $course->visible;
264867fd 2072 }
30fe1181
MG
2073
2074 // Trigger a course updated event.
2075 $event = \core\event\course_updated::create(array(
2076 'objectid' => $course->id,
2077 'context' => $context,
2078 'other' => array('shortname' => $dbcourse->shortname,
2079 'fullname' => $dbcourse->fullname)
2080 ));
2081 $event->add_record_snapshot('course', $dbcourse);
2082 $event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
2083 $event->trigger();
2084
2085 $context->update_moved($newparent);
0cbe8111 2086 }
df997f84 2087 fix_course_sortorder();
eabbfa82 2088 cache_helper::purge_by_event('changesincourse');
df997f84 2089
861efb19 2090 return true;
2091}
2092
ae628043 2093/**
ee7084e9 2094 * Returns the display name of the given section that the course prefers
7487c856 2095 *
ee7084e9
MG
2096 * Implementation of this function is provided by course format
2097 * @see format_base::get_section_name()
7487c856 2098 *
ee7084e9
MG
2099 * @param int|stdClass $courseorid The course to get the section name for (object or just course id)
2100 * @param int|stdClass $section Section object from database or just field course_sections.section
2101 * @return string Display name that the course format prefers, e.g. "Week 2"
ae628043 2102 */
ee7084e9
MG
2103function get_section_name($courseorid, $section) {
2104 return course_get_format($courseorid)->get_section_name($section);
7487c856
SH
2105}
2106
2107/**
ee7084e9 2108 * Tells if current course format uses sections
1b048629 2109 *
7487c856 2110 * @param string $format Course format ID e.g. 'weeks' $course->format
ee7084e9 2111 * @return bool
7487c856 2112 */
7487c856 2113function course_format_uses_sections($format) {
ee7084e9
MG
2114 $course = new stdClass();
2115 $course->format = $format;
2116 return course_get_format($course)->uses_sections();
ae628043 2117}
2118
c0b5d925
DM
2119/**
2120 * Returns the information about the ajax support in the given source format
2121 *
2122 * The returned object's property (boolean)capable indicates that
2123 * the course format supports Moodle course ajax features.
2124 * The property (array)testedbrowsers can be used as a parameter for {@see ajaxenabled()}.
2125 *
2126 * @param string $format
2127 * @return stdClass
2128 */
2129function course_format_ajax_support($format) {
ee7084e9
MG
2130 $course = new stdClass();
2131 $course->format = $format;
2132 return course_get_format($course)->supports_ajax();
c0b5d925
DM
2133}
2134
2585a68d 2135/**
2136 * Can the current user delete this course?
8b449a39 2137 * Course creators have exception,
2138 * 1 day after the creation they can sill delete the course.
2585a68d 2139 * @param int $courseid
2140 * @return boolean
2585a68d 2141 */
2142function can_delete_course($courseid) {
8b449a39 2143 global $USER, $DB;
2585a68d 2144
9a5e297b 2145 $context = context_course::instance($courseid);
2585a68d 2146
8b449a39 2147 if (has_capability('moodle/course:delete', $context)) {
2148 return true;
2149 }
2150
2151 // hack: now try to find out if creator created this course recently (1 day)
2152 if (!has_capability('moodle/course:create', $context)) {
2153 return false;
2154 }
2155
2156 $since = time() - 60*60*24;
2157
2158 $params = array('userid'=>$USER->id, 'url'=>"view.php?id=$courseid", 'since'=>$since);
2159 $select = "module = 'course' AND action = 'new' AND userid = :userid AND url = :url AND time > :since";
2160
2161 return $DB->record_exists_select('log', $select, $params);
2585a68d 2162}
2163
bef12c99 2164/**
2165 * Save the Your name for 'Some role' strings.
2166 *
2167 * @param integer $courseid the id of this course.
2168 * @param array $data the data that came from the course settings form.
2169 */
2170function save_local_role_names($courseid, $data) {
2171 global $DB;
9a5e297b 2172 $context = context_course::instance($courseid);
bef12c99 2173
2174 foreach ($data as $fieldname => $value) {
df997f84 2175 if (strpos($fieldname, 'role_') !== 0) {
bef12c99 2176 continue;
2177 }
2178 list($ignored, $roleid) = explode('_', $fieldname);
2179
2180 // make up our mind whether we want to delete, update or insert
2181 if (!$value) {
2182 $DB->delete_records('role_names', array('contextid' => $context->id, 'roleid' => $roleid));
2183
2184 } else if ($rolename = $DB->get_record('role_names', array('contextid' => $context->id, 'roleid' => $roleid))) {
2185 $rolename->name = $value;
2186 $DB->update_record('role_names', $rolename);
2187
2188 } else {
2189 $rolename = new stdClass;
2190 $rolename->contextid = $context->id;
2191 $rolename->roleid = $roleid;
2192 $rolename->name = $value;
2193 $DB->insert_record('role_names', $rolename);
2194 }
2195 }
2196}
2585a68d 2197
d1f8c1bd
MG
2198/**
2199 * Returns options to use in course overviewfiles filemanager
2200 *
2201 * @param null|stdClass|course_in_list|int $course either object that has 'id' property or just the course id;
2202 * may be empty if course does not exist yet (course create form)
2203 * @return array|null array of options such as maxfiles, maxbytes, accepted_types, etc.
2204 * or null if overviewfiles are disabled
2205 */
2206function course_overviewfiles_options($course) {
2207 global $CFG;
2208 if (empty($CFG->courseoverviewfileslimit)) {
2209 return null;
2210 }
2211 $accepted_types = preg_split('/\s*,\s*/', trim($CFG->courseoverviewfilesext), -1, PREG_SPLIT_NO_EMPTY);
2212 if (in_array('*', $accepted_types) || empty($accepted_types)) {
2213 $accepted_types = '*';
2214 } else {
2215 // Since config for $CFG->courseoverviewfilesext is a text box, human factor must be considered.
2216 // Make sure extensions are prefixed with dot unless they are valid typegroups
2217 foreach ($accepted_types as $i => $type) {
2218 if (substr($type, 0, 1) !== '.') {
2219 require_once($CFG->libdir. '/filelib.php');
2220 if (!count(file_get_typegroup('extension', $type))) {
2221 // It does not start with dot and is not a valid typegroup, this is most likely extension.
2222 $accepted_types[$i] = '.'. $type;
2223 $corrected = true;
2224 }
2225 }
2226 }
2227 if (!empty($corrected)) {
2228 set_config('courseoverviewfilesext', join(',', $accepted_types));
2229 }
2230 }
2231 $options = array(
2232 'maxfiles' => $CFG->courseoverviewfileslimit,
2233 'maxbytes' => $CFG->maxbytes,
2234 'subdirs' => 0,
2235 'accepted_types' => $accepted_types
2236 );
2237 if (!empty($course->id)) {
2238 $options['context'] = context_course::instance($course->id);
2239 } else if (is_int($course) && $course > 0) {
2240 $options['context'] = context_course::instance($course);
2241 }
2242 return $options;
2243}
2244
c3df0901 2245/**
df997f84
PS
2246 * Create a course and either return a $course object
2247 *
2248 * Please note this functions does not verify any access control,
2249 * the calling code is responsible for all validation (usually it is the form definition).
bfefa87e 2250 *
df997f84 2251 * @param array $editoroptions course description editor options
bfefa87e 2252 * @param object $data - all the data needed for an entry in the 'course' table
df997f84 2253 * @return object new course instance
bfefa87e 2254 */
df997f84 2255function create_course($data, $editoroptions = NULL) {
3c2fab94 2256 global $DB;
bfefa87e 2257
df997f84
PS
2258 //check the categoryid - must be given for all new courses
2259 $category = $DB->get_record('course_categories', array('id'=>$data->category), '*', MUST_EXIST);
71b77297 2260
9930e426 2261 // Check if the shortname already exists.
df997f84
PS
2262 if (!empty($data->shortname)) {
2263 if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
9930e426 2264 throw new moodle_exception('shortnametaken', '', '', $data->shortname);
71b77297 2265 }
2266 }
2267
9930e426 2268 // Check if the idnumber already exists.
df997f84
PS
2269 if (!empty($data->idnumber)) {
2270 if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
9930e426 2271 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
71b77297 2272 }
2273 }
2f48819b 2274
df997f84
PS
2275 $data->timecreated = time();
2276 $data->timemodified = $data->timecreated;
71b77297 2277
df997f84
PS
2278 // place at beginning of any category
2279 $data->sortorder = 0;
00f270bc 2280
df997f84
PS
2281 if ($editoroptions) {
2282 // summary text is updated later, we need context to store the files first
2283 $data->summary = '';
2284 $data->summary_format = FORMAT_HTML;
2285 }
2286
db1218a9
PS
2287 if (!isset($data->visible)) {
2288 // data not from form, add missing visibility info
54a01598 2289 $data->visible = $category->visible;
bfefa87e 2290 }
db1218a9 2291 $data->visibleold = $data->visible;
2585a68d 2292
df997f84 2293 $newcourseid = $DB->insert_record('course', $data);
9a5e297b 2294 $context = context_course::instance($newcourseid, MUST_EXIST);
bfefa87e 2295
df997f84
PS
2296 if ($editoroptions) {
2297 // Save the files used in the summary editor and store
64f93798 2298 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
df997f84
PS
2299 $DB->set_field('course', 'summary', $data->summary, array('id'=>$newcourseid));
2300 $DB->set_field('course', 'summaryformat', $data->summary_format, array('id'=>$newcourseid));
2301 }
d1f8c1bd
MG
2302 if ($overviewfilesoptions = course_overviewfiles_options($newcourseid)) {
2303 // Save the course overviewfiles
2304 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2305 }
bfefa87e 2306
fc79ede5
MG
2307 // update course format options
2308 course_get_format($newcourseid)->update_course_format_options($data);
2309
2310 $course = course_get_format($newcourseid)->get_course();
bfefa87e 2311
df997f84
PS
2312 // Setup the blocks
2313 blocks_add_default_course_blocks($course);
bfefa87e 2314
4ede27b2
MG
2315 // Create a default section.
2316 course_create_sections_if_missing($course, 0);
bfefa87e 2317
df997f84 2318 fix_course_sortorder();
eabbfa82
MG
2319 // purge appropriate caches in case fix_course_sortorder() did not change anything
2320 cache_helper::purge_by_event('changesincourse');
bfefa87e 2321
df997f84 2322 // new context created - better mark it as dirty
1de02d62 2323 $context->mark_dirty();
bfefa87e 2324
df997f84 2325 // Save any custom role names.
e92c39ca 2326 save_local_role_names($course->id, (array)$data);
bfefa87e 2327
df997f84
PS
2328 // set up enrolments
2329 enrol_course_updated(true, $course, $data);
bef12c99 2330
3c2fab94
MN
2331 // Trigger a course created event.
2332 $event = \core\event\course_created::create(array(
2333 'objectid' => $course->id,
2334 'context' => context_course::instance($course->id),
2335 'other' => array('shortname' => $course->shortname,
2336 'fullname' => $course->fullname)
2337 ));
2338 $event->add_record_snapshot('course', $course);
2339 $event->trigger();
bfefa87e 2340
df997f84 2341 return $course;
bfefa87e 2342}
2343
c3df0901 2344/**
df997f84
PS
2345 * Update a course.
2346 *
2347 * Please note this functions does not verify any access control,
2348 * the calling code is responsible for all validation (usually it is the form definition).
bfefa87e 2349 *
2350 * @param object $data - all the data needed for an entry in the 'course' table
df997f84
PS
2351 * @param array $editoroptions course description editor options
2352 * @return void
bfefa87e 2353 */
df997f84 2354function update_course($data, $editoroptions = NULL) {
53a8e678 2355 global $DB;
bfefa87e 2356
df997f84 2357 $data->timemodified = time();
ddb0a19f 2358
fc79ede5 2359 $oldcourse = course_get_format($data->id)->get_course();
9a5e297b 2360 $context = context_course::instance($oldcourse->id);
bfefa87e 2361
df997f84 2362 if ($editoroptions) {
64f93798 2363 $data = file_postupdate_standard_editor($data, 'summary', $editoroptions, $context, 'course', 'summary', 0);
71b77297 2364 }
d1f8c1bd
MG
2365 if ($overviewfilesoptions = course_overviewfiles_options($data->id)) {
2366 $data = file_postupdate_standard_filemanager($data, 'overviewfiles', $overviewfilesoptions, $context, 'course', 'overviewfiles', 0);
2367 }
71b77297 2368
5536a561
FD
2369 // Check we don't have a duplicate shortname.
2370 if (!empty($data->shortname) && $oldcourse->shortname != $data->shortname) {
2371 if ($DB->record_exists('course', array('shortname' => $data->shortname))) {
2372 throw new moodle_exception('shortnametaken', '', '', $data->shortname);
2373 }
2374 }
2375
2376 // Check we don't have a duplicate idnumber.
2377 if (!empty($data->idnumber) && $oldcourse->idnumber != $data->idnumber) {
2378 if ($DB->record_exists('course', array('idnumber' => $data->idnumber))) {
2379 throw new moodle_exception('courseidnumbertaken', '', '', $data->idnumber);
2380 }
2381 }
2382
df997f84
PS
2383 if (!isset($data->category) or empty($data->category)) {
2384 // prevent nulls and 0 in category field
bfefa87e 2385 unset($data->category);
2386 }
b80a50f7 2387 $changesincoursecat = $movecat = (isset($data->category) and $oldcourse->category != $data->category);
bfefa87e 2388
db1218a9
PS
2389 if (!isset($data->visible)) {
2390 // data not from form, add missing visibility info
df997f84
PS
2391 $data->visible = $oldcourse->visible;
2392 }
bfefa87e 2393
df997f84
PS
2394 if ($data->visible != $oldcourse->visible) {
2395 // reset the visibleold flag when manually hiding/unhiding course
2396 $data->visibleold = $data->visible;
b55248d5 2397 $changesincoursecat = true;
df997f84 2398 } else {
a372aab5 2399 if ($movecat) {
df997f84
PS
2400 $newcategory = $DB->get_record('course_categories', array('id'=>$data->category));
2401 if (empty($newcategory->visible)) {
2402 // make sure when moving into hidden category the course is hidden automatically
2403 $data->visible = 0;
2404 }
a372aab5 2405 }
df997f84 2406 }
a372aab5 2407
df997f84 2408 // Update with the new data
487caf6b 2409 $DB->update_record('course', $data);
38b19bbc
MG
2410 // make sure the modinfo cache is reset
2411 rebuild_course_cache($data->id);
bfefa87e 2412
fc79ede5
MG
2413 // update course format options with full course data
2414 course_get_format($data->id)->update_course_format_options($data, $oldcourse);
2415
df997f84 2416 $course = $DB->get_record('course', array('id'=>$data->id));
bfefa87e 2417
df997f84 2418 if ($movecat) {
9a5e297b 2419 $newparent = context_coursecat::instance($course->category);
2c5b0eb7 2420 $context->update_moved($newparent);
df997f84 2421 }
238c0dd9 2422
24f824b9
MG
2423 if ($movecat || (isset($data->sortorder) && $oldcourse->sortorder != $data->sortorder)) {
2424 fix_course_sortorder();
2425 }
2426
eabbfa82
MG
2427 // purge appropriate caches in case fix_course_sortorder() did not change anything
2428 cache_helper::purge_by_event('changesincourse');
b55248d5 2429 if ($changesincoursecat) {
b80a50f7
MG
2430 cache_helper::purge_by_event('changesincoursecat');
2431 }
bfefa87e 2432
df997f84
PS
2433 // Test for and remove blocks which aren't appropriate anymore
2434 blocks_remove_inappropriate($course);
bfefa87e 2435
df997f84
PS
2436 // Save any custom role names.
2437 save_local_role_names($course->id, $data);
2438
2439 // update enrol settings
2440 enrol_course_updated(false, $course, $data);
2441
53a8e678
MN
2442 // Trigger a course updated event.
2443 $event = \core\event\course_updated::create(array(
2444 'objectid' => $course->id,
2445 'context' => $context,
2446 'other' => array('shortname' => $course->shortname,
2447 'fullname' => $course->fullname)
2448 ));
2449 $event->add_record_snapshot('course', $course);
2bf2f359 2450 $event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
53a8e678 2451 $event->trigger();
fc79ede5
MG
2452
2453 if ($oldcourse->format !== $course->format) {
2454 // Remove all options stored for the previous format
2455 // We assume that new course format migrated everything it needed watching trigger
2456 // 'course_updated' and in method format_XXX::update_course_format_options()
2457 $DB->delete_records('course_format_options',
2458 array('courseid' => $course->id, 'format' => $oldcourse->format));
2459 }
bfefa87e 2460}
2585a68d 2461
07ab0c80 2462/**
fcb4decd 2463 * Average number of participants
07ab0c80 2464 * @return integer
2465 */
2466function average_number_of_participants() {
fcb4decd 2467 global $DB, $SITE;
2468
2469 //count total of enrolments for visible course (except front page)
2470 $sql = 'SELECT COUNT(*) FROM (
2471 SELECT DISTINCT ue.userid, e.courseid
2472 FROM {user_enrolments} ue, {enrol} e, {course} c
516c5eca 2473 WHERE ue.enrolid = e.id
fcb4decd 2474 AND e.courseid <> :siteid
2475 AND c.id = e.courseid
9f247093 2476 AND c.visible = 1) total';
fcb4decd 2477 $params = array('siteid' => $SITE->id);
2478 $enrolmenttotal = $DB->count_records_sql($sql, $params);
2479
2480
2481 //count total of visible courses (minus front page)
2482 $coursetotal = $DB->count_records('course', array('visible' => 1));
2483 $coursetotal = $coursetotal - 1 ;
2484
2485 //average of enrolment
2486 if (empty($coursetotal)) {
2487 $participantaverage = 0;
2488 } else {
2489 $participantaverage = $enrolmenttotal / $coursetotal;
2490 }
2491
2492 return $participantaverage;
07ab0c80 2493}
2494
2495/**
fcb4decd 2496 * Average number of course modules
07ab0c80 2497 * @return integer
2498 */
2499function average_number_of_courses_modules() {
fcb4decd 2500 global $DB, $SITE;
2501
2502 //count total of visible course module (except front page)
2503 $sql = 'SELECT COUNT(*) FROM (
2504 SELECT cm.course, cm.module
2505 FROM {course} c, {course_modules} cm
516c5eca 2506 WHERE c.id = cm.course
fcb4decd 2507 AND c.id <> :siteid
2508 AND cm.visible = 1
9f247093 2509 AND c.visible = 1) total';
fcb4decd 2510 $params = array('siteid' => $SITE->id);
2511 $moduletotal = $DB->count_records_sql($sql, $params);
2512
2513
2514 //count total of visible courses (minus front page)
2515 $coursetotal = $DB->count_records('course', array('visible' => 1));
2516 $coursetotal = $coursetotal - 1 ;
2517
2518 //average of course module
2519 if (empty($coursetotal)) {
2520 $coursemoduleaverage = 0;
2521 } else {
2522 $coursemoduleaverage = $moduletotal / $coursetotal;
2523 }
2524
2525 return $coursemoduleaverage;
07ab0c80 2526}
2527
8bdc9cac
SH
2528/**
2529 * This class pertains to course requests and contains methods associated with
2530 * create, approving, and removing course requests.
2531 *
64f93798
PS
2532 * Please note we do not allow embedded images here because there is no context
2533 * to store them with proper access control.
2534 *
8bdc9cac
SH
2535 * @copyright 2009 Sam Hemelryk
2536 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2537 * @since Moodle 2.0
2538 *
2539 * @property-read int $id
2540 * @property-read string $fullname
2541 * @property-read string $shortname
2542 * @property-read string $summary
2543 * @property-read int $summaryformat
2544 * @property-read int $summarytrust
2545 * @property-read string $reason
2546 * @property-read int $requester
8bdc9cac
SH
2547 */
2548class course_request {
2549
2550 /**
2551 * This is the stdClass that stores the properties for the course request
7e85563d 2552 * and is externally accessed through the __get magic method
8bdc9cac
SH
2553 * @var stdClass
2554 */
2555 protected $properties;
2556
2557 /**
2558 * An array of options for the summary editor used by course request forms.
2559 * This is initially set by {@link summary_editor_options()}
2560 * @var array
2561 * @static
2562 */
2563 protected static $summaryeditoroptions;
2564
8bdc9cac
SH
2565 /**
2566 * Static function to prepare the summary editor for working with a course
2567 * request.
2568 *
2569 * @static
2570 * @param null|stdClass $data Optional, an object containing the default values
2571 * for the form, these may be modified when preparing the
2572 * editor so this should be called before creating the form
2573 * @return stdClass An object that can be used to set the default values for
2574 * an mforms form
2575 */
2576 public static function prepare($data=null) {
2577 if ($data === null) {
2578 $data = new stdClass;
2579 }
64f93798 2580 $data = file_prepare_standard_editor($data, 'summary', self::summary_editor_options());
8bdc9cac
SH
2581 return $data;
2582 }
2583
2584 /**
2585 * Static function to create a new course request when passed an array of properties
2586 * for it.
2587 *
2588 * This function also handles saving any files that may have been used in the editor
2589 *
2590 * @static
2591 * @param stdClass $data
2592 * @return course_request The newly created course request
2593 */
2594 public static function create($data) {
2595 global $USER, $DB, $CFG;
2596 $data->requester = $USER->id;
64f93798 2597
d347f304 2598 // Setting the default category if none set.
59b9a140
FM
2599 if (empty($data->category) || empty($CFG->requestcategoryselection)) {
2600 $data->category = $CFG->defaultrequestcategory;
2601 }
2602
64f93798
PS
2603 // Summary is a required field so copy the text over
2604 $data->summary = $data->summary_editor['text'];
2605 $data->summaryformat = $data->summary_editor['format'];
2606
8bdc9cac 2607 $data->id = $DB->insert_record('course_request', $data);
64f93798 2608
8bdc9cac
SH
2609 // Create a new course_request object and return it
2610 $request = new course_request($data);
2611
2612 // Notify the admin if required.
adf176d7 2613 if ($users = get_users_from_config($CFG->courserequestnotify, 'moodle/site:approvecourse')) {
aa6c1ced 2614
8bdc9cac
SH
2615 $a = new stdClass;
2616 $a->link = "$CFG->wwwroot/course/pending.php";
2617 $a->user = fullname($USER);
2618 $subject = get_string('courserequest');
2619 $message = get_string('courserequestnotifyemail', 'admin', $a);
2620 foreach ($users as $user) {
2a63b636 2621 $request->notify($user, $USER, 'courserequested', $subject, $message);
8bdc9cac
SH
2622 }
2623 }
2624
2625 return $request;
2626 }
2627
2628 /**
2629 * Returns an array of options to use with a summary editor
2630 *
2631 * @uses course_request::$summaryeditoroptions
2632 * @return array An array of options to use with the editor
2633 */
2634 public static function summary_editor_options() {
2635 global $CFG;
2636 if (self::$summaryeditoroptions === null) {
64f93798 2637 self::$summaryeditoroptions = array('maxfiles' => 0, 'maxbytes'=>0);
8bdc9cac
SH
2638 }
2639 return self::$summaryeditoroptions;
2640 }
2641
8bdc9cac
SH
2642 /**
2643 * Loads the properties for this course request object. Id is required and if
2644 * only id is provided then we load the rest of the properties from the database
2645 *
2646 * @param stdClass|int $properties Either an object containing properties
2647 * or the course_request id to load
2648 */
2649 public function __construct($properties) {
2650 global $DB;
2651 if (empty($properties->id)) {
2652 if (empty($properties)) {
2653 throw new coding_exception('You must provide a course request id when creating a course_request object');
2654 }
2655 $id = $properties;
2656 $properties = new stdClass;
2657 $properties->id = (int)$id;
2658 unset($id);
2659 }
2660 if (empty($properties->requester)) {
2661 if (!($this->properties = $DB->get_record('course_request', array('id' => $properties->id)))) {
2662 print_error('unknowncourserequest');
2663 }
2664 } else {
2665 $this->properties = $properties;
2666 }
2667 $this->properties->collision = null;
2668 }
2669
2670 /**
2671 * Returns the requested property
2672 *
2673 * @param string $key
2674 * @return mixed
2675 */
2676 public function __get($key) {
8bdc9cac
SH
2677 return $this->properties->$key;
2678 }
2679
2680 /**
2681 * Override this to ensure empty($request->blah) calls return a reliable answer...
2682 *
2683 * This is required because we define the __get method
2684 *
2685 * @param mixed $key
2686 * @return bool True is it not empty, false otherwise
2687 */
2688 public function __isset($key) {
2689 return (!empty($this->properties->$key));
2690 }
2691
2692 /**
2693 * Returns the user who requested this course
2694 *
2695 * Uses a static var to cache the results and cut down the number of db queries
2696 *
2697 * @staticvar array $requesters An array of cached users
2698 * @return stdClass The user who requested the course
2699 */
2700 public function get_requester() {
2701 global $DB;
2702 static $requesters= array();
2703 if (!array_key_exists($this->properties->requester, $requesters)) {
2704 $requesters[$this->properties->requester] = $DB->get_record('user', array('id'=>$this->properties->requester));
2705 }
2706 return $requesters[$this->properties->requester];
2707 }
2708
2709 /**
2710 * Checks that the shortname used by the course does not conflict with any other
2711 * courses that exist
2712 *
2713 * @param string|null $shortnamemark The string to append to the requests shortname
2714 * should a conflict be found
2715 * @return bool true is there is a conflict, false otherwise
2716 */
2717 public function check_shortname_collision($shortnamemark = '[*]') {
2718 global $DB;
2719
2720 if ($this->properties->collision !== null) {
2721 return $this->properties->collision;
2722 }
2723
2724 if (empty($this->properties->shortname)) {
2725 debugging('Attempting to check a course request shortname before it has been set', DEBUG_DEVELOPER);
2726 $this->properties->collision = false;
2727 } else if ($DB->record_exists('course', array('shortname' => $this->properties->shortname))) {
2728 if (!empty($shortnamemark)) {
2729 $this->properties->shortname .= ' '.$shortnamemark;
2730 }
2731 $this->properties->collision = true;
2732 } else {
2733 $this->properties->collision = false;
2734 }
2735 return $this->properties->collision;
2736 }
2737
2d8a275b
MG
2738 /**
2739 * Returns the category where this course request should be created
2740 *
2741 * Note that we don't check here that user has a capability to view
2742 * hidden categories if he has capabilities 'moodle/site:approvecourse' and
2743 * 'moodle/course:changecategory'
2744 *
2745 * @return coursecat
2746 */
2747 public function get_category() {
2748 global $CFG;
2749 require_once($CFG->libdir.'/coursecatlib.php');
2750 // If the category is not set, if the current user does not have the rights to change the category, or if the
2751 // category does not exist, we set the default category to the course to be approved.
2752 // The system level is used because the capability moodle/site:approvecourse is based on a system level.
2753 if (empty($this->properties->category) || !has_capability('moodle/course:changecategory', context_system::instance()) ||
2754 (!$category = coursecat::get($this->properties->category, IGNORE_MISSING, true))) {
2755 $category = coursecat::get($CFG->defaultrequestcategory, IGNORE_MISSING, true);
2756 }
2757 if (!$category) {
2758 $category = coursecat::get_default();
2759 }
2760 return $category;
2761 }
2762
8bdc9cac
SH
2763 /**
2764 * This function approves the request turning it into a course
2765 *
2766 * This function converts the course request into a course, at the same time
7e85563d 2767 * transferring any files used in the summary to the new course and then removing
8bdc9cac
SH
2768 * the course request and the files associated with it.
2769 *
2770 * @return int The id of the course that was created from this request
2771 */
2772 public function approve() {
2773 global $CFG, $DB, $USER;
70740405
PS
2774
2775 $user = $DB->get_record('user', array('id' => $this->properties->requester, 'deleted'=>0), '*', MUST_EXIST);
2776
8bdc9cac
SH
2777 $courseconfig = get_config('moodlecourse');
2778
2779 // Transfer appropriate settings
70740405
PS
2780 $data = clone($this->properties);
2781 unset($data->id);
2782 unset($data->reason);
2783 unset($data->requester);
8bdc9cac
SH
2784
2785 // Set category
2d8a275b 2786 $category = $this->get_category();
70740405 2787 $data->category = $category->id;
8bdc9cac 2788 // Set misc settings
70740405 2789 $data->requested = 1;
8bdc9cac
SH
2790
2791 // Apply course default settings
70740405 2792 $data->format = $courseconfig->format;
70740405
PS
2793 $data->newsitems = $courseconfig->newsitems;
2794 $data->showgrades = $courseconfig->showgrades;
2795 $data->showreports = $courseconfig->showreports;
2796 $data->maxbytes = $courseconfig->maxbytes;
2797 $data->groupmode = $courseconfig->groupmode;
2798 $data->groupmodeforce = $courseconfig->groupmodeforce;
2799 $data->visible = $courseconfig->visible;
2800 $data->visibleold = $data->visible;
2801 $data->lang = $courseconfig->lang;
8bdc9cac 2802
70740405 2803 $course = create_course($data);
1f364c87 2804 $context = context_course::instance($course->id, MUST_EXIST);
8bdc9cac 2805
70740405
PS
2806 // add enrol instances
2807 if (!$DB->record_exists('enrol', array('courseid'=>$course->id, 'enrol'=>'manual'))) {
2808 if ($manual = enrol_get_plugin('manual')) {
2809 $manual->add_default_instance($course);
2810 }
8bdc9cac 2811 }
70740405
PS
2812
2813 // enrol the requester as teacher if necessary
2814 if (!empty($CFG->creatornewroleid) and !is_viewing($context, $user, 'moodle/role:assign') and !is_enrolled($context, $user, 'moodle/role:assign')) {
2815 enrol_try_internal_enrol($course->id, $user->id, $CFG->creatornewroleid);
2816 }
2817
2818 $this->delete();
2819
fbaea88f 2820 $a = new stdClass();
9a5e297b 2821 $a->name = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
70740405
PS
2822 $a->url = $CFG->wwwroot.'/course/view.php?id=' . $course->id;
2823 $this->notify($user, $USER, 'courserequestapproved', get_string('courseapprovedsubject'), get_string('courseapprovedemail2', 'moodle', $a));
2824
2825 return $course->id;
8bdc9cac
SH
2826 }
2827
2828 /**
2829 * Reject a course request
2830 *
2831 * This function rejects a course request, emailing the requesting user the
2832 * provided notice and then removing the request from the database
2833 *
2834 * @param string $notice The message to display to the user
2835 */
2836 public function reject($notice) {
70740405
PS
2837 global $USER, $DB;
2838 $user = $DB->get_record('user', array('id' => $this->properties->requester), '*', MUST_EXIST);
8bdc9cac
SH
2839 $this->notify($user, $USER, 'courserequestrejected', get_string('courserejectsubject'), get_string('courserejectemail', 'moodle', $notice));
2840 $this->delete();
2841 }
2842
2843 /**
2844 * Deletes the course request and any associated files
2845 */
2846 public function delete() {
2847 global $DB;
2848 $DB->delete_records('course_request', array('id' => $this->properties->id));
8bdc9cac
SH
2849 }
2850
2851 /**
2852 * Send a message from one user to another using events_trigger
2853 *
2854 * @param object $touser
2855 * @param object $fromuser
2856 * @param string $name
2857 * @param string $subject
2858 * @param string $message
2859 */
2860 protected function notify($touser, $fromuser, $name='courserequested', $subject, $message) {
fbaea88f 2861 $eventdata = new stdClass();
a1708181 2862 $eventdata->component = 'moodle';
8bdc9cac
SH
2863 $eventdata->name = $name;
2864 $eventdata->userfrom = $fromuser;
2865 $eventdata->userto = $touser;
2866 $eventdata->subject = $subject;
2867 $eventdata->fullmessage = $message;
2868 $eventdata->fullmessageformat = FORMAT_PLAIN;
2869 $eventdata->fullmessagehtml = '';
2870 $eventdata->smallmessage = '';
a1708181 2871 $eventdata->notification = 1;
7c7d3afa 2872 message_send($eventdata);
8bdc9cac 2873 }
5c34c4ba 2874}
b1627a92
DC
2875
2876/**
2877 * Return a list of page types
2878 * @param string $pagetype current page type
9dd85edf
MG
2879 * @param context $parentcontext Block's parent context
2880 * @param context $currentcontext Current context of block
2881 * @return array array of page types
b1627a92 2882 */
b38e2e28 2883function course_page_type_list($pagetype, $parentcontext, $currentcontext) {
9dd85edf
MG
2884 if ($pagetype === 'course-index' || $pagetype === 'course-index-category') {
2885 // For courses and categories browsing pages (/course/index.php) add option to show on ANY category page
2886 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2887 'course-index-*' => get_string('page-course-index-x', 'pagetype'),
2888 );
2889 } else if ($currentcontext && (!($coursecontext = $currentcontext->get_course_context(false)) || $coursecontext->instanceid == SITEID)) {
2890 // We know for sure that despite pagetype starts with 'course-' this is not a page in course context (i.e. /course/search.php, etc.)
2891 $pagetypes = array('*' => get_string('page-x', 'pagetype'));
2892 } else {
2893 // Otherwise consider it a page inside a course even if $currentcontext is null
2894 $pagetypes = array('*' => get_string('page-x', 'pagetype'),
2895 'course-*' => get_string('page-course-x', 'pagetype'),
2896 'course-view-*' => get_string('page-course-view-x', 'pagetype')
2897 );
b1627a92 2898 }
9dd85edf 2899 return $pagetypes;
af27c69e 2900}
ebaa29d1 2901
5720019d
ARN
2902/**
2903 * Determine whether course ajax should be enabled for the specified course
2904 *
924c34df 2905 * @param stdClass $course The course to test against
5720019d
ARN
2906 * @return boolean Whether course ajax is enabled or note
2907 */
2908function course_ajax_enabled($course) {
2909 global $CFG, $PAGE, $SITE;
2910
2911 // Ajax must be enabled globally
2912 if (!$CFG->enableajax) {
2913 return false;
2914 }
2915
2916 // The user must be editing for AJAX to be included
2917 if (!$PAGE->user_is_editing()) {
2918 return false;
2919 }
2920
2921 // Check that the theme suports
2922 if (!$PAGE->theme->enablecourseajax) {
2923 return false;
2924 }
2925
2926 // Check that the course format supports ajax functionality
2927 // The site 'format' doesn't have information on course format support
2928 if ($SITE->id !== $course->id) {
2929 $courseformatajaxsupport = course_format_ajax_support($course->format);
2930 if (!$courseformatajaxsupport->capable) {
2931 return false;
2932 }
2933 }
2934
2935 // All conditions have been met so course ajax should be enabled
2936 return true;
2937}
2938
ebaa29d1
ARN
2939/**
2940 * Include the relevant javascript and language strings for the resource
2941 * toolbox YUI module
2942 *
2943 * @param integer $id The ID of the course being applied to
7b061512
SH
2944 * @param array $usedmodules An array containing the names of the modules in use on the page
2945 * @param array $enabledmodules An array containing the names of the enabled (visible) modules on this site
924c34df 2946 * @param stdClass $config An object containing configuration parameters for ajax modules including:
ebaa29d1
ARN
2947 * * resourceurl The URL to post changes to for resource changes
2948 * * sectionurl The URL to post changes to for section changes
2949 * * pageparams Additional parameters to pass through in the post
7b061512 2950 * @return bool
ebaa29d1 2951 */
7b061512 2952function include_course_ajax($course, $usedmodules = array(), $enabledmodules = null, $config = null) {
52973369 2953 global $CFG, $PAGE, $SITE;
ebaa29d1
ARN
2954
2955 // Ensure that ajax should be included
5720019d
ARN
2956 if (!course_ajax_enabled($course)) {
2957 return false;
ebaa29d1
ARN
2958 }
2959
2960 if (!$config) {
2961 $config = new stdClass();
2962 }
2963
2964 // The URL to use for resource changes
2965 if (!isset($config->resourceurl)) {
2966 $config->resourceurl = '/course/rest.php';
2967 }
2968
2969 // The URL to use for section changes
2970 if (!isset($config->sectionurl)) {
2971 $config->sectionurl = '/course/rest.php';
2972 }
2973
2974 // Any additional parameters which need to be included on page submission
2975 if (!isset($config->pageparams)) {
2976 $config->pageparams = array();
2977 }
2978
2979 // Include toolboxes
2980 $PAGE->requires->yui_module('moodle-course-toolboxes',
2981 'M.course.init_resource_toolbox',
2982 array(array(
2983 'courseid' => $course->id,
2984 'ajaxurl' => $config->resourceurl,
2985 'config' => $config,
2986 ))
2987 );
2988 $PAGE->requires->yui_module('moodle-course-toolboxes',
2989 'M.course.init_section_toolbox',
2990 array(array(
2991 'courseid' => $course->id,
2992 'format' => $course->format,
2993 'ajaxurl' => $config->sectionurl,
2994 'config' => $config,
2995 ))
2996 );
2997
15e2552f 2998 // Include course dragdrop
5720019d 2999 if ($course->id != $SITE->id) {
c77582fe 3000 $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_section_dragdrop',
15e2552f
RK
3001 array(array(
3002 'courseid' => $course->id,
56838156 3003 'ajaxurl' => $config->sectionurl,
15e2552f
RK
3004 'config' => $config,
3005 )), null, true);
3006
c77582fe 3007 $PAGE->requires->yui_module('moodle-course-dragdrop', 'M.course.init_resource_dragdrop',
15e2552f
RK
3008 array(array(
3009 'courseid' => $course->id,
56838156 3010 'ajaxurl' => $config->resourceurl,
15e2552f
RK
3011 'config' => $config,
3012 )), null, true);
56838156
RK
3013 }
3014
ebaa29d1
ARN
3015 // Require various strings for the command toolbox
3016 $PAGE->requires->strings_for_js(array(
3017 'moveleft',
3018 'deletechecktype',
3019 'deletechecktypename',
7a9a07d2
ARN
3020 'edittitle',
3021 'edittitleinstructions',
ebaa29d1
ARN
3022 'show',
3023 'hide',
3024 'groupsnone',
3025 'groupsvisible',
3026 'groupsseparate',
3027 'clicktochangeinbrackets',
3028 'markthistopic',
3029 'markedthistopic',
15e2552f
RK
3030 'move',
3031 'movesection',
dd66b6ab 3032 'movecontent',
bbb483b2 3033 'tocontent',
dd66b6ab 3034 'emptydragdropregion'
ebaa29d1
ARN
3035 ), 'moodle');
3036
3037 // Include format-specific strings
5720019d 3038 if ($course->id != $SITE->id) {
ebaa29d1
ARN
3039 $PAGE->requires->strings_for_js(array(
3040 'showfromothers',
3041 'hidefromothers',
3042 ), 'format_' . $course->format);
3043 }
3044
3045 // For confirming resource deletion we need the name of the module in question
7b061512 3046 foreach ($usedmodules as $module => $modname) {
ebaa29d1
ARN
3047 $PAGE->requires->string_for_js('pluginname', $module);
3048 }
3aaa1843 3049
32528f94 3050 // Load drag and drop upload AJAX.
52973369 3051 require_once($CFG->dirroot.'/course/dnduploadlib.php');
7b061512
SH
3052 dndupload_add_to_course($course, $enabledmodules);
3053
5720019d 3054 return true;
ebaa29d1 3055}
5218b9bb 3056
3776335c
MG
3057/**
3058 * Returns the sorted list of available course formats, filtered by enabled if necessary
3059 *
3060 * @param bool $enabledonly return only formats that are enabled
3061 * @return array array of sorted format names
3062 */
3063function get_sorted_course_formats($enabledonly = false) {
3064 global $CFG;
bd3b3bba 3065 $formats = core_component::get_plugin_list('format');
3776335c
MG
3066
3067 if (!empty($CFG->format_plugins_sortorder)) {
3068 $order = explode(',', $CFG->format_plugins_sortorder);
3069 $order = array_merge(array_intersect($order, array_keys($formats)),
3070 array_diff(array_keys($formats), $order));
3071 } else {
3072 $order = array_keys($formats);
3073 }
3074 if (!$enabledonly) {
3075 return $order;
3076 }
3077 $sortedformats = array();
3078 foreach ($order as $formatname) {
3079 if (!get_config('format_'.$formatname, 'disabled')) {
3080 $sortedformats[] = $formatname;
3081 }
3082 }
3083 return $sortedformats;
3084}
3085
5218b9bb
DP
3086/**
3087 * The URL to use for the specified course (with section)
3088 *
ee7084e9
MG
3089 * @param int|stdClass $courseorid The course to get the section name for (either object or just course id)
3090 * @param int|stdClass $section Section object from database or just field course_sections.section
923451c5
MG
3091 * if omitted the course view page is returned
3092 * @param array $options options for view URL. At the moment core uses:
3093 * 'navigation' (bool) if true and section has no separate page, the function returns null
3094 * 'sr' (int) used by multipage formats to specify to which section to return
5218b9bb
DP
3095 * @return moodle_url The url of course
3096 */
ee7084e9
MG
3097function course_get_url($courseorid, $section = null, $options = array()) {
3098 return course_get_format($courseorid)->get_view_url($section, $options);
5218b9bb 3099}
dd5d933f 3100
dd5d933f
JM
3101/**
3102 * Create a module.
7cb0ea2c 3103 *
dd5d933f
JM
3104 * It includes:
3105 * - capability checks and other checks
3106 * - create the module from the module info
3107 *
3108 * @param object $module
3109 * @return object the created module info
3110 */
3111function create_module($moduleinfo) {
74df2951 3112 global $DB, $CFG;
80fe0c19
JM
3113
3114 require_once($CFG->dirroot . '/course/modlib.php');
3115
dd5d933f
JM
3116 // Check manadatory attributs.
3117 $mandatoryfields = array('modulename', 'course', 'section', 'visible');
3118 if (plugin_supports('mod', $moduleinfo->modulename, FEATURE_MOD_INTRO, true)) {
3119 $mandatoryfields[] = 'introeditor';
3120 }
3121 foreach($mandatoryfields as $mandatoryfield) {
3122 if (!isset($moduleinfo->{$mandatoryfield})) {
3123 throw new moodle_exception('createmodulemissingattribut', '', '', $mandatoryfield);
3124 }
3125 }
3126
7cb0ea2c 3127 // Some additional checks (capability / existing instances).
74df2951 3128 $course = $DB->get_record('course', array('id'=>$moduleinfo->course), '*', MUST_EXIST);
dd5d933f
JM
3129 list($module, $context, $cw) = can_add_moduleinfo($course, $moduleinfo->modulename, $moduleinfo->section);
3130
3131 // Load module library.
3132 include_modulelib($module->name);
3133
3134 // Add the module.
3135 $moduleinfo->module = $module->id;
3136 $moduleinfo = add_moduleinfo($moduleinfo, $course, null);
3137
3138 return $moduleinfo;
3139}
3140
3141/**
3142 * Update a module.
7cb0ea2c 3143 *
dd5d933f 3144 * It includes:
7cb0ea2c 3145 * - capability and other checks
dd5d933f
JM
3146 * - update the module
3147 *
3148 * @param object $module
3149 * @return object the updated module info
3150 */
3151function update_module($moduleinfo) {
74df2951 3152 global $DB, $CFG;
80fe0c19
JM
3153
3154 require_once($CFG->dirroot . '/course/modlib.php');
dd5d933f
JM
3155
3156 // Check the course module exists.
3157 $cm = get_coursemodule_from_id('', $moduleinfo->coursemodule, 0, false, MUST_EXIST);
3158
3159 // Check the course exists.
74df2951 3160 $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
dd5d933f 3161
7cb0ea2c 3162 // Some checks (capaibility / existing instances).
dd5d933f
JM
3163 list($cm, $context, $module, $data, $cw) = can_update_moduleinfo($cm);
3164
7cb0ea2c 3165 // Load module library.
dd5d933f
JM
3166 include_modulelib($module->name);
3167
7cb0ea2c 3168 // Retrieve few information needed by update_moduleinfo.
dd5d933f
JM
3169 $moduleinfo->modulename = $cm->modname;
3170 if (!isset($moduleinfo->scale)) {
3171 $moduleinfo->scale = 0;
3172 }
3173 $moduleinfo->type = 'mod';
3174
7cb0ea2c 3175 // Update the module.
dd5d933f
JM
3176 list($cm, $moduleinfo) = update_moduleinfo($cm, $moduleinfo, $course, null);
3177
3178 return $moduleinfo;
3179}
3a7e4a80 3180
bf6b3c7a
AA
3181/**
3182 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3183 * Sorts by descending order of time.
3184 *
3185 * @param stdClass $a First object
3186 * @param stdClass $b Second object
3187 * @return int 0,1,-1 representing the order
3188 */
3189function compare_activities_by_time_desc($a, $b) {
3190 // Make sure the activities actually have a timestamp property.
3191 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3192 return 0;
3193 }
3194 // We treat instances without timestamp as if they have a timestamp of 0.
3195 if ((!property_exists($a, 'timestamp')) && (property_exists($b,'timestamp'))) {
3196 return 1;
3197 }
3198 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3199 return -1;
3200 }
3201 if ($a->timestamp == $b->timestamp) {
3202 return 0;
3203 }
3204 return ($a->timestamp > $b->timestamp) ? -1 : 1;
3205}
3206
3207/**
3208 * Compare two objects to find out their correct order based on timestamp (to be used by usort).
3209 * Sorts by ascending order of time.
3210 *
3211 * @param stdClass $a First object
3212 * @param stdClass $b Second object
3213 * @return int 0,1,-1 representing the order
3214 */
3215function compare_activities_by_time_asc($a, $b) {
3216 // Make sure the activities actually have a timestamp property.
3217 if ((!property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3218 return 0;
3219 }
3220 // We treat instances without timestamp as if they have a timestamp of 0.
3221 if ((!property_exists($a, 'timestamp')) && (property_exists($b, 'timestamp'))) {
3222 return -1;
3223 }
3224 if ((property_exists($a, 'timestamp')) && (!property_exists($b, 'timestamp'))) {
3225 return 1;
3226 }
3227 if ($a->timestamp == $b->timestamp) {
3228 return 0;
3229 }
3230 return ($a->timestamp < $b->timestamp) ? -1 : 1;
3231}