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