Merge branch 'w13_MDL-37742_m25_dirtyoracle' of git://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);
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, $page, $recordsperpage, &$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     $fields = array_diff(array_keys($DB->get_columns('course')), array('modinfo', 'sectioncache'));
911     $sql = "SELECT c.".join(',c.',$fields)." $ccselect
912               FROM {course} c
913            $ccjoin
914              WHERE $searchcond AND c.id <> ".SITEID."
915           ORDER BY $sort";
917     $rs = $DB->get_recordset_sql($sql, $params);
918     foreach($rs as $course) {
919         if (!$course->visible) {
920             // preload contexts only for hidden courses or courses we need to return
921             context_instance_preload($course);
922             $coursecontext = context_course::instance($course->id);
923             if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
924                 continue;
925             }
926         }
927         // Don't exit this loop till the end
928         // we need to count all the visible courses
929         // to update $totalcount
930         if ($c >= $limitfrom && $c < $limitto) {
931             $courses[$course->id] = $course;
932         }
933         $c++;
934     }
935     $rs->close();
937     // our caller expects 2 bits of data - our return
938     // array, and an updated $totalcount
939     $totalcount = $c;
940     return $courses;
943 /**
944  * Fixes course category and course sortorder, also verifies category and course parents and paths.
945  * (circular references are not fixed)
946  *
947  * @global object
948  * @global object
949  * @uses MAX_COURSES_IN_CATEGORY
950  * @uses MAX_COURSE_CATEGORIES
951  * @uses SITEID
952  * @uses CONTEXT_COURSE
953  * @return void
954  */
955 function fix_course_sortorder() {
956     global $DB, $SITE;
958     //WARNING: this is PHP5 only code!
960     // if there are any changes made to courses or categories we will trigger
961     // the cache events to purge all cached courses/categories data
962     $cacheevents = array();
964     if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
965         //move all categories that are not sorted yet to the end
966         $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('sortorder'=>0));
967         $cacheevents['changesincoursecat'] = true;
968     }
970     $allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
971     $topcats    = array();
972     $brokencats = array();
973     foreach ($allcats as $cat) {
974         $sortorder = (int)$cat->sortorder;
975         if (!$cat->parent) {
976             while(isset($topcats[$sortorder])) {
977                 $sortorder++;
978             }
979             $topcats[$sortorder] = $cat;
980             continue;
981         }
982         if (!isset($allcats[$cat->parent])) {
983             $brokencats[] = $cat;
984             continue;
985         }
986         if (!isset($allcats[$cat->parent]->children)) {
987             $allcats[$cat->parent]->children = array();
988         }
989         while(isset($allcats[$cat->parent]->children[$sortorder])) {
990             $sortorder++;
991         }
992         $allcats[$cat->parent]->children[$sortorder] = $cat;
993     }
994     unset($allcats);
996     // add broken cats to category tree
997     if ($brokencats) {
998         $defaultcat = reset($topcats);
999         foreach ($brokencats as $cat) {
1000             $topcats[] = $cat;
1001         }
1002     }
1004     // now walk recursively the tree and fix any problems found
1005     $sortorder = 0;
1006     $fixcontexts = array();
1007     if (_fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts)) {
1008         $cacheevents['changesincoursecat'] = true;
1009     }
1011     // detect if there are "multiple" frontpage courses and fix them if needed
1012     $frontcourses = $DB->get_records('course', array('category'=>0), 'id');
1013     if (count($frontcourses) > 1) {
1014         if (isset($frontcourses[SITEID])) {
1015             $frontcourse = $frontcourses[SITEID];
1016             unset($frontcourses[SITEID]);
1017         } else {
1018             $frontcourse = array_shift($frontcourses);
1019         }
1020         $defaultcat = reset($topcats);
1021         foreach ($frontcourses as $course) {
1022             $DB->set_field('course', 'category', $defaultcat->id, array('id'=>$course->id));
1023             $context = context_course::instance($course->id);
1024             $fixcontexts[$context->id] = $context;
1025             $cacheevents['changesincourse'] = true;
1026         }
1027         unset($frontcourses);
1028     } else {
1029         $frontcourse = reset($frontcourses);
1030     }
1032     // now fix the paths and depths in context table if needed
1033     if ($fixcontexts) {
1034         foreach ($fixcontexts as $fixcontext) {
1035             $fixcontext->reset_paths(false);
1036         }
1037         context_helper::build_all_paths(false);
1038         unset($fixcontexts);
1039         $cacheevents['changesincourse'] = true;
1040         $cacheevents['changesincoursecat'] = true;
1041     }
1043     // release memory
1044     unset($topcats);
1045     unset($brokencats);
1046     unset($fixcontexts);
1048     // fix frontpage course sortorder
1049     if ($frontcourse->sortorder != 1) {
1050         $DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id));
1051         $cacheevents['changesincourse'] = true;
1052     }
1054     // now fix the course counts in category records if needed
1055     $sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
1056               FROM {course_categories} cc
1057               LEFT JOIN {course} c ON c.category = cc.id
1058           GROUP BY cc.id, cc.coursecount
1059             HAVING cc.coursecount <> COUNT(c.id)";
1061     if ($updatecounts = $DB->get_records_sql($sql)) {
1062         // categories with more courses than MAX_COURSES_IN_CATEGORY
1063         $categories = array();
1064         foreach ($updatecounts as $cat) {
1065             $cat->coursecount = $cat->newcount;
1066             if ($cat->coursecount >= MAX_COURSES_IN_CATEGORY) {
1067                 $categories[] = $cat->id;
1068             }
1069             unset($cat->newcount);
1070             $DB->update_record_raw('course_categories', $cat, true);
1071         }
1072         if (!empty($categories)) {
1073             $str = implode(', ', $categories);
1074             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);
1075         }
1076         $cacheevents['changesincoursecat'] = true;
1077     }
1079     // now make sure that sortorders in course table are withing the category sortorder ranges
1080     $sql = "SELECT DISTINCT cc.id, cc.sortorder
1081               FROM {course_categories} cc
1082               JOIN {course} c ON c.category = cc.id
1083              WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY;
1085     if ($fixcategories = $DB->get_records_sql($sql)) {
1086         //fix the course sortorder ranges
1087         foreach ($fixcategories as $cat) {
1088             $sql = "UPDATE {course}
1089                        SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY)." + ?
1090                      WHERE category = ?";
1091             $DB->execute($sql, array($cat->sortorder, $cat->id));
1092         }
1093         $cacheevents['changesincoursecat'] = true;
1094     }
1095     unset($fixcategories);
1097     // categories having courses with sortorder duplicates or having gaps in sortorder
1098     $sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
1099               FROM {course} c1
1100               JOIN {course} c2 ON c1.sortorder = c2.sortorder
1101               JOIN {course_categories} cc ON (c1.category = cc.id)
1102              WHERE c1.id <> c2.id";
1103     $fixcategories = $DB->get_records_sql($sql);
1105     $sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
1106               FROM {course_categories} cc
1107               JOIN {course} c ON c.category = cc.id
1108           GROUP BY cc.id, cc.sortorder, cc.coursecount
1109             HAVING (MAX(c.sortorder) <>  cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <>  cc.sortorder + 1)";
1110     $gapcategories = $DB->get_records_sql($sql);
1112     foreach ($gapcategories as $cat) {
1113         if (isset($fixcategories[$cat->id])) {
1114             // duplicates detected already
1116         } else if ($cat->minsort == $cat->sortorder and $cat->maxsort == $cat->sortorder + $cat->coursecount - 1) {
1117             // easy - new course inserted with sortorder 0, the rest is ok
1118             $sql = "UPDATE {course}
1119                        SET sortorder = sortorder + 1
1120                      WHERE category = ?";
1121             $DB->execute($sql, array($cat->id));
1123         } else {
1124             // it needs full resorting
1125             $fixcategories[$cat->id] = $cat;
1126         }
1127         $cacheevents['changesincourse'] = true;
1128     }
1129     unset($gapcategories);
1131     // fix course sortorders in problematic categories only
1132     foreach ($fixcategories as $cat) {
1133         $i = 1;
1134         $courses = $DB->get_records('course', array('category'=>$cat->id), 'sortorder ASC, id DESC', 'id, sortorder');
1135         foreach ($courses as $course) {
1136             if ($course->sortorder != $cat->sortorder + $i) {
1137                 $course->sortorder = $cat->sortorder + $i;
1138                 $DB->update_record_raw('course', $course, true);
1139                 $cacheevents['changesincourse'] = true;
1140             }
1141             $i++;
1142         }
1143     }
1145     // advise all caches that need to be rebuilt
1146     foreach (array_keys($cacheevents) as $event) {
1147         cache_helper::purge_by_event($event);
1148     }
1151 /**
1152  * Internal recursive category verification function, do not use directly!
1153  *
1154  * @todo Document the arguments of this function better
1155  *
1156  * @global object
1157  * @uses MAX_COURSES_IN_CATEGORY
1158  * @uses CONTEXT_COURSECAT
1159  * @param array $children
1160  * @param int $sortorder
1161  * @param string $parent
1162  * @param int $depth
1163  * @param string $path
1164  * @param array $fixcontexts
1165  * @return bool if changes were made
1166  */
1167 function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
1168     global $DB;
1170     $depth++;
1171     $changesmade = false;
1173     foreach ($children as $cat) {
1174         $sortorder = $sortorder + MAX_COURSES_IN_CATEGORY;
1175         $update = false;
1176         if ($parent != $cat->parent or $depth != $cat->depth or $path.'/'.$cat->id != $cat->path) {
1177             $cat->parent = $parent;
1178             $cat->depth  = $depth;
1179             $cat->path   = $path.'/'.$cat->id;
1180             $update = true;
1182             // make sure context caches are rebuild and dirty contexts marked
1183             $context = context_coursecat::instance($cat->id);
1184             $fixcontexts[$context->id] = $context;
1185         }
1186         if ($cat->sortorder != $sortorder) {
1187             $cat->sortorder = $sortorder;
1188             $update = true;
1189         }
1190         if ($update) {
1191             $DB->update_record('course_categories', $cat, true);
1192             $changesmade = true;
1193         }
1194         if (isset($cat->children)) {
1195             if (_fix_course_cats($cat->children, $sortorder, $cat->id, $cat->depth, $cat->path, $fixcontexts)) {
1196                 $changesmade = true;
1197             }
1198         }
1199     }
1200     return $changesmade;
1203 /**
1204  * List of remote courses that a user has access to via MNET.
1205  * Works only on the IDP
1206  *
1207  * @global object
1208  * @global object
1209  * @param int @userid The user id to get remote courses for
1210  * @return array Array of {@link $COURSE} of course objects
1211  */
1212 function get_my_remotecourses($userid=0) {
1213     global $DB, $USER;
1215     if (empty($userid)) {
1216         $userid = $USER->id;
1217     }
1219     // we can not use SELECT DISTINCT + text field (summary) because of MS SQL and Oracle, subselect used therefore
1220     $sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
1221                    c.hostid, c.summary, c.summaryformat, c.categoryname AS cat_name,
1222                    h.name AS hostname
1223               FROM {mnetservice_enrol_courses} c
1224               JOIN (SELECT DISTINCT hostid, remotecourseid
1225                       FROM {mnetservice_enrol_enrolments}
1226                      WHERE userid = ?
1227                    ) e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
1228               JOIN {mnet_host} h ON h.id = c.hostid";
1230     return $DB->get_records_sql($sql, array($userid));
1233 /**
1234  * List of remote hosts that a user has access to via MNET.
1235  * Works on the SP
1236  *
1237  * @global object
1238  * @global object
1239  * @return array|bool Array of host objects or false
1240  */
1241 function get_my_remotehosts() {
1242     global $CFG, $USER;
1244     if ($USER->mnethostid == $CFG->mnet_localhost_id) {
1245         return false; // Return nothing on the IDP
1246     }
1247     if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
1248         return $USER->mnet_foreign_host_array;
1249     }
1250     return false;
1253 /**
1254  * This function creates a default separated/connected scale
1255  *
1256  * This function creates a default separated/connected scale
1257  * so there's something in the database.  The locations of
1258  * strings and files is a bit odd, but this is because we
1259  * need to maintain backward compatibility with many different
1260  * existing language translations and older sites.
1261  *
1262  * @global object
1263  * @return void
1264  */
1265 function make_default_scale() {
1266     global $DB;
1268     $defaultscale = new stdClass();
1269     $defaultscale->courseid = 0;
1270     $defaultscale->userid = 0;
1271     $defaultscale->name  = get_string('separateandconnected');
1272     $defaultscale->description = get_string('separateandconnectedinfo');
1273     $defaultscale->scale = get_string('postrating1', 'forum').','.
1274                            get_string('postrating2', 'forum').','.
1275                            get_string('postrating3', 'forum');
1276     $defaultscale->timemodified = time();
1278     $defaultscale->id = $DB->insert_record('scale', $defaultscale);
1279     $DB->execute("UPDATE {forum} SET scale = ?", array($defaultscale->id));
1283 /**
1284  * Returns a menu of all available scales from the site as well as the given course
1285  *
1286  * @global object
1287  * @param int $courseid The id of the course as found in the 'course' table.
1288  * @return array
1289  */
1290 function get_scales_menu($courseid=0) {
1291     global $DB;
1293     $sql = "SELECT id, name
1294               FROM {scale}
1295              WHERE courseid = 0 or courseid = ?
1296           ORDER BY courseid ASC, name ASC";
1297     $params = array($courseid);
1299     if ($scales = $DB->get_records_sql_menu($sql, $params)) {
1300         return $scales;
1301     }
1303     make_default_scale();
1305     return $DB->get_records_sql_menu($sql, $params);
1310 /**
1311  * Given a set of timezone records, put them in the database,  replacing what is there
1312  *
1313  * @global object
1314  * @param array $timezones An array of timezone records
1315  * @return void
1316  */
1317 function update_timezone_records($timezones) {
1318     global $DB;
1320 /// Clear out all the old stuff
1321     $DB->delete_records('timezone');
1323 /// Insert all the new stuff
1324     foreach ($timezones as $timezone) {
1325         if (is_array($timezone)) {
1326             $timezone = (object)$timezone;
1327         }
1328         $DB->insert_record('timezone', $timezone);
1329     }
1333 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1335 /**
1336  * Just gets a raw list of all modules in a course
1337  *
1338  * @global object
1339  * @param int $courseid The id of the course as found in the 'course' table.
1340  * @return array
1341  */
1342 function get_course_mods($courseid) {
1343     global $DB;
1345     if (empty($courseid)) {
1346         return false; // avoid warnings
1347     }
1349     return $DB->get_records_sql("SELECT cm.*, m.name as modname
1350                                    FROM {modules} m, {course_modules} cm
1351                                   WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
1352                                 array($courseid)); // no disabled mods
1356 /**
1357  * Given an id of a course module, finds the coursemodule description
1358  *
1359  * @global object
1360  * @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
1361  * @param int $cmid course module id (id in course_modules table)
1362  * @param int $courseid optional course id for extra validation
1363  * @param bool $sectionnum include relative section number (0,1,2 ...)
1364  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1365  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1366  *                        MUST_EXIST means throw exception if no record or multiple records found
1367  * @return stdClass
1368  */
1369 function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1370     global $DB;
1372     $params = array('cmid'=>$cmid);
1374     if (!$modulename) {
1375         if (!$modulename = $DB->get_field_sql("SELECT md.name
1376                                                  FROM {modules} md
1377                                                  JOIN {course_modules} cm ON cm.module = md.id
1378                                                 WHERE cm.id = :cmid", $params, $strictness)) {
1379             return false;
1380         }
1381     }
1383     $params['modulename'] = $modulename;
1385     $courseselect = "";
1386     $sectionfield = "";
1387     $sectionjoin  = "";
1389     if ($courseid) {
1390         $courseselect = "AND cm.course = :courseid";
1391         $params['courseid'] = $courseid;
1392     }
1394     if ($sectionnum) {
1395         $sectionfield = ", cw.section AS sectionnum";
1396         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1397     }
1399     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1400               FROM {course_modules} cm
1401                    JOIN {modules} md ON md.id = cm.module
1402                    JOIN {".$modulename."} m ON m.id = cm.instance
1403                    $sectionjoin
1404              WHERE cm.id = :cmid AND md.name = :modulename
1405                    $courseselect";
1407     return $DB->get_record_sql($sql, $params, $strictness);
1410 /**
1411  * Given an instance number of a module, finds the coursemodule description
1412  *
1413  * @global object
1414  * @param string $modulename name of module type, eg. resource, assignment,...
1415  * @param int $instance module instance number (id in resource, assignment etc. table)
1416  * @param int $courseid optional course id for extra validation
1417  * @param bool $sectionnum include relative section number (0,1,2 ...)
1418  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1419  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1420  *                        MUST_EXIST means throw exception if no record or multiple records found
1421  * @return stdClass
1422  */
1423 function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1424     global $DB;
1426     $params = array('instance'=>$instance, 'modulename'=>$modulename);
1428     $courseselect = "";
1429     $sectionfield = "";
1430     $sectionjoin  = "";
1432     if ($courseid) {
1433         $courseselect = "AND cm.course = :courseid";
1434         $params['courseid'] = $courseid;
1435     }
1437     if ($sectionnum) {
1438         $sectionfield = ", cw.section AS sectionnum";
1439         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1440     }
1442     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1443               FROM {course_modules} cm
1444                    JOIN {modules} md ON md.id = cm.module
1445                    JOIN {".$modulename."} m ON m.id = cm.instance
1446                    $sectionjoin
1447              WHERE m.id = :instance AND md.name = :modulename
1448                    $courseselect";
1450     return $DB->get_record_sql($sql, $params, $strictness);
1453 /**
1454  * Returns all course modules of given activity in course
1455  *
1456  * @param string $modulename The module name (forum, quiz, etc.)
1457  * @param int $courseid The course id to get modules for
1458  * @param string $extrafields extra fields starting with m.
1459  * @return array Array of results
1460  */
1461 function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
1462     global $DB;
1464     if (!empty($extrafields)) {
1465         $extrafields = ", $extrafields";
1466     }
1467     $params = array();
1468     $params['courseid'] = $courseid;
1469     $params['modulename'] = $modulename;
1472     return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
1473                                    FROM {course_modules} cm, {modules} md, {".$modulename."} m
1474                                   WHERE cm.course = :courseid AND
1475                                         cm.instance = m.id AND
1476                                         md.name = :modulename AND
1477                                         md.id = cm.module", $params);
1480 /**
1481  * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1482  *
1483  * Returns an array of all the active instances of a particular
1484  * module in given courses, sorted in the order they are defined
1485  * in the course. Returns an empty array on any errors.
1486  *
1487  * The returned objects includle the columns cw.section, cm.visible,
1488  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1489  *
1490  * @global object
1491  * @global object
1492  * @param string $modulename The name of the module to get instances for
1493  * @param array $courses an array of course objects.
1494  * @param int $userid
1495  * @param int $includeinvisible
1496  * @return array of module instance objects, including some extra fields from the course_modules
1497  *          and course_sections tables, or an empty array if an error occurred.
1498  */
1499 function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
1500     global $CFG, $DB;
1502     $outputarray = array();
1504     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1505         return $outputarray;
1506     }
1508     list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED, 'c0');
1509     $params['modulename'] = $modulename;
1511     if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
1512                                                  cm.groupmode, cm.groupingid, cm.groupmembersonly
1513                                             FROM {course_modules} cm, {course_sections} cw, {modules} md,
1514                                                  {".$modulename."} m
1515                                            WHERE cm.course $coursessql AND
1516                                                  cm.instance = m.id AND
1517                                                  cm.section = cw.id AND
1518                                                  md.name = :modulename AND
1519                                                  md.id = cm.module", $params)) {
1520         return $outputarray;
1521     }
1523     foreach ($courses as $course) {
1524         $modinfo = get_fast_modinfo($course, $userid);
1526         if (empty($modinfo->instances[$modulename])) {
1527             continue;
1528         }
1530         foreach ($modinfo->instances[$modulename] as $cm) {
1531             if (!$includeinvisible and !$cm->uservisible) {
1532                 continue;
1533             }
1534             if (!isset($rawmods[$cm->id])) {
1535                 continue;
1536             }
1537             $instance = $rawmods[$cm->id];
1538             if (!empty($cm->extra)) {
1539                 $instance->extra = $cm->extra;
1540             }
1541             $outputarray[] = $instance;
1542         }
1543     }
1545     return $outputarray;
1548 /**
1549  * Returns an array of all the active instances of a particular module in a given course,
1550  * sorted in the order they are defined.
1551  *
1552  * Returns an array of all the active instances of a particular
1553  * module in a given course, sorted in the order they are defined
1554  * in the course. Returns an empty array on any errors.
1555  *
1556  * The returned objects includle the columns cw.section, cm.visible,
1557  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1558  *
1559  * Simply calls {@link all_instances_in_courses()} with a single provided course
1560  *
1561  * @param string $modulename The name of the module to get instances for
1562  * @param object $course The course obect.
1563  * @return array of module instance objects, including some extra fields from the course_modules
1564  *          and course_sections tables, or an empty array if an error occurred.
1565  * @param int $userid
1566  * @param int $includeinvisible
1567  */
1568 function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
1569     return get_all_instances_in_courses($modulename, array($course->id => $course), $userid, $includeinvisible);
1573 /**
1574  * Determine whether a module instance is visible within a course
1575  *
1576  * Given a valid module object with info about the id and course,
1577  * and the module's type (eg "forum") returns whether the object
1578  * is visible or not, groupmembersonly visibility not tested
1579  *
1580  * @global object
1582  * @param $moduletype Name of the module eg 'forum'
1583  * @param $module Object which is the instance of the module
1584  * @return bool Success
1585  */
1586 function instance_is_visible($moduletype, $module) {
1587     global $DB;
1589     if (!empty($module->id)) {
1590         $params = array('courseid'=>$module->course, 'moduletype'=>$moduletype, 'moduleid'=>$module->id);
1591         if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
1592                                                FROM {course_modules} cm, {modules} m
1593                                               WHERE cm.course = :courseid AND
1594                                                     cm.module = m.id AND
1595                                                     m.name = :moduletype AND
1596                                                     cm.instance = :moduleid", $params)) {
1598             foreach ($records as $record) { // there should only be one - use the first one
1599                 return $record->visible;
1600             }
1601         }
1602     }
1603     return true;  // visible by default!
1606 /**
1607  * Determine whether a course module is visible within a course,
1608  * this is different from instance_is_visible() - faster and visibility for user
1609  *
1610  * @global object
1611  * @global object
1612  * @uses DEBUG_DEVELOPER
1613  * @uses CONTEXT_MODULE
1614  * @uses CONDITION_MISSING_EXTRATABLE
1615  * @param object $cm object
1616  * @param int $userid empty means current user
1617  * @return bool Success
1618  */
1619 function coursemodule_visible_for_user($cm, $userid=0) {
1620     global $USER,$CFG;
1622     if (empty($cm->id)) {
1623         debugging("Incorrect course module parameter!", DEBUG_DEVELOPER);
1624         return false;
1625     }
1626     if (empty($userid)) {
1627         $userid = $USER->id;
1628     }
1629     if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', context_module::instance($cm->id), $userid)) {
1630         return false;
1631     }
1632     if ($CFG->enableavailability) {
1633         require_once($CFG->libdir.'/conditionlib.php');
1634         $ci=new condition_info($cm,CONDITION_MISSING_EXTRATABLE);
1635         if(!$ci->is_available($cm->availableinfo,false,$userid) and
1636             !has_capability('moodle/course:viewhiddenactivities',
1637                 context_module::instance($cm->id), $userid)) {
1638             return false;
1639         }
1640     }
1641     return groups_course_module_visible($cm, $userid);
1647 /// LOG FUNCTIONS /////////////////////////////////////////////////////
1650 /**
1651  * Add an entry to the log table.
1652  *
1653  * Add an entry to the log table.  These are "action" focussed rather
1654  * than web server hits, and provide a way to easily reconstruct what
1655  * any particular student has been doing.
1656  *
1657  * @package core
1658  * @category log
1659  * @global moodle_database $DB
1660  * @global stdClass $CFG
1661  * @global stdClass $USER
1662  * @uses SITEID
1663  * @uses DEBUG_DEVELOPER
1664  * @uses DEBUG_ALL
1665  * @param    int     $courseid  The course id
1666  * @param    string  $module  The module name  e.g. forum, journal, resource, course, user etc
1667  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
1668  * @param    string  $url     The file and parameters used to see the results of the action
1669  * @param    string  $info    Additional description information
1670  * @param    string  $cm      The course_module->id if there is one
1671  * @param    string  $user    If log regards $user other than $USER
1672  * @return void
1673  */
1674 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
1675     // Note that this function intentionally does not follow the normal Moodle DB access idioms.
1676     // This is for a good reason: it is the most frequently used DB update function,
1677     // so it has been optimised for speed.
1678     global $DB, $CFG, $USER;
1680     if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
1681         $cm = 0;
1682     }
1684     if ($user) {
1685         $userid = $user;
1686     } else {
1687         if (session_is_loggedinas()) {  // Don't log
1688             return;
1689         }
1690         $userid = empty($USER->id) ? '0' : $USER->id;
1691     }
1693     if (isset($CFG->logguests) and !$CFG->logguests) {
1694         if (!$userid or isguestuser($userid)) {
1695             return;
1696         }
1697     }
1699     $REMOTE_ADDR = getremoteaddr();
1701     $timenow = time();
1702     $info = $info;
1703     if (!empty($url)) { // could break doing html_entity_decode on an empty var.
1704         $url = html_entity_decode($url, ENT_QUOTES, 'UTF-8');
1705     } else {
1706         $url = '';
1707     }
1709     // Restrict length of log lines to the space actually available in the
1710     // database so that it doesn't cause a DB error. Log a warning so that
1711     // developers can avoid doing things which are likely to cause this on a
1712     // routine basis.
1713     if(!empty($info) && textlib::strlen($info)>255) {
1714         $info = textlib::substr($info,0,252).'...';
1715         debugging('Warning: logged very long info',DEBUG_DEVELOPER);
1716     }
1718     // If the 100 field size is changed, also need to alter print_log in course/lib.php
1719     if(!empty($url) && textlib::strlen($url)>100) {
1720         $url = textlib::substr($url,0,97).'...';
1721         debugging('Warning: logged very long URL',DEBUG_DEVELOPER);
1722     }
1724     if (defined('MDL_PERFDB')) { global $PERF ; $PERF->logwrites++;};
1726     $log = array('time'=>$timenow, 'userid'=>$userid, 'course'=>$courseid, 'ip'=>$REMOTE_ADDR, 'module'=>$module,
1727                  'cmid'=>$cm, 'action'=>$action, 'url'=>$url, 'info'=>$info);
1729     try {
1730         $DB->insert_record_raw('log', $log, false);
1731     } catch (dml_exception $e) {
1732         debugging('Error: Could not insert a new entry to the Moodle log. '. $e->error, DEBUG_ALL);
1734         // MDL-11893, alert $CFG->supportemail if insert into log failed
1735         if ($CFG->supportemail and empty($CFG->noemailever)) {
1736             // email_to_user is not usable because email_to_user tries to write to the logs table,
1737             // and this will get caught in an infinite loop, if disk is full
1738             $site = get_site();
1739             $subject = 'Insert into log failed at your moodle site '.$site->fullname;
1740             $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";
1741             $message .= "The failed query parameters are:\n\n" . var_export($log, true);
1743             $lasttime = get_config('admin', 'lastloginserterrormail');
1744             if(empty($lasttime) || time() - $lasttime > 60*60*24) { // limit to 1 email per day
1745                 //using email directly rather than messaging as they may not be able to log in to access a message
1746                 mail($CFG->supportemail, $subject, $message);
1747                 set_config('lastloginserterrormail', time(), 'admin');
1748             }
1749         }
1750     }
1753 /**
1754  * Store user last access times - called when use enters a course or site
1755  *
1756  * @package core
1757  * @category log
1758  * @global stdClass $USER
1759  * @global stdClass $CFG
1760  * @global moodle_database $DB
1761  * @uses LASTACCESS_UPDATE_SECS
1762  * @uses SITEID
1763  * @param int $courseid  empty courseid means site
1764  * @return void
1765  */
1766 function user_accesstime_log($courseid=0) {
1767     global $USER, $CFG, $DB;
1769     if (!isloggedin() or session_is_loggedinas()) {
1770         // no access tracking
1771         return;
1772     }
1774     if (isguestuser()) {
1775         // Do not update guest access times/ips for performance.
1776         return;
1777     }
1779     if (empty($courseid)) {
1780         $courseid = SITEID;
1781     }
1783     $timenow = time();
1785 /// Store site lastaccess time for the current user
1786     if ($timenow - $USER->lastaccess > LASTACCESS_UPDATE_SECS) {
1787     /// Update $USER->lastaccess for next checks
1788         $USER->lastaccess = $timenow;
1790         $last = new stdClass();
1791         $last->id         = $USER->id;
1792         $last->lastip     = getremoteaddr();
1793         $last->lastaccess = $timenow;
1795         $DB->update_record_raw('user', $last);
1796     }
1798     if ($courseid == SITEID) {
1799     ///  no user_lastaccess for frontpage
1800         return;
1801     }
1803 /// Store course lastaccess times for the current user
1804     if (empty($USER->currentcourseaccess[$courseid]) or ($timenow - $USER->currentcourseaccess[$courseid] > LASTACCESS_UPDATE_SECS)) {
1806         $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id, 'courseid'=>$courseid));
1808         if ($lastaccess === false) {
1809             // Update course lastaccess for next checks
1810             $USER->currentcourseaccess[$courseid] = $timenow;
1812             $last = new stdClass();
1813             $last->userid     = $USER->id;
1814             $last->courseid   = $courseid;
1815             $last->timeaccess = $timenow;
1816             $DB->insert_record_raw('user_lastaccess', $last, false);
1818         } else if ($timenow - $lastaccess <  LASTACCESS_UPDATE_SECS) {
1819             // no need to update now, it was updated recently in concurrent login ;-)
1821         } else {
1822             // Update course lastaccess for next checks
1823             $USER->currentcourseaccess[$courseid] = $timenow;
1825             $DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id, 'courseid'=>$courseid));
1826         }
1827     }
1830 /**
1831  * Select all log records based on SQL criteria
1832  *
1833  * @package core
1834  * @category log
1835  * @global moodle_database $DB
1836  * @param string $select SQL select criteria
1837  * @param array $params named sql type params
1838  * @param string $order SQL order by clause to sort the records returned
1839  * @param string $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set)
1840  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set)
1841  * @param int $totalcount Passed in by reference.
1842  * @return array
1843  */
1844 function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
1845     global $DB;
1847     if ($order) {
1848         $order = "ORDER BY $order";
1849     }
1851     $selectsql = "";
1852     $countsql  = "";
1854     if ($select) {
1855         $select = "WHERE $select";
1856     }
1858     $sql = "SELECT COUNT(*)
1859               FROM {log} l
1860            $select";
1862     $totalcount = $DB->count_records_sql($sql, $params);
1864     $sql = "SELECT l.*, u.firstname, u.lastname, u.picture
1865               FROM {log} l
1866               LEFT JOIN {user} u ON l.userid = u.id
1867            $select
1868             $order";
1870     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum) ;
1874 /**
1875  * Select all log records for a given course and user
1876  *
1877  * @package core
1878  * @category log
1879  * @global moodle_database $DB
1880  * @uses DAYSECS
1881  * @param int $userid The id of the user as found in the 'user' table.
1882  * @param int $courseid The id of the course as found in the 'course' table.
1883  * @param string $coursestart unix timestamp representing course start date and time.
1884  * @return array
1885  */
1886 function get_logs_usercourse($userid, $courseid, $coursestart) {
1887     global $DB;
1889     $params = array();
1891     $courseselect = '';
1892     if ($courseid) {
1893         $courseselect = "AND course = :courseid";
1894         $params['courseid'] = $courseid;
1895     }
1896     $params['userid'] = $userid;
1897     $$coursestart = (int)$coursestart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
1899     return $DB->get_records_sql("SELECT FLOOR((time - $coursestart)/". DAYSECS .") AS day, COUNT(*) AS num
1900                                    FROM {log}
1901                                   WHERE userid = :userid
1902                                         AND time > $coursestart $courseselect
1903                                GROUP BY FLOOR((time - $coursestart)/". DAYSECS .")", $params);
1906 /**
1907  * Select all log records for a given course, user, and day
1908  *
1909  * @package core
1910  * @category log
1911  * @global moodle_database $DB
1912  * @uses HOURSECS
1913  * @param int $userid The id of the user as found in the 'user' table.
1914  * @param int $courseid The id of the course as found in the 'course' table.
1915  * @param string $daystart unix timestamp of the start of the day for which the logs needs to be retrived
1916  * @return array
1917  */
1918 function get_logs_userday($userid, $courseid, $daystart) {
1919     global $DB;
1921     $params = array('userid'=>$userid);
1923     $courseselect = '';
1924     if ($courseid) {
1925         $courseselect = "AND course = :courseid";
1926         $params['courseid'] = $courseid;
1927     }
1928     $daystart = (int)$daystart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
1930     return $DB->get_records_sql("SELECT FLOOR((time - $daystart)/". HOURSECS .") AS hour, COUNT(*) AS num
1931                                    FROM {log}
1932                                   WHERE userid = :userid
1933                                         AND time > $daystart $courseselect
1934                                GROUP BY FLOOR((time - $daystart)/". HOURSECS .") ", $params);
1937 /**
1938  * Returns an object with counts of failed login attempts
1939  *
1940  * Returns information about failed login attempts.  If the current user is
1941  * an admin, then two numbers are returned:  the number of attempts and the
1942  * number of accounts.  For non-admins, only the attempts on the given user
1943  * are shown.
1944  *
1945  * @global moodle_database $DB
1946  * @uses CONTEXT_SYSTEM
1947  * @param string $mode Either 'admin' or 'everybody'
1948  * @param string $username The username we are searching for
1949  * @param string $lastlogin The date from which we are searching
1950  * @return int
1951  */
1952 function count_login_failures($mode, $username, $lastlogin) {
1953     global $DB;
1955     $params = array('mode'=>$mode, 'username'=>$username, 'lastlogin'=>$lastlogin);
1956     $select = "module='login' AND action='error' AND time > :lastlogin";
1958     $count = new stdClass();
1960     if (is_siteadmin()) {
1961         if ($count->attempts = $DB->count_records_select('log', $select, $params)) {
1962             $count->accounts = $DB->count_records_select('log', $select, $params, 'COUNT(DISTINCT info)');
1963             return $count;
1964         }
1965     } else if ($mode == 'everybody') {
1966         if ($count->attempts = $DB->count_records_select('log', "$select AND info = :username", $params)) {
1967             return $count;
1968         }
1969     }
1970     return NULL;
1974 /// GENERAL HELPFUL THINGS  ///////////////////////////////////
1976 /**
1977  * Dumps a given object's information for debugging purposes
1978  *
1979  * When used in a CLI script, the object's information is written to the standard
1980  * error output stream. When used in a web script, the object is dumped to a
1981  * pre-formatted block with the "notifytiny" CSS class.
1982  *
1983  * @param mixed $object The data to be printed
1984  * @return void output is echo'd
1985  */
1986 function print_object($object) {
1988     // we may need a lot of memory here
1989     raise_memory_limit(MEMORY_EXTRA);
1991     if (CLI_SCRIPT) {
1992         fwrite(STDERR, print_r($object, true));
1993         fwrite(STDERR, PHP_EOL);
1994     } else {
1995         echo html_writer::tag('pre', s(print_r($object, true)), array('class' => 'notifytiny'));
1996     }
1999 /**
2000  * This function is the official hook inside XMLDB stuff to delegate its debug to one
2001  * external function.
2002  *
2003  * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
2004  * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
2005  *
2006  * @uses DEBUG_DEVELOPER
2007  * @param string $message string contains the error message
2008  * @param object $object object XMLDB object that fired the debug
2009  */
2010 function xmldb_debug($message, $object) {
2012     debugging($message, DEBUG_DEVELOPER);
2015 /**
2016  * @global object
2017  * @uses CONTEXT_COURSECAT
2018  * @return boolean Whether the user can create courses in any category in the system.
2019  */
2020 function user_can_create_courses() {
2021     global $DB;
2022     $catsrs = $DB->get_recordset('course_categories');
2023     foreach ($catsrs as $cat) {
2024         if (has_capability('moodle/course:create', context_coursecat::instance($cat->id))) {
2025             $catsrs->close();
2026             return true;
2027         }
2028     }
2029     $catsrs->close();
2030     return false;