Damyon Wiese
1fca8a7bdd
Instead of injecting the HTML + JS directly - return a promise that is resolve with the HTML and JS. This gives the caller control over how and when to inject the nodes in the DOM. Also modify templates.replaceNode functions to cleanup YUI events mess. Also pass the context to the callback so it can be verified. Also pass the arguments to the callback as a named array - not a flat argument list. Also - only load external scripts if they are not already loaded.
470 lines
18 KiB
PHP
470 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 API for core library
|
|
*
|
|
* @package core_webservice
|
|
* @category external
|
|
* @copyright 2012 Jerome Mouneyrac <jerome@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die;
|
|
|
|
require_once("$CFG->libdir/externallib.php");
|
|
|
|
/**
|
|
* Web service related functions
|
|
*
|
|
* @package core
|
|
* @category external
|
|
* @copyright 2012 Jerome Mouneyrac <jerome@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 2.4
|
|
*/
|
|
class core_external extends external_api {
|
|
|
|
|
|
/**
|
|
* Format the received string parameters to be sent to the core get_string() function.
|
|
*
|
|
* @param array $stringparams
|
|
* @return object|string
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function format_string_parameters($stringparams) {
|
|
// Check if there are some string params.
|
|
$strparams = new stdClass();
|
|
if (!empty($stringparams)) {
|
|
// There is only one string parameter.
|
|
if (count($stringparams) == 1) {
|
|
$stringparam = array_pop($stringparams);
|
|
if (isset($stringparam['name'])) {
|
|
$strparams->{$stringparam['name']} = $stringparam['value'];
|
|
} else {
|
|
// It is a not named string parameter.
|
|
$strparams = $stringparam['value'];
|
|
}
|
|
} else {
|
|
// There are more than one parameter.
|
|
foreach ($stringparams as $stringparam) {
|
|
|
|
// If a parameter is unnamed throw an exception
|
|
// unnamed param is only possible if one only param is sent.
|
|
if (empty($stringparam['name'])) {
|
|
throw new moodle_exception('unnamedstringparam', 'webservice');
|
|
}
|
|
|
|
$strparams->{$stringparam['name']} = $stringparam['value'];
|
|
}
|
|
}
|
|
}
|
|
return $strparams;
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_string parameters
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_string_parameters() {
|
|
return new external_function_parameters(
|
|
array('stringid' => new external_value(PARAM_STRINGID, 'string identifier'),
|
|
'component' => new external_value(PARAM_COMPONENT,'component', VALUE_DEFAULT, 'moodle'),
|
|
'lang' => new external_value(PARAM_LANG, 'lang', VALUE_DEFAULT, null),
|
|
'stringparams' => new external_multiple_structure (
|
|
new external_single_structure(array(
|
|
'name' => new external_value(PARAM_ALPHANUMEXT, 'param name
|
|
- if the string expect only one $a parameter then don\'t send this field, just send the value.', VALUE_OPTIONAL),
|
|
'value' => new external_value(PARAM_TEXT,'param value'))),
|
|
'the definition of a string param (i.e. {$a->name})', VALUE_DEFAULT, array()
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return a core get_string() call
|
|
*
|
|
* @param string $identifier string identifier
|
|
* @param string $component string component
|
|
* @param array $stringparams the string params
|
|
* @return string
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_string($stringid, $component = 'moodle', $lang = null, $stringparams = array()) {
|
|
$params = self::validate_parameters(self::get_string_parameters(),
|
|
array('stringid'=>$stringid, 'component' => $component, 'lang' => $lang, 'stringparams' => $stringparams));
|
|
|
|
$stringmanager = get_string_manager();
|
|
return $stringmanager->get_string($params['stringid'], $params['component'],
|
|
core_external::format_string_parameters($params['stringparams']), $params['lang']);
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_string() result value
|
|
*
|
|
* @return string
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_string_returns() {
|
|
return new external_value(PARAM_TEXT, 'translated string');
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_string parameters
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_strings_parameters() {
|
|
return new external_function_parameters(
|
|
array('strings' => new external_multiple_structure (
|
|
new external_single_structure (array(
|
|
'stringid' => new external_value(PARAM_STRINGID, 'string identifier'),
|
|
'component' => new external_value(PARAM_COMPONENT, 'component', VALUE_DEFAULT, 'moodle'),
|
|
'lang' => new external_value(PARAM_LANG, 'lang', VALUE_DEFAULT, null),
|
|
'stringparams' => new external_multiple_structure (
|
|
new external_single_structure(array(
|
|
'name' => new external_value(PARAM_ALPHANUMEXT, 'param name
|
|
- if the string expect only one $a parameter then don\'t send this field, just send the value.', VALUE_OPTIONAL),
|
|
'value' => new external_value(PARAM_TEXT, 'param value'))),
|
|
'the definition of a string param (i.e. {$a->name})', VALUE_DEFAULT, array()
|
|
))
|
|
)
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return multiple call to core get_string()
|
|
*
|
|
* @param array $strings strings to translate
|
|
* @return array
|
|
*
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_strings($strings) {
|
|
$params = self::validate_parameters(self::get_strings_parameters(),
|
|
array('strings'=>$strings));
|
|
$stringmanager = get_string_manager();
|
|
|
|
$translatedstrings = array();
|
|
foreach($params['strings'] as $string) {
|
|
|
|
if (!empty($string['lang'])) {
|
|
$lang = $string['lang'];
|
|
} else {
|
|
$lang = current_language();
|
|
}
|
|
|
|
$translatedstrings[] = array(
|
|
'stringid' => $string['stringid'],
|
|
'component' => $string['component'],
|
|
'lang' => $lang,
|
|
'string' => $stringmanager->get_string($string['stringid'], $string['component'],
|
|
core_external::format_string_parameters($string['stringparams']), $lang));
|
|
}
|
|
|
|
return $translatedstrings;
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_string() result value
|
|
*
|
|
* @return array
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_strings_returns() {
|
|
return new external_multiple_structure(
|
|
new external_single_structure(array(
|
|
'stringid' => new external_value(PARAM_STRINGID, 'string id'),
|
|
'component' => new external_value(PARAM_COMPONENT, 'string component'),
|
|
'lang' => new external_value(PARAM_LANG, 'lang'),
|
|
'string' => new external_value(PARAM_TEXT, 'translated string'))
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_component_strings parameters
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_component_strings_parameters() {
|
|
return new external_function_parameters(
|
|
array('component' => new external_value(PARAM_COMPONENT, 'component'),
|
|
'lang' => new external_value(PARAM_LANG, 'lang', VALUE_DEFAULT, null),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return all lang strings of a component - call to core get_component_strings().
|
|
*
|
|
* @param string $component component name
|
|
* @return array
|
|
*
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_component_strings($component, $lang = null) {
|
|
|
|
if (empty($lang)) {
|
|
$lang = current_language();
|
|
}
|
|
|
|
$params = self::validate_parameters(self::get_component_strings_parameters(),
|
|
array('component'=>$component, 'lang' => $lang));
|
|
|
|
$stringmanager = get_string_manager();
|
|
|
|
$wsstrings = array();
|
|
$componentstrings = $stringmanager->load_component_strings($params['component'], $params['lang']);
|
|
foreach($componentstrings as $stringid => $string) {
|
|
$wsstring = array();
|
|
$wsstring['stringid'] = $stringid;
|
|
$wsstring['string'] = $string;
|
|
$wsstrings[] = $wsstring;
|
|
}
|
|
|
|
return $wsstrings;
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_component_strings() result value
|
|
*
|
|
* @return array
|
|
* @since Moodle 2.4
|
|
*/
|
|
public static function get_component_strings_returns() {
|
|
return new external_multiple_structure(
|
|
new external_single_structure(array(
|
|
'stringid' => new external_value(PARAM_STRINGID, 'string id'),
|
|
'string' => new external_value(PARAM_RAW, 'translated string'))
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_fragment parameters
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 3.1
|
|
*/
|
|
public static function get_fragment_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'component' => new external_value(PARAM_COMPONENT, 'Component for the callback e.g. mod_assign'),
|
|
'callback' => new external_value(PARAM_ALPHANUMEXT, 'Name of the callback to execute'),
|
|
'contextid' => new external_value(PARAM_INT, 'Context ID that the fragment is from'),
|
|
'args' => new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'name' => new external_value(PARAM_ALPHANUMEXT, 'param name'),
|
|
'value' => new external_value(PARAM_RAW, 'param value')
|
|
)
|
|
), 'args for the callback are optional', VALUE_OPTIONAL
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get a HTML fragment for inserting into something. Initial use is for inserting mforms into
|
|
* a page using AJAX.
|
|
* This web service is designed to be called only via AJAX and not directly.
|
|
* Callbacks that are called by this web service are responsible for doing the appropriate security checks
|
|
* to access the information returned. This only does minimal validation on the context.
|
|
*
|
|
* @param string $component Name of the component.
|
|
* @param string $callback Function callback name.
|
|
* @param int $contextid Context ID this fragment is in.
|
|
* @param array $args optional arguments for the callback.
|
|
* @return array HTML and JavaScript fragments for insertion into stuff.
|
|
* @since Moodle 3.1
|
|
*/
|
|
public static function get_fragment($component, $callback, $contextid, $args = null) {
|
|
global $OUTPUT, $PAGE;
|
|
|
|
$params = self::validate_parameters(self::get_fragment_parameters(),
|
|
array(
|
|
'component' => $component,
|
|
'callback' => $callback,
|
|
'contextid' => $contextid,
|
|
'args' => $args
|
|
)
|
|
);
|
|
|
|
// Reformat arguments into something less unwieldy.
|
|
$arguments = array();
|
|
foreach ($params['args'] as $paramargument) {
|
|
$arguments[$paramargument['name']] = $paramargument['value'];
|
|
}
|
|
|
|
$context = context::instance_by_id($contextid);
|
|
self::validate_context($context);
|
|
$arguments['context'] = $context;
|
|
|
|
// Hack alert: Forcing bootstrap_renderer to initiate moodle page.
|
|
$OUTPUT->header();
|
|
|
|
// Overwriting page_requirements_manager with the fragment one so only JS included from
|
|
// this point is returned to the user.
|
|
$PAGE->start_collecting_javascript_requirements();
|
|
$data = component_callback($params['component'], 'output_fragment_' . $params['callback'], array($arguments));
|
|
$jsfooter = $PAGE->requires->get_end_code();
|
|
$output = array('html' => $data, 'javascript' => $jsfooter);
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Returns description of get_fragment() result value
|
|
*
|
|
* @return array
|
|
* @since Moodle 3.1
|
|
*/
|
|
public static function get_fragment_returns() {
|
|
return new external_single_structure(
|
|
array(
|
|
'html' => new external_value(PARAM_RAW, 'HTML fragment.'),
|
|
'javascript' => new external_value(PARAM_RAW, 'JavaScript fragment')
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Parameters for function update_inplace_editable()
|
|
*
|
|
* @since Moodle 3.1
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function update_inplace_editable_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'component' => new external_value(PARAM_COMPONENT, 'component responsible for the update', VALUE_REQUIRED),
|
|
'itemtype' => new external_value(PARAM_NOTAGS, 'type of the updated item inside the component', VALUE_REQUIRED),
|
|
'itemid' => new external_value(PARAM_INT, 'identifier of the updated item', VALUE_REQUIRED),
|
|
'value' => new external_value(PARAM_RAW, 'new value', VALUE_REQUIRED),
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Update any component's editable value assuming that component implements necessary callback
|
|
*
|
|
* @since Moodle 3.1
|
|
* @param string $component
|
|
* @param string $itemtype
|
|
* @param string $itemid
|
|
* @param string $value
|
|
*/
|
|
public static function update_inplace_editable($component, $itemtype, $itemid, $value) {
|
|
global $PAGE;
|
|
// Validate and normalize parameters.
|
|
$params = self::validate_parameters(self::update_inplace_editable_parameters(),
|
|
array('component' => $component, 'itemtype' => $itemtype, 'itemid' => $itemid, 'value' => $value));
|
|
if (!$functionname = component_callback_exists($component, 'inplace_editable')) {
|
|
throw new \moodle_exception('inplaceeditableerror');
|
|
}
|
|
$tmpl = component_callback($params['component'], 'inplace_editable',
|
|
array($params['itemtype'], $params['itemid'], $params['value']));
|
|
if (!$tmpl || !($tmpl instanceof \core\output\inplace_editable)) {
|
|
throw new \moodle_exception('inplaceeditableerror');
|
|
}
|
|
$PAGE->set_context(null); // To prevent warning if context was not set in the callback.
|
|
return $tmpl->export_for_template($PAGE->get_renderer('core'));
|
|
}
|
|
|
|
/**
|
|
* Return structure for update_inplace_editable()
|
|
*
|
|
* @since Moodle 3.1
|
|
* @return external_description
|
|
*/
|
|
public static function update_inplace_editable_returns() {
|
|
return new external_single_structure(
|
|
array(
|
|
'displayvalue' => new external_value(PARAM_RAW, 'display value (may contain link or other html tags)'),
|
|
'component' => new external_value(PARAM_NOTAGS, 'component responsible for the update', VALUE_OPTIONAL),
|
|
'itemtype' => new external_value(PARAM_NOTAGS, 'itemtype', VALUE_OPTIONAL),
|
|
'value' => new external_value(PARAM_RAW, 'value of the item as it is stored', VALUE_OPTIONAL),
|
|
'itemid' => new external_value(PARAM_RAW, 'identifier of the updated item', VALUE_OPTIONAL),
|
|
'edithint' => new external_value(PARAM_NOTAGS, 'hint for editing element', VALUE_OPTIONAL),
|
|
'editlabel' => new external_value(PARAM_NOTAGS, 'label for editing element', VALUE_OPTIONAL),
|
|
'type' => new external_value(PARAM_ALPHA, 'type of the element (text, toggle, select)', VALUE_OPTIONAL),
|
|
'options' => new external_value(PARAM_RAW, 'options of the element, format depends on type', VALUE_OPTIONAL),
|
|
'linkeverything' => new external_value(PARAM_INT, 'Should everything be wrapped in the edit link or link displayed separately', VALUE_OPTIONAL),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns description of fetch_notifications() parameters.
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 3.1
|
|
*/
|
|
public static function fetch_notifications_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'contextid' => new external_value(PARAM_INT, 'Context ID', VALUE_REQUIRED),
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Returns description of fetch_notifications() result value.
|
|
*
|
|
* @return external_description
|
|
* @since Moodle 3.1
|
|
*/
|
|
public static function fetch_notifications_returns() {
|
|
return new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'template' => new external_value(PARAM_RAW, 'Name of the template'),
|
|
'variables' => new external_single_structure(array(
|
|
'message' => new external_value(PARAM_RAW, 'HTML content of the Notification'),
|
|
'extraclasses' => new external_value(PARAM_RAW, 'Extra classes to provide to the tmeplate'),
|
|
'announce' => new external_value(PARAM_RAW, 'Whether to announce'),
|
|
'closebutton' => new external_value(PARAM_RAW, 'Whether to close'),
|
|
)),
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns the list of notifications against the current session.
|
|
*
|
|
* @return array
|
|
* @since Moodle 3.1
|
|
*/
|
|
public static function fetch_notifications($contextid) {
|
|
global $PAGE;
|
|
|
|
self::validate_parameters(self::fetch_notifications_parameters(), [
|
|
'contextid' => $contextid,
|
|
]);
|
|
|
|
$context = \context::instance_by_id($contextid);
|
|
$PAGE->set_context($context);
|
|
|
|
return \core\notification::fetch_as_array($PAGE->get_renderer('core'));
|
|
}
|
|
}
|