mirror of
https://github.com/moodle/moodle.git
synced 2025-01-17 21:49:15 +01:00
507 lines
18 KiB
PHP
507 lines
18 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/>.
|
|
|
|
/**
|
|
* External groups API
|
|
*
|
|
* @package moodlecore
|
|
* @subpackage webservice
|
|
* @copyright 2009 Moodle Pty Ltd (http://moodle.com)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
require_once("$CFG->libdir/externallib.php");
|
|
|
|
class moodle_group_external extends external_api {
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function create_groups_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'groups' => new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'courseid' => new external_value(PARAM_INT, 'id of course'),
|
|
'name' => new external_value(PARAM_TEXT, 'multilang compatible name, course unique'),
|
|
'description' => new external_value(PARAM_RAW, 'group description text'),
|
|
'enrolmentkey' => new external_value(PARAM_RAW, 'group enrol secret phrase'),
|
|
)
|
|
), 'List of group object. A group has a courseid, a name, a description and an enrolment key.'
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Create groups
|
|
* @param array $groups array of group description arrays (with keys groupname and courseid)
|
|
* @return array of newly created groups
|
|
*/
|
|
public static function create_groups($groups) {
|
|
global $CFG, $DB;
|
|
require_once("$CFG->dirroot/group/lib.php");
|
|
|
|
$params = self::validate_parameters(self::create_groups_parameters(), array('groups'=>$groups));
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
|
|
$groups = array();
|
|
|
|
foreach ($params['groups'] as $group) {
|
|
$group = (object)$group;
|
|
|
|
if (trim($group->name) == '') {
|
|
throw new invalid_parameter_exception('Invalid group name');
|
|
}
|
|
if ($DB->get_record('groups', array('courseid'=>$group->courseid, 'name'=>$group->name))) {
|
|
throw new invalid_parameter_exception('Group with the same name already exists in the course');
|
|
}
|
|
|
|
// now security checks
|
|
$context = get_context_instance(CONTEXT_COURSE, $group->courseid);
|
|
try {
|
|
self::validate_context($context);
|
|
} catch (Exception $e) {
|
|
$exceptionparam = new stdClass();
|
|
$exceptionparam->message = $e->getMessage();
|
|
$exceptionparam->courseid = $group->courseid;
|
|
throw new moodle_exception(
|
|
get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
|
|
}
|
|
require_capability('moodle/course:managegroups', $context);
|
|
|
|
// finally create the group
|
|
$group->id = groups_create_group($group, false);
|
|
$groups[] = (array)$group;
|
|
}
|
|
|
|
$transaction->allow_commit();
|
|
|
|
return $groups;
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
* @return external_description
|
|
*/
|
|
public static function create_groups_returns() {
|
|
return new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'id' => new external_value(PARAM_INT, 'group record id'),
|
|
'courseid' => new external_value(PARAM_INT, 'id of course'),
|
|
'name' => new external_value(PARAM_TEXT, 'multilang compatible name, course unique'),
|
|
'description' => new external_value(PARAM_RAW, 'group description text'),
|
|
'enrolmentkey' => new external_value(PARAM_RAW, 'group enrol secret phrase'),
|
|
)
|
|
), 'List of group object. A group has an id, a courseid, a name, a description and an enrolment key.'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function get_groups_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'groupids' => new external_multiple_structure(new external_value(PARAM_INT, 'Group ID')
|
|
,'List of group id. A group id is an integer.'),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get groups definition specified by ids
|
|
* @param array $groupids arrays of group ids
|
|
* @return array of group objects (id, courseid, name, enrolmentkey)
|
|
*/
|
|
public static function get_groups($groupids) {
|
|
$params = self::validate_parameters(self::get_groups_parameters(), array('groupids'=>$groupids));
|
|
|
|
$groups = array();
|
|
foreach ($params['groupids'] as $groupid) {
|
|
// validate params
|
|
$group = groups_get_group($groupid, 'id, courseid, name, description, enrolmentkey', MUST_EXIST);
|
|
|
|
// now security checks
|
|
$context = get_context_instance(CONTEXT_COURSE, $group->courseid);
|
|
try {
|
|
self::validate_context($context);
|
|
} catch (Exception $e) {
|
|
$exceptionparam = new stdClass();
|
|
$exceptionparam->message = $e->getMessage();
|
|
$exceptionparam->courseid = $group->courseid;
|
|
throw new moodle_exception(
|
|
get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
|
|
}
|
|
require_capability('moodle/course:managegroups', $context);
|
|
|
|
$groups[] = (array)$group;
|
|
}
|
|
|
|
return $groups;
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
* @return external_description
|
|
*/
|
|
public static function get_groups_returns() {
|
|
return new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'id' => new external_value(PARAM_INT, 'group record id'),
|
|
'courseid' => new external_value(PARAM_INT, 'id of course'),
|
|
'name' => new external_value(PARAM_TEXT, 'multilang compatible name, course unique'),
|
|
'description' => new external_value(PARAM_RAW, 'group description text'),
|
|
'enrolmentkey' => new external_value(PARAM_RAW, 'group enrol secret phrase'),
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function get_course_groups_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'courseid' => new external_value(PARAM_INT, 'id of course'),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get all groups in the specified course
|
|
* @param int $courseid id of course
|
|
* @return array of group objects (id, courseid, name, enrolmentkey)
|
|
*/
|
|
public static function get_course_groups($courseid) {
|
|
$params = self::validate_parameters(self::get_course_groups_parameters(), array('courseid'=>$courseid));
|
|
|
|
// now security checks
|
|
$context = get_context_instance(CONTEXT_COURSE, $params['courseid']);
|
|
try {
|
|
self::validate_context($context);
|
|
} catch (Exception $e) {
|
|
$exceptionparam = new stdClass();
|
|
$exceptionparam->message = $e->getMessage();
|
|
$exceptionparam->courseid = $params['courseid'];
|
|
throw new moodle_exception(
|
|
get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
|
|
}
|
|
require_capability('moodle/course:managegroups', $context);
|
|
|
|
$gs = groups_get_all_groups($params['courseid'], 0, 0, 'g.id, g.courseid, g.name, g.description, g.enrolmentkey');
|
|
|
|
$groups = array();
|
|
foreach ($gs as $group) {
|
|
$groups[] = (array)$group;
|
|
}
|
|
|
|
return $groups;
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
* @return external_description
|
|
*/
|
|
public static function get_course_groups_returns() {
|
|
return new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'id' => new external_value(PARAM_INT, 'group record id'),
|
|
'courseid' => new external_value(PARAM_INT, 'id of course'),
|
|
'name' => new external_value(PARAM_TEXT, 'multilang compatible name, course unique'),
|
|
'description' => new external_value(PARAM_RAW, 'group description text'),
|
|
'enrolmentkey' => new external_value(PARAM_RAW, 'group enrol secret phrase'),
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function delete_groups_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'groupids' => new external_multiple_structure(new external_value(PARAM_INT, 'Group ID')),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Delete groups
|
|
* @param array $groupids array of group ids
|
|
* @return void
|
|
*/
|
|
public static function delete_groups($groupids) {
|
|
global $CFG, $DB;
|
|
require_once("$CFG->dirroot/group/lib.php");
|
|
|
|
$params = self::validate_parameters(self::delete_groups_parameters(), array('groupids'=>$groupids));
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
|
|
// TODO: this is problematic because the DB rollback does not handle deleting of group images!
|
|
foreach ($params['groupids'] as $groupid) {
|
|
// validate params
|
|
$groupid = validate_param($groupid, PARAM_INTEGER);
|
|
if (!$group = groups_get_group($groupid, 'id, courseid', IGNORE_MISSING)) {
|
|
// silently ignore attempts to delete nonexisting groups
|
|
continue;
|
|
}
|
|
|
|
// now security checks
|
|
$context = get_context_instance(CONTEXT_COURSE, $group->courseid);
|
|
try {
|
|
self::validate_context($context);
|
|
} catch (Exception $e) {
|
|
$exceptionparam = new stdClass();
|
|
$exceptionparam->message = $e->getMessage();
|
|
$exceptionparam->courseid = $group->courseid;
|
|
throw new moodle_exception(
|
|
get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
|
|
}
|
|
require_capability('moodle/course:managegroups', $context);
|
|
|
|
groups_delete_group($group);
|
|
}
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
* @return external_description
|
|
*/
|
|
public static function delete_groups_returns() {
|
|
return null;
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function get_groupmembers_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'groupids' => new external_multiple_structure(new external_value(PARAM_INT, 'Group ID')),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return all members for a group
|
|
* @param array $groupids array of group ids
|
|
* @return array with group id keys containing arrays of user ids
|
|
*/
|
|
public static function get_groupmembers($groupids) {
|
|
$members = array();
|
|
|
|
$params = self::validate_parameters(self::get_groupmembers_parameters(), array('groupids'=>$groupids));
|
|
|
|
foreach ($params['groupids'] as $groupid) {
|
|
// validate params
|
|
$group = groups_get_group($groupid, 'id, courseid, name, enrolmentkey', MUST_EXIST);
|
|
// now security checks
|
|
$context = get_context_instance(CONTEXT_COURSE, $group->courseid);
|
|
try {
|
|
self::validate_context($context);
|
|
} catch (Exception $e) {
|
|
$exceptionparam = new stdClass();
|
|
$exceptionparam->message = $e->getMessage();
|
|
$exceptionparam->courseid = $group->courseid;
|
|
throw new moodle_exception(
|
|
get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
|
|
}
|
|
require_capability('moodle/course:managegroups', $context);
|
|
|
|
$groupmembers = groups_get_members($group->id, 'u.id', 'lastname ASC, firstname ASC');
|
|
|
|
$members[] = array('groupid'=>$groupid, 'userids'=>array_keys($groupmembers));
|
|
}
|
|
|
|
return $members;
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
* @return external_description
|
|
*/
|
|
public static function get_groupmembers_returns() {
|
|
return new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'groupid' => new external_value(PARAM_INT, 'group record id'),
|
|
'userids' => new external_multiple_structure(new external_value(PARAM_INT, 'user id')),
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function add_groupmembers_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'members'=> new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'groupid' => new external_value(PARAM_INT, 'group record id'),
|
|
'userid' => new external_value(PARAM_INT, 'user id'),
|
|
)
|
|
)
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Add group members
|
|
* @param array $members of arrays with keys userid, groupid
|
|
* @return void
|
|
*/
|
|
public static function add_groupmembers($members) {
|
|
global $CFG, $DB;
|
|
require_once("$CFG->dirroot/group/lib.php");
|
|
|
|
$params = self::validate_parameters(self::add_groupmembers_parameters(), array('members'=>$members));
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
foreach ($params['members'] as $member) {
|
|
// validate params
|
|
$groupid = $member['groupid'];
|
|
$userid = $member['userid'];
|
|
|
|
$group = groups_get_group($groupid, 'id, courseid', MUST_EXIST);
|
|
$user = $DB->get_record('user', array('id'=>$userid, 'deleted'=>0, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
|
|
|
|
// now security checks
|
|
$context = get_context_instance(CONTEXT_COURSE, $group->courseid);
|
|
try {
|
|
self::validate_context($context);
|
|
} catch (Exception $e) {
|
|
$exceptionparam = new stdClass();
|
|
$exceptionparam->message = $e->getMessage();
|
|
$exceptionparam->courseid = $group->courseid;
|
|
throw new moodle_exception(
|
|
get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
|
|
}
|
|
require_capability('moodle/course:managegroups', $context);
|
|
|
|
// now make sure user is enrolled in course - this is mandatory requirement,
|
|
// unfortunately this is slow
|
|
if (!is_enrolled($context, $userid)) {
|
|
throw new invalid_parameter_exception('Only enrolled users may be members of groups');
|
|
}
|
|
|
|
groups_add_member($group, $user);
|
|
}
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
* @return external_description
|
|
*/
|
|
public static function add_groupmembers_returns() {
|
|
return null;
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function delete_groupmembers_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'members'=> new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'groupid' => new external_value(PARAM_INT, 'group record id'),
|
|
'userid' => new external_value(PARAM_INT, 'user id'),
|
|
)
|
|
)
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Delete group members
|
|
* @param array $members of arrays with keys userid, groupid
|
|
* @return void
|
|
*/
|
|
public static function delete_groupmembers($members) {
|
|
global $CFG, $DB;
|
|
require_once("$CFG->dirroot/group/lib.php");
|
|
|
|
$params = self::validate_parameters(self::delete_groupmembers_parameters(), array('members'=>$members));
|
|
|
|
$transaction = $DB->start_delegated_transaction();
|
|
|
|
foreach ($params['members'] as $member) {
|
|
// validate params
|
|
$groupid = $member['groupid'];
|
|
$userid = $member['userid'];
|
|
|
|
$group = groups_get_group($groupid, 'id, courseid', MUST_EXIST);
|
|
$user = $DB->get_record('user', array('id'=>$userid, 'deleted'=>0, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
|
|
|
|
// now security checks
|
|
$context = get_context_instance(CONTEXT_COURSE, $group->courseid);
|
|
try {
|
|
self::validate_context($context);
|
|
} catch (Exception $e) {
|
|
$exceptionparam = new stdClass();
|
|
$exceptionparam->message = $e->getMessage();
|
|
$exceptionparam->courseid = $group->courseid;
|
|
throw new moodle_exception(
|
|
get_string('errorcoursecontextnotvalid' , 'webservice', $exceptionparam));
|
|
}
|
|
require_capability('moodle/course:managegroups', $context);
|
|
|
|
groups_remove_member($group, $user);
|
|
}
|
|
|
|
$transaction->allow_commit();
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
* @return external_description
|
|
*/
|
|
public static function delete_groupmembers_returns() {
|
|
return null;
|
|
}
|
|
|
|
}
|