mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 05:58:34 +01:00
286 lines
11 KiB
PHP
286 lines
11 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/>.
|
|
|
|
/**
|
|
* Web services admin UI forms
|
|
*
|
|
* @package 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 . '/formslib.php';
|
|
|
|
/**
|
|
* Display the authorised user settings form
|
|
* Including IP Restriction, Valid until and (TODO) capability
|
|
*/
|
|
class external_service_authorised_user_settings_form extends moodleform {
|
|
|
|
function definition() {
|
|
$mform = $this->_form;
|
|
$data = $this->_customdata;
|
|
|
|
$mform->addElement('header', 'serviceusersettings',
|
|
get_string('serviceusersettings', 'webservice'));
|
|
|
|
$mform->addElement('text', 'iprestriction',
|
|
get_string('iprestriction', 'webservice'));
|
|
$mform->addHelpButton('iprestriction', 'iprestriction', 'webservice');
|
|
|
|
$mform->addElement('date_selector', 'validuntil',
|
|
get_string('validuntil', 'webservice'), array('optional' => true));
|
|
$mform->addHelpButton('validuntil', 'validuntil', 'webservice');
|
|
|
|
$this->add_action_buttons(true, get_string('updateusersettings', 'webservice'));
|
|
|
|
$this->set_data($data);
|
|
}
|
|
|
|
}
|
|
|
|
class external_service_form extends moodleform {
|
|
|
|
function definition() {
|
|
$mform = $this->_form;
|
|
$service = $this->_customdata;
|
|
|
|
$mform->addElement('header', 'extservice',
|
|
get_string('externalservice', 'webservice'));
|
|
|
|
$mform->addElement('text', 'name', get_string('name'));
|
|
$mform->addRule('name', get_string('required'), 'required', null, 'client');
|
|
$mform->addElement('advcheckbox', 'enabled', get_string('enabled', 'webservice'));
|
|
$mform->addElement('advcheckbox', 'restrictedusers',
|
|
get_string('restrictedusers', 'webservice'));
|
|
$mform->addHelpButton('restrictedusers', 'restrictedusers', 'webservice');
|
|
|
|
//can users download files
|
|
$mform->addElement('advcheckbox', 'downloadfiles', get_string('downloadfiles', 'webservice'));
|
|
$mform->setAdvanced('downloadfiles');
|
|
$mform->addHelpButton('downloadfiles', 'downloadfiles', 'webservice');
|
|
|
|
/// needed to select automatically the 'No required capability" option
|
|
$currentcapabilityexist = false;
|
|
if (empty($service->requiredcapability)) {
|
|
$service->requiredcapability = "norequiredcapability";
|
|
$currentcapabilityexist = true;
|
|
}
|
|
|
|
// Prepare the list of capabilities to choose from
|
|
$systemcontext = get_context_instance(CONTEXT_SYSTEM);
|
|
$allcapabilities = fetch_context_capabilities($systemcontext);
|
|
$capabilitychoices = array();
|
|
$capabilitychoices['norequiredcapability'] = get_string('norequiredcapability',
|
|
'webservice');
|
|
foreach ($allcapabilities as $cap) {
|
|
$capabilitychoices[$cap->name] = $cap->name . ': '
|
|
. get_capability_string($cap->name);
|
|
if (!empty($service->requiredcapability)
|
|
&& $service->requiredcapability == $cap->name) {
|
|
$currentcapabilityexist = true;
|
|
}
|
|
}
|
|
|
|
$mform->addElement('searchableselector', 'requiredcapability',
|
|
get_string('requiredcapability', 'webservice'), $capabilitychoices);
|
|
$mform->addHelpButton('requiredcapability', 'requiredcapability', 'webservice');
|
|
$mform->setAdvanced('requiredcapability');
|
|
/// display notification error if the current requiredcapability doesn't exist anymore
|
|
if (empty($currentcapabilityexist)) {
|
|
global $OUTPUT;
|
|
$mform->addElement('static', 'capabilityerror', '',
|
|
$OUTPUT->notification(get_string('selectedcapabilitydoesntexit',
|
|
'webservice', $service->requiredcapability)));
|
|
$service->requiredcapability = "norequiredcapability";
|
|
}
|
|
|
|
$mform->addElement('hidden', 'id');
|
|
$mform->setType('id', PARAM_INT);
|
|
|
|
if (!empty($service->id)) {
|
|
$buttonlabel = get_string('editaservice', 'webservice');
|
|
} else {
|
|
$buttonlabel = get_string('addaservice', 'webservice');
|
|
}
|
|
|
|
$this->add_action_buttons(true, $buttonlabel);
|
|
|
|
$this->set_data($service);
|
|
}
|
|
|
|
function definition_after_data() {
|
|
$mform = $this->_form;
|
|
$service = $this->_customdata;
|
|
|
|
if (!empty($service->component)) {
|
|
// built-in components must not be modified except the enabled flag!!
|
|
$mform->hardFreeze('name,requiredcapability,restrictedusers');
|
|
}
|
|
}
|
|
|
|
function validation($data, $files) {
|
|
$errors = parent::validation($data, $files);
|
|
return $errors;
|
|
}
|
|
|
|
}
|
|
|
|
class external_service_functions_form extends moodleform {
|
|
|
|
function definition() {
|
|
global $CFG;
|
|
|
|
$mform = $this->_form;
|
|
$data = $this->_customdata;
|
|
|
|
$mform->addElement('header', 'addfunction', get_string('addfunctions', 'webservice'));
|
|
|
|
require_once($CFG->dirroot . "/webservice/lib.php");
|
|
$webservicemanager = new webservice();
|
|
$functions = $webservicemanager->get_not_associated_external_functions($data['id']);
|
|
|
|
//we add the descriptions to the functions
|
|
foreach ($functions as $functionid => $functionname) {
|
|
//retrieve full function information (including the description)
|
|
$function = external_function_info($functionname);
|
|
$functions[$functionid] = $function->name . ':' . $function->description;
|
|
}
|
|
|
|
$mform->addElement('searchableselector', 'fid', get_string('name'),
|
|
$functions, array('multiple'));
|
|
|
|
$mform->addElement('hidden', 'id');
|
|
$mform->setType('id', PARAM_INT);
|
|
|
|
$mform->addElement('hidden', 'action');
|
|
$mform->setType('action', PARAM_ACTION);
|
|
|
|
$this->add_action_buttons(true, get_string('addfunctions', 'webservice'));
|
|
|
|
$this->set_data($data);
|
|
}
|
|
|
|
}
|
|
|
|
class web_service_token_form extends moodleform {
|
|
|
|
function definition() {
|
|
global $USER, $DB, $CFG;
|
|
|
|
$mform = $this->_form;
|
|
$data = $this->_customdata;
|
|
|
|
$mform->addElement('header', 'token', get_string('token', 'webservice'));
|
|
|
|
if (empty($data->nouserselection)) {
|
|
|
|
//check if the number of user is reasonable to be displayed in a select box
|
|
$usertotal = $DB->count_records('user',
|
|
array('deleted' => 0, 'suspended' => 0, 'confirmed' => 1));
|
|
|
|
if ($usertotal < 500) {
|
|
//user searchable selector - get all users (admin and guest included)
|
|
//user must be confirmed, not deleted, not suspended, not guest
|
|
$sql = "SELECT u.id, u.firstname, u.lastname
|
|
FROM {user} u
|
|
WHERE u.deleted = 0 AND u.confirmed = 1 AND u.suspended = 0 AND u.id != ?
|
|
ORDER BY u.lastname";
|
|
$users = $DB->get_records_sql($sql, array($CFG->siteguest));
|
|
$options = array();
|
|
foreach ($users as $userid => $user) {
|
|
$options[$userid] = $user->firstname . " " . $user->lastname;
|
|
}
|
|
$mform->addElement('searchableselector', 'user', get_string('user'), $options);
|
|
} else {
|
|
//simple text box for username or user id (if two username exists, a form error is displayed)
|
|
$mform->addElement('text', 'user', get_string('usernameorid', 'webservice'));
|
|
}
|
|
$mform->addRule('user', get_string('required'), 'required', null, 'client');
|
|
}
|
|
|
|
//service selector
|
|
$services = $DB->get_records('external_services');
|
|
$options = array();
|
|
$systemcontext = get_context_instance(CONTEXT_SYSTEM);
|
|
foreach ($services as $serviceid => $service) {
|
|
//check that the user has the required capability
|
|
//(only for generation by the profile page)
|
|
if (empty($data->nouserselection)
|
|
|| empty($service->requiredcapability)
|
|
|| has_capability($service->requiredcapability, $systemcontext, $USER->id)) {
|
|
$options[$serviceid] = $service->name;
|
|
}
|
|
}
|
|
$mform->addElement('select', 'service', get_string('service', 'webservice'), $options);
|
|
$mform->addRule('service', get_string('required'), 'required', null, 'client');
|
|
|
|
|
|
$mform->addElement('text', 'iprestriction', get_string('iprestriction', 'webservice'));
|
|
|
|
$mform->addElement('date_selector', 'validuntil',
|
|
get_string('validuntil', 'webservice'), array('optional' => true));
|
|
|
|
$mform->addElement('hidden', 'action');
|
|
$mform->setType('action', PARAM_ACTION);
|
|
|
|
$this->add_action_buttons(true);
|
|
|
|
$this->set_data($data);
|
|
}
|
|
|
|
function get_data() {
|
|
global $DB;
|
|
$data = parent::get_data();
|
|
|
|
if (!empty($data) && !is_numeric($data->user)) {
|
|
//retrieve username
|
|
$user = $DB->get_record('user', array('username' => $data->user), 'id');
|
|
$data->user = $user->id;
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
function validation(&$data, $files) {
|
|
global $DB;
|
|
|
|
$errors = parent::validation($data, $files);
|
|
|
|
if (is_numeric($data['user'])) {
|
|
$searchtype = 'id';
|
|
} else {
|
|
$searchtype = 'username';
|
|
//check the username is valid
|
|
if (clean_param($data['user'], PARAM_USERNAME) != $data['user']) {
|
|
$errors['user'] = get_string('invalidusername');
|
|
}
|
|
}
|
|
|
|
if (!isset($errors['user'])) {
|
|
$users = $DB->get_records('user', array($searchtype => $data['user']), '', 'id');
|
|
|
|
//check that the user exists in the database
|
|
if (count($users) == 0) {
|
|
$errors['user'] = get_string('usernameoridnousererror', 'webservice');
|
|
} else if (count($users) > 1) { //can only be a username search as id are unique
|
|
$errors['user'] = get_string('usernameoridoccurenceerror', 'webservice');
|
|
}
|
|
}
|
|
|
|
return $errors;
|
|
}
|
|
|
|
} |