lib/deprecatedlib.php

   1 <?php // $Id$
   2
   3 ///////////////////////////////////////////////////////////////////////////
   4 //                                                                       //
   5 // NOTICE OF COPYRIGHT                                                   //
   6 //                                                                       //
   7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   8 //          http://moodle.org                                            //
   9 //                                                                       //
  10 // Copyright (C) 1999-2999  Martin Dougiamas, Moodle  http://moodle.com  //
  11 //                                                                       //
  12 // This program is free software; you can redistribute it and/or modify  //
  13 // it under the terms of the GNU General Public License as published by  //
  14 // the Free Software Foundation; either version 2 of the License, or     //
  15 // (at your option) any later version.                                   //
  16 //                                                                       //
  17 // This program is distributed in the hope that it will be useful,       //
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  20 // GNU General Public License for more details:                          //
  21 //                                                                       //
  22 //          http://www.gnu.org/copyleft/gpl.html                         //
  23 //                                                                       //
  24 ///////////////////////////////////////////////////////////////////////////
  25
  26 /**
  27  * deprecatedlib.php - Old functions retained only for backward compatibility
  28  *
  29  * Old functions retained only for backward compatibility.  New code should not
  30  * use any of these functions.
  31  *
  32  * @author Martin Dougiamas
  33  * @version $Id$
  34  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  35  * @package moodlecore
  36  */
  37
  38
  39
  40
  41 /**
  42  * Ensure that a variable is set
  43  *
  44  * If $var is undefined throw an error, otherwise return $var.
  45  *
  46  * @param mixed $var the variable which may be unset
  47  * @param mixed $default the value to return if $var is unset
  48  */
  49 function require_variable($var) {
  50     global $CFG;
  51     if (!empty($CFG->disableglobalshack)) {
  52         error( 'The require_variable() function is deprecated.' );
  53     }
  54     if (! isset($var)) {
  55         error('A required parameter was missing');
  56     }
  57 }
  58
  59 /**
  60  * Ensure that a variable is set
  61  *
  62  * If $var is undefined set it (by reference), otherwise return $var.
  63  *
  64  * @param mixed $var the variable which may be unset
  65  * @param mixed $default the value to return if $var is unset
  66  */
  67 function optional_variable(&$var, $default=0) {
  68     global $CFG;
  69     if (!empty($CFG->disableglobalshack)) {
  70         error( "The optional_variable() function is deprecated ($var, $default)." );
  71     }
  72     if (! isset($var)) {
  73         $var = $default;
  74     }
  75 }
  76
  77 /**
  78  * Ensure that a variable is set
  79  *
  80  * Return $var if it is defined, otherwise return $default,
  81  * This function is very similar to {@link optional_variable()}
  82  *
  83  * @param    mixed $var the variable which may be unset
  84  * @param    mixed $default the value to return if $var is unset
  85  * @return   mixed
  86  */
  87 function nvl(&$var, $default='') {
  88     global $CFG;
  89
  90     if (!empty($CFG->disableglobalshack)) {
  91       error( "The nvl() function is deprecated ($var, $default)." );
  92     }
  93     return isset($var) ? $var : $default;
  94 }
  95
  96 /**
  97  * Determines if a user an admin
  98  *
  99  * @uses $USER
 100  * @param int $userid The id of the user as is found in the 'user' table
 101  * @staticvar array $admins List of users who have been found to be admins by user id
 102  * @staticvar array $nonadmins List of users who have been found not to be admins by user id
 103  * @return bool
 104  */
 105 function isadmin($userid=0) {
 106     global $USER, $CFG;
 107
 108     if (empty($CFG->rolesactive)) {    // Then the user is likely to be upgrading NOW
 109         if (!$userid) {
 110             if (empty($USER->id)) {
 111                 return false;
 112             }
 113             if (!empty($USER->admin)) {
 114                 return true;
 115             }
 116             $userid = $USER->id;
 117         }
 118
 119         return record_exists('user_admins', 'userid', $userid);
 120     }
 121
 122     $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 123
 124     return has_capability('moodle/legacy:admin', $context, $userid, false);
 125 }
 126
 127 /**
 128  * Determines if a user is a teacher (or better)
 129  *
 130  * @uses $CFG
 131  * @param int $courseid The id of the course that is being viewed, if any
 132  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
 133  * @param bool $obsolete_includeadmin Not used any more
 134  * @return bool
 135  */
 136
 137 function isteacher($courseid=0, $userid=0, $obsolete_includeadmin=true) {
 138 /// Is the user able to access this course as a teacher?
 139     global $CFG;
 140
 141     if (empty($CFG->rolesactive)) {     // Teachers are locked out during an upgrade to 1.7
 142         return false;
 143     }
 144
 145     if ($courseid) {
 146         $context = get_context_instance(CONTEXT_COURSE, $courseid);
 147     } else {
 148         $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 149     }
 150
 151     return (has_capability('moodle/legacy:teacher', $context, $userid, false)
 152          or has_capability('moodle/legacy:editingteacher', $context, $userid, false)
 153          or has_capability('moodle/legacy:admin', $context, $userid, false));
 154 }
 155
 156 /**
 157  * Determines if a user is a teacher in any course, or an admin
 158  *
 159  * @uses $USER
 160  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
 161  * @param bool $includeadmin Include anyone wo is an admin as well
 162  * @return bool
 163  */
 164 function isteacherinanycourse($userid=0, $includeadmin=true) {
 165     global $USER, $CFG;
 166
 167     if (empty($CFG->rolesactive)) {     // Teachers are locked out during an upgrade to 1.7
 168         return false;
 169     }
 170
 171     if (!$userid) {
 172         if (empty($USER->id)) {
 173             return false;
 174         }
 175         $userid = $USER->id;
 176     }
 177
 178     if (!record_exists('role_assignments', 'userid', $userid)) {    // Has no roles anywhere
 179         return false;
 180     }
 181
 182 /// If this user is assigned as an editing teacher anywhere then return true
 183     if ($roles = get_roles_with_capability('moodle/legacy:editingteacher', CAP_ALLOW)) {
 184         foreach ($roles as $role) {
 185             if (record_exists('role_assignments', 'roleid', $role->id, 'userid', $userid)) {
 186                 return true;
 187             }
 188         }
 189     }
 190
 191 /// If this user is assigned as a non-editing teacher anywhere then return true
 192     if ($roles = get_roles_with_capability('moodle/legacy:teacher', CAP_ALLOW)) {
 193         foreach ($roles as $role) {
 194             if (record_exists('role_assignments', 'roleid', $role->id, 'userid', $userid)) {
 195                 return true;
 196             }
 197         }
 198     }
 199
 200 /// Include admins if required
 201     if ($includeadmin) {
 202         $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 203         if (has_capability('moodle/legacy:admin', $context, $userid, false)) {
 204             return true;
 205         }
 206     }
 207
 208     return false;
 209 }
 210
 211 /**
 212  * Determines if a user is allowed to edit a given course
 213  *
 214  * @param int $courseid The id of the course that is being edited
 215  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
 216  * @return bool
 217  */
 218 function isteacheredit($courseid, $userid=0, $obsolete_ignorestudentview=false) {
 219     global $CFG;
 220
 221     if (empty($CFG->rolesactive)) {
 222         return false;
 223     }
 224
 225     if (empty($courseid)) {
 226         $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 227     } else {
 228         $context = get_context_instance(CONTEXT_COURSE, $courseid);
 229     }
 230
 231     return (has_capability('moodle/legacy:editingteacher', $context, $userid, false)
 232          or has_capability('moodle/legacy:admin', $context, $userid, false));
 233 }
 234
 235 /**
 236  * Determines if a user can create new courses
 237  *
 238  * @param int $userid The user being tested. You can set this to 0 or leave it blank to test the currently logged in user.
 239  * @return bool
 240  */
 241 function iscreator ($userid=0) {
 242     global $CFG;
 243
 244     if (empty($CFG->rolesactive)) {
 245         return false;
 246     }
 247
 248     $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 249
 250     return (has_capability('moodle/legacy:coursecreator', $context, $userid, false)
 251          or has_capability('moodle/legacy:admin', $context, $userid, false));
 252 }
 253
 254 /**
 255  * Determines if a user is a student in the specified course
 256  *
 257  * If the course id specifies the site then this determines
 258  * if the user is a confirmed and valid user of this site.
 259  *
 260  * @uses $CFG
 261  * @uses SITEID
 262  * @param int $courseid The id of the course being tested
 263  * @param int $userid The user being tested. You can set this to 0 or leave it blank to test the currently logged in user.
 264  * @return bool
 265  */
 266 function isstudent($courseid=0, $userid=0) {
 267     global $CFG;
 268
 269     if (empty($CFG->rolesactive)) {
 270         return false;
 271     }
 272
 273     if ($courseid == 0) {
 274         $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 275     } else {
 276         $context = get_context_instance(CONTEXT_COURSE, $courseid);
 277     }
 278
 279     return has_capability('moodle/legacy:student', $context, $userid, false);
 280 }
 281
 282 /**
 283  * Determines if the specified user is logged in as guest.
 284  *
 285  * @param int $userid The user being tested. You can set this to 0 or leave it blank to test the currently logged in user.
 286  * @return bool
 287  */
 288 function isguest($userid=0) {
 289     global $CFG;
 290
 291     if (empty($CFG->rolesactive)) {
 292         return false;
 293     }
 294
 295     $context = get_context_instance(CONTEXT_SYSTEM);
 296
 297     return has_capability('moodle/legacy:guest', $context, $userid, false);
 298 }
 299
 300 /**
 301  * Enrols (or re-enrols) a student in a given course
 302  *
 303  * NOTE: Defaults to 'manual' enrolment - enrolment plugins
 304  * must set it explicitly.
 305  *
 306  * @uses $CFG
 307  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
 308  * @param int $courseid The id of the course that is being viewed
 309  * @param int $timestart ?
 310  * @param int $timeend ?
 311  * @param string $enrol ?
 312  * @return bool
 313  */
 314 function enrol_student($userid, $courseid, $timestart=0, $timeend=0, $enrol='manual') {
 315
 316     global $CFG;
 317
 318     if (!$user = get_record('user', 'id', $userid)) {        // Check user
 319         return false;
 320     }
 321
 322     if (!$roles = get_roles_with_capability('moodle/legacy:student', CAP_ALLOW)) {
 323         return false;
 324     }
 325
 326     $role = array_shift($roles);      // We can only use one, let's use the first one
 327
 328     if (!$context = get_context_instance(CONTEXT_COURSE, $courseid)) {
 329         return false;
 330     }
 331
 332     return role_assign($role->id, $user->id, 0, $context->id, $timestart, $timeend, 0, $enrol);
 333 }
 334
 335 /**
 336  * Unenrols a student from a given course
 337  *
 338  * @param int $courseid The id of the course that is being viewed, if any
 339  * @param int $userid The id of the user that is being tested against.
 340  * @return bool
 341  */
 342 function unenrol_student($userid, $courseid=0) {
 343     global $CFG;
 344
 345     $status = true;
 346
 347     if ($courseid) {
 348         /// First delete any crucial stuff that might still send mail
 349         if ($forums = get_records('forum', 'course', $courseid)) {
 350             foreach ($forums as $forum) {
 351                 delete_records('forum_subscriptions', 'forum', $forum->id, 'userid', $userid);
 352             }
 353         }
 354         /// remove from all legacy student roles
 355         if ($courseid == SITEID) {
 356             $context = get_context_instance(CONTEXT_SYSTEM, SITEID);
 357         } else if (!$context = get_context_instance(CONTEXT_COURSE, $courseid)) {
 358             return false;
 359         }
 360         if (!$roles = get_roles_with_capability('moodle/legacy:student', CAP_ALLOW)) {
 361             return false;
 362         }
 363         foreach($roles as $role) {
 364             $status = role_unassign($role->id, $userid, 0, $context->id) and $status;
 365         }
 366     } else {
 367         // recursivelly unenroll student from all courses
 368         if ($courses = get_records('course')) {
 369             foreach($courses as $course) {
 370                 $status = unenrol_student($userid, $course->id) and $status;
 371             }
 372         }
 373     }
 374
 375     return $status;
 376 }
 377
 378 /**
 379  * Add a teacher to a given course
 380  *
 381  * @param int $userid The id of the user that is being tested against. Set this to 0 if you would just like to test against the currently logged in user.
 382  * @param int $courseid The id of the course that is being viewed, if any
 383  * @param int $editall Can edit the course
 384  * @param string $role Obsolete
 385  * @param int $timestart The time they start
 386  * @param int $timeend The time they end in this role
 387  * @param string $enrol The type of enrolment this is
 388  * @return bool
 389  */
 390 function add_teacher($userid, $courseid, $editall=1, $role='', $timestart=0, $timeend=0, $enrol='manual') {
 391     global $CFG;
 392
 393     if (!$user = get_record('user', 'id', $userid)) {        // Check user
 394         return false;
 395     }
 396
 397     $capability = $editall ? 'moodle/legacy:editingteacher' : 'moodle/legacy:teacher';
 398
 399     if (!$roles = get_roles_with_capability($capability, CAP_ALLOW)) {
 400         return false;
 401     }
 402
 403     $role = array_shift($roles);      // We can only use one, let's use the first one
 404
 405     if (!$context = get_context_instance(CONTEXT_COURSE, $courseid)) {
 406         return false;
 407     }
 408
 409     return role_assign($role->id, $user->id, 0, $context->id, $timestart, $timeend, 0, $enrol);
 410 }
 411
 412 /**
 413  * Removes a teacher from a given course (or ALL courses)
 414  * Does not delete the user account
 415  *
 416  * @param int $courseid The id of the course that is being viewed, if any
 417  * @param int $userid The id of the user that is being tested against.
 418  * @return bool
 419  */
 420 function remove_teacher($userid, $courseid=0) {
 421     global $CFG;
 422
 423     $roles = get_roles_with_capability('moodle/legacy:editingteacher', CAP_ALLOW);
 424
 425     if ($roles) {
 426         $roles += get_roles_with_capability('moodle/legacy:teacher', CAP_ALLOW);
 427     } else {
 428         $roles = get_roles_with_capability('moodle/legacy:teacher', CAP_ALLOW);
 429     }
 430
 431     if (empty($roles)) {
 432         return true;
 433     }
 434
 435     $return = true;
 436
 437     if ($courseid) {
 438
 439         if (!$context = get_context_instance(CONTEXT_COURSE, $courseid)) {
 440             return false;
 441         }
 442
 443         /// First delete any crucial stuff that might still send mail
 444         if ($forums = get_records('forum', 'course', $courseid)) {
 445             foreach ($forums as $forum) {
 446                 delete_records('forum_subscriptions', 'forum', $forum->id, 'userid', $userid);
 447             }
 448         }
 449
 450         /// No need to remove from groups now
 451
 452         foreach ($roles as $role) {    // Unassign them from all the teacher roles
 453             $newreturn = role_unassign($role->id, $userid, 0, $context->id);
 454             if (empty($newreturn)) {
 455                 $return = false;
 456             }
 457         }
 458
 459     } else {
 460         delete_records('forum_subscriptions', 'userid', $userid);
 461         $return = true;
 462         foreach ($roles as $role) {    // Unassign them from all the teacher roles
 463             $newreturn = role_unassign($role->id, $userid, 0, 0);
 464             if (empty($newreturn)) {
 465                 $return = false;
 466             }
 467         }
 468     }
 469
 470     return $return;
 471 }
 472
 473 /**
 474  * Add an admin to a site
 475  *
 476  * @uses SITEID
 477  * @param int $userid The id of the user that is being tested against.
 478  * @return bool
 479  * @TODO: remove from cvs
 480  */
 481 function add_admin($userid) {
 482     return true;
 483 }
 484
 485 function get_user_info_from_db($field, $value) {  // For backward compatibility
 486     return get_complete_user_data($field, $value);
 487 }
 488
 489
 490 /**
 491  * Get the guest user information from the database
 492  *
 493  * @return object(user) An associative array with the details of the guest user account.
 494  * @todo Is object(user) a correct return type? Or is array the proper return type with a note that the contents include all details for a user.
 495  */
 496 function get_guest() {
 497     return get_complete_user_data('username', 'guest');
 498 }
 499
 500 /**
 501  * Returns $user object of the main teacher for a course
 502  *
 503  * @uses $CFG
 504  * @param int $courseid The course in question.
 505  * @return user|false  A {@link $USER} record of the main teacher for the specified course or false if error.
 506  * @todo Finish documenting this function
 507  */
 508 function get_teacher($courseid) {
 509
 510     global $CFG;
 511
 512     $context = get_context_instance(CONTEXT_COURSE, $courseid);
 513
 514     if ($users = get_users_by_capability($context, 'moodle/course:update', 'u.*,ra.hidden', 'r.sortorder ASC',
 515                                          '', '', '', '', false)) {
 516         foreach ($users as $user) {
 517             if (!$user->hidden || has_capability('moodle/role:viewhiddenassigns', $context)) {
 518                 return $user;
 519             }
 520         }
 521     }
 522
 523     return false;
 524 }
 525
 526 /**
 527  * Searches logs to find all enrolments since a certain date
 528  *
 529  * used to print recent activity
 530  *
 531  * @uses $CFG
 532  * @param int $courseid The course in question.
 533  * @return object|false  {@link $USER} records or false if error.
 534  * @todo Finish documenting this function
 535  */
 536 function get_recent_enrolments($courseid, $timestart) {
 537
 538     global $CFG;
 539
 540     $context = get_context_instance(CONTEXT_COURSE, $courseid);
 541
 542     return get_records_sql("SELECT DISTINCT u.id, u.firstname, u.lastname, l.time
 543                             FROM {$CFG->prefix}user u,
 544                                  {$CFG->prefix}role_assignments ra,
 545                                  {$CFG->prefix}log l
 546                             WHERE l.time > '$timestart'
 547                               AND l.course = '$courseid'
 548                               AND l.module = 'course'
 549                               AND l.action = 'enrol'
 550                               AND l.info = u.id
 551                               AND u.id = ra.userid
 552                               AND ra.contextid ".get_related_contexts_string($context)."
 553                               ORDER BY l.time ASC");
 554 }
 555
 556 /**
 557  * Returns array of userinfo of all students in this course
 558  * or on this site if courseid is id of site
 559  *
 560  * @uses $CFG
 561  * @uses SITEID
 562  * @param int $courseid The course in question.
 563  * @param string $sort ?
 564  * @param string $dir ?
 565  * @param int $page ?
 566  * @param int $recordsperpage ?
 567  * @param string $firstinitial ?
 568  * @param string $lastinitial ?
 569  * @param ? $group ?
 570  * @param string $search ?
 571  * @param string $fields A comma separated list of fields to be returned from the chosen table.
 572  * @param string $exceptions ?
 573  * @return object
 574  * @todo Finish documenting this function
 575  */
 576 function get_course_students($courseid, $sort='ul.timeaccess', $dir='', $page='', $recordsperpage='',
 577                              $firstinitial='', $lastinitial='', $group=NULL, $search='', $fields='', $exceptions='') {
 578
 579     global $CFG;
 580
 581     if ($courseid == SITEID and $CFG->allusersaresitestudents) {
 582         // return users with confirmed, undeleted accounts who are not site teachers
 583         // the following is a mess because of different conventions in the different user functions
 584         $sort = str_replace('s.timeaccess', 'lastaccess', $sort); // site users can't be sorted by timeaccess
 585         $sort = str_replace('timeaccess', 'lastaccess', $sort); // site users can't be sorted by timeaccess
 586         $sort = str_replace('u.', '', $sort); // the get_user function doesn't use the u. prefix to fields
 587         $fields = str_replace('u.', '', $fields);
 588         if ($sort) {
 589             $sort = $sort .' '. $dir;
 590         }
 591         // Now we have to make sure site teachers are excluded
 592
 593         if ($teachers = get_course_teachers(SITEID)) {
 594             foreach ($teachers as $teacher) {
 595                 $exceptions .= ','. $teacher->userid;
 596             }
 597             $exceptions = ltrim($exceptions, ',');
 598
 599         }
 600
 601         return get_users(true, $search, true, $exceptions, $sort, $firstinitial, $lastinitial,
 602                           $page, $recordsperpage, $fields ? $fields : '*');
 603     }
 604
 605     $LIKE      = sql_ilike();
 606     $fullname  = sql_fullname('u.firstname','u.lastname');
 607
 608     $groupmembers = '';
 609
 610     // make sure it works on the site course
 611     $context = get_context_instance(CONTEXT_COURSE, $courseid);
 612
 613     $select = "c.contextlevel=".CONTEXT_COURSE." AND "; // Must be on a course
 614     if ($courseid != SITEID) {
 615         // If not site, require specific course
 616         $select.= "c.instanceid=$courseid AND ";
 617     }
 618     $select.="rc.capability='moodle/legacy:student' AND rc.permission=".CAP_ALLOW." AND ";
 619
 620     $select .= ' u.deleted = \'0\' ';
 621
 622     if (!$fields) {
 623         $fields = 'u.id, u.confirmed, u.username, u.firstname, u.lastname, '.
 624                   'u.maildisplay, u.mailformat, u.maildigest, u.email, u.city, '.
 625                   'u.country, u.picture, u.idnumber, u.department, u.institution, '.
 626                   'u.emailstop, u.lang, u.timezone, ul.timeaccess as lastaccess';
 627     }
 628
 629     if ($search) {
 630         $search = ' AND ('. $fullname .' '. $LIKE .'\'%'. $search .'%\' OR email '. $LIKE .'\'%'. $search .'%\') ';
 631     }
 632
 633     if ($firstinitial) {
 634         $select .= ' AND u.firstname '. $LIKE .'\''. $firstinitial .'%\' ';
 635     }
 636
 637     if ($lastinitial) {
 638         $select .= ' AND u.lastname '. $LIKE .'\''. $lastinitial .'%\' ';
 639     }
 640
 641     if ($group === 0) {   /// Need something here to get all students not in a group
 642         return array();
 643
 644     } else if ($group !== NULL) {
 645         $groupmembers = "INNER JOIN {$CFG->prefix}groups_members gm on u.id=gm.userid";
 646         $select .= ' AND gm.groupid = \''. $group .'\'';
 647     }
 648
 649     if (!empty($exceptions)) {
 650         $select .= ' AND u.id NOT IN ('. $exceptions .')';
 651     }
 652
 653     if ($sort) {
 654         $sort = ' ORDER BY '. $sort .' ';
 655     }
 656
 657     $students = get_records_sql("SELECT $fields
 658                                 FROM {$CFG->prefix}user u INNER JOIN
 659                                      {$CFG->prefix}role_assignments ra on u.id=ra.userid INNER JOIN
 660                                      {$CFG->prefix}role_capabilities rc ON ra.roleid=rc.roleid INNER JOIN
 661                                      {$CFG->prefix}context c ON c.id=ra.contextid LEFT OUTER JOIN
 662                                      {$CFG->prefix}user_lastaccess ul on ul.userid=ra.userid
 663                                      $groupmembers
 664                                 WHERE $select $search $sort $dir", $page, $recordsperpage);
 665
 666     return $students;
 667 }
 668
 669 /**
 670  * Counts the students in a given course (or site), or a subset of them
 671  *
 672  * @param object $course The course in question as a course object.
 673  * @param string $search ?
 674  * @param string $firstinitial ?
 675  * @param string $lastinitial ?
 676  * @param ? $group ?
 677  * @param string $exceptions ?
 678  * @return int
 679  * @todo Finish documenting this function
 680  */
 681 function count_course_students($course, $search='', $firstinitial='', $lastinitial='', $group=NULL, $exceptions='') {
 682
 683     if ($students = get_course_students($course->id, '', '', 0, 999999, $firstinitial, $lastinitial, $group, $search, '', $exceptions)) {
 684         return count($students);
 685     }
 686     return 0;
 687 }
 688
 689 /**
 690  * Returns list of all teachers in this course
 691  *
 692  * If $courseid matches the site id then this function
 693  * returns a list of all teachers for the site.
 694  *
 695  * @uses $CFG
 696  * @param int $courseid The course in question.
 697  * @param string $sort ?
 698  * @param string $exceptions ?
 699  * @return object
 700  * @todo Finish documenting this function
 701  */
 702 function get_course_teachers($courseid, $sort='t.authority ASC', $exceptions='') {
 703
 704     global $CFG;
 705
 706     $sort = 'ul.timeaccess DESC';
 707
 708     $context = get_context_instance(CONTEXT_COURSE, $courseid);
 709     return get_users_by_capability($context, 'moodle/course:update', 'u.*, ul.timeaccess as lastaccess, ra.hidden', $sort, '','','',$exceptions, false);
 710     /// some fields will be missing, like authority, editall
 711     /*
 712     return get_records_sql("SELECT u.id, u.username, u.firstname, u.lastname, u.maildisplay, u.mailformat, u.maildigest,
 713                                    u.email, u.city, u.country, u.lastlogin, u.picture, u.lang, u.timezone,
 714                                    u.emailstop, t.authority,t.role,t.editall,t.timeaccess as lastaccess
 715                             FROM {$CFG->prefix}user u,
 716                                  {$CFG->prefix}user_teachers t
 717                             WHERE t.course = '$courseid' AND t.userid = u.id
 718                               AND u.deleted = '0' AND u.confirmed = '1' $exceptions $sort");
 719     */
 720 }
 721
 722 /**
 723  * Returns all the users of a course: students and teachers
 724  *
 725  * @param int $courseid The course in question.
 726  * @param string $sort ?
 727  * @param string $exceptions ?
 728  * @param string $fields A comma separated list of fields to be returned from the chosen table.
 729  * @return object
 730  * @todo Finish documenting this function
 731  */
 732 function get_course_users($courseid, $sort='ul.timeaccess DESC', $exceptions='', $fields='') {
 733
 734     $context = get_context_instance(CONTEXT_COURSE, $courseid);
 735     return get_users_by_capability($context, 'moodle/course:view', 'u.*, ul.timeaccess as lastaccess', $sort, '','','',$exceptions, false);
 736
 737 }
 738
 739 /**
 740  * Returns an array of user objects
 741  *
 742  * @uses $CFG
 743  * @param int $groupid The group(s) in question.
 744  * @param string $sort How to sort the results
 745  * @return object (changed to groupids)
 746  */
 747 function get_group_students($groupids, $sort='ul.timeaccess DESC') {
 748
 749     if (is_array($groupids)){
 750         $groups = $groupids;
 751         // all groups must be from one course anyway...
 752         $group = groups_get_group(array_shift($groups));
 753     } else {
 754         $group = groups_get_group($groupids);
 755     }
 756     if (!$group) {
 757         return NULL;
 758     }
 759
 760     $context = get_context_instance(CONTEXT_COURSE, $group->courseid);
 761     return get_users_by_capability($context, 'moodle/legacy:student', 'u.*, ul.timeaccess as lastaccess', $sort, '','',$groupids, '', false);
 762 }
 763
 764 /**
 765  * Returns list of all the teachers who can access a group
 766  *
 767  * @uses $CFG
 768  * @param int $courseid The course in question.
 769  * @param int $groupid The group in question.
 770  * @return object
 771  */
 772 function get_group_teachers($courseid, $groupid) {
 773 /// Returns a list of all the teachers who can access a group
 774     if ($teachers = get_course_teachers($courseid)) {
 775         foreach ($teachers as $key => $teacher) {
 776             if ($teacher->editall) {             // These can access anything
 777                 continue;
 778             }
 779             if (($teacher->authority > 0) and ismember($groupid, $teacher->id)) {  // Specific group teachers
 780                 continue;
 781             }
 782             unset($teachers[$key]);
 783         }
 784     }
 785     return $teachers;
 786 }
 787
 788
 789
 790 ########### FROM weblib.php ##########################################################################
 791
 792
 793 /**
 794  * Print a message in a standard themed box.
 795  * This old function used to implement boxes using tables.  Now it uses a DIV, but the old
 796  * parameters remain.  If possible, $align, $width and $color should not be defined at all.
 797  * Preferably just use print_box() in weblib.php
 798  *
 799  * @param string $align, alignment of the box, not the text (default center, left, right).
 800  * @param string $width, width of the box, including units %, for example '100%'.
 801  * @param string $color, background colour of the box, for example '#eee'.
 802  * @param int $padding, padding in pixels, specified without units.
 803  * @param string $class, space-separated class names.
 804  * @param string $id, space-separated id names.
 805  * @param boolean $return, return as string or just print it
 806  */
 807 function print_simple_box($message, $align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
 808     $output = '';
 809     $output .= print_simple_box_start($align, $width, $color, $padding, $class, $id, true);
 810     $output .= stripslashes_safe($message);
 811     $output .= print_simple_box_end(true);
 812
 813     if ($return) {
 814         return $output;
 815     } else {
 816         echo $output;
 817     }
 818 }
 819
 820
 821
 822 /**
 823  * This old function used to implement boxes using tables.  Now it uses a DIV, but the old
 824  * parameters remain.  If possible, $align, $width and $color should not be defined at all.
 825  * Even better, please use print_box_start() in weblib.php
 826  *
 827  * @param string $align, alignment of the box, not the text (default center, left, right).   DEPRECATED
 828  * @param string $width, width of the box, including % units, for example '100%'.            DEPRECATED
 829  * @param string $color, background colour of the box, for example '#eee'.                   DEPRECATED
 830  * @param int $padding, padding in pixels, specified without units.                          OBSOLETE
 831  * @param string $class, space-separated class names.
 832  * @param string $id, space-separated id names.
 833  * @param boolean $return, return as string or just print it
 834  */
 835 function print_simple_box_start($align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
 836
 837     $output = '';
 838
 839     $divclasses = 'box '.$class.' '.$class.'content';
 840     $divstyles  = '';
 841
 842     if ($align) {
 843         $divclasses .= ' boxalign'.$align;    // Implement alignment using a class
 844     }
 845     if ($width) {    // Hopefully we can eliminate these in calls to this function (inline styles are bad)
 846         if (substr($width, -1, 1) == '%') {    // Width is a % value
 847             $width = (int) substr($width, 0, -1);    // Extract just the number
 848             if ($width < 40) {
 849                 $divclasses .= ' boxwidthnarrow';    // Approx 30% depending on theme
 850             } else if ($width > 60) {
 851                 $divclasses .= ' boxwidthwide';      // Approx 80% depending on theme
 852             } else {
 853                 $divclasses .= ' boxwidthnormal';    // Approx 50% depending on theme
 854             }
 855         } else {
 856             $divstyles  .= ' width:'.$width.';';     // Last resort
 857         }
 858     }
 859     if ($color) {    // Hopefully we can eliminate these in calls to this function (inline styles are bad)
 860         $divstyles  .= ' background:'.$color.';';
 861     }
 862     if ($divstyles) {
 863         $divstyles = ' style="'.$divstyles.'"';
 864     }
 865
 866     if ($id) {
 867         $id = ' id="'.$id.'"';
 868     }
 869
 870     $output .= '<div'.$id.$divstyles.' class="'.$divclasses.'">';
 871
 872     if ($return) {
 873         return $output;
 874     } else {
 875         echo $output;
 876     }
 877 }
 878
 879
 880 /**
 881  * Print the end portion of a standard themed box.
 882  * Preferably just use print_box_end() in weblib.php
 883  */
 884 function print_simple_box_end($return=false) {
 885     $output = '</div>';
 886     if ($return) {
 887         return $output;
 888     } else {
 889         echo $output;
 890     }
 891 }
 892
 893 /**
 894  * deprecated - use clean_param($string, PARAM_FILE); instead
 895  * Check for bad characters ?
 896  *
 897  * @param string $string ?
 898  * @param int $allowdots ?
 899  * @todo Finish documenting this function - more detail needed in description as well as details on arguments
 900  */
 901 function detect_munged_arguments($string, $allowdots=1) {
 902     if (substr_count($string, '..') > $allowdots) {   // Sometimes we allow dots in references
 903         return true;
 904     }
 905     if (ereg('[\|\`]', $string)) {  // check for other bad characters
 906         return true;
 907     }
 908     if (empty($string) or $string == '/') {
 909         return true;
 910     }
 911
 912     return false;
 913 }
 914
 915 /** Deprecated function - returns the code of the current charset - originally depended on the selected language pack.
 916  *
 917  * @param $ignorecache not used anymore
 918  * @return string always returns 'UTF-8'
 919  */
 920 function current_charset($ignorecache = false) {
 921     return 'UTF-8';
 922 }
 923
 924
 925 /////////////////////////////////////////////////////////////
 926 /// Old functions not used anymore - candidates for removal
 927 /////////////////////////////////////////////////////////////
 928
 929 /**
 930  * Load a template from file - this function dates back to Moodle 1 :-) not used anymore
 931  *
 932  * Returns a (big) string containing the contents of a template file with all
 933  * the variables interpolated.  all the variables must be in the $var[] array or
 934  * object (whatever you decide to use).
 935  *
 936  * <b>WARNING: do not use this on big files!!</b>
 937  *
 938  * @param string $filename Location on the server's filesystem where template can be found.
 939  * @param mixed $var Passed in by reference. An array or object which will be loaded with data from the template file.
 940  *
 941  */
 942 function read_template($filename, &$var) {
 943
 944     $temp = str_replace("\\", "\\\\", implode(file($filename), ''));
 945     $temp = str_replace('"', '\"', $temp);
 946     eval("\$template = \"$temp\";");
 947     return $template;
 948 }
 949
 950
 951 /**
 952  * deprecated - relies on register globals; use new formslib instead
 953  *
 954  * Set a variable's value depending on whether or not it already has a value.
 955  *
 956  * If variable is set, set it to the set_value otherwise set it to the
 957  * unset_value.  used to handle checkboxes when you are expecting them from
 958  * a form
 959  *
 960  * @param mixed $var Passed in by reference. The variable to check.
 961  * @param mixed $set_value The value to set $var to if $var already has a value.
 962  * @param mixed $unset_value The value to set $var to if $var does not already have a value.
 963  */
 964 function checked(&$var, $set_value = 1, $unset_value = 0) {
 965
 966     if (empty($var)) {
 967         $var = $unset_value;
 968     } else {
 969         $var = $set_value;
 970     }
 971 }
 972
 973 /**
 974  * deprecated - use new formslib instead
 975  *
 976  * Prints the word "checked" if a variable is true, otherwise prints nothing,
 977  * used for printing the word "checked" in a checkbox form element.
 978  *
 979  * @param boolean $var Variable to be checked for true value
 980  * @param string $true_value Value to be printed if $var is true
 981  * @param string $false_value Value to be printed if $var is false
 982  */
 983 function frmchecked(&$var, $true_value = 'checked', $false_value = '') {
 984
 985     if ($var) {
 986         echo $true_value;
 987     } else {
 988         echo $false_value;
 989     }
 990 }
 991
 992 /**
 993  * Legacy function, provided for backward compatability.
 994  * This method now simply calls {@link use_html_editor()}
 995  *
 996  * @deprecated Use {@link use_html_editor()} instead.
 997  * @param string $name Form element to replace with HTMl editor by name
 998  * @todo Finish documenting this function
 999  */
1000 function print_richedit_javascript($form, $name, $source='no') {
1001     use_html_editor($name);
1002 }
1003
1004
1005
1006 ?>