2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Library of functions for database manipulation.
20 * Other main libraries:
21 * - weblib.php - functions that produce web output
22 * - moodlelib.php - general-purpose Moodle functions
25 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29 defined('MOODLE_INTERNAL') ||
die();
32 * The maximum courses in a category
33 * MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
35 define('MAX_COURSES_IN_CATEGORY', 10000);
38 * The maximum number of course categories
39 * MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
41 define('MAX_COURSE_CATEGORIES', 10000);
44 * Number of seconds to wait before updating lastaccess information in DB.
46 * We allow overwrites from config.php, useful to ensure coherence in performance
49 if (!defined('LASTACCESS_UPDATE_SECS')) {
50 define('LASTACCESS_UPDATE_SECS', 60);
54 * Returns $user object of the main admin user
56 * @static stdClass $mainadmin
57 * @return stdClass {@link $USER} record from DB, false if not found
59 function get_admin() {
62 static $mainadmin = null;
63 static $prevadmins = null;
65 if (empty($CFG->siteadmins
)) {
66 // Should not happen on an ordinary site.
67 // It does however happen during unit tests.
71 if (isset($mainadmin) and $prevadmins === $CFG->siteadmins
) {
72 return clone($mainadmin);
77 foreach (explode(',', $CFG->siteadmins
) as $id) {
78 if ($user = $DB->get_record('user', array('id'=>$id, 'deleted'=>0))) {
85 $prevadmins = $CFG->siteadmins
;
86 return clone($mainadmin);
88 // this should not happen
94 * Returns list of all admins, using 1 DB query
98 function get_admins() {
101 if (empty($CFG->siteadmins
)) { // Should not happen on an ordinary site
107 WHERE u.deleted = 0 AND u.id IN ($CFG->siteadmins)";
109 // We want the same order as in $CFG->siteadmins.
110 $records = $DB->get_records_sql($sql);
112 foreach (explode(',', $CFG->siteadmins
) as $id) {
114 if (!isset($records[$id])) {
115 // User does not exist, this should not happen.
118 $admins[$records[$id]->id
] = $records[$id];
125 * Search through course users
127 * If $coursid specifies the site course then this function searches
128 * through all undeleted and confirmed users
132 * @uses SQL_PARAMS_NAMED
133 * @uses CONTEXT_COURSE
134 * @param int $courseid The course in question.
135 * @param int $groupid The group in question.
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
141 function search_users($courseid, $groupid, $searchtext, $sort='', array $exceptions=null) {
144 $fullname = $DB->sql_fullname('u.firstname', 'u.lastname');
146 if (!empty($exceptions)) {
147 list($exceptions, $params) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED
, 'ex', false);
148 $except = "AND u.id $exceptions";
155 $order = "ORDER BY $sort";
160 $select = "u.deleted = 0 AND u.confirmed = 1 AND (".$DB->sql_like($fullname, ':search1', false)." OR ".$DB->sql_like('u.email', ':search2', false).")";
161 $params['search1'] = "%$searchtext%";
162 $params['search2'] = "%$searchtext%";
164 if (!$courseid or $courseid == SITEID
) {
165 $sql = "SELECT u.id, u.firstname, u.lastname, u.email
170 return $DB->get_records_sql($sql, $params);
174 $sql = "SELECT u.id, u.firstname, u.lastname, u.email
176 JOIN {groups_members} gm ON gm.userid = u.id
177 WHERE $select AND gm.groupid = :groupid
180 $params['groupid'] = $groupid;
181 return $DB->get_records_sql($sql, $params);
184 $context = context_course
::instance($courseid);
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');
189 $sql = "SELECT u.id, u.firstname, u.lastname, u.email
191 JOIN {role_assignments} ra ON ra.userid = u.id
192 WHERE $select AND ra.contextid $relatedctxsql
195 $params = array_merge($params, $relatedctxparams);
196 return $DB->get_records_sql($sql, $params);
202 * Returns SQL used to search through user table to find users (in a query
203 * which may also join and apply other conditions).
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.
211 * There are examples of basic usage in the unit test for this function.
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
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).
226 function users_search_sql($search, $u = 'u', $searchanywhere = true, array $extrafields = array(),
227 array $exclude = null, array $includeonly = null) {
236 // If we have a $search string, put a field LIKE '$search%' condition on each field.
239 $DB->sql_fullname($u . 'firstname', $u . 'lastname'),
240 $conditions[] = $u . 'lastname'
242 foreach ($extrafields as $field) {
243 $conditions[] = $u . $field;
245 if ($searchanywhere) {
246 $searchparam = '%' . $search . '%';
248 $searchparam = $search . '%';
251 foreach ($conditions as $key => $condition) {
252 $conditions[$key] = $DB->sql_like($condition, ":con{$i}00", false, false);
253 $params["con{$i}00"] = $searchparam;
256 $tests[] = '(' . implode(' OR ', $conditions) . ')';
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';
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);
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);
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).
285 // Combing the conditions and return.
286 return array(implode(' AND ', $tests), $params);
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.
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.)
301 * The list of fields scanned for exact matches are:
304 * - $DB->sql_fullname
305 * - those returned by get_extra_user_fields
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.
310 * The simplest possible example use is:
311 * list($sort, $params) = users_order_by_sql();
312 * $sql = 'SELECT * FROM {users} ORDER BY ' . $sort;
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
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;
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);
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.
340 function users_order_by_sql($usertablealias = '', $search = null, context
$context = null) {
343 if ($usertablealias) {
344 $tableprefix = $usertablealias . '.';
349 $sort = "{$tableprefix}lastname, {$tableprefix}firstname, {$tableprefix}id";
353 return array($sort, $params);
357 $context = $PAGE->context
;
360 $exactconditions = array();
361 $paramkey = 'usersortexact1';
363 $exactconditions[] = $DB->sql_fullname($tableprefix . 'firstname', $tableprefix . 'lastname') .
365 $params[$paramkey] = $search;
368 $fieldstocheck = array_merge(array('firstname', 'lastname'), get_extra_user_fields($context));
369 foreach ($fieldstocheck as $key => $field) {
370 $exactconditions[] = 'LOWER(' . $tableprefix . $field . ') = LOWER(:' . $paramkey . ')';
371 $params[$paramkey] = $search;
375 $sort = 'CASE WHEN ' . implode(' OR ', $exactconditions) .
376 ' THEN 0 ELSE 1 END, ' . $sort;
378 return array($sort, $params);
382 * Returns a subset of users
385 * @uses DEBUG_DEVELOPER
386 * @uses SQL_PARAMS_NAMED
387 * @param bool $get If false then only a count of the records is returned
388 * @param string $search A simple string to search for
389 * @param bool $confirmed A switch to allow/disallow unconfirmed users
390 * @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
391 * @param string $sort A SQL snippet for the sorting criteria to use
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
396 * @param string $fields A comma separated list of fields to be returned from the chosen table.
397 * @return array|int|bool {@link $USER} records unless get is false in which case the integer count of the records found is returned.
398 * False is returned if an error is encountered.
400 function get_users($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC',
401 $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*', $extraselect='', array $extraparams=null) {
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 ' .
408 'load so much data into memory.', DEBUG_DEVELOPER
);
411 $fullname = $DB->sql_fullname();
413 $select = " id <> :guestid AND deleted = 0";
414 $params = array('guestid'=>$CFG->siteguest
);
416 if (!empty($search)){
417 $search = trim($search);
418 $select .= " AND (".$DB->sql_like($fullname, ':search1', false)." OR ".$DB->sql_like('email', ':search2', false)." OR username = :search3)";
419 $params['search1'] = "%$search%";
420 $params['search2'] = "%$search%";
421 $params['search3'] = "$search";
425 $select .= " AND confirmed = 1";
429 list($exceptions, $eparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED
, 'ex', false);
430 $params = $params +
$eparams;
431 $select .= " AND id $exceptions";
435 $select .= " AND ".$DB->sql_like('firstname', ':fni', false, false);
436 $params['fni'] = "$firstinitial%";
439 $select .= " AND ".$DB->sql_like('lastname', ':lni', false, false);
440 $params['lni'] = "$lastinitial%";
444 $select .= " AND $extraselect";
445 $params = $params +
(array)$extraparams;
449 return $DB->get_records_select('user', $select, $params, $sort, $fields, $page, $recordsperpage);
451 return $DB->count_records_select('user', $select, $params);
457 * Return filtered (if provided) list of users in site, except guest and deleted users.
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
468 * @param stdClass $extracontext If specified, will include user 'extra fields'
469 * as appropriate for current user and given context
470 * @return array Array of {@link $USER} records
472 function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
473 $search='', $firstinitial='', $lastinitial='', $extraselect='',
474 array $extraparams=null, $extracontext = null) {
477 $fullname = $DB->sql_fullname();
479 $select = "deleted <> 1 AND id <> :guestid";
480 $params = array('guestid' => $CFG->siteguest
);
482 if (!empty($search)) {
483 $search = trim($search);
484 $select .= " AND (". $DB->sql_like($fullname, ':search1', false, false).
485 " OR ". $DB->sql_like('email', ':search2', false, false).
486 " OR username = :search3)";
487 $params['search1'] = "%$search%";
488 $params['search2'] = "%$search%";
489 $params['search3'] = "$search";
493 $select .= " AND ". $DB->sql_like('firstname', ':fni', false, false);
494 $params['fni'] = "$firstinitial%";
497 $select .= " AND ". $DB->sql_like('lastname', ':lni', false, false);
498 $params['lni'] = "$lastinitial%";
502 $select .= " AND $extraselect";
503 $params = $params +
(array)$extraparams;
507 $sort = " ORDER BY $sort $dir";
510 // If a context is specified, get extra user fields that the current user
511 // is supposed to see.
514 $extrafields = get_extra_user_fields_sql($extracontext, '', '',
515 array('id', 'username', 'email', 'firstname', 'lastname', 'city', 'country',
516 'lastaccess', 'confirmed', 'mnethostid'));
518 $namefields = get_all_user_name_fields(true);
519 $extrafields = "$extrafields, $namefields";
521 // warning: will return UNCONFIRMED USERS
522 return $DB->get_records_sql("SELECT id, username, email, city, country, lastaccess, confirmed, mnethostid, suspended $extrafields
525 $sort", $params, $page, $recordsperpage);
531 * Full list of users that have confirmed their accounts.
534 * @return array of unconfirmed users
536 function get_users_confirmed() {
538 return $DB->get_records_sql("SELECT *
540 WHERE confirmed = 1 AND deleted = 0 AND id <> ?", array($CFG->siteguest
));
544 /// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
548 * Returns $course object of the top-level site.
550 * @return object A {@link $COURSE} object for the site, exception if not found
552 function get_site() {
555 if (!empty($SITE->id
)) { // We already have a global to use, so return that
559 if ($course = $DB->get_record('course', array('category'=>0))) {
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');
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.
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.
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
581 function 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;
588 return $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST
);
593 * Returns list of courses, for whole site, or category
595 * Returns list of courses, for whole site, or category
596 * Important: Using c.* for fields is extremely expensive because
597 * we are using distinct. You almost _NEVER_ need all the fields
598 * in such a large SELECT
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
609 function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
611 global $USER, $CFG, $DB;
615 if ($categoryid !== "all" && is_numeric($categoryid)) {
616 $categoryselect = "WHERE c.category = :catid";
617 $params['catid'] = $categoryid;
619 $categoryselect = "";
625 $sortstatement = "ORDER BY $sort";
628 $visiblecourses = array();
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
;
634 $sql = "SELECT $fields $ccselect
640 // pull out all course matching the cat
641 if ($courses = $DB->get_records_sql($sql, $params)) {
643 // loop throught them
644 foreach ($courses as $course) {
645 context_helper
::preload_from_record($course);
646 if (isset($course->visible
) && $course->visible
<= 0) {
647 // for hidden courses, require visibility check
648 if (has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
649 $visiblecourses [$course->id
] = $course;
652 $visiblecourses [$course->id
] = $course;
656 return $visiblecourses;
661 * Returns list of courses, for whole site, or category
663 * Similar to get_courses, but allows paging
664 * Important: Using c.* for fields is extremely expensive because
665 * we are using distinct. You almost _NEVER_ need all the fields
666 * in such a large SELECT
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
678 * @return array Array of courses
680 function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
681 &$totalcount, $limitfrom="", $limitnum="") {
682 global $USER, $CFG, $DB;
686 $categoryselect = "";
687 if ($categoryid !== "all" && is_numeric($categoryid)) {
688 $categoryselect = "WHERE c.category = :catid";
689 $params['catid'] = $categoryid;
691 $categoryselect = "";
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
;
702 $visiblecourses = array();
704 $sql = "SELECT $fields $ccselect
710 // pull out all course matching the cat
711 $rs = $DB->get_recordset_sql($sql, $params);
712 // iteration will have to be done inside loop to keep track of the limitfrom and limitnum
713 foreach($rs as $course) {
714 context_helper
::preload_from_record($course);
715 if ($course->visible
<= 0) {
716 // for hidden courses, require visibility check
717 if (has_capability('moodle/course:viewhiddencourses', context_course
::instance($course->id
))) {
719 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
720 $visiblecourses [$course->id
] = $course;
725 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
726 $visiblecourses [$course->id
] = $course;
731 return $visiblecourses;
735 * A list of courses that match a search
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.
744 * @param array $requiredcapabilities Extra list of capabilities used to filter courses
745 * @return object {@link $COURSE} records
747 function get_courses_search($searchterms, $sort, $page, $recordsperpage, &$totalcount,
748 $requiredcapabilities = array()) {
751 if ($DB->sql_regex_supported()) {
752 $REGEXP = $DB->sql_regex(true);
753 $NOTREGEXP = $DB->sql_regex(false);
756 $searchcond = array();
760 // Thanks Oracle for your non-ansi concat and type limits in coalesce. MDL-29912
761 if ($DB->get_dbfamily() == 'oracle') {
762 $concat = "(c.summary|| ' ' || c.fullname || ' ' || c.idnumber || ' ' || c.shortname)";
764 $concat = $DB->sql_concat("COALESCE(c.summary, '')", "' '", 'c.fullname', "' '", 'c.idnumber', "' '", 'c.shortname');
767 foreach ($searchterms as $searchterm) {
770 $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
771 /// will use it to simulate the "-" operator with LIKE clause
773 /// Under Oracle and MSSQL, trim the + and - operators and perform
774 /// simpler LIKE (or NOT LIKE) queries
775 if (!$DB->sql_regex_supported()) {
776 if (substr($searchterm, 0, 1) == '-') {
779 $searchterm = trim($searchterm, '+-');
782 // TODO: +- may not work for non latin languages
784 if (substr($searchterm,0,1) == '+') {
785 $searchterm = trim($searchterm, '+-');
786 $searchterm = preg_quote($searchterm, '|');
787 $searchcond[] = "$concat $REGEXP :ss$i";
788 $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
790 } else if ((substr($searchterm,0,1) == "-") && (core_text
::strlen($searchterm) > 1)) {
791 $searchterm = trim($searchterm, '+-');
792 $searchterm = preg_quote($searchterm, '|');
793 $searchcond[] = "$concat $NOTREGEXP :ss$i";
794 $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
797 $searchcond[] = $DB->sql_like($concat,":ss$i", false, true, $NOT);
798 $params['ss'.$i] = "%$searchterm%";
802 if (empty($searchcond)) {
803 $searchcond = array('1 = 1');
806 $searchcond = implode(" AND ", $searchcond);
809 $c = 0; // counts how many visible courses we've seen
812 $limitfrom = $page * $recordsperpage;
813 $limitto = $limitfrom +
$recordsperpage;
815 $ccselect = ', ' . context_helper
::get_preload_record_columns_sql('ctx');
816 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
817 $params['contextlevel'] = CONTEXT_COURSE
;
819 $sql = "SELECT c.* $ccselect
822 WHERE $searchcond AND c.id <> ".SITEID
."
825 $rs = $DB->get_recordset_sql($sql, $params);
826 foreach($rs as $course) {
827 // Preload contexts only for hidden courses or courses we need to return.
828 context_helper
::preload_from_record($course);
829 $coursecontext = context_course
::instance($course->id
);
830 if (!$course->visible
&& !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
833 if (!empty($requiredcapabilities)) {
834 if (!has_all_capabilities($requiredcapabilities, $coursecontext)) {
838 // Don't exit this loop till the end
839 // we need to count all the visible courses
840 // to update $totalcount
841 if ($c >= $limitfrom && $c < $limitto) {
842 $courses[$course->id
] = $course;
848 // our caller expects 2 bits of data - our return
849 // array, and an updated $totalcount
855 * Fixes course category and course sortorder, also verifies category and course parents and paths.
856 * (circular references are not fixed)
860 * @uses MAX_COURSES_IN_CATEGORY
861 * @uses MAX_COURSE_CATEGORIES
863 * @uses CONTEXT_COURSE
866 function fix_course_sortorder() {
869 //WARNING: this is PHP5 only code!
871 // if there are any changes made to courses or categories we will trigger
872 // the cache events to purge all cached courses/categories data
873 $cacheevents = array();
875 if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
876 //move all categories that are not sorted yet to the end
877 $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY
*MAX_COURSE_CATEGORIES
, array('sortorder'=>0));
878 $cacheevents['changesincoursecat'] = true;
881 $allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
883 $brokencats = array();
884 foreach ($allcats as $cat) {
885 $sortorder = (int)$cat->sortorder
;
887 while(isset($topcats[$sortorder])) {
890 $topcats[$sortorder] = $cat;
893 if (!isset($allcats[$cat->parent
])) {
894 $brokencats[] = $cat;
897 if (!isset($allcats[$cat->parent
]->children
)) {
898 $allcats[$cat->parent
]->children
= array();
900 while(isset($allcats[$cat->parent
]->children
[$sortorder])) {
903 $allcats[$cat->parent
]->children
[$sortorder] = $cat;
907 // add broken cats to category tree
909 $defaultcat = reset($topcats);
910 foreach ($brokencats as $cat) {
915 // now walk recursively the tree and fix any problems found
917 $fixcontexts = array();
918 if (_fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts)) {
919 $cacheevents['changesincoursecat'] = true;
922 // detect if there are "multiple" frontpage courses and fix them if needed
923 $frontcourses = $DB->get_records('course', array('category'=>0), 'id');
924 if (count($frontcourses) > 1) {
925 if (isset($frontcourses[SITEID
])) {
926 $frontcourse = $frontcourses[SITEID
];
927 unset($frontcourses[SITEID
]);
929 $frontcourse = array_shift($frontcourses);
931 $defaultcat = reset($topcats);
932 foreach ($frontcourses as $course) {
933 $DB->set_field('course', 'category', $defaultcat->id
, array('id'=>$course->id
));
934 $context = context_course
::instance($course->id
);
935 $fixcontexts[$context->id
] = $context;
936 $cacheevents['changesincourse'] = true;
938 unset($frontcourses);
940 $frontcourse = reset($frontcourses);
943 // now fix the paths and depths in context table if needed
945 foreach ($fixcontexts as $fixcontext) {
946 $fixcontext->reset_paths(false);
948 context_helper
::build_all_paths(false);
950 $cacheevents['changesincourse'] = true;
951 $cacheevents['changesincoursecat'] = true;
959 // fix frontpage course sortorder
960 if ($frontcourse->sortorder
!= 1) {
961 $DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id
));
962 $cacheevents['changesincourse'] = true;
965 // now fix the course counts in category records if needed
966 $sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
967 FROM {course_categories} cc
968 LEFT JOIN {course} c ON c.category = cc.id
969 GROUP BY cc.id, cc.coursecount
970 HAVING cc.coursecount <> COUNT(c.id)";
972 if ($updatecounts = $DB->get_records_sql($sql)) {
973 // categories with more courses than MAX_COURSES_IN_CATEGORY
974 $categories = array();
975 foreach ($updatecounts as $cat) {
976 $cat->coursecount
= $cat->newcount
;
977 if ($cat->coursecount
>= MAX_COURSES_IN_CATEGORY
) {
978 $categories[] = $cat->id
;
980 unset($cat->newcount
);
981 $DB->update_record_raw('course_categories', $cat, true);
983 if (!empty($categories)) {
984 $str = implode(', ', $categories);
985 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
);
987 $cacheevents['changesincoursecat'] = true;
990 // now make sure that sortorders in course table are withing the category sortorder ranges
991 $sql = "SELECT DISTINCT cc.id, cc.sortorder
992 FROM {course_categories} cc
993 JOIN {course} c ON c.category = cc.id
994 WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY
;
996 if ($fixcategories = $DB->get_records_sql($sql)) {
997 //fix the course sortorder ranges
998 foreach ($fixcategories as $cat) {
999 $sql = "UPDATE {course}
1000 SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY
)." + ?
1001 WHERE category = ?";
1002 $DB->execute($sql, array($cat->sortorder
, $cat->id
));
1004 $cacheevents['changesincoursecat'] = true;
1006 unset($fixcategories);
1008 // categories having courses with sortorder duplicates or having gaps in sortorder
1009 $sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
1011 JOIN {course} c2 ON c1.sortorder = c2.sortorder
1012 JOIN {course_categories} cc ON (c1.category = cc.id)
1013 WHERE c1.id <> c2.id";
1014 $fixcategories = $DB->get_records_sql($sql);
1016 $sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
1017 FROM {course_categories} cc
1018 JOIN {course} c ON c.category = cc.id
1019 GROUP BY cc.id, cc.sortorder, cc.coursecount
1020 HAVING (MAX(c.sortorder) <> cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <> cc.sortorder + 1)";
1021 $gapcategories = $DB->get_records_sql($sql);
1023 foreach ($gapcategories as $cat) {
1024 if (isset($fixcategories[$cat->id
])) {
1025 // duplicates detected already
1027 } else if ($cat->minsort
== $cat->sortorder
and $cat->maxsort
== $cat->sortorder +
$cat->coursecount
- 1) {
1028 // easy - new course inserted with sortorder 0, the rest is ok
1029 $sql = "UPDATE {course}
1030 SET sortorder = sortorder + 1
1031 WHERE category = ?";
1032 $DB->execute($sql, array($cat->id
));
1035 // it needs full resorting
1036 $fixcategories[$cat->id
] = $cat;
1038 $cacheevents['changesincourse'] = true;
1040 unset($gapcategories);
1042 // fix course sortorders in problematic categories only
1043 foreach ($fixcategories as $cat) {
1045 $courses = $DB->get_records('course', array('category'=>$cat->id
), 'sortorder ASC, id DESC', 'id, sortorder');
1046 foreach ($courses as $course) {
1047 if ($course->sortorder
!= $cat->sortorder +
$i) {
1048 $course->sortorder
= $cat->sortorder +
$i;
1049 $DB->update_record_raw('course', $course, true);
1050 $cacheevents['changesincourse'] = true;
1056 // advise all caches that need to be rebuilt
1057 foreach (array_keys($cacheevents) as $event) {
1058 cache_helper
::purge_by_event($event);
1063 * Internal recursive category verification function, do not use directly!
1065 * @todo Document the arguments of this function better
1068 * @uses MAX_COURSES_IN_CATEGORY
1069 * @uses CONTEXT_COURSECAT
1070 * @param array $children
1071 * @param int $sortorder
1072 * @param string $parent
1074 * @param string $path
1075 * @param array $fixcontexts
1076 * @return bool if changes were made
1078 function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
1082 $changesmade = false;
1084 foreach ($children as $cat) {
1085 $sortorder = $sortorder + MAX_COURSES_IN_CATEGORY
;
1087 if ($parent != $cat->parent
or $depth != $cat->depth
or $path.'/'.$cat->id
!= $cat->path
) {
1088 $cat->parent
= $parent;
1089 $cat->depth
= $depth;
1090 $cat->path
= $path.'/'.$cat->id
;
1093 // make sure context caches are rebuild and dirty contexts marked
1094 $context = context_coursecat
::instance($cat->id
);
1095 $fixcontexts[$context->id
] = $context;
1097 if ($cat->sortorder
!= $sortorder) {
1098 $cat->sortorder
= $sortorder;
1102 $DB->update_record('course_categories', $cat, true);
1103 $changesmade = true;
1105 if (isset($cat->children
)) {
1106 if (_fix_course_cats($cat->children
, $sortorder, $cat->id
, $cat->depth
, $cat->path
, $fixcontexts)) {
1107 $changesmade = true;
1111 return $changesmade;
1115 * List of remote courses that a user has access to via MNET.
1116 * Works only on the IDP
1120 * @param int @userid The user id to get remote courses for
1121 * @return array Array of {@link $COURSE} of course objects
1123 function get_my_remotecourses($userid=0) {
1126 if (empty($userid)) {
1127 $userid = $USER->id
;
1130 // we can not use SELECT DISTINCT + text field (summary) because of MS SQL and Oracle, subselect used therefore
1131 $sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
1132 c.hostid, c.summary, c.summaryformat, c.categoryname AS cat_name,
1134 FROM {mnetservice_enrol_courses} c
1135 JOIN (SELECT DISTINCT hostid, remotecourseid
1136 FROM {mnetservice_enrol_enrolments}
1138 ) e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
1139 JOIN {mnet_host} h ON h.id = c.hostid";
1141 return $DB->get_records_sql($sql, array($userid));
1145 * List of remote hosts that a user has access to via MNET.
1150 * @return array|bool Array of host objects or false
1152 function get_my_remotehosts() {
1155 if ($USER->mnethostid
== $CFG->mnet_localhost_id
) {
1156 return false; // Return nothing on the IDP
1158 if (!empty($USER->mnet_foreign_host_array
) && is_array($USER->mnet_foreign_host_array
)) {
1159 return $USER->mnet_foreign_host_array
;
1166 * Returns a menu of all available scales from the site as well as the given course
1169 * @param int $courseid The id of the course as found in the 'course' table.
1172 function get_scales_menu($courseid=0) {
1175 $sql = "SELECT id, name
1177 WHERE courseid = 0 or courseid = ?
1178 ORDER BY courseid ASC, name ASC";
1179 $params = array($courseid);
1181 return $scales = $DB->get_records_sql_menu($sql, $params);
1185 * Increment standard revision field.
1187 * The revision are based on current time and are incrementing.
1188 * There is a protection for runaway revisions, it may not go further than
1189 * one hour into future.
1191 * The field has to be XMLDB_TYPE_INTEGER with size 10.
1193 * @param string $table
1194 * @param string $field name of the field containing revision
1195 * @param string $select use empty string when updating all records
1196 * @param array $params optional select parameters
1198 function increment_revision_number($table, $field, $select, array $params = null) {
1202 $sql = "UPDATE {{$table}}
1204 WHEN $field IS NULL THEN $now
1205 WHEN $field < $now THEN $now
1206 WHEN $field > $now + 3600 THEN $now
1207 ELSE $field + 1 END)";
1209 $sql = $sql . " WHERE $select";
1211 $DB->execute($sql, $params);
1215 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1218 * Just gets a raw list of all modules in a course
1221 * @param int $courseid The id of the course as found in the 'course' table.
1224 function get_course_mods($courseid) {
1227 if (empty($courseid)) {
1228 return false; // avoid warnings
1231 return $DB->get_records_sql("SELECT cm.*, m.name as modname
1232 FROM {modules} m, {course_modules} cm
1233 WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
1234 array($courseid)); // no disabled mods
1239 * Given an id of a course module, finds the coursemodule description
1241 * Please note that this function performs 1-2 DB queries. When possible use cached
1242 * course modinfo. For example get_fast_modinfo($courseorid)->get_cm($cmid)
1243 * See also {@link cm_info::get_course_module_record()}
1246 * @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
1247 * @param int $cmid course module id (id in course_modules table)
1248 * @param int $courseid optional course id for extra validation
1249 * @param bool $sectionnum include relative section number (0,1,2 ...)
1250 * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1251 * IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1252 * MUST_EXIST means throw exception if no record or multiple records found
1255 function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING
) {
1258 $params = array('cmid'=>$cmid);
1261 if (!$modulename = $DB->get_field_sql("SELECT md.name
1263 JOIN {course_modules} cm ON cm.module = md.id
1264 WHERE cm.id = :cmid", $params, $strictness)) {
1268 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
1269 throw new coding_exception('Invalid modulename parameter');
1273 $params['modulename'] = $modulename;
1280 $courseselect = "AND cm.course = :courseid";
1281 $params['courseid'] = $courseid;
1285 $sectionfield = ", cw.section AS sectionnum";
1286 $sectionjoin = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1289 $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1290 FROM {course_modules} cm
1291 JOIN {modules} md ON md.id = cm.module
1292 JOIN {".$modulename."} m ON m.id = cm.instance
1294 WHERE cm.id = :cmid AND md.name = :modulename
1297 return $DB->get_record_sql($sql, $params, $strictness);
1301 * Given an instance number of a module, finds the coursemodule description
1303 * Please note that this function performs DB query. When possible use cached course
1304 * modinfo. For example get_fast_modinfo($courseorid)->instances[$modulename][$instance]
1305 * See also {@link cm_info::get_course_module_record()}
1308 * @param string $modulename name of module type, eg. resource, assignment,...
1309 * @param int $instance module instance number (id in resource, assignment etc. table)
1310 * @param int $courseid optional course id for extra validation
1311 * @param bool $sectionnum include relative section number (0,1,2 ...)
1312 * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1313 * IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1314 * MUST_EXIST means throw exception if no record or multiple records found
1317 function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING
) {
1320 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
1321 throw new coding_exception('Invalid modulename parameter');
1324 $params = array('instance'=>$instance, 'modulename'=>$modulename);
1331 $courseselect = "AND cm.course = :courseid";
1332 $params['courseid'] = $courseid;
1336 $sectionfield = ", cw.section AS sectionnum";
1337 $sectionjoin = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1340 $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1341 FROM {course_modules} cm
1342 JOIN {modules} md ON md.id = cm.module
1343 JOIN {".$modulename."} m ON m.id = cm.instance
1345 WHERE m.id = :instance AND md.name = :modulename
1348 return $DB->get_record_sql($sql, $params, $strictness);
1352 * Returns all course modules of given activity in course
1354 * @param string $modulename The module name (forum, quiz, etc.)
1355 * @param int $courseid The course id to get modules for
1356 * @param string $extrafields extra fields starting with m.
1357 * @return array Array of results
1359 function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
1362 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
1363 throw new coding_exception('Invalid modulename parameter');
1366 if (!empty($extrafields)) {
1367 $extrafields = ", $extrafields";
1370 $params['courseid'] = $courseid;
1371 $params['modulename'] = $modulename;
1374 return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
1375 FROM {course_modules} cm, {modules} md, {".$modulename."} m
1376 WHERE cm.course = :courseid AND
1377 cm.instance = m.id AND
1378 md.name = :modulename AND
1379 md.id = cm.module", $params);
1383 * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1385 * Returns an array of all the active instances of a particular
1386 * module in given courses, sorted in the order they are defined
1387 * in the course. Returns an empty array on any errors.
1389 * The returned objects includle the columns cw.section, cm.visible,
1390 * cm.groupmode, and cm.groupingid, and are indexed by cm.id.
1394 * @param string $modulename The name of the module to get instances for
1395 * @param array $courses an array of course objects.
1396 * @param int $userid
1397 * @param int $includeinvisible
1398 * @return array of module instance objects, including some extra fields from the course_modules
1399 * and course_sections tables, or an empty array if an error occurred.
1401 function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
1404 if (!core_component
::is_valid_plugin_name('mod', $modulename)) {
1405 throw new coding_exception('Invalid modulename parameter');
1408 $outputarray = array();
1410 if (empty($courses) ||
!is_array($courses) ||
count($courses) == 0) {
1411 return $outputarray;
1414 list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED
, 'c0');
1415 $params['modulename'] = $modulename;
1417 if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
1418 cm.groupmode, cm.groupingid
1419 FROM {course_modules} cm, {course_sections} cw, {modules} md,
1421 WHERE cm.course $coursessql AND
1422 cm.instance = m.id AND
1423 cm.section = cw.id AND
1424 md.name = :modulename AND
1425 md.id = cm.module", $params)) {
1426 return $outputarray;
1429 foreach ($courses as $course) {
1430 $modinfo = get_fast_modinfo($course, $userid);
1432 if (empty($modinfo->instances
[$modulename])) {
1436 foreach ($modinfo->instances
[$modulename] as $cm) {
1437 if (!$includeinvisible and !$cm->uservisible
) {
1440 if (!isset($rawmods[$cm->id
])) {
1443 $instance = $rawmods[$cm->id
];
1444 if (!empty($cm->extra
)) {
1445 $instance->extra
= $cm->extra
;
1447 $outputarray[] = $instance;
1451 return $outputarray;
1455 * Returns an array of all the active instances of a particular module in a given course,
1456 * sorted in the order they are defined.
1458 * Returns an array of all the active instances of a particular
1459 * module in a given course, sorted in the order they are defined
1460 * in the course. Returns an empty array on any errors.
1462 * The returned objects includle the columns cw.section, cm.visible,
1463 * cm.groupmode, and cm.groupingid, and are indexed by cm.id.
1465 * Simply calls {@link all_instances_in_courses()} with a single provided course
1467 * @param string $modulename The name of the module to get instances for
1468 * @param object $course The course obect.
1469 * @return array of module instance objects, including some extra fields from the course_modules
1470 * and course_sections tables, or an empty array if an error occurred.
1471 * @param int $userid
1472 * @param int $includeinvisible
1474 function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
1475 return get_all_instances_in_courses($modulename, array($course->id
=> $course), $userid, $includeinvisible);
1480 * Determine whether a module instance is visible within a course
1482 * Given a valid module object with info about the id and course,
1483 * and the module's type (eg "forum") returns whether the object
1484 * is visible or not according to the 'eye' icon only.
1486 * NOTE: This does NOT take into account visibility to a particular user.
1487 * To get visibility access for a specific user, use get_fast_modinfo, get a
1488 * cm_info object from this, and check the ->uservisible property; or use
1489 * the \core_availability\info_module::is_user_visible() static function.
1493 * @param $moduletype Name of the module eg 'forum'
1494 * @param $module Object which is the instance of the module
1495 * @return bool Success
1497 function instance_is_visible($moduletype, $module) {
1500 if (!empty($module->id
)) {
1501 $params = array('courseid'=>$module->course
, 'moduletype'=>$moduletype, 'moduleid'=>$module->id
);
1502 if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.course
1503 FROM {course_modules} cm, {modules} m
1504 WHERE cm.course = :courseid AND
1505 cm.module = m.id AND
1506 m.name = :moduletype AND
1507 cm.instance = :moduleid", $params)) {
1509 foreach ($records as $record) { // there should only be one - use the first one
1510 return $record->visible
;
1514 return true; // visible by default!
1518 /// LOG FUNCTIONS /////////////////////////////////////////////////////
1521 * Get instance of log manager.
1523 * @param bool $forcereload
1524 * @return \core\log\manager
1526 function get_log_manager($forcereload = false) {
1527 /** @var \core\log\manager $singleton */
1528 static $singleton = null;
1530 if ($forcereload and isset($singleton)) {
1531 $singleton->dispose();
1535 if (isset($singleton)) {
1539 $classname = '\tool_log\log\manager';
1540 if (defined('LOG_MANAGER_CLASS')) {
1541 $classname = LOG_MANAGER_CLASS
;
1544 if (!class_exists($classname)) {
1545 if (!empty($classname)) {
1546 debugging("Cannot find log manager class '$classname'.", DEBUG_DEVELOPER
);
1548 $classname = '\core\log\dummy_manager';
1551 $singleton = new $classname();
1556 * Add an entry to the config log table.
1558 * These are "action" focussed rather than web server hits,
1559 * and provide a way to easily reconstruct changes to Moodle configuration.
1563 * @global moodle_database $DB
1564 * @global stdClass $USER
1565 * @param string $name The name of the configuration change action
1566 For example 'filter_active' when activating or deactivating a filter
1567 * @param string $oldvalue The config setting's previous value
1568 * @param string $value The config setting's new value
1569 * @param string $plugin Plugin name, for example a filter name when changing filter configuration
1572 function add_to_config_log($name, $oldvalue, $value, $plugin) {
1575 $log = new stdClass();
1576 // Use 0 as user id during install.
1577 $log->userid
= during_initial_install() ?
0 : $USER->id
;
1578 $log->timemodified
= time();
1580 $log->oldvalue
= $oldvalue;
1581 $log->value
= $value;
1582 $log->plugin
= $plugin;
1584 $id = $DB->insert_record('config_log', $log);
1586 $event = core\event\config_log_created
::create(array(
1588 'userid' => $log->userid
,
1589 'context' => \context_system
::instance(),
1591 'name' => $log->name
,
1592 'oldvalue' => $log->oldvalue
,
1593 'value' => $log->value
,
1594 'plugin' => $log->plugin
1601 * Store user last access times - called when use enters a course or site
1605 * @global stdClass $USER
1606 * @global stdClass $CFG
1607 * @global moodle_database $DB
1608 * @uses LASTACCESS_UPDATE_SECS
1610 * @param int $courseid empty courseid means site
1613 function user_accesstime_log($courseid=0) {
1614 global $USER, $CFG, $DB;
1616 if (!isloggedin() or \core\session\manager
::is_loggedinas()) {
1617 // no access tracking
1621 if (isguestuser()) {
1622 // Do not update guest access times/ips for performance.
1626 if (empty($courseid)) {
1632 /// Store site lastaccess time for the current user
1633 if ($timenow - $USER->lastaccess
> LASTACCESS_UPDATE_SECS
) {
1634 /// Update $USER->lastaccess for next checks
1635 $USER->lastaccess
= $timenow;
1637 $last = new stdClass();
1638 $last->id
= $USER->id
;
1639 $last->lastip
= getremoteaddr();
1640 $last->lastaccess
= $timenow;
1642 $DB->update_record_raw('user', $last);
1645 if ($courseid == SITEID
) {
1646 /// no user_lastaccess for frontpage
1650 /// Store course lastaccess times for the current user
1651 if (empty($USER->currentcourseaccess
[$courseid]) or ($timenow - $USER->currentcourseaccess
[$courseid] > LASTACCESS_UPDATE_SECS
)) {
1653 $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id
, 'courseid'=>$courseid));
1655 if ($lastaccess === false) {
1656 // Update course lastaccess for next checks
1657 $USER->currentcourseaccess
[$courseid] = $timenow;
1659 $last = new stdClass();
1660 $last->userid
= $USER->id
;
1661 $last->courseid
= $courseid;
1662 $last->timeaccess
= $timenow;
1664 $DB->insert_record_raw('user_lastaccess', $last, false);
1665 } catch (dml_write_exception
$e) {
1666 // During a race condition we can fail to find the data, then it appears.
1667 // If we still can't find it, rethrow the exception.
1668 $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid' => $USER->id
,
1669 'courseid' => $courseid));
1670 if ($lastaccess === false) {
1673 // If we did find it, the race condition was true and another thread has inserted the time for us.
1674 // We can just continue without having to do anything.
1677 } else if ($timenow - $lastaccess < LASTACCESS_UPDATE_SECS
) {
1678 // no need to update now, it was updated recently in concurrent login ;-)
1681 // Update course lastaccess for next checks
1682 $USER->currentcourseaccess
[$courseid] = $timenow;
1684 $DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id
, 'courseid'=>$courseid));
1689 /// GENERAL HELPFUL THINGS ///////////////////////////////////
1692 * Dumps a given object's information for debugging purposes
1694 * When used in a CLI script, the object's information is written to the standard
1695 * error output stream. When used in a web script, the object is dumped to a
1696 * pre-formatted block with the "notifytiny" CSS class.
1698 * @param mixed $object The data to be printed
1699 * @return void output is echo'd
1701 function print_object($object) {
1703 // we may need a lot of memory here
1704 raise_memory_limit(MEMORY_EXTRA
);
1707 fwrite(STDERR
, print_r($object, true));
1708 fwrite(STDERR
, PHP_EOL
);
1710 echo html_writer
::tag('pre', s(print_r($object, true)), array('class' => 'notifytiny'));
1715 * This function is the official hook inside XMLDB stuff to delegate its debug to one
1716 * external function.
1718 * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
1719 * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
1721 * @uses DEBUG_DEVELOPER
1722 * @param string $message string contains the error message
1723 * @param object $object object XMLDB object that fired the debug
1725 function xmldb_debug($message, $object) {
1727 debugging($message, DEBUG_DEVELOPER
);
1732 * @uses CONTEXT_COURSECAT
1733 * @return boolean Whether the user can create courses in any category in the system.
1735 function user_can_create_courses() {
1737 $catsrs = $DB->get_recordset('course_categories');
1738 foreach ($catsrs as $cat) {
1739 if (has_capability('moodle/course:create', context_coursecat
::instance($cat->id
))) {
1749 * This method can update the values in mulitple database rows for a colum with
1750 * a unique index, without violating that constraint.
1752 * Suppose we have a table with a unique index on (otherid, sortorder), and
1753 * for a particular value of otherid, we want to change all the sort orders.
1754 * You have to do this carefully or you will violate the unique index at some time.
1755 * This method takes care of the details for you.
1757 * Note that, it is the responsibility of the caller to make sure that the
1758 * requested rename is legal. For example, if you ask for [1 => 2, 2 => 2]
1759 * then you will get a unique key violation error from the database.
1761 * @param string $table The database table to modify.
1762 * @param string $field the field that contains the values we are going to change.
1763 * @param array $newvalues oldvalue => newvalue how to change the values.
1764 * E.g. [1 => 4, 2 => 1, 3 => 3, 4 => 2].
1765 * @param array $otherconditions array fieldname => requestedvalue extra WHERE clause
1766 * conditions to restrict which rows are affected. E.g. array('otherid' => 123).
1767 * @param int $unusedvalue (defaults to -1) a value that is never used in $ordercol.
1769 function update_field_with_unique_index($table, $field, array $newvalues,
1770 array $otherconditions, $unusedvalue = -1) {
1772 $safechanges = decompose_update_into_safe_changes($newvalues, $unusedvalue);
1774 $transaction = $DB->start_delegated_transaction();
1775 foreach ($safechanges as $change) {
1776 list($from, $to) = $change;
1777 $otherconditions[$field] = $from;
1778 $DB->set_field($table, $field, $to, $otherconditions);
1780 $transaction->allow_commit();
1784 * Helper used by {@link update_field_with_unique_index()}. Given a desired
1785 * set of changes, break them down into single udpates that can be done one at
1786 * a time without breaking any unique index constraints.
1788 * Suppose the input is array(1 => 2, 2 => 1) and -1. Then the output will be
1789 * array (array(1, -1), array(2, 1), array(-1, 2)). This function solves this
1790 * problem in the general case, not just for simple swaps. The unit tests give
1793 * Note that, it is the responsibility of the caller to make sure that the
1794 * requested rename is legal. For example, if you ask for something impossible
1795 * like array(1 => 2, 2 => 2) then the results are undefined. (You will probably
1796 * get a unique key violation error from the database later.)
1798 * @param array $newvalues The desired re-ordering.
1799 * E.g. array(1 => 4, 2 => 1, 3 => 3, 4 => 2).
1800 * @param int $unusedvalue A value that is not currently used.
1801 * @return array A safe way to perform the re-order. An array of two-element
1802 * arrays array($from, $to).
1803 * E.g. array(array(1, -1), array(2, 1), array(4, 2), array(-1, 4)).
1805 function decompose_update_into_safe_changes(array $newvalues, $unusedvalue) {
1806 $nontrivialmap = array();
1807 foreach ($newvalues as $from => $to) {
1808 if ($from == $unusedvalue ||
$to == $unusedvalue) {
1809 throw new \
coding_exception('Supposedly unused value ' . $unusedvalue . ' is actually used!');
1812 $nontrivialmap[$from] = $to;
1816 if (empty($nontrivialmap)) {
1820 // First we deal with all renames that are not part of cycles.
1821 // This bit is O(n^2) and it ought to be possible to do better,
1822 // but it does not seem worth the effort.
1823 $safechanges = array();
1824 $nontrivialmapchanged = true;
1825 while ($nontrivialmapchanged) {
1826 $nontrivialmapchanged = false;
1828 foreach ($nontrivialmap as $from => $to) {
1829 if (array_key_exists($to, $nontrivialmap)) {
1830 continue; // Cannot currenly do this rename.
1832 // Is safe to do this rename now.
1833 $safechanges[] = array($from, $to);
1834 unset($nontrivialmap[$from]);
1835 $nontrivialmapchanged = true;
1840 if (empty($nontrivialmap)) {
1841 return $safechanges;
1844 // Now what is left in $nontrivialmap must be a permutation,
1845 // which must be a combination of disjoint cycles. We need to break them.
1846 while (!empty($nontrivialmap)) {
1847 // Extract the first cycle.
1848 reset($nontrivialmap);
1849 $current = $cyclestart = key($nontrivialmap);
1852 $cycle[] = $current;
1853 $next = $nontrivialmap[$current];
1854 unset($nontrivialmap[$current]);
1856 } while ($current != $cyclestart);
1858 // Now convert it to a sequence of safe renames by using a temp.
1859 $safechanges[] = array($cyclestart, $unusedvalue);
1860 $cycle[0] = $unusedvalue;
1862 while ($from = array_pop($cycle)) {
1863 $safechanges[] = array($from, $to);
1868 return $safechanges;