MDL-25187 upgrade log debugging to use new DML style
[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  * @global object
55  * @static object $myadmin
56  * @return object An associative array representing the admin user.
57  */
58 function get_admin() {
59     static $mainadmin = null;
61     if (!isset($mainadmin)) {
62         if (! $admins = get_admins()) {
63             return false;
64         }
65         //TODO: add some admin setting for specifying of THE main admin
66         //      for now return the first assigned admin
67         $mainadmin = reset($admins);
68     }
69     return $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, 'ex0000', 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, 'ex0000', 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  * @return array Array of {@link $USER} records
253  */
255 function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
256                            $search='', $firstinitial='', $lastinitial='', $extraselect='', array $extraparams=null) {
257     global $DB;
259     $fullname  = $DB->sql_fullname();
261     $select = "deleted <> 1";
262     $params = array();
264     if (!empty($search)) {
265         $search = trim($search);
266         $select .= " AND (". $DB->sql_like($fullname, ':search1', false, false).
267                    " OR ". $DB->sql_like('email', ':search2', false, false).
268                    " OR username = :search3)";
269         $params['search1'] = "%$search%";
270         $params['search2'] = "%$search%";
271         $params['search3'] = "$search";
272     }
274     if ($firstinitial) {
275         $select .= " AND ". $DB->sql_like('firstname', ':fni', false, false);
276         $params['fni'] = "$firstinitial%";
277     }
278     if ($lastinitial) {
279         $select .= " AND ". $DB->sql_like('lastname', ':lni', false, false);
280         $params['lni'] = "$lastinitial%";
281     }
283     if ($extraselect) {
284         $select .= " AND $extraselect";
285         $params = $params + (array)$extraparams;
286     }
288     if ($sort) {
289         $sort = " ORDER BY $sort $dir";
290     }
292 /// warning: will return UNCONFIRMED USERS
293     return $DB->get_records_sql("SELECT id, username, email, firstname, lastname, city, country, lastaccess, confirmed, mnethostid
294                                    FROM {user}
295                                   WHERE $select
296                                   $sort", $params, $page, $recordsperpage);
301 /**
302  * Full list of users that have confirmed their accounts.
303  *
304  * @global object
305  * @return array of unconfirmed users
306  */
307 function get_users_confirmed() {
308     global $DB, $CFG;
309     return $DB->get_records_sql("SELECT *
310                                    FROM {user}
311                                   WHERE confirmed = 1 AND deleted = 0 AND id <> ?", array($CFG->siteguest));
315 /// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
318 /**
319  * Returns $course object of the top-level site.
320  *
321  * @return object A {@link $COURSE} object for the site, exception if not found
322  */
323 function get_site() {
324     global $SITE, $DB;
326     if (!empty($SITE->id)) {   // We already have a global to use, so return that
327         return $SITE;
328     }
330     if ($course = $DB->get_record('course', array('category'=>0))) {
331         return $course;
332     } else {
333         // course table exists, but the site is not there,
334         // unfortunately there is no automatic way to recover
335         throw new moodle_exception('nosite', 'error');
336     }
339 /**
340  * Returns list of courses, for whole site, or category
341  *
342  * Returns list of courses, for whole site, or category
343  * Important: Using c.* for fields is extremely expensive because
344  *            we are using distinct. You almost _NEVER_ need all the fields
345  *            in such a large SELECT
346  *
347  * @global object
348  * @global object
349  * @global object
350  * @uses CONTEXT_COURSE
351  * @param string|int $categoryid Either a category id or 'all' for everything
352  * @param string $sort A field and direction to sort by
353  * @param string $fields The additional fields to return
354  * @return array Array of courses
355  */
356 function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
358     global $USER, $CFG, $DB;
360     $params = array();
362     if ($categoryid !== "all" && is_numeric($categoryid)) {
363         $categoryselect = "WHERE c.category = :catid";
364         $params['catid'] = $categoryid;
365     } else {
366         $categoryselect = "";
367     }
369     if (empty($sort)) {
370         $sortstatement = "";
371     } else {
372         $sortstatement = "ORDER BY $sort";
373     }
375     $visiblecourses = array();
377     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
379     $sql = "SELECT $fields $ccselect
380               FROM {course} c
381            $ccjoin
382               $categoryselect
383               $sortstatement";
385     // pull out all course matching the cat
386     if ($courses = $DB->get_records_sql($sql, $params)) {
388         // loop throught them
389         foreach ($courses as $course) {
390             context_instance_preload($course);
391             if (isset($course->visible) && $course->visible <= 0) {
392                 // for hidden courses, require visibility check
393                 if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
394                     $visiblecourses [$course->id] = $course;
395                 }
396             } else {
397                 $visiblecourses [$course->id] = $course;
398             }
399         }
400     }
401     return $visiblecourses;
405 /**
406  * Returns list of courses, for whole site, or category
407  *
408  * Similar to get_courses, but allows paging
409  * Important: Using c.* for fields is extremely expensive because
410  *            we are using distinct. You almost _NEVER_ need all the fields
411  *            in such a large SELECT
412  *
413  * @global object
414  * @global object
415  * @global object
416  * @uses CONTEXT_COURSE
417  * @param string|int $categoryid Either a category id or 'all' for everything
418  * @param string $sort A field and direction to sort by
419  * @param string $fields The additional fields to return
420  * @param int $totalcount Reference for the number of courses
421  * @param string $limitfrom The course to start from
422  * @param string $limitnum The number of courses to limit to
423  * @return array Array of courses
424  */
425 function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
426                           &$totalcount, $limitfrom="", $limitnum="") {
427     global $USER, $CFG, $DB;
429     $params = array();
431     $categoryselect = "";
432     if ($categoryid != "all" && is_numeric($categoryid)) {
433         $categoryselect = "WHERE c.category = :catid";
434         $params['catid'] = $categoryid;
435     } else {
436         $categoryselect = "";
437     }
439     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
441     $sql = "SELECT $fields $ccselect
442               FROM {course} c
443               $ccjoin
444            $categoryselect
445           ORDER BY $sort";
447     // pull out all course matching the cat
448     if (!$rs = $DB->get_recordset_sql($sql, $params)) {
449         return array();
450     }
451     $totalcount = 0;
453     if (!$limitfrom) {
454         $limitfrom = 0;
455     }
457     // iteration will have to be done inside loop to keep track of the limitfrom and limitnum
458     $visiblecourses = array();
459     foreach($rs as $course) {
460         context_instance_preload($course);
461         if ($course->visible <= 0) {
462             // for hidden courses, require visibility check
463             if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
464                 $totalcount++;
465                 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
466                     $visiblecourses [$course->id] = $course;
467                 }
468             }
469         } else {
470             $totalcount++;
471             if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
472                 $visiblecourses [$course->id] = $course;
473             }
474         }
475     }
476     $rs->close();
477     return $visiblecourses;
480 /**
481  * Retrieve course records with the course managers and other related records
482  * that we need for print_course(). This allows print_courses() to do its job
483  * in a constant number of DB queries, regardless of the number of courses,
484  * role assignments, etc.
485  *
486  * The returned array is indexed on c.id, and each course will have
487  * - $course->managers - array containing RA objects that include a $user obj
488  *                       with the minimal fields needed for fullname()
489  *
490  * @global object
491  * @global object
492  * @global object
493  * @uses CONTEXT_COURSE
494  * @uses CONTEXT_SYSTEM
495  * @uses CONTEXT_COURSECAT
496  * @uses SITEID
497  * @param int|string $categoryid Either the categoryid for the courses or 'all'
498  * @param string $sort A SQL sort field and direction
499  * @param array $fields An array of additional fields to fetch
500  * @return array
501  */
502 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
503     /*
504      * The plan is to
505      *
506      * - Grab the courses JOINed w/context
507      *
508      * - Grab the interesting course-manager RAs
509      *   JOINed with a base user obj and add them to each course
510      *
511      * So as to do all the work in 2 DB queries. The RA+user JOIN
512      * ends up being pretty expensive if it happens over _all_
513      * courses on a large site. (Are we surprised!?)
514      *
515      * So this should _never_ get called with 'all' on a large site.
516      *
517      */
518     global $USER, $CFG, $DB;
520     $params = array();
521     $allcats = false; // bool flag
522     if ($categoryid === 'all') {
523         $categoryclause   = '';
524         $allcats = true;
525     } elseif (is_numeric($categoryid)) {
526         $categoryclause = "c.category = :catid";
527         $params['catid'] = $categoryid;
528     } else {
529         debugging("Could not recognise categoryid = $categoryid");
530         $categoryclause = '';
531     }
533     $basefields = array('id', 'category', 'sortorder',
534                         'shortname', 'fullname', 'idnumber',
535                         'startdate', 'visible',
536                         'newsitems', 'groupmode', 'groupmodeforce');
538     if (!is_null($fields) && is_string($fields)) {
539         if (empty($fields)) {
540             $fields = $basefields;
541         } else {
542             // turn the fields from a string to an array that
543             // get_user_courses_bycap() will like...
544             $fields = explode(',',$fields);
545             $fields = array_map('trim', $fields);
546             $fields = array_unique(array_merge($basefields, $fields));
547         }
548     } elseif (is_array($fields)) {
549         $fields = array_merge($basefields,$fields);
550     }
551     $coursefields = 'c.' .join(',c.', $fields);
553     if (empty($sort)) {
554         $sortstatement = "";
555     } else {
556         $sortstatement = "ORDER BY $sort";
557     }
559     $where = 'WHERE c.id != ' . SITEID;
560     if ($categoryclause !== ''){
561         $where = "$where AND $categoryclause";
562     }
564     // pull out all courses matching the cat
565     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
566     $sql = "SELECT $coursefields $ccselect
567               FROM {course} c
568            $ccjoin
569                $where
570                $sortstatement";
572     $catpaths = array();
573     $catpath  = NULL;
574     if ($courses = $DB->get_records_sql($sql, $params)) {
575         // loop on courses materialising
576         // the context, and prepping data to fetch the
577         // managers efficiently later...
578         foreach ($courses as $k => $course) {
579             context_instance_preload($course);
580             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
581             $courses[$k] = $course;
582             $courses[$k]->managers = array();
583             if ($allcats === false) {
584                 // single cat, so take just the first one...
585                 if ($catpath === NULL) {
586                     $catpath = preg_replace(':/\d+$:', '', $coursecontext->path);
587                 }
588             } else {
589                 // chop off the contextid of the course itself
590                 // like dirname() does...
591                 $catpaths[] = preg_replace(':/\d+$:', '', $coursecontext->path);
592             }
593         }
594     } else {
595         return array(); // no courses!
596     }
598     $CFG->coursecontact = trim($CFG->coursecontact);
599     if (empty($CFG->coursecontact)) {
600         return $courses;
601     }
603     $managerroles = explode(',', $CFG->coursecontact);
604     $catctxids = '';
605     if (count($managerroles)) {
606         if ($allcats === true) {
607             $catpaths  = array_unique($catpaths);
608             $ctxids = array();
609             foreach ($catpaths as $cpath) {
610                 $ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
611             }
612             $ctxids = array_unique($ctxids);
613             $catctxids = implode( ',' , $ctxids);
614             unset($catpaths);
615             unset($cpath);
616         } else {
617             // take the ctx path from the first course
618             // as all categories will be the same...
619             $catpath = substr($catpath,1);
620             $catpath = preg_replace(':/\d+$:','',$catpath);
621             $catctxids = str_replace('/',',',$catpath);
622         }
623         if ($categoryclause !== '') {
624             $categoryclause = "AND $categoryclause";
625         }
626         /*
627          * Note: Here we use a LEFT OUTER JOIN that can
628          * "optionally" match to avoid passing a ton of context
629          * ids in an IN() clause. Perhaps a subselect is faster.
630          *
631          * In any case, this SQL is not-so-nice over large sets of
632          * courses with no $categoryclause.
633          *
634          */
635         $sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
636                        r.id AS roleid, r.name as rolename,
637                        u.id AS userid, u.firstname, u.lastname
638                   FROM {role_assignments} ra
639                   JOIN {context} ctx ON ra.contextid = ctx.id
640                   JOIN {user} u ON ra.userid = u.id
641                   JOIN {role} r ON ra.roleid = r.id
642                   LEFT OUTER JOIN {course} c
643                        ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
644                 WHERE ( c.id IS NOT NULL";
645         // under certain conditions, $catctxids is NULL
646         if($catctxids == NULL){
647             $sql .= ") ";
648         }else{
649             $sql .= " OR ra.contextid  IN ($catctxids) )";
650         }
652         $sql .= "AND ra.roleid IN ({$CFG->coursecontact})
653                       $categoryclause
654                 ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
655         $rs = $DB->get_recordset_sql($sql, $params);
657         // This loop is fairly stupid as it stands - might get better
658         // results doing an initial pass clustering RAs by path.
659         foreach($rs as $ra) {
660             $user = new stdClass;
661             $user->id        = $ra->userid;    unset($ra->userid);
662             $user->firstname = $ra->firstname; unset($ra->firstname);
663             $user->lastname  = $ra->lastname;  unset($ra->lastname);
664             $ra->user = $user;
665             if ($ra->contextlevel == CONTEXT_SYSTEM) {
666                 foreach ($courses as $k => $course) {
667                     $courses[$k]->managers[] = $ra;
668                 }
669             } else if ($ra->contextlevel == CONTEXT_COURSECAT) {
670                 if ($allcats === false) {
671                     // It always applies
672                     foreach ($courses as $k => $course) {
673                         $courses[$k]->managers[] = $ra;
674                     }
675                 } else {
676                     foreach ($courses as $k => $course) {
677                         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
678                         // Note that strpos() returns 0 as "matched at pos 0"
679                         if (strpos($coursecontext->path, $ra->path.'/') === 0) {
680                             // Only add it to subpaths
681                             $courses[$k]->managers[] = $ra;
682                         }
683                     }
684                 }
685             } else { // course-level
686                 if (!array_key_exists($ra->instanceid, $courses)) {
687                     //this course is not in a list, probably a frontpage course
688                     continue;
689                 }
690                 $courses[$ra->instanceid]->managers[] = $ra;
691             }
692         }
693         $rs->close();
694     }
696     return $courses;
699 /**
700  * A list of courses that match a search
701  *
702  * @global object
703  * @global object
704  * @param array $searchterms An array of search criteria
705  * @param string $sort A field and direction to sort by
706  * @param int $page The page number to get
707  * @param int $recordsperpage The number of records per page
708  * @param int $totalcount Passed in by reference.
709  * @return object {@link $COURSE} records
710  */
711 function get_courses_search($searchterms, $sort='fullname ASC', $page=0, $recordsperpage=50, &$totalcount) {
712     global $CFG, $DB;
714     if ($DB->sql_regex_supported()) {
715         $REGEXP    = $DB->sql_regex(true);
716         $NOTREGEXP = $DB->sql_regex(false);
717     }
719     $searchcond = array();
720     $params     = array();
721     $i = 0;
723     $concat = $DB->sql_concat('c.summary', "' '", 'c.fullname');
725     foreach ($searchterms as $searchterm) {
726         $i++;
728         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
729                    /// will use it to simulate the "-" operator with LIKE clause
731     /// Under Oracle and MSSQL, trim the + and - operators and perform
732     /// simpler LIKE (or NOT LIKE) queries
733         if (!$DB->sql_regex_supported()) {
734             if (substr($searchterm, 0, 1) == '-') {
735                 $NOT = true;
736             }
737             $searchterm = trim($searchterm, '+-');
738         }
740         // TODO: +- may not work for non latin languages
742         if (substr($searchterm,0,1) == '+') {
743             $searchterm = trim($searchterm, '+-');
744             $searchterm = preg_quote($searchterm, '|');
745             $searchcond[] = "$concat $REGEXP :ss$i";
746             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
748         } else if (substr($searchterm,0,1) == "-") {
749             $searchterm = trim($searchterm, '+-');
750             $searchterm = preg_quote($searchterm, '|');
751             $searchcond[] = "$concat $NOTREGEXP :ss$i";
752             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
754         } else {
755             $searchcond[] = $DB->sql_like($concat,":ss$i", false, true, $NOT);
756             $params['ss'.$i] = "%$searchterm%";
757         }
758     }
760     if (empty($searchcond)) {
761         $totalcount = 0;
762         return array();
763     }
765     $searchcond = implode(" AND ", $searchcond);
767     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
768     $sql = "SELECT c.* $ccselect
769               FROM {course} c
770            $ccjoin
771              WHERE $searchcond AND c.id <> ".SITEID."
772           ORDER BY $sort";
773     $courses = array();
774     $c = 0; // counts how many visible courses we've seen
776     if ($rs = $DB->get_recordset_sql($sql, $params)) {
777         // Tiki pagination
778         $limitfrom = $page * $recordsperpage;
779         $limitto   = $limitfrom + $recordsperpage;
781         foreach($rs as $course) {
782             context_instance_preload($course);
783             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
784             if ($course->visible || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
785                 // Don't exit this loop till the end
786                 // we need to count all the visible courses
787                 // to update $totalcount
788                 if ($c >= $limitfrom && $c < $limitto) {
789                     $courses[$course->id] = $course;
790                 }
791                 $c++;
792             }
793         }
794         $rs->close();
795     }
797     // our caller expects 2 bits of data - our return
798     // array, and an updated $totalcount
799     $totalcount = $c;
800     return $courses;
804 /**
805  * Returns a sorted list of categories. Each category object has a context
806  * property that is a context object.
807  *
808  * When asking for $parent='none' it will return all the categories, regardless
809  * of depth. Wheen asking for a specific parent, the default is to return
810  * a "shallow" resultset. Pass false to $shallow and it will return all
811  * the child categories as well.
812  *
813  * @global object
814  * @uses CONTEXT_COURSECAT
815  * @param string $parent The parent category if any
816  * @param string $sort the sortorder
817  * @param bool   $shallow - set to false to get the children too
818  * @return array of categories
819  */
820 function get_categories($parent='none', $sort=NULL, $shallow=true) {
821     global $DB;
823     if ($sort === NULL) {
824         $sort = 'ORDER BY cc.sortorder ASC';
825     } elseif ($sort ==='') {
826         // leave it as empty
827     } else {
828         $sort = "ORDER BY $sort";
829     }
831     list($ccselect, $ccjoin) = context_instance_preload_sql('cc.id', CONTEXT_COURSECAT, 'ctx');
833     if ($parent === 'none') {
834         $sql = "SELECT cc.* $ccselect
835                   FROM {course_categories} cc
836                $ccjoin
837                 $sort";
838         $params = array();
840     } elseif ($shallow) {
841         $sql = "SELECT cc.* $ccselect
842                   FROM {course_categories} cc
843                $ccjoin
844                  WHERE cc.parent=?
845                 $sort";
846         $params = array($parent);
848     } else {
849         $sql = "SELECT cc.* $ccselect
850                   FROM {course_categories} cc
851                $ccjoin
852                   JOIN {course_categories} ccp
853                        ON (cc.path LIKE ".$DB->sql_concat('ccp.path',"'%'").")
854                  WHERE ccp.id=?
855                 $sort";
856         $params = array($parent);
857     }
858     $categories = array();
860     if( $rs = $DB->get_recordset_sql($sql, $params) ){
861         foreach($rs as $cat) {
862             context_instance_preload($cat);
863             $catcontext = get_context_instance(CONTEXT_COURSECAT, $cat->id);
864             if ($cat->visible || has_capability('moodle/category:viewhiddencategories', $catcontext)) {
865                 $categories[$cat->id] = $cat;
866             }
867         }
868         $rs->close();
869     }
870     return $categories;
874 /**
875  * Returns an array of category ids of all the subcategories for a given
876  * category.
877  *
878  * @global object
879  * @param int $catid - The id of the category whose subcategories we want to find.
880  * @return array of category ids.
881  */
882 function get_all_subcategories($catid) {
883     global $DB;
885     $subcats = array();
887     if ($categories = $DB->get_records('course_categories', array('parent'=>$catid))) {
888         foreach ($categories as $cat) {
889             array_push($subcats, $cat->id);
890             $subcats = array_merge($subcats, get_all_subcategories($cat->id));
891         }
892     }
893     return $subcats;
896 /**
897  * Return specified category, default if given does not exist
898  *
899  * @global object
900  * @uses MAX_COURSES_IN_CATEGORY
901  * @uses CONTEXT_COURSECAT
902  * @uses SYSCONTEXTID
903  * @param int $catid course category id
904  * @return object caregory
905  */
906 function get_course_category($catid=0) {
907     global $DB;
909     $category = false;
911     if (!empty($catid)) {
912         $category = $DB->get_record('course_categories', array('id'=>$catid));
913     }
915     if (!$category) {
916         // the first category is considered default for now
917         if ($category = $DB->get_records('course_categories', null, 'sortorder', '*', 0, 1)) {
918             $category = reset($category);
920         } else {
921             $cat = new stdClass();
922             $cat->name         = get_string('miscellaneous');
923             $cat->depth        = 1;
924             $cat->sortorder    = MAX_COURSES_IN_CATEGORY;
925             $cat->timemodified = time();
926             $catid = $DB->insert_record('course_categories', $cat);
927             // make sure category context exists
928             get_context_instance(CONTEXT_COURSECAT, $catid);
929             mark_context_dirty('/'.SYSCONTEXTID);
930             fix_course_sortorder(); // Required to build course_categories.depth and .path.
931             $category = $DB->get_record('course_categories', array('id'=>$catid));
932         }
933     }
935     return $category;
938 /**
939  * Fixes course category and course sortorder, also verifies category and course parents and paths.
940  * (circular references are not fixed)
941  *
942  * @global object
943  * @global object
944  * @uses MAX_COURSES_IN_CATEGORY
945  * @uses MAX_COURSE_CATEGORIES
946  * @uses SITEID
947  * @uses CONTEXT_COURSE
948  * @return void
949  */
950 function fix_course_sortorder() {
951     global $DB, $SITE;
953     //WARNING: this is PHP5 only code!
955     if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
956         //move all categories that are not sorted yet to the end
957         $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('sortorder'=>0));
958     }
960     $allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
961     $topcats    = array();
962     $brokencats = array();
963     foreach ($allcats as $cat) {
964         $sortorder = (int)$cat->sortorder;
965         if (!$cat->parent) {
966             while(isset($topcats[$sortorder])) {
967                 $sortorder++;
968             }
969             $topcats[$sortorder] = $cat;
970             continue;
971         }
972         if (!isset($allcats[$cat->parent])) {
973             $brokencats[] = $cat;
974             continue;
975         }
976         if (!isset($allcats[$cat->parent]->children)) {
977             $allcats[$cat->parent]->children = array();
978         }
979         while(isset($allcats[$cat->parent]->children[$sortorder])) {
980             $sortorder++;
981         }
982         $allcats[$cat->parent]->children[$sortorder] = $cat;
983     }
984     unset($allcats);
986     // add broken cats to category tree
987     if ($brokencats) {
988         $defaultcat = reset($topcats);
989         foreach ($brokencats as $cat) {
990             $topcats[] = $cat;
991         }
992     }
994     // now walk recursively the tree and fix any problems found
995     $sortorder = 0;
996     $fixcontexts = array();
997     _fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts);
999     // detect if there are "multiple" frontpage courses and fix them if needed
1000     $frontcourses = $DB->get_records('course', array('category'=>0), 'id');
1001     if (count($frontcourses) > 1) {
1002         if (isset($frontcourses[SITEID])) {
1003             $frontcourse = $frontcourses[SITEID];
1004             unset($frontcourses[SITEID]);
1005         } else {
1006             $frontcourse = array_shift($frontcourses);
1007         }
1008         $defaultcat = reset($topcats);
1009         foreach ($frontcourses as $course) {
1010             $DB->set_field('course', 'category', $defaultcat->id, array('id'=>$course->id));
1011             $context = get_context_instance(CONTEXT_COURSE, $course->id);
1012             $fixcontexts[$context->id] = $context;
1013         }
1014         unset($frontcourses);
1015     } else {
1016         $frontcourse = reset($frontcourses);
1017     }
1019     // now fix the paths and depths in context table if needed
1020     if ($fixcontexts) {
1021         rebuild_contexts($fixcontexts);
1022     }
1024     // release memory
1025     unset($topcats);
1026     unset($brokencats);
1027     unset($fixcontexts);
1029     // fix frontpage course sortorder
1030     if ($frontcourse->sortorder != 1) {
1031         $DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id));
1032     }
1034     // now fix the course counts in category records if needed
1035     $sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
1036               FROM {course_categories} cc
1037               LEFT JOIN {course} c ON c.category = cc.id
1038           GROUP BY cc.id, cc.coursecount
1039             HAVING cc.coursecount <> COUNT(c.id)";
1041     if ($updatecounts = $DB->get_records_sql($sql)) {
1042         foreach ($updatecounts as $cat) {
1043             $cat->coursecount = $cat->newcount;
1044             unset($cat->newcount);
1045             $DB->update_record_raw('course_categories', $cat, true);
1046         }
1047     }
1049     // now make sure that sortorders in course table are withing the category sortorder ranges
1050     $sql = "SELECT DISTINCT cc.id, cc.sortorder
1051               FROM {course_categories} cc
1052               JOIN {course} c ON c.category = cc.id
1053              WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY;
1055     if ($fixcategories = $DB->get_records_sql($sql)) {
1056         //fix the course sortorder ranges
1057         foreach ($fixcategories as $cat) {
1058             $sql = "UPDATE {course}
1059                        SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY)." + ?
1060                      WHERE category = ?";
1061             $DB->execute($sql, array($cat->sortorder, $cat->id));
1062         }
1063     }
1064     unset($fixcategories);
1066     // categories having courses with sortorder duplicates or having gaps in sortorder
1067     $sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
1068               FROM {course} c1
1069               JOIN {course} c2 ON c1.sortorder = c2.sortorder
1070               JOIN {course_categories} cc ON (c1.category = cc.id)
1071              WHERE c1.id <> c2.id";
1072     $fixcategories = $DB->get_records_sql($sql);
1074     $sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
1075               FROM {course_categories} cc
1076               JOIN {course} c ON c.category = cc.id
1077           GROUP BY cc.id, cc.sortorder, cc.coursecount
1078             HAVING (MAX(c.sortorder) <>  cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <>  cc.sortorder + 1)";
1079     $gapcategories = $DB->get_records_sql($sql);
1081     foreach ($gapcategories as $cat) {
1082         if (isset($fixcategories[$cat->id])) {
1083             // duplicates detected already
1085         } else if ($cat->minsort == $cat->sortorder and $cat->maxsort == $cat->sortorder + $cat->coursecount - 1) {
1086             // easy - new course inserted with sortorder 0, the rest is ok
1087             $sql = "UPDATE {course}
1088                        SET sortorder = sortorder + 1
1089                      WHERE category = ?";
1090             $DB->execute($sql, array($cat->id));
1092         } else {
1093             // it needs full resorting
1094             $fixcategories[$cat->id] = $cat;
1095         }
1096     }
1097     unset($gapcategories);
1099     // fix course sortorders in problematic categories only
1100     foreach ($fixcategories as $cat) {
1101         $i = 1;
1102         $courses = $DB->get_records('course', array('category'=>$cat->id), 'sortorder ASC, id DESC', 'id, sortorder');
1103         foreach ($courses as $course) {
1104             if ($course->sortorder != $cat->sortorder + $i) {
1105                 $course->sortorder = $cat->sortorder + $i;
1106                 $DB->update_record_raw('course', $course, true);
1107             }
1108             $i++;
1109         }
1110     }
1113 /**
1114  * Internal recursive category verification function, do not use directly!
1115  *
1116  * @todo Document the arguments of this function better
1117  *
1118  * @global object
1119  * @uses MAX_COURSES_IN_CATEGORY
1120  * @uses CONTEXT_COURSECAT
1121  * @param array $children
1122  * @param int $sortorder
1123  * @param string $parent
1124  * @param int $depth
1125  * @param string $path
1126  * @param array $fixcontexts
1127  * @return void
1128  */
1129 function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
1130     global $DB;
1132     $depth++;
1134     foreach ($children as $cat) {
1135         $sortorder = $sortorder + MAX_COURSES_IN_CATEGORY;
1136         $update = false;
1137         if ($parent != $cat->parent or $depth != $cat->depth or $path.'/'.$cat->id != $cat->path) {
1138             $cat->parent = $parent;
1139             $cat->depth  = $depth;
1140             $cat->path   = $path.'/'.$cat->id;
1141             $update = true;
1143             // make sure context caches are rebuild and dirty contexts marked
1144             $context = get_context_instance(CONTEXT_COURSECAT, $cat->id);
1145             $fixcontexts[$context->id] = $context;
1146         }
1147         if ($cat->sortorder != $sortorder) {
1148             $cat->sortorder = $sortorder;
1149             $update = true;
1150         }
1151         if ($update) {
1152             $DB->update_record('course_categories', $cat, true);
1153         }
1154         if (isset($cat->children)) {
1155             _fix_course_cats($cat->children, $sortorder, $cat->id, $cat->depth, $cat->path, $fixcontexts);
1156         }
1157     }
1160 /**
1161  * List of remote courses that a user has access to via MNET.
1162  * Works only on the IDP
1163  *
1164  * @global object
1165  * @global object
1166  * @param int @userid The user id to get remote courses for
1167  * @return array Array of {@link $COURSE} of course objects
1168  */
1169 function get_my_remotecourses($userid=0) {
1170     global $DB, $USER;
1172     if (empty($userid)) {
1173         $userid = $USER->id;
1174     }
1176     // we can not use SELECT DISTINCT + text field (summary) because of MS SQL and Oracle, subselect used therefore
1177     $sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
1178                    c.hostid, c.summary, c.summaryformat, c.categoryname AS cat_name,
1179                    h.name AS hostname
1180               FROM {mnetservice_enrol_courses} c
1181               JOIN (SELECT DISTINCT hostid, remotecourseid
1182                       FROM {mnetservice_enrol_enrolments}
1183                      WHERE userid = ?
1184                    ) e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
1185               JOIN {mnet_host} h ON h.id = c.hostid";
1187     return $DB->get_records_sql($sql, array($userid));
1190 /**
1191  * List of remote hosts that a user has access to via MNET.
1192  * Works on the SP
1193  *
1194  * @global object
1195  * @global object
1196  * @return array|bool Array of host objects or false
1197  */
1198 function get_my_remotehosts() {
1199     global $CFG, $USER;
1201     if ($USER->mnethostid == $CFG->mnet_localhost_id) {
1202         return false; // Return nothing on the IDP
1203     }
1204     if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
1205         return $USER->mnet_foreign_host_array;
1206     }
1207     return false;
1210 /**
1211  * This function creates a default separated/connected scale
1212  *
1213  * This function creates a default separated/connected scale
1214  * so there's something in the database.  The locations of
1215  * strings and files is a bit odd, but this is because we
1216  * need to maintain backward compatibility with many different
1217  * existing language translations and older sites.
1218  *
1219  * @global object
1220  * @return void
1221  */
1222 function make_default_scale() {
1223     global $DB;
1225     $defaultscale = NULL;
1226     $defaultscale->courseid = 0;
1227     $defaultscale->userid = 0;
1228     $defaultscale->name  = get_string('separateandconnected');
1229     $defaultscale->description = get_string('separateandconnectedinfo');
1230     $defaultscale->scale = get_string('postrating1', 'forum').','.
1231                            get_string('postrating2', 'forum').','.
1232                            get_string('postrating3', 'forum');
1233     $defaultscale->timemodified = time();
1235     $defaultscale->id = $DB->insert_record('scale', $defaultscale);
1236     $DB->execute("UPDATE {forum} SET scale = ?", array($defaultscale->id));
1240 /**
1241  * Returns a menu of all available scales from the site as well as the given course
1242  *
1243  * @global object
1244  * @param int $courseid The id of the course as found in the 'course' table.
1245  * @return array
1246  */
1247 function get_scales_menu($courseid=0) {
1248     global $DB;
1250     $sql = "SELECT id, name
1251               FROM {scale}
1252              WHERE courseid = 0 or courseid = ?
1253           ORDER BY courseid ASC, name ASC";
1254     $params = array($courseid);
1256     if ($scales = $DB->get_records_sql_menu($sql, $params)) {
1257         return $scales;
1258     }
1260     make_default_scale();
1262     return $DB->get_records_sql_menu($sql, $params);
1267 /**
1268  * Given a set of timezone records, put them in the database,  replacing what is there
1269  *
1270  * @global object
1271  * @param array $timezones An array of timezone records
1272  * @return void
1273  */
1274 function update_timezone_records($timezones) {
1275     global $DB;
1277 /// Clear out all the old stuff
1278     $DB->delete_records('timezone');
1280 /// Insert all the new stuff
1281     foreach ($timezones as $timezone) {
1282         if (is_array($timezone)) {
1283             $timezone = (object)$timezone;
1284         }
1285         $DB->insert_record('timezone', $timezone);
1286     }
1290 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1292 /**
1293  * Just gets a raw list of all modules in a course
1294  *
1295  * @global object
1296  * @param int $courseid The id of the course as found in the 'course' table.
1297  * @return array
1298  */
1299 function get_course_mods($courseid) {
1300     global $DB;
1302     if (empty($courseid)) {
1303         return false; // avoid warnings
1304     }
1306     return $DB->get_records_sql("SELECT cm.*, m.name as modname
1307                                    FROM {modules} m, {course_modules} cm
1308                                   WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
1309                                 array($courseid)); // no disabled mods
1313 /**
1314  * Given an id of a course module, finds the coursemodule description
1315  *
1316  * @global object
1317  * @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
1318  * @param int $cmid course module id (id in course_modules table)
1319  * @param int $courseid optional course id for extra validation
1320  * @param bool $sectionnum include relative section number (0,1,2 ...)
1321  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1322  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1323  *                        MUST_EXIST means throw exception if no record or multiple records found
1324  * @return stdClass
1325  */
1326 function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1327     global $DB;
1329     $params = array('cmid'=>$cmid);
1331     if (!$modulename) {
1332         if (!$modulename = $DB->get_field_sql("SELECT md.name
1333                                                  FROM {modules} md
1334                                                  JOIN {course_modules} cm ON cm.module = md.id
1335                                                 WHERE cm.id = :cmid", $params, $strictness)) {
1336             return false;
1337         }
1338     }
1340     $params['modulename'] = $modulename;
1342     $courseselect = "";
1343     $sectionfield = "";
1344     $sectionjoin  = "";
1346     if ($courseid) {
1347         $courseselect = "AND cm.course = :courseid";
1348         $params['courseid'] = $courseid;
1349     }
1351     if ($sectionnum) {
1352         $sectionfield = ", cw.section AS sectionnum";
1353         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1354     }
1356     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1357               FROM {course_modules} cm
1358                    JOIN {modules} md ON md.id = cm.module
1359                    JOIN {".$modulename."} m ON m.id = cm.instance
1360                    $sectionjoin
1361              WHERE cm.id = :cmid AND md.name = :modulename
1362                    $courseselect";
1364     return $DB->get_record_sql($sql, $params, $strictness);
1367 /**
1368  * Given an instance number of a module, finds the coursemodule description
1369  *
1370  * @global object
1371  * @param string $modulename name of module type, eg. resource, assignment,...
1372  * @param int $instance module instance number (id in resource, assignment etc. table)
1373  * @param int $courseid optional course id for extra validation
1374  * @param bool $sectionnum include relative section number (0,1,2 ...)
1375  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1376  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1377  *                        MUST_EXIST means throw exception if no record or multiple records found
1378  * @return stdClass
1379  */
1380 function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1381     global $DB;
1383     $params = array('instance'=>$instance, '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 m.id = :instance AND md.name = :modulename
1405                    $courseselect";
1407     return $DB->get_record_sql($sql, $params, $strictness);
1410 /**
1411  * Returns all course modules of given activity in course
1412  *
1413  * @param string $modulename The module name (forum, quiz, etc.)
1414  * @param int $courseid The course id to get modules for
1415  * @param string $extrafields extra fields starting with m.
1416  * @return array Array of results
1417  */
1418 function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
1419     global $DB;
1421     if (!empty($extrafields)) {
1422         $extrafields = ", $extrafields";
1423     }
1424     $params = array();
1425     $params['courseid'] = $courseid;
1426     $params['modulename'] = $modulename;
1429     return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
1430                                    FROM {course_modules} cm, {modules} md, {".$modulename."} m
1431                                   WHERE cm.course = :courseid AND
1432                                         cm.instance = m.id AND
1433                                         md.name = :modulename AND
1434                                         md.id = cm.module", $params);
1437 /**
1438  * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1439  *
1440  * Returns an array of all the active instances of a particular
1441  * module in given courses, sorted in the order they are defined
1442  * in the course. Returns an empty array on any errors.
1443  *
1444  * The returned objects includle the columns cw.section, cm.visible,
1445  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1446  *
1447  * @global object
1448  * @global object
1449  * @param string $modulename The name of the module to get instances for
1450  * @param array $courses an array of course objects.
1451  * @param int $userid
1452  * @param int $includeinvisible
1453  * @return array of module instance objects, including some extra fields from the course_modules
1454  *          and course_sections tables, or an empty array if an error occurred.
1455  */
1456 function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
1457     global $CFG, $DB;
1459     $outputarray = array();
1461     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1462         return $outputarray;
1463     }
1465     list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED, 'c0');
1466     $params['modulename'] = $modulename;
1468     if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
1469                                                  cm.groupmode, cm.groupingid, cm.groupmembersonly
1470                                             FROM {course_modules} cm, {course_sections} cw, {modules} md,
1471                                                  {".$modulename."} m
1472                                            WHERE cm.course $coursessql AND
1473                                                  cm.instance = m.id AND
1474                                                  cm.section = cw.id AND
1475                                                  md.name = :modulename AND
1476                                                  md.id = cm.module", $params)) {
1477         return $outputarray;
1478     }
1480     foreach ($courses as $course) {
1481         $modinfo = get_fast_modinfo($course, $userid);
1483         if (empty($modinfo->instances[$modulename])) {
1484             continue;
1485         }
1487         foreach ($modinfo->instances[$modulename] as $cm) {
1488             if (!$includeinvisible and !$cm->uservisible) {
1489                 continue;
1490             }
1491             if (!isset($rawmods[$cm->id])) {
1492                 continue;
1493             }
1494             $instance = $rawmods[$cm->id];
1495             if (!empty($cm->extra)) {
1496                 $instance->extra = $cm->extra;
1497             }
1498             $outputarray[] = $instance;
1499         }
1500     }
1502     return $outputarray;
1505 /**
1506  * Returns an array of all the active instances of a particular module in a given course,
1507  * sorted in the order they are defined.
1508  *
1509  * Returns an array of all the active instances of a particular
1510  * module in a given course, sorted in the order they are defined
1511  * in the course. Returns an empty array on any errors.
1512  *
1513  * The returned objects includle the columns cw.section, cm.visible,
1514  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1515  *
1516  * Simply calls {@link all_instances_in_courses()} with a single provided course
1517  *
1518  * @param string $modulename The name of the module to get instances for
1519  * @param object $course The course obect.
1520  * @return array of module instance objects, including some extra fields from the course_modules
1521  *          and course_sections tables, or an empty array if an error occurred.
1522  * @param int $userid
1523  * @param int $includeinvisible
1524  */
1525 function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
1526     return get_all_instances_in_courses($modulename, array($course->id => $course), $userid, $includeinvisible);
1530 /**
1531  * Determine whether a module instance is visible within a course
1532  *
1533  * Given a valid module object with info about the id and course,
1534  * and the module's type (eg "forum") returns whether the object
1535  * is visible or not, groupmembersonly visibility not tested
1536  *
1537  * @global object
1539  * @param $moduletype Name of the module eg 'forum'
1540  * @param $module Object which is the instance of the module
1541  * @return bool Success
1542  */
1543 function instance_is_visible($moduletype, $module) {
1544     global $DB;
1546     if (!empty($module->id)) {
1547         $params = array('courseid'=>$module->course, 'moduletype'=>$moduletype, 'moduleid'=>$module->id);
1548         if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
1549                                                FROM {course_modules} cm, {modules} m
1550                                               WHERE cm.course = :courseid AND
1551                                                     cm.module = m.id AND
1552                                                     m.name = :moduletype AND
1553                                                     cm.instance = :moduleid", $params)) {
1555             foreach ($records as $record) { // there should only be one - use the first one
1556                 return $record->visible;
1557             }
1558         }
1559     }
1560     return true;  // visible by default!
1563 /**
1564  * Determine whether a course module is visible within a course,
1565  * this is different from instance_is_visible() - faster and visibility for user
1566  *
1567  * @global object
1568  * @global object
1569  * @uses DEBUG_DEVELOPER
1570  * @uses CONTEXT_MODULE
1571  * @uses CONDITION_MISSING_EXTRATABLE
1572  * @param object $cm object
1573  * @param int $userid empty means current user
1574  * @return bool Success
1575  */
1576 function coursemodule_visible_for_user($cm, $userid=0) {
1577     global $USER,$CFG;
1579     if (empty($cm->id)) {
1580         debugging("Incorrect course module parameter!", DEBUG_DEVELOPER);
1581         return false;
1582     }
1583     if (empty($userid)) {
1584         $userid = $USER->id;
1585     }
1586     if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1587         return false;
1588     }
1589     if ($CFG->enableavailability) {
1590         require_once($CFG->libdir.'/conditionlib.php');
1591         $ci=new condition_info($cm,CONDITION_MISSING_EXTRATABLE);
1592         if(!$ci->is_available($cm->availableinfo,false,$userid) and
1593             !has_capability('moodle/course:viewhiddenactivities',
1594                 get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1595             return false;
1596         }
1597     }
1598     return groups_course_module_visible($cm, $userid);
1604 /// LOG FUNCTIONS /////////////////////////////////////////////////////
1607 /**
1608  * Add an entry to the log table.
1609  *
1610  * Add an entry to the log table.  These are "action" focussed rather
1611  * than web server hits, and provide a way to easily reconstruct what
1612  * any particular student has been doing.
1613  *
1614  * @global object
1615  * @global object
1616  * @global object
1617  * @uses SITEID
1618  * @uses DEBUG_DEVELOPER
1619  * @uses DEBUG_ALL
1620  * @param    int     $courseid  The course id
1621  * @param    string  $module  The module name - e.g. forum, journal, resource, course, user etc
1622  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
1623  * @param    string  $url     The file and parameters used to see the results of the action
1624  * @param    string  $info    Additional description information
1625  * @param    string  $cm      The course_module->id if there is one
1626  * @param    string  $user    If log regards $user other than $USER
1627  * @return void
1628  */
1629 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
1630     // Note that this function intentionally does not follow the normal Moodle DB access idioms.
1631     // This is for a good reason: it is the most frequently used DB update function,
1632     // so it has been optimised for speed.
1633     global $DB, $CFG, $USER;
1635     if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
1636         $cm = 0;
1637     }
1639     if ($user) {
1640         $userid = $user;
1641     } else {
1642         if (session_is_loggedinas()) {  // Don't log
1643             return;
1644         }
1645         $userid = empty($USER->id) ? '0' : $USER->id;
1646     }
1648     if (isset($CFG->logguests) and !$CFG->logguests) {
1649         if (!$userid or isguestuser($userid)) {
1650             return;
1651         }
1652     }
1654     $REMOTE_ADDR = getremoteaddr();
1656     $timenow = time();
1657     $info = $info;
1658     if (!empty($url)) { // could break doing html_entity_decode on an empty var.
1659         $url = html_entity_decode($url);
1660     }
1662     // Restrict length of log lines to the space actually available in the
1663     // database so that it doesn't cause a DB error. Log a warning so that
1664     // developers can avoid doing things which are likely to cause this on a
1665     // routine basis.
1666     $tl = textlib_get_instance();
1667     if(!empty($info) && $tl->strlen($info)>255) {
1668         $info = $tl->substr($info,0,252).'...';
1669         debugging('Warning: logged very long info',DEBUG_DEVELOPER);
1670     }
1672     // If the 100 field size is changed, also need to alter print_log in course/lib.php
1673     if(!empty($url) && $tl->strlen($url)>100) {
1674         $url=$tl->substr($url,0,97).'...';
1675         debugging('Warning: logged very long URL',DEBUG_DEVELOPER);
1676     }
1678     if (defined('MDL_PERFDB')) { global $PERF ; $PERF->logwrites++;};
1680     $log = array('time'=>$timenow, 'userid'=>$userid, 'course'=>$courseid, 'ip'=>$REMOTE_ADDR, 'module'=>$module,
1681                  'cmid'=>$cm, 'action'=>$action, 'url'=>$url, 'info'=>$info);
1683     try {
1684         $DB->insert_record_raw('log', $log, false);
1685     } catch (dml_write_exception $e) {
1686         debugging('Error: Could not insert a new entry to the Moodle log', DEBUG_ALL);
1687         // MDL-11893, alert $CFG->supportemail if insert into log failed
1688         if ($CFG->supportemail and empty($CFG->noemailever)) {
1689             // email_to_user is not usable because email_to_user tries to write to the logs table,
1690             // and this will get caught in an infinite loop, if disk is full
1691             $site = get_site();
1692             $subject = 'Insert into log failed at your moodle site '.$site->fullname;
1693             $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";
1694             $message .= "The failed query parameters are:\n\n" . var_export($log, true);
1696             $lasttime = get_config('admin', 'lastloginserterrormail');
1697             if(empty($lasttime) || time() - $lasttime > 60*60*24) { // limit to 1 email per day
1698                 mail($CFG->supportemail, $subject, $message);
1699                 set_config('lastloginserterrormail', time(), 'admin');
1700             }
1701         }
1702     }
1705 /**
1706  * Store user last access times - called when use enters a course or site
1707  *
1708  * @global object
1709  * @global object
1710  * @global object
1711  * @uses LASTACCESS_UPDATE_SECS
1712  * @uses SITEID
1713  * @param int $courseid, empty means site
1714  * @return void
1715  */
1716 function user_accesstime_log($courseid=0) {
1717     global $USER, $CFG, $DB;
1719     if (!isloggedin() or session_is_loggedinas()) {
1720         // no access tracking
1721         return;
1722     }
1724     if (empty($courseid)) {
1725         $courseid = SITEID;
1726     }
1728     $timenow = time();
1730 /// Store site lastaccess time for the current user
1731     if ($timenow - $USER->lastaccess > LASTACCESS_UPDATE_SECS) {
1732     /// Update $USER->lastaccess for next checks
1733         $USER->lastaccess = $timenow;
1735         $last = new stdClass();
1736         $last->id         = $USER->id;
1737         $last->lastip     = getremoteaddr();
1738         $last->lastaccess = $timenow;
1740         $DB->update_record_raw('user', $last);
1741     }
1743     if ($courseid == SITEID) {
1744     ///  no user_lastaccess for frontpage
1745         return;
1746     }
1748 /// Store course lastaccess times for the current user
1749     if (empty($USER->currentcourseaccess[$courseid]) or ($timenow - $USER->currentcourseaccess[$courseid] > LASTACCESS_UPDATE_SECS)) {
1751         $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id, 'courseid'=>$courseid));
1753         if ($lastaccess === false) {
1754             // Update course lastaccess for next checks
1755             $USER->currentcourseaccess[$courseid] = $timenow;
1757             $last = new stdClass();
1758             $last->userid     = $USER->id;
1759             $last->courseid   = $courseid;
1760             $last->timeaccess = $timenow;
1761             $DB->insert_record_raw('user_lastaccess', $last, false);
1763         } else if ($timenow - $lastaccess <  LASTACCESS_UPDATE_SECS) {
1764             // no need to update now, it was updated recently in concurrent login ;-)
1766         } else {
1767             // Update course lastaccess for next checks
1768             $USER->currentcourseaccess[$courseid] = $timenow;
1770             $DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id, 'courseid'=>$courseid));
1771         }
1772     }
1775 /**
1776  * Select all log records based on SQL criteria
1777  *
1778  * @todo Finish documenting this function
1779  *
1780  * @global object
1781  * @param string $select SQL select criteria
1782  * @param array $params named sql type params
1783  * @param string $order SQL order by clause to sort the records returned
1784  * @param string $limitfrom ?
1785  * @param int $limitnum ?
1786  * @param int $totalcount Passed in by reference.
1787  * @return object
1788  */
1789 function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
1790     global $DB;
1792     if ($order) {
1793         $order = "ORDER BY $order";
1794     }
1796     $selectsql = "";
1797     $countsql  = "";
1799     if ($select) {
1800         $select = "WHERE $select";
1801     }
1803     $sql = "SELECT COUNT(*)
1804               FROM {log} l
1805            $select";
1807     $totalcount = $DB->count_records_sql($sql, $params);
1809     $sql = "SELECT l.*, u.firstname, u.lastname, u.picture
1810               FROM {log} l
1811               LEFT JOIN {user} u ON l.userid = u.id
1812            $select
1813             $order";
1815     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum) ;
1819 /**
1820  * Select all log records for a given course and user
1821  *
1822  * @todo Finish documenting this function
1823  *
1824  * @global object
1825  * @uses DAYSECS
1826  * @param int $userid The id of the user as found in the 'user' table.
1827  * @param int $courseid The id of the course as found in the 'course' table.
1828  * @param string $coursestart ?
1829  */
1830 function get_logs_usercourse($userid, $courseid, $coursestart) {
1831     global $DB;
1833     $params = array();
1835     $courseselect = '';
1836     if ($courseid) {
1837         $courseselect = "AND course = :courseid";
1838         $params['courseid'] = $courseid;
1839     }
1840     $params['userid'] = $userid;
1841     $params['coursestart'] = $coursestart;
1843     return $DB->get_records_sql("SELECT FLOOR((time - :coursestart)/". DAYSECS .") AS day, COUNT(*) AS num
1844                                    FROM {log}
1845                                   WHERE userid = :userid
1846                                         AND time > :coursestart $courseselect
1847                                GROUP BY FLOOR((time - :coursestart)/". DAYSECS .")", $params);
1850 /**
1851  * Select all log records for a given course, user, and day
1852  *
1853  * @global object
1854  * @uses HOURSECS
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 $daystart ?
1858  * @return object
1859  */
1860 function get_logs_userday($userid, $courseid, $daystart) {
1861     global $DB;
1863     $params = array($daystart, $userid, $daystart);
1865     $courseselect = '';
1866     if ($courseid) {
1867         $courseselect = "AND course = ?";
1868         $params[] = $courseid;
1869     }
1870     $params[] = $daystart;
1872     return $DB->get_records_sql("SELECT FLOOR((time - ?)/". HOURSECS .") AS hour, COUNT(*) AS num
1873                                    FROM {log}
1874                                   WHERE userid = ?
1875                                         AND time > ? $courseselect
1876                                GROUP BY FLOOR((time - ?)/". HOURSECS .") ", $params);
1879 /**
1880  * Returns an object with counts of failed login attempts
1881  *
1882  * Returns information about failed login attempts.  If the current user is
1883  * an admin, then two numbers are returned:  the number of attempts and the
1884  * number of accounts.  For non-admins, only the attempts on the given user
1885  * are shown.
1886  *
1887  * @global object
1888  * @uses CONTEXT_SYSTEM
1889  * @param string $mode Either 'admin' or 'everybody'
1890  * @param string $username The username we are searching for
1891  * @param string $lastlogin The date from which we are searching
1892  * @return int
1893  */
1894 function count_login_failures($mode, $username, $lastlogin) {
1895     global $DB;
1897     $params = array('mode'=>$mode, 'username'=>$username, 'lastlogin'=>$lastlogin);
1898     $select = "module='login' AND action='error' AND time > :lastlogin";
1900     $count = new stdClass();
1902     if (is_siteadmin()) {
1903         if ($count->attempts = $DB->count_records_select('log', $select, $params)) {
1904             $count->accounts = $DB->count_records_select('log', $select, $params, 'COUNT(DISTINCT info)');
1905             return $count;
1906         }
1907     } else if ($mode == 'everybody') {
1908         if ($count->attempts = $DB->count_records_select('log', "$select AND info = :username", $params)) {
1909             return $count;
1910         }
1911     }
1912     return NULL;
1916 /// GENERAL HELPFUL THINGS  ///////////////////////////////////
1918 /**
1919  * Dump a given object's information in a PRE block.
1920  *
1921  * Mostly just used for debugging.
1922  *
1923  * @param mixed $object The data to be printed
1924  * @return void OUtput is echo'd
1925  */
1926 function print_object($object) {
1927     echo '<pre class="notifytiny">';
1928     print_r($object);  // Direct to output because some objects get too big for memory otherwise!
1929     echo '</pre>';
1932 /**
1933  * This function is the official hook inside XMLDB stuff to delegate its debug to one
1934  * external function.
1935  *
1936  * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
1937  * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
1938  *
1939  * @uses DEBUG_DEVELOPER
1940  * @param string $message string contains the error message
1941  * @param object $object object XMLDB object that fired the debug
1942  */
1943 function xmldb_debug($message, $object) {
1945     debugging($message, DEBUG_DEVELOPER);
1948 /**
1949  * @global object
1950  * @uses CONTEXT_COURSECAT
1951  * @return boolean Whether the user can create courses in any category in the system.
1952  */
1953 function user_can_create_courses() {
1954     global $DB;
1955     $catsrs = $DB->get_recordset('course_categories');
1956     foreach ($catsrs as $cat) {
1957         if (has_capability('moodle/course:create', get_context_instance(CONTEXT_COURSECAT, $cat->id))) {
1958             $catsrs->close();
1959             return true;
1960         }
1961     }
1962     $catsrs->close();
1963     return false;