lib/datalib.php

   1 <?php // $Id$
   2 /**
   3  * Library of functions for database manipulation.
   4  *
   5  * Other main libraries:
   6  * - weblib.php - functions that produce web output
   7  * - moodlelib.php - general-purpose Moodle functions
   8  * @author Martin Dougiamas and many others
   9  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  10  * @package moodlecore
  11  */
  12
  13
  14 /**
  15  * Escape all dangerous characters in a data record
  16  *
  17  * $dataobject is an object containing needed data
  18  * Run over each field exectuting addslashes() function
  19  * to escape SQL unfriendly characters (e.g. quotes)
  20  * Handy when writing back data read from the database
  21  *
  22  * @param $dataobject Object containing the database record
  23  * @return object Same object with neccessary characters escaped
  24  */
  25 function addslashes_object( $dataobject ) {
  26     $a = get_object_vars( $dataobject);
  27     foreach ($a as $key=>$value) {
  28       $a[$key] = addslashes( $value );
  29     }
  30     return (object)$a;
  31 }
  32
  33 /// USER DATABASE ////////////////////////////////////////////////
  34
  35 /**
  36  * Returns $user object of the main admin user
  37  * primary admin = admin with lowest role_assignment id among admins
  38  * @uses $CFG
  39  * @return object(admin) An associative array representing the admin user.
  40  */
  41 function get_admin () {
  42
  43     global $CFG;
  44     static $myadmin;
  45
  46     if (isset($myadmin)) {
  47         return $myadmin;
  48     }
  49
  50     if ( $admins = get_admins() ) {
  51         foreach ($admins as $admin) {
  52             $myadmin = $admin;
  53             return $admin;   // ie the first one
  54         }
  55     } else {
  56         return false;
  57     }
  58 }
  59
  60 /**
  61  * Returns list of all admins
  62  *
  63  * @uses $CFG
  64  * @return object
  65  */
  66 function get_admins() {
  67
  68     global $CFG;
  69
  70     $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
  71
  72     return get_users_by_capability($context, 'moodle/site:doanything', 'u.*, ra.id as adminid', 'ra.id ASC'); // only need first one
  73
  74 }
  75
  76
  77 function get_courses_in_metacourse($metacourseid) {
  78     global $CFG;
  79
  80     $sql = "SELECT c.id,c.shortname,c.fullname FROM {$CFG->prefix}course c, {$CFG->prefix}course_meta mc WHERE mc.parent_course = $metacourseid
  81         AND mc.child_course = c.id ORDER BY c.shortname";
  82
  83     return get_records_sql($sql);
  84 }
  85
  86 function get_courses_notin_metacourse($metacourseid,$count=false) {
  87
  88     global $CFG;
  89
  90     if ($count) {
  91         $sql  = "SELECT COUNT(c.id)";
  92     } else {
  93         $sql = "SELECT c.id,c.shortname,c.fullname";
  94     }
  95
  96     $alreadycourses = get_courses_in_metacourse($metacourseid);
  97
  98     $sql .= " FROM {$CFG->prefix}course c WHERE ".((!empty($alreadycourses)) ? "c.id NOT IN (".implode(',',array_keys($alreadycourses)).")
  99     AND " : "")." c.id !=$metacourseid and c.id != ".SITEID." and c.metacourse != 1 ".((empty($count)) ? " ORDER BY c.shortname" : "");
 100
 101     return get_records_sql($sql);
 102 }
 103
 104 function count_courses_notin_metacourse($metacourseid) {
 105     global $CFG;
 106
 107     $alreadycourses = get_courses_in_metacourse($metacourseid);
 108
 109     $sql = "SELECT COUNT(c.id) AS notin FROM {$CFG->prefix}course c
 110              WHERE ".((!empty($alreadycourses)) ? "c.id NOT IN (".implode(',',array_keys($alreadycourses)).")
 111               AND " : "")." c.id !=$metacourseid and c.id != ".SITEID." and c.metacourse != 1";
 112
 113     if (!$count = get_record_sql($sql)) {
 114         return 0;
 115     }
 116
 117     return $count->notin;
 118 }
 119
 120 /**
 121  * Search through course users
 122  *
 123  * If $coursid specifies the site course then this function searches
 124  * through all undeleted and confirmed users
 125  *
 126  * @uses $CFG
 127  * @uses SITEID
 128  * @param int $courseid The course in question.
 129  * @param int $groupid The group in question.
 130  * @param string $searchtext ?
 131  * @param string $sort ?
 132  * @param string $exceptions ?
 133  * @return object
 134  */
 135 function search_users($courseid, $groupid, $searchtext, $sort='', $exceptions='') {
 136     global $CFG;
 137
 138     $LIKE      = sql_ilike();
 139     $fullname  = sql_fullname('u.firstname', 'u.lastname');
 140
 141     if (!empty($exceptions)) {
 142         $except = ' AND u.id NOT IN ('. $exceptions .') ';
 143     } else {
 144         $except = '';
 145     }
 146
 147     if (!empty($sort)) {
 148         $order = ' ORDER BY '. $sort;
 149     } else {
 150         $order = '';
 151     }
 152
 153     $select = 'u.deleted = \'0\' AND u.confirmed = \'1\'';
 154
 155     if (!$courseid or $courseid == SITEID) {
 156         return get_records_sql("SELECT u.id, u.firstname, u.lastname, u.email
 157                       FROM {$CFG->prefix}user u
 158                       WHERE $select
 159                           AND ($fullname $LIKE '%$searchtext%' OR u.email $LIKE '%$searchtext%')
 160                           $except $order");
 161     } else {
 162
 163         if ($groupid) {
 164 //TODO:check. Remove group DB dependencies.
 165             return get_records_sql("SELECT u.id, u.firstname, u.lastname, u.email
 166                           FROM {$CFG->prefix}user u,
 167                                {$CFG->prefix}groups_members gm
 168                           WHERE $select AND gm.groupid = '$groupid' AND gm.userid = u.id
 169                               AND ($fullname $LIKE '%$searchtext%' OR u.email $LIKE '%$searchtext%')
 170                               $except $order");
 171         } else {
 172             $context = get_context_instance(CONTEXT_COURSE, $courseid);
 173             $contextlists = get_related_contexts_string($context);
 174             $users = get_records_sql("SELECT u.id, u.firstname, u.lastname, u.email
 175                           FROM {$CFG->prefix}user u,
 176                                {$CFG->prefix}role_assignments ra
 177                           WHERE $select AND ra.contextid $contextlists AND ra.userid = u.id
 178                               AND ($fullname $LIKE '%$searchtext%' OR u.email $LIKE '%$searchtext%')
 179                               $except $order");
 180         }
 181         return $users;
 182     }
 183 }
 184
 185
 186 /**
 187  * Returns a list of all site users
 188  * Obsolete, just calls get_course_users(SITEID)
 189  *
 190  * @uses SITEID
 191  * @deprecated Use {@link get_course_users()} instead.
 192  * @param string $fields A comma separated list of fields to be returned from the chosen table.
 193  * @return object|false  {@link $USER} records or false if error.
 194  */
 195 function get_site_users($sort='u.lastaccess DESC', $fields='*', $exceptions='') {
 196
 197     return get_course_users(SITEID, $sort, $exceptions, $fields);
 198 }
 199
 200
 201 /**
 202  * Returns a subset of users
 203  *
 204  * @uses $CFG
 205  * @param bool $get If false then only a count of the records is returned
 206  * @param string $search A simple string to search for
 207  * @param bool $confirmed A switch to allow/disallow unconfirmed users
 208  * @param array(int) $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
 209  * @param string $sort A SQL snippet for the sorting criteria to use
 210  * @param string $firstinitial ?
 211  * @param string $lastinitial ?
 212  * @param string $page ?
 213  * @param string $recordsperpage ?
 214  * @param string $fields A comma separated list of fields to be returned from the chosen table.
 215  * @return object|false|int  {@link $USER} records unless get is false in which case the integer count of the records found is returned. False is returned if an error is encountered.
 216  */
 217 function get_users($get=true, $search='', $confirmed=false, $exceptions='', $sort='firstname ASC',
 218                    $firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*') {
 219
 220     global $CFG;
 221
 222     if ($get && !$recordsperpage) {
 223         debugging('Call to get_users with $get = true no $recordsperpage limit. ' .
 224                 'On large installations, this will probably cause an out of memory error. ' .
 225                 'Please think again and change your code so that it does not try to ' .
 226                 'load so much data into memory.', DEBUG_DEVELOPER);
 227     }
 228
 229     $LIKE      = sql_ilike();
 230     $fullname  = sql_fullname();
 231
 232     $select = 'username <> \'guest\' AND deleted = 0';
 233
 234     if (!empty($search)){
 235         $search = trim($search);
 236         $select .= " AND ($fullname $LIKE '%$search%' OR email $LIKE '%$search%') ";
 237     }
 238
 239     if ($confirmed) {
 240         $select .= ' AND confirmed = \'1\' ';
 241     }
 242
 243     if ($exceptions) {
 244         $select .= ' AND id NOT IN ('. $exceptions .') ';
 245     }
 246
 247     if ($firstinitial) {
 248         $select .= ' AND firstname '. $LIKE .' \''. $firstinitial .'%\'';
 249     }
 250     if ($lastinitial) {
 251         $select .= ' AND lastname '. $LIKE .' \''. $lastinitial .'%\'';
 252     }
 253
 254     if ($get) {
 255         return get_records_select('user', $select, $sort, $fields, $page, $recordsperpage);
 256     } else {
 257         return count_records_select('user', $select);
 258     }
 259 }
 260
 261
 262 /**
 263  * shortdesc (optional)
 264  *
 265  * longdesc
 266  *
 267  * @uses $CFG
 268  * @param string $sort ?
 269  * @param string $dir ?
 270  * @param int $categoryid ?
 271  * @param int $categoryid ?
 272  * @param string $search ?
 273  * @param string $firstinitial ?
 274  * @param string $lastinitial ?
 275  * @returnobject {@link $USER} records
 276  * @todo Finish documenting this function
 277  */
 278
 279 function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
 280                            $search='', $firstinitial='', $lastinitial='', $remotewhere='') {
 281
 282     global $CFG;
 283
 284     $LIKE      = sql_ilike();
 285     $fullname  = sql_fullname();
 286
 287     $select = "deleted <> '1'";
 288
 289     if (!empty($search)) {
 290         $search = trim($search);
 291         $select .= " AND ($fullname $LIKE '%$search%' OR email $LIKE '%$search%' OR username='$search') ";
 292     }
 293
 294     if ($firstinitial) {
 295         $select .= ' AND firstname '. $LIKE .' \''. $firstinitial .'%\' ';
 296     }
 297
 298     if ($lastinitial) {
 299         $select .= ' AND lastname '. $LIKE .' \''. $lastinitial .'%\' ';
 300     }
 301
 302     $select .= $remotewhere;
 303
 304     if ($sort) {
 305         $sort = ' ORDER BY '. $sort .' '. $dir;
 306     }
 307
 308 /// warning: will return UNCONFIRMED USERS
 309     return get_records_sql("SELECT id, username, email, firstname, lastname, city, country, lastaccess, confirmed, mnethostid
 310                               FROM {$CFG->prefix}user
 311                              WHERE $select $sort", $page, $recordsperpage);
 312
 313 }
 314
 315
 316 /**
 317  * Full list of users that have confirmed their accounts.
 318  *
 319  * @uses $CFG
 320  * @return object
 321  */
 322 function get_users_confirmed() {
 323     global $CFG;
 324     return get_records_sql("SELECT *
 325                               FROM {$CFG->prefix}user
 326                              WHERE confirmed = 1
 327                                AND deleted = 0
 328                                AND username <> 'guest'");
 329 }
 330
 331
 332 /**
 333  * Full list of users that have not yet confirmed their accounts.
 334  *
 335  * @uses $CFG
 336  * @param string $cutofftime ?
 337  * @return object  {@link $USER} records
 338  */
 339 function get_users_unconfirmed($cutofftime=2000000000) {
 340     global $CFG;
 341     return get_records_sql("SELECT *
 342                              FROM {$CFG->prefix}user
 343                             WHERE confirmed = 0
 344                               AND firstaccess > 0
 345                               AND firstaccess < $cutofftime");
 346 }
 347
 348 /**
 349  * All users that we have not seen for a really long time (ie dead accounts)
 350  *
 351  * @uses $CFG
 352  * @param string $cutofftime ?
 353  * @return object  {@link $USER} records
 354  */
 355 function get_users_longtimenosee($cutofftime) {
 356     global $CFG;
 357     return get_records_sql("SELECT userid as id, courseid
 358                               FROM {$CFG->prefix}user_lastaccess
 359                              WHERE courseid != ".SITEID."
 360                                AND timeaccess > 0
 361                                AND timeaccess < $cutofftime ");
 362 }
 363
 364 /**
 365  * Full list of bogus accounts that are probably not ever going to be used
 366  *
 367  * @uses $CFG
 368  * @param string $cutofftime ?
 369  * @return object  {@link $USER} records
 370  */
 371
 372 function get_users_not_fully_set_up($cutofftime=2000000000) {
 373     global $CFG;
 374     return get_records_sql("SELECT *
 375                              FROM {$CFG->prefix}user
 376                             WHERE confirmed = 1
 377                              AND lastaccess > 0
 378                              AND lastaccess < $cutofftime
 379                              AND deleted = 0
 380                              AND (lastname = '' OR firstname = '' OR email = '')");
 381 }
 382
 383 /// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
 384
 385
 386 /**
 387  * Returns $course object of the top-level site.
 388  *
 389  * @return course  A {@link $COURSE} object for the site
 390  */
 391 function get_site() {
 392
 393     global $SITE;
 394
 395     if (!empty($SITE->id)) {   // We already have a global to use, so return that
 396         return $SITE;
 397     }
 398
 399     if ($course = get_record('course', 'category', 0)) {
 400         return $course;
 401     } else {
 402         return false;
 403     }
 404 }
 405
 406 /**
 407  * Returns list of courses, for whole site, or category
 408  *
 409  * Returns list of courses, for whole site, or category
 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  * @param    type description
 415  *
 416  */
 417 function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
 418
 419     global $USER, $CFG;
 420
 421     if ($categoryid != "all" && is_numeric($categoryid)) {
 422         $categoryselect = "WHERE c.category = '$categoryid'";
 423     } else {
 424         $categoryselect = "";
 425     }
 426
 427     if (empty($sort)) {
 428         $sortstatement = "";
 429     } else {
 430         $sortstatement = "ORDER BY $sort";
 431     }
 432
 433     $visiblecourses = array();
 434
 435     // pull out all course matching the cat
 436     if ($courses = get_records_sql("SELECT $fields
 437                                 FROM {$CFG->prefix}course c
 438                                 $categoryselect
 439                                 $sortstatement")) {
 440
 441         // loop throught them
 442         foreach ($courses as $course) {
 443
 444             if (isset($course->visible) && $course->visible <= 0) {
 445                 // for hidden courses, require visibility check
 446                 if (has_capability('moodle/course:viewhiddencourses',
 447                         get_context_instance(CONTEXT_COURSE, $course->id))) {
 448                     $visiblecourses [] = $course;
 449                 }
 450             } else {
 451                 $visiblecourses [] = $course;
 452             }
 453         }
 454     }
 455     return $visiblecourses;
 456
 457 /*
 458     $teachertable = "";
 459     $visiblecourses = "";
 460     $sqland = "";
 461     if (!empty($categoryselect)) {
 462         $sqland = "AND ";
 463     }
 464     if (!empty($USER->id)) {  // May need to check they are a teacher
 465         if (!has_capability('moodle/course:create', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
 466             $visiblecourses = "$sqland ((c.visible > 0) OR t.userid = '$USER->id')";
 467             $teachertable = "LEFT JOIN {$CFG->prefix}user_teachers t ON t.course = c.id";
 468         }
 469     } else {
 470         $visiblecourses = "$sqland c.visible > 0";
 471     }
 472
 473     if ($categoryselect or $visiblecourses) {
 474         $selectsql = "{$CFG->prefix}course c $teachertable WHERE $categoryselect $visiblecourses";
 475     } else {
 476         $selectsql = "{$CFG->prefix}course c $teachertable";
 477     }
 478
 479     $extrafield = str_replace('ASC','',$sort);
 480     $extrafield = str_replace('DESC','',$extrafield);
 481     $extrafield = trim($extrafield);
 482     if (!empty($extrafield)) {
 483         $extrafield = ','.$extrafield;
 484     }
 485     return get_records_sql("SELECT ".((!empty($teachertable)) ? " DISTINCT " : "")." $fields $extrafield FROM $selectsql ".((!empty($sort)) ? "ORDER BY $sort" : ""));
 486     */
 487 }
 488
 489
 490 /**
 491  * Returns list of courses, for whole site, or category
 492  *
 493  * Similar to get_courses, but allows paging
 494  * Important: Using c.* for fields is extremely expensive because
 495  *            we are using distinct. You almost _NEVER_ need all the fields
 496  *            in such a large SELECT
 497  *
 498  * @param    type description
 499  *
 500  */
 501 function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
 502                           &$totalcount, $limitfrom="", $limitnum="") {
 503
 504     global $USER, $CFG;
 505
 506     $categoryselect = "";
 507     if ($categoryid != "all" && is_numeric($categoryid)) {
 508         $categoryselect = "WHERE c.category = '$categoryid'";
 509     } else {
 510         $categoryselect = "";
 511     }
 512
 513     // pull out all course matching the cat
 514     $visiblecourses = array();
 515     if (!($rs = get_recordset_sql("SELECT $fields,
 516                                           ctx.id AS ctxid, ctx.path AS ctxpath,
 517                                           ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
 518                                    FROM {$CFG->prefix}course c
 519                                    JOIN {$CFG->prefix}context ctx
 520                                      ON (c.id = ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
 521                                    $categoryselect
 522                                    ORDER BY $sort"))) {
 523         return $visiblecourses;
 524     }
 525     $totalcount = 0;
 526
 527     if (!$limitnum) {
 528         $limitnum = $rs->RecordCount();
 529     }
 530
 531     if (!$limitfrom) {
 532         $limitfrom = 0;
 533     }
 534
 535     // iteration will have to be done inside loop to keep track of the limitfrom and limitnum
 536     if ($rs->RecordCount()) {
 537         while ($course = rs_fetch_next_record($rs)) {
 538             $course = make_context_subobj($course);
 539             if ($course->visible <= 0) {
 540                 // for hidden courses, require visibility check
 541                 if (has_capability('moodle/course:viewhiddencourses', $course->context)) {
 542                     $totalcount++;
 543                     if ($totalcount > $limitfrom && count($visiblecourses) < $limitnum) {
 544                         $visiblecourses [] = $course;
 545                     }
 546                 }
 547             } else {
 548                 $totalcount++;
 549                 if ($totalcount > $limitfrom && count($visiblecourses) < $limitnum) {
 550                     $visiblecourses [] = $course;
 551                 }
 552             }
 553         }
 554     }
 555     return $visiblecourses;
 556
 557 /**
 558
 559     $categoryselect = "";
 560     if ($categoryid != "all" && is_numeric($categoryid)) {
 561         $categoryselect = "c.category = '$categoryid'";
 562     }
 563
 564     $teachertable = "";
 565     $visiblecourses = "";
 566     $sqland = "";
 567     if (!empty($categoryselect)) {
 568         $sqland = "AND ";
 569     }
 570     if (!empty($USER) and !empty($USER->id)) {  // May need to check they are a teacher
 571         if (!has_capability('moodle/course:create', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
 572             $visiblecourses = "$sqland ((c.visible > 0) OR t.userid = '$USER->id')";
 573             $teachertable = "LEFT JOIN {$CFG->prefix}user_teachers t ON t.course=c.id";
 574         }
 575     } else {
 576         $visiblecourses = "$sqland c.visible > 0";
 577     }
 578
 579     if ($limitfrom !== "") {
 580         $limit = sql_paging_limit($limitfrom, $limitnum);
 581     } else {
 582         $limit = "";
 583     }
 584
 585     $selectsql = "{$CFG->prefix}course c $teachertable WHERE $categoryselect $visiblecourses";
 586
 587     $totalcount = count_records_sql("SELECT COUNT(DISTINCT c.id) FROM $selectsql");
 588
 589     return get_records_sql("SELECT $fields FROM $selectsql ".((!empty($sort)) ? "ORDER BY $sort" : "")." $limit");
 590     */
 591 }
 592
 593 /*
 594  * Retrieve course records with the course managers and other related records
 595  * that we need for print_course(). This allows print_courses() to do its job
 596  * in a constant number of DB queries, regardless of the number of courses,
 597  * role assignments, etc.
 598  *
 599  * The returned array is indexed on c.id, and each course will have
 600  * - $course->context - a context obj
 601  * - $course->managers - array containing RA objects that include a $user obj
 602  *                       with the minimal fields needed for fullname()
 603  *
 604  */
 605 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
 606     /*
 607      * The plan is to
 608      *
 609      * - Grab the courses JOINed w/context
 610      *
 611      * - Grab the interesting course-manager RAs
 612      *   JOINed with a base user obj and add them to each course
 613      *
 614      * So as to do all the work in 2 DB queries. The RA+user JOIN
 615      * ends up being pretty expensive if it happens over _all_
 616      * courses on a large site. (Are we surprised!?)
 617      *
 618      * So this should _never_ get called with 'all' on a large site.
 619      *
 620      */
 621     global $USER, $CFG;
 622
 623     $allcats = false; // bool flag
 624     if ($categoryid === 'all') {
 625         $categoryclause   = '';
 626         $allcats = true;
 627     } elseif (is_numeric($categoryid)) {
 628         $categoryclause = "c.category = $categoryid";
 629     } else {
 630         debugging("Could not recognise categoryid = $categoryid");
 631         $categoryclause = '';
 632     }
 633
 634     $basefields = array('id', 'category', 'sortorder',
 635                         'shortname', 'fullname', 'idnumber',
 636                         'teacher', 'teachers', 'student', 'students',
 637                         'guest', 'startdate', 'visible',
 638                         'newsitems',  'cost', 'enrol',
 639                         'groupmode', 'groupmodeforce');
 640
 641     if (!is_null($fields) && is_string($fields)) {
 642         if (empty($fields)) {
 643             $fields = $basefields;
 644         } else {
 645             // turn the fields from a string to an array that
 646             // get_user_courses_bycap() will like...
 647             $fields = explode(',',$fields);
 648             $fields = array_map('trim', $fields);
 649             $fields = array_unique(array_merge($basefields, $fields));
 650         }
 651     } elseif (is_array($fields)) {
 652         $fields = array_merge($basefields,$fields);
 653     }
 654     $coursefields = 'c.' .join(',c.', $fields);
 655
 656     if (empty($sort)) {
 657         $sortstatement = "";
 658     } else {
 659         $sortstatement = "ORDER BY $sort";
 660     }
 661
 662     $where = 'WHERE c.id != ' . SITEID;
 663     if ($categoryclause !== ''){
 664         $where = "$where AND $categoryclause";
 665     }
 666
 667     // pull out all courses matching the cat
 668     $sql = "SELECT $coursefields,
 669                    ctx.id AS ctxid, ctx.path AS ctxpath,
 670                    ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
 671             FROM {$CFG->prefix}course c
 672             JOIN {$CFG->prefix}context ctx
 673                  ON (c.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
 674                  $where
 675                  $sortstatement";
 676
 677     $catpaths = array();
 678     $catpath  = NULL;
 679     if ($courses = get_records_sql($sql)) {
 680         // loop on courses materialising
 681         // the context, and prepping data to fetch the
 682         // managers efficiently later...
 683         foreach ($courses as $k => $course) {
 684             $courses[$k] = make_context_subobj($courses[$k]);
 685             $courses[$k]->managers = array();
 686             if ($allcats === false) {
 687                 // single cat, so take just the first one...
 688                 if ($catpath === NULL) {
 689                     $catpath = preg_replace(':/\d+$:', '',$courses[$k]->context->path);
 690                 }
 691             } else {
 692                 // chop off the contextid of the course itself
 693                 // like dirname() does...
 694                 $catpaths[] = preg_replace(':/\d+$:', '',$courses[$k]->context->path);
 695             }
 696         }
 697     } else {
 698         return array(); // no courses!
 699     }
 700
 701     $CFG->coursemanager = trim($CFG->coursemanager);
 702     if (empty($CFG->coursemanager)) {
 703         return $courses;
 704     }
 705
 706     $managerroles = split(',', $CFG->coursemanager);
 707     $catctxids = '';
 708     if (count($managerroles)) {
 709         if ($allcats === true) {
 710             $catpaths  = array_unique($catpaths);
 711             $ctxids = array();
 712             foreach ($catpaths as $cpath) {
 713                 $ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
 714             }
 715             $ctxids = array_unique($ctxids);
 716             $catctxids = implode( ',' , $ctxids);
 717             unset($catpaths);unset($cpath);
 718         } else {
 719             // take the ctx path from the first course
 720             // as all categories will be the same...
 721             $catpath = substr($catpath,1);
 722             $catpath = preg_replace(':/\d+$:','',$catpath);
 723             $catctxids = str_replace('/',',',$catpath);
 724         }
 725         if ($categoryclause !== '') {
 726             $categoryclause = "AND $categoryclause";
 727         }
 728         /*
 729          * Note: Here we use a LEFT OUTER JOIN that can
 730          * "optionally" match to avoid passing a ton of context
 731          * ids in an IN() clause. Perhaps a subselect is faster.
 732          *
 733          * In any case, this SQL is not-so-nice over large sets of
 734          * courses with no $categoryclause.
 735          *
 736          */
 737         $sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
 738                        ra.hidden,
 739                        r.id AS roleid, r.name as rolename,
 740                        u.id AS userid, u.firstname, u.lastname
 741                 FROM {$CFG->prefix}role_assignments ra
 742                 JOIN {$CFG->prefix}context ctx
 743                   ON ra.contextid = ctx.id
 744                 JOIN {$CFG->prefix}user u
 745                   ON ra.userid = u.id
 746                 JOIN {$CFG->prefix}role r
 747                   ON ra.roleid = r.id
 748                 LEFT OUTER JOIN {$CFG->prefix}course c
 749                   ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
 750                 WHERE (  c.id IS NOT NULL
 751                          OR ra.contextid  IN ($catctxids) )
 752                       AND ra.roleid IN ({$CFG->coursemanager})
 753                       $categoryclause
 754                 ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
 755
 756         $rs = get_recordset_sql($sql);
 757
 758         // This loop is fairly stupid as it stands - might get better
 759         // results doing an initial pass clustering RAs by path.
 760         if ($rs->RecordCount()) {
 761             while ($ra = rs_fetch_next_record($rs)) {
 762                 $user = new StdClass;
 763                 $user->id        = $ra->userid;    unset($ra->userid);
 764                 $user->firstname = $ra->firstname; unset($ra->firstname);
 765                 $user->lastname  = $ra->lastname;  unset($ra->lastname);
 766                 $ra->user = $user;
 767                 if ($ra->contextlevel == CONTEXT_SYSTEM) {
 768                     foreach ($courses as $k => $course) {
 769                         $courses[$k]->managers[] = $ra;
 770                     }
 771                 } elseif ($ra->contextlevel == CONTEXT_COURSECAT) {
 772                     if ($allcats === false) {
 773                         // It always applies
 774                         foreach ($courses as $k => $course) {
 775                             $courses[$k]->managers[] = $ra;
 776                         }
 777                     } else {
 778                         foreach ($courses as $k => $course) {
 779                             // Note that strpos() returns 0 as "matched at pos 0"
 780                             if (strpos($course->context->path, $ra->path.'/')===0) {
 781                                 // Only add it to subpaths
 782                                 $courses[$k]->managers[] = $ra;
 783                             }
 784                         }
 785                     }
 786                 } else { // course-level
 787                     $courses[$ra->instanceid]->managers[] = $ra;
 788                 }
 789             }
 790         }
 791
 792
 793
 794     }
 795
 796     return $courses;
 797 }
 798
 799 /**
 800  * Convenience function - lists courses that a user has access to view.
 801  *
 802  * For admins and others with access to "every" course in the system, we should
 803  * try to get courses with explicit RAs.
 804  *
 805  * NOTE: this function is heavily geared towards the perspective of the user
 806  *       passed in $userid. So it will hide courses that the user cannot see
 807  *       (for any reason) even if called from cron or from another $USER's
 808  *       perspective.
 809  *
 810  *       If you really want to know what courses are assigned to the user,
 811  *       without any hiding or scheming, call the lower-level
 812  *       get_user_courses_bycap().
 813  *
 814  *
 815  * Notes inherited from get_user_courses_bycap():
 816  *
 817  * - $fields is an array of fieldnames to ADD
 818  *   so name the fields you really need, which will
 819  *   be added and uniq'd
 820  *
 821  * - the course records have $c->context which is a fully
 822  *   valid context object. Saves you a query per course!
 823  *
 824  * @uses $CFG,$USER
 825  * @param int $userid The user of interest
 826  * @param string $sort the sortorder in the course table
 827  * @param array $fields - names of _additional_ fields to return (also accepts a string)
 828  * @param bool $doanything True if using the doanything flag
 829  * @param int $limit Maximum number of records to return, or 0 for unlimited
 830  * @return array {@link $COURSE} of course objects
 831  */
 832 function get_my_courses($userid, $sort='visible DESC,sortorder ASC', $fields=NULL, $doanything=false,$limit=0) {
 833
 834     global $CFG,$USER;
 835
 836     // Guest's do not have any courses
 837     $sitecontext = get_context_instance(CONTEXT_SYSTEM, SITEID);
 838     if (has_capability('moodle/legacy:guest',$sitecontext,$userid,false)) {
 839         return(array());
 840     }
 841
 842     $basefields = array('id', 'category', 'sortorder',
 843                         'shortname', 'fullname', 'idnumber',
 844                         'teacher', 'teachers', 'student', 'students',
 845                         'guest', 'startdate', 'visible',
 846                         'newsitems',  'cost', 'enrol',
 847                         'groupmode', 'groupmodeforce');
 848
 849     if (!is_null($fields) && is_string($fields)) {
 850         if (empty($fields)) {
 851             $fields = $basefields;
 852         } else {
 853             // turn the fields from a string to an array that
 854             // get_user_courses_bycap() will like...
 855             $fields = explode(',',$fields);
 856             $fields = array_map('trim', $fields);
 857             $fields = array_unique(array_merge($basefields, $fields));
 858         }
 859     } elseif (is_array($fields)) {
 860         $fields = array_unique(array_merge($basefields, $fields));
 861     } else {
 862         $fields = $basefields;
 863     }
 864
 865     $orderby = '';
 866     $sort    = trim($sort);
 867     if (!empty($sort)) {
 868         $orderby = "ORDER BY $sort";
 869     }
 870
 871     //
 872     // Logged-in user - Check cached courses
 873     //
 874     // NOTE! it's a _string_ because
 875     // - it's all we'll ever use
 876     // - it serialises much more compact than an array
 877     //   this a big concern here - cost of serialise
 878     //   and unserialise gets huge as the session grows
 879     //
 880     // If the courses are too many - it won't be set
 881     // for large numbers of courses, caching in the session
 882     // has marginal benefits (costs too much, not
 883     // worthwhile...) and we may hit SQL parser limits
 884     // because we use IN()
 885     //
 886     if ($userid === $USER->id) {
 887         if (isset($USER->loginascontext)
 888             && $USER->loginascontext->contextlevel == CONTEXT_COURSE) {
 889             // list _only_ this course
 890             // anything else is asking for trouble...
 891             $courseids = $USER->loginascontext->instanceid;
 892         } elseif (isset($USER->mycourses)
 893                   && is_string($USER->mycourses)) {
 894             if ($USER->mycourses === '') {
 895                 // empty str means: user has no courses
 896                 // ... so do the easy thing...
 897                 return array();
 898             } else {
 899                 $courseids = $USER->mycourses;
 900             }
 901         }
 902         if (isset($courseids)) {
 903             // The data massaging here MUST be kept in sync with
 904             // get_user_courses_bycap() so we return
 905             // the same...
 906             // (but here we don't need to check has_cap)
 907             $coursefields = 'c.' .join(',c.', $fields);
 908             $sql = "SELECT $coursefields,
 909                            ctx.id AS ctxid, ctx.path AS ctxpath,
 910                            ctx.depth as ctxdepth, ctx.contextlevel AS ctxlevel,
 911                            cc.path AS categorypath
 912                     FROM {$CFG->prefix}course c
 913                     JOIN {$CFG->prefix}course_categories cc
 914                       ON c.category=cc.id
 915                     JOIN {$CFG->prefix}context ctx
 916                       ON (c.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
 917                     WHERE c.id IN ($courseids)
 918                     $orderby";
 919             $rs = get_recordset_sql($sql);
 920             $courses = array();
 921             $cc = 0; // keep count
 922             if ($rs->RecordCount()) {
 923                 while ($c = rs_fetch_next_record($rs)) {
 924                     // build the context obj
 925                     $c = make_context_subobj($c);
 926
 927                     $courses[$c->id] = $c;
 928                     if ($limit > 0 && $cc++ > $limit) {
 929                         break;
 930                     }
 931                 }
 932             }
 933             rs_close($rs);
 934             return $courses;
 935         }
 936     }
 937
 938     // Non-cached - get accessinfo
 939     if ($userid === $USER->id && isset($USER->access)) {
 940         $accessinfo = $USER->access;
 941     } else {
 942         $accessinfo = get_user_access_sitewide($userid);
 943     }
 944
 945
 946     $courses = get_user_courses_bycap($userid, 'moodle/course:view', $accessinfo,
 947                                       $doanything, $sort, $fields,
 948                                       $limit);
 949
 950     $cats = NULL;
 951     // If we have to walk category visibility
 952     // to eval course visibility, get the categories
 953     if (empty($CFG->allowvisiblecoursesinhiddencategories)) {
 954         $sql = "SELECT cc.id, cc.path, cc.visible,
 955                        ctx.id AS ctxid, ctx.path AS ctxpath,
 956                        ctx.depth as ctxdepth, ctx.contextlevel AS ctxlevel
 957                 FROM {$CFG->prefix}course_categories cc
 958             JOIN {$CFG->prefix}context ctx
 959               ON (cc.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT.")
 960                 ORDER BY id";
 961         $rs = get_recordset_sql($sql);
 962
 963         // Using a temporary array instead of $cats here, to avoid a "true" result when isnull($cats) further down
 964         $categories = array();
 965         if ($rs->RecordCount()) {
 966             while ($course_cat = rs_fetch_next_record($rs)) {
 967                 // build the context obj
 968                 $course_cat = make_context_subobj($course_cat);
 969                 $categories[$course_cat->id] = $course_cat;
 970             }
 971         }
 972
 973         if (!empty($categories)) {
 974             $cats = $categories;
 975         }
 976
 977         unset($course_cat);
 978         rs_close($rs);
 979     }
 980     //
 981     // Strangely, get_my_courses() is expected to return the
 982     // array keyed on id, which messes up the sorting
 983     // So do that, and also cache the ids in the session if appropriate
 984     //
 985     $kcourses = array();
 986     $courses_count = count($courses);
 987     $cacheids = NULL;
 988     $vcatpaths = array();
 989     if ($userid === $USER->id && $courses_count < 500) {
 990         $cacheids = array();
 991     }
 992     for ($n=0; $n<$courses_count; $n++) {
 993
 994         //
 995         // Check whether $USER (not $userid) can _actually_ see them
 996         // Easy if $CFG->allowvisiblecoursesinhiddencategories
 997         // is set, and we don't have to care about categories.
 998         // Lots of work otherwise... (all in mem though!)
 999         //
1000         $cansee = false;
1001         if (is_null($cats)) { // easy rules!
1002             if ($courses[$n]->visible == true) {
1003                 $cansee = true;
1004             } elseif (has_capability('moodle/course:viewhiddencourses',
1005                                      $courses[$n]->context, $USER->id)) {
1006                 $cansee = true;
1007             }
1008         } else {
1009             //
1010             // Is the cat visible?
1011             // we have to assume it _is_ visible
1012             // so we can shortcut when we find a hidden one
1013             //
1014             $viscat = true;
1015             $cpath = $courses[$n]->categorypath;
1016             if (isset($vcatpaths[$cpath])) {
1017                 $viscat = $vcatpaths[$cpath];
1018             } else {
1019                 $cpath = substr($cpath,1); // kill leading slash
1020                 $cpath = explode('/',$cpath);
1021                 $ccct  = count($cpath);
1022                 for ($m=0;$m<$ccct;$m++) {
1023                     $ccid = $cpath[$m];
1024                     if ($cats[$ccid]->visible==false) {
1025                         $viscat = false;
1026                         break;
1027                     }
1028                 }
1029                 $vcatpaths[$courses[$n]->categorypath] = $viscat;
1030             }
1031
1032             //
1033             // Perhaps it's actually visible to $USER
1034             // check moodle/category:visibility
1035             //
1036             // The name isn't obvious, but the description says
1037             // "See hidden categories" so the user shall see...
1038             // But also check if the allowvisiblecoursesinhiddencategories setting is true, and check for course visibility
1039             if ($viscat === false) {
1040                 $catctx = $cats[$courses[$n]->category]->context;
1041                 if (has_capability('moodle/category:visibility', $catctx, $USER->id)) {
1042                     $vcatpaths[$courses[$n]->categorypath] = true;
1043                     $viscat = true;
1044                 } elseif ($CFG->allowvisiblecoursesinhiddencategories && $courses[$n]->visible == true) {
1045                     $viscat = true;
1046                 }
1047             }
1048
1049             //
1050             // Decision matrix
1051             //
1052             if ($viscat === true) {
1053                 if ($courses[$n]->visible == true) {
1054                     $cansee = true;
1055                 } elseif (has_capability('moodle/course:viewhiddencourses',
1056                                         $courses[$n]->context, $USER->id)) {
1057                     $cansee = true;
1058                 }
1059             }
1060         }
1061         if ($cansee === true) {
1062             $kcourses[$courses[$n]->id] = $courses[$n];
1063             if (is_array($cacheids)) {
1064                 $cacheids[] = $courses[$n]->id;
1065             }
1066         }
1067     }
1068     if (is_array($cacheids)) {
1069         // Only happens
1070         // - for the logged in user
1071         // - below the threshold (500)
1072         // empty string is _valid_
1073         $USER->mycourses = join(',',$cacheids);
1074     } elseif ($userid === $USER->id && isset($USER->mycourses)) {
1075         // cheap sanity check
1076         unset($USER->mycourses);
1077     }
1078
1079     return $kcourses;
1080 }
1081
1082 /**
1083  * A list of courses that match a search
1084  *
1085  * @uses $CFG
1086  * @param array $searchterms ?
1087  * @param string $sort ?
1088  * @param int $page ?
1089  * @param int $recordsperpage ?
1090  * @param int $totalcount Passed in by reference. ?
1091  * @return object {@link $COURSE} records
1092  */
1093 function get_courses_search($searchterms, $sort='fullname ASC', $page=0, $recordsperpage=50, &$totalcount) {
1094
1095     global $CFG;
1096
1097     //to allow case-insensitive search for postgesql
1098     if ($CFG->dbfamily == 'postgres') {
1099         $LIKE = 'ILIKE';
1100         $NOTLIKE = 'NOT ILIKE';   // case-insensitive
1101         $REGEXP = '~*';
1102         $NOTREGEXP = '!~*';
1103     } else {
1104         $LIKE = 'LIKE';
1105         $NOTLIKE = 'NOT LIKE';
1106         $REGEXP = 'REGEXP';
1107         $NOTREGEXP = 'NOT REGEXP';
1108     }
1109
1110     $fullnamesearch = '';
1111     $summarysearch = '';
1112
1113     foreach ($searchterms as $searchterm) {
1114
1115     /// Under Oracle and MSSQL, trim the + and - operators and perform
1116     /// simpler LIKE search
1117         if ($CFG->dbfamily == 'oracle' || $CFG->dbfamily == 'mssql') {
1118             $searchterm = trim($searchterm, '+-');
1119         }
1120
1121         if ($fullnamesearch) {
1122             $fullnamesearch .= ' AND ';
1123         }
1124         if ($summarysearch) {
1125             $summarysearch .= ' AND ';
1126         }
1127
1128         if (substr($searchterm,0,1) == '+') {
1129             $searchterm      = substr($searchterm,1);
1130             $summarysearch  .= " c.summary $REGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
1131             $fullnamesearch .= " c.fullname $REGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
1132         } else if (substr($searchterm,0,1) == "-") {
1133             $searchterm      = substr($searchterm,1);
1134             $summarysearch  .= " c.summary $NOTREGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
1135             $fullnamesearch .= " c.fullname $NOTREGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
1136         } else {
1137             $summarysearch  .= ' c.summary '. $LIKE .' \'%'. $searchterm .'%\' ';
1138             $fullnamesearch .= ' c.fullname '. $LIKE .' \'%'. $searchterm .'%\' ';
1139         }
1140
1141     }
1142
1143     $sql = "SELECT c.*,
1144                    ctx.id AS ctxid, ctx.path AS ctxpath,
1145                    ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
1146             FROM {$CFG->prefix}course c
1147             JOIN {$CFG->prefix}context ctx
1148              ON (c.id = ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
1149             WHERE ( $fullnamesearch OR  $summarysearch )
1150                   AND category > 0
1151             ORDER BY " . $sort;
1152
1153     $courses = array();
1154
1155     if ($rs = get_recordset_sql($sql)) {
1156
1157
1158         // Tiki pagination
1159         $limitfrom = $page * $recordsperpage;
1160         $limitto   = $limitfrom + $recordsperpage;
1161         $c = 0; // counts how many visible courses we've seen
1162
1163         while ($course = rs_fetch_next_record($rs)) {
1164             $course = make_context_subobj($course);
1165             if ($course->visible || has_capability('moodle/course:viewhiddencourses', $course->context)) {
1166                 // Don't exit this loop till the end
1167                 // we need to count all the visible courses
1168                 // to update $totalcount
1169                 if ($c >= $limitfrom && $c < $limitto) {
1170                     $courses[] = $course;
1171                 }
1172                 $c++;
1173             }
1174         }
1175     }
1176
1177     // our caller expects 2 bits of data - our return
1178     // array, and an updated $totalcount
1179     $totalcount = $c;
1180     return $courses;
1181 }
1182
1183
1184 /**
1185  * Returns a sorted list of categories. Each category object has a context
1186  * property that is a context object.
1187  *
1188  * When asking for $parent='none' it will return all the categories, regardless
1189  * of depth. Wheen asking for a specific parent, the default is to return
1190  * a "shallow" resultset. Pass false to $shallow and it will return all
1191  * the child categories as well.
1192  *
1193  *
1194  * @param string $parent The parent category if any
1195  * @param string $sort the sortorder
1196  * @param bool   $shallow - set to false to get the children too
1197  * @return array of categories
1198  */
1199 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1200     global $CFG;
1201
1202     if ($sort === NULL) {
1203         $sort = 'ORDER BY cc.sortorder ASC';
1204     } elseif ($sort ==='') {
1205         // leave it as empty
1206     } else {
1207         $sort = "ORDER BY $sort";
1208     }
1209
1210     if ($parent === 'none') {
1211         $sql = "SELECT cc.*,
1212                       ctx.id AS ctxid, ctx.path AS ctxpath,
1213                       ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
1214                 FROM {$CFG->prefix}course_categories cc
1215                 JOIN {$CFG->prefix}context ctx
1216                   ON cc.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT."
1217                 $sort";
1218     } elseif ($shallow) {
1219         $parent = (int)$parent;
1220         $sql = "SELECT cc.*,
1221                        ctx.id AS ctxid, ctx.path AS ctxpath,
1222                        ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
1223                 FROM {$CFG->prefix}course_categories cc
1224                 JOIN {$CFG->prefix}context ctx
1225                   ON cc.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT."
1226                 WHERE cc.parent=$parent
1227                 $sort";
1228     } else {
1229         $parent = (int)$parent;
1230         $sql = "SELECT cc.*,
1231                        ctx.id AS ctxid, ctx.path AS ctxpath,
1232                        ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
1233                 FROM {$CFG->prefix}course_categories cc
1234                 JOIN {$CFG->prefix}context ctx
1235                   ON cc.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT."
1236                 JOIN {$CFG->prefix}course_categories ccp
1237                      ON (cc.path LIKE ".sql_concat('ccp.path',"'%'").")
1238                 WHERE ccp.id=$parent
1239                 $sort";
1240     }
1241     $categories = array();
1242
1243     if( $rs = get_recordset_sql($sql) ){
1244         while ($cat = rs_fetch_next_record($rs)) {
1245             $cat = make_context_subobj($cat);
1246             if ($cat->visible || has_capability('moodle/course:create',$cat->context)) {
1247                 $categories[$cat->id] = $cat;
1248             }
1249         }
1250     }
1251     return $categories;
1252 }
1253
1254
1255 /**
1256  * Returns an array of category ids of all the subcategories for a given
1257  * category.
1258  * @param $catid - The id of the category whose subcategories we want to find.
1259  * @return array of category ids.
1260  */
1261 function get_all_subcategories($catid) {
1262
1263     $subcats = array();
1264
1265     if ($categories = get_records('course_categories', 'parent', $catid)) {
1266         foreach ($categories as $cat) {
1267             array_push($subcats, $cat->id);
1268             $subcats = array_merge($subcats, get_all_subcategories($cat->id));
1269         }
1270     }
1271     return $subcats;
1272 }
1273
1274
1275 /**
1276 * This recursive function makes sure that the courseorder is consecutive
1277 *
1278 * @param    type description
1279 *
1280 * $n is the starting point, offered only for compatilibity -- will be ignored!
1281 * $safe (bool) prevents it from assuming category-sortorder is unique, used to upgrade
1282 *       safely from 1.4 to 1.5
1283 */
1284 function fix_course_sortorder($categoryid=0, $n=0, $safe=0, $depth=0, $path='') {
1285
1286     global $CFG;
1287
1288     $count = 0;
1289
1290     $catgap    = 1000; // "standard" category gap
1291     $tolerance = 200;  // how "close" categories can get
1292
1293     if ($categoryid > 0){
1294         // update depth and path
1295         $cat   = get_record('course_categories', 'id', $categoryid);
1296         if ($cat->parent == 0) {
1297             $depth = 0;
1298             $path  = '';
1299         } else if ($depth == 0 ) { // doesn't make sense; get from DB
1300             // this is only called if the $depth parameter looks dodgy
1301             $parent = get_record('course_categories', 'id', $cat->parent);
1302             $path  = $parent->path;
1303             $depth = $parent->depth;
1304         }
1305         $path  = $path . '/' . $categoryid;
1306         $depth = $depth + 1;
1307
1308         if ($cat->path !== $path) {
1309             set_field('course_categories', 'path',  addslashes($path),  'id', $categoryid);
1310         }
1311         if ($cat->depth != $depth) {
1312             set_field('course_categories', 'depth', $depth, 'id', $categoryid);
1313         }
1314     }
1315
1316     // get some basic info about courses in the category
1317     $info = get_record_sql('SELECT MIN(sortorder) AS min,
1318                                    MAX(sortorder) AS max,
1319                                    COUNT(sortorder)  AS count
1320                             FROM ' . $CFG->prefix . 'course
1321                             WHERE category=' . $categoryid);
1322     if (is_object($info)) { // no courses?
1323         $max   = $info->max;
1324         $count = $info->count;
1325         $min   = $info->min;
1326         unset($info);
1327     }
1328
1329     if ($categoryid > 0 && $n==0) { // only passed category so don't shift it
1330         $n = $min;
1331     }
1332
1333     // $hasgap flag indicates whether there's a gap in the sequence
1334     $hasgap    = false;
1335     if ($max-$min+1 != $count) {
1336         $hasgap = true;
1337     }
1338
1339     // $mustshift indicates whether the sequence must be shifted to
1340     // meet its range
1341     $mustshift = false;
1342     if ($min < $n+$tolerance || $min > $n+$tolerance+$catgap ) {
1343         $mustshift = true;
1344     }
1345
1346     // actually sort only if there are courses,
1347     // and we meet one ofthe triggers:
1348     //  - safe flag
1349     //  - they are not in a continuos block
1350     //  - they are too close to the 'bottom'
1351     if ($count && ( $safe || $hasgap || $mustshift ) ) {
1352         // special, optimized case where all we need is to shift
1353         if ( $mustshift && !$safe && !$hasgap) {
1354             $shift = $n + $catgap - $min;
1355             if ($shift < $count) {
1356                 $shift = $count + $catgap;
1357             }
1358             // UPDATE course SET sortorder=sortorder+$shift
1359             execute_sql("UPDATE {$CFG->prefix}course
1360                          SET sortorder=sortorder+$shift
1361                          WHERE category=$categoryid", 0);
1362             $n = $n + $catgap + $count;
1363
1364         } else { // do it slowly
1365             $n = $n + $catgap;
1366             // if the new sequence overlaps the current sequence, lack of transactions
1367             // will stop us -- shift things aside for a moment...
1368             if ($safe || ($n >= $min && $n+$count+1 < $min && $CFG->dbfamily==='mysql')) {
1369                 $shift = $max + $n + 1000;
1370                 execute_sql("UPDATE {$CFG->prefix}course
1371                          SET sortorder=sortorder+$shift
1372                          WHERE category=$categoryid", 0);
1373             }
1374
1375             $courses = get_courses($categoryid, 'c.sortorder ASC', 'c.id,c.sortorder');
1376             begin_sql();
1377             $tx = true; // transaction sanity
1378             foreach ($courses as $course) {
1379                 if ($tx && $course->sortorder != $n ) { // save db traffic
1380                     $tx = $tx && set_field('course', 'sortorder', $n,
1381                                            'id', $course->id);
1382                 }
1383                 $n++;
1384             }
1385             if ($tx) {
1386                 commit_sql();
1387             } else {
1388                 rollback_sql();
1389                 if (!$safe) {
1390                     // if we failed when called with !safe, try
1391                     // to recover calling self with safe=true
1392                     return fix_course_sortorder($categoryid, $n, true, $depth, $path);
1393                 }
1394             }
1395         }
1396     }
1397     set_field('course_categories', 'coursecount', $count, 'id', $categoryid);
1398
1399     // $n could need updating
1400     $max = get_field_sql("SELECT MAX(sortorder) from {$CFG->prefix}course WHERE category=$categoryid");
1401     if ($max > $n) {
1402         $n = $max;
1403     }
1404
1405     if ($categories = get_categories($categoryid)) {
1406         foreach ($categories as $category) {
1407             $n = fix_course_sortorder($category->id, $n, $safe, $depth, $path);
1408         }
1409     }
1410
1411     return $n+1;
1412 }
1413
1414 /**
1415  * Ensure all courses have a valid course category
1416  * useful if a category has been removed manually
1417  **/
1418 function fix_coursecategory_orphans() {
1419
1420     global $CFG;
1421
1422     // Note: the handling of sortorder here is arguably
1423     // open to race conditions. Hard to fix here, unlikely
1424     // to hit anyone in production.
1425
1426     $sql = "SELECT c.id, c.category, c.shortname
1427             FROM {$CFG->prefix}course c
1428             LEFT OUTER JOIN {$CFG->prefix}course_categories cc ON c.category=cc.id
1429             WHERE cc.id IS NULL AND c.id != " . SITEID;
1430
1431     $rs = get_recordset_sql($sql);
1432
1433     if ($rs->RecordCount()){ // we have some orphans
1434
1435         // the "default" category is the lowest numbered...
1436         $default   = get_field_sql("SELECT MIN(id)
1437                                     FROM {$CFG->prefix}course_categories");
1438         $sortorder = get_field_sql("SELECT MAX(sortorder)
1439                                     FROM {$CFG->prefix}course
1440                                     WHERE category=$default");
1441
1442
1443         begin_sql();
1444         $tx = true;
1445         while ($tx && $course = rs_fetch_next_record($rs)) {
1446             $tx = $tx && set_field('course', 'category',  $default,     'id', $course->id);
1447             $tx = $tx && set_field('course', 'sortorder', ++$sortorder, 'id', $course->id);
1448         }
1449         if ($tx) {
1450             commit_sql();
1451         } else {
1452             rollback_sql();
1453         }
1454     }
1455 }
1456
1457 /**
1458  * List of remote courses that a user has access to via MNET.
1459  * Works only on the IDP
1460  *
1461  * @uses $CFG, $USER
1462  * @return array {@link $COURSE} of course objects
1463  */
1464 function get_my_remotecourses($userid=0) {
1465     global $CFG, $USER;
1466
1467     if (empty($userid)) {
1468         $userid = $USER->id;
1469     }
1470
1471     $sql = "SELECT c.remoteid, c.shortname, c.fullname,
1472                    c.hostid, c.summary, c.cat_name,
1473                    h.name AS hostname
1474             FROM   {$CFG->prefix}mnet_enrol_course c
1475             JOIN   {$CFG->prefix}mnet_enrol_assignments a ON c.id=a.courseid
1476             JOIN   {$CFG->prefix}mnet_host h        ON c.hostid=h.id
1477             WHERE  a.userid={$userid}";
1478
1479     return get_records_sql($sql);
1480 }
1481
1482 /**
1483  * List of remote hosts that a user has access to via MNET.
1484  * Works on the SP
1485  *
1486  * @uses $CFG, $USER
1487  * @return array of host objects
1488  */
1489 function get_my_remotehosts() {
1490     global $CFG, $USER;
1491
1492     if ($USER->mnethostid == $CFG->mnet_localhost_id) {
1493         return false; // Return nothing on the IDP
1494     }
1495     if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
1496         return $USER->mnet_foreign_host_array;
1497     }
1498     return false;
1499 }
1500
1501 /**
1502  * This function creates a default separated/connected scale
1503  *
1504  * This function creates a default separated/connected scale
1505  * so there's something in the database.  The locations of
1506  * strings and files is a bit odd, but this is because we
1507  * need to maintain backward compatibility with many different
1508  * existing language translations and older sites.
1509  *
1510  * @uses $CFG
1511  */
1512 function make_default_scale() {
1513
1514     global $CFG;
1515
1516     $defaultscale = NULL;
1517     $defaultscale->courseid = 0;
1518     $defaultscale->userid = 0;
1519     $defaultscale->name  = get_string('separateandconnected');
1520     $defaultscale->scale = get_string('postrating1', 'forum').','.
1521                            get_string('postrating2', 'forum').','.
1522                            get_string('postrating3', 'forum');
1523     $defaultscale->timemodified = time();
1524
1525     /// Read in the big description from the file.  Note this is not
1526     /// HTML (despite the file extension) but Moodle format text.
1527     $parentlang = get_string('parentlang');
1528     if (is_readable($CFG->dataroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html')) {
1529         $file = file($CFG->dataroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html');
1530     } else if (is_readable($CFG->dirroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html')) {
1531         $file = file($CFG->dirroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html');
1532     } else if ($parentlang and is_readable($CFG->dataroot .'/lang/'. $parentlang .'/help/forum/ratings.html')) {
1533         $file = file($CFG->dataroot .'/lang/'. $parentlang .'/help/forum/ratings.html');
1534     } else if ($parentlang and is_readable($CFG->dirroot .'/lang/'. $parentlang .'/help/forum/ratings.html')) {
1535         $file = file($CFG->dirroot .'/lang/'. $parentlang .'/help/forum/ratings.html');
1536     } else if (is_readable($CFG->dirroot .'/lang/en_utf8/help/forum/ratings.html')) {
1537         $file = file($CFG->dirroot .'/lang/en_utf8/help/forum/ratings.html');
1538     } else {
1539         $file = '';
1540     }
1541
1542     $defaultscale->description = addslashes(implode('', $file));
1543
1544     if ($defaultscale->id = insert_record('scale', $defaultscale)) {
1545         execute_sql('UPDATE '. $CFG->prefix .'forum SET scale = \''. $defaultscale->id .'\'', false);
1546     }
1547 }
1548
1549
1550 /**
1551  * Returns a menu of all available scales from the site as well as the given course
1552  *
1553  * @uses $CFG
1554  * @param int $courseid The id of the course as found in the 'course' table.
1555  * @return object
1556  */
1557 function get_scales_menu($courseid=0) {
1558
1559     global $CFG;
1560
1561     $sql = "SELECT id, name FROM {$CFG->prefix}scale
1562              WHERE courseid = '0' or courseid = '$courseid'
1563           ORDER BY courseid ASC, name ASC";
1564
1565     if ($scales = get_records_sql_menu($sql)) {
1566         return $scales;
1567     }
1568
1569     make_default_scale();
1570
1571     return get_records_sql_menu($sql);
1572 }
1573
1574
1575
1576 /**
1577  * Given a set of timezone records, put them in the database,  replacing what is there
1578  *
1579  * @uses $CFG
1580  * @param array $timezones An array of timezone records
1581  */
1582 function update_timezone_records($timezones) {
1583 /// Given a set of timezone records, put them in the database
1584
1585     global $CFG;
1586
1587 /// Clear out all the old stuff
1588     execute_sql('TRUNCATE TABLE '.$CFG->prefix.'timezone', false);
1589
1590 /// Insert all the new stuff
1591     foreach ($timezones as $timezone) {
1592         insert_record('timezone', $timezone);
1593     }
1594 }
1595
1596
1597 /// MODULE FUNCTIONS /////////////////////////////////////////////////
1598
1599 /**
1600  * Just gets a raw list of all modules in a course
1601  *
1602  * @uses $CFG
1603  * @param int $courseid The id of the course as found in the 'course' table.
1604  * @return object
1605  */
1606 function get_course_mods($courseid) {
1607     global $CFG;
1608
1609     if (empty($courseid)) {
1610         return false; // avoid warnings
1611     }
1612
1613     return get_records_sql("SELECT cm.*, m.name as modname
1614                             FROM {$CFG->prefix}modules m,
1615                                  {$CFG->prefix}course_modules cm
1616                             WHERE cm.course = '$courseid'
1617                             AND cm.module = m.id ");
1618 }
1619
1620
1621 /**
1622  * Given an id of a course module, finds the coursemodule description
1623  *
1624  * @param string $modulename name of module type, eg. resource, assignment,...
1625  * @param int $cmid course module id (id in course_modules table)
1626  * @param int $courseid optional course id for extra validation
1627  * @return object course module instance with instance and module name
1628  */
1629 function get_coursemodule_from_id($modulename, $cmid, $courseid=0) {
1630
1631     global $CFG;
1632
1633     $courseselect = ($courseid) ? "cm.course = '$courseid' AND " : '';
1634
1635     return get_record_sql("SELECT cm.*, m.name, md.name as modname
1636                            FROM {$CFG->prefix}course_modules cm,
1637                                 {$CFG->prefix}modules md,
1638                                 {$CFG->prefix}$modulename m
1639                            WHERE $courseselect
1640                                  cm.id = '$cmid' AND
1641                                  cm.instance = m.id AND
1642                                  md.name = '$modulename' AND
1643                                  md.id = cm.module");
1644 }
1645
1646 /**
1647  * Given an instance number of a module, finds the coursemodule description
1648  *
1649  * @param string $modulename name of module type, eg. resource, assignment,...
1650  * @param int $instance module instance number (id in resource, assignment etc. table)
1651  * @param int $courseid optional course id for extra validation
1652  * @return object course module instance with instance and module name
1653  */
1654 function get_coursemodule_from_instance($modulename, $instance, $courseid=0) {
1655
1656     global $CFG;
1657
1658     $courseselect = ($courseid) ? "cm.course = '$courseid' AND " : '';
1659
1660     return get_record_sql("SELECT cm.*, m.name, md.name as modname
1661                            FROM {$CFG->prefix}course_modules cm,
1662                                 {$CFG->prefix}modules md,
1663                                 {$CFG->prefix}$modulename m
1664                            WHERE $courseselect
1665                                  cm.instance = m.id AND
1666                                  md.name = '$modulename' AND
1667                                  md.id = cm.module AND
1668                                  m.id = '$instance'");
1669
1670 }
1671
1672 /**
1673  * Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
1674  *
1675  * Returns an array of all the active instances of a particular
1676  * module in given courses, sorted in the order they are defined
1677  * in the course.   Returns false on any errors.
1678  *
1679  * @uses $CFG
1680  * @param string  $modulename The name of the module to get instances for
1681  * @param array  $courses This depends on an accurate $course->modinfo
1682  * @return array of instances
1683  */
1684 function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
1685     global $CFG;
1686     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1687         return array();
1688     }
1689     if (!$rawmods = get_records_sql("SELECT cm.id as coursemodule, m.*,cw.section,cm.visible as visible,cm.groupmode, cm.course
1690                             FROM {$CFG->prefix}course_modules cm,
1691                                  {$CFG->prefix}course_sections cw,
1692                                  {$CFG->prefix}modules md,
1693                                  {$CFG->prefix}$modulename m
1694                             WHERE cm.course IN (".implode(',',array_keys($courses)).") AND
1695                                   cm.instance = m.id AND
1696                                   cm.section = cw.id AND
1697                                   md.name = '$modulename' AND
1698                                   md.id = cm.module")) {
1699         return array();
1700     }
1701
1702     $outputarray = array();
1703
1704     foreach ($courses as $course) {
1705         if ($includeinvisible) {
1706             $invisible = -1;
1707         } else if (has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id), $userid)) {
1708             // Usually hide non-visible instances from students
1709             $invisible = -1;
1710         } else {
1711             $invisible = 0;
1712         }
1713
1714    /// Casting $course->modinfo to string prevents one notice when the field is null
1715         if (!$modinfo = unserialize((string)$course->modinfo)) {
1716             continue;
1717         }
1718         foreach ($modinfo as $mod) {
1719             if ($mod->mod == $modulename and $mod->visible > $invisible) {
1720                 $instance = $rawmods[$mod->cm];
1721                 if (!empty($mod->extra)) {
1722                     $instance->extra = $mod->extra;
1723                 }
1724                 $outputarray[] = $instance;
1725             }
1726         }
1727     }
1728
1729     return $outputarray;
1730
1731 }
1732
1733 /**
1734  * Returns an array of all the active instances of a particular module in a given course, sorted in the order they are defined
1735  *
1736  * Returns an array of all the active instances of a particular
1737  * module in a given course, sorted in the order they are defined
1738  * in the course.   Returns false on any errors.
1739  *
1740  * @uses $CFG
1741  * @param string  $modulename The name of the module to get instances for
1742  * @param object(course)  $course This depends on an accurate $course->modinfo
1743  */
1744 function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
1745
1746     global $CFG;
1747
1748     if (empty($course->modinfo)) {
1749         return array();
1750     }
1751
1752     if (!$modinfo = unserialize((string)$course->modinfo)) {
1753         return array();
1754     }
1755
1756     if (!$rawmods = get_records_sql("SELECT cm.id as coursemodule, m.*,cw.section,cm.visible as visible,cm.groupmode,cm.groupingid
1757                             FROM {$CFG->prefix}course_modules cm,
1758                                  {$CFG->prefix}course_sections cw,
1759                                  {$CFG->prefix}modules md,
1760                                  {$CFG->prefix}$modulename m
1761                             WHERE cm.course = '$course->id' AND
1762                                   cm.instance = m.id AND
1763                                   cm.section = cw.id AND
1764                                   md.name = '$modulename' AND
1765                                   md.id = cm.module")) {
1766         return array();
1767     }
1768
1769     if ($includeinvisible) {
1770         $invisible = -1;
1771     } else if (has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_COURSE, $course->id), $userid)) {
1772         // Usually hide non-visible instances from students
1773         $invisible = -1;
1774     } else {
1775         $invisible = 0;
1776     }
1777
1778     $outputarray = array();
1779
1780     foreach ($modinfo as $mod) {
1781         $mod->id = $mod->cm;
1782         $mod->course = $course->id;
1783         if (!groups_course_module_visible($mod)) {
1784             continue;
1785         }
1786         if ($mod->mod == $modulename and $mod->visible > $invisible) {
1787             $instance = $rawmods[$mod->cm];
1788             if (!empty($mod->extra)) {
1789                 $instance->extra = $mod->extra;
1790             }
1791             $outputarray[] = $instance;
1792         }
1793     }
1794
1795     return $outputarray;
1796
1797 }
1798
1799
1800 /**
1801  * Determine whether a module instance is visible within a course
1802  *
1803  * Given a valid module object with info about the id and course,
1804  * and the module's type (eg "forum") returns whether the object
1805  * is visible or not
1806  *
1807  * @uses $CFG
1808  * @param $moduletype Name of the module eg 'forum'
1809  * @param $module Object which is the instance of the module
1810  * @return bool
1811  */
1812 function instance_is_visible($moduletype, $module) {
1813
1814     global $CFG;
1815
1816     if (!empty($module->id)) {
1817         if ($records = get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
1818                                         FROM {$CFG->prefix}course_modules cm,
1819                                              {$CFG->prefix}modules m
1820                                        WHERE cm.course = '$module->course' AND
1821                                              cm.module = m.id AND
1822                                              m.name = '$moduletype' AND
1823                                              cm.instance = '$module->id'")) {
1824
1825             foreach ($records as $record) { // there should only be one - use the first one
1826                 return $record->visible && groups_course_module_visible($record);
1827             }
1828         }
1829     }
1830     return true;  // visible by default!
1831 }
1832
1833
1834
1835
1836 /// LOG FUNCTIONS /////////////////////////////////////////////////////
1837
1838
1839 /**
1840  * Add an entry to the log table.
1841  *
1842  * Add an entry to the log table.  These are "action" focussed rather
1843  * than web server hits, and provide a way to easily reconstruct what
1844  * any particular student has been doing.
1845  *
1846  * @uses $CFG
1847  * @uses $USER
1848  * @uses $db
1849  * @uses $REMOTE_ADDR
1850  * @uses SITEID
1851  * @param    int     $courseid  The course id
1852  * @param    string  $module  The module name - e.g. forum, journal, resource, course, user etc
1853  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
1854  * @param    string  $url     The file and parameters used to see the results of the action
1855  * @param    string  $info    Additional description information
1856  * @param    string  $cm      The course_module->id if there is one
1857  * @param    string  $user    If log regards $user other than $USER
1858  */
1859 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
1860     // Note that this function intentionally does not follow the normal Moodle DB access idioms.
1861     // This is for a good reason: it is the most frequently used DB update function,
1862     // so it has been optimised for speed.
1863     global $db, $CFG, $USER;
1864
1865     if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
1866         $cm = 0;
1867     }
1868
1869     if ($user) {
1870         $userid = $user;
1871     } else {
1872         if (!empty($USER->realuser)) {  // Don't log
1873             return;
1874         }
1875         $userid = empty($USER->id) ? '0' : $USER->id;
1876     }
1877
1878     $REMOTE_ADDR = getremoteaddr();
1879
1880     $timenow = time();
1881     $info = addslashes($info);
1882     if (!empty($url)) { // could break doing html_entity_decode on an empty var.
1883         $url = html_entity_decode($url); // for php < 4.3.0 this is defined in moodlelib.php
1884     }
1885
1886     if (defined('MDL_PERFDB')) { global $PERF ; $PERF->dbqueries++; $PERF->logwrites++;};
1887
1888     if ($CFG->type = 'oci8po') {
1889         if (empty($info)) {
1890             $info = ' ';
1891         }
1892     }
1893
1894     $result = $db->Execute('INSERT INTO '. $CFG->prefix .'log (time, userid, course, ip, module, cmid, action, url, info)
1895         VALUES (' . "'$timenow', '$userid', '$courseid', '$REMOTE_ADDR', '$module', '$cm', '$action', '$url', '$info')");
1896
1897     if (!$result and debugging()) {
1898         echo '<p>Error: Could not insert a new entry to the Moodle log</p>';  // Don't throw an error
1899     }
1900
1901 /// Store lastaccess times for the current user, do not use in cron and other commandline scripts
1902 /// only update the lastaccess/timeaccess fields only once every 60s
1903     if (!empty($USER->id) && ($userid == $USER->id) && !defined('FULLME')) {
1904         $res = $db->Execute('UPDATE '. $CFG->prefix .'user
1905                                 SET lastip=\''. $REMOTE_ADDR .'\', lastaccess=\''. $timenow .'\'
1906                              WHERE id = \''. $userid .'\' AND '.$timenow.' - lastaccess > 60');
1907         if (!$res) {
1908             debugging('<p>Error: Could not insert a new entry to the Moodle log</p>');  // Don't throw an error
1909         }
1910         if ($courseid != SITEID && !empty($courseid)) {
1911             if (defined('MDL_PERFDB')) { global $PERF ; $PERF->dbqueries++;};
1912
1913             if ($ulid = get_field('user_lastaccess', 'id', 'userid', $userid, 'courseid', $courseid)) {
1914                 $res = $db->Execute("UPDATE {$CFG->prefix}user_lastaccess
1915                                         SET timeaccess=$timenow
1916                                      WHERE id = $ulid AND $timenow - timeaccess > 60");
1917                 if (!$res) {
1918                     debugging('Error: Could not insert a new entry to the Moodle log');  // Don't throw an error
1919                 }
1920             } else {
1921                 $res = $db->Execute("INSERT INTO {$CFG->prefix}user_lastaccess
1922                                             ( userid,  courseid,  timeaccess)
1923                                      VALUES ($userid, $courseid, $timenow)");
1924                 if (!$res) {
1925                     debugging('Error: Could not insert a new entry to the Moodle log');  // Don't throw an error
1926                 }
1927             }
1928             if (defined('MDL_PERFDB')) { global $PERF ; $PERF->dbqueries++;};
1929         }
1930     }
1931 }
1932
1933
1934 /**
1935  * Select all log records based on SQL criteria
1936  *
1937  * @uses $CFG
1938  * @param string $select SQL select criteria
1939  * @param string $order SQL order by clause to sort the records returned
1940  * @param string $limitfrom ?
1941  * @param int $limitnum ?
1942  * @param int $totalcount Passed in by reference.
1943  * @return object
1944  * @todo Finish documenting this function
1945  */
1946 function get_logs($select, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
1947     global $CFG;
1948
1949     if ($order) {
1950         $order = 'ORDER BY '. $order;
1951     }
1952
1953     $selectsql = $CFG->prefix .'log l LEFT JOIN '. $CFG->prefix .'user u ON l.userid = u.id '. ((strlen($select) > 0) ? 'WHERE '. $select : '');
1954     $countsql = $CFG->prefix.'log l '.((strlen($select) > 0) ? ' WHERE '. $select : '');
1955
1956     $totalcount = count_records_sql("SELECT COUNT(*) FROM $countsql");
1957
1958     return get_records_sql('SELECT l.*, u.firstname, u.lastname, u.picture
1959                                 FROM '. $selectsql .' '. $order, $limitfrom, $limitnum) ;
1960 }
1961
1962
1963 /**
1964  * Select all log records for a given course and user
1965  *
1966  * @uses $CFG
1967  * @uses DAYSECS
1968  * @param int $userid The id of the user as found in the 'user' table.
1969  * @param int $courseid The id of the course as found in the 'course' table.
1970  * @param string $coursestart ?
1971  * @todo Finish documenting this function
1972  */
1973 function get_logs_usercourse($userid, $courseid, $coursestart) {
1974     global $CFG;
1975
1976     if ($courseid) {
1977         $courseselect = ' AND course = \''. $courseid .'\' ';
1978     } else {
1979         $courseselect = '';
1980     }
1981
1982     return get_records_sql("SELECT floor((time - $coursestart)/". DAYSECS .") as day, count(*) as num
1983                             FROM {$CFG->prefix}log
1984                            WHERE userid = '$userid'
1985                              AND time > '$coursestart' $courseselect
1986                         GROUP BY day ");
1987 }
1988
1989 /**
1990  * Select all log records for a given course, user, and day
1991  *
1992  * @uses $CFG
1993  * @uses HOURSECS
1994  * @param int $userid The id of the user as found in the 'user' table.
1995  * @param int $courseid The id of the course as found in the 'course' table.
1996  * @param string $daystart ?
1997  * @return object
1998  * @todo Finish documenting this function
1999  */
2000 function get_logs_userday($userid, $courseid, $daystart) {
2001     global $CFG;
2002
2003     if ($courseid) {
2004         $courseselect = ' AND course = \''. $courseid .'\' ';
2005     } else {
2006         $courseselect = '';
2007     }
2008
2009     return get_records_sql("SELECT floor((time - $daystart)/". HOURSECS .") as hour, count(*) as num
2010                             FROM {$CFG->prefix}log
2011                            WHERE userid = '$userid'
2012                              AND time > '$daystart' $courseselect
2013                         GROUP BY hour ");
2014 }
2015
2016 /**
2017  * Returns an object with counts of failed login attempts
2018  *
2019  * Returns information about failed login attempts.  If the current user is
2020  * an admin, then two numbers are returned:  the number of attempts and the
2021  * number of accounts.  For non-admins, only the attempts on the given user
2022  * are shown.
2023  *
2024  * @param string $mode Either 'admin', 'teacher' or 'everybody'
2025  * @param string $username The username we are searching for
2026  * @param string $lastlogin The date from which we are searching
2027  * @return int
2028  */
2029 function count_login_failures($mode, $username, $lastlogin) {
2030
2031     $select = 'module=\'login\' AND action=\'error\' AND time > '. $lastlogin;
2032
2033     if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM, SITEID))) {    // Return information about all accounts
2034         if ($count->attempts = count_records_select('log', $select)) {
2035             $count->accounts = count_records_select('log', $select, 'COUNT(DISTINCT info)');
2036             return $count;
2037         }
2038     } else if ($mode == 'everybody' or ($mode == 'teacher' and isteacherinanycourse())) {
2039         if ($count->attempts = count_records_select('log', $select .' AND info = \''. $username .'\'')) {
2040             return $count;
2041         }
2042     }
2043     return NULL;
2044 }
2045
2046
2047 /// GENERAL HELPFUL THINGS  ///////////////////////////////////
2048
2049 /**
2050  * Dump a given object's information in a PRE block.
2051  *
2052  * Mostly just used for debugging.
2053  *
2054  * @param mixed $object The data to be printed
2055  */
2056 function print_object($object) {
2057     echo '<pre class="notifytiny">' . htmlspecialchars(print_r($object,true)) . '</pre>';
2058 }
2059
2060 /*
2061  * Check whether a course is visible through its parents
2062  * path.
2063  *
2064  * Notes:
2065  *
2066  * - All we need from the course is ->category. _However_
2067  *   if the course object has a categorypath property,
2068  *   we'll save a dbquery
2069  *
2070  * - If we return false, you'll still need to check if
2071  *   the user can has the 'moodle/category:visibility'
2072  *   capability...
2073  *
2074  * - Will generate 2 DB calls.
2075  *
2076  * - It does have a small local cache, however...
2077  *
2078  * - Do NOT call this over many courses as it'll generate
2079  *   DB traffic. Instead, see what get_my_courses() does.
2080  *
2081  * @param mixed $object A course object
2082  * @return bool
2083  */
2084 function course_parent_visible($course = null) {
2085     global $CFG;
2086     //return true;
2087     static $mycache;
2088
2089     if (!is_object($course)) {
2090         return true;
2091     }
2092     if (!empty($CFG->allowvisiblecoursesinhiddencategories)) {
2093         return true;
2094     }
2095
2096     if (!isset($mycache)) {
2097         $mycache = array();
2098     } else {
2099         // cast to force assoc array
2100         $k = (string)$course->category;
2101         if (isset($mycache[$k])) {
2102             return $mycache[$k];
2103         }
2104     }
2105
2106     if (isset($course->categorypath)) {
2107         $path = $course->categorypath;
2108     } else {
2109         $path = get_field('course_categories', 'path',
2110                           'id', $course->category);
2111     }
2112     $catids = substr($path,1); // strip leading slash
2113     $catids = str_replace('/',',',$catids);
2114
2115     $sql = "SELECT MIN(visible)
2116             FROM {$CFG->prefix}course_categories
2117             WHERE id IN ($catids)";
2118     $vis = get_field_sql($sql);
2119
2120     // cast to force assoc array
2121     $k = (string)$course->category;
2122     $mycache[$k] = $vis;
2123
2124     return $vis;
2125 }
2126
2127 /**
2128  * This function is the official hook inside XMLDB stuff to delegate its debug to one
2129  * external function.
2130  *
2131  * Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
2132  * using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
2133  *
2134  * @param $message string contains the error message
2135  * @param $object object XMLDB object that fired the debug
2136  */
2137 function xmldb_debug($message, $object) {
2138
2139     debugging($message, DEBUG_DEVELOPER);
2140 }
2141
2142 /**
2143  * true or false function to see if user can create any courses at all
2144  * @return bool
2145  */
2146 function user_can_create_courses() {
2147     global $USER;
2148     // if user has course creation capability at any site or course cat, then return true;
2149
2150     if (has_capability('moodle/course:create', get_context_instance(CONTEXT_SYSTEM, SITEID))) {
2151         return true;
2152     } else {
2153         return (bool) count(get_creatable_categories());
2154     }
2155
2156 }
2157
2158 /**
2159  * get the list of categories the current user can create courses in
2160  * @return array
2161  */
2162 function get_creatable_categories() {
2163
2164     $creatablecats = array();
2165     if ($cats = get_records('course_categories')) {
2166         foreach ($cats as $cat) {
2167             if (has_capability('moodle/course:create', get_context_instance(CONTEXT_COURSECAT, $cat->id))) {
2168                 $creatablecats[$cat->id] = $cat->name;
2169             }
2170         }
2171     }
2172     return $creatablecats;
2173 }
2174
2175 // vim:autoindent:expandtab:shiftwidth=4:tabstop=4:tw=140:
2176 ?>