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