MDL-37742 add debugging message when $DB->sql_empty() used
[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);
180             $contextlists = get_related_contexts_string($context);
182             $sql = "SELECT u.id, u.firstname, u.lastname, u.email
183                       FROM {user} u
184                       JOIN {role_assignments} ra ON ra.userid = u.id
185                      WHERE $select AND ra.contextid $contextlists
186                            $except
187                     $order";
188             return $DB->get_records_sql($sql, $params);
189         }
190     }
193 /**
194  * This function generates the standard ORDER BY clause for use when generating
195  * lists of users. If you don't have a reason to use a different order, then
196  * you should use this method to generate the order when displaying lists of users.
197  *
198  * If the optional $search parameter is passed, then exact matches to the search
199  * will be sorted first. For example, suppose you have two users 'Al Zebra' and
200  * 'Alan Aardvark'. The default sort is Alan, then Al. If, however, you search for
201  * 'Al', then Al will be listed first. (With two users, this is not a big deal,
202  * but with thousands of users, it is essential.)
203  *
204  * The list of fields scanned for exact matches are:
205  *  - firstname
206  *  - lastname
207  *  - $DB->sql_fullname
208  *  - those returned by get_extra_user_fields
209  *
210  * If named parameters are used (which is the default, and highly recommended),
211  * then the parameter names are like :usersortexactN, where N is an int.
212  *
213  * The simplest possible example use is:
214  * list($sort, $params) = users_order_by_sql();
215  * $sql = 'SELECT * FROM {users} ORDER BY ' . $sort;
216  *
217  * A more complex example, showing that this sort can be combined with other sorts:
218  * list($sort, $sortparams) = users_order_by_sql('u');
219  * $sql = "SELECT g.id AS groupid, gg.groupingid, u.id AS userid, u.firstname, u.lastname, u.idnumber, u.username
220  *           FROM {groups} g
221  *      LEFT JOIN {groupings_groups} gg ON g.id = gg.groupid
222  *      LEFT JOIN {groups_members} gm ON g.id = gm.groupid
223  *      LEFT JOIN {user} u ON gm.userid = u.id
224  *          WHERE g.courseid = :courseid $groupwhere $groupingwhere
225  *       ORDER BY g.name, $sort";
226  * $params += $sortparams;
227  *
228  * An example showing the use of $search:
229  * list($sort, $sortparams) = users_order_by_sql('u', $search, $this->get_context());
230  * $order = ' ORDER BY ' . $sort;
231  * $params += $sortparams;
232  * $availableusers = $DB->get_records_sql($fields . $sql . $order, $params, $page*$perpage, $perpage);
233  *
234  * @param string $usertablealias (optional) any table prefix for the {users} table. E.g. 'u'.
235  * @param string $search (optional) a current search string. If given,
236  *      any exact matches to this string will be sorted first.
237  * @param context $context the context we are in. Use by get_extra_user_fields.
238  *      Defaults to $PAGE->context.
239  * @return array with two elements:
240  *      string SQL fragment to use in the ORDER BY clause. For example, "firstname, lastname".
241  *      array of parameters used in the SQL fragment.
242  */
243 function users_order_by_sql($usertablealias = '', $search = null, context $context = null) {
244     global $DB, $PAGE;
246     if ($usertablealias) {
247         $tableprefix = $usertablealias . '.';
248     } else {
249         $tableprefix = '';
250     }
252     $sort = "{$tableprefix}lastname, {$tableprefix}firstname, {$tableprefix}id";
253     $params = array();
255     if (!$search) {
256         return array($sort, $params);
257     }
259     if (!$context) {
260         $context = $PAGE->context;
261     }
263     $exactconditions = array();
264     $paramkey = 'usersortexact1';
266     $exactconditions[] = $DB->sql_fullname($tableprefix . 'firstname', $tableprefix  . 'lastname') .
267             ' = :' . $paramkey;
268     $params[$paramkey] = $search;
269     $paramkey++;
271     $fieldstocheck = array_merge(array('firstname', 'lastname'), get_extra_user_fields($context));
272     foreach ($fieldstocheck as $key => $field) {
273         $exactconditions[] = 'LOWER(' . $tableprefix . $field . ') = LOWER(:' . $paramkey . ')';
274         $params[$paramkey] = $search;
275         $paramkey++;
276     }
278     $sort = 'CASE WHEN ' . implode(' OR ', $exactconditions) .
279             ' THEN 0 ELSE 1 END, ' . $sort;
281     return array($sort, $params);
284 /**
285  * Returns a subset of users
286  *
287  * @global object
288  * @uses DEBUG_DEVELOPER
289  * @uses SQL_PARAMS_NAMED
290  * @param bool $get If false then only a count of the records is returned
291  * @param string $search A simple string to search for
292  * @param bool $confirmed A switch to allow/disallow unconfirmed users
293  * @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
294  * @param string $sort A SQL snippet for the sorting criteria to use
295  * @param string $firstinitial Users whose first name starts with $firstinitial
296  * @param string $lastinitial Users whose last name starts with $lastinitial
297  * @param string $page The page or records to return
298  * @param string $recordsperpage The number of records to return per page
299  * @param string $fields A comma separated list of fields to be returned from the chosen table.
300  * @return array|int|bool  {@link $USER} records unless get is false in which case the integer count of the records found is returned.
301  *                        False is returned if an error is encountered.
302  */
303 function get_users($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC',
304                    $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*', $extraselect='', array $extraparams=null) {
305     global $DB, $CFG;
307     if ($get && !$recordsperpage) {
308         debugging('Call to get_users with $get = true no $recordsperpage limit. ' .
309                 'On large installations, this will probably cause an out of memory error. ' .
310                 'Please think again and change your code so that it does not try to ' .
311                 'load so much data into memory.', DEBUG_DEVELOPER);
312     }
314     $fullname  = $DB->sql_fullname();
316     $select = " id <> :guestid AND deleted = 0";
317     $params = array('guestid'=>$CFG->siteguest);
319     if (!empty($search)){
320         $search = trim($search);
321         $select .= " AND (".$DB->sql_like($fullname, ':search1', false)." OR ".$DB->sql_like('email', ':search2', false)." OR username = :search3)";
322         $params['search1'] = "%$search%";
323         $params['search2'] = "%$search%";
324         $params['search3'] = "$search";
325     }
327     if ($confirmed) {
328         $select .= " AND confirmed = 1";
329     }
331     if ($exceptions) {
332         list($exceptions, $eparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex', false);
333         $params = $params + $eparams;
334         $select .= " AND id $exceptions";
335     }
337     if ($firstinitial) {
338         $select .= " AND ".$DB->sql_like('firstname', ':fni', false, false);
339         $params['fni'] = "$firstinitial%";
340     }
341     if ($lastinitial) {
342         $select .= " AND ".$DB->sql_like('lastname', ':lni', false, false);
343         $params['lni'] = "$lastinitial%";
344     }
346     if ($extraselect) {
347         $select .= " AND $extraselect";
348         $params = $params + (array)$extraparams;
349     }
351     if ($get) {
352         return $DB->get_records_select('user', $select, $params, $sort, $fields, $page, $recordsperpage);
353     } else {
354         return $DB->count_records_select('user', $select, $params);
355     }
359 /**
360  * Return filtered (if provided) list of users in site, except guest and deleted users.
361  *
362  * @param string $sort An SQL field to sort by
363  * @param string $dir The sort direction ASC|DESC
364  * @param int $page The page or records to return
365  * @param int $recordsperpage The number of records to return per page
366  * @param string $search A simple string to search for
367  * @param string $firstinitial Users whose first name starts with $firstinitial
368  * @param string $lastinitial Users whose last name starts with $lastinitial
369  * @param string $extraselect An additional SQL select statement to append to the query
370  * @param array $extraparams Additional parameters to use for the above $extraselect
371  * @param stdClass $extracontext If specified, will include user 'extra fields'
372  *   as appropriate for current user and given context
373  * @return array Array of {@link $USER} records
374  */
375 function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
376                            $search='', $firstinitial='', $lastinitial='', $extraselect='',
377                            array $extraparams=null, $extracontext = null) {
378     global $DB, $CFG;
380     $fullname  = $DB->sql_fullname();
382     $select = "deleted <> 1 AND id <> :guestid";
383     $params = array('guestid' => $CFG->siteguest);
385     if (!empty($search)) {
386         $search = trim($search);
387         $select .= " AND (". $DB->sql_like($fullname, ':search1', false, false).
388                    " OR ". $DB->sql_like('email', ':search2', false, false).
389                    " OR username = :search3)";
390         $params['search1'] = "%$search%";
391         $params['search2'] = "%$search%";
392         $params['search3'] = "$search";
393     }
395     if ($firstinitial) {
396         $select .= " AND ". $DB->sql_like('firstname', ':fni', false, false);
397         $params['fni'] = "$firstinitial%";
398     }
399     if ($lastinitial) {
400         $select .= " AND ". $DB->sql_like('lastname', ':lni', false, false);
401         $params['lni'] = "$lastinitial%";
402     }
404     if ($extraselect) {
405         $select .= " AND $extraselect";
406         $params = $params + (array)$extraparams;
407     }
409     if ($sort) {
410         $sort = " ORDER BY $sort $dir";
411     }
413     // If a context is specified, get extra user fields that the current user
414     // is supposed to see.
415     $extrafields = '';
416     if ($extracontext) {
417         $extrafields = get_extra_user_fields_sql($extracontext, '', '',
418                 array('id', 'username', 'email', 'firstname', 'lastname', 'city', 'country',
419                 'lastaccess', 'confirmed', 'mnethostid'));
420     }
422     // warning: will return UNCONFIRMED USERS
423     return $DB->get_records_sql("SELECT id, username, email, firstname, lastname, city, country,
424                                         lastaccess, confirmed, mnethostid, suspended $extrafields
425                                    FROM {user}
426                                   WHERE $select
427                                   $sort", $params, $page, $recordsperpage);
432 /**
433  * Full list of users that have confirmed their accounts.
434  *
435  * @global object
436  * @return array of unconfirmed users
437  */
438 function get_users_confirmed() {
439     global $DB, $CFG;
440     return $DB->get_records_sql("SELECT *
441                                    FROM {user}
442                                   WHERE confirmed = 1 AND deleted = 0 AND id <> ?", array($CFG->siteguest));
446 /// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
449 /**
450  * Returns $course object of the top-level site.
451  *
452  * @return object A {@link $COURSE} object for the site, exception if not found
453  */
454 function get_site() {
455     global $SITE, $DB;
457     if (!empty($SITE->id)) {   // We already have a global to use, so return that
458         return $SITE;
459     }
461     if ($course = $DB->get_record('course', array('category'=>0))) {
462         return $course;
463     } else {
464         // course table exists, but the site is not there,
465         // unfortunately there is no automatic way to recover
466         throw new moodle_exception('nosite', 'error');
467     }
470 /**
471  * Returns list of courses, for whole site, or category
472  *
473  * Returns list of courses, for whole site, or category
474  * Important: Using c.* for fields is extremely expensive because
475  *            we are using distinct. You almost _NEVER_ need all the fields
476  *            in such a large SELECT
477  *
478  * @global object
479  * @global object
480  * @global object
481  * @uses CONTEXT_COURSE
482  * @param string|int $categoryid Either a category id or 'all' for everything
483  * @param string $sort A field and direction to sort by
484  * @param string $fields The additional fields to return
485  * @return array Array of courses
486  */
487 function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
489     global $USER, $CFG, $DB;
491     $params = array();
493     if ($categoryid !== "all" && is_numeric($categoryid)) {
494         $categoryselect = "WHERE c.category = :catid";
495         $params['catid'] = $categoryid;
496     } else {
497         $categoryselect = "";
498     }
500     if (empty($sort)) {
501         $sortstatement = "";
502     } else {
503         $sortstatement = "ORDER BY $sort";
504     }
506     $visiblecourses = array();
508     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
510     $sql = "SELECT $fields $ccselect
511               FROM {course} c
512            $ccjoin
513               $categoryselect
514               $sortstatement";
516     // pull out all course matching the cat
517     if ($courses = $DB->get_records_sql($sql, $params)) {
519         // loop throught them
520         foreach ($courses as $course) {
521             context_instance_preload($course);
522             if (isset($course->visible) && $course->visible <= 0) {
523                 // for hidden courses, require visibility check
524                 if (has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
525                     $visiblecourses [$course->id] = $course;
526                 }
527             } else {
528                 $visiblecourses [$course->id] = $course;
529             }
530         }
531     }
532     return $visiblecourses;
536 /**
537  * Returns list of courses, for whole site, or category
538  *
539  * Similar to get_courses, but allows paging
540  * Important: Using c.* for fields is extremely expensive because
541  *            we are using distinct. You almost _NEVER_ need all the fields
542  *            in such a large SELECT
543  *
544  * @global object
545  * @global object
546  * @global object
547  * @uses CONTEXT_COURSE
548  * @param string|int $categoryid Either a category id or 'all' for everything
549  * @param string $sort A field and direction to sort by
550  * @param string $fields The additional fields to return
551  * @param int $totalcount Reference for the number of courses
552  * @param string $limitfrom The course to start from
553  * @param string $limitnum The number of courses to limit to
554  * @return array Array of courses
555  */
556 function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
557                           &$totalcount, $limitfrom="", $limitnum="") {
558     global $USER, $CFG, $DB;
560     $params = array();
562     $categoryselect = "";
563     if ($categoryid !== "all" && is_numeric($categoryid)) {
564         $categoryselect = "WHERE c.category = :catid";
565         $params['catid'] = $categoryid;
566     } else {
567         $categoryselect = "";
568     }
570     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
572     $totalcount = 0;
573     if (!$limitfrom) {
574         $limitfrom = 0;
575     }
576     $visiblecourses = array();
578     $sql = "SELECT $fields $ccselect
579               FROM {course} c
580               $ccjoin
581            $categoryselect
582           ORDER BY $sort";
584     // pull out all course matching the cat
585     $rs = $DB->get_recordset_sql($sql, $params);
586     // iteration will have to be done inside loop to keep track of the limitfrom and limitnum
587     foreach($rs as $course) {
588         context_instance_preload($course);
589         if ($course->visible <= 0) {
590             // for hidden courses, require visibility check
591             if (has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
592                 $totalcount++;
593                 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
594                     $visiblecourses [$course->id] = $course;
595                 }
596             }
597         } else {
598             $totalcount++;
599             if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
600                 $visiblecourses [$course->id] = $course;
601             }
602         }
603     }
604     $rs->close();
605     return $visiblecourses;
608 /**
609  * Retrieve course records with the course managers and other related records
610  * that we need for print_course(). This allows print_courses() to do its job
611  * in a constant number of DB queries, regardless of the number of courses,
612  * role assignments, etc.
613  *
614  * The returned array is indexed on c.id, and each course will have
615  * - $course->managers - array containing RA objects that include a $user obj
616  *                       with the minimal fields needed for fullname()
617  *
618  * @global object
619  * @global object
620  * @global object
621  * @uses CONTEXT_COURSE
622  * @uses CONTEXT_SYSTEM
623  * @uses CONTEXT_COURSECAT
624  * @uses SITEID
625  * @param int|string $categoryid Either the categoryid for the courses or 'all'
626  * @param string $sort A SQL sort field and direction
627  * @param array $fields An array of additional fields to fetch
628  * @return array
629  */
630 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
631     /*
632      * The plan is to
633      *
634      * - Grab the courses JOINed w/context
635      *
636      * - Grab the interesting course-manager RAs
637      *   JOINed with a base user obj and add them to each course
638      *
639      * So as to do all the work in 2 DB queries. The RA+user JOIN
640      * ends up being pretty expensive if it happens over _all_
641      * courses on a large site. (Are we surprised!?)
642      *
643      * So this should _never_ get called with 'all' on a large site.
644      *
645      */
646     global $USER, $CFG, $DB;
648     $params = array();
649     $allcats = false; // bool flag
650     if ($categoryid === 'all') {
651         $categoryclause   = '';
652         $allcats = true;
653     } elseif (is_numeric($categoryid)) {
654         $categoryclause = "c.category = :catid";
655         $params['catid'] = $categoryid;
656     } else {
657         debugging("Could not recognise categoryid = $categoryid");
658         $categoryclause = '';
659     }
661     $basefields = array('id', 'category', 'sortorder',
662                         'shortname', 'fullname', 'idnumber',
663                         'startdate', 'visible',
664                         'newsitems', 'groupmode', 'groupmodeforce');
666     if (!is_null($fields) && is_string($fields)) {
667         if (empty($fields)) {
668             $fields = $basefields;
669         } else {
670             // turn the fields from a string to an array that
671             // get_user_courses_bycap() will like...
672             $fields = explode(',',$fields);
673             $fields = array_map('trim', $fields);
674             $fields = array_unique(array_merge($basefields, $fields));
675         }
676     } elseif (is_array($fields)) {
677         $fields = array_merge($basefields,$fields);
678     }
679     $coursefields = 'c.' .join(',c.', $fields);
681     if (empty($sort)) {
682         $sortstatement = "";
683     } else {
684         $sortstatement = "ORDER BY $sort";
685     }
687     $where = 'WHERE c.id != ' . SITEID;
688     if ($categoryclause !== ''){
689         $where = "$where AND $categoryclause";
690     }
692     // pull out all courses matching the cat
693     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
694     $sql = "SELECT $coursefields $ccselect
695               FROM {course} c
696            $ccjoin
697                $where
698                $sortstatement";
700     $catpaths = array();
701     $catpath  = NULL;
702     if ($courses = $DB->get_records_sql($sql, $params)) {
703         // loop on courses materialising
704         // the context, and prepping data to fetch the
705         // managers efficiently later...
706         foreach ($courses as $k => $course) {
707             context_instance_preload($course);
708             $coursecontext = context_course::instance($course->id);
709             $courses[$k] = $course;
710             $courses[$k]->managers = array();
711             if ($allcats === false) {
712                 // single cat, so take just the first one...
713                 if ($catpath === NULL) {
714                     $catpath = preg_replace(':/\d+$:', '', $coursecontext->path);
715                 }
716             } else {
717                 // chop off the contextid of the course itself
718                 // like dirname() does...
719                 $catpaths[] = preg_replace(':/\d+$:', '', $coursecontext->path);
720             }
721         }
722     } else {
723         return array(); // no courses!
724     }
726     $CFG->coursecontact = trim($CFG->coursecontact);
727     if (empty($CFG->coursecontact)) {
728         return $courses;
729     }
731     $managerroles = explode(',', $CFG->coursecontact);
732     $catctxids = '';
733     if (count($managerroles)) {
734         if ($allcats === true) {
735             $catpaths  = array_unique($catpaths);
736             $ctxids = array();
737             foreach ($catpaths as $cpath) {
738                 $ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
739             }
740             $ctxids = array_unique($ctxids);
741             $catctxids = implode( ',' , $ctxids);
742             unset($catpaths);
743             unset($cpath);
744         } else {
745             // take the ctx path from the first course
746             // as all categories will be the same...
747             $catpath = substr($catpath,1);
748             $catpath = preg_replace(':/\d+$:','',$catpath);
749             $catctxids = str_replace('/',',',$catpath);
750         }
751         if ($categoryclause !== '') {
752             $categoryclause = "AND $categoryclause";
753         }
754         /*
755          * Note: Here we use a LEFT OUTER JOIN that can
756          * "optionally" match to avoid passing a ton of context
757          * ids in an IN() clause. Perhaps a subselect is faster.
758          *
759          * In any case, this SQL is not-so-nice over large sets of
760          * courses with no $categoryclause.
761          *
762          */
763         $sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
764                        r.id AS roleid, r.name AS rolename, r.shortname AS roleshortname,
765                        rn.name AS rolecoursealias, u.id AS userid, u.firstname, u.lastname
766                   FROM {role_assignments} ra
767                   JOIN {context} ctx ON ra.contextid = ctx.id
768                   JOIN {user} u ON ra.userid = u.id
769                   JOIN {role} r ON ra.roleid = r.id
770              LEFT JOIN {role_names} rn ON (rn.contextid = ctx.id AND rn.roleid = r.id)
771                   LEFT OUTER JOIN {course} c
772                        ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
773                 WHERE ( c.id IS NOT NULL";
774         // under certain conditions, $catctxids is NULL
775         if($catctxids == NULL){
776             $sql .= ") ";
777         }else{
778             $sql .= " OR ra.contextid  IN ($catctxids) )";
779         }
781         $sql .= "AND ra.roleid IN ({$CFG->coursecontact})
782                       $categoryclause
783                 ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
784         $rs = $DB->get_recordset_sql($sql, $params);
786         // This loop is fairly stupid as it stands - might get better
787         // results doing an initial pass clustering RAs by path.
788         foreach($rs as $ra) {
789             $user = new stdClass;
790             $user->id        = $ra->userid;    unset($ra->userid);
791             $user->firstname = $ra->firstname; unset($ra->firstname);
792             $user->lastname  = $ra->lastname;  unset($ra->lastname);
793             $ra->user = $user;
794             if ($ra->contextlevel == CONTEXT_SYSTEM) {
795                 foreach ($courses as $k => $course) {
796                     $courses[$k]->managers[] = $ra;
797                 }
798             } else if ($ra->contextlevel == CONTEXT_COURSECAT) {
799                 if ($allcats === false) {
800                     // It always applies
801                     foreach ($courses as $k => $course) {
802                         $courses[$k]->managers[] = $ra;
803                     }
804                 } else {
805                     foreach ($courses as $k => $course) {
806                         $coursecontext = context_course::instance($course->id);
807                         // Note that strpos() returns 0 as "matched at pos 0"
808                         if (strpos($coursecontext->path, $ra->path.'/') === 0) {
809                             // Only add it to subpaths
810                             $courses[$k]->managers[] = $ra;
811                         }
812                     }
813                 }
814             } else { // course-level
815                 if (!array_key_exists($ra->instanceid, $courses)) {
816                     //this course is not in a list, probably a frontpage course
817                     continue;
818                 }
819                 $courses[$ra->instanceid]->managers[] = $ra;
820             }
821         }
822         $rs->close();
823     }
825     return $courses;
828 /**
829  * A list of courses that match a search
830  *
831  * @global object
832  * @global object
833  * @param array $searchterms An array of search criteria
834  * @param string $sort A field and direction to sort by
835  * @param int $page The page number to get
836  * @param int $recordsperpage The number of records per page
837  * @param int $totalcount Passed in by reference.
838  * @return object {@link $COURSE} records
839  */
840 function get_courses_search($searchterms, $sort='fullname ASC', $page=0, $recordsperpage=50, &$totalcount) {
841     global $CFG, $DB;
843     if ($DB->sql_regex_supported()) {
844         $REGEXP    = $DB->sql_regex(true);
845         $NOTREGEXP = $DB->sql_regex(false);
846     }
848     $searchcond = array();
849     $params     = array();
850     $i = 0;
852     // Thanks Oracle for your non-ansi concat and type limits in coalesce. MDL-29912
853     if ($DB->get_dbfamily() == 'oracle') {
854         $concat = $DB->sql_concat('c.summary', "' '", 'c.fullname', "' '", 'c.idnumber', "' '", 'c.shortname');
855     } else {
856         $concat = $DB->sql_concat("COALESCE(c.summary, :empty)", "' '", 'c.fullname', "' '", 'c.idnumber', "' '", 'c.shortname');
857         $params['empty'] = '';
858     }
860     foreach ($searchterms as $searchterm) {
861         $i++;
863         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
864                    /// will use it to simulate the "-" operator with LIKE clause
866     /// Under Oracle and MSSQL, trim the + and - operators and perform
867     /// simpler LIKE (or NOT LIKE) queries
868         if (!$DB->sql_regex_supported()) {
869             if (substr($searchterm, 0, 1) == '-') {
870                 $NOT = true;
871             }
872             $searchterm = trim($searchterm, '+-');
873         }
875         // TODO: +- may not work for non latin languages
877         if (substr($searchterm,0,1) == '+') {
878             $searchterm = trim($searchterm, '+-');
879             $searchterm = preg_quote($searchterm, '|');
880             $searchcond[] = "$concat $REGEXP :ss$i";
881             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
883         } else if (substr($searchterm,0,1) == "-") {
884             $searchterm = trim($searchterm, '+-');
885             $searchterm = preg_quote($searchterm, '|');
886             $searchcond[] = "$concat $NOTREGEXP :ss$i";
887             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
889         } else {
890             $searchcond[] = $DB->sql_like($concat,":ss$i", false, true, $NOT);
891             $params['ss'.$i] = "%$searchterm%";
892         }
893     }
895     if (empty($searchcond)) {
896         $totalcount = 0;
897         return array();
898     }
900     $searchcond = implode(" AND ", $searchcond);
902     $courses = array();
903     $c = 0; // counts how many visible courses we've seen
905     // Tiki pagination
906     $limitfrom = $page * $recordsperpage;
907     $limitto   = $limitfrom + $recordsperpage;
909     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
910     $sql = "SELECT c.* $ccselect
911               FROM {course} c
912            $ccjoin
913              WHERE $searchcond AND c.id <> ".SITEID."
914           ORDER BY $sort";
916     $rs = $DB->get_recordset_sql($sql, $params);
917     foreach($rs as $course) {
918         context_instance_preload($course);
919         $coursecontext = context_course::instance($course->id);
920         if ($course->visible || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
921             // Don't exit this loop till the end
922             // we need to count all the visible courses
923             // to update $totalcount
924             if ($c >= $limitfrom && $c < $limitto) {
925                 $courses[$course->id] = $course;
926             }
927             $c++;
928         }
929     }
930     $rs->close();
932     // our caller expects 2 bits of data - our return
933     // array, and an updated $totalcount
934     $totalcount = $c;
935     return $courses;
939 /**
940  * Returns a sorted list of categories. Each category object has a context
941  * property that is a context object.
942  *
943  * When asking for $parent='none' it will return all the categories, regardless
944  * of depth. Wheen asking for a specific parent, the default is to return
945  * a "shallow" resultset. Pass false to $shallow and it will return all
946  * the child categories as well.
947  *
948  * @global object
949  * @uses CONTEXT_COURSECAT
950  * @param string $parent The parent category if any
951  * @param string $sort the sortorder
952  * @param bool   $shallow - set to false to get the children too
953  * @return array of categories
954  */
955 function get_categories($parent='none', $sort=NULL, $shallow=true) {
956     global $DB;
958     if ($sort === NULL) {
959         $sort = 'ORDER BY cc.sortorder ASC';
960     } elseif ($sort ==='') {
961         // leave it as empty
962     } else {
963         $sort = "ORDER BY $sort";
964     }
966     list($ccselect, $ccjoin) = context_instance_preload_sql('cc.id', CONTEXT_COURSECAT, 'ctx');
968     if ($parent === 'none') {
969         $sql = "SELECT cc.* $ccselect
970                   FROM {course_categories} cc
971                $ccjoin
972                 $sort";
973         $params = array();
975     } elseif ($shallow) {
976         $sql = "SELECT cc.* $ccselect
977                   FROM {course_categories} cc
978                $ccjoin
979                  WHERE cc.parent=?
980                 $sort";
981         $params = array($parent);
983     } else {
984         $sql = "SELECT cc.* $ccselect
985                   FROM {course_categories} cc
986                $ccjoin
987                   JOIN {course_categories} ccp
988                        ON ((cc.parent = ccp.id) OR (cc.path LIKE ".$DB->sql_concat('ccp.path',"'/%'")."))
989                  WHERE ccp.id=?
990                 $sort";
991         $params = array($parent);
992     }
993     $categories = array();
995     $rs = $DB->get_recordset_sql($sql, $params);
996     foreach($rs as $cat) {
997         context_instance_preload($cat);
998         $catcontext = context_coursecat::instance($cat->id);
999         if ($cat->visible || has_capability('moodle/category:viewhiddencategories', $catcontext)) {
1000             $categories[$cat->id] = $cat;
1001         }
1002     }
1003     $rs->close();
1004     return $categories;
1008 /**
1009  * Returns an array of category ids of all the subcategories for a given
1010  * category.
1011  *
1012  * @global object
1013  * @param int $catid - The id of the category whose subcategories we want to find.
1014  * @return array of category ids.
1015  */
1016 function get_all_subcategories($catid) {
1017     global $DB;
1019     $subcats = array();
1021     if ($categories = $DB->get_records('course_categories', array('parent'=>$catid))) {
1022         foreach ($categories as $cat) {
1023             array_push($subcats, $cat->id);
1024             $subcats = array_merge($subcats, get_all_subcategories($cat->id));
1025         }
1026     }
1027     return $subcats;
1030 /**
1031  * Return specified category, default if given does not exist
1032  *
1033  * @global object
1034  * @uses MAX_COURSES_IN_CATEGORY
1035  * @uses CONTEXT_COURSECAT
1036  * @uses SYSCONTEXTID
1037  * @param int $catid course category id
1038  * @return object caregory
1039  */
1040 function get_course_category($catid=0) {
1041     global $DB;
1043     $category = false;
1045     if (!empty($catid)) {
1046         $category = $DB->get_record('course_categories', array('id'=>$catid));
1047     }
1049     if (!$category) {
1050         // the first category is considered default for now
1051         if ($category = $DB->get_records('course_categories', null, 'sortorder', '*', 0, 1)) {
1052             $category = reset($category);
1054         } else {
1055             $cat = new stdClass();
1056             $cat->name         = get_string('miscellaneous');
1057             $cat->depth        = 1;
1058             $cat->sortorder    = MAX_COURSES_IN_CATEGORY;
1059             $cat->timemodified = time();
1060             $catid = $DB->insert_record('course_categories', $cat);
1061             // make sure category context exists
1062             context_coursecat::instance($catid);
1063             mark_context_dirty('/'.SYSCONTEXTID);
1064             fix_course_sortorder(); // Required to build course_categories.depth and .path.
1065             $category = $DB->get_record('course_categories', array('id'=>$catid));
1066         }
1067     }
1069     return $category;
1072 /**
1073  * Fixes course category and course sortorder, also verifies category and course parents and paths.
1074  * (circular references are not fixed)
1075  *
1076  * @global object
1077  * @global object
1078  * @uses MAX_COURSES_IN_CATEGORY
1079  * @uses MAX_COURSE_CATEGORIES
1080  * @uses SITEID
1081  * @uses CONTEXT_COURSE
1082  * @return void
1083  */
1084 function fix_course_sortorder() {
1085     global $DB, $SITE;
1087     //WARNING: this is PHP5 only code!
1089     if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
1090         //move all categories that are not sorted yet to the end
1091         $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('sortorder'=>0));
1092     }
1094     $allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
1095     $topcats    = array();
1096     $brokencats = array();
1097     foreach ($allcats as $cat) {
1098         $sortorder = (int)$cat->sortorder;
1099         if (!$cat->parent) {
1100             while(isset($topcats[$sortorder])) {
1101                 $sortorder++;
1102             }
1103             $topcats[$sortorder] = $cat;
1104             continue;
1105         }
1106         if (!isset($allcats[$cat->parent])) {
1107             $brokencats[] = $cat;
1108             continue;
1109         }
1110         if (!isset($allcats[$cat->parent]->children)) {
1111             $allcats[$cat->parent]->children = array();
1112         }
1113         while(isset($allcats[$cat->parent]->children[$sortorder])) {
1114             $sortorder++;
1115         }
1116         $allcats[$cat->parent]->children[$sortorder] = $cat;
1117     }
1118     unset($allcats);
1120     // add broken cats to category tree
1121     if ($brokencats) {
1122         $defaultcat = reset($topcats);
1123         foreach ($brokencats as $cat) {
1124             $topcats[] = $cat;
1125         }
1126     }
1128     // now walk recursively the tree and fix any problems found
1129     $sortorder = 0;
1130     $fixcontexts = array();
1131     _fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts);
1133     // detect if there are "multiple" frontpage courses and fix them if needed
1134     $frontcourses = $DB->get_records('course', array('category'=>0), 'id');
1135     if (count($frontcourses) > 1) {
1136         if (isset($frontcourses[SITEID])) {
1137             $frontcourse = $frontcourses[SITEID];
1138             unset($frontcourses[SITEID]);
1139         } else {
1140             $frontcourse = array_shift($frontcourses);
1141         }
1142         $defaultcat = reset($topcats);
1143         foreach ($frontcourses as $course) {
1144             $DB->set_field('course', 'category', $defaultcat->id, array('id'=>$course->id));
1145             $context = context_course::instance($course->id);
1146             $fixcontexts[$context->id] = $context;
1147         }
1148         unset($frontcourses);
1149     } else {
1150         $frontcourse = reset($frontcourses);
1151     }
1153     // now fix the paths and depths in context table if needed
1154     if ($fixcontexts) {
1155         foreach ($fixcontexts as $fixcontext) {
1156             $fixcontext->reset_paths(false);
1157         }
1158         context_helper::build_all_paths(false);
1159         unset($fixcontexts);
1160     }
1162     // release memory
1163     unset($topcats);
1164     unset($brokencats);
1165     unset($fixcontexts);
1167     // fix frontpage course sortorder
1168     if ($frontcourse->sortorder != 1) {
1169         $DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id));
1170     }
1172     // now fix the course counts in category records if needed
1173     $sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
1174               FROM {course_categories} cc
1175               LEFT JOIN {course} c ON c.category = cc.id
1176           GROUP BY cc.id, cc.coursecount
1177             HAVING cc.coursecount <> COUNT(c.id)";
1179     if ($updatecounts = $DB->get_records_sql($sql)) {
1180         // categories with more courses than MAX_COURSES_IN_CATEGORY
1181         $categories = array();
1182         foreach ($updatecounts as $cat) {
1183             $cat->coursecount = $cat->newcount;
1184             if ($cat->coursecount >= MAX_COURSES_IN_CATEGORY) {
1185                 $categories[] = $cat->id;
1186             }
1187             unset($cat->newcount);
1188             $DB->update_record_raw('course_categories', $cat, true);
1189         }
1190         if (!empty($categories)) {
1191             $str = implode(', ', $categories);
1192             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);
1193         }
1194     }
1196     // now make sure that sortorders in course table are withing the category sortorder ranges
1197     $sql = "SELECT DISTINCT cc.id, cc.sortorder
1198               FROM {course_categories} cc
1199               JOIN {course} c ON c.category = cc.id
1200              WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY;
1202     if ($fixcategories = $DB->get_records_sql($sql)) {
1203         //fix the course sortorder ranges
1204         foreach ($fixcategories as $cat) {
1205             $sql = "UPDATE {course}
1206                        SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY)." + ?
1207                      WHERE category = ?";
1208             $DB->execute($sql, array($cat->sortorder, $cat->id));
1209         }
1210     }
1211     unset($fixcategories);
1213     // categories having courses with sortorder duplicates or having gaps in sortorder
1214     $sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
1215               FROM {course} c1
1216               JOIN {course} c2 ON c1.sortorder = c2.sortorder
1217               JOIN {course_categories} cc ON (c1.category = cc.id)
1218              WHERE c1.id <> c2.id";
1219     $fixcategories = $DB->get_records_sql($sql);
1221     $sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
1222               FROM {course_categories} cc
1223               JOIN {course} c ON c.category = cc.id
1224           GROUP BY cc.id, cc.sortorder, cc.coursecount
1225             HAVING (MAX(c.sortorder) <>  cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <>  cc.sortorder + 1)";
1226     $gapcategories = $DB->get_records_sql($sql);
1228     foreach ($gapcategories as $cat) {
1229         if (isset($fixcategories[$cat->id])) {
1230             // duplicates detected already
1232         } else if ($cat->minsort == $cat->sortorder and $cat->maxsort == $cat->sortorder + $cat->coursecount - 1) {
1233             // easy - new course inserted with sortorder 0, the rest is ok
1234             $sql = "UPDATE {course}
1235                        SET sortorder = sortorder + 1
1236                      WHERE category = ?";
1237             $DB->execute($sql, array($cat->id));
1239         } else {
1240             // it needs full resorting
1241             $fixcategories[$cat->id] = $cat;
1242         }
1243     }
1244     unset($gapcategories);
1246     // fix course sortorders in problematic categories only
1247     foreach ($fixcategories as $cat) {
1248         $i = 1;
1249         $courses = $DB->get_records('course', array('category'=>$cat->id), 'sortorder ASC, id DESC', 'id, sortorder');
1250         foreach ($courses as $course) {
1251             if ($course->sortorder != $cat->sortorder + $i) {
1252                 $course->sortorder = $cat->sortorder + $i;
1253                 $DB->update_record_raw('course', $course, true);
1254             }
1255             $i++;
1256         }
1257     }
1260 /**
1261  * Internal recursive category verification function, do not use directly!
1262  *
1263  * @todo Document the arguments of this function better
1264  *
1265  * @global object
1266  * @uses MAX_COURSES_IN_CATEGORY
1267  * @uses CONTEXT_COURSECAT
1268  * @param array $children
1269  * @param int $sortorder
1270  * @param string $parent
1271  * @param int $depth
1272  * @param string $path
1273  * @param array $fixcontexts
1274  * @return void
1275  */
1276 function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
1277     global $DB;
1279     $depth++;
1281     foreach ($children as $cat) {
1282         $sortorder = $sortorder + MAX_COURSES_IN_CATEGORY;
1283         $update = false;
1284         if ($parent != $cat->parent or $depth != $cat->depth or $path.'/'.$cat->id != $cat->path) {
1285             $cat->parent = $parent;
1286             $cat->depth  = $depth;
1287             $cat->path   = $path.'/'.$cat->id;
1288             $update = true;
1290             // make sure context caches are rebuild and dirty contexts marked
1291             $context = context_coursecat::instance($cat->id);
1292             $fixcontexts[$context->id] = $context;
1293         }
1294         if ($cat->sortorder != $sortorder) {
1295             $cat->sortorder = $sortorder;
1296             $update = true;
1297         }
1298         if ($update) {
1299             $DB->update_record('course_categories', $cat, true);
1300         }
1301         if (isset($cat->children)) {
1302             _fix_course_cats($cat->children, $sortorder, $cat->id, $cat->depth, $cat->path, $fixcontexts);
1303         }
1304     }
1307 /**
1308  * List of remote courses that a user has access to via MNET.
1309  * Works only on the IDP
1310  *
1311  * @global object
1312  * @global object
1313  * @param int @userid The user id to get remote courses for
1314  * @return array Array of {@link $COURSE} of course objects
1315  */
1316 function get_my_remotecourses($userid=0) {
1317     global $DB, $USER;
1319     if (empty($userid)) {
1320         $userid = $USER->id;
1321     }
1323     // we can not use SELECT DISTINCT + text field (summary) because of MS SQL and Oracle, subselect used therefore
1324     $sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
1325                    c.hostid, c.summary, c.summaryformat, c.categoryname AS cat_name,
1326                    h.name AS hostname
1327               FROM {mnetservice_enrol_courses} c
1328               JOIN (SELECT DISTINCT hostid, remotecourseid
1329                       FROM {mnetservice_enrol_enrolments}
1330                      WHERE userid = ?
1331                    ) e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
1332               JOIN {mnet_host} h ON h.id = c.hostid";
1334     return $DB->get_records_sql($sql, array($userid));
1337 /**
1338  * List of remote hosts that a user has access to via MNET.
1339  * Works on the SP
1340  *
1341  * @global object
1342  * @global object
1343  * @return array|bool Array of host objects or false
1344  */
1345 function get_my_remotehosts() {
1346     global $CFG, $USER;
1348     if ($USER->mnethostid == $CFG->mnet_localhost_id) {
1349         return false; // Return nothing on the IDP
1350     }
1351     if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
1352         return $USER->mnet_foreign_host_array;
1353     }
1354     return false;
1357 /**
1358  * This function creates a default separated/connected scale
1359  *
1360  * This function creates a default separated/connected scale
1361  * so there's something in the database.  The locations of
1362  * strings and files is a bit odd, but this is because we
1363  * need to maintain backward compatibility with many different
1364  * existing language translations and older sites.
1365  *
1366  * @global object
1367  * @return void
1368  */
1369 function make_default_scale() {
1370     global $DB;
1372     $defaultscale = new stdClass();
1373     $defaultscale->courseid = 0;
1374     $defaultscale->userid = 0;
1375     $defaultscale->name  = get_string('separateandconnected');
1376     $defaultscale->description = get_string('separateandconnectedinfo');
1377     $defaultscale->scale = get_string('postrating1', 'forum').','.
1378                            get_string('postrating2', 'forum').','.
1379                            get_string('postrating3', 'forum');
1380     $defaultscale->timemodified = time();
1382     $defaultscale->id = $DB->insert_record('scale', $defaultscale);
1383     $DB->execute("UPDATE {forum} SET scale = ?", array($defaultscale->id));
1387 /**
1388  * Returns a menu of all available scales from the site as well as the given course
1389  *
1390  * @global object
1391  * @param int $courseid The id of the course as found in the 'course' table.
1392  * @return array
1393  */
1394 function get_scales_menu($courseid=0) {
1395     global $DB;
1397     $sql = "SELECT id, name
1398               FROM {scale}
1399              WHERE courseid = 0 or courseid = ?
1400           ORDER BY courseid ASC, name ASC";
1401     $params = array($courseid);
1403     if ($scales = $DB->get_records_sql_menu($sql, $params)) {
1404         return $scales;
1405     }
1407     make_default_scale();
1409     return $DB->get_records_sql_menu($sql, $params);
1414 /**
1415  * Given a set of timezone records, put them in the database,  replacing what is there
1416  *
1417  * @global object
1418  * @param array $timezones An array of timezone records
1419  * @return void
1420  */
1421 function update_timezone_records($timezones) {
1422     global $DB;
1424 /// Clear out all the old stuff
1425     $DB->delete_records('timezone');
1427 /// Insert all the new stuff
1428     foreach ($timezones as $timezone) {
1429         if (is_array($timezone)) {
1430             $timezone = (object)$timezone;
1431         }
1432         $DB->insert_record('timezone', $timezone);
1433     }
1437 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1439 /**
1440  * Just gets a raw list of all modules in a course
1441  *
1442  * @global object
1443  * @param int $courseid The id of the course as found in the 'course' table.
1444  * @return array
1445  */
1446 function get_course_mods($courseid) {
1447     global $DB;
1449     if (empty($courseid)) {
1450         return false; // avoid warnings
1451     }
1453     return $DB->get_records_sql("SELECT cm.*, m.name as modname
1454                                    FROM {modules} m, {course_modules} cm
1455                                   WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
1456                                 array($courseid)); // no disabled mods
1460 /**
1461  * Given an id of a course module, finds the coursemodule description
1462  *
1463  * @global object
1464  * @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
1465  * @param int $cmid course module id (id in course_modules table)
1466  * @param int $courseid optional course id for extra validation
1467  * @param bool $sectionnum include relative section number (0,1,2 ...)
1468  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1469  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1470  *                        MUST_EXIST means throw exception if no record or multiple records found
1471  * @return stdClass
1472  */
1473 function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1474     global $DB;
1476     $params = array('cmid'=>$cmid);
1478     if (!$modulename) {
1479         if (!$modulename = $DB->get_field_sql("SELECT md.name
1480                                                  FROM {modules} md
1481                                                  JOIN {course_modules} cm ON cm.module = md.id
1482                                                 WHERE cm.id = :cmid", $params, $strictness)) {
1483             return false;
1484         }
1485     }
1487     $params['modulename'] = $modulename;
1489     $courseselect = "";
1490     $sectionfield = "";
1491     $sectionjoin  = "";
1493     if ($courseid) {
1494         $courseselect = "AND cm.course = :courseid";
1495         $params['courseid'] = $courseid;
1496     }
1498     if ($sectionnum) {
1499         $sectionfield = ", cw.section AS sectionnum";
1500         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1501     }
1503     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1504               FROM {course_modules} cm
1505                    JOIN {modules} md ON md.id = cm.module
1506                    JOIN {".$modulename."} m ON m.id = cm.instance
1507                    $sectionjoin
1508              WHERE cm.id = :cmid AND md.name = :modulename
1509                    $courseselect";
1511     return $DB->get_record_sql($sql, $params, $strictness);
1514 /**
1515  * Given an instance number of a module, finds the coursemodule description
1516  *
1517  * @global object
1518  * @param string $modulename name of module type, eg. resource, assignment,...
1519  * @param int $instance module instance number (id in resource, assignment etc. table)
1520  * @param int $courseid optional course id for extra validation
1521  * @param bool $sectionnum include relative section number (0,1,2 ...)
1522  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1523  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1524  *                        MUST_EXIST means throw exception if no record or multiple records found
1525  * @return stdClass
1526  */
1527 function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1528     global $DB;
1530     $params = array('instance'=>$instance, 'modulename'=>$modulename);
1532     $courseselect = "";
1533     $sectionfield = "";
1534     $sectionjoin  = "";
1536     if ($courseid) {
1537         $courseselect = "AND cm.course = :courseid";
1538         $params['courseid'] = $courseid;
1539     }
1541     if ($sectionnum) {
1542         $sectionfield = ", cw.section AS sectionnum";
1543         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1544     }
1546     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1547               FROM {course_modules} cm
1548                    JOIN {modules} md ON md.id = cm.module
1549                    JOIN {".$modulename."} m ON m.id = cm.instance
1550                    $sectionjoin
1551              WHERE m.id = :instance AND md.name = :modulename
1552                    $courseselect";
1554     return $DB->get_record_sql($sql, $params, $strictness);
1557 /**
1558  * Returns all course modules of given activity in course
1559  *
1560  * @param string $modulename The module name (forum, quiz, etc.)
1561  * @param int $courseid The course id to get modules for
1562  * @param string $extrafields extra fields starting with m.
1563  * @return array Array of results
1564  */
1565 function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
1566     global $DB;
1568     if (!empty($extrafields)) {
1569         $extrafields = ", $extrafields";
1570     }
1571     $params = array();
1572     $params['courseid'] = $courseid;
1573     $params['modulename'] = $modulename;
1576     return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
1577                                    FROM {course_modules} cm, {modules} md, {".$modulename."} m
1578                                   WHERE cm.course = :courseid AND
1579                                         cm.instance = m.id AND
1580                                         md.name = :modulename AND
1581                                         md.id = cm.module", $params);
1584 /**
1585  * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1586  *
1587  * Returns an array of all the active instances of a particular
1588  * module in given courses, sorted in the order they are defined
1589  * in the course. Returns an empty array on any errors.
1590  *
1591  * The returned objects includle the columns cw.section, cm.visible,
1592  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1593  *
1594  * @global object
1595  * @global object
1596  * @param string $modulename The name of the module to get instances for
1597  * @param array $courses an array of course objects.
1598  * @param int $userid
1599  * @param int $includeinvisible
1600  * @return array of module instance objects, including some extra fields from the course_modules
1601  *          and course_sections tables, or an empty array if an error occurred.
1602  */
1603 function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
1604     global $CFG, $DB;
1606     $outputarray = array();
1608     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1609         return $outputarray;
1610     }
1612     list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED, 'c0');
1613     $params['modulename'] = $modulename;
1615     if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
1616                                                  cm.groupmode, cm.groupingid, cm.groupmembersonly
1617                                             FROM {course_modules} cm, {course_sections} cw, {modules} md,
1618                                                  {".$modulename."} m
1619                                            WHERE cm.course $coursessql AND
1620                                                  cm.instance = m.id AND
1621                                                  cm.section = cw.id AND
1622                                                  md.name = :modulename AND
1623                                                  md.id = cm.module", $params)) {
1624         return $outputarray;
1625     }
1627     foreach ($courses as $course) {
1628         $modinfo = get_fast_modinfo($course, $userid);
1630         if (empty($modinfo->instances[$modulename])) {
1631             continue;
1632         }
1634         foreach ($modinfo->instances[$modulename] as $cm) {
1635             if (!$includeinvisible and !$cm->uservisible) {
1636                 continue;
1637             }
1638             if (!isset($rawmods[$cm->id])) {
1639                 continue;
1640             }
1641             $instance = $rawmods[$cm->id];
1642             if (!empty($cm->extra)) {
1643                 $instance->extra = $cm->extra;
1644             }
1645             $outputarray[] = $instance;
1646         }
1647     }
1649     return $outputarray;
1652 /**
1653  * Returns an array of all the active instances of a particular module in a given course,
1654  * sorted in the order they are defined.
1655  *
1656  * Returns an array of all the active instances of a particular
1657  * module in a given course, sorted in the order they are defined
1658  * in the course. Returns an empty array on any errors.
1659  *
1660  * The returned objects includle the columns cw.section, cm.visible,
1661  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1662  *
1663  * Simply calls {@link all_instances_in_courses()} with a single provided course
1664  *
1665  * @param string $modulename The name of the module to get instances for
1666  * @param object $course The course obect.
1667  * @return array of module instance objects, including some extra fields from the course_modules
1668  *          and course_sections tables, or an empty array if an error occurred.
1669  * @param int $userid
1670  * @param int $includeinvisible
1671  */
1672 function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
1673     return get_all_instances_in_courses($modulename, array($course->id => $course), $userid, $includeinvisible);
1677 /**
1678  * Determine whether a module instance is visible within a course
1679  *
1680  * Given a valid module object with info about the id and course,
1681  * and the module's type (eg "forum") returns whether the object
1682  * is visible or not, groupmembersonly visibility not tested
1683  *
1684  * @global object
1686  * @param $moduletype Name of the module eg 'forum'
1687  * @param $module Object which is the instance of the module
1688  * @return bool Success
1689  */
1690 function instance_is_visible($moduletype, $module) {
1691     global $DB;
1693     if (!empty($module->id)) {
1694         $params = array('courseid'=>$module->course, 'moduletype'=>$moduletype, 'moduleid'=>$module->id);
1695         if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
1696                                                FROM {course_modules} cm, {modules} m
1697                                               WHERE cm.course = :courseid AND
1698                                                     cm.module = m.id AND
1699                                                     m.name = :moduletype AND
1700                                                     cm.instance = :moduleid", $params)) {
1702             foreach ($records as $record) { // there should only be one - use the first one
1703                 return $record->visible;
1704             }
1705         }
1706     }
1707     return true;  // visible by default!
1710 /**
1711  * Determine whether a course module is visible within a course,
1712  * this is different from instance_is_visible() - faster and visibility for user
1713  *
1714  * @global object
1715  * @global object
1716  * @uses DEBUG_DEVELOPER
1717  * @uses CONTEXT_MODULE
1718  * @uses CONDITION_MISSING_EXTRATABLE
1719  * @param object $cm object
1720  * @param int $userid empty means current user
1721  * @return bool Success
1722  */
1723 function coursemodule_visible_for_user($cm, $userid=0) {
1724     global $USER,$CFG;
1726     if (empty($cm->id)) {
1727         debugging("Incorrect course module parameter!", DEBUG_DEVELOPER);
1728         return false;
1729     }
1730     if (empty($userid)) {
1731         $userid = $USER->id;
1732     }
1733     if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', context_module::instance($cm->id), $userid)) {
1734         return false;
1735     }
1736     if ($CFG->enableavailability) {
1737         require_once($CFG->libdir.'/conditionlib.php');
1738         $ci=new condition_info($cm,CONDITION_MISSING_EXTRATABLE);
1739         if(!$ci->is_available($cm->availableinfo,false,$userid) and
1740             !has_capability('moodle/course:viewhiddenactivities',
1741                 context_module::instance($cm->id), $userid)) {
1742             return false;
1743         }
1744     }
1745     return groups_course_module_visible($cm, $userid);
1751 /// LOG FUNCTIONS /////////////////////////////////////////////////////
1754 /**
1755  * Add an entry to the log table.
1756  *
1757  * Add an entry to the log table.  These are "action" focussed rather
1758  * than web server hits, and provide a way to easily reconstruct what
1759  * any particular student has been doing.
1760  *
1761  * @package core
1762  * @category log
1763  * @global moodle_database $DB
1764  * @global stdClass $CFG
1765  * @global stdClass $USER
1766  * @uses SITEID
1767  * @uses DEBUG_DEVELOPER
1768  * @uses DEBUG_ALL
1769  * @param    int     $courseid  The course id
1770  * @param    string  $module  The module name  e.g. forum, journal, resource, course, user etc
1771  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
1772  * @param    string  $url     The file and parameters used to see the results of the action
1773  * @param    string  $info    Additional description information
1774  * @param    string  $cm      The course_module->id if there is one
1775  * @param    string  $user    If log regards $user other than $USER
1776  * @return void
1777  */
1778 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
1779     // Note that this function intentionally does not follow the normal Moodle DB access idioms.
1780     // This is for a good reason: it is the most frequently used DB update function,
1781     // so it has been optimised for speed.
1782     global $DB, $CFG, $USER;
1784     if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
1785         $cm = 0;
1786     }
1788     if ($user) {
1789         $userid = $user;
1790     } else {
1791         if (session_is_loggedinas()) {  // Don't log
1792             return;
1793         }
1794         $userid = empty($USER->id) ? '0' : $USER->id;
1795     }
1797     if (isset($CFG->logguests) and !$CFG->logguests) {
1798         if (!$userid or isguestuser($userid)) {
1799             return;
1800         }
1801     }
1803     $REMOTE_ADDR = getremoteaddr();
1805     $timenow = time();
1806     $info = $info;
1807     if (!empty($url)) { // could break doing html_entity_decode on an empty var.
1808         $url = html_entity_decode($url, ENT_QUOTES, 'UTF-8');
1809     } else {
1810         $url = '';
1811     }
1813     // Restrict length of log lines to the space actually available in the
1814     // database so that it doesn't cause a DB error. Log a warning so that
1815     // developers can avoid doing things which are likely to cause this on a
1816     // routine basis.
1817     if(!empty($info) && textlib::strlen($info)>255) {
1818         $info = textlib::substr($info,0,252).'...';
1819         debugging('Warning: logged very long info',DEBUG_DEVELOPER);
1820     }
1822     // If the 100 field size is changed, also need to alter print_log in course/lib.php
1823     if(!empty($url) && textlib::strlen($url)>100) {
1824         $url = textlib::substr($url,0,97).'...';
1825         debugging('Warning: logged very long URL',DEBUG_DEVELOPER);
1826     }
1828     if (defined('MDL_PERFDB')) { global $PERF ; $PERF->logwrites++;};
1830     $log = array('time'=>$timenow, 'userid'=>$userid, 'course'=>$courseid, 'ip'=>$REMOTE_ADDR, 'module'=>$module,
1831                  'cmid'=>$cm, 'action'=>$action, 'url'=>$url, 'info'=>$info);
1833     try {
1834         $DB->insert_record_raw('log', $log, false);
1835     } catch (dml_exception $e) {
1836         debugging('Error: Could not insert a new entry to the Moodle log. '. $e->error, DEBUG_ALL);
1838         // MDL-11893, alert $CFG->supportemail if insert into log failed
1839         if ($CFG->supportemail and empty($CFG->noemailever)) {
1840             // email_to_user is not usable because email_to_user tries to write to the logs table,
1841             // and this will get caught in an infinite loop, if disk is full
1842             $site = get_site();
1843             $subject = 'Insert into log failed at your moodle site '.$site->fullname;
1844             $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";
1845             $message .= "The failed query parameters are:\n\n" . var_export($log, true);
1847             $lasttime = get_config('admin', 'lastloginserterrormail');
1848             if(empty($lasttime) || time() - $lasttime > 60*60*24) { // limit to 1 email per day
1849                 //using email directly rather than messaging as they may not be able to log in to access a message
1850                 mail($CFG->supportemail, $subject, $message);
1851                 set_config('lastloginserterrormail', time(), 'admin');
1852             }
1853         }
1854     }
1857 /**
1858  * Store user last access times - called when use enters a course or site
1859  *
1860  * @package core
1861  * @category log
1862  * @global stdClass $USER
1863  * @global stdClass $CFG
1864  * @global moodle_database $DB
1865  * @uses LASTACCESS_UPDATE_SECS
1866  * @uses SITEID
1867  * @param int $courseid  empty courseid means site
1868  * @return void
1869  */
1870 function user_accesstime_log($courseid=0) {
1871     global $USER, $CFG, $DB;
1873     if (!isloggedin() or session_is_loggedinas()) {
1874         // no access tracking
1875         return;
1876     }
1878     if (isguestuser()) {
1879         // Do not update guest access times/ips for performance.
1880         return;
1881     }
1883     if (empty($courseid)) {
1884         $courseid = SITEID;
1885     }
1887     $timenow = time();
1889 /// Store site lastaccess time for the current user
1890     if ($timenow - $USER->lastaccess > LASTACCESS_UPDATE_SECS) {
1891     /// Update $USER->lastaccess for next checks
1892         $USER->lastaccess = $timenow;
1894         $last = new stdClass();
1895         $last->id         = $USER->id;
1896         $last->lastip     = getremoteaddr();
1897         $last->lastaccess = $timenow;
1899         $DB->update_record_raw('user', $last);
1900     }
1902     if ($courseid == SITEID) {
1903     ///  no user_lastaccess for frontpage
1904         return;
1905     }
1907 /// Store course lastaccess times for the current user
1908     if (empty($USER->currentcourseaccess[$courseid]) or ($timenow - $USER->currentcourseaccess[$courseid] > LASTACCESS_UPDATE_SECS)) {
1910         $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id, 'courseid'=>$courseid));
1912         if ($lastaccess === false) {
1913             // Update course lastaccess for next checks
1914             $USER->currentcourseaccess[$courseid] = $timenow;
1916             $last = new stdClass();
1917             $last->userid     = $USER->id;
1918             $last->courseid   = $courseid;
1919             $last->timeaccess = $timenow;
1920             $DB->insert_record_raw('user_lastaccess', $last, false);
1922         } else if ($timenow - $lastaccess <  LASTACCESS_UPDATE_SECS) {
1923             // no need to update now, it was updated recently in concurrent login ;-)
1925         } else {
1926             // Update course lastaccess for next checks
1927             $USER->currentcourseaccess[$courseid] = $timenow;
1929             $DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id, 'courseid'=>$courseid));
1930         }
1931     }
1934 /**
1935  * Select all log records based on SQL criteria
1936  *
1937  * @package core
1938  * @category log
1939  * @global moodle_database $DB
1940  * @param string $select SQL select criteria
1941  * @param array $params named sql type params
1942  * @param string $order SQL order by clause to sort the records returned
1943  * @param string $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set)
1944  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set)
1945  * @param int $totalcount Passed in by reference.
1946  * @return array
1947  */
1948 function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
1949     global $DB;
1951     if ($order) {
1952         $order = "ORDER BY $order";
1953     }
1955     $selectsql = "";
1956     $countsql  = "";
1958     if ($select) {
1959         $select = "WHERE $select";
1960     }
1962     $sql = "SELECT COUNT(*)
1963               FROM {log} l
1964            $select";
1966     $totalcount = $DB->count_records_sql($sql, $params);
1968     $sql = "SELECT l.*, u.firstname, u.lastname, u.picture
1969               FROM {log} l
1970               LEFT JOIN {user} u ON l.userid = u.id
1971            $select
1972             $order";
1974     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum) ;
1978 /**
1979  * Select all log records for a given course and user
1980  *
1981  * @package core
1982  * @category log
1983  * @global moodle_database $DB
1984  * @uses DAYSECS
1985  * @param int $userid The id of the user as found in the 'user' table.
1986  * @param int $courseid The id of the course as found in the 'course' table.
1987  * @param string $coursestart unix timestamp representing course start date and time.
1988  * @return array
1989  */
1990 function get_logs_usercourse($userid, $courseid, $coursestart) {
1991     global $DB;
1993     $params = array();
1995     $courseselect = '';
1996     if ($courseid) {
1997         $courseselect = "AND course = :courseid";
1998         $params['courseid'] = $courseid;
1999     }
2000     $params['userid'] = $userid;
2001     $$coursestart = (int)$coursestart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
2003     return $DB->get_records_sql("SELECT FLOOR((time - $coursestart)/". DAYSECS .") AS day, COUNT(*) AS num
2004                                    FROM {log}
2005                                   WHERE userid = :userid
2006                                         AND time > $coursestart $courseselect
2007                                GROUP BY FLOOR((time - $coursestart)/". DAYSECS .")", $params);
2010 /**
2011  * Select all log records for a given course, user, and day
2012  *
2013  * @package core
2014  * @category log
2015  * @global moodle_database $DB
2016  * @uses HOURSECS
2017  * @param int $userid The id of the user as found in the 'user' table.
2018  * @param int $courseid The id of the course as found in the 'course' table.
2019  * @param string $daystart unix timestamp of the start of the day for which the logs needs to be retrived
2020  * @return array
2021  */
2022 function get_logs_userday($userid, $courseid, $daystart) {
2023     global $DB;
2025     $params = array('userid'=>$userid);
2027     $courseselect = '';
2028     if ($courseid) {
2029         $courseselect = "AND course = :courseid";
2030         $params['courseid'] = $courseid;
2031     }
2032     $daystart = (int)$daystart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
2034     return $DB->get_records_sql("SELECT FLOOR((time - $daystart)/". HOURSECS .") AS hour, COUNT(*) AS num
2035                                    FROM {log}
2036                                   WHERE userid = :userid
2037                                         AND time > $daystart $courseselect
2038                                GROUP BY FLOOR((time - $daystart)/". HOURSECS .") ", $params);
2041 /**
2042  * Returns an object with counts of failed login attempts
2043  *
2044  * Returns information about failed login attempts.  If the current user is
2045  * an admin, then two numbers are returned:  the number of attempts and the
2046  * number of accounts.  For non-admins, only the attempts on the given user
2047  * are shown.
2048  *
2049  * @global moodle_database $DB
2050  * @uses CONTEXT_SYSTEM
2051  * @param string $mode Either 'admin' or 'everybody'
2052  * @param string $username The username we are searching for
2053  * @param string $lastlogin The date from which we are searching
2054  * @return int
2055  */
2056 function count_login_failures($mode, $username, $lastlogin) {
2057     global $DB;
2059     $params = array('mode'=>$mode, 'username'=>$username, 'lastlogin'=>$lastlogin);
2060     $select = "module='login' AND action='error' AND time > :lastlogin";
2062     $count = new stdClass();
2064     if (is_siteadmin()) {
2065         if ($count->attempts = $DB->count_records_select('log', $select, $params)) {
2066             $count->accounts = $DB->count_records_select('log', $select, $params, 'COUNT(DISTINCT info)');
2067             return $count;
2068         }
2069     } else if ($mode == 'everybody') {
2070         if ($count->attempts = $DB->count_records_select('log', "$select AND info = :username", $params)) {
2071             return $count;
2072         }
2073     }
2074     return NULL;
2078 /// GENERAL HELPFUL THINGS  ///////////////////////////////////
2080 /**
2081  * Dumps a given object's information for debugging purposes
2082  *
2083  * When used in a CLI script, the object's information is written to the standard
2084  * error output stream. When used in a web script, the object is dumped to a
2085  * pre-formatted block with the "notifytiny" CSS class.
2086  *
2087  * @param mixed $object The data to be printed
2088  * @return void output is echo'd
2089  */
2090 function print_object($object) {
2092     // we may need a lot of memory here
2093     raise_memory_limit(MEMORY_EXTRA);
2095     if (CLI_SCRIPT) {
2096         fwrite(STDERR, print_r($object, true));
2097         fwrite(STDERR, PHP_EOL);
2098     } else {
2099         echo html_writer::tag('pre', s(print_r($object, true)), array('class' => 'notifytiny'));
2100     }
2103 /**
2104  * This function is the official hook inside XMLDB stuff to delegate its debug to one
2105  * external function.
2106  *
2107  * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
2108  * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
2109  *
2110  * @uses DEBUG_DEVELOPER
2111  * @param string $message string contains the error message
2112  * @param object $object object XMLDB object that fired the debug
2113  */
2114 function xmldb_debug($message, $object) {
2116     debugging($message, DEBUG_DEVELOPER);
2119 /**
2120  * @global object
2121  * @uses CONTEXT_COURSECAT
2122  * @return boolean Whether the user can create courses in any category in the system.
2123  */
2124 function user_can_create_courses() {
2125     global $DB;
2126     $catsrs = $DB->get_recordset('course_categories');
2127     foreach ($catsrs as $cat) {
2128         if (has_capability('moodle/course:create', context_coursecat::instance($cat->id))) {
2129             $catsrs->close();
2130             return true;
2131         }
2132     }
2133     $catsrs->close();
2134     return false;