MDL-30328 some whitespace changes
[moodle.git] / lib / datalib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions for database manipulation.
20  *
21  * Other main libraries:
22  * - weblib.php - functions that produce web output
23  * - moodlelib.php - general-purpose Moodle functions
24  *
25  * @package    core
26  * @subpackage lib
27  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * The maximum courses in a category
35  * MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
36  */
37 define('MAX_COURSES_IN_CATEGORY', 10000);
39 /**
40   * The maximum number of course categories
41   * MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
42   */
43 define('MAX_COURSE_CATEGORIES', 10000);
45 /**
46  * Number of seconds to wait before updating lastaccess information in DB.
47  */
48 define('LASTACCESS_UPDATE_SECS', 60);
50 /**
51  * Returns $user object of the main admin user
52  * primary admin = admin with lowest role_assignment id among admins
53  *
54  * @static stdClass $mainadmin
55  * @return stdClass {@link $USER} record from DB, false if not found
56  */
57 function get_admin() {
58     static $mainadmin = null;
60     if (!isset($mainadmin)) {
61         if (! $admins = get_admins()) {
62             return false;
63         }
64         //TODO: add some admin setting for specifying of THE main admin
65         //      for now return the first assigned admin
66         $mainadmin = reset($admins);
67     }
68     // we must clone this otherwise code outside can break the static var
69     return clone($mainadmin);
70 }
72 /**
73  * Returns list of all admins, using 1 DB query
74  *
75  * @return array
76  */
77 function get_admins() {
78     global $DB, $CFG;
80     if (empty($CFG->siteadmins)) {  // Should not happen on an ordinary site
81         return array();
82     }
84     $sql = "SELECT u.*
85               FROM {user} u
86              WHERE u.deleted = 0 AND u.id IN ($CFG->siteadmins)";
88     return $DB->get_records_sql($sql);
89 }
91 /**
92  * Search through course users
93  *
94  * If $coursid specifies the site course then this function searches
95  * through all undeleted and confirmed users
96  *
97  * @global object
98  * @uses SITEID
99  * @uses SQL_PARAMS_NAMED
100  * @uses CONTEXT_COURSE
101  * @param int $courseid The course in question.
102  * @param int $groupid The group in question.
103  * @param string $searchtext The string to search for
104  * @param string $sort A field to sort by
105  * @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
106  * @return array
107  */
108 function search_users($courseid, $groupid, $searchtext, $sort='', array $exceptions=null) {
109     global $DB;
111     $fullname  = $DB->sql_fullname('u.firstname', 'u.lastname');
113     if (!empty($exceptions)) {
114         list($exceptions, $params) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex', false);
115         $except = "AND u.id $exceptions";
116     } else {
117         $except = "";
118         $params = array();
119     }
121     if (!empty($sort)) {
122         $order = "ORDER BY $sort";
123     } else {
124         $order = "";
125     }
127     $select = "u.deleted = 0 AND u.confirmed = 1 AND (".$DB->sql_like($fullname, ':search1', false)." OR ".$DB->sql_like('u.email', ':search2', false).")";
128     $params['search1'] = "%$searchtext%";
129     $params['search2'] = "%$searchtext%";
131     if (!$courseid or $courseid == SITEID) {
132         $sql = "SELECT u.id, u.firstname, u.lastname, u.email
133                   FROM {user} u
134                  WHERE $select
135                        $except
136                 $order";
137         return $DB->get_records_sql($sql, $params);
139     } else {
140         if ($groupid) {
141             $sql = "SELECT u.id, u.firstname, u.lastname, u.email
142                       FROM {user} u
143                       JOIN {groups_members} gm ON gm.userid = u.id
144                      WHERE $select AND gm.groupid = :groupid
145                            $except
146                      $order";
147             $params['groupid'] = $groupid;
148             return $DB->get_records_sql($sql, $params);
150         } else {
151             $context = get_context_instance(CONTEXT_COURSE, $courseid);
152             $contextlists = get_related_contexts_string($context);
154             $sql = "SELECT u.id, u.firstname, u.lastname, u.email
155                       FROM {user} u
156                       JOIN {role_assignments} ra ON ra.userid = u.id
157                      WHERE $select AND ra.contextid $contextlists
158                            $except
159                     $order";
160             return $DB->get_records_sql($sql, $params);
161         }
162     }
165 /**
166  * Returns a subset of users
167  *
168  * @global object
169  * @uses DEBUG_DEVELOPER
170  * @uses SQL_PARAMS_NAMED
171  * @param bool $get If false then only a count of the records is returned
172  * @param string $search A simple string to search for
173  * @param bool $confirmed A switch to allow/disallow unconfirmed users
174  * @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
175  * @param string $sort A SQL snippet for the sorting criteria to use
176  * @param string $firstinitial Users whose first name starts with $firstinitial
177  * @param string $lastinitial Users whose last name starts with $lastinitial
178  * @param string $page The page or records to return
179  * @param string $recordsperpage The number of records to return per page
180  * @param string $fields A comma separated list of fields to be returned from the chosen table.
181  * @return array|int|bool  {@link $USER} records unless get is false in which case the integer count of the records found is returned.
182   *                        False is returned if an error is encountered.
183  */
184 function get_users($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC',
185                    $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*', $extraselect='', array $extraparams=null) {
186     global $DB, $CFG;
188     if ($get && !$recordsperpage) {
189         debugging('Call to get_users with $get = true no $recordsperpage limit. ' .
190                 'On large installations, this will probably cause an out of memory error. ' .
191                 'Please think again and change your code so that it does not try to ' .
192                 'load so much data into memory.', DEBUG_DEVELOPER);
193     }
195     $fullname  = $DB->sql_fullname();
197     $select = " id <> :guestid AND deleted = 0";
198     $params = array('guestid'=>$CFG->siteguest);
200     if (!empty($search)){
201         $search = trim($search);
202         $select .= " AND (".$DB->sql_like($fullname, ':search1', false)." OR ".$DB->sql_like('email', ':search2', false)." OR username = :search3)";
203         $params['search1'] = "%$search%";
204         $params['search2'] = "%$search%";
205         $params['search3'] = "$search";
206     }
208     if ($confirmed) {
209         $select .= " AND confirmed = 1";
210     }
212     if ($exceptions) {
213         list($exceptions, $eparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex', false);
214         $params = $params + $eparams;
215         $except = " AND id $exceptions";
216     }
218     if ($firstinitial) {
219         $select .= " AND ".$DB->sql_like('firstname', ':fni', false, false);
220         $params['fni'] = "$firstinitial%";
221     }
222     if ($lastinitial) {
223         $select .= " AND ".$DB->sql_like('lastname', ':lni', false, false);
224         $params['lni'] = "$lastinitial%";
225     }
227     if ($extraselect) {
228         $select .= " AND $extraselect";
229         $params = $params + (array)$extraparams;
230     }
232     if ($get) {
233         return $DB->get_records_select('user', $select, $params, $sort, $fields, $page, $recordsperpage);
234     } else {
235         return $DB->count_records_select('user', $select, $params);
236     }
240 /**
241  * @todo Finish documenting this function
242  *
243  * @param string $sort An SQL field to sort by
244  * @param string $dir The sort direction ASC|DESC
245  * @param int $page The page or records to return
246  * @param int $recordsperpage The number of records to return per page
247  * @param string $search A simple string to search for
248  * @param string $firstinitial Users whose first name starts with $firstinitial
249  * @param string $lastinitial Users whose last name starts with $lastinitial
250  * @param string $extraselect An additional SQL select statement to append to the query
251  * @param array $extraparams Additional parameters to use for the above $extraselect
252  * @param object $extracontext If specified, will include user 'extra fields'
253  *   as appropriate for current user and given context
254  * @return array Array of {@link $USER} records
255  */
256 function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
257                            $search='', $firstinitial='', $lastinitial='', $extraselect='',
258                            array $extraparams=null, $extracontext = null) {
259     global $DB;
261     $fullname  = $DB->sql_fullname();
263     $select = "deleted <> 1";
264     $params = array();
266     if (!empty($search)) {
267         $search = trim($search);
268         $select .= " AND (". $DB->sql_like($fullname, ':search1', false, false).
269                    " OR ". $DB->sql_like('email', ':search2', false, false).
270                    " OR username = :search3)";
271         $params['search1'] = "%$search%";
272         $params['search2'] = "%$search%";
273         $params['search3'] = "$search";
274     }
276     if ($firstinitial) {
277         $select .= " AND ". $DB->sql_like('firstname', ':fni', false, false);
278         $params['fni'] = "$firstinitial%";
279     }
280     if ($lastinitial) {
281         $select .= " AND ". $DB->sql_like('lastname', ':lni', false, false);
282         $params['lni'] = "$lastinitial%";
283     }
285     if ($extraselect) {
286         $select .= " AND $extraselect";
287         $params = $params + (array)$extraparams;
288     }
290     if ($sort) {
291         $sort = " ORDER BY $sort $dir";
292     }
294     // If a context is specified, get extra user fields that the current user
295     // is supposed to see.
296     $extrafields = '';
297     if ($extracontext) {
298         $extrafields = get_extra_user_fields_sql($extracontext, '', '',
299                 array('id', 'username', 'email', 'firstname', 'lastname', 'city', 'country',
300                 'lastaccess', 'confirmed', 'mnethostid'));
301     }
303     // warning: will return UNCONFIRMED USERS
304     return $DB->get_records_sql("SELECT id, username, email, firstname, lastname, city, country,
305                                         lastaccess, confirmed, mnethostid$extrafields
306                                    FROM {user}
307                                   WHERE $select
308                                   $sort", $params, $page, $recordsperpage);
313 /**
314  * Full list of users that have confirmed their accounts.
315  *
316  * @global object
317  * @return array of unconfirmed users
318  */
319 function get_users_confirmed() {
320     global $DB, $CFG;
321     return $DB->get_records_sql("SELECT *
322                                    FROM {user}
323                                   WHERE confirmed = 1 AND deleted = 0 AND id <> ?", array($CFG->siteguest));
327 /// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
330 /**
331  * Returns $course object of the top-level site.
332  *
333  * @return object A {@link $COURSE} object for the site, exception if not found
334  */
335 function get_site() {
336     global $SITE, $DB;
338     if (!empty($SITE->id)) {   // We already have a global to use, so return that
339         return $SITE;
340     }
342     if ($course = $DB->get_record('course', array('category'=>0))) {
343         return $course;
344     } else {
345         // course table exists, but the site is not there,
346         // unfortunately there is no automatic way to recover
347         throw new moodle_exception('nosite', 'error');
348     }
351 /**
352  * Returns list of courses, for whole site, or category
353  *
354  * Returns list of courses, for whole site, or category
355  * Important: Using c.* for fields is extremely expensive because
356  *            we are using distinct. You almost _NEVER_ need all the fields
357  *            in such a large SELECT
358  *
359  * @global object
360  * @global object
361  * @global object
362  * @uses CONTEXT_COURSE
363  * @param string|int $categoryid Either a category id or 'all' for everything
364  * @param string $sort A field and direction to sort by
365  * @param string $fields The additional fields to return
366  * @return array Array of courses
367  */
368 function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
370     global $USER, $CFG, $DB;
372     $params = array();
374     if ($categoryid !== "all" && is_numeric($categoryid)) {
375         $categoryselect = "WHERE c.category = :catid";
376         $params['catid'] = $categoryid;
377     } else {
378         $categoryselect = "";
379     }
381     if (empty($sort)) {
382         $sortstatement = "";
383     } else {
384         $sortstatement = "ORDER BY $sort";
385     }
387     $visiblecourses = array();
389     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
391     $sql = "SELECT $fields $ccselect
392               FROM {course} c
393            $ccjoin
394               $categoryselect
395               $sortstatement";
397     // pull out all course matching the cat
398     if ($courses = $DB->get_records_sql($sql, $params)) {
400         // loop throught them
401         foreach ($courses as $course) {
402             context_instance_preload($course);
403             if (isset($course->visible) && $course->visible <= 0) {
404                 // for hidden courses, require visibility check
405                 if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
406                     $visiblecourses [$course->id] = $course;
407                 }
408             } else {
409                 $visiblecourses [$course->id] = $course;
410             }
411         }
412     }
413     return $visiblecourses;
417 /**
418  * Returns list of courses, for whole site, or category
419  *
420  * Similar to get_courses, but allows paging
421  * Important: Using c.* for fields is extremely expensive because
422  *            we are using distinct. You almost _NEVER_ need all the fields
423  *            in such a large SELECT
424  *
425  * @global object
426  * @global object
427  * @global object
428  * @uses CONTEXT_COURSE
429  * @param string|int $categoryid Either a category id or 'all' for everything
430  * @param string $sort A field and direction to sort by
431  * @param string $fields The additional fields to return
432  * @param int $totalcount Reference for the number of courses
433  * @param string $limitfrom The course to start from
434  * @param string $limitnum The number of courses to limit to
435  * @return array Array of courses
436  */
437 function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
438                           &$totalcount, $limitfrom="", $limitnum="") {
439     global $USER, $CFG, $DB;
441     $params = array();
443     $categoryselect = "";
444     if ($categoryid != "all" && is_numeric($categoryid)) {
445         $categoryselect = "WHERE c.category = :catid";
446         $params['catid'] = $categoryid;
447     } else {
448         $categoryselect = "";
449     }
451     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
453     $totalcount = 0;
454     if (!$limitfrom) {
455         $limitfrom = 0;
456     }
457     $visiblecourses = array();
459     $sql = "SELECT $fields $ccselect
460               FROM {course} c
461               $ccjoin
462            $categoryselect
463           ORDER BY $sort";
465     // pull out all course matching the cat
466     $rs = $DB->get_recordset_sql($sql, $params);
467     // iteration will have to be done inside loop to keep track of the limitfrom and limitnum
468     foreach($rs as $course) {
469         context_instance_preload($course);
470         if ($course->visible <= 0) {
471             // for hidden courses, require visibility check
472             if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
473                 $totalcount++;
474                 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
475                     $visiblecourses [$course->id] = $course;
476                 }
477             }
478         } else {
479             $totalcount++;
480             if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
481                 $visiblecourses [$course->id] = $course;
482             }
483         }
484     }
485     $rs->close();
486     return $visiblecourses;
489 /**
490  * Retrieve course records with the course managers and other related records
491  * that we need for print_course(). This allows print_courses() to do its job
492  * in a constant number of DB queries, regardless of the number of courses,
493  * role assignments, etc.
494  *
495  * The returned array is indexed on c.id, and each course will have
496  * - $course->managers - array containing RA objects that include a $user obj
497  *                       with the minimal fields needed for fullname()
498  *
499  * @global object
500  * @global object
501  * @global object
502  * @uses CONTEXT_COURSE
503  * @uses CONTEXT_SYSTEM
504  * @uses CONTEXT_COURSECAT
505  * @uses SITEID
506  * @param int|string $categoryid Either the categoryid for the courses or 'all'
507  * @param string $sort A SQL sort field and direction
508  * @param array $fields An array of additional fields to fetch
509  * @return array
510  */
511 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
512     /*
513      * The plan is to
514      *
515      * - Grab the courses JOINed w/context
516      *
517      * - Grab the interesting course-manager RAs
518      *   JOINed with a base user obj and add them to each course
519      *
520      * So as to do all the work in 2 DB queries. The RA+user JOIN
521      * ends up being pretty expensive if it happens over _all_
522      * courses on a large site. (Are we surprised!?)
523      *
524      * So this should _never_ get called with 'all' on a large site.
525      *
526      */
527     global $USER, $CFG, $DB;
529     $params = array();
530     $allcats = false; // bool flag
531     if ($categoryid === 'all') {
532         $categoryclause   = '';
533         $allcats = true;
534     } elseif (is_numeric($categoryid)) {
535         $categoryclause = "c.category = :catid";
536         $params['catid'] = $categoryid;
537     } else {
538         debugging("Could not recognise categoryid = $categoryid");
539         $categoryclause = '';
540     }
542     $basefields = array('id', 'category', 'sortorder',
543                         'shortname', 'fullname', 'idnumber',
544                         'startdate', 'visible',
545                         'newsitems', 'groupmode', 'groupmodeforce');
547     if (!is_null($fields) && is_string($fields)) {
548         if (empty($fields)) {
549             $fields = $basefields;
550         } else {
551             // turn the fields from a string to an array that
552             // get_user_courses_bycap() will like...
553             $fields = explode(',',$fields);
554             $fields = array_map('trim', $fields);
555             $fields = array_unique(array_merge($basefields, $fields));
556         }
557     } elseif (is_array($fields)) {
558         $fields = array_merge($basefields,$fields);
559     }
560     $coursefields = 'c.' .join(',c.', $fields);
562     if (empty($sort)) {
563         $sortstatement = "";
564     } else {
565         $sortstatement = "ORDER BY $sort";
566     }
568     $where = 'WHERE c.id != ' . SITEID;
569     if ($categoryclause !== ''){
570         $where = "$where AND $categoryclause";
571     }
573     // pull out all courses matching the cat
574     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
575     $sql = "SELECT $coursefields $ccselect
576               FROM {course} c
577            $ccjoin
578                $where
579                $sortstatement";
581     $catpaths = array();
582     $catpath  = NULL;
583     if ($courses = $DB->get_records_sql($sql, $params)) {
584         // loop on courses materialising
585         // the context, and prepping data to fetch the
586         // managers efficiently later...
587         foreach ($courses as $k => $course) {
588             context_instance_preload($course);
589             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
590             $courses[$k] = $course;
591             $courses[$k]->managers = array();
592             if ($allcats === false) {
593                 // single cat, so take just the first one...
594                 if ($catpath === NULL) {
595                     $catpath = preg_replace(':/\d+$:', '', $coursecontext->path);
596                 }
597             } else {
598                 // chop off the contextid of the course itself
599                 // like dirname() does...
600                 $catpaths[] = preg_replace(':/\d+$:', '', $coursecontext->path);
601             }
602         }
603     } else {
604         return array(); // no courses!
605     }
607     $CFG->coursecontact = trim($CFG->coursecontact);
608     if (empty($CFG->coursecontact)) {
609         return $courses;
610     }
612     $managerroles = explode(',', $CFG->coursecontact);
613     $catctxids = '';
614     if (count($managerroles)) {
615         if ($allcats === true) {
616             $catpaths  = array_unique($catpaths);
617             $ctxids = array();
618             foreach ($catpaths as $cpath) {
619                 $ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
620             }
621             $ctxids = array_unique($ctxids);
622             $catctxids = implode( ',' , $ctxids);
623             unset($catpaths);
624             unset($cpath);
625         } else {
626             // take the ctx path from the first course
627             // as all categories will be the same...
628             $catpath = substr($catpath,1);
629             $catpath = preg_replace(':/\d+$:','',$catpath);
630             $catctxids = str_replace('/',',',$catpath);
631         }
632         if ($categoryclause !== '') {
633             $categoryclause = "AND $categoryclause";
634         }
635         /*
636          * Note: Here we use a LEFT OUTER JOIN that can
637          * "optionally" match to avoid passing a ton of context
638          * ids in an IN() clause. Perhaps a subselect is faster.
639          *
640          * In any case, this SQL is not-so-nice over large sets of
641          * courses with no $categoryclause.
642          *
643          */
644         $sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
645                        r.id AS roleid, r.name as rolename,
646                        u.id AS userid, u.firstname, u.lastname
647                   FROM {role_assignments} ra
648                   JOIN {context} ctx ON ra.contextid = ctx.id
649                   JOIN {user} u ON ra.userid = u.id
650                   JOIN {role} r ON ra.roleid = r.id
651                   LEFT OUTER JOIN {course} c
652                        ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
653                 WHERE ( c.id IS NOT NULL";
654         // under certain conditions, $catctxids is NULL
655         if($catctxids == NULL){
656             $sql .= ") ";
657         }else{
658             $sql .= " OR ra.contextid  IN ($catctxids) )";
659         }
661         $sql .= "AND ra.roleid IN ({$CFG->coursecontact})
662                       $categoryclause
663                 ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
664         $rs = $DB->get_recordset_sql($sql, $params);
666         // This loop is fairly stupid as it stands - might get better
667         // results doing an initial pass clustering RAs by path.
668         foreach($rs as $ra) {
669             $user = new stdClass;
670             $user->id        = $ra->userid;    unset($ra->userid);
671             $user->firstname = $ra->firstname; unset($ra->firstname);
672             $user->lastname  = $ra->lastname;  unset($ra->lastname);
673             $ra->user = $user;
674             if ($ra->contextlevel == CONTEXT_SYSTEM) {
675                 foreach ($courses as $k => $course) {
676                     $courses[$k]->managers[] = $ra;
677                 }
678             } else if ($ra->contextlevel == CONTEXT_COURSECAT) {
679                 if ($allcats === false) {
680                     // It always applies
681                     foreach ($courses as $k => $course) {
682                         $courses[$k]->managers[] = $ra;
683                     }
684                 } else {
685                     foreach ($courses as $k => $course) {
686                         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
687                         // Note that strpos() returns 0 as "matched at pos 0"
688                         if (strpos($coursecontext->path, $ra->path.'/') === 0) {
689                             // Only add it to subpaths
690                             $courses[$k]->managers[] = $ra;
691                         }
692                     }
693                 }
694             } else { // course-level
695                 if (!array_key_exists($ra->instanceid, $courses)) {
696                     //this course is not in a list, probably a frontpage course
697                     continue;
698                 }
699                 $courses[$ra->instanceid]->managers[] = $ra;
700             }
701         }
702         $rs->close();
703     }
705     return $courses;
708 /**
709  * A list of courses that match a search
710  *
711  * @global object
712  * @global object
713  * @param array $searchterms An array of search criteria
714  * @param string $sort A field and direction to sort by
715  * @param int $page The page number to get
716  * @param int $recordsperpage The number of records per page
717  * @param int $totalcount Passed in by reference.
718  * @return object {@link $COURSE} records
719  */
720 function get_courses_search($searchterms, $sort='fullname ASC', $page=0, $recordsperpage=50, &$totalcount) {
721     global $CFG, $DB;
723     if ($DB->sql_regex_supported()) {
724         $REGEXP    = $DB->sql_regex(true);
725         $NOTREGEXP = $DB->sql_regex(false);
726     }
728     $searchcond = array();
729     $params     = array();
730     $i = 0;
732     // Thanks Oracle for your non-ansi concat and type limits in coalesce. MDL-29912
733     if ($DB->get_dbfamily() == 'oracle') {
734         $concat = $DB->sql_concat('c.summary', "' '", 'c.fullname', "' '", 'c.idnumber', "' '", 'c.shortname');
735     } else {
736         $concat = $DB->sql_concat("COALESCE(c.summary, '". $DB->sql_empty() ."')", "' '", 'c.fullname', "' '", 'c.idnumber', "' '", 'c.shortname');
737     }
739     foreach ($searchterms as $searchterm) {
740         $i++;
742         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
743                    /// will use it to simulate the "-" operator with LIKE clause
745     /// Under Oracle and MSSQL, trim the + and - operators and perform
746     /// simpler LIKE (or NOT LIKE) queries
747         if (!$DB->sql_regex_supported()) {
748             if (substr($searchterm, 0, 1) == '-') {
749                 $NOT = true;
750             }
751             $searchterm = trim($searchterm, '+-');
752         }
754         // TODO: +- may not work for non latin languages
756         if (substr($searchterm,0,1) == '+') {
757             $searchterm = trim($searchterm, '+-');
758             $searchterm = preg_quote($searchterm, '|');
759             $searchcond[] = "$concat $REGEXP :ss$i";
760             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
762         } else if (substr($searchterm,0,1) == "-") {
763             $searchterm = trim($searchterm, '+-');
764             $searchterm = preg_quote($searchterm, '|');
765             $searchcond[] = "$concat $NOTREGEXP :ss$i";
766             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
768         } else {
769             $searchcond[] = $DB->sql_like($concat,":ss$i", false, true, $NOT);
770             $params['ss'.$i] = "%$searchterm%";
771         }
772     }
774     if (empty($searchcond)) {
775         $totalcount = 0;
776         return array();
777     }
779     $searchcond = implode(" AND ", $searchcond);
781     $courses = array();
782     $c = 0; // counts how many visible courses we've seen
784     // Tiki pagination
785     $limitfrom = $page * $recordsperpage;
786     $limitto   = $limitfrom + $recordsperpage;
788     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
789     $sql = "SELECT c.* $ccselect
790               FROM {course} c
791            $ccjoin
792              WHERE $searchcond AND c.id <> ".SITEID."
793           ORDER BY $sort";
795     $rs = $DB->get_recordset_sql($sql, $params);
796     foreach($rs as $course) {
797         context_instance_preload($course);
798         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
799         if ($course->visible || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
800             // Don't exit this loop till the end
801             // we need to count all the visible courses
802             // to update $totalcount
803             if ($c >= $limitfrom && $c < $limitto) {
804                 $courses[$course->id] = $course;
805             }
806             $c++;
807         }
808     }
809     $rs->close();
811     // our caller expects 2 bits of data - our return
812     // array, and an updated $totalcount
813     $totalcount = $c;
814     return $courses;
818 /**
819  * Returns a sorted list of categories. Each category object has a context
820  * property that is a context object.
821  *
822  * When asking for $parent='none' it will return all the categories, regardless
823  * of depth. Wheen asking for a specific parent, the default is to return
824  * a "shallow" resultset. Pass false to $shallow and it will return all
825  * the child categories as well.
826  *
827  * @global object
828  * @uses CONTEXT_COURSECAT
829  * @param string $parent The parent category if any
830  * @param string $sort the sortorder
831  * @param bool   $shallow - set to false to get the children too
832  * @return array of categories
833  */
834 function get_categories($parent='none', $sort=NULL, $shallow=true) {
835     global $DB;
837     if ($sort === NULL) {
838         $sort = 'ORDER BY cc.sortorder ASC';
839     } elseif ($sort ==='') {
840         // leave it as empty
841     } else {
842         $sort = "ORDER BY $sort";
843     }
845     list($ccselect, $ccjoin) = context_instance_preload_sql('cc.id', CONTEXT_COURSECAT, 'ctx');
847     if ($parent === 'none') {
848         $sql = "SELECT cc.* $ccselect
849                   FROM {course_categories} cc
850                $ccjoin
851                 $sort";
852         $params = array();
854     } elseif ($shallow) {
855         $sql = "SELECT cc.* $ccselect
856                   FROM {course_categories} cc
857                $ccjoin
858                  WHERE cc.parent=?
859                 $sort";
860         $params = array($parent);
862     } else {
863         $sql = "SELECT cc.* $ccselect
864                   FROM {course_categories} cc
865                $ccjoin
866                   JOIN {course_categories} ccp
867                        ON ((cc.parent = ccp.id) OR (cc.path LIKE ".$DB->sql_concat('ccp.path',"'/%'")."))
868                  WHERE ccp.id=?
869                 $sort";
870         $params = array($parent);
871     }
872     $categories = array();
874     $rs = $DB->get_recordset_sql($sql, $params);
875     foreach($rs as $cat) {
876         context_instance_preload($cat);
877         $catcontext = get_context_instance(CONTEXT_COURSECAT, $cat->id);
878         if ($cat->visible || has_capability('moodle/category:viewhiddencategories', $catcontext)) {
879             $categories[$cat->id] = $cat;
880         }
881     }
882     $rs->close();
883     return $categories;
887 /**
888  * Returns an array of category ids of all the subcategories for a given
889  * category.
890  *
891  * @global object
892  * @param int $catid - The id of the category whose subcategories we want to find.
893  * @return array of category ids.
894  */
895 function get_all_subcategories($catid) {
896     global $DB;
898     $subcats = array();
900     if ($categories = $DB->get_records('course_categories', array('parent'=>$catid))) {
901         foreach ($categories as $cat) {
902             array_push($subcats, $cat->id);
903             $subcats = array_merge($subcats, get_all_subcategories($cat->id));
904         }
905     }
906     return $subcats;
909 /**
910  * Return specified category, default if given does not exist
911  *
912  * @global object
913  * @uses MAX_COURSES_IN_CATEGORY
914  * @uses CONTEXT_COURSECAT
915  * @uses SYSCONTEXTID
916  * @param int $catid course category id
917  * @return object caregory
918  */
919 function get_course_category($catid=0) {
920     global $DB;
922     $category = false;
924     if (!empty($catid)) {
925         $category = $DB->get_record('course_categories', array('id'=>$catid));
926     }
928     if (!$category) {
929         // the first category is considered default for now
930         if ($category = $DB->get_records('course_categories', null, 'sortorder', '*', 0, 1)) {
931             $category = reset($category);
933         } else {
934             $cat = new stdClass();
935             $cat->name         = get_string('miscellaneous');
936             $cat->depth        = 1;
937             $cat->sortorder    = MAX_COURSES_IN_CATEGORY;
938             $cat->timemodified = time();
939             $catid = $DB->insert_record('course_categories', $cat);
940             // make sure category context exists
941             get_context_instance(CONTEXT_COURSECAT, $catid);
942             mark_context_dirty('/'.SYSCONTEXTID);
943             fix_course_sortorder(); // Required to build course_categories.depth and .path.
944             $category = $DB->get_record('course_categories', array('id'=>$catid));
945         }
946     }
948     return $category;
951 /**
952  * Fixes course category and course sortorder, also verifies category and course parents and paths.
953  * (circular references are not fixed)
954  *
955  * @global object
956  * @global object
957  * @uses MAX_COURSES_IN_CATEGORY
958  * @uses MAX_COURSE_CATEGORIES
959  * @uses SITEID
960  * @uses CONTEXT_COURSE
961  * @return void
962  */
963 function fix_course_sortorder() {
964     global $DB, $SITE;
966     //WARNING: this is PHP5 only code!
968     if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
969         //move all categories that are not sorted yet to the end
970         $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('sortorder'=>0));
971     }
973     $allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
974     $topcats    = array();
975     $brokencats = array();
976     foreach ($allcats as $cat) {
977         $sortorder = (int)$cat->sortorder;
978         if (!$cat->parent) {
979             while(isset($topcats[$sortorder])) {
980                 $sortorder++;
981             }
982             $topcats[$sortorder] = $cat;
983             continue;
984         }
985         if (!isset($allcats[$cat->parent])) {
986             $brokencats[] = $cat;
987             continue;
988         }
989         if (!isset($allcats[$cat->parent]->children)) {
990             $allcats[$cat->parent]->children = array();
991         }
992         while(isset($allcats[$cat->parent]->children[$sortorder])) {
993             $sortorder++;
994         }
995         $allcats[$cat->parent]->children[$sortorder] = $cat;
996     }
997     unset($allcats);
999     // add broken cats to category tree
1000     if ($brokencats) {
1001         $defaultcat = reset($topcats);
1002         foreach ($brokencats as $cat) {
1003             $topcats[] = $cat;
1004         }
1005     }
1007     // now walk recursively the tree and fix any problems found
1008     $sortorder = 0;
1009     $fixcontexts = array();
1010     _fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts);
1012     // detect if there are "multiple" frontpage courses and fix them if needed
1013     $frontcourses = $DB->get_records('course', array('category'=>0), 'id');
1014     if (count($frontcourses) > 1) {
1015         if (isset($frontcourses[SITEID])) {
1016             $frontcourse = $frontcourses[SITEID];
1017             unset($frontcourses[SITEID]);
1018         } else {
1019             $frontcourse = array_shift($frontcourses);
1020         }
1021         $defaultcat = reset($topcats);
1022         foreach ($frontcourses as $course) {
1023             $DB->set_field('course', 'category', $defaultcat->id, array('id'=>$course->id));
1024             $context = get_context_instance(CONTEXT_COURSE, $course->id);
1025             $fixcontexts[$context->id] = $context;
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     }
1041     // release memory
1042     unset($topcats);
1043     unset($brokencats);
1044     unset($fixcontexts);
1046     // fix frontpage course sortorder
1047     if ($frontcourse->sortorder != 1) {
1048         $DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id));
1049     }
1051     // now fix the course counts in category records if needed
1052     $sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
1053               FROM {course_categories} cc
1054               LEFT JOIN {course} c ON c.category = cc.id
1055           GROUP BY cc.id, cc.coursecount
1056             HAVING cc.coursecount <> COUNT(c.id)";
1058     if ($updatecounts = $DB->get_records_sql($sql)) {
1059         // categories with more courses than MAX_COURSES_IN_CATEGORY
1060         $categories = array();
1061         foreach ($updatecounts as $cat) {
1062             $cat->coursecount = $cat->newcount;
1063             if ($cat->coursecount >= MAX_COURSES_IN_CATEGORY) {
1064                 $categories[] = $cat->id;
1065             }
1066             unset($cat->newcount);
1067             $DB->update_record_raw('course_categories', $cat, true);
1068         }
1069         if (!empty($categories)) {
1070             $str = implode(', ', $categories);
1071             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);
1072         }
1073     }
1075     // now make sure that sortorders in course table are withing the category sortorder ranges
1076     $sql = "SELECT DISTINCT cc.id, cc.sortorder
1077               FROM {course_categories} cc
1078               JOIN {course} c ON c.category = cc.id
1079              WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY;
1081     if ($fixcategories = $DB->get_records_sql($sql)) {
1082         //fix the course sortorder ranges
1083         foreach ($fixcategories as $cat) {
1084             $sql = "UPDATE {course}
1085                        SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY)." + ?
1086                      WHERE category = ?";
1087             $DB->execute($sql, array($cat->sortorder, $cat->id));
1088         }
1089     }
1090     unset($fixcategories);
1092     // categories having courses with sortorder duplicates or having gaps in sortorder
1093     $sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
1094               FROM {course} c1
1095               JOIN {course} c2 ON c1.sortorder = c2.sortorder
1096               JOIN {course_categories} cc ON (c1.category = cc.id)
1097              WHERE c1.id <> c2.id";
1098     $fixcategories = $DB->get_records_sql($sql);
1100     $sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
1101               FROM {course_categories} cc
1102               JOIN {course} c ON c.category = cc.id
1103           GROUP BY cc.id, cc.sortorder, cc.coursecount
1104             HAVING (MAX(c.sortorder) <>  cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <>  cc.sortorder + 1)";
1105     $gapcategories = $DB->get_records_sql($sql);
1107     foreach ($gapcategories as $cat) {
1108         if (isset($fixcategories[$cat->id])) {
1109             // duplicates detected already
1111         } else if ($cat->minsort == $cat->sortorder and $cat->maxsort == $cat->sortorder + $cat->coursecount - 1) {
1112             // easy - new course inserted with sortorder 0, the rest is ok
1113             $sql = "UPDATE {course}
1114                        SET sortorder = sortorder + 1
1115                      WHERE category = ?";
1116             $DB->execute($sql, array($cat->id));
1118         } else {
1119             // it needs full resorting
1120             $fixcategories[$cat->id] = $cat;
1121         }
1122     }
1123     unset($gapcategories);
1125     // fix course sortorders in problematic categories only
1126     foreach ($fixcategories as $cat) {
1127         $i = 1;
1128         $courses = $DB->get_records('course', array('category'=>$cat->id), 'sortorder ASC, id DESC', 'id, sortorder');
1129         foreach ($courses as $course) {
1130             if ($course->sortorder != $cat->sortorder + $i) {
1131                 $course->sortorder = $cat->sortorder + $i;
1132                 $DB->update_record_raw('course', $course, true);
1133             }
1134             $i++;
1135         }
1136     }
1139 /**
1140  * Internal recursive category verification function, do not use directly!
1141  *
1142  * @todo Document the arguments of this function better
1143  *
1144  * @global object
1145  * @uses MAX_COURSES_IN_CATEGORY
1146  * @uses CONTEXT_COURSECAT
1147  * @param array $children
1148  * @param int $sortorder
1149  * @param string $parent
1150  * @param int $depth
1151  * @param string $path
1152  * @param array $fixcontexts
1153  * @return void
1154  */
1155 function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
1156     global $DB;
1158     $depth++;
1160     foreach ($children as $cat) {
1161         $sortorder = $sortorder + MAX_COURSES_IN_CATEGORY;
1162         $update = false;
1163         if ($parent != $cat->parent or $depth != $cat->depth or $path.'/'.$cat->id != $cat->path) {
1164             $cat->parent = $parent;
1165             $cat->depth  = $depth;
1166             $cat->path   = $path.'/'.$cat->id;
1167             $update = true;
1169             // make sure context caches are rebuild and dirty contexts marked
1170             $context = get_context_instance(CONTEXT_COURSECAT, $cat->id);
1171             $fixcontexts[$context->id] = $context;
1172         }
1173         if ($cat->sortorder != $sortorder) {
1174             $cat->sortorder = $sortorder;
1175             $update = true;
1176         }
1177         if ($update) {
1178             $DB->update_record('course_categories', $cat, true);
1179         }
1180         if (isset($cat->children)) {
1181             _fix_course_cats($cat->children, $sortorder, $cat->id, $cat->depth, $cat->path, $fixcontexts);
1182         }
1183     }
1186 /**
1187  * List of remote courses that a user has access to via MNET.
1188  * Works only on the IDP
1189  *
1190  * @global object
1191  * @global object
1192  * @param int @userid The user id to get remote courses for
1193  * @return array Array of {@link $COURSE} of course objects
1194  */
1195 function get_my_remotecourses($userid=0) {
1196     global $DB, $USER;
1198     if (empty($userid)) {
1199         $userid = $USER->id;
1200     }
1202     // we can not use SELECT DISTINCT + text field (summary) because of MS SQL and Oracle, subselect used therefore
1203     $sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
1204                    c.hostid, c.summary, c.summaryformat, c.categoryname AS cat_name,
1205                    h.name AS hostname
1206               FROM {mnetservice_enrol_courses} c
1207               JOIN (SELECT DISTINCT hostid, remotecourseid
1208                       FROM {mnetservice_enrol_enrolments}
1209                      WHERE userid = ?
1210                    ) e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
1211               JOIN {mnet_host} h ON h.id = c.hostid";
1213     return $DB->get_records_sql($sql, array($userid));
1216 /**
1217  * List of remote hosts that a user has access to via MNET.
1218  * Works on the SP
1219  *
1220  * @global object
1221  * @global object
1222  * @return array|bool Array of host objects or false
1223  */
1224 function get_my_remotehosts() {
1225     global $CFG, $USER;
1227     if ($USER->mnethostid == $CFG->mnet_localhost_id) {
1228         return false; // Return nothing on the IDP
1229     }
1230     if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
1231         return $USER->mnet_foreign_host_array;
1232     }
1233     return false;
1236 /**
1237  * This function creates a default separated/connected scale
1238  *
1239  * This function creates a default separated/connected scale
1240  * so there's something in the database.  The locations of
1241  * strings and files is a bit odd, but this is because we
1242  * need to maintain backward compatibility with many different
1243  * existing language translations and older sites.
1244  *
1245  * @global object
1246  * @return void
1247  */
1248 function make_default_scale() {
1249     global $DB;
1251     $defaultscale = NULL;
1252     $defaultscale->courseid = 0;
1253     $defaultscale->userid = 0;
1254     $defaultscale->name  = get_string('separateandconnected');
1255     $defaultscale->description = get_string('separateandconnectedinfo');
1256     $defaultscale->scale = get_string('postrating1', 'forum').','.
1257                            get_string('postrating2', 'forum').','.
1258                            get_string('postrating3', 'forum');
1259     $defaultscale->timemodified = time();
1261     $defaultscale->id = $DB->insert_record('scale', $defaultscale);
1262     $DB->execute("UPDATE {forum} SET scale = ?", array($defaultscale->id));
1266 /**
1267  * Returns a menu of all available scales from the site as well as the given course
1268  *
1269  * @global object
1270  * @param int $courseid The id of the course as found in the 'course' table.
1271  * @return array
1272  */
1273 function get_scales_menu($courseid=0) {
1274     global $DB;
1276     $sql = "SELECT id, name
1277               FROM {scale}
1278              WHERE courseid = 0 or courseid = ?
1279           ORDER BY courseid ASC, name ASC";
1280     $params = array($courseid);
1282     if ($scales = $DB->get_records_sql_menu($sql, $params)) {
1283         return $scales;
1284     }
1286     make_default_scale();
1288     return $DB->get_records_sql_menu($sql, $params);
1293 /**
1294  * Given a set of timezone records, put them in the database,  replacing what is there
1295  *
1296  * @global object
1297  * @param array $timezones An array of timezone records
1298  * @return void
1299  */
1300 function update_timezone_records($timezones) {
1301     global $DB;
1303 /// Clear out all the old stuff
1304     $DB->delete_records('timezone');
1306 /// Insert all the new stuff
1307     foreach ($timezones as $timezone) {
1308         if (is_array($timezone)) {
1309             $timezone = (object)$timezone;
1310         }
1311         $DB->insert_record('timezone', $timezone);
1312     }
1316 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1318 /**
1319  * Just gets a raw list of all modules in a course
1320  *
1321  * @global object
1322  * @param int $courseid The id of the course as found in the 'course' table.
1323  * @return array
1324  */
1325 function get_course_mods($courseid) {
1326     global $DB;
1328     if (empty($courseid)) {
1329         return false; // avoid warnings
1330     }
1332     return $DB->get_records_sql("SELECT cm.*, m.name as modname
1333                                    FROM {modules} m, {course_modules} cm
1334                                   WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
1335                                 array($courseid)); // no disabled mods
1339 /**
1340  * Given an id of a course module, finds the coursemodule description
1341  *
1342  * @global object
1343  * @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
1344  * @param int $cmid course module id (id in course_modules table)
1345  * @param int $courseid optional course id for extra validation
1346  * @param bool $sectionnum include relative section number (0,1,2 ...)
1347  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1348  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1349  *                        MUST_EXIST means throw exception if no record or multiple records found
1350  * @return stdClass
1351  */
1352 function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1353     global $DB;
1355     $params = array('cmid'=>$cmid);
1357     if (!$modulename) {
1358         if (!$modulename = $DB->get_field_sql("SELECT md.name
1359                                                  FROM {modules} md
1360                                                  JOIN {course_modules} cm ON cm.module = md.id
1361                                                 WHERE cm.id = :cmid", $params, $strictness)) {
1362             return false;
1363         }
1364     }
1366     $params['modulename'] = $modulename;
1368     $courseselect = "";
1369     $sectionfield = "";
1370     $sectionjoin  = "";
1372     if ($courseid) {
1373         $courseselect = "AND cm.course = :courseid";
1374         $params['courseid'] = $courseid;
1375     }
1377     if ($sectionnum) {
1378         $sectionfield = ", cw.section AS sectionnum";
1379         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1380     }
1382     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1383               FROM {course_modules} cm
1384                    JOIN {modules} md ON md.id = cm.module
1385                    JOIN {".$modulename."} m ON m.id = cm.instance
1386                    $sectionjoin
1387              WHERE cm.id = :cmid AND md.name = :modulename
1388                    $courseselect";
1390     return $DB->get_record_sql($sql, $params, $strictness);
1393 /**
1394  * Given an instance number of a module, finds the coursemodule description
1395  *
1396  * @global object
1397  * @param string $modulename name of module type, eg. resource, assignment,...
1398  * @param int $instance module instance number (id in resource, assignment etc. table)
1399  * @param int $courseid optional course id for extra validation
1400  * @param bool $sectionnum include relative section number (0,1,2 ...)
1401  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1402  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1403  *                        MUST_EXIST means throw exception if no record or multiple records found
1404  * @return stdClass
1405  */
1406 function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1407     global $DB;
1409     $params = array('instance'=>$instance, 'modulename'=>$modulename);
1411     $courseselect = "";
1412     $sectionfield = "";
1413     $sectionjoin  = "";
1415     if ($courseid) {
1416         $courseselect = "AND cm.course = :courseid";
1417         $params['courseid'] = $courseid;
1418     }
1420     if ($sectionnum) {
1421         $sectionfield = ", cw.section AS sectionnum";
1422         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1423     }
1425     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1426               FROM {course_modules} cm
1427                    JOIN {modules} md ON md.id = cm.module
1428                    JOIN {".$modulename."} m ON m.id = cm.instance
1429                    $sectionjoin
1430              WHERE m.id = :instance AND md.name = :modulename
1431                    $courseselect";
1433     return $DB->get_record_sql($sql, $params, $strictness);
1436 /**
1437  * Returns all course modules of given activity in course
1438  *
1439  * @param string $modulename The module name (forum, quiz, etc.)
1440  * @param int $courseid The course id to get modules for
1441  * @param string $extrafields extra fields starting with m.
1442  * @return array Array of results
1443  */
1444 function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
1445     global $DB;
1447     if (!empty($extrafields)) {
1448         $extrafields = ", $extrafields";
1449     }
1450     $params = array();
1451     $params['courseid'] = $courseid;
1452     $params['modulename'] = $modulename;
1455     return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
1456                                    FROM {course_modules} cm, {modules} md, {".$modulename."} m
1457                                   WHERE cm.course = :courseid AND
1458                                         cm.instance = m.id AND
1459                                         md.name = :modulename AND
1460                                         md.id = cm.module", $params);
1463 /**
1464  * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1465  *
1466  * Returns an array of all the active instances of a particular
1467  * module in given courses, sorted in the order they are defined
1468  * in the course. Returns an empty array on any errors.
1469  *
1470  * The returned objects includle the columns cw.section, cm.visible,
1471  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1472  *
1473  * @global object
1474  * @global object
1475  * @param string $modulename The name of the module to get instances for
1476  * @param array $courses an array of course objects.
1477  * @param int $userid
1478  * @param int $includeinvisible
1479  * @return array of module instance objects, including some extra fields from the course_modules
1480  *          and course_sections tables, or an empty array if an error occurred.
1481  */
1482 function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
1483     global $CFG, $DB;
1485     $outputarray = array();
1487     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1488         return $outputarray;
1489     }
1491     list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED, 'c0');
1492     $params['modulename'] = $modulename;
1494     if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
1495                                                  cm.groupmode, cm.groupingid, cm.groupmembersonly
1496                                             FROM {course_modules} cm, {course_sections} cw, {modules} md,
1497                                                  {".$modulename."} m
1498                                            WHERE cm.course $coursessql AND
1499                                                  cm.instance = m.id AND
1500                                                  cm.section = cw.id AND
1501                                                  md.name = :modulename AND
1502                                                  md.id = cm.module", $params)) {
1503         return $outputarray;
1504     }
1506     foreach ($courses as $course) {
1507         $modinfo = get_fast_modinfo($course, $userid);
1509         if (empty($modinfo->instances[$modulename])) {
1510             continue;
1511         }
1513         foreach ($modinfo->instances[$modulename] as $cm) {
1514             if (!$includeinvisible and !$cm->uservisible) {
1515                 continue;
1516             }
1517             if (!isset($rawmods[$cm->id])) {
1518                 continue;
1519             }
1520             $instance = $rawmods[$cm->id];
1521             if (!empty($cm->extra)) {
1522                 $instance->extra = $cm->extra;
1523             }
1524             $outputarray[] = $instance;
1525         }
1526     }
1528     return $outputarray;
1531 /**
1532  * Returns an array of all the active instances of a particular module in a given course,
1533  * sorted in the order they are defined.
1534  *
1535  * Returns an array of all the active instances of a particular
1536  * module in a given course, sorted in the order they are defined
1537  * in the course. Returns an empty array on any errors.
1538  *
1539  * The returned objects includle the columns cw.section, cm.visible,
1540  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1541  *
1542  * Simply calls {@link all_instances_in_courses()} with a single provided course
1543  *
1544  * @param string $modulename The name of the module to get instances for
1545  * @param object $course The course obect.
1546  * @return array of module instance objects, including some extra fields from the course_modules
1547  *          and course_sections tables, or an empty array if an error occurred.
1548  * @param int $userid
1549  * @param int $includeinvisible
1550  */
1551 function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
1552     return get_all_instances_in_courses($modulename, array($course->id => $course), $userid, $includeinvisible);
1556 /**
1557  * Determine whether a module instance is visible within a course
1558  *
1559  * Given a valid module object with info about the id and course,
1560  * and the module's type (eg "forum") returns whether the object
1561  * is visible or not, groupmembersonly visibility not tested
1562  *
1563  * @global object
1565  * @param $moduletype Name of the module eg 'forum'
1566  * @param $module Object which is the instance of the module
1567  * @return bool Success
1568  */
1569 function instance_is_visible($moduletype, $module) {
1570     global $DB;
1572     if (!empty($module->id)) {
1573         $params = array('courseid'=>$module->course, 'moduletype'=>$moduletype, 'moduleid'=>$module->id);
1574         if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
1575                                                FROM {course_modules} cm, {modules} m
1576                                               WHERE cm.course = :courseid AND
1577                                                     cm.module = m.id AND
1578                                                     m.name = :moduletype AND
1579                                                     cm.instance = :moduleid", $params)) {
1581             foreach ($records as $record) { // there should only be one - use the first one
1582                 return $record->visible;
1583             }
1584         }
1585     }
1586     return true;  // visible by default!
1589 /**
1590  * Determine whether a course module is visible within a course,
1591  * this is different from instance_is_visible() - faster and visibility for user
1592  *
1593  * @global object
1594  * @global object
1595  * @uses DEBUG_DEVELOPER
1596  * @uses CONTEXT_MODULE
1597  * @uses CONDITION_MISSING_EXTRATABLE
1598  * @param object $cm object
1599  * @param int $userid empty means current user
1600  * @return bool Success
1601  */
1602 function coursemodule_visible_for_user($cm, $userid=0) {
1603     global $USER,$CFG;
1605     if (empty($cm->id)) {
1606         debugging("Incorrect course module parameter!", DEBUG_DEVELOPER);
1607         return false;
1608     }
1609     if (empty($userid)) {
1610         $userid = $USER->id;
1611     }
1612     if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1613         return false;
1614     }
1615     if ($CFG->enableavailability) {
1616         require_once($CFG->libdir.'/conditionlib.php');
1617         $ci=new condition_info($cm,CONDITION_MISSING_EXTRATABLE);
1618         if(!$ci->is_available($cm->availableinfo,false,$userid) and
1619             !has_capability('moodle/course:viewhiddenactivities',
1620                 get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1621             return false;
1622         }
1623     }
1624     return groups_course_module_visible($cm, $userid);
1630 /// LOG FUNCTIONS /////////////////////////////////////////////////////
1633 /**
1634  * Add an entry to the log table.
1635  *
1636  * Add an entry to the log table.  These are "action" focussed rather
1637  * than web server hits, and provide a way to easily reconstruct what
1638  * any particular student has been doing.
1639  *
1640  * @global object
1641  * @global object
1642  * @global object
1643  * @uses SITEID
1644  * @uses DEBUG_DEVELOPER
1645  * @uses DEBUG_ALL
1646  * @param    int     $courseid  The course id
1647  * @param    string  $module  The module name - e.g. forum, journal, resource, course, user etc
1648  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
1649  * @param    string  $url     The file and parameters used to see the results of the action
1650  * @param    string  $info    Additional description information
1651  * @param    string  $cm      The course_module->id if there is one
1652  * @param    string  $user    If log regards $user other than $USER
1653  * @return void
1654  */
1655 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
1656     // Note that this function intentionally does not follow the normal Moodle DB access idioms.
1657     // This is for a good reason: it is the most frequently used DB update function,
1658     // so it has been optimised for speed.
1659     global $DB, $CFG, $USER;
1661     if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
1662         $cm = 0;
1663     }
1665     if ($user) {
1666         $userid = $user;
1667     } else {
1668         if (session_is_loggedinas()) {  // Don't log
1669             return;
1670         }
1671         $userid = empty($USER->id) ? '0' : $USER->id;
1672     }
1674     if (isset($CFG->logguests) and !$CFG->logguests) {
1675         if (!$userid or isguestuser($userid)) {
1676             return;
1677         }
1678     }
1680     $REMOTE_ADDR = getremoteaddr();
1682     $timenow = time();
1683     $info = $info;
1684     if (!empty($url)) { // could break doing html_entity_decode on an empty var.
1685         $url = html_entity_decode($url);
1686     } else {
1687         $url = '';
1688     }
1690     // Restrict length of log lines to the space actually available in the
1691     // database so that it doesn't cause a DB error. Log a warning so that
1692     // developers can avoid doing things which are likely to cause this on a
1693     // routine basis.
1694     $tl = textlib_get_instance();
1695     if(!empty($info) && $tl->strlen($info)>255) {
1696         $info = $tl->substr($info,0,252).'...';
1697         debugging('Warning: logged very long info',DEBUG_DEVELOPER);
1698     }
1700     // If the 100 field size is changed, also need to alter print_log in course/lib.php
1701     if(!empty($url) && $tl->strlen($url)>100) {
1702         $url=$tl->substr($url,0,97).'...';
1703         debugging('Warning: logged very long URL',DEBUG_DEVELOPER);
1704     }
1706     if (defined('MDL_PERFDB')) { global $PERF ; $PERF->logwrites++;};
1708     $log = array('time'=>$timenow, 'userid'=>$userid, 'course'=>$courseid, 'ip'=>$REMOTE_ADDR, 'module'=>$module,
1709                  'cmid'=>$cm, 'action'=>$action, 'url'=>$url, 'info'=>$info);
1711     try {
1712         $DB->insert_record_raw('log', $log, false);
1713     } catch (dml_write_exception $e) {
1714         debugging('Error: Could not insert a new entry to the Moodle log', DEBUG_ALL);
1715         // MDL-11893, alert $CFG->supportemail if insert into log failed
1716         if ($CFG->supportemail and empty($CFG->noemailever)) {
1717             // email_to_user is not usable because email_to_user tries to write to the logs table,
1718             // and this will get caught in an infinite loop, if disk is full
1719             $site = get_site();
1720             $subject = 'Insert into log failed at your moodle site '.$site->fullname;
1721             $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";
1722             $message .= "The failed query parameters are:\n\n" . var_export($log, true);
1724             $lasttime = get_config('admin', 'lastloginserterrormail');
1725             if(empty($lasttime) || time() - $lasttime > 60*60*24) { // limit to 1 email per day
1726                 //using email directly rather than messaging as they may not be able to log in to access a message
1727                 mail($CFG->supportemail, $subject, $message);
1728                 set_config('lastloginserterrormail', time(), 'admin');
1729             }
1730         }
1731     }
1734 /**
1735  * Store user last access times - called when use enters a course or site
1736  *
1737  * @global object
1738  * @global object
1739  * @global object
1740  * @uses LASTACCESS_UPDATE_SECS
1741  * @uses SITEID
1742  * @param int $courseid, empty means site
1743  * @return void
1744  */
1745 function user_accesstime_log($courseid=0) {
1746     global $USER, $CFG, $DB;
1748     if (!isloggedin() or session_is_loggedinas()) {
1749         // no access tracking
1750         return;
1751     }
1753     if (empty($courseid)) {
1754         $courseid = SITEID;
1755     }
1757     $timenow = time();
1759 /// Store site lastaccess time for the current user
1760     if ($timenow - $USER->lastaccess > LASTACCESS_UPDATE_SECS) {
1761     /// Update $USER->lastaccess for next checks
1762         $USER->lastaccess = $timenow;
1764         $last = new stdClass();
1765         $last->id         = $USER->id;
1766         $last->lastip     = getremoteaddr();
1767         $last->lastaccess = $timenow;
1769         $DB->update_record_raw('user', $last);
1770     }
1772     if ($courseid == SITEID) {
1773     ///  no user_lastaccess for frontpage
1774         return;
1775     }
1777 /// Store course lastaccess times for the current user
1778     if (empty($USER->currentcourseaccess[$courseid]) or ($timenow - $USER->currentcourseaccess[$courseid] > LASTACCESS_UPDATE_SECS)) {
1780         $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id, 'courseid'=>$courseid));
1782         if ($lastaccess === false) {
1783             // Update course lastaccess for next checks
1784             $USER->currentcourseaccess[$courseid] = $timenow;
1786             $last = new stdClass();
1787             $last->userid     = $USER->id;
1788             $last->courseid   = $courseid;
1789             $last->timeaccess = $timenow;
1790             $DB->insert_record_raw('user_lastaccess', $last, false);
1792         } else if ($timenow - $lastaccess <  LASTACCESS_UPDATE_SECS) {
1793             // no need to update now, it was updated recently in concurrent login ;-)
1795         } else {
1796             // Update course lastaccess for next checks
1797             $USER->currentcourseaccess[$courseid] = $timenow;
1799             $DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id, 'courseid'=>$courseid));
1800         }
1801     }
1804 /**
1805  * Select all log records based on SQL criteria
1806  *
1807  * @todo Finish documenting this function
1808  *
1809  * @global object
1810  * @param string $select SQL select criteria
1811  * @param array $params named sql type params
1812  * @param string $order SQL order by clause to sort the records returned
1813  * @param string $limitfrom ?
1814  * @param int $limitnum ?
1815  * @param int $totalcount Passed in by reference.
1816  * @return object
1817  */
1818 function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
1819     global $DB;
1821     if ($order) {
1822         $order = "ORDER BY $order";
1823     }
1825     $selectsql = "";
1826     $countsql  = "";
1828     if ($select) {
1829         $select = "WHERE $select";
1830     }
1832     $sql = "SELECT COUNT(*)
1833               FROM {log} l
1834            $select";
1836     $totalcount = $DB->count_records_sql($sql, $params);
1838     $sql = "SELECT l.*, u.firstname, u.lastname, u.picture
1839               FROM {log} l
1840               LEFT JOIN {user} u ON l.userid = u.id
1841            $select
1842             $order";
1844     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum) ;
1848 /**
1849  * Select all log records for a given course and user
1850  *
1851  * @todo Finish documenting this function
1852  *
1853  * @global object
1854  * @uses DAYSECS
1855  * @param int $userid The id of the user as found in the 'user' table.
1856  * @param int $courseid The id of the course as found in the 'course' table.
1857  * @param string $coursestart ?
1858  */
1859 function get_logs_usercourse($userid, $courseid, $coursestart) {
1860     global $DB;
1862     $params = array();
1864     $courseselect = '';
1865     if ($courseid) {
1866         $courseselect = "AND course = :courseid";
1867         $params['courseid'] = $courseid;
1868     }
1869     $params['userid'] = $userid;
1870     $$coursestart = (int)$coursestart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
1872     return $DB->get_records_sql("SELECT FLOOR((time - $coursestart)/". DAYSECS .") AS day, COUNT(*) AS num
1873                                    FROM {log}
1874                                   WHERE userid = :userid
1875                                         AND time > $coursestart $courseselect
1876                                GROUP BY FLOOR((time - $coursestart)/". DAYSECS .")", $params);
1879 /**
1880  * Select all log records for a given course, user, and day
1881  *
1882  * @global object
1883  * @uses HOURSECS
1884  * @param int $userid The id of the user as found in the 'user' table.
1885  * @param int $courseid The id of the course as found in the 'course' table.
1886  * @param string $daystart ?
1887  * @return object
1888  */
1889 function get_logs_userday($userid, $courseid, $daystart) {
1890     global $DB;
1892     $params = array('userid'=>$userid);
1894     $courseselect = '';
1895     if ($courseid) {
1896         $courseselect = "AND course = :courseid";
1897         $params['courseid'] = $courseid;
1898     }
1899     $daystart = (int)$daystart; // note: unfortunately pg complains if you use name parameter or column alias in GROUP BY
1901     return $DB->get_records_sql("SELECT FLOOR((time - $daystart)/". HOURSECS .") AS hour, COUNT(*) AS num
1902                                    FROM {log}
1903                                   WHERE userid = :userid
1904                                         AND time > $daystart $courseselect
1905                                GROUP BY FLOOR((time - $daystart)/". HOURSECS .") ", $params);
1908 /**
1909  * Returns an object with counts of failed login attempts
1910  *
1911  * Returns information about failed login attempts.  If the current user is
1912  * an admin, then two numbers are returned:  the number of attempts and the
1913  * number of accounts.  For non-admins, only the attempts on the given user
1914  * are shown.
1915  *
1916  * @global object
1917  * @uses CONTEXT_SYSTEM
1918  * @param string $mode Either 'admin' or 'everybody'
1919  * @param string $username The username we are searching for
1920  * @param string $lastlogin The date from which we are searching
1921  * @return int
1922  */
1923 function count_login_failures($mode, $username, $lastlogin) {
1924     global $DB;
1926     $params = array('mode'=>$mode, 'username'=>$username, 'lastlogin'=>$lastlogin);
1927     $select = "module='login' AND action='error' AND time > :lastlogin";
1929     $count = new stdClass();
1931     if (is_siteadmin()) {
1932         if ($count->attempts = $DB->count_records_select('log', $select, $params)) {
1933             $count->accounts = $DB->count_records_select('log', $select, $params, 'COUNT(DISTINCT info)');
1934             return $count;
1935         }
1936     } else if ($mode == 'everybody') {
1937         if ($count->attempts = $DB->count_records_select('log', "$select AND info = :username", $params)) {
1938             return $count;
1939         }
1940     }
1941     return NULL;
1945 /// GENERAL HELPFUL THINGS  ///////////////////////////////////
1947 /**
1948  * Dump a given object's information in a PRE block.
1949  *
1950  * Mostly just used for debugging.
1951  *
1952  * @param mixed $object The data to be printed
1953  * @return void OUtput is echo'd
1954  */
1955 function print_object($object) {
1956     echo '<pre class="notifytiny">';
1957     print_r($object);  // Direct to output because some objects get too big for memory otherwise!
1958     echo '</pre>';
1961 /**
1962  * This function is the official hook inside XMLDB stuff to delegate its debug to one
1963  * external function.
1964  *
1965  * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
1966  * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
1967  *
1968  * @uses DEBUG_DEVELOPER
1969  * @param string $message string contains the error message
1970  * @param object $object object XMLDB object that fired the debug
1971  */
1972 function xmldb_debug($message, $object) {
1974     debugging($message, DEBUG_DEVELOPER);
1977 /**
1978  * @global object
1979  * @uses CONTEXT_COURSECAT
1980  * @return boolean Whether the user can create courses in any category in the system.
1981  */
1982 function user_can_create_courses() {
1983     global $DB;
1984     $catsrs = $DB->get_recordset('course_categories');
1985     foreach ($catsrs as $cat) {
1986         if (has_capability('moodle/course:create', get_context_instance(CONTEXT_COURSECAT, $cat->id))) {
1987             $catsrs->close();
1988             return true;
1989         }
1990     }
1991     $catsrs->close();
1992     return false;