mirror of
https://github.com/moodle/moodle.git
synced 2025-01-17 21:49:15 +01:00
2448 lines
83 KiB
PHP
2448 lines
83 KiB
PHP
<?php
|
|
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Library of functions for database manipulation.
|
|
*
|
|
* Other main libraries:
|
|
* - weblib.php - functions that produce web output
|
|
* - moodlelib.php - general-purpose Moodle functions
|
|
*
|
|
* @package moodlecore
|
|
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
/**
|
|
* The maximum courses in a category
|
|
* MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
|
|
*/
|
|
define('MAX_COURSES_IN_CATEGORY', 10000);
|
|
/**
|
|
* The maximum number of course categories
|
|
* MAX_COURSES_IN_CATEGORY * MAX_COURSE_CATEGORIES must not be more than max integer!
|
|
*/
|
|
define('MAX_COURSE_CATEGORIES', 10000);
|
|
|
|
/**
|
|
* Number of seconds to wait before updating lastaccess information in DB.
|
|
*/
|
|
define('LASTACCESS_UPDATE_SECS', 60);
|
|
|
|
/**
|
|
* Returns $user object of the main admin user
|
|
* primary admin = admin with lowest role_assignment id among admins
|
|
*
|
|
* @global object
|
|
* @static object $myadmin
|
|
* @return object An associative array representing the admin user.
|
|
*/
|
|
function get_admin () {
|
|
|
|
global $CFG;
|
|
static $myadmin;
|
|
|
|
if (isset($myadmin)) {
|
|
return $myadmin;
|
|
}
|
|
|
|
if ( $admins = get_admins() ) {
|
|
foreach ($admins as $admin) {
|
|
$myadmin = $admin;
|
|
return $admin; // ie the first one
|
|
}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns list of all admins, using 1 DB query. It depends on DB schema v1.7
|
|
* but does not depend on the v1.9 datastructures (context.path, etc).
|
|
*
|
|
* @global object
|
|
* @return array
|
|
*/
|
|
function get_admins() {
|
|
global $DB;
|
|
|
|
$sql = "SELECT ra.userid, SUM(rc.permission) AS permission, MIN(ra.id) AS adminid
|
|
FROM {role_capabilities} rc
|
|
JOIN {context} ctx ON ctx.id=rc.contextid
|
|
JOIN {role_assignments} ra ON ra.roleid=rc.roleid AND ra.contextid=ctx.id
|
|
WHERE ctx.contextlevel=10 AND rc.capability IN (?, ?, ?)
|
|
GROUP BY ra.userid
|
|
HAVING SUM(rc.permission) > 0";
|
|
$params = array('moodle/site:config', 'moodle/legacy:admin', 'moodle/site:doanything');
|
|
|
|
$sql = "SELECT u.*, ra.adminid
|
|
FROM {user} u
|
|
JOIN ($sql) ra
|
|
ON u.id=ra.userid
|
|
ORDER BY ra.adminid ASC";
|
|
|
|
return $DB->get_records_sql($sql, $params);
|
|
}
|
|
|
|
/**
|
|
* Get all of the courses in a given meta course
|
|
*
|
|
* @global object
|
|
* @param int $metacourseid The metacourse id
|
|
* @return array
|
|
*/
|
|
function get_courses_in_metacourse($metacourseid) {
|
|
global $DB;
|
|
|
|
$sql = "SELECT c.id, c.shortname, c.fullname
|
|
FROM {course} c, {course_meta} mc
|
|
WHERE mc.parent_course = ? AND mc.child_course = c.id
|
|
ORDER BY c.shortname";
|
|
$params = array($metacourseid);
|
|
|
|
return $DB->get_records_sql($sql, $params);
|
|
}
|
|
|
|
/**
|
|
* @todo Document this function
|
|
*
|
|
* @global object
|
|
* @uses SITEID
|
|
* @param int $metacourseid
|
|
* @return array
|
|
*/
|
|
function get_courses_notin_metacourse($metacourseid) {
|
|
global $DB;
|
|
|
|
if ($alreadycourses = get_courses_in_metacourse($metacourseid)) {
|
|
$alreadycourses = implode(',',array_keys($alreadycourses));
|
|
$alreadycourses = "AND c.id NOT IN ($alreadycourses)";
|
|
} else {
|
|
$alreadycourses = "";
|
|
}
|
|
|
|
$sql = "SELECT c.id,c.shortname,c.fullname
|
|
FROM {course} c
|
|
WHERE c.id != ? and c.id != ".SITEID." and c.metacourse != 1
|
|
$alreadycourses
|
|
ORDER BY c.shortname";
|
|
$params = array($metacourseid);
|
|
|
|
return $DB->get_records_sql($sql, $params);
|
|
}
|
|
|
|
/**
|
|
* @todo Document this function
|
|
*
|
|
* This function is nearly identical to {@link get_courses_notin_metacourse()}
|
|
*
|
|
* @global object
|
|
* @uses SITEID
|
|
* @param int $metacourseid
|
|
* @return int The count
|
|
*/
|
|
function count_courses_notin_metacourse($metacourseid) {
|
|
global $DB;
|
|
|
|
if ($alreadycourses = get_courses_in_metacourse($metacourseid)) {
|
|
$alreadycourses = implode(',',array_keys($alreadycourses));
|
|
$alreadycourses = "AND c.id NOT IN ($alreadycourses)";
|
|
} else {
|
|
$alreadycourses = "";
|
|
}
|
|
|
|
$sql = "SELECT COUNT(c.id)
|
|
FROM {course} c
|
|
WHERE c.id != ? and c.id != ".SITEID." and c.metacourse != 1
|
|
$alreadycourses";
|
|
$params = array($metacourseid);
|
|
|
|
return $DB->count_records_sql($sql, $params);
|
|
}
|
|
|
|
/**
|
|
* Search through course users
|
|
*
|
|
* If $coursid specifies the site course then this function searches
|
|
* through all undeleted and confirmed users
|
|
*
|
|
* @global object
|
|
* @uses SITEID
|
|
* @uses SQL_PARAMS_NAMED
|
|
* @uses CONTEXT_COURSE
|
|
* @param int $courseid The course in question.
|
|
* @param int $groupid The group in question.
|
|
* @param string $searchtext The string to search for
|
|
* @param string $sort A field to sort by
|
|
* @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
|
|
* @return array
|
|
*/
|
|
function search_users($courseid, $groupid, $searchtext, $sort='', array $exceptions=null) {
|
|
global $DB;
|
|
|
|
$LIKE = $DB->sql_ilike();
|
|
$fullname = $DB->sql_fullname('u.firstname', 'u.lastname');
|
|
|
|
if (!empty($exceptions)) {
|
|
list($exceptions, $params) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex0000', false);
|
|
$except = "AND u.id $exceptions";
|
|
} else {
|
|
$except = "";
|
|
$params = array();
|
|
}
|
|
|
|
if (!empty($sort)) {
|
|
$order = "ORDER BY $sort";
|
|
} else {
|
|
$order = "";
|
|
}
|
|
|
|
$select = "u.deleted = 0 AND u.confirmed = 1 AND ($fullname $LIKE :search1 OR u.email $LIKE :search2)";
|
|
$params['search1'] = "%$searchtext%";
|
|
$params['search2'] = "%$searchtext%";
|
|
|
|
if (!$courseid or $courseid == SITEID) {
|
|
$sql = "SELECT u.id, u.firstname, u.lastname, u.email
|
|
FROM {user} u
|
|
WHERE $select
|
|
$except
|
|
$order";
|
|
return $DB->get_records_sql($sql, $params);
|
|
|
|
} else {
|
|
if ($groupid) {
|
|
$sql = "SELECT u.id, u.firstname, u.lastname, u.email
|
|
FROM {user} u
|
|
JOIN {groups_members} gm ON gm.userid = u.id
|
|
WHERE $select AND gm.groupid = :groupid
|
|
$except
|
|
$order";
|
|
$params['groupid'] = $groupid;
|
|
return $DB->get_records_sql($sql, $params);
|
|
|
|
} else {
|
|
$context = get_context_instance(CONTEXT_COURSE, $courseid);
|
|
$contextlists = get_related_contexts_string($context);
|
|
|
|
$sql = "SELECT u.id, u.firstname, u.lastname, u.email
|
|
FROM {user} u
|
|
JOIN {role_assignments} ra ON ra.userid = u.id
|
|
WHERE $select AND ra.contextid $contextlists
|
|
$except
|
|
$order";
|
|
return $DB->get_records_sql($sql, $params);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a subset of users
|
|
*
|
|
* @global object
|
|
* @uses DEBUG_DEVELOPER
|
|
* @uses SQL_PARAMS_NAMED
|
|
* @param bool $get If false then only a count of the records is returned
|
|
* @param string $search A simple string to search for
|
|
* @param bool $confirmed A switch to allow/disallow unconfirmed users
|
|
* @param array $exceptions A list of IDs to ignore, eg 2,4,5,8,9,10
|
|
* @param string $sort A SQL snippet for the sorting criteria to use
|
|
* @param string $firstinitial Users whose first name starts with $firstinitial
|
|
* @param string $lastinitial Users whose last name starts with $lastinitial
|
|
* @param string $page The page or records to return
|
|
* @param string $recordsperpage The number of records to return per page
|
|
* @param string $fields A comma separated list of fields to be returned from the chosen table.
|
|
* @return array|int|bool {@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.
|
|
*/
|
|
function get_users($get=true, $search='', $confirmed=false, array $exceptions=null, $sort='firstname ASC',
|
|
$firstinitial='', $lastinitial='', $page='', $recordsperpage='', $fields='*', $extraselect='', array $extraparams=null) {
|
|
global $DB;
|
|
|
|
if ($get && !$recordsperpage) {
|
|
debugging('Call to get_users with $get = true no $recordsperpage limit. ' .
|
|
'On large installations, this will probably cause an out of memory error. ' .
|
|
'Please think again and change your code so that it does not try to ' .
|
|
'load so much data into memory.', DEBUG_DEVELOPER);
|
|
}
|
|
|
|
$LIKE = $DB->sql_ilike();
|
|
$fullname = $DB->sql_fullname();
|
|
|
|
$select = " username <> :guest AND deleted = 0";
|
|
$params = array('guest'=>'guest');
|
|
|
|
if (!empty($search)){
|
|
$search = trim($search);
|
|
$select .= " AND ($fullname $LIKE :search1 OR email $LIKE :search2 OR username = :search3)";
|
|
$params['search1'] = "%$search%";
|
|
$params['search2'] = "%$search%";
|
|
$params['search3'] = "$search";
|
|
}
|
|
|
|
if ($confirmed) {
|
|
$select .= " AND confirmed = 1";
|
|
}
|
|
|
|
if ($exceptions) {
|
|
list($exceptions, $eparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'ex0000', false);
|
|
$params = $params + $eparams;
|
|
$except = " AND id $exceptions";
|
|
}
|
|
|
|
if ($firstinitial) {
|
|
$select .= " AND firstname $LIKE :fni";
|
|
$params['fni'] = "$firstinitial%";
|
|
}
|
|
if ($lastinitial) {
|
|
$select .= " AND lastname $LIKE :lni";
|
|
$params['lni'] = "$lastinitial%";
|
|
}
|
|
|
|
if ($extraselect) {
|
|
$select .= " AND $extraselect";
|
|
$params = $params + (array)$extraparams;
|
|
}
|
|
|
|
if ($get) {
|
|
return $DB->get_records_select('user', $select, $params, $sort, $fields, $page, $recordsperpage);
|
|
} else {
|
|
return $DB->count_records_select('user', $select, $params);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @todo Finish documenting this function
|
|
*
|
|
* @param string $sort An SQL field to sort by
|
|
* @param string $dir The sort direction ASC|DESC
|
|
* @param int $page The page or records to return
|
|
* @param int $recordsperpage The number of records to return per page
|
|
* @param string $search A simple string to search for
|
|
* @param string $firstinitial Users whose first name starts with $firstinitial
|
|
* @param string $lastinitial Users whose last name starts with $lastinitial
|
|
* @param string $extraselect An additional SQL select statement to append to the query
|
|
* @param array $extraparams Additional parameters to use for the above $extraselect
|
|
* @return array Array of {@link $USER} records
|
|
*/
|
|
|
|
function get_users_listing($sort='lastaccess', $dir='ASC', $page=0, $recordsperpage=0,
|
|
$search='', $firstinitial='', $lastinitial='', $extraselect='', array $extraparams=null) {
|
|
global $DB;
|
|
|
|
$LIKE = $DB->sql_ilike();
|
|
$fullname = $DB->sql_fullname();
|
|
|
|
$select = "deleted <> 1";
|
|
$params = array();
|
|
|
|
if (!empty($search)) {
|
|
$search = trim($search);
|
|
$select .= " AND ($fullname $LIKE :search1 OR email $LIKE :search2 OR username = :search3)";
|
|
$params['search1'] = "%$search%";
|
|
$params['search2'] = "%$search%";
|
|
$params['search3'] = "$search";
|
|
}
|
|
|
|
if ($firstinitial) {
|
|
$select .= " AND firstname $LIKE :fni";
|
|
$params['fni'] = "$firstinitial%";
|
|
}
|
|
if ($lastinitial) {
|
|
$select .= " AND lastname $LIKE :lni";
|
|
$params['lni'] = "$lastinitial%";
|
|
}
|
|
|
|
if ($extraselect) {
|
|
$select .= " AND $extraselect";
|
|
$params = $params + (array)$extraparams;
|
|
}
|
|
|
|
if ($sort) {
|
|
$sort = " ORDER BY $sort $dir";
|
|
}
|
|
|
|
/// warning: will return UNCONFIRMED USERS
|
|
return $DB->get_records_sql("SELECT id, username, email, firstname, lastname, city, country, lastaccess, confirmed, mnethostid
|
|
FROM {user}
|
|
WHERE $select
|
|
$sort", $params, $page, $recordsperpage);
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Full list of users that have confirmed their accounts.
|
|
*
|
|
* @global object
|
|
* @return array of unconfirmed users
|
|
*/
|
|
function get_users_confirmed() {
|
|
global $DB;
|
|
return $DB->get_records_sql("SELECT *
|
|
FROM {user}
|
|
WHERE confirmed = 1 AND deleted = 0 AND username <> ?", array('guest'));
|
|
}
|
|
|
|
|
|
/// OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////
|
|
|
|
|
|
/**
|
|
* Returns $course object of the top-level site.
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @return bool|object A {@link $COURSE} object for the site
|
|
*/
|
|
function get_site() {
|
|
global $SITE, $DB;
|
|
|
|
if (!empty($SITE->id)) { // We already have a global to use, so return that
|
|
return $SITE;
|
|
}
|
|
|
|
if ($course = $DB->get_record('course', array('category'=>0))) {
|
|
return $course;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns list of courses, for whole site, or category
|
|
*
|
|
* Returns list of courses, for whole site, or category
|
|
* Important: Using c.* for fields is extremely expensive because
|
|
* we are using distinct. You almost _NEVER_ need all the fields
|
|
* in such a large SELECT
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @global object
|
|
* @uses CONTEXT_COURSE
|
|
* @param string|int $categoryid Either a category id or 'all' for everything
|
|
* @param string $sort A field and direction to sort by
|
|
* @param string $fields The additional fields to return
|
|
* @return array Array of courses
|
|
*/
|
|
function get_courses($categoryid="all", $sort="c.sortorder ASC", $fields="c.*") {
|
|
|
|
global $USER, $CFG, $DB;
|
|
|
|
$params = array();
|
|
|
|
if ($categoryid !== "all" && is_numeric($categoryid)) {
|
|
$categoryselect = "WHERE c.category = :catid";
|
|
$params['catid'] = $categoryid;
|
|
} else {
|
|
$categoryselect = "";
|
|
}
|
|
|
|
if (empty($sort)) {
|
|
$sortstatement = "";
|
|
} else {
|
|
$sortstatement = "ORDER BY $sort";
|
|
}
|
|
|
|
$visiblecourses = array();
|
|
|
|
$sql = "SELECT $fields,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course} c
|
|
JOIN {context} ctx
|
|
ON (c.id = ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
|
|
$categoryselect
|
|
$sortstatement";
|
|
|
|
// pull out all course matching the cat
|
|
if ($courses = $DB->get_records_sql($sql, $params)) {
|
|
|
|
// loop throught them
|
|
foreach ($courses as $course) {
|
|
$course = make_context_subobj($course);
|
|
if (isset($course->visible) && $course->visible <= 0) {
|
|
// for hidden courses, require visibility check
|
|
if (has_capability('moodle/course:viewhiddencourses', $course->context)) {
|
|
$visiblecourses [$course->id] = $course;
|
|
}
|
|
} else {
|
|
$visiblecourses [$course->id] = $course;
|
|
}
|
|
}
|
|
}
|
|
return $visiblecourses;
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns list of courses, for whole site, or category
|
|
*
|
|
* Similar to get_courses, but allows paging
|
|
* Important: Using c.* for fields is extremely expensive because
|
|
* we are using distinct. You almost _NEVER_ need all the fields
|
|
* in such a large SELECT
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @global object
|
|
* @uses CONTEXT_COURSE
|
|
* @param string|int $categoryid Either a category id or 'all' for everything
|
|
* @param string $sort A field and direction to sort by
|
|
* @param string $fields The additional fields to return
|
|
* @param int $totalcount Reference for the number of courses
|
|
* @param string $limitfrom The course to start from
|
|
* @param string $limitnum The number of courses to limit to
|
|
* @return array Array of courses
|
|
*/
|
|
function get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",
|
|
&$totalcount, $limitfrom="", $limitnum="") {
|
|
global $USER, $CFG, $DB;
|
|
|
|
$params = array();
|
|
|
|
$categoryselect = "";
|
|
if ($categoryid != "all" && is_numeric($categoryid)) {
|
|
$categoryselect = "WHERE c.category = :catid";
|
|
$params['catid'] = $categoryid;
|
|
} else {
|
|
$categoryselect = "";
|
|
}
|
|
|
|
$sql = "SELECT $fields,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course} c
|
|
JOIN {context} ctx
|
|
ON (c.id = ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
|
|
$categoryselect
|
|
ORDER BY $sort";
|
|
|
|
// pull out all course matching the cat
|
|
if (!$rs = $DB->get_recordset_sql($sql, $params)) {
|
|
return array();
|
|
}
|
|
$totalcount = 0;
|
|
|
|
if (!$limitfrom) {
|
|
$limitfrom = 0;
|
|
}
|
|
|
|
// iteration will have to be done inside loop to keep track of the limitfrom and limitnum
|
|
$visiblecourses = array();
|
|
foreach($rs as $course) {
|
|
$course = make_context_subobj($course);
|
|
if ($course->visible <= 0) {
|
|
// for hidden courses, require visibility check
|
|
if (has_capability('moodle/course:viewhiddencourses', $course->context)) {
|
|
$totalcount++;
|
|
if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
|
|
$visiblecourses [$course->id] = $course;
|
|
}
|
|
}
|
|
} else {
|
|
$totalcount++;
|
|
if ($totalcount > $limitfrom && (!$limitnum or count($visiblecourses) < $limitnum)) {
|
|
$visiblecourses [$course->id] = $course;
|
|
}
|
|
}
|
|
}
|
|
$rs->close();
|
|
return $visiblecourses;
|
|
}
|
|
|
|
/**
|
|
* Retrieve course records with the course managers and other related records
|
|
* that we need for print_course(). This allows print_courses() to do its job
|
|
* in a constant number of DB queries, regardless of the number of courses,
|
|
* role assignments, etc.
|
|
*
|
|
* The returned array is indexed on c.id, and each course will have
|
|
* - $course->context - a context obj
|
|
* - $course->managers - array containing RA objects that include a $user obj
|
|
* with the minimal fields needed for fullname()
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @global object
|
|
* @uses CONTEXT_COURSE
|
|
* @uses CONTEXT_SYSTEM
|
|
* @uses CONTEXT_COURSECAT
|
|
* @uses SITEID
|
|
* @param int|string $categoryid Either the categoryid for the courses or 'all'
|
|
* @param string $sort A SQL sort field and direction
|
|
* @param array $fields An array of additional fields to fetch
|
|
* @return array
|
|
*/
|
|
function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
|
|
/*
|
|
* The plan is to
|
|
*
|
|
* - Grab the courses JOINed w/context
|
|
*
|
|
* - Grab the interesting course-manager RAs
|
|
* JOINed with a base user obj and add them to each course
|
|
*
|
|
* So as to do all the work in 2 DB queries. The RA+user JOIN
|
|
* ends up being pretty expensive if it happens over _all_
|
|
* courses on a large site. (Are we surprised!?)
|
|
*
|
|
* So this should _never_ get called with 'all' on a large site.
|
|
*
|
|
*/
|
|
global $USER, $CFG, $DB;
|
|
|
|
$params = array();
|
|
$allcats = false; // bool flag
|
|
if ($categoryid === 'all') {
|
|
$categoryclause = '';
|
|
$allcats = true;
|
|
} elseif (is_numeric($categoryid)) {
|
|
$categoryclause = "c.category = :catid";
|
|
$params['catid'] = $categoryid;
|
|
} else {
|
|
debugging("Could not recognise categoryid = $categoryid");
|
|
$categoryclause = '';
|
|
}
|
|
|
|
$basefields = array('id', 'category', 'sortorder',
|
|
'shortname', 'fullname', 'idnumber',
|
|
'guest', 'startdate', 'visible',
|
|
'newsitems', 'cost', 'enrol',
|
|
'groupmode', 'groupmodeforce');
|
|
|
|
if (!is_null($fields) && is_string($fields)) {
|
|
if (empty($fields)) {
|
|
$fields = $basefields;
|
|
} else {
|
|
// turn the fields from a string to an array that
|
|
// get_user_courses_bycap() will like...
|
|
$fields = explode(',',$fields);
|
|
$fields = array_map('trim', $fields);
|
|
$fields = array_unique(array_merge($basefields, $fields));
|
|
}
|
|
} elseif (is_array($fields)) {
|
|
$fields = array_merge($basefields,$fields);
|
|
}
|
|
$coursefields = 'c.' .join(',c.', $fields);
|
|
|
|
if (empty($sort)) {
|
|
$sortstatement = "";
|
|
} else {
|
|
$sortstatement = "ORDER BY $sort";
|
|
}
|
|
|
|
$where = 'WHERE c.id != ' . SITEID;
|
|
if ($categoryclause !== ''){
|
|
$where = "$where AND $categoryclause";
|
|
}
|
|
|
|
// pull out all courses matching the cat
|
|
$sql = "SELECT $coursefields,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course} c
|
|
JOIN {context} ctx
|
|
ON (c.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
|
|
$where
|
|
$sortstatement";
|
|
|
|
$catpaths = array();
|
|
$catpath = NULL;
|
|
if ($courses = $DB->get_records_sql($sql, $params)) {
|
|
// loop on courses materialising
|
|
// the context, and prepping data to fetch the
|
|
// managers efficiently later...
|
|
foreach ($courses as $k => $course) {
|
|
$courses[$k] = make_context_subobj($courses[$k]);
|
|
$courses[$k]->managers = array();
|
|
if ($allcats === false) {
|
|
// single cat, so take just the first one...
|
|
if ($catpath === NULL) {
|
|
$catpath = preg_replace(':/\d+$:', '',$courses[$k]->context->path);
|
|
}
|
|
} else {
|
|
// chop off the contextid of the course itself
|
|
// like dirname() does...
|
|
$catpaths[] = preg_replace(':/\d+$:', '',$courses[$k]->context->path);
|
|
}
|
|
}
|
|
} else {
|
|
return array(); // no courses!
|
|
}
|
|
|
|
$CFG->coursemanager = trim($CFG->coursemanager);
|
|
if (empty($CFG->coursemanager)) {
|
|
return $courses;
|
|
}
|
|
|
|
$managerroles = split(',', $CFG->coursemanager);
|
|
$catctxids = '';
|
|
if (count($managerroles)) {
|
|
if ($allcats === true) {
|
|
$catpaths = array_unique($catpaths);
|
|
$ctxids = array();
|
|
foreach ($catpaths as $cpath) {
|
|
$ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
|
|
}
|
|
$ctxids = array_unique($ctxids);
|
|
$catctxids = implode( ',' , $ctxids);
|
|
unset($catpaths);
|
|
unset($cpath);
|
|
} else {
|
|
// take the ctx path from the first course
|
|
// as all categories will be the same...
|
|
$catpath = substr($catpath,1);
|
|
$catpath = preg_replace(':/\d+$:','',$catpath);
|
|
$catctxids = str_replace('/',',',$catpath);
|
|
}
|
|
if ($categoryclause !== '') {
|
|
$categoryclause = "AND $categoryclause";
|
|
}
|
|
/*
|
|
* Note: Here we use a LEFT OUTER JOIN that can
|
|
* "optionally" match to avoid passing a ton of context
|
|
* ids in an IN() clause. Perhaps a subselect is faster.
|
|
*
|
|
* In any case, this SQL is not-so-nice over large sets of
|
|
* courses with no $categoryclause.
|
|
*
|
|
*/
|
|
$sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
|
|
ra.hidden,
|
|
r.id AS roleid, r.name as rolename,
|
|
u.id AS userid, u.firstname, u.lastname
|
|
FROM {role_assignments} ra
|
|
JOIN {context} ctx ON ra.contextid = ctx.id
|
|
JOIN {user} u ON ra.userid = u.id
|
|
JOIN {role} r ON ra.roleid = r.id
|
|
LEFT OUTER JOIN {course} c
|
|
ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
|
|
WHERE ( c.id IS NOT NULL";
|
|
// under certain conditions, $catctxids is NULL
|
|
if($catctxids == NULL){
|
|
$sql .= ") ";
|
|
}else{
|
|
$sql .= " OR ra.contextid IN ($catctxids) )";
|
|
}
|
|
|
|
$sql .= "AND ra.roleid IN ({$CFG->coursemanager})
|
|
$categoryclause
|
|
ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
|
|
$rs = $DB->get_recordset_sql($sql, $params);
|
|
|
|
// This loop is fairly stupid as it stands - might get better
|
|
// results doing an initial pass clustering RAs by path.
|
|
foreach($rs as $ra) {
|
|
$user = new StdClass;
|
|
$user->id = $ra->userid; unset($ra->userid);
|
|
$user->firstname = $ra->firstname; unset($ra->firstname);
|
|
$user->lastname = $ra->lastname; unset($ra->lastname);
|
|
$ra->user = $user;
|
|
if ($ra->contextlevel == CONTEXT_SYSTEM) {
|
|
foreach ($courses as $k => $course) {
|
|
$courses[$k]->managers[] = $ra;
|
|
}
|
|
} elseif ($ra->contextlevel == CONTEXT_COURSECAT) {
|
|
if ($allcats === false) {
|
|
// It always applies
|
|
foreach ($courses as $k => $course) {
|
|
$courses[$k]->managers[] = $ra;
|
|
}
|
|
} else {
|
|
foreach ($courses as $k => $course) {
|
|
// Note that strpos() returns 0 as "matched at pos 0"
|
|
if (strpos($course->context->path, $ra->path.'/')===0) {
|
|
// Only add it to subpaths
|
|
$courses[$k]->managers[] = $ra;
|
|
}
|
|
}
|
|
}
|
|
} else { // course-level
|
|
if(!array_key_exists($ra->instanceid, $courses)) {
|
|
//this course is not in a list, probably a frontpage course
|
|
continue;
|
|
}
|
|
$courses[$ra->instanceid]->managers[] = $ra;
|
|
}
|
|
}
|
|
$rs->close();
|
|
}
|
|
|
|
return $courses;
|
|
}
|
|
|
|
/**
|
|
* Convenience function - lists courses that a user has access to view.
|
|
*
|
|
* For admins and others with access to "every" course in the system, we should
|
|
* try to get courses with explicit RAs.
|
|
*
|
|
* NOTE: this function is heavily geared towards the perspective of the user
|
|
* passed in $userid. So it will hide courses that the user cannot see
|
|
* (for any reason) even if called from cron or from another $USER's
|
|
* perspective.
|
|
*
|
|
* If you really want to know what courses are assigned to the user,
|
|
* without any hiding or scheming, call the lower-level
|
|
* get_user_courses_bycap().
|
|
*
|
|
*
|
|
* Notes inherited from get_user_courses_bycap():
|
|
*
|
|
* - $fields is an array of fieldnames to ADD
|
|
* so name the fields you really need, which will
|
|
* be added and uniq'd
|
|
*
|
|
* - the course records have $c->context which is a fully
|
|
* valid context object. Saves you a query per course!
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @global object
|
|
* @uses CONTEXT_SYSTEM
|
|
* @uses CONTEXT_COURSE
|
|
* @uses CONTEXT_COURSECAT
|
|
* @param int $userid The user of interest
|
|
* @param string $sort the sortorder in the course table
|
|
* @param array $fields names of _additional_ fields to return (also accepts a string)
|
|
* @param bool $doanything True if using the doanything flag
|
|
* @param int $limit Maximum number of records to return, or 0 for unlimited
|
|
* @return array Array of {@link $COURSE} of course objects
|
|
*/
|
|
function get_my_courses($userid, $sort='visible DESC,sortorder ASC', $fields=NULL, $doanything=false,$limit=0) {
|
|
global $CFG, $USER, $DB;
|
|
|
|
// Guest's do not have any courses
|
|
$sitecontext = get_context_instance(CONTEXT_SYSTEM);
|
|
if (has_capability('moodle/legacy:guest', $sitecontext, $userid, false)) {
|
|
return(array());
|
|
}
|
|
|
|
$basefields = array('id', 'category', 'sortorder',
|
|
'shortname', 'fullname', 'idnumber',
|
|
'guest', 'startdate', 'visible',
|
|
'newsitems', 'cost', 'enrol',
|
|
'groupmode', 'groupmodeforce');
|
|
|
|
if (!is_null($fields) && is_string($fields)) {
|
|
if (empty($fields)) {
|
|
$fields = $basefields;
|
|
} else {
|
|
// turn the fields from a string to an array that
|
|
// get_user_courses_bycap() will like...
|
|
$fields = explode(',',$fields);
|
|
$fields = array_map('trim', $fields);
|
|
$fields = array_unique(array_merge($basefields, $fields));
|
|
}
|
|
} elseif (is_array($fields)) {
|
|
$fields = array_unique(array_merge($basefields, $fields));
|
|
} else {
|
|
$fields = $basefields;
|
|
}
|
|
|
|
$orderby = '';
|
|
$sort = trim($sort);
|
|
if (!empty($sort)) {
|
|
$rawsorts = explode(',', $sort);
|
|
$sorts = array();
|
|
foreach ($rawsorts as $rawsort) {
|
|
$rawsort = trim($rawsort);
|
|
if (strpos($rawsort, 'c.') === 0) {
|
|
$rawsort = substr($rawsort, 2);
|
|
}
|
|
$sorts[] = trim($rawsort);
|
|
}
|
|
$sort = 'c.'.implode(',c.', $sorts);
|
|
$orderby = "ORDER BY $sort";
|
|
}
|
|
|
|
//
|
|
// Logged-in user - Check cached courses
|
|
//
|
|
// NOTE! it's a _string_ because
|
|
// - it's all we'll ever use
|
|
// - it serialises much more compact than an array
|
|
// this a big concern here - cost of serialise
|
|
// and unserialise gets huge as the session grows
|
|
//
|
|
// If the courses are too many - it won't be set
|
|
// for large numbers of courses, caching in the session
|
|
// has marginal benefits (costs too much, not
|
|
// worthwhile...) and we may hit SQL parser limits
|
|
// because we use IN()
|
|
//
|
|
if ($userid === $USER->id) {
|
|
if (isset($USER->loginascontext)
|
|
&& $USER->loginascontext->contextlevel == CONTEXT_COURSE) {
|
|
// list _only_ this course
|
|
// anything else is asking for trouble...
|
|
$courseids = $USER->loginascontext->instanceid;
|
|
} elseif (isset($USER->mycourses)
|
|
&& is_string($USER->mycourses)) {
|
|
if ($USER->mycourses === '') {
|
|
// empty str means: user has no courses
|
|
// ... so do the easy thing...
|
|
return array();
|
|
} else {
|
|
$courseids = $USER->mycourses;
|
|
}
|
|
}
|
|
if (isset($courseids)) {
|
|
// The data massaging here MUST be kept in sync with
|
|
// get_user_courses_bycap() so we return
|
|
// the same...
|
|
// (but here we don't need to check has_cap)
|
|
$coursefields = 'c.' .join(',c.', $fields);
|
|
$sql = "SELECT $coursefields,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth as ctxdepth, ctx.contextlevel AS ctxlevel,
|
|
cc.path AS categorypath
|
|
FROM {course} c
|
|
JOIN {course_categories} cc ON c.category=cc.id
|
|
JOIN {context} ctx
|
|
ON (c.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
|
|
WHERE c.id IN ($courseids)
|
|
$orderby";
|
|
$rs = $DB->get_recordset_sql($sql);
|
|
$courses = array();
|
|
$cc = 0; // keep count
|
|
foreach ($rs as $c) {
|
|
// build the context obj
|
|
$c = make_context_subobj($c);
|
|
|
|
$courses[$c->id] = $c;
|
|
if ($limit > 0 && $cc++ > $limit) {
|
|
break;
|
|
}
|
|
}
|
|
$rs->close();
|
|
return $courses;
|
|
}
|
|
}
|
|
|
|
// Non-cached - get accessinfo
|
|
if ($userid === $USER->id && isset($USER->access)) {
|
|
$accessinfo = $USER->access;
|
|
} else {
|
|
$accessinfo = get_user_access_sitewide($userid);
|
|
}
|
|
|
|
|
|
$courses = get_user_courses_bycap($userid, 'moodle/course:view', $accessinfo,
|
|
$doanything, $sort, $fields,
|
|
$limit);
|
|
|
|
$cats = NULL;
|
|
// If we have to walk category visibility
|
|
// to eval course visibility, get the categories
|
|
if (empty($CFG->allowvisiblecoursesinhiddencategories)) {
|
|
$sql = "SELECT cc.id, cc.path, cc.visible,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth as ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course_categories} cc
|
|
JOIN {context} ctx ON (cc.id = ctx.instanceid)
|
|
WHERE ctx.contextlevel = ".CONTEXT_COURSECAT."
|
|
ORDER BY cc.id";
|
|
$rs = $DB->get_recordset_sql($sql);
|
|
|
|
// Using a temporary array instead of $cats here, to avoid a "true" result when isnull($cats) further down
|
|
$categories = array();
|
|
foreach($rs as $course_cat) {
|
|
// build the context obj
|
|
$course_cat = make_context_subobj($course_cat);
|
|
$categories[$course_cat->id] = $course_cat;
|
|
}
|
|
$rs->close();
|
|
|
|
if (!empty($categories)) {
|
|
$cats = $categories;
|
|
}
|
|
|
|
unset($course_cat);
|
|
}
|
|
//
|
|
// Strangely, get_my_courses() is expected to return the
|
|
// array keyed on id, which messes up the sorting
|
|
// So do that, and also cache the ids in the session if appropriate
|
|
//
|
|
$kcourses = array();
|
|
$courses_count = count($courses);
|
|
$cacheids = NULL;
|
|
$vcatpaths = array();
|
|
if ($userid === $USER->id && $courses_count < 500) {
|
|
$cacheids = array();
|
|
}
|
|
for ($n=0; $n<$courses_count; $n++) {
|
|
|
|
//
|
|
// Check whether $USER (not $userid) can _actually_ see them
|
|
// Easy if $CFG->allowvisiblecoursesinhiddencategories
|
|
// is set, and we don't have to care about categories.
|
|
// Lots of work otherwise... (all in mem though!)
|
|
//
|
|
$cansee = false;
|
|
if (is_null($cats)) { // easy rules!
|
|
if ($courses[$n]->visible == true) {
|
|
$cansee = true;
|
|
} elseif (has_capability('moodle/course:viewhiddencourses',
|
|
$courses[$n]->context, $USER->id)) {
|
|
$cansee = true;
|
|
}
|
|
} else {
|
|
//
|
|
// Is the cat visible?
|
|
// we have to assume it _is_ visible
|
|
// so we can shortcut when we find a hidden one
|
|
//
|
|
$viscat = true;
|
|
$cpath = $courses[$n]->categorypath;
|
|
if (isset($vcatpaths[$cpath])) {
|
|
$viscat = $vcatpaths[$cpath];
|
|
} else {
|
|
$cpath = substr($cpath,1); // kill leading slash
|
|
$cpath = explode('/',$cpath);
|
|
$ccct = count($cpath);
|
|
for ($m=0;$m<$ccct;$m++) {
|
|
$ccid = $cpath[$m];
|
|
if ($cats[$ccid]->visible==false) {
|
|
$viscat = false;
|
|
break;
|
|
}
|
|
}
|
|
$vcatpaths[$courses[$n]->categorypath] = $viscat;
|
|
}
|
|
|
|
//
|
|
// Perhaps it's actually visible to $USER
|
|
// check moodle/category:viewhiddencategories
|
|
//
|
|
// The name isn't obvious, but the description says
|
|
// "See hidden categories" so the user shall see...
|
|
// But also check if the allowvisiblecoursesinhiddencategories setting is true, and check for course visibility
|
|
if ($viscat === false) {
|
|
$catctx = $cats[$courses[$n]->category]->context;
|
|
if (has_capability('moodle/category:viewhiddencategories', $catctx, $USER->id)) {
|
|
$vcatpaths[$courses[$n]->categorypath] = true;
|
|
$viscat = true;
|
|
} elseif ($CFG->allowvisiblecoursesinhiddencategories && $courses[$n]->visible == true) {
|
|
$viscat = true;
|
|
}
|
|
}
|
|
|
|
//
|
|
// Decision matrix
|
|
//
|
|
if ($viscat === true) {
|
|
if ($courses[$n]->visible == true) {
|
|
$cansee = true;
|
|
} elseif (has_capability('moodle/course:viewhiddencourses',
|
|
$courses[$n]->context, $USER->id)) {
|
|
$cansee = true;
|
|
}
|
|
}
|
|
}
|
|
if ($cansee === true) {
|
|
$kcourses[$courses[$n]->id] = $courses[$n];
|
|
if (is_array($cacheids)) {
|
|
$cacheids[] = $courses[$n]->id;
|
|
}
|
|
}
|
|
}
|
|
if (is_array($cacheids)) {
|
|
// Only happens
|
|
// - for the logged in user
|
|
// - below the threshold (500)
|
|
// empty string is _valid_
|
|
$USER->mycourses = join(',',$cacheids);
|
|
} elseif ($userid === $USER->id && isset($USER->mycourses)) {
|
|
// cheap sanity check
|
|
unset($USER->mycourses);
|
|
}
|
|
|
|
return $kcourses;
|
|
}
|
|
|
|
/**
|
|
* A list of courses that match a search
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @param array $searchterms An array of search criteria
|
|
* @param string $sort A field and direction to sort by
|
|
* @param int $page The page number to get
|
|
* @param int $recordsperpage The number of records per page
|
|
* @param int $totalcount Passed in by reference.
|
|
* @return object {@link $COURSE} records
|
|
*/
|
|
function get_courses_search($searchterms, $sort='fullname ASC', $page=0, $recordsperpage=50, &$totalcount) {
|
|
global $CFG, $DB;
|
|
|
|
if ($DB->sql_regex_supported()) {
|
|
$REGEXP = $DB->sql_regex(true);
|
|
$NOTREGEXP = $DB->sql_regex(false);
|
|
}
|
|
$LIKE = $DB->sql_ilike(); // case-insensitive
|
|
|
|
$searchcond = array();
|
|
$params = array();
|
|
$i = 0;
|
|
|
|
$concat = $DB->sql_concat('c.summary', "' '", 'c.fullname');
|
|
|
|
foreach ($searchterms as $searchterm) {
|
|
$i++;
|
|
|
|
$NOT = ''; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
|
|
/// will use it to simulate the "-" operator with LIKE clause
|
|
|
|
/// Under Oracle and MSSQL, trim the + and - operators and perform
|
|
/// simpler LIKE (or NOT LIKE) queries
|
|
if (!$DB->sql_regex_supported()) {
|
|
if (substr($searchterm, 0, 1) == '-') {
|
|
$NOT = ' NOT ';
|
|
}
|
|
$searchterm = trim($searchterm, '+-');
|
|
}
|
|
|
|
// TODO: +- may not work for non latin languages
|
|
|
|
if (substr($searchterm,0,1) == '+') {
|
|
$searchterm = trim($searchterm, '+-');
|
|
$searchterm = preg_quote($searchterm, '|');
|
|
$searchcond[] = "$concat $REGEXP :ss$i";
|
|
$params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
|
|
|
|
} else if (substr($searchterm,0,1) == "-") {
|
|
$searchterm = trim($searchterm, '+-');
|
|
$searchterm = preg_quote($searchterm, '|');
|
|
$searchcond[] = "$concat $NOTREGEXP :ss$i";
|
|
$params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
|
|
|
|
} else {
|
|
$searchcond[] = "$concat $NOT $LIKE :ss$i";
|
|
$params['ss'.$i] = "%$searchterm%";
|
|
}
|
|
}
|
|
|
|
if (empty($searchcond)) {
|
|
$totalcount = 0;
|
|
return array();
|
|
}
|
|
|
|
$searchcond = implode(" AND ", $searchcond);
|
|
|
|
$sql = "SELECT c.*,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course} c
|
|
JOIN {context} ctx
|
|
ON (c.id = ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
|
|
WHERE $searchcond AND c.id <> ".SITEID."
|
|
ORDER BY $sort";
|
|
$courses = array();
|
|
$c = 0; // counts how many visible courses we've seen
|
|
|
|
if ($rs = $DB->get_recordset_sql($sql, $params)) {
|
|
// Tiki pagination
|
|
$limitfrom = $page * $recordsperpage;
|
|
$limitto = $limitfrom + $recordsperpage;
|
|
|
|
foreach($rs as $course) {
|
|
$course = make_context_subobj($course);
|
|
if ($course->visible || has_capability('moodle/course:viewhiddencourses', $course->context)) {
|
|
// Don't exit this loop till the end
|
|
// we need to count all the visible courses
|
|
// to update $totalcount
|
|
if ($c >= $limitfrom && $c < $limitto) {
|
|
$courses[$course->id] = $course;
|
|
}
|
|
$c++;
|
|
}
|
|
}
|
|
$rs->close();
|
|
}
|
|
|
|
// our caller expects 2 bits of data - our return
|
|
// array, and an updated $totalcount
|
|
$totalcount = $c;
|
|
return $courses;
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns a sorted list of categories. Each category object has a context
|
|
* property that is a context object.
|
|
*
|
|
* When asking for $parent='none' it will return all the categories, regardless
|
|
* of depth. Wheen asking for a specific parent, the default is to return
|
|
* a "shallow" resultset. Pass false to $shallow and it will return all
|
|
* the child categories as well.
|
|
*
|
|
* @global object
|
|
* @uses CONTEXT_COURSECAT
|
|
* @param string $parent The parent category if any
|
|
* @param string $sort the sortorder
|
|
* @param bool $shallow - set to false to get the children too
|
|
* @return array of categories
|
|
*/
|
|
function get_categories($parent='none', $sort=NULL, $shallow=true) {
|
|
global $DB;
|
|
|
|
if ($sort === NULL) {
|
|
$sort = 'ORDER BY cc.sortorder ASC';
|
|
} elseif ($sort ==='') {
|
|
// leave it as empty
|
|
} else {
|
|
$sort = "ORDER BY $sort";
|
|
}
|
|
|
|
if ($parent === 'none') {
|
|
$sql = "SELECT cc.*,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course_categories} cc
|
|
JOIN {context} ctx
|
|
ON cc.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT."
|
|
$sort";
|
|
$params = array();
|
|
|
|
} elseif ($shallow) {
|
|
$sql = "SELECT cc.*,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course_categories} cc
|
|
JOIN {context} ctx
|
|
ON cc.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT."
|
|
WHERE cc.parent=?
|
|
$sort";
|
|
$params = array($parent);
|
|
|
|
} else {
|
|
$sql = "SELECT cc.*,
|
|
ctx.id AS ctxid, ctx.path AS ctxpath,
|
|
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
|
|
FROM {course_categories} cc
|
|
JOIN {context} ctx
|
|
ON cc.id=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT."
|
|
JOIN {course_categories} ccp
|
|
ON (cc.path LIKE ".$DB->sql_concat('ccp.path',"'%'").")
|
|
WHERE ccp.id=?
|
|
$sort";
|
|
$params = array($parent);
|
|
}
|
|
$categories = array();
|
|
|
|
if( $rs = $DB->get_recordset_sql($sql, $params) ){
|
|
foreach($rs as $cat) {
|
|
$cat = make_context_subobj($cat);
|
|
if ($cat->visible || has_capability('moodle/category:viewhiddencategories',$cat->context)) {
|
|
$categories[$cat->id] = $cat;
|
|
}
|
|
}
|
|
$rs->close();
|
|
}
|
|
return $categories;
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns an array of category ids of all the subcategories for a given
|
|
* category.
|
|
*
|
|
* @global object
|
|
* @param int $catid - The id of the category whose subcategories we want to find.
|
|
* @return array of category ids.
|
|
*/
|
|
function get_all_subcategories($catid) {
|
|
global $DB;
|
|
|
|
$subcats = array();
|
|
|
|
if ($categories = $DB->get_records('course_categories', array('parent'=>$catid))) {
|
|
foreach ($categories as $cat) {
|
|
array_push($subcats, $cat->id);
|
|
$subcats = array_merge($subcats, get_all_subcategories($cat->id));
|
|
}
|
|
}
|
|
return $subcats;
|
|
}
|
|
|
|
/**
|
|
* Return specified category, default if given does not exist
|
|
*
|
|
* @global object
|
|
* @uses MAX_COURSES_IN_CATEGORY
|
|
* @uses CONTEXT_COURSECAT
|
|
* @uses SYSCONTEXTID
|
|
* @param int $catid course category id
|
|
* @return object caregory
|
|
*/
|
|
function get_course_category($catid=0) {
|
|
global $DB;
|
|
|
|
$category = false;
|
|
|
|
if (!empty($catid)) {
|
|
$category = $DB->get_record('course_categories', array('id'=>$catid));
|
|
}
|
|
|
|
if (!$category) {
|
|
// the first category is considered default for now
|
|
if ($category = $DB->get_records('course_categories', null, 'sortorder', '*', 0, 1)) {
|
|
$category = reset($category);
|
|
|
|
} else {
|
|
$cat = new object();
|
|
$cat->name = get_string('miscellaneous');
|
|
$cat->depth = 1;
|
|
$cat->sortorder = MAX_COURSES_IN_CATEGORY;
|
|
$cat->timemodified = time();
|
|
$catid = $DB->insert_record('course_categories', $cat);
|
|
// make sure category context exists
|
|
get_context_instance(CONTEXT_COURSECAT, $catid);
|
|
mark_context_dirty('/'.SYSCONTEXTID);
|
|
fix_course_sortorder(); // Required to build course_categories.depth and .path.
|
|
$category = $DB->get_record('course_categories', array('id'=>$catid));
|
|
}
|
|
}
|
|
|
|
return $category;
|
|
}
|
|
|
|
/**
|
|
* Fixes course category and course sortorder, also verifies category and course parents and paths.
|
|
* (circular references are not fixed)
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @uses MAX_COURSES_IN_CATEGORY
|
|
* @uses MAX_COURSE_CATEGORIES
|
|
* @uses SITEID
|
|
* @uses CONTEXT_COURSE
|
|
* @return void
|
|
*/
|
|
function fix_course_sortorder() {
|
|
global $DB, $SITE;
|
|
|
|
//WARNING: this is PHP5 only code!
|
|
|
|
if ($unsorted = $DB->get_records('course_categories', array('sortorder'=>0))) {
|
|
//move all categories that are not sorted yet to the end
|
|
$DB->set_field('course_categories', 'sortorder', MAX_COURSES_IN_CATEGORY*MAX_COURSE_CATEGORIES, array('sortorder'=>0));
|
|
}
|
|
|
|
$allcats = $DB->get_records('course_categories', null, 'sortorder, id', 'id, sortorder, parent, depth, path');
|
|
$topcats = array();
|
|
$brokencats = array();
|
|
foreach ($allcats as $cat) {
|
|
$sortorder = (int)$cat->sortorder;
|
|
if (!$cat->parent) {
|
|
while(isset($topcats[$sortorder])) {
|
|
$sortorder++;
|
|
}
|
|
$topcats[$sortorder] = $cat;
|
|
continue;
|
|
}
|
|
if (!isset($allcats[$cat->parent])) {
|
|
$brokencats[] = $cat;
|
|
continue;
|
|
}
|
|
if (!isset($allcats[$cat->parent]->children)) {
|
|
$allcats[$cat->parent]->children = array();
|
|
}
|
|
while(isset($allcats[$cat->parent]->children[$sortorder])) {
|
|
$sortorder++;
|
|
}
|
|
$allcats[$cat->parent]->children[$sortorder] = $cat;
|
|
}
|
|
unset($allcats);
|
|
|
|
// add broken cats to category tree
|
|
if ($brokencats) {
|
|
$defaultcat = reset($topcats);
|
|
foreach ($brokencats as $cat) {
|
|
$topcats[] = $cat;
|
|
}
|
|
}
|
|
|
|
// now walk recursively the tree and fix any problems found
|
|
$sortorder = 0;
|
|
$fixcontexts = array();
|
|
_fix_course_cats($topcats, $sortorder, 0, 0, '', $fixcontexts);
|
|
|
|
// detect if there are "multiple" frontpage courses and fix them if needed
|
|
$frontcourses = $DB->get_records('course', array('category'=>0), 'id');
|
|
if (count($frontcourses) > 1) {
|
|
if (isset($frontcourses[SITEID])) {
|
|
$frontcourse = $frontcourses[SITEID];
|
|
unset($frontcourses[SITEID]);
|
|
} else {
|
|
$frontcourse = array_shift($frontcourses);
|
|
}
|
|
$defaultcat = reset($topcats);
|
|
foreach ($frontcourses as $course) {
|
|
$DB->set_field('course', 'category', $defaultcat->id, array('id'=>$course->id));
|
|
$context = get_context_instance(CONTEXT_COURSE, $course->id);
|
|
$fixcontexts[$context->id] = $context;
|
|
}
|
|
unset($frontcourses);
|
|
} else {
|
|
$frontcourse = reset($frontcourses);
|
|
}
|
|
|
|
// now fix the paths and depths in context table if needed
|
|
if ($fixcontexts) {
|
|
rebuild_contexts($fixcontexts);
|
|
}
|
|
|
|
// release memory
|
|
unset($topcats);
|
|
unset($brokencats);
|
|
unset($fixcontexts);
|
|
|
|
// fix frontpage course sortorder
|
|
if ($frontcourse->sortorder != 1) {
|
|
$DB->set_field('course', 'sortorder', 1, array('id'=>$frontcourse->id));
|
|
}
|
|
|
|
// now fix the course counts in category records if needed
|
|
$sql = "SELECT cc.id, cc.coursecount, COUNT(c.id) AS newcount
|
|
FROM {course_categories} cc
|
|
LEFT JOIN {course} c ON c.category = cc.id
|
|
GROUP BY cc.id, cc.coursecount
|
|
HAVING cc.coursecount <> COUNT(c.id)";
|
|
|
|
if ($updatecounts = $DB->get_records_sql($sql)) {
|
|
foreach ($updatecounts as $cat) {
|
|
$cat->coursecount = $cat->newcount;
|
|
unset($cat->newcount);
|
|
$DB->update_record_raw('course_categories', $cat, true);
|
|
}
|
|
}
|
|
|
|
// now make sure that sortorders in course table are withing the category sortorder ranges
|
|
$sql = "SELECT DISTINCT cc.id, cc.sortorder
|
|
FROM {course_categories} cc
|
|
JOIN {course} c ON c.category = cc.id
|
|
WHERE c.sortorder < cc.sortorder OR c.sortorder > cc.sortorder + ".MAX_COURSES_IN_CATEGORY;
|
|
|
|
if ($fixcategories = $DB->get_records_sql($sql)) {
|
|
//fix the course sortorder ranges
|
|
foreach ($fixcategories as $cat) {
|
|
$sql = "UPDATE {course}
|
|
SET sortorder = ".$DB->sql_modulo('sortorder', MAX_COURSES_IN_CATEGORY)." + ?
|
|
WHERE category = ?";
|
|
$DB->execute($sql, array($cat->sortorder, $cat->id));
|
|
}
|
|
}
|
|
unset($fixcategories);
|
|
|
|
// categories having courses with sortorder duplicates or having gaps in sortorder
|
|
$sql = "SELECT DISTINCT c1.category AS id , cc.sortorder
|
|
FROM {course} c1
|
|
JOIN {course} c2 ON c1.sortorder = c2.sortorder
|
|
JOIN {course_categories} cc ON (c1.category = cc.id)
|
|
WHERE c1.id <> c2.id";
|
|
$fixcategories = $DB->get_records_sql($sql);
|
|
|
|
$sql = "SELECT cc.id, cc.sortorder, cc.coursecount, MAX(c.sortorder) AS maxsort, MIN(c.sortorder) AS minsort
|
|
FROM {course_categories} cc
|
|
JOIN {course} c ON c.category = cc.id
|
|
GROUP BY cc.id, cc.sortorder, cc.coursecount
|
|
HAVING (MAX(c.sortorder) <> cc.sortorder + cc.coursecount) OR (MIN(c.sortorder) <> cc.sortorder + 1)";
|
|
$gapcategories = $DB->get_records_sql($sql);
|
|
|
|
foreach ($gapcategories as $cat) {
|
|
if (isset($fixcategories[$cat->id])) {
|
|
// duplicates detected already
|
|
|
|
} else if ($cat->minsort == $cat->sortorder and $cat->maxsort == $cat->sortorder + $cat->coursecount - 1) {
|
|
// easy - new course inserted with sortorder 0, the rest is ok
|
|
$sql = "UPDATE {course}
|
|
SET sortorder = sortorder + 1
|
|
WHERE category = ?";
|
|
$DB->execute($sql, array($cat->id));
|
|
|
|
} else {
|
|
// it needs full resorting
|
|
$fixcategories[$cat->id] = $cat;
|
|
}
|
|
}
|
|
unset($gapcategories);
|
|
|
|
// fix course sortorders in problematic categories only
|
|
foreach ($fixcategories as $cat) {
|
|
$i = 1;
|
|
$courses = $DB->get_records('course', array('category'=>$cat->id), 'sortorder ASC, id DESC', 'id, sortorder');
|
|
foreach ($courses as $course) {
|
|
if ($course->sortorder != $cat->sortorder + $i) {
|
|
$course->sortorder = $cat->sortorder + $i;
|
|
$DB->update_record_raw('course', $course, true);
|
|
}
|
|
$i++;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Internal recursive category verification function, do not use directly!
|
|
*
|
|
* @todo Document the arguments of this function better
|
|
*
|
|
* @global object
|
|
* @uses MAX_COURSES_IN_CATEGORY
|
|
* @uses CONTEXT_COURSECAT
|
|
* @param array $children
|
|
* @param int $sortorder
|
|
* @param string $parent
|
|
* @param int $depth
|
|
* @param string $path
|
|
* @param array $fixcontexts
|
|
* @return void
|
|
*/
|
|
function _fix_course_cats($children, &$sortorder, $parent, $depth, $path, &$fixcontexts) {
|
|
global $DB;
|
|
|
|
$depth++;
|
|
|
|
foreach ($children as $cat) {
|
|
$sortorder = $sortorder + MAX_COURSES_IN_CATEGORY;
|
|
$update = false;
|
|
if ($parent != $cat->parent or $depth != $cat->depth or $path.'/'.$cat->id != $cat->path) {
|
|
$cat->parent = $parent;
|
|
$cat->depth = $depth;
|
|
$cat->path = $path.'/'.$cat->id;
|
|
$update = true;
|
|
|
|
// make sure context caches are rebuild and dirty contexts marked
|
|
$context = get_context_instance(CONTEXT_COURSECAT, $cat->id);
|
|
$fixcontexts[$context->id] = $context;
|
|
}
|
|
if ($cat->sortorder != $sortorder) {
|
|
$cat->sortorder = $sortorder;
|
|
$update = true;
|
|
}
|
|
if ($update) {
|
|
$DB->update_record('course_categories', $cat, true);
|
|
}
|
|
if (isset($cat->children)) {
|
|
_fix_course_cats($cat->children, $sortorder, $cat->id, $cat->depth, $cat->path, $fixcontexts);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* List of remote courses that a user has access to via MNET.
|
|
* Works only on the IDP
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @param int @userid The user id to get remote courses for
|
|
* @return array Array of {@link $COURSE} of course objects
|
|
*/
|
|
function get_my_remotecourses($userid=0) {
|
|
global $DB, $USER;
|
|
|
|
if (empty($userid)) {
|
|
$userid = $USER->id;
|
|
}
|
|
|
|
$sql = "SELECT c.id, c.remoteid, c.shortname, c.fullname,
|
|
c.hostid, c.summary, c.cat_name,
|
|
h.name AS hostname
|
|
FROM {mnet_enrol_course} c
|
|
JOIN {mnet_enrol_assignments} a ON c.id=a.courseid
|
|
JOIN {mnet_host} h ON c.hostid=h.id
|
|
WHERE a.userid=?";
|
|
|
|
return $DB->get_records_sql($sql, array($userid));
|
|
}
|
|
|
|
/**
|
|
* List of remote hosts that a user has access to via MNET.
|
|
* Works on the SP
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @return array|bool Array of host objects or false
|
|
*/
|
|
function get_my_remotehosts() {
|
|
global $CFG, $USER;
|
|
|
|
if ($USER->mnethostid == $CFG->mnet_localhost_id) {
|
|
return false; // Return nothing on the IDP
|
|
}
|
|
if (!empty($USER->mnet_foreign_host_array) && is_array($USER->mnet_foreign_host_array)) {
|
|
return $USER->mnet_foreign_host_array;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* This function creates a default separated/connected scale
|
|
*
|
|
* This function creates a default separated/connected scale
|
|
* so there's something in the database. The locations of
|
|
* strings and files is a bit odd, but this is because we
|
|
* need to maintain backward compatibility with many different
|
|
* existing language translations and older sites.
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @return void
|
|
*/
|
|
function make_default_scale() {
|
|
global $CFG, $DB;
|
|
|
|
$defaultscale = NULL;
|
|
$defaultscale->courseid = 0;
|
|
$defaultscale->userid = 0;
|
|
$defaultscale->name = get_string('separateandconnected');
|
|
$defaultscale->scale = get_string('postrating1', 'forum').','.
|
|
get_string('postrating2', 'forum').','.
|
|
get_string('postrating3', 'forum');
|
|
$defaultscale->timemodified = time();
|
|
|
|
/// Read in the big description from the file. Note this is not
|
|
/// HTML (despite the file extension) but Moodle format text.
|
|
$parentlang = get_string('parentlanguage');
|
|
if ($parentlang[0] == '[') {
|
|
$parentlang = '';
|
|
}
|
|
if (is_readable($CFG->dataroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html')) {
|
|
$file = file($CFG->dataroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html');
|
|
} else if (is_readable($CFG->dirroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html')) {
|
|
$file = file($CFG->dirroot .'/lang/'. $CFG->lang .'/help/forum/ratings.html');
|
|
} else if ($parentlang and is_readable($CFG->dataroot .'/lang/'. $parentlang .'/help/forum/ratings.html')) {
|
|
$file = file($CFG->dataroot .'/lang/'. $parentlang .'/help/forum/ratings.html');
|
|
} else if ($parentlang and is_readable($CFG->dirroot .'/lang/'. $parentlang .'/help/forum/ratings.html')) {
|
|
$file = file($CFG->dirroot .'/lang/'. $parentlang .'/help/forum/ratings.html');
|
|
} else if (is_readable($CFG->dirroot .'/lang/en_utf8/help/forum/ratings.html')) {
|
|
$file = file($CFG->dirroot .'/lang/en_utf8/help/forum/ratings.html');
|
|
} else {
|
|
$file = '';
|
|
}
|
|
|
|
$defaultscale->description = implode('', $file);
|
|
|
|
if ($defaultscale->id = $DB->insert_record('scale', $defaultscale)) {
|
|
$DB->execute("UPDATE {forum} SET scale = ?", array($defaultscale->id));
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns a menu of all available scales from the site as well as the given course
|
|
*
|
|
* @global object
|
|
* @param int $courseid The id of the course as found in the 'course' table.
|
|
* @return array
|
|
*/
|
|
function get_scales_menu($courseid=0) {
|
|
global $DB;
|
|
|
|
$sql = "SELECT id, name
|
|
FROM {scale}
|
|
WHERE courseid = 0 or courseid = ?
|
|
ORDER BY courseid ASC, name ASC";
|
|
$params = array($courseid);
|
|
|
|
if ($scales = $DB->get_records_sql_menu($sql, $params)) {
|
|
return $scales;
|
|
}
|
|
|
|
make_default_scale();
|
|
|
|
return $DB->get_records_sql_menu($sql, $params);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Given a set of timezone records, put them in the database, replacing what is there
|
|
*
|
|
* @global object
|
|
* @param array $timezones An array of timezone records
|
|
* @return void
|
|
*/
|
|
function update_timezone_records($timezones) {
|
|
global $DB;
|
|
|
|
/// Clear out all the old stuff
|
|
$DB->delete_records('timezone');
|
|
|
|
/// Insert all the new stuff
|
|
foreach ($timezones as $timezone) {
|
|
if (is_array($timezone)) {
|
|
$timezone = (object)$timezone;
|
|
}
|
|
$DB->insert_record('timezone', $timezone);
|
|
}
|
|
}
|
|
|
|
|
|
/// MODULE FUNCTIONS /////////////////////////////////////////////////
|
|
|
|
/**
|
|
* Just gets a raw list of all modules in a course
|
|
*
|
|
* @global object
|
|
* @param int $courseid The id of the course as found in the 'course' table.
|
|
* @return array
|
|
*/
|
|
function get_course_mods($courseid) {
|
|
global $DB;
|
|
|
|
if (empty($courseid)) {
|
|
return false; // avoid warnings
|
|
}
|
|
|
|
return $DB->get_records_sql("SELECT cm.*, m.name as modname
|
|
FROM {modules} m, {course_modules} cm
|
|
WHERE cm.course = ? AND cm.module = m.id AND m.visible = 1",
|
|
array($courseid)); // no disabled mods
|
|
}
|
|
|
|
|
|
/**
|
|
* Given an id of a course module, finds the coursemodule description
|
|
*
|
|
* @global object
|
|
* @param string $modulename name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
|
|
* @param int $cmid course module id (id in course_modules table)
|
|
* @param int $courseid optional course id for extra validation
|
|
* @param bool $sectionnum include relative section number (0,1,2 ...)
|
|
* @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
|
|
* IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
|
|
* MUST_EXIST means throw exception if no record or multiple records found
|
|
* @return array Array of results
|
|
*/
|
|
function get_coursemodule_from_id($modulename, $cmid, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
|
|
global $DB;
|
|
|
|
$params = array('cmid'=>$cmid);
|
|
|
|
if (!$modulename) {
|
|
if (!$modulename = $DB->get_field_sql("SELECT md.name
|
|
FROM {modules} md
|
|
JOIN {course_modules} cm ON cm.module = md.id
|
|
WHERE cm.id = :cmid", $params, $strictness)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$params['modulename'] = $modulename;
|
|
|
|
$courseselect = "";
|
|
$sectionfield = "";
|
|
$sectionjoin = "";
|
|
|
|
if ($courseid) {
|
|
$courseselect = "AND cm.course = :courseid";
|
|
$params['courseid'] = $courseid;
|
|
}
|
|
|
|
if ($sectionnum) {
|
|
$sectionfield = ", cw.section AS sectionnum";
|
|
$sectionjoin = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
|
|
}
|
|
|
|
$sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
|
|
FROM {course_modules} cm
|
|
JOIN {modules} md ON md.id = cm.module
|
|
JOIN {".$modulename."} m ON m.id = cm.instance
|
|
$sectionjoin
|
|
WHERE cm.id = :cmid AND md.name = :modulename
|
|
$courseselect";
|
|
|
|
return $DB->get_record_sql($sql, $params, $strictness);
|
|
}
|
|
|
|
/**
|
|
* Given an instance number of a module, finds the coursemodule description
|
|
*
|
|
* @global object
|
|
* @param string $modulename name of module type, eg. resource, assignment,...
|
|
* @param int $instance module instance number (id in resource, assignment etc. table)
|
|
* @param int $courseid optional course id for extra validation
|
|
* @param bool $sectionnum include relative section number (0,1,2 ...)
|
|
* @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
|
|
* IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
|
|
* MUST_EXIST means throw exception if no record or multiple records found
|
|
* @return array Array of results
|
|
*/
|
|
function get_coursemodule_from_instance($modulename, $instance, $courseid=0, $sectionnum=false, $strictness=IGNORE_MISSING) {
|
|
global $DB;
|
|
|
|
$params = array('instance'=>$instance, 'modulename'=>$modulename);
|
|
|
|
$courseselect = "";
|
|
$sectionfield = "";
|
|
$sectionjoin = "";
|
|
|
|
if ($courseid) {
|
|
$courseselect = "AND cm.course = :courseid";
|
|
$params['courseid'] = $courseid;
|
|
}
|
|
|
|
if ($sectionnum) {
|
|
$sectionfield = ", cw.section AS sectionnum";
|
|
$sectionjoin = "LEFT JOIN {course_sections} cw ON cw.id = cm.section";
|
|
}
|
|
|
|
$sql = "SELECT cm.*, m.name, md.name AS modname $sectionfield
|
|
FROM {course_modules} cm
|
|
JOIN {modules} md ON md.id = cm.module
|
|
JOIN {".$modulename."} m ON m.id = cm.instance
|
|
$sectionjoin
|
|
WHERE m.id = :instance AND md.name = :modulename
|
|
$courseselect";
|
|
|
|
return $DB->get_record_sql($sql, $params, $strictness);
|
|
}
|
|
|
|
/**
|
|
* Returns all course modules of given activity in course
|
|
*
|
|
* @param string $modulename The module name (forum, quiz, etc.)
|
|
* @param int $courseid The course id to get modules for
|
|
* @param string $extrafields extra fields starting with m.
|
|
* @return array Array of results
|
|
*/
|
|
function get_coursemodules_in_course($modulename, $courseid, $extrafields='') {
|
|
global $DB;
|
|
|
|
if (!empty($extrafields)) {
|
|
$extrafields = ", $extrafields";
|
|
}
|
|
$params = array();
|
|
$params['courseid'] = $courseid;
|
|
$params['modulename'] = $modulename;
|
|
|
|
|
|
return $DB->get_records_sql("SELECT cm.*, m.name, md.name as modname $extrafields
|
|
FROM {course_modules} cm, {modules} md, {".$modulename."} m
|
|
WHERE cm.course = :courseid AND
|
|
cm.instance = m.id AND
|
|
md.name = :modulename AND
|
|
md.id = cm.module", $params);
|
|
}
|
|
|
|
/**
|
|
* Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined
|
|
*
|
|
* Returns an array of all the active instances of a particular
|
|
* module in given courses, sorted in the order they are defined
|
|
* in the course. Returns an empty array on any errors.
|
|
*
|
|
* The returned objects includle the columns cw.section, cm.visible,
|
|
* cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @param string $modulename The name of the module to get instances for
|
|
* @param array $courses an array of course objects.
|
|
* @param int $userid
|
|
* @param int $includeinvisible
|
|
* @return array of module instance objects, including some extra fields from the course_modules
|
|
* and course_sections tables, or an empty array if an error occurred.
|
|
*/
|
|
function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $includeinvisible=false) {
|
|
global $CFG, $DB;
|
|
|
|
$outputarray = array();
|
|
|
|
if (empty($courses) || !is_array($courses) || count($courses) == 0) {
|
|
return $outputarray;
|
|
}
|
|
|
|
list($coursessql, $params) = $DB->get_in_or_equal(array_keys($courses), SQL_PARAMS_NAMED, 'c0');
|
|
$params['modulename'] = $modulename;
|
|
|
|
if (!$rawmods = $DB->get_records_sql("SELECT cm.id AS coursemodule, m.*, cw.section, cm.visible AS visible,
|
|
cm.groupmode, cm.groupingid, cm.groupmembersonly
|
|
FROM {course_modules} cm, {course_sections} cw, {modules} md,
|
|
{".$modulename."} m
|
|
WHERE cm.course $coursessql AND
|
|
cm.instance = m.id AND
|
|
cm.section = cw.id AND
|
|
md.name = :modulename AND
|
|
md.id = cm.module", $params)) {
|
|
return $outputarray;
|
|
}
|
|
|
|
foreach ($courses as $course) {
|
|
$modinfo = get_fast_modinfo($course, $userid);
|
|
|
|
if (empty($modinfo->instances[$modulename])) {
|
|
continue;
|
|
}
|
|
|
|
foreach ($modinfo->instances[$modulename] as $cm) {
|
|
if (!$includeinvisible and !$cm->uservisible) {
|
|
continue;
|
|
}
|
|
if (!isset($rawmods[$cm->id])) {
|
|
continue;
|
|
}
|
|
$instance = $rawmods[$cm->id];
|
|
if (!empty($cm->extra)) {
|
|
$instance->extra = urlencode($cm->extra); // bc compatibility
|
|
}
|
|
$outputarray[] = $instance;
|
|
}
|
|
}
|
|
|
|
return $outputarray;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of all the active instances of a particular module in a given course,
|
|
* sorted in the order they are defined.
|
|
*
|
|
* Returns an array of all the active instances of a particular
|
|
* module in a given course, sorted in the order they are defined
|
|
* in the course. Returns an empty array on any errors.
|
|
*
|
|
* The returned objects includle the columns cw.section, cm.visible,
|
|
* cm.groupmode and cm.groupingid, cm.groupmembersonly, and are indexed by cm.id.
|
|
*
|
|
* Simply calls {@link all_instances_in_courses()} with a single provided course
|
|
*
|
|
* @param string $modulename The name of the module to get instances for
|
|
* @param object $course The course obect.
|
|
* @return array of module instance objects, including some extra fields from the course_modules
|
|
* and course_sections tables, or an empty array if an error occurred.
|
|
* @param int $userid
|
|
* @param int $includeinvisible
|
|
*/
|
|
function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {
|
|
return get_all_instances_in_courses($modulename, array($course->id => $course), $userid, $includeinvisible);
|
|
}
|
|
|
|
|
|
/**
|
|
* Determine whether a module instance is visible within a course
|
|
*
|
|
* Given a valid module object with info about the id and course,
|
|
* and the module's type (eg "forum") returns whether the object
|
|
* is visible or not, groupmembersonly visibility not tested
|
|
*
|
|
* @global object
|
|
|
|
* @param $moduletype Name of the module eg 'forum'
|
|
* @param $module Object which is the instance of the module
|
|
* @return bool Success
|
|
*/
|
|
function instance_is_visible($moduletype, $module) {
|
|
global $DB;
|
|
|
|
if (!empty($module->id)) {
|
|
$params = array('courseid'=>$module->course, 'moduletype'=>$moduletype, 'moduleid'=>$module->id);
|
|
if ($records = $DB->get_records_sql("SELECT cm.instance, cm.visible, cm.groupingid, cm.id, cm.groupmembersonly, cm.course
|
|
FROM {course_modules} cm, {modules} m
|
|
WHERE cm.course = :courseid AND
|
|
cm.module = m.id AND
|
|
m.name = :moduletype AND
|
|
cm.instance = :moduleid", $params)) {
|
|
|
|
foreach ($records as $record) { // there should only be one - use the first one
|
|
return $record->visible;
|
|
}
|
|
}
|
|
}
|
|
return true; // visible by default!
|
|
}
|
|
|
|
/**
|
|
* Determine whether a course module is visible within a course,
|
|
* this is different from instance_is_visible() - faster and visibility for user
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @uses DEBUG_DEVELOPER
|
|
* @uses CONTEXT_MODULE
|
|
* @uses CONDITION_MISSING_EXTRATABLE
|
|
* @param object $cm object
|
|
* @param int $userid empty means current user
|
|
* @return bool Success
|
|
*/
|
|
function coursemodule_visible_for_user($cm, $userid=0) {
|
|
global $USER,$CFG;
|
|
|
|
if (empty($cm->id)) {
|
|
debugging("Incorrect course module parameter!", DEBUG_DEVELOPER);
|
|
return false;
|
|
}
|
|
if (empty($userid)) {
|
|
$userid = $USER->id;
|
|
}
|
|
if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
|
|
return false;
|
|
}
|
|
if ($CFG->enableavailability) {
|
|
require_once($CFG->libdir.'/conditionlib.php');
|
|
$ci=new condition_info($cm,CONDITION_MISSING_EXTRATABLE);
|
|
if(!$ci->is_available($cm->availableinfo,false,$userid) and
|
|
!has_capability('moodle/course:viewhiddenactivities',
|
|
get_context_instance(CONTEXT_MODULE, $cm->id), $userid)) {
|
|
return false;
|
|
}
|
|
}
|
|
return groups_course_module_visible($cm, $userid);
|
|
}
|
|
|
|
|
|
|
|
|
|
/// LOG FUNCTIONS /////////////////////////////////////////////////////
|
|
|
|
|
|
/**
|
|
* Add an entry to the log table.
|
|
*
|
|
* Add an entry to the log table. These are "action" focussed rather
|
|
* than web server hits, and provide a way to easily reconstruct what
|
|
* any particular student has been doing.
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @global object
|
|
* @uses SITEID
|
|
* @uses DEBUG_DEVELOPER
|
|
* @uses DEBUG_ALL
|
|
* @param int $courseid The course id
|
|
* @param string $module The module name - e.g. forum, journal, resource, course, user etc
|
|
* @param string $action 'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
|
|
* @param string $url The file and parameters used to see the results of the action
|
|
* @param string $info Additional description information
|
|
* @param string $cm The course_module->id if there is one
|
|
* @param string $user If log regards $user other than $USER
|
|
* @return void
|
|
*/
|
|
function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
|
|
// Note that this function intentionally does not follow the normal Moodle DB access idioms.
|
|
// This is for a good reason: it is the most frequently used DB update function,
|
|
// so it has been optimised for speed.
|
|
global $DB, $CFG, $USER;
|
|
|
|
if ($cm === '' || is_null($cm)) { // postgres won't translate empty string to its default
|
|
$cm = 0;
|
|
}
|
|
|
|
if ($user) {
|
|
$userid = $user;
|
|
} else {
|
|
if (session_is_loggedinas()) { // Don't log
|
|
return;
|
|
}
|
|
$userid = empty($USER->id) ? '0' : $USER->id;
|
|
}
|
|
|
|
$REMOTE_ADDR = getremoteaddr();
|
|
if (empty($REMOTE_ADDR)) {
|
|
$REMOTE_ADDR = '0.0.0.0';
|
|
}
|
|
|
|
$timenow = time();
|
|
$info = $info;
|
|
if (!empty($url)) { // could break doing html_entity_decode on an empty var.
|
|
$url = html_entity_decode($url); // for php < 4.3.0 this is defined in moodlelib.php
|
|
}
|
|
|
|
// Restrict length of log lines to the space actually available in the
|
|
// database so that it doesn't cause a DB error. Log a warning so that
|
|
// developers can avoid doing things which are likely to cause this on a
|
|
// routine basis.
|
|
$tl = textlib_get_instance();
|
|
if(!empty($info) && $tl->strlen($info)>255) {
|
|
$info = $tl->substr($info,0,252).'...';
|
|
debugging('Warning: logged very long info',DEBUG_DEVELOPER);
|
|
}
|
|
|
|
// If the 100 field size is changed, also need to alter print_log in course/lib.php
|
|
if(!empty($url) && $tl->strlen($url)>100) {
|
|
$url=$tl->substr($url,0,97).'...';
|
|
debugging('Warning: logged very long URL',DEBUG_DEVELOPER);
|
|
}
|
|
|
|
if (defined('MDL_PERFDB')) { global $PERF ; $PERF->logwrites++;};
|
|
|
|
if ($CFG->type = 'oci8po') {
|
|
if ($info == '') {
|
|
$info = ' ';
|
|
}
|
|
}
|
|
$log = array('time'=>$timenow, 'userid'=>$userid, 'course'=>$courseid, 'ip'=>$REMOTE_ADDR, 'module'=>$module,
|
|
'cmid'=>$cm, 'action'=>$action, 'url'=>$url, 'info'=>$info);
|
|
$result = $DB->insert_record_raw('log', $log, false);
|
|
|
|
// MDL-11893, alert $CFG->supportemail if insert into log failed
|
|
if (!$result and $CFG->supportemail and empty($CFG->noemailever)) {
|
|
// email_to_user is not usable because email_to_user tries to write to the logs table,
|
|
// and this will get caught in an infinite loop, if disk is full
|
|
$site = get_site();
|
|
$subject = 'Insert into log failed at your moodle site '.$site->fullname;
|
|
$message = "Insert into log table failed at ". date('l dS \of F Y h:i:s A') .".\n It is possible that your disk is full.\n\n";
|
|
$message .= "The failed query parameters are:\n\n" . var_export($log, true);
|
|
|
|
$lasttime = get_config('admin', 'lastloginserterrormail');
|
|
if(empty($lasttime) || time() - $lasttime > 60*60*24) { // limit to 1 email per day
|
|
mail($CFG->supportemail, $subject, $message);
|
|
set_config('lastloginserterrormail', time(), 'admin');
|
|
}
|
|
}
|
|
|
|
if (!$result) {
|
|
debugging('Error: Could not insert a new entry to the Moodle log', DEBUG_ALL);
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Store user last access times - called when use enters a course or site
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @global object
|
|
* @uses LASTACCESS_UPDATE_SECS
|
|
* @uses SITEID
|
|
* @param int $courseid, empty means site
|
|
* @return void
|
|
*/
|
|
function user_accesstime_log($courseid=0) {
|
|
global $USER, $CFG, $DB;
|
|
|
|
if (!isloggedin() or session_is_loggedinas()) {
|
|
// no access tracking
|
|
return;
|
|
}
|
|
|
|
if (empty($courseid)) {
|
|
$courseid = SITEID;
|
|
}
|
|
|
|
$timenow = time();
|
|
|
|
/// Store site lastaccess time for the current user
|
|
if ($timenow - $USER->lastaccess > LASTACCESS_UPDATE_SECS) {
|
|
/// Update $USER->lastaccess for next checks
|
|
$USER->lastaccess = $timenow;
|
|
|
|
$last = new object();
|
|
$last->id = $USER->id;
|
|
$last->lastip = getremoteaddr();
|
|
$last->lastaccess = $timenow;
|
|
|
|
$DB->update_record_raw('user', $last);
|
|
}
|
|
|
|
if ($courseid == SITEID) {
|
|
/// no user_lastaccess for frontpage
|
|
return;
|
|
}
|
|
|
|
/// Store course lastaccess times for the current user
|
|
if (empty($USER->currentcourseaccess[$courseid]) or ($timenow - $USER->currentcourseaccess[$courseid] > LASTACCESS_UPDATE_SECS)) {
|
|
|
|
$lastaccess = $DB->get_field('user_lastaccess', 'timeaccess', array('userid'=>$USER->id, 'courseid'=>$courseid));
|
|
|
|
if ($lastaccess === false) {
|
|
// Update course lastaccess for next checks
|
|
$USER->currentcourseaccess[$courseid] = $timenow;
|
|
|
|
$last = new object();
|
|
$last->userid = $USER->id;
|
|
$last->courseid = $courseid;
|
|
$last->timeaccess = $timenow;
|
|
$DB->insert_record_raw('user_lastaccess', $last, false);
|
|
|
|
} else if ($timenow - $lastaccess < LASTACCESS_UPDATE_SECS) {
|
|
// no need to update now, it was updated recently in concurrent login ;-)
|
|
|
|
} else {
|
|
// Update course lastaccess for next checks
|
|
$USER->currentcourseaccess[$courseid] = $timenow;
|
|
|
|
$DB->set_field('user_lastaccess', 'timeaccess', $timenow, array('userid'=>$USER->id, 'courseid'=>$courseid));
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Select all log records based on SQL criteria
|
|
*
|
|
* @todo Finish documenting this function
|
|
*
|
|
* @global object
|
|
* @param string $select SQL select criteria
|
|
* @param array $params named sql type params
|
|
* @param string $order SQL order by clause to sort the records returned
|
|
* @param string $limitfrom ?
|
|
* @param int $limitnum ?
|
|
* @param int $totalcount Passed in by reference.
|
|
* @return object
|
|
*/
|
|
function get_logs($select, array $params=null, $order='l.time DESC', $limitfrom='', $limitnum='', &$totalcount) {
|
|
global $DB;
|
|
|
|
if ($order) {
|
|
$order = "ORDER BY $order";
|
|
}
|
|
|
|
$selectsql = "";
|
|
$countsql = "";
|
|
|
|
if ($select) {
|
|
$select = "WHERE $select";
|
|
}
|
|
|
|
$sql = "SELECT COUNT(*)
|
|
FROM {log} l
|
|
$select";
|
|
|
|
$totalcount = $DB->count_records_sql($sql, $params);
|
|
|
|
$sql = "SELECT l.*, u.firstname, u.lastname, u.picture
|
|
FROM {log} l
|
|
LEFT JOIN {user} u ON l.userid = u.id
|
|
$select
|
|
$order";
|
|
|
|
return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum) ;
|
|
}
|
|
|
|
|
|
/**
|
|
* Select all log records for a given course and user
|
|
*
|
|
* @todo Finish documenting this function
|
|
*
|
|
* @global object
|
|
* @uses DAYSECS
|
|
* @param int $userid The id of the user as found in the 'user' table.
|
|
* @param int $courseid The id of the course as found in the 'course' table.
|
|
* @param string $coursestart ?
|
|
*/
|
|
function get_logs_usercourse($userid, $courseid, $coursestart) {
|
|
global $DB;
|
|
|
|
$params = array();
|
|
|
|
$courseselect = '';
|
|
if ($courseid) {
|
|
$courseselect = "AND course = :courseid";
|
|
$params['courseid'] = $courseid;
|
|
}
|
|
$params['userid'] = $userid;
|
|
$params['coursestart'] = $coursestart;
|
|
|
|
return $DB->get_records_sql("SELECT FLOOR((time - :coursestart)/". DAYSECS .") AS day, COUNT(*) AS num
|
|
FROM {log}
|
|
WHERE userid = :userid
|
|
AND time > :coursestart $courseselect
|
|
GROUP BY FLOOR((time - :coursestart)/". DAYSECS .")", $params);
|
|
}
|
|
|
|
/**
|
|
* Select all log records for a given course, user, and day
|
|
*
|
|
* @global object
|
|
* @uses HOURSECS
|
|
* @param int $userid The id of the user as found in the 'user' table.
|
|
* @param int $courseid The id of the course as found in the 'course' table.
|
|
* @param string $daystart ?
|
|
* @return object
|
|
*/
|
|
function get_logs_userday($userid, $courseid, $daystart) {
|
|
global $DB;
|
|
|
|
$params = array();
|
|
|
|
$courseselect = '';
|
|
if ($courseid) {
|
|
$courseselect = "AND course = :courseid";
|
|
$params['courseid'] = $courseid;
|
|
}
|
|
$params['userid'] = $userid;
|
|
$params['daystart'] = $daystart;
|
|
|
|
return $DB->get_records_sql("SELECT FLOOR((time - :daystart)/". HOURSECS .") AS hour, COUNT(*) AS num
|
|
FROM {log}
|
|
WHERE userid = :userid
|
|
AND time > :daystart $courseselect
|
|
GROUP BY FLOOR((time - :daystart)/". HOURSECS .") ");
|
|
}
|
|
|
|
/**
|
|
* Returns an object with counts of failed login attempts
|
|
*
|
|
* Returns information about failed login attempts. If the current user is
|
|
* an admin, then two numbers are returned: the number of attempts and the
|
|
* number of accounts. For non-admins, only the attempts on the given user
|
|
* are shown.
|
|
*
|
|
* @global object
|
|
* @uses CONTEXT_SYSTEM
|
|
* @param string $mode Either 'admin', 'teacher' or 'everybody'
|
|
* @param string $username The username we are searching for
|
|
* @param string $lastlogin The date from which we are searching
|
|
* @return int
|
|
*/
|
|
function count_login_failures($mode, $username, $lastlogin) {
|
|
global $DB;
|
|
|
|
$params = array('mode'=>$mode, 'username'=>$username, 'lastlogin'=>$lastlogin);
|
|
$select = "module='login' AND action='error' AND time > :lastlogin";
|
|
|
|
$count = new object();
|
|
|
|
if (has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) { // Return information about all accounts
|
|
if ($count->attempts = $DB->count_records_select('log', $select, $params)) {
|
|
$count->accounts = $DB->count_records_select('log', $select, $params, 'COUNT(DISTINCT info)');
|
|
return $count;
|
|
}
|
|
} else if ($mode == 'everybody' or ($mode == 'teacher' and isteacherinanycourse())) {
|
|
if ($count->attempts = $DB->count_records_select('log', "$select AND info = :username", $params)) {
|
|
return $count;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
|
|
/// GENERAL HELPFUL THINGS ///////////////////////////////////
|
|
|
|
/**
|
|
* Dump a given object's information in a PRE block.
|
|
*
|
|
* Mostly just used for debugging.
|
|
*
|
|
* @param mixed $object The data to be printed
|
|
* @return void OUtput is echo'd
|
|
*/
|
|
function print_object($object) {
|
|
echo '<pre class="notifytiny">' . htmlspecialchars(print_r($object,true)) . '</pre>';
|
|
}
|
|
|
|
/**
|
|
* Check whether a course is visible through its parents
|
|
* path.
|
|
*
|
|
* Notes:
|
|
*
|
|
* - All we need from the course is ->category. _However_
|
|
* if the course object has a categorypath property,
|
|
* we'll save a dbquery
|
|
*
|
|
* - If we return false, you'll still need to check if
|
|
* the user can has the 'moodle/category:viewhiddencategories'
|
|
* capability...
|
|
*
|
|
* - Will generate 2 DB calls.
|
|
*
|
|
* - It does have a small local cache, however...
|
|
*
|
|
* - Do NOT call this over many courses as it'll generate
|
|
* DB traffic. Instead, see what get_my_courses() does.
|
|
*
|
|
* @global object
|
|
* @global object
|
|
* @staticvar array $mycache
|
|
* @param object $course A course object
|
|
* @return bool
|
|
*/
|
|
function course_parent_visible($course = null) {
|
|
global $CFG, $DB;
|
|
//return true;
|
|
static $mycache;
|
|
|
|
if (!is_object($course)) {
|
|
return true;
|
|
}
|
|
if (!empty($CFG->allowvisiblecoursesinhiddencategories)) {
|
|
return true;
|
|
}
|
|
|
|
if (!isset($mycache)) {
|
|
$mycache = array();
|
|
} else {
|
|
// cast to force assoc array
|
|
$k = (string)$course->category;
|
|
if (isset($mycache[$k])) {
|
|
return $mycache[$k];
|
|
}
|
|
}
|
|
|
|
if (isset($course->categorypath)) {
|
|
$path = $course->categorypath;
|
|
} else {
|
|
$path = $DB->get_field('course_categories', 'path', array('id'=>$course->category));
|
|
}
|
|
$catids = substr($path,1); // strip leading slash
|
|
$catids = str_replace('/',',',$catids);
|
|
|
|
$sql = "SELECT MIN(visible)
|
|
FROM {course_categories}
|
|
WHERE id IN ($catids)";
|
|
$vis = $DB->get_field_sql($sql);
|
|
|
|
// cast to force assoc array
|
|
$k = (string)$course->category;
|
|
$mycache[$k] = $vis;
|
|
|
|
return $vis;
|
|
}
|
|
|
|
/**
|
|
* This function is the official hook inside XMLDB stuff to delegate its debug to one
|
|
* external function.
|
|
*
|
|
* Any script can avoid calls to this function by defining XMLDB_SKIP_DEBUG_HOOK before
|
|
* using XMLDB classes. Obviously, also, if this function doesn't exist, it isn't invoked ;-)
|
|
*
|
|
* @uses DEBUG_DEVELOPER
|
|
* @param string $message string contains the error message
|
|
* @param object $object object XMLDB object that fired the debug
|
|
*/
|
|
function xmldb_debug($message, $object) {
|
|
|
|
debugging($message, DEBUG_DEVELOPER);
|
|
}
|
|
|
|
/**
|
|
* @global object
|
|
* @uses CONTEXT_COURSECAT
|
|
* @return boolean Whether the user can create courses in any category in the system.
|
|
*/
|
|
function user_can_create_courses() {
|
|
global $DB;
|
|
$catsrs = $DB->get_recordset('course_categories');
|
|
foreach ($catsrs as $cat) {
|
|
if (has_capability('moodle/course:create', get_context_instance(CONTEXT_COURSECAT, $cat->id))) {
|
|
$catsrs->close();
|
|
return true;
|
|
}
|
|
}
|
|
$catsrs->close();
|
|
return false;
|
|
}
|
|
|
|
?>
|