1de813b99e46d87d395a9cdc514d348d05b534be
[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     $LIKE      = $DB->sql_ilike();
112     $fullname  = $DB->sql_fullname('u.firstname', 'u.lastname');
114     if (!empty($exceptions)) {
115         list($exceptions, $params) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex0000', false);
116         $except = "AND u.id $exceptions";
117     } else {
118         $except = "";
119         $params = array();
120     }
122     if (!empty($sort)) {
123         $order = "ORDER BY $sort";
124     } else {
125         $order = "";
126     }
128     $select = "u.deleted = 0 AND u.confirmed = 1 AND ($fullname $LIKE :search1 OR u.email $LIKE :search2)";
129     $params['search1'] = "%$searchtext%";
130     $params['search2'] = "%$searchtext%";
132     if (!$courseid or $courseid == SITEID) {
133         $sql = "SELECT u.id, u.firstname, u.lastname, u.email
134                   FROM {user} u
135                  WHERE $select
136                        $except
137                 $order";
138         return $DB->get_records_sql($sql, $params);
140     } else {
141         if ($groupid) {
142             $sql = "SELECT u.id, u.firstname, u.lastname, u.email
143                       FROM {user} u
144                       JOIN {groups_members} gm ON gm.userid = u.id
145                      WHERE $select AND gm.groupid = :groupid
146                            $except
147                      $order";
148             $params['groupid'] = $groupid;
149             return $DB->get_records_sql($sql, $params);
151         } else {
152             $context = get_context_instance(CONTEXT_COURSE, $courseid);
153             $contextlists = get_related_contexts_string($context);
155             $sql = "SELECT u.id, u.firstname, u.lastname, u.email
156                       FROM {user} u
157                       JOIN {role_assignments} ra ON ra.userid = u.id
158                      WHERE $select AND ra.contextid $contextlists
159                            $except
160                     $order";
161             return $DB->get_records_sql($sql, $params);
162         }
163     }
166 /**
167  * Returns a subset of users
168  *
169  * @global object
170  * @uses DEBUG_DEVELOPER
171  * @uses SQL_PARAMS_NAMED
172  * @param bool $get If false then only a count of the records is returned
173  * @param string $search A simple string to search for
174  * @param bool $confirmed A switch to allow/disallow unconfirmed users
175  * @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
176  * @param string $sort A SQL snippet for the sorting criteria to use
177  * @param string $firstinitial Users whose first name starts with $firstinitial
178  * @param string $lastinitial Users whose last name starts with $lastinitial
179  * @param string $page The page or records to return
180  * @param string $recordsperpage The number of records to return per page
181  * @param string $fields A comma separated list of fields to be returned from the chosen table.
182  * @return array|int|bool  {@link $USER} records unless get is false in which case the integer count of the records found is returned.
183   *                        False is returned if an error is encountered.
184  */
185 function get_users($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC',
186                    $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*', $extraselect='', array $extraparams=null) {
187     global $DB;
189     if ($get && !$recordsperpage) {
190         debugging('Call to get_users with $get = true no $recordsperpage limit. ' .
191                 'On large installations, this will probably cause an out of memory error. ' .
192                 'Please think again and change your code so that it does not try to ' .
193                 'load so much data into memory.', DEBUG_DEVELOPER);
194     }
196     $LIKE      = $DB->sql_ilike();
197     $fullname  = $DB->sql_fullname();
199     $select = " username <> :guest AND deleted = 0";
200     $params = array('guest'=>'guest');
202     if (!empty($search)){
203         $search = trim($search);
204         $select .= " AND ($fullname $LIKE :search1 OR email $LIKE :search2 OR username = :search3)";
205         $params['search1'] = "%$search%";
206         $params['search2'] = "%$search%";
207         $params['search3'] = "$search";
208     }
210     if ($confirmed) {
211         $select .= " AND confirmed = 1";
212     }
214     if ($exceptions) {
215         list($exceptions, $eparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex0000', false);
216         $params = $params + $eparams;
217         $except = " AND id $exceptions";
218     }
220     if ($firstinitial) {
221         $select .= " AND firstname $LIKE :fni";
222         $params['fni'] = "$firstinitial%";
223     }
224     if ($lastinitial) {
225         $select .= " AND lastname $LIKE :lni";
226         $params['lni'] = "$lastinitial%";
227     }
229     if ($extraselect) {
230         $select .= " AND $extraselect";
231         $params = $params + (array)$extraparams;
232     }
234     if ($get) {
235         return $DB->get_records_select('user', $select, $params, $sort, $fields, $page, $recordsperpage);
236     } else {
237         return $DB->count_records_select('user', $select, $params);
238     }
242 /**
243  * @todo Finish documenting this function
244  *
245  * @param string $sort An SQL field to sort by
246  * @param string $dir The sort direction ASC|DESC
247  * @param int $page The page or records to return
248  * @param int $recordsperpage The number of records to return per page
249  * @param string $search A simple string to search for
250  * @param string $firstinitial Users whose first name starts with $firstinitial
251  * @param string $lastinitial Users whose last name starts with $lastinitial
252  * @param string $extraselect An additional SQL select statement to append to the query
253  * @param array $extraparams Additional parameters to use for the above $extraselect
254  * @return array Array of {@link $USER} records
255  */
257 function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
258                            $search='', $firstinitial='', $lastinitial='', $extraselect='', array $extraparams=null) {
259     global $DB;
261     $LIKE      = $DB->sql_ilike();
262     $fullname  = $DB->sql_fullname();
264     $select = "deleted <> 1";
265     $params = array();
267     if (!empty($search)) {
268         $search = trim($search);
269         $select .= " AND ($fullname $LIKE :search1 OR email $LIKE :search2 OR username = :search3)";
270         $params['search1'] = "%$search%";
271         $params['search2'] = "%$search%";
272         $params['search3'] = "$search";
273     }
275     if ($firstinitial) {
276         $select .= " AND firstname $LIKE :fni";
277         $params['fni'] = "$firstinitial%";
278     }
279     if ($lastinitial) {
280         $select .= " AND lastname $LIKE :lni";
281         $params['lni'] = "$lastinitial%";
282     }
284     if ($extraselect) {
285         $select .= " AND $extraselect";
286         $params = $params + (array)$extraparams;
287     }
289     if ($sort) {
290         $sort = " ORDER BY $sort $dir";
291     }
293 /// warning: will return UNCONFIRMED USERS
294     return $DB->get_records_sql("SELECT id, username, email, firstname, lastname, city, country, lastaccess, confirmed, mnethostid
295                                    FROM {user}
296                                   WHERE $select
297                                   $sort", $params, $page, $recordsperpage);
302 /**
303  * Full list of users that have confirmed their accounts.
304  *
305  * @global object
306  * @return array of unconfirmed users
307  */
308 function get_users_confirmed() {
309     global $DB;
310     return $DB->get_records_sql("SELECT *
311                                    FROM {user}
312                                   WHERE confirmed = 1 AND deleted = 0 AND username <> ?", array('guest'));
316 /// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
319 /**
320  * Returns $course object of the top-level site.
321  *
322  * @return object A {@link $COURSE} object for the site, exception if not found
323  */
324 function get_site() {
325     global $SITE, $DB;
327     if (!empty($SITE->id)) {   // We already have a global to use, so return that
328         return $SITE;
329     }
331     if ($course = $DB->get_record('course', array('category'=>0))) {
332         return $course;
333     } else {
334         // course table exists, but the site is not there,
335         // unfortunately there is no automatic way to recover
336         throw new moodle_exception('nosite', 'error');
337     }
340 /**
341  * Returns list of courses, for whole site, or category
342  *
343  * Returns list of courses, for whole site, or category
344  * Important: Using c.* for fields is extremely expensive because
345  *            we are using distinct. You almost _NEVER_ need all the fields
346  *            in such a large SELECT
347  *
348  * @global object
349  * @global object
350  * @global object
351  * @uses CONTEXT_COURSE
352  * @param string|int $categoryid Either a category id or 'all' for everything
353  * @param string $sort A field and direction to sort by
354  * @param string $fields The additional fields to return
355  * @return array Array of courses
356  */
357 function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
359     global $USER, $CFG, $DB;
361     $params = array();
363     if ($categoryid !== "all" && is_numeric($categoryid)) {
364         $categoryselect = "WHERE c.category = :catid";
365         $params['catid'] = $categoryid;
366     } else {
367         $categoryselect = "";
368     }
370     if (empty($sort)) {
371         $sortstatement = "";
372     } else {
373         $sortstatement = "ORDER BY $sort";
374     }
376     $visiblecourses = array();
378     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
380     $sql = "SELECT $fields $ccselect
381               FROM {course} c
382            $ccjoin
383               $categoryselect
384               $sortstatement";
386     // pull out all course matching the cat
387     if ($courses = $DB->get_records_sql($sql, $params)) {
389         // loop throught them
390         foreach ($courses as $course) {
391             context_instance_preload($course);
392             if (isset($course->visible) && $course->visible <= 0) {
393                 // for hidden courses, require visibility check
394                 if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
395                     $visiblecourses [$course->id] = $course;
396                 }
397             } else {
398                 $visiblecourses [$course->id] = $course;
399             }
400         }
401     }
402     return $visiblecourses;
406 /**
407  * Returns list of courses, for whole site, or category
408  *
409  * Similar to get_courses, but allows paging
410  * Important: Using c.* for fields is extremely expensive because
411  *            we are using distinct. You almost _NEVER_ need all the fields
412  *            in such a large SELECT
413  *
414  * @global object
415  * @global object
416  * @global object
417  * @uses CONTEXT_COURSE
418  * @param string|int $categoryid Either a category id or 'all' for everything
419  * @param string $sort A field and direction to sort by
420  * @param string $fields The additional fields to return
421  * @param int $totalcount Reference for the number of courses
422  * @param string $limitfrom The course to start from
423  * @param string $limitnum The number of courses to limit to
424  * @return array Array of courses
425  */
426 function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
427                           &$totalcount, $limitfrom="", $limitnum="") {
428     global $USER, $CFG, $DB;
430     $params = array();
432     $categoryselect = "";
433     if ($categoryid != "all" && is_numeric($categoryid)) {
434         $categoryselect = "WHERE c.category = :catid";
435         $params['catid'] = $categoryid;
436     } else {
437         $categoryselect = "";
438     }
440     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
442     $sql = "SELECT $fields $ccselect
443               FROM {course} c
444               $ccjoin
445            $categoryselect
446           ORDER BY $sort";
448     // pull out all course matching the cat
449     if (!$rs = $DB->get_recordset_sql($sql, $params)) {
450         return array();
451     }
452     $totalcount = 0;
454     if (!$limitfrom) {
455         $limitfrom = 0;
456     }
458     // iteration will have to be done inside loop to keep track of the limitfrom and limitnum
459     $visiblecourses = array();
460     foreach($rs as $course) {
461         context_instance_preload($course);
462         if ($course->visible <= 0) {
463             // for hidden courses, require visibility check
464             if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
465                 $totalcount++;
466                 if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
467                     $visiblecourses [$course->id] = $course;
468                 }
469             }
470         } else {
471             $totalcount++;
472             if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
473                 $visiblecourses [$course->id] = $course;
474             }
475         }
476     }
477     $rs->close();
478     return $visiblecourses;
481 /**
482  * Retrieve course records with the course managers and other related records
483  * that we need for print_course(). This allows print_courses() to do its job
484  * in a constant number of DB queries, regardless of the number of courses,
485  * role assignments, etc.
486  *
487  * The returned array is indexed on c.id, and each course will have
488  * - $course->managers - array containing RA objects that include a $user obj
489  *                       with the minimal fields needed for fullname()
490  *
491  * @global object
492  * @global object
493  * @global object
494  * @uses CONTEXT_COURSE
495  * @uses CONTEXT_SYSTEM
496  * @uses CONTEXT_COURSECAT
497  * @uses SITEID
498  * @param int|string $categoryid Either the categoryid for the courses or 'all'
499  * @param string $sort A SQL sort field and direction
500  * @param array $fields An array of additional fields to fetch
501  * @return array
502  */
503 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
504     /*
505      * The plan is to
506      *
507      * - Grab the courses JOINed w/context
508      *
509      * - Grab the interesting course-manager RAs
510      *   JOINed with a base user obj and add them to each course
511      *
512      * So as to do all the work in 2 DB queries. The RA+user JOIN
513      * ends up being pretty expensive if it happens over _all_
514      * courses on a large site. (Are we surprised!?)
515      *
516      * So this should _never_ get called with 'all' on a large site.
517      *
518      */
519     global $USER, $CFG, $DB;
521     $params = array();
522     $allcats = false; // bool flag
523     if ($categoryid === 'all') {
524         $categoryclause   = '';
525         $allcats = true;
526     } elseif (is_numeric($categoryid)) {
527         $categoryclause = "c.category = :catid";
528         $params['catid'] = $categoryid;
529     } else {
530         debugging("Could not recognise categoryid = $categoryid");
531         $categoryclause = '';
532     }
534     $basefields = array('id', 'category', 'sortorder',
535                         'shortname', 'fullname', 'idnumber',
536                         'startdate', 'visible',
537                         'newsitems', 'groupmode', 'groupmodeforce');
539     if (!is_null($fields) && is_string($fields)) {
540         if (empty($fields)) {
541             $fields = $basefields;
542         } else {
543             // turn the fields from a string to an array that
544             // get_user_courses_bycap() will like...
545             $fields = explode(',',$fields);
546             $fields = array_map('trim', $fields);
547             $fields = array_unique(array_merge($basefields, $fields));
548         }
549     } elseif (is_array($fields)) {
550         $fields = array_merge($basefields,$fields);
551     }
552     $coursefields = 'c.' .join(',c.', $fields);
554     if (empty($sort)) {
555         $sortstatement = "";
556     } else {
557         $sortstatement = "ORDER BY $sort";
558     }
560     $where = 'WHERE c.id != ' . SITEID;
561     if ($categoryclause !== ''){
562         $where = "$where AND $categoryclause";
563     }
565     // pull out all courses matching the cat
566     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
567     $sql = "SELECT $coursefields $ccselect
568               FROM {course} c
569            $ccjoin
570                $where
571                $sortstatement";
573     $catpaths = array();
574     $catpath  = NULL;
575     if ($courses = $DB->get_records_sql($sql, $params)) {
576         // loop on courses materialising
577         // the context, and prepping data to fetch the
578         // managers efficiently later...
579         foreach ($courses as $k => $course) {
580             context_instance_preload($course);
581             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
582             $courses[$k] = $course;
583             $courses[$k]->managers = array();
584             if ($allcats === false) {
585                 // single cat, so take just the first one...
586                 if ($catpath === NULL) {
587                     $catpath = preg_replace(':/\d+$:', '', $coursecontext->path);
588                 }
589             } else {
590                 // chop off the contextid of the course itself
591                 // like dirname() does...
592                 $catpaths[] = preg_replace(':/\d+$:', '', $coursecontext->path);
593             }
594         }
595     } else {
596         return array(); // no courses!
597     }
599     $CFG->coursecontact = trim($CFG->coursecontact);
600     if (empty($CFG->coursecontact)) {
601         return $courses;
602     }
604     $managerroles = explode(',', $CFG->coursecontact);
605     $catctxids = '';
606     if (count($managerroles)) {
607         if ($allcats === true) {
608             $catpaths  = array_unique($catpaths);
609             $ctxids = array();
610             foreach ($catpaths as $cpath) {
611                 $ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
612             }
613             $ctxids = array_unique($ctxids);
614             $catctxids = implode( ',' , $ctxids);
615             unset($catpaths);
616             unset($cpath);
617         } else {
618             // take the ctx path from the first course
619             // as all categories will be the same...
620             $catpath = substr($catpath,1);
621             $catpath = preg_replace(':/\d+$:','',$catpath);
622             $catctxids = str_replace('/',',',$catpath);
623         }
624         if ($categoryclause !== '') {
625             $categoryclause = "AND $categoryclause";
626         }
627         /*
628          * Note: Here we use a LEFT OUTER JOIN that can
629          * "optionally" match to avoid passing a ton of context
630          * ids in an IN() clause. Perhaps a subselect is faster.
631          *
632          * In any case, this SQL is not-so-nice over large sets of
633          * courses with no $categoryclause.
634          *
635          */
636         $sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
637                        r.id AS roleid, r.name as rolename,
638                        u.id AS userid, u.firstname, u.lastname
639                   FROM {role_assignments} ra
640                   JOIN {context} ctx ON ra.contextid = ctx.id
641                   JOIN {user} u ON ra.userid = u.id
642                   JOIN {role} r ON ra.roleid = r.id
643                   LEFT OUTER JOIN {course} c
644                        ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
645                 WHERE ( c.id IS NOT NULL";
646         // under certain conditions, $catctxids is NULL
647         if($catctxids == NULL){
648             $sql .= ") ";
649         }else{
650             $sql .= " OR ra.contextid  IN ($catctxids) )";
651         }
653         $sql .= "AND ra.roleid IN ({$CFG->coursecontact})
654                       $categoryclause
655                 ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
656         $rs = $DB->get_recordset_sql($sql, $params);
658         // This loop is fairly stupid as it stands - might get better
659         // results doing an initial pass clustering RAs by path.
660         foreach($rs as $ra) {
661             $user = new stdClass;
662             $user->id        = $ra->userid;    unset($ra->userid);
663             $user->firstname = $ra->firstname; unset($ra->firstname);
664             $user->lastname  = $ra->lastname;  unset($ra->lastname);
665             $ra->user = $user;
666             if ($ra->contextlevel == CONTEXT_SYSTEM) {
667                 foreach ($courses as $k => $course) {
668                     $courses[$k]->managers[] = $ra;
669                 }
670             } else if ($ra->contextlevel == CONTEXT_COURSECAT) {
671                 if ($allcats === false) {
672                     // It always applies
673                     foreach ($courses as $k => $course) {
674                         $courses[$k]->managers[] = $ra;
675                     }
676                 } else {
677                     foreach ($courses as $k => $course) {
678                         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
679                         // Note that strpos() returns 0 as "matched at pos 0"
680                         if (strpos($coursecontext->path, $ra->path.'/') === 0) {
681                             // Only add it to subpaths
682                             $courses[$k]->managers[] = $ra;
683                         }
684                     }
685                 }
686             } else { // course-level
687                 if (!array_key_exists($ra->instanceid, $courses)) {
688                     //this course is not in a list, probably a frontpage course
689                     continue;
690                 }
691                 $courses[$ra->instanceid]->managers[] = $ra;
692             }
693         }
694         $rs->close();
695     }
697     return $courses;
700 /**
701  * A list of courses that match a search
702  *
703  * @global object
704  * @global object
705  * @param array $searchterms An array of search criteria
706  * @param string $sort A field and direction to sort by
707  * @param int $page The page number to get
708  * @param int $recordsperpage The number of records per page
709  * @param int $totalcount Passed in by reference.
710  * @return object {@link $COURSE} records
711  */
712 function get_courses_search($searchterms, $sort='fullname ASC', $page=0, $recordsperpage=50, &$totalcount) {
713     global $CFG, $DB;
715     if ($DB->sql_regex_supported()) {
716         $REGEXP    = $DB->sql_regex(true);
717         $NOTREGEXP = $DB->sql_regex(false);
718     }
719     $LIKE = $DB->sql_ilike(); // case-insensitive
721     $searchcond = array();
722     $params     = array();
723     $i = 0;
725     $concat = $DB->sql_concat('c.summary', "' '", 'c.fullname');
727     foreach ($searchterms as $searchterm) {
728         $i++;
730         $NOT = ''; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
731                    /// will use it to simulate the "-" operator with LIKE clause
733     /// Under Oracle and MSSQL, trim the + and - operators and perform
734     /// simpler LIKE (or NOT LIKE) queries
735         if (!$DB->sql_regex_supported()) {
736             if (substr($searchterm, 0, 1) == '-') {
737                 $NOT = ' NOT ';
738             }
739             $searchterm = trim($searchterm, '+-');
740         }
742         // TODO: +- may not work for non latin languages
744         if (substr($searchterm,0,1) == '+') {
745             $searchterm = trim($searchterm, '+-');
746             $searchterm = preg_quote($searchterm, '|');
747             $searchcond[] = "$concat $REGEXP :ss$i";
748             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
750         } else if (substr($searchterm,0,1) == "-") {
751             $searchterm = trim($searchterm, '+-');
752             $searchterm = preg_quote($searchterm, '|');
753             $searchcond[] = "$concat $NOTREGEXP :ss$i";
754             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
756         } else {
757             $searchcond[] = "$concat $NOT $LIKE :ss$i";
758             $params['ss'.$i] = "%$searchterm%";
759         }
760     }
762     if (empty($searchcond)) {
763         $totalcount = 0;
764         return array();
765     }
767     $searchcond = implode(" AND ", $searchcond);
769     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
770     $sql = "SELECT c.* $ccselect
771               FROM {course} c
772            $ccjoin
773              WHERE $searchcond AND c.id <> ".SITEID."
774           ORDER BY $sort";
775     $courses = array();
776     $c = 0; // counts how many visible courses we've seen
778     if ($rs = $DB->get_recordset_sql($sql, $params)) {
779         // Tiki pagination
780         $limitfrom = $page * $recordsperpage;
781         $limitto   = $limitfrom + $recordsperpage;
783         foreach($rs as $course) {
784             context_instance_preload($course);
785             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
786             if ($course->visible || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
787                 // Don't exit this loop till the end
788                 // we need to count all the visible courses
789                 // to update $totalcount
790                 if ($c >= $limitfrom && $c < $limitto) {
791                     $courses[$course->id] = $course;
792                 }
793                 $c++;
794             }
795         }
796         $rs->close();
797     }
799     // our caller expects 2 bits of data - our return
800     // array, and an updated $totalcount
801     $totalcount = $c;
802     return $courses;
806 /**
807  * Returns a sorted list of categories. Each category object has a context
808  * property that is a context object.
809  *
810  * When asking for $parent='none' it will return all the categories, regardless
811  * of depth. Wheen asking for a specific parent, the default is to return
812  * a "shallow" resultset. Pass false to $shallow and it will return all
813  * the child categories as well.
814  *
815  * @global object
816  * @uses CONTEXT_COURSECAT
817  * @param string $parent The parent category if any
818  * @param string $sort the sortorder
819  * @param bool   $shallow - set to false to get the children too
820  * @return array of categories
821  */
822 function get_categories($parent='none', $sort=NULL, $shallow=true) {
823     global $DB;
825     if ($sort === NULL) {
826         $sort = 'ORDER BY cc.sortorder ASC';
827     } elseif ($sort ==='') {
828         // leave it as empty
829     } else {
830         $sort = "ORDER BY $sort";
831     }
833     list($ccselect, $ccjoin) = context_instance_preload_sql('cc.id', CONTEXT_COURSECAT, 'ctx');
835     if ($parent === 'none') {
836         $sql = "SELECT cc.* $ccselect
837                   FROM {course_categories} cc
838                $ccjoin
839                 $sort";
840         $params = array();
842     } elseif ($shallow) {
843         $sql = "SELECT cc.* $ccselect
844                   FROM {course_categories} cc
845                $ccjoin
846                  WHERE cc.parent=?
847                 $sort";
848         $params = array($parent);
850     } else {
851         $sql = "SELECT cc.* $ccselect
852                   FROM {course_categories} cc
853                $ccjoin
854                   JOIN {course_categories} ccp
855                        ON (cc.path LIKE ".$DB->sql_concat('ccp.path',"'%'").")
856                  WHERE ccp.id=?
857                 $sort";
858         $params = array($parent);
859     }
860     $categories = array();
862     if( $rs = $DB->get_recordset_sql($sql, $params) ){
863         foreach($rs as $cat) {
864             context_instance_preload($cat);
865             $catcontext = get_context_instance(CONTEXT_COURSECAT, $cat->id);
866             if ($cat->visible || has_capability('moodle/category:viewhiddencategories', $catcontext)) {
867                 $categories[$cat->id] = $cat;
868             }
869         }
870         $rs->close();
871     }
872     return $categories;
876 /**
877  * Returns an array of category ids of all the subcategories for a given
878  * category.
879  *
880  * @global object
881  * @param int $catid - The id of the category whose subcategories we want to find.
882  * @return array of category ids.
883  */
884 function get_all_subcategories($catid) {
885     global $DB;
887     $subcats = array();
889     if ($categories = $DB->get_records('course_categories', array('parent'=>$catid))) {
890         foreach ($categories as $cat) {
891             array_push($subcats, $cat->id);
892             $subcats = array_merge($subcats, get_all_subcategories($cat->id));
893         }
894     }
895     return $subcats;
898 /**
899  * Return specified category, default if given does not exist
900  *
901  * @global object
902  * @uses MAX_COURSES_IN_CATEGORY
903  * @uses CONTEXT_COURSECAT
904  * @uses SYSCONTEXTID
905  * @param int $catid course category id
906  * @return object caregory
907  */
908 function get_course_category($catid=0) {
909     global $DB;
911     $category = false;
913     if (!empty($catid)) {
914         $category = $DB->get_record('course_categories', array('id'=>$catid));
915     }
917     if (!$category) {
918         // the first category is considered default for now
919         if ($category = $DB->get_records('course_categories', null, 'sortorder', '*', 0, 1)) {
920             $category = reset($category);
922         } else {
923             $cat = new object();
924             $cat->name         = get_string('miscellaneous');
925             $cat->depth        = 1;
926             $cat->sortorder    = MAX_COURSES_IN_CATEGORY;
927             $cat->timemodified = time();
928             $catid = $DB->insert_record('course_categories', $cat);
929             // make sure category context exists
930             get_context_instance(CONTEXT_COURSECAT, $catid);
931             mark_context_dirty('/'.SYSCONTEXTID);
932             fix_course_sortorder(); // Required to build course_categories.depth and .path.
933             $category = $DB->get_record('course_categories', array('id'=>$catid));
934         }
935     }
937     return $category;
940 /**
941  * Fixes course category and course sortorder, also verifies category and course parents and paths.
942  * (circular references are not fixed)
943  *
944  * @global object
945  * @global object
946  * @uses MAX_COURSES_IN_CATEGORY
947  * @uses MAX_COURSE_CATEGORIES
948  * @uses SITEID
949  * @uses CONTEXT_COURSE
950  * @return void
951  */
952 function fix_course_sortorder() {
953     global $DB, $SITE;
955     //WARNING: this is PHP5 only code!
957     if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
958         //move all categories that are not sorted yet to the end
959         $DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('sortorder'=>0));
960     }
962     $allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
963     $topcats    = array();
964     $brokencats = array();
965     foreach ($allcats as $cat) {
966         $sortorder = (int)$cat->sortorder;
967         if (!$cat->parent) {
968             while(isset($topcats[$sortorder])) {
969                 $sortorder++;
970             }
971             $topcats[$sortorder] = $cat;
972             continue;
973         }
974         if (!isset($allcats[$cat->parent])) {
975             $brokencats[] = $cat;
976             continue;
977         }
978         if (!isset($allcats[$cat->parent]->children)) {
979             $allcats[$cat->parent]->children = array();
980         }
981         while(isset($allcats[$cat->parent]->children[$sortorder])) {
982             $sortorder++;
983         }
984         $allcats[$cat->parent]->children[$sortorder] = $cat;
985     }
986     unset($allcats);
988     // add broken cats to category tree
989     if ($brokencats) {
990         $defaultcat = reset($topcats);
991         foreach ($brokencats as $cat) {
992             $topcats[] = $cat;
993         }
994     }
996     // now walk recursively the tree and fix any problems found
997     $sortorder = 0;
998     $fixcontexts = array();
999     _fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts);
1001     // detect if there are "multiple" frontpage courses and fix them if needed
1002     $frontcourses = $DB->get_records('course', array('category'=>0), 'id');
1003     if (count($frontcourses) > 1) {
1004         if (isset($frontcourses[SITEID])) {
1005             $frontcourse = $frontcourses[SITEID];
1006             unset($frontcourses[SITEID]);
1007         } else {
1008             $frontcourse = array_shift($frontcourses);
1009         }
1010         $defaultcat = reset($topcats);
1011         foreach ($frontcourses as $course) {
1012             $DB->set_field('course', 'category', $defaultcat->id, array('id'=>$course->id));
1013             $context = get_context_instance(CONTEXT_COURSE, $course->id);
1014             $fixcontexts[$context->id] = $context;
1015         }
1016         unset($frontcourses);
1017     } else {
1018         $frontcourse = reset($frontcourses);
1019     }
1021     // now fix the paths and depths in context table if needed
1022     if ($fixcontexts) {
1023         rebuild_contexts($fixcontexts);
1024     }
1026     // release memory
1027     unset($topcats);
1028     unset($brokencats);
1029     unset($fixcontexts);
1031     // fix frontpage course sortorder
1032     if ($frontcourse->sortorder != 1) {
1033         $DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id));
1034     }
1036     // now fix the course counts in category records if needed
1037     $sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
1038               FROM {course_categories} cc
1039               LEFT JOIN {course} c ON c.category = cc.id
1040           GROUP BY cc.id, cc.coursecount
1041             HAVING cc.coursecount <> COUNT(c.id)";
1043     if ($updatecounts = $DB->get_records_sql($sql)) {
1044         foreach ($updatecounts as $cat) {
1045             $cat->coursecount = $cat->newcount;
1046             unset($cat->newcount);
1047             $DB->update_record_raw('course_categories', $cat, true);
1048         }
1049     }
1051     // now make sure that sortorders in course table are withing the category sortorder ranges
1052     $sql = "SELECT DISTINCT cc.id, cc.sortorder
1053               FROM {course_categories} cc
1054               JOIN {course} c ON c.category = cc.id
1055              WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY;
1057     if ($fixcategories = $DB->get_records_sql($sql)) {
1058         //fix the course sortorder ranges
1059         foreach ($fixcategories as $cat) {
1060             $sql = "UPDATE {course}
1061                        SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY)." + ?
1062                      WHERE category = ?";
1063             $DB->execute($sql, array($cat->sortorder, $cat->id));
1064         }
1065     }
1066     unset($fixcategories);
1068     // categories having courses with sortorder duplicates or having gaps in sortorder
1069     $sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
1070               FROM {course} c1
1071               JOIN {course} c2 ON c1.sortorder = c2.sortorder
1072               JOIN {course_categories} cc ON (c1.category = cc.id)
1073              WHERE c1.id <> c2.id";
1074     $fixcategories = $DB->get_records_sql($sql);
1076     $sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
1077               FROM {course_categories} cc
1078               JOIN {course} c ON c.category = cc.id
1079           GROUP BY cc.id, cc.sortorder, cc.coursecount
1080             HAVING (MAX(c.sortorder) <>  cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <>  cc.sortorder + 1)";
1081     $gapcategories = $DB->get_records_sql($sql);
1083     foreach ($gapcategories as $cat) {
1084         if (isset($fixcategories[$cat->id])) {
1085             // duplicates detected already
1087         } else if ($cat->minsort == $cat->sortorder and $cat->maxsort == $cat->sortorder + $cat->coursecount - 1) {
1088             // easy - new course inserted with sortorder 0, the rest is ok
1089             $sql = "UPDATE {course}
1090                        SET sortorder = sortorder + 1
1091                      WHERE category = ?";
1092             $DB->execute($sql, array($cat->id));
1094         } else {
1095             // it needs full resorting
1096             $fixcategories[$cat->id] = $cat;
1097         }
1098     }
1099     unset($gapcategories);
1101     // fix course sortorders in problematic categories only
1102     foreach ($fixcategories as $cat) {
1103         $i = 1;
1104         $courses = $DB->get_records('course', array('category'=>$cat->id), 'sortorder ASC, id DESC', 'id, sortorder');
1105         foreach ($courses as $course) {
1106             if ($course->sortorder != $cat->sortorder + $i) {
1107                 $course->sortorder = $cat->sortorder + $i;
1108                 $DB->update_record_raw('course', $course, true);
1109             }
1110             $i++;
1111         }
1112     }
1115 /**
1116  * Internal recursive category verification function, do not use directly!
1117  *
1118  * @todo Document the arguments of this function better
1119  *
1120  * @global object
1121  * @uses MAX_COURSES_IN_CATEGORY
1122  * @uses CONTEXT_COURSECAT
1123  * @param array $children
1124  * @param int $sortorder
1125  * @param string $parent
1126  * @param int $depth
1127  * @param string $path
1128  * @param array $fixcontexts
1129  * @return void
1130  */
1131 function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
1132     global $DB;
1134     $depth++;
1136     foreach ($children as $cat) {
1137         $sortorder = $sortorder + MAX_COURSES_IN_CATEGORY;
1138         $update = false;
1139         if ($parent != $cat->parent or $depth != $cat->depth or $path.'/'.$cat->id != $cat->path) {
1140             $cat->parent = $parent;
1141             $cat->depth  = $depth;
1142             $cat->path   = $path.'/'.$cat->id;
1143             $update = true;
1145             // make sure context caches are rebuild and dirty contexts marked
1146             $context = get_context_instance(CONTEXT_COURSECAT, $cat->id);
1147             $fixcontexts[$context->id] = $context;
1148         }
1149         if ($cat->sortorder != $sortorder) {
1150             $cat->sortorder = $sortorder;
1151             $update = true;
1152         }
1153         if ($update) {
1154             $DB->update_record('course_categories', $cat, true);
1155         }
1156         if (isset($cat->children)) {
1157             _fix_course_cats($cat->children, $sortorder, $cat->id, $cat->depth, $cat->path, $fixcontexts);
1158         }
1159     }
1162 /**
1163  * List of remote courses that a user has access to via MNET.
1164  * Works only on the IDP
1165  *
1166  * @global object
1167  * @global object
1168  * @param int @userid The user id to get remote courses for
1169  * @return array Array of {@link $COURSE} of course objects
1170  */
1171 function get_my_remotecourses($userid=0) {
1172     global $DB, $USER;
1174     if (empty($userid)) {
1175         $userid = $USER->id;
1176     }
1178     // we can not use SELECT DISTINCT + text field (summary) because of MS SQL and Oracle, subselect used therefore
1179     $sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
1180                    c.hostid, c.summary, c.summaryformat, c.categoryname AS cat_name,
1181                    h.name AS hostname
1182               FROM {mnetservice_enrol_courses} c
1183               JOIN (SELECT DISTINCT hostid, remotecourseid
1184                       FROM {mnetservice_enrol_enrolments}
1185                      WHERE userid = ?
1186                    ) e ON (e.hostid = c.hostid AND e.remotecourseid = c.remoteid)
1187               JOIN {mnet_host} h ON h.id = c.hostid";
1189     return $DB->get_records_sql($sql, array($userid));
1192 /**
1193  * List of remote hosts that a user has access to via MNET.
1194  * Works on the SP
1195  *
1196  * @global object
1197  * @global object
1198  * @return array|bool Array of host objects or false
1199  */
1200 function get_my_remotehosts() {
1201     global $CFG, $USER;
1203     if ($USER->mnethostid == $CFG->mnet_localhost_id) {
1204         return false; // Return nothing on the IDP
1205     }
1206     if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
1207         return $USER->mnet_foreign_host_array;
1208     }
1209     return false;
1212 /**
1213  * This function creates a default separated/connected scale
1214  *
1215  * This function creates a default separated/connected scale
1216  * so there's something in the database.  The locations of
1217  * strings and files is a bit odd, but this is because we
1218  * need to maintain backward compatibility with many different
1219  * existing language translations and older sites.
1220  *
1221  * @global object
1222  * @return void
1223  */
1224 function make_default_scale() {
1225     global $DB;
1227     $defaultscale = NULL;
1228     $defaultscale->courseid = 0;
1229     $defaultscale->userid = 0;
1230     $defaultscale->name  = get_string('separateandconnected');
1231     $defaultscale->description = get_string('separateandconnectedinfo');
1232     $defaultscale->scale = get_string('postrating1', 'forum').','.
1233                            get_string('postrating2', 'forum').','.
1234                            get_string('postrating3', 'forum');
1235     $defaultscale->timemodified = time();
1237     if ($defaultscale->id = $DB->insert_record('scale', $defaultscale)) {
1238         $DB->execute("UPDATE {forum} SET scale = ?", array($defaultscale->id));
1239     }
1243 /**
1244  * Returns a menu of all available scales from the site as well as the given course
1245  *
1246  * @global object
1247  * @param int $courseid The id of the course as found in the 'course' table.
1248  * @return array
1249  */
1250 function get_scales_menu($courseid=0) {
1251     global $DB;
1253     $sql = "SELECT id, name
1254               FROM {scale}
1255              WHERE courseid = 0 or courseid = ?
1256           ORDER BY courseid ASC, name ASC";
1257     $params = array($courseid);
1259     if ($scales = $DB->get_records_sql_menu($sql, $params)) {
1260         return $scales;
1261     }
1263     make_default_scale();
1265     return $DB->get_records_sql_menu($sql, $params);
1270 /**
1271  * Given a set of timezone records, put them in the database,  replacing what is there
1272  *
1273  * @global object
1274  * @param array $timezones An array of timezone records
1275  * @return void
1276  */
1277 function update_timezone_records($timezones) {
1278     global $DB;
1280 /// Clear out all the old stuff
1281     $DB->delete_records('timezone');
1283 /// Insert all the new stuff
1284     foreach ($timezones as $timezone) {
1285         if (is_array($timezone)) {
1286             $timezone = (object)$timezone;
1287         }
1288         $DB->insert_record('timezone', $timezone);
1289     }
1293 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1295 /**
1296  * Just gets a raw list of all modules in a course
1297  *
1298  * @global object
1299  * @param int $courseid The id of the course as found in the 'course' table.
1300  * @return array
1301  */
1302 function get_course_mods($courseid) {
1303     global $DB;
1305     if (empty($courseid)) {
1306         return false; // avoid warnings
1307     }
1309     return $DB->get_records_sql("SELECT cm.*, m.name as modname
1310                                    FROM {modules} m, {course_modules} cm
1311                                   WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
1312                                 array($courseid)); // no disabled mods
1316 /**
1317  * Given an id of a course module, finds the coursemodule description
1318  *
1319  * @global object
1320  * @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
1321  * @param int $cmid course module id (id in course_modules table)
1322  * @param int $courseid optional course id for extra validation
1323  * @param bool $sectionnum include relative section number (0,1,2 ...)
1324  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1325  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1326  *                        MUST_EXIST means throw exception if no record or multiple records found
1327  * @return array Array of results
1328  */
1329 function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1330     global $DB;
1332     $params = array('cmid'=>$cmid);
1334     if (!$modulename) {
1335         if (!$modulename = $DB->get_field_sql("SELECT md.name
1336                                                  FROM {modules} md
1337                                                  JOIN {course_modules} cm ON cm.module = md.id
1338                                                 WHERE cm.id = :cmid", $params, $strictness)) {
1339             return false;
1340         }
1341     }
1343     $params['modulename'] = $modulename;
1345     $courseselect = "";
1346     $sectionfield = "";
1347     $sectionjoin  = "";
1349     if ($courseid) {
1350         $courseselect = "AND cm.course = :courseid";
1351         $params['courseid'] = $courseid;
1352     }
1354     if ($sectionnum) {
1355         $sectionfield = ", cw.section AS sectionnum";
1356         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1357     }
1359     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1360               FROM {course_modules} cm
1361                    JOIN {modules} md ON md.id = cm.module
1362                    JOIN {".$modulename."} m ON m.id = cm.instance
1363                    $sectionjoin
1364              WHERE cm.id = :cmid AND md.name = :modulename
1365                    $courseselect";
1367     return $DB->get_record_sql($sql, $params, $strictness);
1370 /**
1371  * Given an instance number of a module, finds the coursemodule description
1372  *
1373  * @global object
1374  * @param string $modulename name of module type, eg. resource, assignment,...
1375  * @param int $instance module instance number (id in resource, assignment etc. table)
1376  * @param int $courseid optional course id for extra validation
1377  * @param bool $sectionnum include relative section number (0,1,2 ...)
1378  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1379  *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1380  *                        MUST_EXIST means throw exception if no record or multiple records found
1381  * @return array Array of results
1382  */
1383 function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
1384     global $DB;
1386     $params = array('instance'=>$instance, 'modulename'=>$modulename);
1388     $courseselect = "";
1389     $sectionfield = "";
1390     $sectionjoin  = "";
1392     if ($courseid) {
1393         $courseselect = "AND cm.course = :courseid";
1394         $params['courseid'] = $courseid;
1395     }
1397     if ($sectionnum) {
1398         $sectionfield = ", cw.section AS sectionnum";
1399         $sectionjoin  = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
1400     }
1402     $sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
1403               FROM {course_modules} cm
1404                    JOIN {modules} md ON md.id = cm.module
1405                    JOIN {".$modulename."} m ON m.id = cm.instance
1406                    $sectionjoin
1407              WHERE m.id = :instance AND md.name = :modulename
1408                    $courseselect";
1410     return $DB->get_record_sql($sql, $params, $strictness);
1413 /**
1414  * Returns all course modules of given activity in course
1415  *
1416  * @param string $modulename The module name (forum, quiz, etc.)
1417  * @param int $courseid The course id to get modules for
1418  * @param string $extrafields extra fields starting with m.
1419  * @return array Array of results
1420  */
1421 function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
1422     global $DB;
1424     if (!empty($extrafields)) {
1425         $extrafields = ", $extrafields";
1426     }
1427     $params = array();
1428     $params['courseid'] = $courseid;
1429     $params['modulename'] = $modulename;
1432     return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
1433                                    FROM {course_modules} cm, {modules} md, {".$modulename."} m
1434                                   WHERE cm.course = :courseid AND
1435                                         cm.instance = m.id AND
1436                                         md.name = :modulename AND
1437                                         md.id = cm.module", $params);
1440 /**
1441  * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1442  *
1443  * Returns an array of all the active instances of a particular
1444  * module in given courses, sorted in the order they are defined
1445  * in the course. Returns an empty array on any errors.
1446  *
1447  * The returned objects includle the columns cw.section, cm.visible,
1448  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1449  *
1450  * @global object
1451  * @global object
1452  * @param string $modulename The name of the module to get instances for
1453  * @param array $courses an array of course objects.
1454  * @param int $userid
1455  * @param int $includeinvisible
1456  * @return array of module instance objects, including some extra fields from the course_modules
1457  *          and course_sections tables, or an empty array if an error occurred.
1458  */
1459 function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
1460     global $CFG, $DB;
1462     $outputarray = array();
1464     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1465         return $outputarray;
1466     }
1468     list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED, 'c0');
1469     $params['modulename'] = $modulename;
1471     if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
1472                                                  cm.groupmode, cm.groupingid, cm.groupmembersonly
1473                                             FROM {course_modules} cm, {course_sections} cw, {modules} md,
1474                                                  {".$modulename."} m
1475                                            WHERE cm.course $coursessql AND
1476                                                  cm.instance = m.id AND
1477                                                  cm.section = cw.id AND
1478                                                  md.name = :modulename AND
1479                                                  md.id = cm.module", $params)) {
1480         return $outputarray;
1481     }
1483     foreach ($courses as $course) {
1484         $modinfo = get_fast_modinfo($course, $userid);
1486         if (empty($modinfo->instances[$modulename])) {
1487             continue;
1488         }
1490         foreach ($modinfo->instances[$modulename] as $cm) {
1491             if (!$includeinvisible and !$cm->uservisible) {
1492                 continue;
1493             }
1494             if (!isset($rawmods[$cm->id])) {
1495                 continue;
1496             }
1497             $instance = $rawmods[$cm->id];
1498             if (!empty($cm->extra)) {
1499                 $instance->extra = $cm->extra;
1500             }
1501             $outputarray[] = $instance;
1502         }
1503     }
1505     return $outputarray;
1508 /**
1509  * Returns an array of all the active instances of a particular module in a given course,
1510  * sorted in the order they are defined.
1511  *
1512  * Returns an array of all the active instances of a particular
1513  * module in a given course, sorted in the order they are defined
1514  * in the course. Returns an empty array on any errors.
1515  *
1516  * The returned objects includle the columns cw.section, cm.visible,
1517  * cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
1518  *
1519  * Simply calls {@link all_instances_in_courses()} with a single provided course
1520  *
1521  * @param string $modulename The name of the module to get instances for
1522  * @param object $course The course obect.
1523  * @return array of module instance objects, including some extra fields from the course_modules
1524  *          and course_sections tables, or an empty array if an error occurred.
1525  * @param int $userid
1526  * @param int $includeinvisible
1527  */
1528 function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
1529     return get_all_instances_in_courses($modulename, array($course->id => $course), $userid, $includeinvisible);
1533 /**
1534  * Determine whether a module instance is visible within a course
1535  *
1536  * Given a valid module object with info about the id and course,
1537  * and the module's type (eg "forum") returns whether the object
1538  * is visible or not, groupmembersonly visibility not tested
1539  *
1540  * @global object
1542  * @param $moduletype Name of the module eg 'forum'
1543  * @param $module Object which is the instance of the module
1544  * @return bool Success
1545  */
1546 function instance_is_visible($moduletype, $module) {
1547     global $DB;
1549     if (!empty($module->id)) {
1550         $params = array('courseid'=>$module->course, 'moduletype'=>$moduletype, 'moduleid'=>$module->id);
1551         if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
1552                                                FROM {course_modules} cm, {modules} m
1553                                               WHERE cm.course = :courseid AND
1554                                                     cm.module = m.id AND
1555                                                     m.name = :moduletype AND
1556                                                     cm.instance = :moduleid", $params)) {
1558             foreach ($records as $record) { // there should only be one - use the first one
1559                 return $record->visible;
1560             }
1561         }
1562     }
1563     return true;  // visible by default!
1566 /**
1567  * Determine whether a course module is visible within a course,
1568  * this is different from instance_is_visible() - faster and visibility for user
1569  *
1570  * @global object
1571  * @global object
1572  * @uses DEBUG_DEVELOPER
1573  * @uses CONTEXT_MODULE
1574  * @uses CONDITION_MISSING_EXTRATABLE
1575  * @param object $cm object
1576  * @param int $userid empty means current user
1577  * @return bool Success
1578  */
1579 function coursemodule_visible_for_user($cm, $userid=0) {
1580     global $USER,$CFG;
1582     if (empty($cm->id)) {
1583         debugging("Incorrect course module parameter!", DEBUG_DEVELOPER);
1584         return false;
1585     }
1586     if (empty($userid)) {
1587         $userid = $USER->id;
1588     }
1589     if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1590         return false;
1591     }
1592     if ($CFG->enableavailability) {
1593         require_once($CFG->libdir.'/conditionlib.php');
1594         $ci=new condition_info($cm,CONDITION_MISSING_EXTRATABLE);
1595         if(!$ci->is_available($cm->availableinfo,false,$userid) and
1596             !has_capability('moodle/course:viewhiddenactivities',
1597                 get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
1598             return false;
1599         }
1600     }
1601     return groups_course_module_visible($cm, $userid);
1607 /// LOG FUNCTIONS /////////////////////////////////////////////////////
1610 /**
1611  * Add an entry to the log table.
1612  *
1613  * Add an entry to the log table.  These are "action" focussed rather
1614  * than web server hits, and provide a way to easily reconstruct what
1615  * any particular student has been doing.
1616  *
1617  * @global object
1618  * @global object
1619  * @global object
1620  * @uses SITEID
1621  * @uses DEBUG_DEVELOPER
1622  * @uses DEBUG_ALL
1623  * @param    int     $courseid  The course id
1624  * @param    string  $module  The module name - e.g. forum, journal, resource, course, user etc
1625  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
1626  * @param    string  $url     The file and parameters used to see the results of the action
1627  * @param    string  $info    Additional description information
1628  * @param    string  $cm      The course_module->id if there is one
1629  * @param    string  $user    If log regards $user other than $USER
1630  * @return void
1631  */
1632 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
1633     // Note that this function intentionally does not follow the normal Moodle DB access idioms.
1634     // This is for a good reason: it is the most frequently used DB update function,
1635     // so it has been optimised for speed.
1636     global $DB, $CFG, $USER;
1638     if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
1639         $cm = 0;
1640     }
1642     if ($user) {
1643         $userid = $user;
1644     } else {
1645         if (session_is_loggedinas()) {  // Don't log
1646             return;
1647         }
1648         $userid = empty($USER->id) ? '0' : $USER->id;
1649     }
1651     $REMOTE_ADDR = getremoteaddr();
1653     $timenow = time();
1654     $info = $info;
1655     if (!empty($url)) { // could break doing html_entity_decode on an empty var.
1656         $url = html_entity_decode($url); // for php < 4.3.0 this is defined in moodlelib.php
1657     }
1659     // Restrict length of log lines to the space actually available in the
1660     // database so that it doesn't cause a DB error. Log a warning so that
1661     // developers can avoid doing things which are likely to cause this on a
1662     // routine basis.
1663     $tl = textlib_get_instance();
1664     if(!empty($info) && $tl->strlen($info)>255) {
1665         $info = $tl->substr($info,0,252).'...';
1666         debugging('Warning: logged very long info',DEBUG_DEVELOPER);
1667     }
1669     // If the 100 field size is changed, also need to alter print_log in course/lib.php
1670     if(!empty($url) && $tl->strlen($url)>100) {
1671         $url=$tl->substr($url,0,97).'...';
1672         debugging('Warning: logged very long URL',DEBUG_DEVELOPER);
1673     }
1675     if (defined('MDL_PERFDB')) { global $PERF ; $PERF->logwrites++;};
1677     $log = array('time'=>$timenow, 'userid'=>$userid, 'course'=>$courseid, 'ip'=>$REMOTE_ADDR, 'module'=>$module,
1678                  'cmid'=>$cm, 'action'=>$action, 'url'=>$url, 'info'=>$info);
1679     $result = $DB->insert_record_raw('log', $log, false);
1681     // MDL-11893, alert $CFG->supportemail if insert into log failed
1682     if (!$result and $CFG->supportemail and empty($CFG->noemailever)) {
1683         // email_to_user is not usable because email_to_user tries to write to the logs table,
1684         // and this will get caught in an infinite loop, if disk is full
1685         $site = get_site();
1686         $subject = 'Insert into log failed at your moodle site '.$site->fullname;
1687         $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";
1688         $message .= "The failed query parameters are:\n\n" . var_export($log, true);
1690         $lasttime = get_config('admin', 'lastloginserterrormail');
1691         if(empty($lasttime) || time() - $lasttime > 60*60*24) { // limit to 1 email per day
1692             mail($CFG->supportemail, $subject, $message);
1693             set_config('lastloginserterrormail', time(), 'admin');
1694         }
1695     }
1697     if (!$result) {
1698         debugging('Error: Could not insert a new entry to the Moodle log', DEBUG_ALL);
1699     }
1703 /**
1704  * Store user last access times - called when use enters a course or site
1705  *
1706  * @global object
1707  * @global object
1708  * @global object
1709  * @uses LASTACCESS_UPDATE_SECS
1710  * @uses SITEID
1711  * @param int $courseid, empty means site
1712  * @return void
1713  */
1714 function user_accesstime_log($courseid=0) {
1715     global $USER, $CFG, $DB;
1717     if (!isloggedin() or session_is_loggedinas()) {
1718         // no access tracking
1719         return;
1720     }
1722     if (empty($courseid)) {
1723         $courseid = SITEID;
1724     }
1726     $timenow = time();
1728 /// Store site lastaccess time for the current user
1729     if ($timenow - $USER->lastaccess > LASTACCESS_UPDATE_SECS) {
1730     /// Update $USER->lastaccess for next checks
1731         $USER->lastaccess = $timenow;
1733         $last = new object();
1734         $last->id         = $USER->id;
1735         $last->lastip     = getremoteaddr();
1736         $last->lastaccess = $timenow;
1738         $DB->update_record_raw('user', $last);
1739     }
1741     if ($courseid == SITEID) {
1742     ///  no user_lastaccess for frontpage
1743         return;
1744     }
1746 /// Store course lastaccess times for the current user
1747     if (empty($USER->currentcourseaccess[$courseid]) or ($timenow - $USER->currentcourseaccess[$courseid] > LASTACCESS_UPDATE_SECS)) {
1749         $lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id, 'courseid'=>$courseid));
1751         if ($lastaccess === false) {
1752             // Update course lastaccess for next checks
1753             $USER->currentcourseaccess[$courseid] = $timenow;
1755             $last = new object();
1756             $last->userid     = $USER->id;
1757             $last->courseid   = $courseid;
1758             $last->timeaccess = $timenow;
1759             $DB->insert_record_raw('user_lastaccess', $last, false);
1761         } else if ($timenow - $lastaccess <  LASTACCESS_UPDATE_SECS) {
1762             // no need to update now, it was updated recently in concurrent login ;-)
1764         } else {
1765             // Update course lastaccess for next checks
1766             $USER->currentcourseaccess[$courseid] = $timenow;
1768             $DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id, 'courseid'=>$courseid));
1769         }
1770     }
1773 /**
1774  * Select all log records based on SQL criteria
1775  *
1776  * @todo Finish documenting this function
1777  *
1778  * @global object
1779  * @param string $select SQL select criteria
1780  * @param array $params named sql type params
1781  * @param string $order SQL order by clause to sort the records returned
1782  * @param string $limitfrom ?
1783  * @param int $limitnum ?
1784  * @param int $totalcount Passed in by reference.
1785  * @return object
1786  */
1787 function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
1788     global $DB;
1790     if ($order) {
1791         $order = "ORDER BY $order";
1792     }
1794     $selectsql = "";
1795     $countsql  = "";
1797     if ($select) {
1798         $select = "WHERE $select";
1799     }
1801     $sql = "SELECT COUNT(*)
1802               FROM {log} l
1803            $select";
1805     $totalcount = $DB->count_records_sql($sql, $params);
1807     $sql = "SELECT l.*, u.firstname, u.lastname, u.picture
1808               FROM {log} l
1809               LEFT JOIN {user} u ON l.userid = u.id
1810            $select
1811             $order";
1813     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum) ;
1817 /**
1818  * Select all log records for a given course and user
1819  *
1820  * @todo Finish documenting this function
1821  *
1822  * @global object
1823  * @uses DAYSECS
1824  * @param int $userid The id of the user as found in the 'user' table.
1825  * @param int $courseid The id of the course as found in the 'course' table.
1826  * @param string $coursestart ?
1827  */
1828 function get_logs_usercourse($userid, $courseid, $coursestart) {
1829     global $DB;
1831     $params = array();
1833     $courseselect = '';
1834     if ($courseid) {
1835         $courseselect = "AND course = :courseid";
1836         $params['courseid'] = $courseid;
1837     }
1838     $params['userid'] = $userid;
1839     $params['coursestart'] = $coursestart;
1841     return $DB->get_records_sql("SELECT FLOOR((time - :coursestart)/". DAYSECS .") AS day, COUNT(*) AS num
1842                                    FROM {log}
1843                                   WHERE userid = :userid
1844                                         AND time > :coursestart $courseselect
1845                                GROUP BY FLOOR((time - :coursestart)/". DAYSECS .")", $params);
1848 /**
1849  * Select all log records for a given course, user, and day
1850  *
1851  * @global object
1852  * @uses HOURSECS
1853  * @param int $userid The id of the user as found in the 'user' table.
1854  * @param int $courseid The id of the course as found in the 'course' table.
1855  * @param string $daystart ?
1856  * @return object
1857  */
1858 function get_logs_userday($userid, $courseid, $daystart) {
1859     global $DB;
1861     $params = array($daystart, $userid, $daystart);
1863     $courseselect = '';
1864     if ($courseid) {
1865         $courseselect = "AND course = ?";
1866         $params[] = $courseid;
1867     }
1868     $params[] = $daystart;
1870     return $DB->get_records_sql("SELECT FLOOR((time - ?)/". HOURSECS .") AS hour, COUNT(*) AS num
1871                                    FROM {log}
1872                                   WHERE userid = ?
1873                                         AND time > ? $courseselect
1874                                GROUP BY FLOOR((time - ?)/". HOURSECS .") ", $params);
1877 /**
1878  * Returns an object with counts of failed login attempts
1879  *
1880  * Returns information about failed login attempts.  If the current user is
1881  * an admin, then two numbers are returned:  the number of attempts and the
1882  * number of accounts.  For non-admins, only the attempts on the given user
1883  * are shown.
1884  *
1885  * @global object
1886  * @uses CONTEXT_SYSTEM
1887  * @param string $mode Either 'admin' or 'everybody'
1888  * @param string $username The username we are searching for
1889  * @param string $lastlogin The date from which we are searching
1890  * @return int
1891  */
1892 function count_login_failures($mode, $username, $lastlogin) {
1893     global $DB;
1895     $params = array('mode'=>$mode, 'username'=>$username, 'lastlogin'=>$lastlogin);
1896     $select = "module='login' AND action='error' AND time > :lastlogin";
1898     $count = new object();
1900     if (is_siteadmin()) {
1901         if ($count->attempts = $DB->count_records_select('log', $select, $params)) {
1902             $count->accounts = $DB->count_records_select('log', $select, $params, 'COUNT(DISTINCT info)');
1903             return $count;
1904         }
1905     } else if ($mode == 'everybody') {
1906         if ($count->attempts = $DB->count_records_select('log', "$select AND info = :username", $params)) {
1907             return $count;
1908         }
1909     }
1910     return NULL;
1914 /// GENERAL HELPFUL THINGS  ///////////////////////////////////
1916 /**
1917  * Dump a given object's information in a PRE block.
1918  *
1919  * Mostly just used for debugging.
1920  *
1921  * @param mixed $object The data to be printed
1922  * @return void OUtput is echo'd
1923  */
1924 function print_object($object) {
1925     echo '<pre class="notifytiny">';
1926     print_r($object);  // Direct to output because some objects get too big for memory otherwise!
1927     echo '</pre>';
1930 /**
1931  * This function is the official hook inside XMLDB stuff to delegate its debug to one
1932  * external function.
1933  *
1934  * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
1935  * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
1936  *
1937  * @uses DEBUG_DEVELOPER
1938  * @param string $message string contains the error message
1939  * @param object $object object XMLDB object that fired the debug
1940  */
1941 function xmldb_debug($message, $object) {
1943     debugging($message, DEBUG_DEVELOPER);
1946 /**
1947  * @global object
1948  * @uses CONTEXT_COURSECAT
1949  * @return boolean Whether the user can create courses in any category in the system.
1950  */
1951 function user_can_create_courses() {
1952     global $DB;
1953     $catsrs = $DB->get_recordset('course_categories');
1954     foreach ($catsrs as $cat) {
1955         if (has_capability('moodle/course:create', get_context_instance(CONTEXT_COURSECAT, $cat->id))) {
1956             $catsrs->close();
1957             return true;
1958         }
1959     }
1960     $catsrs->close();
1961     return false;