MDL-29496 Search, Course - Code applied from patch to allow courses with a blank...
[moodle.git] / lib / datalib.php
CommitLineData
3564771d 1<?php
2
117bd748
PS
3// This file is part of Moodle - http://moodle.org/
4//
3564771d 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.
117bd748 14//
3564771d 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/>.
341b5ed2 17
7cf1c7bd 18/**
19 * Library of functions for database manipulation.
5930cded 20 *
7cf1c7bd 21 * Other main libraries:
22 * - weblib.php - functions that produce web output
23 * - moodlelib.php - general-purpose Moodle functions
3564771d 24 *
78bfb562
PS
25 * @package core
26 * @subpackage lib
27 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
28 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7cf1c7bd 29 */
30
78bfb562
PS
31defined('MOODLE_INTERNAL') || die();
32
4f0c2d00
PS
33/**
34 * The maximum courses in a category
35 * MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
36 */
3564771d 37define('MAX_COURSES_IN_CATEGORY', 10000);
4f0c2d00 38
117bd748 39/**
3564771d 40 * The maximum number of course categories
117bd748 41 * MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
3564771d 42 */
0cbe8111 43define('MAX_COURSE_CATEGORIES', 10000);
44
4f0c2d00
PS
45/**
46 * Number of seconds to wait before updating lastaccess information in DB.
47 */
48define('LASTACCESS_UPDATE_SECS', 60);
df28d6c5 49
18a97fd8 50/**
fbc21ae8 51 * Returns $user object of the main admin user
20aeb4b8 52 * primary admin = admin with lowest role_assignment id among admins
3564771d 53 *
5d6ab054 54 * @static stdClass $mainadmin
b739d51b 55 * @return stdClass {@link $USER} record from DB, false if not found
fbc21ae8 56 */
4f0c2d00
PS
57function get_admin() {
58 static $mainadmin = null;
2965f8fd 59
4f0c2d00 60 if (!isset($mainadmin)) {
850262ee
AD
61 if (! $admins = get_admins()) {
62 return false;
df28d6c5 63 }
4f0c2d00
PS
64 //TODO: add some admin setting for specifying of THE main admin
65 // for now return the first assigned admin
66 $mainadmin = reset($admins);
df28d6c5 67 }
5d6ab054
PS
68 // we must clone this otherwise code outside can break the static var
69 return clone($mainadmin);
df28d6c5 70}
71
18a97fd8 72/**
4f0c2d00 73 * Returns list of all admins, using 1 DB query
fbc21ae8 74 *
3564771d 75 * @return array
fbc21ae8 76 */
df28d6c5 77function get_admins() {
4f0c2d00 78 global $DB, $CFG;
5930cded 79
7928979b 80 if (empty($CFG->siteadmins)) { // Should not happen on an ordinary site
adf176d7 81 return array();
7928979b
MD
82 }
83
4f0c2d00 84 $sql = "SELECT u.*
624a690b 85 FROM {user} u
4f0c2d00 86 WHERE u.deleted = 0 AND u.id IN ($CFG->siteadmins)";
5930cded 87
4f0c2d00 88 return $DB->get_records_sql($sql);
df28d6c5 89}
90
900df8b6 91/**
fbc21ae8 92 * Search through course users
93 *
5930cded 94 * If $coursid specifies the site course then this function searches
fbc21ae8 95 * through all undeleted and confirmed users
96 *
3564771d 97 * @global object
98 * @uses SITEID
99 * @uses SQL_PARAMS_NAMED
100 * @uses CONTEXT_COURSE
fbc21ae8 101 * @param int $courseid The course in question.
102 * @param int $groupid The group in question.
3564771d 103 * @param string $searchtext The string to search for
104 * @param string $sort A field to sort by
105 * @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
106 * @return array
fbc21ae8 107 */
624a690b 108function search_users($courseid, $groupid, $searchtext, $sort='', array $exceptions=null) {
109 global $DB;
0720313b 110
245ac557 111 $fullname = $DB->sql_fullname('u.firstname', 'u.lastname');
8f0cd6ef 112
900df8b6 113 if (!empty($exceptions)) {
cf717dc2 114 list($exceptions, $params) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex', false);
624a690b 115 $except = "AND u.id $exceptions";
900df8b6 116 } else {
624a690b 117 $except = "";
118 $params = array();
900df8b6 119 }
2700d113 120
900df8b6 121 if (!empty($sort)) {
624a690b 122 $order = "ORDER BY $sort";
900df8b6 123 } else {
624a690b 124 $order = "";
900df8b6 125 }
8f0cd6ef 126
b0238f06 127 $select = "u.deleted = 0 AND u.confirmed = 1 AND (".$DB->sql_like($fullname, ':search1', false)." OR ".$DB->sql_like('u.email', ':search2', false).")";
624a690b 128 $params['search1'] = "%$searchtext%";
129 $params['search2'] = "%$searchtext%";
2700d113 130
222ac91b 131 if (!$courseid or $courseid == SITEID) {
624a690b 132 $sql = "SELECT u.id, u.firstname, u.lastname, u.email
133 FROM {user} u
134 WHERE $select
135 $except
136 $order";
137 return $DB->get_records_sql($sql, $params);
2700d113 138
624a690b 139 } else {
900df8b6 140 if ($groupid) {
624a690b 141 $sql = "SELECT u.id, u.firstname, u.lastname, u.email
142 FROM {user} u
143 JOIN {groups_members} gm ON gm.userid = u.id
144 WHERE $select AND gm.groupid = :groupid
145 $except
146 $order";
147 $params['groupid'] = $groupid;
148 return $DB->get_records_sql($sql, $params);
149
900df8b6 150 } else {
ea8158c1 151 $context = get_context_instance(CONTEXT_COURSE, $courseid);
152 $contextlists = get_related_contexts_string($context);
624a690b 153
154 $sql = "SELECT u.id, u.firstname, u.lastname, u.email
155 FROM {user} u
156 JOIN {role_assignments} ra ON ra.userid = u.id
157 WHERE $select AND ra.contextid $contextlists
158 $except
159 $order";
160 return $DB->get_records_sql($sql, $params);
900df8b6 161 }
162 }
df28d6c5 163}
164
18a97fd8 165/**
fbc21ae8 166 * Returns a subset of users
167 *
3564771d 168 * @global object
169 * @uses DEBUG_DEVELOPER
170 * @uses SQL_PARAMS_NAMED
7290c7fa 171 * @param bool $get If false then only a count of the records is returned
fbc21ae8 172 * @param string $search A simple string to search for
7290c7fa 173 * @param bool $confirmed A switch to allow/disallow unconfirmed users
3564771d 174 * @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
fbc21ae8 175 * @param string $sort A SQL snippet for the sorting criteria to use
3564771d 176 * @param string $firstinitial Users whose first name starts with $firstinitial
177 * @param string $lastinitial Users whose last name starts with $lastinitial
178 * @param string $page The page or records to return
179 * @param string $recordsperpage The number of records to return per page
fbc21ae8 180 * @param string $fields A comma separated list of fields to be returned from the chosen table.
117bd748 181 * @return array|int|bool {@link $USER} records unless get is false in which case the integer count of the records found is returned.
3564771d 182 * False is returned if an error is encountered.
fbc21ae8 183 */
624a690b 184function get_users($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC',
185 $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*', $extraselect='', array $extraparams=null) {
b3df1764 186 global $DB, $CFG;
5930cded 187
36075e09 188 if ($get && !$recordsperpage) {
189 debugging('Call to get_users with $get = true no $recordsperpage limit. ' .
190 'On large installations, this will probably cause an out of memory error. ' .
191 'Please think again and change your code so that it does not try to ' .
03517306 192 'load so much data into memory.', DEBUG_DEVELOPER);
36075e09 193 }
18a97fd8 194
245ac557 195 $fullname = $DB->sql_fullname();
e384fb7b 196
b3df1764
PS
197 $select = " id <> :guestid AND deleted = 0";
198 $params = array('guestid'=>$CFG->siteguest);
488acd1b 199
0044147e 200 if (!empty($search)){
201 $search = trim($search);
b0238f06 202 $select .= " AND (".$DB->sql_like($fullname, ':search1', false)." OR ".$DB->sql_like('email', ':search2', false)." OR username = :search3)";
624a690b 203 $params['search1'] = "%$search%";
204 $params['search2'] = "%$search%";
205 $params['search3'] = "$search";
e384fb7b 206 }
207
5a741655 208 if ($confirmed) {
624a690b 209 $select .= " AND confirmed = 1";
5a741655 210 }
211
212 if ($exceptions) {
cf717dc2 213 list($exceptions, $eparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex', false);
624a690b 214 $params = $params + $eparams;
215 $except = " AND id $exceptions";
5a741655 216 }
217
488acd1b 218 if ($firstinitial) {
b0238f06 219 $select .= " AND ".$DB->sql_like('firstname', ':fni', false, false);
624a690b 220 $params['fni'] = "$firstinitial%";
8f0cd6ef 221 }
488acd1b 222 if ($lastinitial) {
b0238f06 223 $select .= " AND ".$DB->sql_like('lastname', ':lni', false, false);
624a690b 224 $params['lni'] = "$lastinitial%";
8f0cd6ef 225 }
488acd1b 226
cd1edf9e 227 if ($extraselect) {
624a690b 228 $select .= " AND $extraselect";
229 $params = $params + (array)$extraparams;
cd1edf9e 230 }
231
5a741655 232 if ($get) {
624a690b 233 return $DB->get_records_select('user', $select, $params, $sort, $fields, $page, $recordsperpage);
5a741655 234 } else {
624a690b 235 return $DB->count_records_select('user', $select, $params);
5a741655 236 }
9fa49e22 237}
238
5a741655 239
18a97fd8 240/**
fbc21ae8 241 * @todo Finish documenting this function
3564771d 242 *
243 * @param string $sort An SQL field to sort by
244 * @param string $dir The sort direction ASC|DESC
245 * @param int $page The page or records to return
246 * @param int $recordsperpage The number of records to return per page
247 * @param string $search A simple string to search for
248 * @param string $firstinitial Users whose first name starts with $firstinitial
249 * @param string $lastinitial Users whose last name starts with $lastinitial
250 * @param string $extraselect An additional SQL select statement to append to the query
251 * @param array $extraparams Additional parameters to use for the above $extraselect
252 * @return array Array of {@link $USER} records
fbc21ae8 253 */
254
36075e09 255function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
624a690b 256 $search='', $firstinitial='', $lastinitial='', $extraselect='', array $extraparams=null) {
257 global $DB;
31fefa63 258
245ac557 259 $fullname = $DB->sql_fullname();
c2a96d6b 260
624a690b 261 $select = "deleted <> 1";
262 $params = array();
488acd1b 263
0044147e 264 if (!empty($search)) {
265 $search = trim($search);
f63ac65a
PS
266 $select .= " AND (". $DB->sql_like($fullname, ':search1', false, false).
267 " OR ". $DB->sql_like('email', ':search2', false, false).
268 " OR username = :search3)";
624a690b 269 $params['search1'] = "%$search%";
270 $params['search2'] = "%$search%";
271 $params['search3'] = "$search";
488acd1b 272 }
273
274 if ($firstinitial) {
f63ac65a 275 $select .= " AND ". $DB->sql_like('firstname', ':fni', false, false);
624a690b 276 $params['fni'] = "$firstinitial%";
488acd1b 277 }
488acd1b 278 if ($lastinitial) {
f63ac65a 279 $select .= " AND ". $DB->sql_like('lastname', ':lni', false, false);
624a690b 280 $params['lni'] = "$lastinitial%";
c750592a 281 }
282
cd1edf9e 283 if ($extraselect) {
624a690b 284 $select .= " AND $extraselect";
285 $params = $params + (array)$extraparams;
cd1edf9e 286 }
03d820c7 287
488acd1b 288 if ($sort) {
624a690b 289 $sort = " ORDER BY $sort $dir";
488acd1b 290 }
291
292/// warning: will return UNCONFIRMED USERS
624a690b 293 return $DB->get_records_sql("SELECT id, username, email, firstname, lastname, city, country, lastaccess, confirmed, mnethostid
294 FROM {user}
295 WHERE $select
296 $sort", $params, $page, $recordsperpage);
9fa49e22 297
298}
299
488acd1b 300
18a97fd8 301/**
7290c7fa 302 * Full list of users that have confirmed their accounts.
fbc21ae8 303 *
3564771d 304 * @global object
624a690b 305 * @return array of unconfirmed users
fbc21ae8 306 */
9fa49e22 307function get_users_confirmed() {
b3df1764 308 global $DB, $CFG;
624a690b 309 return $DB->get_records_sql("SELECT *
310 FROM {user}
b3df1764 311 WHERE confirmed = 1 AND deleted = 0 AND id <> ?", array($CFG->siteguest));
9fa49e22 312}
313
314
02ebf404 315/// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
316
317
18a97fd8 318/**
fbc21ae8 319 * Returns $course object of the top-level site.
320 *
3f77c158 321 * @return object A {@link $COURSE} object for the site, exception if not found
fbc21ae8 322 */
c44d5d42 323function get_site() {
624a690b 324 global $SITE, $DB;
c44d5d42 325
326 if (!empty($SITE->id)) { // We already have a global to use, so return that
327 return $SITE;
328 }
02ebf404 329
624a690b 330 if ($course = $DB->get_record('course', array('category'=>0))) {
02ebf404 331 return $course;
332 } else {
3f77c158
PS
333 // course table exists, but the site is not there,
334 // unfortunately there is no automatic way to recover
335 throw new moodle_exception('nosite', 'error');
02ebf404 336 }
337}
338
18a97fd8 339/**
613bbd7c 340 * Returns list of courses, for whole site, or category
341 *
342 * Returns list of courses, for whole site, or category
bfbfdb53 343 * Important: Using c.* for fields is extremely expensive because
613bbd7c 344 * we are using distinct. You almost _NEVER_ need all the fields
345 * in such a large SELECT
346 *
3564771d 347 * @global object
348 * @global object
349 * @global object
350 * @uses CONTEXT_COURSE
351 * @param string|int $categoryid Either a category id or 'all' for everything
352 * @param string $sort A field and direction to sort by
353 * @param string $fields The additional fields to return
354 * @return array Array of courses
613bbd7c 355 */
6315b1c8 356function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
02ebf404 357
3b8a284c 358 global $USER, $CFG, $DB;
5930cded 359
3b8a284c 360 $params = array();
361
362 if ($categoryid !== "all" && is_numeric($categoryid)) {
363 $categoryselect = "WHERE c.category = :catid";
364 $params['catid'] = $categoryid;
71dea306 365 } else {
5930cded 366 $categoryselect = "";
09575480 367 }
368
369 if (empty($sort)) {
370 $sortstatement = "";
371 } else {
372 $sortstatement = "ORDER BY $sort";
373 }
374
375 $visiblecourses = array();
5930cded 376
4f0c2d00
PS
377 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
378
379 $sql = "SELECT $fields $ccselect
3b8a284c 380 FROM {course} c
4f0c2d00 381 $ccjoin
3b8a284c 382 $categoryselect
383 $sortstatement";
384
71dea306 385 // pull out all course matching the cat
3b8a284c 386 if ($courses = $DB->get_records_sql($sql, $params)) {
09575480 387
388 // loop throught them
389 foreach ($courses as $course) {
4f0c2d00 390 context_instance_preload($course);
285f94f5 391 if (isset($course->visible) && $course->visible <= 0) {
09575480 392 // for hidden courses, require visibility check
4f0c2d00 393 if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
3b8a284c 394 $visiblecourses [$course->id] = $course;
09575480 395 }
396 } else {
3b8a284c 397 $visiblecourses [$course->id] = $course;
5930cded 398 }
09575480 399 }
6315b1c8 400 }
71dea306 401 return $visiblecourses;
8130b77b 402}
403
8130b77b 404
6315b1c8 405/**
613bbd7c 406 * Returns list of courses, for whole site, or category
407 *
408 * Similar to get_courses, but allows paging
5930cded 409 * Important: Using c.* for fields is extremely expensive because
613bbd7c 410 * we are using distinct. You almost _NEVER_ need all the fields
411 * in such a large SELECT
412 *
3564771d 413 * @global object
414 * @global object
415 * @global object
416 * @uses CONTEXT_COURSE
417 * @param string|int $categoryid Either a category id or 'all' for everything
418 * @param string $sort A field and direction to sort by
419 * @param string $fields The additional fields to return
420 * @param int $totalcount Reference for the number of courses
421 * @param string $limitfrom The course to start from
422 * @param string $limitnum The number of courses to limit to
117bd748 423 * @return array Array of courses
613bbd7c 424 */
6315b1c8 425function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
426 &$totalcount, $limitfrom="", $limitnum="") {
3b8a284c 427 global $USER, $CFG, $DB;
c7fe5c6f 428
3b8a284c 429 $params = array();
5930cded 430
71dea306 431 $categoryselect = "";
432 if ($categoryid != "all" && is_numeric($categoryid)) {
3b8a284c 433 $categoryselect = "WHERE c.category = :catid";
434 $params['catid'] = $categoryid;
71dea306 435 } else {
5930cded 436 $categoryselect = "";
437 }
438
4f0c2d00
PS
439 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
440
afa559e9
EL
441 $totalcount = 0;
442 if (!$limitfrom) {
443 $limitfrom = 0;
444 }
445 $visiblecourses = array();
446
4f0c2d00 447 $sql = "SELECT $fields $ccselect
3b8a284c 448 FROM {course} c
4f0c2d00 449 $ccjoin
3b8a284c 450 $categoryselect
451 ORDER BY $sort";
452
71dea306 453 // pull out all course matching the cat
afa559e9 454 $rs = $DB->get_recordset_sql($sql, $params);
71dea306 455 // iteration will have to be done inside loop to keep track of the limitfrom and limitnum
3b8a284c 456 foreach($rs as $course) {
4f0c2d00 457 context_instance_preload($course);
03cedd62 458 if ($course->visible <= 0) {
459 // for hidden courses, require visibility check
4f0c2d00 460 if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
71dea306 461 $totalcount++;
03cedd62 462 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
3b8a284c 463 $visiblecourses [$course->id] = $course;
71dea306 464 }
465 }
03cedd62 466 } else {
467 $totalcount++;
468 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
3b8a284c 469 $visiblecourses [$course->id] = $course;
03cedd62 470 }
5930cded 471 }
71dea306 472 }
3b8a284c 473 $rs->close();
71dea306 474 return $visiblecourses;
02ebf404 475}
476
624a690b 477/**
70f15878 478 * Retrieve course records with the course managers and other related records
479 * that we need for print_course(). This allows print_courses() to do its job
480 * in a constant number of DB queries, regardless of the number of courses,
481 * role assignments, etc.
bfbfdb53 482 *
70f15878 483 * The returned array is indexed on c.id, and each course will have
70f15878 484 * - $course->managers - array containing RA objects that include a $user obj
485 * with the minimal fields needed for fullname()
486 *
3564771d 487 * @global object
488 * @global object
489 * @global object
490 * @uses CONTEXT_COURSE
491 * @uses CONTEXT_SYSTEM
492 * @uses CONTEXT_COURSECAT
493 * @uses SITEID
494 * @param int|string $categoryid Either the categoryid for the courses or 'all'
495 * @param string $sort A SQL sort field and direction
496 * @param array $fields An array of additional fields to fetch
497 * @return array
70f15878 498 */
499function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
500 /*
bfbfdb53 501 * The plan is to
70f15878 502 *
503 * - Grab the courses JOINed w/context
504 *
505 * - Grab the interesting course-manager RAs
506 * JOINed with a base user obj and add them to each course
507 *
508 * So as to do all the work in 2 DB queries. The RA+user JOIN
509 * ends up being pretty expensive if it happens over _all_
510 * courses on a large site. (Are we surprised!?)
511 *
512 * So this should _never_ get called with 'all' on a large site.
513 *
514 */
3b8a284c 515 global $USER, $CFG, $DB;
70f15878 516
3b8a284c 517 $params = array();
70f15878 518 $allcats = false; // bool flag
519 if ($categoryid === 'all') {
520 $categoryclause = '';
521 $allcats = true;
522 } elseif (is_numeric($categoryid)) {
3b8a284c 523 $categoryclause = "c.category = :catid";
524 $params['catid'] = $categoryid;
70f15878 525 } else {
526 debugging("Could not recognise categoryid = $categoryid");
527 $categoryclause = '';
528 }
529
530 $basefields = array('id', 'category', 'sortorder',
531 'shortname', 'fullname', 'idnumber',
df997f84
PS
532 'startdate', 'visible',
533 'newsitems', 'groupmode', 'groupmodeforce');
70f15878 534
535 if (!is_null($fields) && is_string($fields)) {
536 if (empty($fields)) {
537 $fields = $basefields;
538 } else {
bfbfdb53 539 // turn the fields from a string to an array that
70f15878 540 // get_user_courses_bycap() will like...
541 $fields = explode(',',$fields);
542 $fields = array_map('trim', $fields);
543 $fields = array_unique(array_merge($basefields, $fields));
544 }
545 } elseif (is_array($fields)) {
546 $fields = array_merge($basefields,$fields);
547 }
548 $coursefields = 'c.' .join(',c.', $fields);
549
550 if (empty($sort)) {
551 $sortstatement = "";
552 } else {
553 $sortstatement = "ORDER BY $sort";
554 }
555
e89f157b 556 $where = 'WHERE c.id != ' . SITEID;
70f15878 557 if ($categoryclause !== ''){
e89f157b 558 $where = "$where AND $categoryclause";
70f15878 559 }
560
561 // pull out all courses matching the cat
4f0c2d00
PS
562 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
563 $sql = "SELECT $coursefields $ccselect
3b8a284c 564 FROM {course} c
4f0c2d00 565 $ccjoin
3b8a284c 566 $where
567 $sortstatement";
70f15878 568
569 $catpaths = array();
570 $catpath = NULL;
3b8a284c 571 if ($courses = $DB->get_records_sql($sql, $params)) {
70f15878 572 // loop on courses materialising
bfbfdb53 573 // the context, and prepping data to fetch the
70f15878 574 // managers efficiently later...
575 foreach ($courses as $k => $course) {
4f0c2d00
PS
576 context_instance_preload($course);
577 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
578 $courses[$k] = $course;
70f15878 579 $courses[$k]->managers = array();
580 if ($allcats === false) {
581 // single cat, so take just the first one...
582 if ($catpath === NULL) {
4f0c2d00 583 $catpath = preg_replace(':/\d+$:', '', $coursecontext->path);
70f15878 584 }
585 } else {
586 // chop off the contextid of the course itself
587 // like dirname() does...
4f0c2d00 588 $catpaths[] = preg_replace(':/\d+$:', '', $coursecontext->path);
70f15878 589 }
590 }
591 } else {
592 return array(); // no courses!
593 }
594
df997f84
PS
595 $CFG->coursecontact = trim($CFG->coursecontact);
596 if (empty($CFG->coursecontact)) {
b1cff118 597 return $courses;
598 }
599
7785dc2e 600 $managerroles = explode(',', $CFG->coursecontact);
70f15878 601 $catctxids = '';
602 if (count($managerroles)) {
603 if ($allcats === true) {
604 $catpaths = array_unique($catpaths);
605 $ctxids = array();
606 foreach ($catpaths as $cpath) {
607 $ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
608 }
609 $ctxids = array_unique($ctxids);
610 $catctxids = implode( ',' , $ctxids);
c7a71127 611 unset($catpaths);
612 unset($cpath);
70f15878 613 } else {
614 // take the ctx path from the first course
615 // as all categories will be the same...
616 $catpath = substr($catpath,1);
617 $catpath = preg_replace(':/\d+$:','',$catpath);
618 $catctxids = str_replace('/',',',$catpath);
619 }
620 if ($categoryclause !== '') {
621 $categoryclause = "AND $categoryclause";
622 }
623 /*
bfbfdb53 624 * Note: Here we use a LEFT OUTER JOIN that can
70f15878 625 * "optionally" match to avoid passing a ton of context
626 * ids in an IN() clause. Perhaps a subselect is faster.
627 *
628 * In any case, this SQL is not-so-nice over large sets of
629 * courses with no $categoryclause.
630 *
631 */
632 $sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
70f15878 633 r.id AS roleid, r.name as rolename,
634 u.id AS userid, u.firstname, u.lastname
3b8a284c 635 FROM {role_assignments} ra
636 JOIN {context} ctx ON ra.contextid = ctx.id
637 JOIN {user} u ON ra.userid = u.id
638 JOIN {role} r ON ra.roleid = r.id
639 LEFT OUTER JOIN {course} c
640 ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
c7a71127 641 WHERE ( c.id IS NOT NULL";
642 // under certain conditions, $catctxids is NULL
643 if($catctxids == NULL){
644 $sql .= ") ";
645 }else{
646 $sql .= " OR ra.contextid IN ($catctxids) )";
647 }
648
df997f84 649 $sql .= "AND ra.roleid IN ({$CFG->coursecontact})
70f15878 650 $categoryclause
651 ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
3b8a284c 652 $rs = $DB->get_recordset_sql($sql, $params);
bfbfdb53 653
70f15878 654 // This loop is fairly stupid as it stands - might get better
655 // results doing an initial pass clustering RAs by path.
3b8a284c 656 foreach($rs as $ra) {
4f0c2d00 657 $user = new stdClass;
03cedd62 658 $user->id = $ra->userid; unset($ra->userid);
659 $user->firstname = $ra->firstname; unset($ra->firstname);
660 $user->lastname = $ra->lastname; unset($ra->lastname);
661 $ra->user = $user;
662 if ($ra->contextlevel == CONTEXT_SYSTEM) {
663 foreach ($courses as $k => $course) {
664 $courses[$k]->managers[] = $ra;
665 }
4f0c2d00 666 } else if ($ra->contextlevel == CONTEXT_COURSECAT) {
03cedd62 667 if ($allcats === false) {
668 // It always applies
70f15878 669 foreach ($courses as $k => $course) {
670 $courses[$k]->managers[] = $ra;
671 }
03cedd62 672 } else {
673 foreach ($courses as $k => $course) {
4f0c2d00 674 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
03cedd62 675 // Note that strpos() returns 0 as "matched at pos 0"
4f0c2d00 676 if (strpos($coursecontext->path, $ra->path.'/') === 0) {
03cedd62 677 // Only add it to subpaths
70f15878 678 $courses[$k]->managers[] = $ra;
679 }
70f15878 680 }
70f15878 681 }
03cedd62 682 } else { // course-level
4f0c2d00 683 if (!array_key_exists($ra->instanceid, $courses)) {
03cedd62 684 //this course is not in a list, probably a frontpage course
685 continue;
686 }
687 $courses[$ra->instanceid]->managers[] = $ra;
70f15878 688 }
689 }
3b8a284c 690 $rs->close();
70f15878 691 }
692
693 return $courses;
694}
02ebf404 695
18a97fd8 696/**
7290c7fa 697 * A list of courses that match a search
fbc21ae8 698 *
3564771d 699 * @global object
700 * @global object
701 * @param array $searchterms An array of search criteria
702 * @param string $sort A field and direction to sort by
703 * @param int $page The page number to get
704 * @param int $recordsperpage The number of records per page
705 * @param int $totalcount Passed in by reference.
7290c7fa 706 * @return object {@link $COURSE} records
fbc21ae8 707 */
d4419d55 708function get_courses_search($searchterms, $sort='fullname ASC', $page=0, $recordsperpage=50, &$totalcount) {
3b8a284c 709 global $CFG, $DB;
02ebf404 710
06c1a1da 711 if ($DB->sql_regex_supported()) {
712 $REGEXP = $DB->sql_regex(true);
713 $NOTREGEXP = $DB->sql_regex(false);
02ebf404 714 }
715
06c1a1da 716 $searchcond = array();
717 $params = array();
718 $i = 0;
02ebf404 719
b438bce9 720 $concat = $DB->sql_concat("COALESCE(c.summary, ". $DB->sql_empty() .")", "' '", 'c.fullname', "' '", 'c.idnumber', "' '", 'c.shortname');
3b8a284c 721
02ebf404 722 foreach ($searchterms as $searchterm) {
06c1a1da 723 $i++;
6bb0f67f 724
b0238f06 725 $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
0f62a5b5 726 /// will use it to simulate the "-" operator with LIKE clause
727
6bb0f67f 728 /// Under Oracle and MSSQL, trim the + and - operators and perform
0f62a5b5 729 /// simpler LIKE (or NOT LIKE) queries
06c1a1da 730 if (!$DB->sql_regex_supported()) {
0f62a5b5 731 if (substr($searchterm, 0, 1) == '-') {
b0238f06 732 $NOT = true;
0f62a5b5 733 }
6bb0f67f 734 $searchterm = trim($searchterm, '+-');
735 }
736
06c1a1da 737 // TODO: +- may not work for non latin languages
3b8a284c 738
d4419d55 739 if (substr($searchterm,0,1) == '+') {
06c1a1da 740 $searchterm = trim($searchterm, '+-');
741 $searchterm = preg_quote($searchterm, '|');
742 $searchcond[] = "$concat $REGEXP :ss$i";
743 $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
744
a8b56716 745 } else if (substr($searchterm,0,1) == "-") {
06c1a1da 746 $searchterm = trim($searchterm, '+-');
747 $searchterm = preg_quote($searchterm, '|');
748 $searchcond[] = "$concat $NOTREGEXP :ss$i";
749 $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
750
a8b56716 751 } else {
47586394 752 $searchcond[] = $DB->sql_like($concat,":ss$i", false, true, $NOT);
06c1a1da 753 $params['ss'.$i] = "%$searchterm%";
a8b56716 754 }
02ebf404 755 }
756
06c1a1da 757 if (empty($searchcond)) {
758 $totalcount = 0;
759 return array();
760 }
761
762 $searchcond = implode(" AND ", $searchcond);
763
afa559e9
EL
764 $courses = array();
765 $c = 0; // counts how many visible courses we've seen
766
767 // Tiki pagination
768 $limitfrom = $page * $recordsperpage;
769 $limitto = $limitfrom + $recordsperpage;
770
4f0c2d00
PS
771 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
772 $sql = "SELECT c.* $ccselect
3b8a284c 773 FROM {course} c
4f0c2d00 774 $ccjoin
06c1a1da 775 WHERE $searchcond AND c.id <> ".SITEID."
776 ORDER BY $sort";
2c64f65c 777
afa559e9
EL
778 $rs = $DB->get_recordset_sql($sql, $params);
779 foreach($rs as $course) {
780 context_instance_preload($course);
781 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
782 if ($course->visible || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
783 // Don't exit this loop till the end
784 // we need to count all the visible courses
785 // to update $totalcount
786 if ($c >= $limitfrom && $c < $limitto) {
787 $courses[$course->id] = $course;
02ebf404 788 }
afa559e9 789 $c++;
02ebf404 790 }
791 }
afa559e9 792 $rs->close();
02ebf404 793
2c64f65c 794 // our caller expects 2 bits of data - our return
795 // array, and an updated $totalcount
796 $totalcount = $c;
02ebf404 797 return $courses;
798}
799
800
18a97fd8 801/**
40fb8aa6 802 * Returns a sorted list of categories. Each category object has a context
803 * property that is a context object.
bfbfdb53 804 *
40fb8aa6 805 * When asking for $parent='none' it will return all the categories, regardless
806 * of depth. Wheen asking for a specific parent, the default is to return
807 * a "shallow" resultset. Pass false to $shallow and it will return all
bfbfdb53 808 * the child categories as well.
809 *
3564771d 810 * @global object
811 * @uses CONTEXT_COURSECAT
613bbd7c 812 * @param string $parent The parent category if any
813 * @param string $sort the sortorder
40fb8aa6 814 * @param bool $shallow - set to false to get the children too
613bbd7c 815 * @return array of categories
fbc21ae8 816 */
40fb8aa6 817function get_categories($parent='none', $sort=NULL, $shallow=true) {
3b8a284c 818 global $DB;
40fb8aa6 819
820 if ($sort === NULL) {
821 $sort = 'ORDER BY cc.sortorder ASC';
822 } elseif ($sort ==='') {
823 // leave it as empty
824 } else {
825 $sort = "ORDER BY $sort";
826 }
02ebf404 827
4f0c2d00
PS
828 list($ccselect, $ccjoin) = context_instance_preload_sql('cc.id', CONTEXT_COURSECAT, 'ctx');
829
814748c9 830 if ($parent === 'none') {
4f0c2d00 831 $sql = "SELECT cc.* $ccselect
3b8a284c 832 FROM {course_categories} cc
4f0c2d00 833 $ccjoin
40fb8aa6 834 $sort";
3b8a284c 835 $params = array();
836
40fb8aa6 837 } elseif ($shallow) {
4f0c2d00 838 $sql = "SELECT cc.* $ccselect
3b8a284c 839 FROM {course_categories} cc
4f0c2d00 840 $ccjoin
3b8a284c 841 WHERE cc.parent=?
40fb8aa6 842 $sort";
3b8a284c 843 $params = array($parent);
844
02ebf404 845 } else {
4f0c2d00 846 $sql = "SELECT cc.* $ccselect
3b8a284c 847 FROM {course_categories} cc
4f0c2d00 848 $ccjoin
3b8a284c 849 JOIN {course_categories} ccp
618a7f91 850 ON ((cc.parent = ccp.id) OR (cc.path LIKE ".$DB->sql_concat('ccp.path',"'/%'")."))
3b8a284c 851 WHERE ccp.id=?
40fb8aa6 852 $sort";
3b8a284c 853 $params = array($parent);
02ebf404 854 }
40fb8aa6 855 $categories = array();
856
afa559e9
EL
857 $rs = $DB->get_recordset_sql($sql, $params);
858 foreach($rs as $cat) {
859 context_instance_preload($cat);
860 $catcontext = get_context_instance(CONTEXT_COURSECAT, $cat->id);
861 if ($cat->visible || has_capability('moodle/category:viewhiddencategories', $catcontext)) {
862 $categories[$cat->id] = $cat;
02ebf404 863 }
864 }
afa559e9 865 $rs->close();
02ebf404 866 return $categories;
867}
868
869
2327b9df 870/**
871 * Returns an array of category ids of all the subcategories for a given
872 * category.
3564771d 873 *
874 * @global object
875 * @param int $catid - The id of the category whose subcategories we want to find.
2327b9df 876 * @return array of category ids.
877 */
878function get_all_subcategories($catid) {
3b8a284c 879 global $DB;
2327b9df 880
881 $subcats = array();
882
3b8a284c 883 if ($categories = $DB->get_records('course_categories', array('parent'=>$catid))) {
2327b9df 884 foreach ($categories as $cat) {
885 array_push($subcats, $cat->id);
886 $subcats = array_merge($subcats, get_all_subcategories($cat->id));
887 }
888 }
889 return $subcats;
890}
891
18a97fd8 892/**
0cbe8111 893 * Return specified category, default if given does not exist
117bd748 894 *
3564771d 895 * @global object
896 * @uses MAX_COURSES_IN_CATEGORY
897 * @uses CONTEXT_COURSECAT
898 * @uses SYSCONTEXTID
0cbe8111 899 * @param int $catid course category id
900 * @return object caregory
901 */
902function get_course_category($catid=0) {
903 global $DB;
904
905 $category = false;
906
907 if (!empty($catid)) {
908 $category = $DB->get_record('course_categories', array('id'=>$catid));
909 }
8f0cd6ef 910
0cbe8111 911 if (!$category) {
912 // the first category is considered default for now
913 if ($category = $DB->get_records('course_categories', null, 'sortorder', '*', 0, 1)) {
914 $category = reset($category);
915
916 } else {
365a5941 917 $cat = new stdClass();
0cbe8111 918 $cat->name = get_string('miscellaneous');
919 $cat->depth = 1;
920 $cat->sortorder = MAX_COURSES_IN_CATEGORY;
921 $cat->timemodified = time();
a8d6ef8c 922 $catid = $DB->insert_record('course_categories', $cat);
0cbe8111 923 // make sure category context exists
924 get_context_instance(CONTEXT_COURSECAT, $catid);
925 mark_context_dirty('/'.SYSCONTEXTID);
7a9d505b 926 fix_course_sortorder(); // Required to build course_categories.depth and .path.
0cbe8111 927 $category = $DB->get_record('course_categories', array('id'=>$catid));
f41ef63e 928 }
0cbe8111 929 }
ba87a4da 930
0cbe8111 931 return $category;
932}
933
934/**
935 * Fixes course category and course sortorder, also verifies category and course parents and paths.
a1b892cc 936 * (circular references are not fixed)
3564771d 937 *
938 * @global object
939 * @global object
940 * @uses MAX_COURSES_IN_CATEGORY
941 * @uses MAX_COURSE_CATEGORIES
942 * @uses SITEID
943 * @uses CONTEXT_COURSE
944 * @return void
0cbe8111 945 */
946function fix_course_sortorder() {
947 global $DB, $SITE;
948
949 //WARNING: this is PHP5 only code!
950
951 if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
952 //move all categories that are not sorted yet to the end
953 $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('sortorder'=>0));
954 }
955
956 $allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
957 $topcats = array();
958 $brokencats = array();
959 foreach ($allcats as $cat) {
960 $sortorder = (int)$cat->sortorder;
961 if (!$cat->parent) {
962 while(isset($topcats[$sortorder])) {
963 $sortorder++;
964 }
965 $topcats[$sortorder] = $cat;
966 continue;
967 }
968 if (!isset($allcats[$cat->parent])) {
969 $brokencats[] = $cat;
970 continue;
c5d13b68 971 }
0cbe8111 972 if (!isset($allcats[$cat->parent]->children)) {
973 $allcats[$cat->parent]->children = array();
c5d13b68 974 }
0cbe8111 975 while(isset($allcats[$cat->parent]->children[$sortorder])) {
976 $sortorder++;
977 }
978 $allcats[$cat->parent]->children[$sortorder] = $cat;
f41ef63e 979 }
0cbe8111 980 unset($allcats);
39f65595 981
0cbe8111 982 // add broken cats to category tree
983 if ($brokencats) {
984 $defaultcat = reset($topcats);
985 foreach ($brokencats as $cat) {
986 $topcats[] = $cat;
a1b892cc 987 }
ba87a4da 988 }
989
0cbe8111 990 // now walk recursively the tree and fix any problems found
991 $sortorder = 0;
992 $fixcontexts = array();
993 _fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts);
994
995 // detect if there are "multiple" frontpage courses and fix them if needed
996 $frontcourses = $DB->get_records('course', array('category'=>0), 'id');
997 if (count($frontcourses) > 1) {
998 if (isset($frontcourses[SITEID])) {
999 $frontcourse = $frontcourses[SITEID];
1000 unset($frontcourses[SITEID]);
1001 } else {
1002 $frontcourse = array_shift($frontcourses);
1003 }
1004 $defaultcat = reset($topcats);
1005 foreach ($frontcourses as $course) {
1006 $DB->set_field('course', 'category', $defaultcat->id, array('id'=>$course->id));
1007 $context = get_context_instance(CONTEXT_COURSE, $course->id);
1008 $fixcontexts[$context->id] = $context;
1009 }
1010 unset($frontcourses);
1011 } else {
1012 $frontcourse = reset($frontcourses);
814748c9 1013 }
1014
0cbe8111 1015 // now fix the paths and depths in context table if needed
1016 if ($fixcontexts) {
1017 rebuild_contexts($fixcontexts);
39f65595 1018 }
5930cded 1019
0cbe8111 1020 // release memory
1021 unset($topcats);
1022 unset($brokencats);
1023 unset($fixcontexts);
1024
1025 // fix frontpage course sortorder
1026 if ($frontcourse->sortorder != 1) {
1027 $DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id));
39f65595 1028 }
1029
0cbe8111 1030 // now fix the course counts in category records if needed
1031 $sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
1032 FROM {course_categories} cc
1033 LEFT JOIN {course} c ON c.category = cc.id
1034 GROUP BY cc.id, cc.coursecount
1035 HAVING cc.coursecount <> COUNT(c.id)";
ba87a4da 1036
0cbe8111 1037 if ($updatecounts = $DB->get_records_sql($sql)) {
3acbe663
DC
1038 // categories with more courses than MAX_COURSES_IN_CATEGORY
1039 $categories = array();
0cbe8111 1040 foreach ($updatecounts as $cat) {
1041 $cat->coursecount = $cat->newcount;
3acbe663
DC
1042 if ($cat->coursecount >= MAX_COURSES_IN_CATEGORY) {
1043 $categories[] = $cat->id;
1044 }
0cbe8111 1045 unset($cat->newcount);
1046 $DB->update_record_raw('course_categories', $cat, true);
a1b892cc 1047 }
3acbe663
DC
1048 if (!empty($categories)) {
1049 $str = implode(', ', $categories);
1050 debugging("The number of courses (category id: $str) has reached MAX_COURSES_IN_CATEGORY (" . MAX_COURSES_IN_CATEGORY . "), it will cause a sorting performance issue, please increase the value of MAX_COURSES_IN_CATEGORY in lib/datalib.php file. See tracker issue: MDL-25669", DEBUG_DEVELOPER);
1051 }
02ebf404 1052 }
8f0cd6ef 1053
0cbe8111 1054 // now make sure that sortorders in course table are withing the category sortorder ranges
8ed5dd63 1055 $sql = "SELECT DISTINCT cc.id, cc.sortorder
0cbe8111 1056 FROM {course_categories} cc
1057 JOIN {course} c ON c.category = cc.id
1058 WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY;
1059
1060 if ($fixcategories = $DB->get_records_sql($sql)) {
1061 //fix the course sortorder ranges
1062 foreach ($fixcategories as $cat) {
1063 $sql = "UPDATE {course}
78a0635c 1064 SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY)." + ?
0cbe8111 1065 WHERE category = ?";
1066 $DB->execute($sql, array($cat->sortorder, $cat->id));
1067 }
814748c9 1068 }
0cbe8111 1069 unset($fixcategories);
1070
1071 // categories having courses with sortorder duplicates or having gaps in sortorder
1072 $sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
1073 FROM {course} c1
1074 JOIN {course} c2 ON c1.sortorder = c2.sortorder
1075 JOIN {course_categories} cc ON (c1.category = cc.id)
1076 WHERE c1.id <> c2.id";
1077 $fixcategories = $DB->get_records_sql($sql);
1078
1079 $sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
1080 FROM {course_categories} cc
1081 JOIN {course} c ON c.category = cc.id
1082 GROUP BY cc.id, cc.sortorder, cc.coursecount
1083 HAVING (MAX(c.sortorder) <> cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <> cc.sortorder + 1)";
1084 $gapcategories = $DB->get_records_sql($sql);
1085
1086 foreach ($gapcategories as $cat) {
1087 if (isset($fixcategories[$cat->id])) {
1088 // duplicates detected already
1089
1090 } else if ($cat->minsort == $cat->sortorder and $cat->maxsort == $cat->sortorder + $cat->coursecount - 1) {
1091 // easy - new course inserted with sortorder 0, the rest is ok
1092 $sql = "UPDATE {course}
1093 SET sortorder = sortorder + 1
1094 WHERE category = ?";
1095 $DB->execute($sql, array($cat->id));
758b9a4d 1096
0cbe8111 1097 } else {
1098 // it needs full resorting
1099 $fixcategories[$cat->id] = $cat;
6bc502cc 1100 }
1101 }
0cbe8111 1102 unset($gapcategories);
8f0cd6ef 1103
0cbe8111 1104 // fix course sortorders in problematic categories only
1105 foreach ($fixcategories as $cat) {
1106 $i = 1;
1107 $courses = $DB->get_records('course', array('category'=>$cat->id), 'sortorder ASC, id DESC', 'id, sortorder');
1108 foreach ($courses as $course) {
1109 if ($course->sortorder != $cat->sortorder + $i) {
1110 $course->sortorder = $cat->sortorder + $i;
a1b892cc 1111 $DB->update_record_raw('course', $course, true);
0cbe8111 1112 }
1113 $i++;
1114 }
1115 }
02ebf404 1116}
1117
d8634192 1118/**
0cbe8111 1119 * Internal recursive category verification function, do not use directly!
3564771d 1120 *
1121 * @todo Document the arguments of this function better
1122 *
1123 * @global object
1124 * @uses MAX_COURSES_IN_CATEGORY
1125 * @uses CONTEXT_COURSECAT
1126 * @param array $children
1127 * @param int $sortorder
1128 * @param string $parent
1129 * @param int $depth
1130 * @param string $path
1131 * @param array $fixcontexts
1132 * @return void
0cbe8111 1133 */
1134function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
c3df0901 1135 global $DB;
d8634192 1136
0cbe8111 1137 $depth++;
c3df0901 1138
0cbe8111 1139 foreach ($children as $cat) {
1140 $sortorder = $sortorder + MAX_COURSES_IN_CATEGORY;
1141 $update = false;
1142 if ($parent != $cat->parent or $depth != $cat->depth or $path.'/'.$cat->id != $cat->path) {
1143 $cat->parent = $parent;
1144 $cat->depth = $depth;
1145 $cat->path = $path.'/'.$cat->id;
1146 $update = true;
c3df0901 1147
0cbe8111 1148 // make sure context caches are rebuild and dirty contexts marked
1149 $context = get_context_instance(CONTEXT_COURSECAT, $cat->id);
1150 $fixcontexts[$context->id] = $context;
1151 }
1152 if ($cat->sortorder != $sortorder) {
1153 $cat->sortorder = $sortorder;
1154 $update = true;
1155 }
1156 if ($update) {
1157 $DB->update_record('course_categories', $cat, true);
1158 }
1159 if (isset($cat->children)) {
1160 _fix_course_cats($cat->children, $sortorder, $cat->id, $cat->depth, $cat->path, $fixcontexts);
d8634192 1161 }
1162 }
1163}
1164
db4b12eb 1165/**
1166 * List of remote courses that a user has access to via MNET.
1167 * Works only on the IDP
1168 *
3564771d 1169 * @global object
1170 * @global object
1171 * @param int @userid The user id to get remote courses for
1172 * @return array Array of {@link $COURSE} of course objects
db4b12eb 1173 */
1174function get_my_remotecourses($userid=0) {
c3df0901 1175 global $DB, $USER;
db4b12eb 1176
1177 if (empty($userid)) {
1178 $userid = $USER->id;
1179 }
1180
c6575bef
DM
1181 // we can not use SELECT DISTINCT + text field (summary) because of MS SQL and Oracle, subselect used therefore
1182 $sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
152a2273 1183 c.hostid, c.summary, c.summaryformat, c.categoryname AS cat_name,
86dd62a7 1184 h.name AS hostname
152a2273 1185 FROM {mnetservice_enrol_courses} c
c6575bef
DM
1186 JOIN (SELECT DISTINCT hostid, remotecourseid
1187 FROM {mnetservice_enrol_enrolments}
1188 WHERE userid = ?
1189 ) e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
1190 JOIN {mnet_host} h ON h.id = c.hostid";
db4b12eb 1191
c3df0901 1192 return $DB->get_records_sql($sql, array($userid));
db4b12eb 1193}
1194
1195/**
1196 * List of remote hosts that a user has access to via MNET.
1197 * Works on the SP
1198 *
3564771d 1199 * @global object
1200 * @global object
1201 * @return array|bool Array of host objects or false
db4b12eb 1202 */
1203function get_my_remotehosts() {
1204 global $CFG, $USER;
1205
1206 if ($USER->mnethostid == $CFG->mnet_localhost_id) {
1207 return false; // Return nothing on the IDP
1208 }
1209 if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
1210 return $USER->mnet_foreign_host_array;
1211 }
1212 return false;
1213}
fbc21ae8 1214
18a97fd8 1215/**
fbc21ae8 1216 * This function creates a default separated/connected scale
1217 *
1218 * This function creates a default separated/connected scale
1219 * so there's something in the database. The locations of
1220 * strings and files is a bit odd, but this is because we
1221 * need to maintain backward compatibility with many different
1222 * existing language translations and older sites.
3564771d 1223 *
1224 * @global object
3564771d 1225 * @return void
fbc21ae8 1226 */
02ebf404 1227function make_default_scale() {
2d0f7da8 1228 global $DB;
02ebf404 1229
1230 $defaultscale = NULL;
1231 $defaultscale->courseid = 0;
1232 $defaultscale->userid = 0;
d4419d55 1233 $defaultscale->name = get_string('separateandconnected');
2d0f7da8 1234 $defaultscale->description = get_string('separateandconnectedinfo');
d4419d55 1235 $defaultscale->scale = get_string('postrating1', 'forum').','.
1236 get_string('postrating2', 'forum').','.
1237 get_string('postrating3', 'forum');
02ebf404 1238 $defaultscale->timemodified = time();
1239
a9637e7d
PS
1240 $defaultscale->id = $DB->insert_record('scale', $defaultscale);
1241 $DB->execute("UPDATE {forum} SET scale = ?", array($defaultscale->id));
02ebf404 1242}
1243
fbc21ae8 1244
18a97fd8 1245/**
fbc21ae8 1246 * Returns a menu of all available scales from the site as well as the given course
1247 *
3564771d 1248 * @global object
fbc21ae8 1249 * @param int $courseid The id of the course as found in the 'course' table.
3564771d 1250 * @return array
fbc21ae8 1251 */
02ebf404 1252function get_scales_menu($courseid=0) {
c3df0901 1253 global $DB;
02ebf404 1254
c3df0901 1255 $sql = "SELECT id, name
1256 FROM {scale}
1257 WHERE courseid = 0 or courseid = ?
02ebf404 1258 ORDER BY courseid ASC, name ASC";
c3df0901 1259 $params = array($courseid);
02ebf404 1260
c3df0901 1261 if ($scales = $DB->get_records_sql_menu($sql, $params)) {
02ebf404 1262 return $scales;
1263 }
1264
1265 make_default_scale();
1266
c3df0901 1267 return $DB->get_records_sql_menu($sql, $params);
02ebf404 1268}
1269
5baa0ad6 1270
1271
1272/**
1273 * Given a set of timezone records, put them in the database, replacing what is there
1274 *
3564771d 1275 * @global object
5baa0ad6 1276 * @param array $timezones An array of timezone records
3564771d 1277 * @return void
5baa0ad6 1278 */
1279function update_timezone_records($timezones) {
c3df0901 1280 global $DB;
5baa0ad6 1281
1282/// Clear out all the old stuff
b820eb8c 1283 $DB->delete_records('timezone');
5baa0ad6 1284
1285/// Insert all the new stuff
1286 foreach ($timezones as $timezone) {
a599aeeb 1287 if (is_array($timezone)) {
1288 $timezone = (object)$timezone;
1289 }
c3df0901 1290 $DB->insert_record('timezone', $timezone);
5baa0ad6 1291 }
1292}
1293
1294
df28d6c5 1295/// MODULE FUNCTIONS /////////////////////////////////////////////////
1296
18a97fd8 1297/**
fbc21ae8 1298 * Just gets a raw list of all modules in a course
1299 *
3564771d 1300 * @global object
fbc21ae8 1301 * @param int $courseid The id of the course as found in the 'course' table.
3564771d 1302 * @return array
fbc21ae8 1303 */
9fa49e22 1304function get_course_mods($courseid) {
c3df0901 1305 global $DB;
9fa49e22 1306
3a11c548 1307 if (empty($courseid)) {
1308 return false; // avoid warnings
1309 }
1310
c3df0901 1311 return $DB->get_records_sql("SELECT cm.*, m.name as modname
1312 FROM {modules} m, {course_modules} cm
1313 WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
1314 array($courseid)); // no disabled mods
9fa49e22 1315}
1316
fbc21ae8 1317
18a97fd8 1318/**
f9d5371b 1319 * Given an id of a course module, finds the coursemodule description
fbc21ae8 1320 *
3564771d 1321 * @global object
a1b892cc 1322 * @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
f9d5371b 1323 * @param int $cmid course module id (id in course_modules table)
1324 * @param int $courseid optional course id for extra validation
a1b892cc 1325 * @param bool $sectionnum include relative section number (0,1,2 ...)
4fea29e4 1326 * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1327 * IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1328 * MUST_EXIST means throw exception if no record or multiple records found
83be47e6 1329 * @return stdClass
f9d5371b 1330 */
4fea29e4 1331function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
c3df0901 1332 global $DB;
f9d5371b 1333
a1b892cc 1334 $params = array('cmid'=>$cmid);
1335
1336 if (!$modulename) {
1337 if (!$modulename = $DB->get_field_sql("SELECT md.name
1338 FROM {modules} md
1339 JOIN {course_modules} cm ON cm.module = md.id
4fea29e4 1340 WHERE cm.id = :cmid", $params, $strictness)) {
a1b892cc 1341 return false;
1342 }
1343 }
1344
1345 $params['modulename'] = $modulename;
1346
d251907c 1347 $courseselect = "";
a1b892cc 1348 $sectionfield = "";
1349 $sectionjoin = "";
f9d5371b 1350
c3df0901 1351 if ($courseid) {
a1b892cc 1352 $courseselect = "AND cm.course = :courseid";
c3df0901 1353 $params['courseid'] = $courseid;
d251907c 1354 }
c3df0901 1355
a1b892cc 1356 if ($sectionnum) {
1357 $sectionfield = ", cw.section AS sectionnum";
1358 $sectionjoin = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1359 }
1360
1361 $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1362 FROM {course_modules} cm
1363 JOIN {modules} md ON md.id = cm.module
1364 JOIN {".$modulename."} m ON m.id = cm.instance
1365 $sectionjoin
1366 WHERE cm.id = :cmid AND md.name = :modulename
1367 $courseselect";
1368
4fea29e4 1369 return $DB->get_record_sql($sql, $params, $strictness);
f9d5371b 1370}
1371
1372/**
1373 * Given an instance number of a module, finds the coursemodule description
1374 *
3564771d 1375 * @global object
f9d5371b 1376 * @param string $modulename name of module type, eg. resource, assignment,...
1377 * @param int $instance module instance number (id in resource, assignment etc. table)
1378 * @param int $courseid optional course id for extra validation
a1b892cc 1379 * @param bool $sectionnum include relative section number (0,1,2 ...)
4fea29e4 1380 * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1381 * IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1382 * MUST_EXIST means throw exception if no record or multiple records found
83be47e6 1383 * @return stdClass
fbc21ae8 1384 */
4fea29e4 1385function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
c3df0901 1386 global $DB;
df28d6c5 1387
a1b892cc 1388 $params = array('instance'=>$instance, 'modulename'=>$modulename);
1389
d251907c 1390 $courseselect = "";
a1b892cc 1391 $sectionfield = "";
1392 $sectionjoin = "";
df28d6c5 1393
c3df0901 1394 if ($courseid) {
a1b892cc 1395 $courseselect = "AND cm.course = :courseid";
c3df0901 1396 $params['courseid'] = $courseid;
d251907c 1397 }
c3df0901 1398
a1b892cc 1399 if ($sectionnum) {
1400 $sectionfield = ", cw.section AS sectionnum";
1401 $sectionjoin = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1402 }
1403
1404 $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1405 FROM {course_modules} cm
1406 JOIN {modules} md ON md.id = cm.module
1407 JOIN {".$modulename."} m ON m.id = cm.instance
1408 $sectionjoin
1409 WHERE m.id = :instance AND md.name = :modulename
1410 $courseselect";
df28d6c5 1411
4fea29e4 1412 return $DB->get_record_sql($sql, $params, $strictness);
df28d6c5 1413}
1414
dd97c328 1415/**
1416 * Returns all course modules of given activity in course
3564771d 1417 *
1418 * @param string $modulename The module name (forum, quiz, etc.)
1419 * @param int $courseid The course id to get modules for
dd97c328 1420 * @param string $extrafields extra fields starting with m.
3564771d 1421 * @return array Array of results
dd97c328 1422 */
1423function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
c3df0901 1424 global $DB;
dd97c328 1425
1426 if (!empty($extrafields)) {
1427 $extrafields = ", $extrafields";
1428 }
c3df0901 1429 $params = array();
1430 $params['courseid'] = $courseid;
1431 $params['modulename'] = $modulename;
1432
1433
1434 return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
1435 FROM {course_modules} cm, {modules} md, {".$modulename."} m
1436 WHERE cm.course = :courseid AND
1437 cm.instance = m.id AND
1438 md.name = :modulename AND
e0985504 1439 md.id = cm.module", $params);
dd97c328 1440}
ac0b1a19 1441
185cfb09 1442/**
1443 * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1444 *
1445 * Returns an array of all the active instances of a particular
1446 * module in given courses, sorted in the order they are defined
ac0b1a19 1447 * in the course. Returns an empty array on any errors.
185cfb09 1448 *
ac0b1a19 1449 * The returned objects includle the columns cw.section, cm.visible,
1450 * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1451 *
3564771d 1452 * @global object
1453 * @global object
ac0b1a19 1454 * @param string $modulename The name of the module to get instances for
1455 * @param array $courses an array of course objects.
3564771d 1456 * @param int $userid
1457 * @param int $includeinvisible
ac0b1a19 1458 * @return array of module instance objects, including some extra fields from the course_modules
1459 * and course_sections tables, or an empty array if an error occurred.
185cfb09 1460 */
00e12c73 1461function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
c3df0901 1462 global $CFG, $DB;
ac0b1a19 1463
1464 $outputarray = array();
1465
185cfb09 1466 if (empty($courses) || !is_array($courses) || count($courses) == 0) {
ac0b1a19 1467 return $outputarray;
185cfb09 1468 }
ac0b1a19 1469
c3df0901 1470 list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED, 'c0');
1471 $params['modulename'] = $modulename;
1472
1473 if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
1474 cm.groupmode, cm.groupingid, cm.groupmembersonly
1475 FROM {course_modules} cm, {course_sections} cw, {modules} md,
1476 {".$modulename."} m
1477 WHERE cm.course $coursessql AND
1478 cm.instance = m.id AND
1479 cm.section = cw.id AND
1480 md.name = :modulename AND
1481 md.id = cm.module", $params)) {
ac0b1a19 1482 return $outputarray;
185cfb09 1483 }
1484
185cfb09 1485 foreach ($courses as $course) {
ac0b1a19 1486 $modinfo = get_fast_modinfo($course, $userid);
fea43a7f 1487
ac0b1a19 1488 if (empty($modinfo->instances[$modulename])) {
185cfb09 1489 continue;
1490 }
ac0b1a19 1491
1492 foreach ($modinfo->instances[$modulename] as $cm) {
1493 if (!$includeinvisible and !$cm->uservisible) {
1494 continue;
1495 }
1496 if (!isset($rawmods[$cm->id])) {
1497 continue;
185cfb09 1498 }
ac0b1a19 1499 $instance = $rawmods[$cm->id];
1500 if (!empty($cm->extra)) {
9a9012dc 1501 $instance->extra = $cm->extra;
ac0b1a19 1502 }
1503 $outputarray[] = $instance;
185cfb09 1504 }
1505 }
1506
1507 return $outputarray;
185cfb09 1508}
fbc21ae8 1509
18a97fd8 1510/**
3d96cba7 1511 * Returns an array of all the active instances of a particular module in a given course,
1512 * sorted in the order they are defined.
fbc21ae8 1513 *
1514 * Returns an array of all the active instances of a particular
1515 * module in a given course, sorted in the order they are defined
3d96cba7 1516 * in the course. Returns an empty array on any errors.
1517 *
1518 * The returned objects includle the columns cw.section, cm.visible,
ac0b1a19 1519 * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
fbc21ae8 1520 *
3564771d 1521 * Simply calls {@link all_instances_in_courses()} with a single provided course
1522 *
3d96cba7 1523 * @param string $modulename The name of the module to get instances for
ac0b1a19 1524 * @param object $course The course obect.
3d96cba7 1525 * @return array of module instance objects, including some extra fields from the course_modules
1526 * and course_sections tables, or an empty array if an error occurred.
3564771d 1527 * @param int $userid
1528 * @param int $includeinvisible
fbc21ae8 1529 */
00e12c73 1530function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
ac0b1a19 1531 return get_all_instances_in_courses($modulename, array($course->id => $course), $userid, $includeinvisible);
df28d6c5 1532}
1533
9fa49e22 1534
18a97fd8 1535/**
fbc21ae8 1536 * Determine whether a module instance is visible within a course
1537 *
1538 * Given a valid module object with info about the id and course,
1539 * and the module's type (eg "forum") returns whether the object
dd97c328 1540 * is visible or not, groupmembersonly visibility not tested
fbc21ae8 1541 *
3564771d 1542 * @global object
117bd748 1543
613bbd7c 1544 * @param $moduletype Name of the module eg 'forum'
1545 * @param $module Object which is the instance of the module
3564771d 1546 * @return bool Success
fbc21ae8 1547 */
580f2fbc 1548function instance_is_visible($moduletype, $module) {
c3df0901 1549 global $DB;
580f2fbc 1550
2b49ae96 1551 if (!empty($module->id)) {
d251907c 1552 $params = array('courseid'=>$module->course, 'moduletype'=>$moduletype, 'moduleid'=>$module->id);
c3df0901 1553 if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
1554 FROM {course_modules} cm, {modules} m
1555 WHERE cm.course = :courseid AND
1556 cm.module = m.id AND
1557 m.name = :moduletype AND
f93ea222 1558 cm.instance = :moduleid", $params)) {
5930cded 1559
2b49ae96 1560 foreach ($records as $record) { // there should only be one - use the first one
dd97c328 1561 return $record->visible;
2b49ae96 1562 }
580f2fbc 1563 }
1564 }
580f2fbc 1565 return true; // visible by default!
1566}
1567
dd97c328 1568/**
1569 * Determine whether a course module is visible within a course,
1570 * this is different from instance_is_visible() - faster and visibility for user
1571 *
3564771d 1572 * @global object
1573 * @global object
1574 * @uses DEBUG_DEVELOPER
1575 * @uses CONTEXT_MODULE
1576 * @uses CONDITION_MISSING_EXTRATABLE
dd97c328 1577 * @param object $cm object
1578 * @param int $userid empty means current user
3564771d 1579 * @return bool Success
dd97c328 1580 */
1581function coursemodule_visible_for_user($cm, $userid=0) {
82bd6a5e 1582 global $USER,$CFG;
dd97c328 1583
1584 if (empty($cm->id)) {
1585 debugging("Incorrect course module parameter!", DEBUG_DEVELOPER);
1586 return false;
1587 }
1588 if (empty($userid)) {
1589 $userid = $USER->id;
1590 }
1591 if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1592 return false;
1593 }
82bd6a5e 1594 if ($CFG->enableavailability) {
1595 require_once($CFG->libdir.'/conditionlib.php');
1596 $ci=new condition_info($cm,CONDITION_MISSING_EXTRATABLE);
117bd748
PS
1597 if(!$ci->is_available($cm->availableinfo,false,$userid) and
1598 !has_capability('moodle/course:viewhiddenactivities',
82bd6a5e 1599 get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1600 return false;
1601 }
1602 }
dd97c328 1603 return groups_course_module_visible($cm, $userid);
1604}
1605
a3fb1c45 1606
1607
1608
9fa49e22 1609/// LOG FUNCTIONS /////////////////////////////////////////////////////
1610
1611
18a97fd8 1612/**
fbc21ae8 1613 * Add an entry to the log table.
1614 *
1615 * Add an entry to the log table. These are "action" focussed rather
1616 * than web server hits, and provide a way to easily reconstruct what
1617 * any particular student has been doing.
1618 *
3564771d 1619 * @global object
1620 * @global object
1621 * @global object
fbc21ae8 1622 * @uses SITEID
3564771d 1623 * @uses DEBUG_DEVELOPER
1624 * @uses DEBUG_ALL
89dcb99d 1625 * @param int $courseid The course id
fbc21ae8 1626 * @param string $module The module name - e.g. forum, journal, resource, course, user etc
f7664880 1627 * @param string $action 'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
fbc21ae8 1628 * @param string $url The file and parameters used to see the results of the action
1629 * @param string $info Additional description information
1630 * @param string $cm The course_module->id if there is one
1631 * @param string $user If log regards $user other than $USER
3564771d 1632 * @return void
fbc21ae8 1633 */
d4419d55 1634function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
e8395a09 1635 // Note that this function intentionally does not follow the normal Moodle DB access idioms.
1636 // This is for a good reason: it is the most frequently used DB update function,
1637 // so it has been optimised for speed.
f33e1ed4 1638 global $DB, $CFG, $USER;
9fa49e22 1639
7a5b1fc5 1640 if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
f78b3c34 1641 $cm = 0;
1642 }
1643
3d94772d 1644 if ($user) {
1645 $userid = $user;
1646 } else {
b7b64ff2 1647 if (session_is_loggedinas()) { // Don't log
3d94772d 1648 return;
1649 }
d4419d55 1650 $userid = empty($USER->id) ? '0' : $USER->id;
9fa49e22 1651 }
1652
f11f7b41
PS
1653 if (isset($CFG->logguests) and !$CFG->logguests) {
1654 if (!$userid or isguestuser($userid)) {
1655 return;
1656 }
1657 }
1658
fcaff7ff 1659 $REMOTE_ADDR = getremoteaddr();
1660
9fa49e22 1661 $timenow = time();
ac1ba33e 1662 $info = $info;
10a760b9 1663 if (!empty($url)) { // could break doing html_entity_decode on an empty var.
8082d3ab 1664 $url = html_entity_decode($url);
43b9db45
PS
1665 } else {
1666 $url = '';
10a760b9 1667 }
853df85e 1668
6c5a2108 1669 // Restrict length of log lines to the space actually available in the
1670 // database so that it doesn't cause a DB error. Log a warning so that
1671 // developers can avoid doing things which are likely to cause this on a
1672 // routine basis.
ac1ba33e 1673 $tl = textlib_get_instance();
6c5a2108 1674 if(!empty($info) && $tl->strlen($info)>255) {
ac1ba33e 1675 $info = $tl->substr($info,0,252).'...';
6c5a2108 1676 debugging('Warning: logged very long info',DEBUG_DEVELOPER);
1677 }
ac1ba33e 1678
6c5a2108 1679 // If the 100 field size is changed, also need to alter print_log in course/lib.php
1680 if(!empty($url) && $tl->strlen($url)>100) {
1681 $url=$tl->substr($url,0,97).'...';
1682 debugging('Warning: logged very long URL',DEBUG_DEVELOPER);
1683 }
8a445484 1684
f33e1ed4 1685 if (defined('MDL_PERFDB')) { global $PERF ; $PERF->logwrites++;};
853df85e 1686
f33e1ed4 1687 $log = array('time'=>$timenow, 'userid'=>$userid, 'course'=>$courseid, 'ip'=>$REMOTE_ADDR, 'module'=>$module,
1688 'cmid'=>$cm, 'action'=>$action, 'url'=>$url, 'info'=>$info);
9f064546 1689
8082d3ab
PS
1690 try {
1691 $DB->insert_record_raw('log', $log, false);
1692 } catch (dml_write_exception $e) {
252720c4 1693 debugging('Error: Could not insert a new entry to the Moodle log', DEBUG_ALL);
8082d3ab
PS
1694 // MDL-11893, alert $CFG->supportemail if insert into log failed
1695 if ($CFG->supportemail and empty($CFG->noemailever)) {
1696 // email_to_user is not usable because email_to_user tries to write to the logs table,
1697 // and this will get caught in an infinite loop, if disk is full
1698 $site = get_site();
1699 $subject = 'Insert into log failed at your moodle site '.$site->fullname;
1700 $message = "Insert into log table failed at ". date('l dS \of F Y h:i:s A') .".\n It is possible that your disk is full.\n\n";
1701 $message .= "The failed query parameters are:\n\n" . var_export($log, true);
1702
1703 $lasttime = get_config('admin', 'lastloginserterrormail');
1704 if(empty($lasttime) || time() - $lasttime > 60*60*24) { // limit to 1 email per day
d8f14128 1705 //using email directly rather than messaging as they may not be able to log in to access a message
8082d3ab
PS
1706 mail($CFG->supportemail, $subject, $message);
1707 set_config('lastloginserterrormail', time(), 'admin');
1708 }
1709 }
8f0cd6ef 1710 }
341b5ed2 1711}
1712
1713/**
1714 * Store user last access times - called when use enters a course or site
1715 *
3564771d 1716 * @global object
1717 * @global object
1718 * @global object
1719 * @uses LASTACCESS_UPDATE_SECS
1720 * @uses SITEID
341b5ed2 1721 * @param int $courseid, empty means site
1722 * @return void
1723 */
1724function user_accesstime_log($courseid=0) {
f33e1ed4 1725 global $USER, $CFG, $DB;
341b5ed2 1726
b7b64ff2 1727 if (!isloggedin() or session_is_loggedinas()) {
341b5ed2 1728 // no access tracking
1729 return;
1730 }
1731
1732 if (empty($courseid)) {
1733 $courseid = SITEID;
1734 }
1735
1736 $timenow = time();
1737
1738/// Store site lastaccess time for the current user
1739 if ($timenow - $USER->lastaccess > LASTACCESS_UPDATE_SECS) {
1740 /// Update $USER->lastaccess for next checks
1741 $USER->lastaccess = $timenow;
341b5ed2 1742
365a5941 1743 $last = new stdClass();
f33e1ed4 1744 $last->id = $USER->id;
1745 $last->lastip = getremoteaddr();
1746 $last->lastaccess = $timenow;
1747
68fbad44 1748 $DB->update_record_raw('user', $last);
341b5ed2 1749 }
1750
1751 if ($courseid == SITEID) {
1752 /// no user_lastaccess for frontpage
1753 return;
1754 }
cb8aaedf 1755
341b5ed2 1756/// Store course lastaccess times for the current user
1757 if (empty($USER->currentcourseaccess[$courseid]) or ($timenow - $USER->currentcourseaccess[$courseid] > LASTACCESS_UPDATE_SECS)) {
341b5ed2 1758
f33e1ed4 1759 $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id, 'courseid'=>$courseid));
341b5ed2 1760
f33e1ed4 1761 if ($lastaccess === false) {
1762 // Update course lastaccess for next checks
1763 $USER->currentcourseaccess[$courseid] = $timenow;
1764
365a5941 1765 $last = new stdClass();
f33e1ed4 1766 $last->userid = $USER->id;
1767 $last->courseid = $courseid;
1768 $last->timeaccess = $timenow;
68fbad44 1769 $DB->insert_record_raw('user_lastaccess', $last, false);
d251907c 1770
f33e1ed4 1771 } else if ($timenow - $lastaccess < LASTACCESS_UPDATE_SECS) {
1772 // no need to update now, it was updated recently in concurrent login ;-)
341b5ed2 1773
f33e1ed4 1774 } else {
1775 // Update course lastaccess for next checks
1776 $USER->currentcourseaccess[$courseid] = $timenow;
1777
68fbad44 1778 $DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id, 'courseid'=>$courseid));
3d94772d 1779 }
8f0cd6ef 1780 }
9fa49e22 1781}
1782
18a97fd8 1783/**
fbc21ae8 1784 * Select all log records based on SQL criteria
1785 *
3564771d 1786 * @todo Finish documenting this function
1787 *
1788 * @global object
fbc21ae8 1789 * @param string $select SQL select criteria
c3df0901 1790 * @param array $params named sql type params
fbc21ae8 1791 * @param string $order SQL order by clause to sort the records returned
1792 * @param string $limitfrom ?
1793 * @param int $limitnum ?
1794 * @param int $totalcount Passed in by reference.
7290c7fa 1795 * @return object
fbc21ae8 1796 */
c3df0901 1797function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
1798 global $DB;
9fa49e22 1799
519d369f 1800 if ($order) {
c3df0901 1801 $order = "ORDER BY $order";
1802 }
1803
1804 $selectsql = "";
1805 $countsql = "";
1806
1807 if ($select) {
1808 $select = "WHERE $select";
519d369f 1809 }
1810
c3df0901 1811 $sql = "SELECT COUNT(*)
1812 FROM {log} l
1813 $select";
1814
1815 $totalcount = $DB->count_records_sql($sql, $params);
a2ddd957 1816
c3df0901 1817 $sql = "SELECT l.*, u.firstname, u.lastname, u.picture
d251907c 1818 FROM {log} l
c3df0901 1819 LEFT JOIN {user} u ON l.userid = u.id
d251907c 1820 $select
c3df0901 1821 $order";
519d369f 1822
c3df0901 1823 return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum) ;
9fa49e22 1824}
1825
519d369f 1826
18a97fd8 1827/**
fbc21ae8 1828 * Select all log records for a given course and user
1829 *
3564771d 1830 * @todo Finish documenting this function
1831 *
1832 * @global object
2f87145b 1833 * @uses DAYSECS
fbc21ae8 1834 * @param int $userid The id of the user as found in the 'user' table.
1835 * @param int $courseid The id of the course as found in the 'course' table.
1836 * @param string $coursestart ?
fbc21ae8 1837 */
9fa49e22 1838function get_logs_usercourse($userid, $courseid, $coursestart) {
c3df0901 1839 global $DB;
9fa49e22 1840
c3df0901 1841 $params = array();
1842
1843 $courseselect = '';
da0c90c3 1844 if ($courseid) {
c3df0901 1845 $courseselect = "AND course = :courseid";
d251907c 1846 $params['courseid'] = $courseid;
da0c90c3 1847 }
c3df0901 1848 $params['userid'] = $userid;
51c3e855 1849 $$coursestart = (int)$coursestart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
da0c90c3 1850
51c3e855 1851 return $DB->get_records_sql("SELECT FLOOR((time - $coursestart)/". DAYSECS .") AS day, COUNT(*) AS num
c3df0901 1852 FROM {log}
1853 WHERE userid = :userid
51c3e855
PS
1854 AND time > $coursestart $courseselect
1855 GROUP BY FLOOR((time - $coursestart)/". DAYSECS .")", $params);
9fa49e22 1856}
1857
18a97fd8 1858/**
fbc21ae8 1859 * Select all log records for a given course, user, and day
1860 *
3564771d 1861 * @global object
2f87145b 1862 * @uses HOURSECS
fbc21ae8 1863 * @param int $userid The id of the user as found in the 'user' table.
1864 * @param int $courseid The id of the course as found in the 'course' table.
1865 * @param string $daystart ?
7290c7fa 1866 * @return object
fbc21ae8 1867 */
9fa49e22 1868function get_logs_userday($userid, $courseid, $daystart) {
c3df0901 1869 global $DB;
1870
51c3e855 1871 $params = array('userid'=>$userid);
9fa49e22 1872
c3df0901 1873 $courseselect = '';
7e4a6488 1874 if ($courseid) {
51c3e855
PS
1875 $courseselect = "AND course = :courseid";
1876 $params['courseid'] = $courseid;
7e4a6488 1877 }
51c3e855 1878 $daystart = (int)$daystart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
7e4a6488 1879
51c3e855 1880 return $DB->get_records_sql("SELECT FLOOR((time - $daystart)/". HOURSECS .") AS hour, COUNT(*) AS num
c3df0901 1881 FROM {log}
51c3e855
PS
1882 WHERE userid = :userid
1883 AND time > $daystart $courseselect
1884 GROUP BY FLOOR((time - $daystart)/". HOURSECS .") ", $params);
9fa49e22 1885}
1886
b4bac9b6 1887/**
1888 * Returns an object with counts of failed login attempts
1889 *
8f0cd6ef 1890 * Returns information about failed login attempts. If the current user is
1891 * an admin, then two numbers are returned: the number of attempts and the
b4bac9b6 1892 * number of accounts. For non-admins, only the attempts on the given user
1893 * are shown.
1894 *
3564771d 1895 * @global object
1896 * @uses CONTEXT_SYSTEM
4f0c2d00 1897 * @param string $mode Either 'admin' or 'everybody'
fbc21ae8 1898 * @param string $username The username we are searching for
1899 * @param string $lastlogin The date from which we are searching
1900 * @return int
b4bac9b6 1901 */
b4bac9b6 1902function count_login_failures($mode, $username, $lastlogin) {
c3df0901 1903 global $DB;
b4bac9b6 1904
c3df0901 1905 $params = array('mode'=>$mode, 'username'=>$username, 'lastlogin'=>$lastlogin);
1906 $select = "module='login' AND action='error' AND time > :lastlogin";
1907
365a5941 1908 $count = new stdClass();
b4bac9b6 1909
4f0c2d00 1910 if (is_siteadmin()) {
c3df0901 1911 if ($count->attempts = $DB->count_records_select('log', $select, $params)) {
1912 $count->accounts = $DB->count_records_select('log', $select, $params, 'COUNT(DISTINCT info)');
b4bac9b6 1913 return $count;
1914 }
4f0c2d00 1915 } else if ($mode == 'everybody') {
c3df0901 1916 if ($count->attempts = $DB->count_records_select('log', "$select AND info = :username", $params)) {
b4bac9b6 1917 return $count;
1918 }
1919 }
1920 return NULL;
1921}
1922
1923
a3fb1c45 1924/// GENERAL HELPFUL THINGS ///////////////////////////////////
1925
18a97fd8 1926/**
fbc21ae8 1927 * Dump a given object's information in a PRE block.
1928 *
1929 * Mostly just used for debugging.
1930 *
1931 * @param mixed $object The data to be printed
3564771d 1932 * @return void OUtput is echo'd
fbc21ae8 1933 */
a3fb1c45 1934function print_object($object) {
9f4ec46d
MD
1935 echo '<pre class="notifytiny">';
1936 print_r($object); // Direct to output because some objects get too big for memory otherwise!
1937 echo '</pre>';
a3fb1c45 1938}
1939
62d4e774 1940/**
5930cded 1941 * This function is the official hook inside XMLDB stuff to delegate its debug to one
62d4e774 1942 * external function.
1943 *
1944 * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
1945 * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
1946 *
3564771d 1947 * @uses DEBUG_DEVELOPER
1948 * @param string $message string contains the error message
1949 * @param object $object object XMLDB object that fired the debug
62d4e774 1950 */
1951function xmldb_debug($message, $object) {
1952
92b564f4 1953 debugging($message, DEBUG_DEVELOPER);
62d4e774 1954}
1955
49860445 1956/**
3564771d 1957 * @global object
1958 * @uses CONTEXT_COURSECAT
df73f8d4 1959 * @return boolean Whether the user can create courses in any category in the system.
49860445 1960 */
1961function user_can_create_courses() {
c3df0901 1962 global $DB;
df73f8d4 1963 $catsrs = $DB->get_recordset('course_categories');
4d55255b 1964 foreach ($catsrs as $cat) {
df73f8d4 1965 if (has_capability('moodle/course:create', get_context_instance(CONTEXT_COURSECAT, $cat->id))) {
1966 $catsrs->close();
1967 return true;
49860445 1968 }
1969 }
df73f8d4 1970 $catsrs->close();
1971 return false;
49860445 1972}