mirror of
https://github.com/moodle/moodle.git
synced 2025-08-06 17:36:38 +02:00
339 lines
14 KiB
PHP
339 lines
14 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 tool module external API
|
|
*
|
|
* @package mod_lti
|
|
* @category external
|
|
* @copyright 2015 Juan Leyva <juan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 3.0
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die;
|
|
|
|
require_once($CFG->libdir . '/externallib.php');
|
|
require_once($CFG->dirroot . '/mod/lti/lib.php');
|
|
require_once($CFG->dirroot . '/mod/lti/locallib.php');
|
|
|
|
/**
|
|
* External tool module external functions
|
|
*
|
|
* @package mod_lti
|
|
* @category external
|
|
* @copyright 2015 Juan Leyva <juan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 3.0
|
|
*/
|
|
class mod_lti_external extends external_api {
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 3.0
|
|
*/
|
|
public static function get_tool_launch_data_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'toolid' => new external_value(PARAM_INT, 'external tool instance id')
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return the launch data for a given external tool.
|
|
*
|
|
* @param int $toolid the external tool instance id
|
|
* @return array of warnings and launch data
|
|
* @since Moodle 3.0
|
|
* @throws moodle_exception
|
|
*/
|
|
public static function get_tool_launch_data($toolid) {
|
|
global $DB, $CFG;
|
|
require_once($CFG->dirroot . '/mod/lti/lib.php');
|
|
|
|
$params = self::validate_parameters(self::get_tool_launch_data_parameters(),
|
|
array(
|
|
'toolid' => $toolid
|
|
));
|
|
$warnings = array();
|
|
|
|
// Request and permission validation.
|
|
$lti = $DB->get_record('lti', array('id' => $params['toolid']), '*', MUST_EXIST);
|
|
list($course, $cm) = get_course_and_cm_from_instance($lti, 'lti');
|
|
|
|
$context = context_module::instance($cm->id);
|
|
self::validate_context($context);
|
|
|
|
require_capability('mod/lti:view', $context);
|
|
|
|
$lti->cmid = $cm->id;
|
|
list($endpoint, $parms) = lti_get_launch_data($lti);
|
|
|
|
$parameters = array();
|
|
foreach ($parms as $name => $value) {
|
|
$parameters[] = array(
|
|
'name' => $name,
|
|
'value' => $value
|
|
);
|
|
}
|
|
|
|
$result = array();
|
|
$result['endpoint'] = $endpoint;
|
|
$result['parameters'] = $parameters;
|
|
$result['warnings'] = $warnings;
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
*
|
|
* @return external_description
|
|
* @since Moodle 3.0
|
|
*/
|
|
public static function get_tool_launch_data_returns() {
|
|
return new external_single_structure(
|
|
array(
|
|
'endpoint' => new external_value(PARAM_RAW, 'Endpoint URL'), // Using PARAM_RAW as is defined in the module.
|
|
'parameters' => new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'name' => new external_value(PARAM_NOTAGS, 'Parameter name'),
|
|
'value' => new external_value(PARAM_RAW, 'Parameter value')
|
|
)
|
|
)
|
|
),
|
|
'warnings' => new external_warnings()
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Describes the parameters for get_ltis_by_courses.
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 3.0
|
|
*/
|
|
public static function get_ltis_by_courses_parameters() {
|
|
return new external_function_parameters (
|
|
array(
|
|
'courseids' => new external_multiple_structure(
|
|
new external_value(PARAM_INT, 'course id'), 'Array of course ids', VALUE_DEFAULT, array()
|
|
),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns a list of external tools in a provided list of courses,
|
|
* if no list is provided all external tools that the user can view will be returned.
|
|
*
|
|
* @param array $courseids the course ids
|
|
* @return array the lti details
|
|
* @since Moodle 3.0
|
|
*/
|
|
public static function get_ltis_by_courses($courseids = array()) {
|
|
global $CFG;
|
|
|
|
$returnedltis = array();
|
|
$warnings = array();
|
|
|
|
$params = self::validate_parameters(self::get_ltis_by_courses_parameters(), array('courseids' => $courseids));
|
|
|
|
$mycourses = array();
|
|
if (empty($params['courseids'])) {
|
|
$mycourses = enrol_get_my_courses();
|
|
$params['courseids'] = array_keys($mycourses);
|
|
}
|
|
|
|
// Ensure there are courseids to loop through.
|
|
if (!empty($params['courseids'])) {
|
|
|
|
list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses);
|
|
|
|
// Get the ltis in this course, this function checks users visibility permissions.
|
|
// We can avoid then additional validate_context calls.
|
|
$ltis = get_all_instances_in_courses("lti", $courses);
|
|
|
|
foreach ($ltis as $lti) {
|
|
|
|
$context = context_module::instance($lti->coursemodule);
|
|
|
|
// Entry to return.
|
|
$module = array();
|
|
|
|
// First, we return information that any user can see in (or can deduce from) the web interface.
|
|
$module['id'] = $lti->id;
|
|
$module['coursemodule'] = $lti->coursemodule;
|
|
$module['course'] = $lti->course;
|
|
$module['name'] = external_format_string($lti->name, $context->id);
|
|
|
|
$viewablefields = [];
|
|
if (has_capability('mod/lti:view', $context)) {
|
|
list($module['intro'], $module['introformat']) =
|
|
external_format_text($lti->intro, $lti->introformat, $context->id, 'mod_lti', 'intro', $lti->id);
|
|
|
|
$viewablefields = array('launchcontainer', 'showtitlelaunch', 'showdescriptionlaunch', 'icon', 'secureicon');
|
|
}
|
|
|
|
// Check additional permissions for returning optional private settings.
|
|
if (has_capability('moodle/course:manageactivities', $context)) {
|
|
|
|
$additionalfields = array('timecreated', 'timemodified', 'typeid', 'toolurl', 'securetoolurl',
|
|
'instructorchoicesendname', 'instructorchoicesendemailaddr', 'instructorchoiceallowroster',
|
|
'instructorchoiceallowsetting', 'instructorcustomparameters', 'instructorchoiceacceptgrades', 'grade',
|
|
'resourcekey', 'password', 'debuglaunch', 'servicesalt', 'visible', 'groupmode', 'groupingid');
|
|
$viewablefields = array_merge($viewablefields, $additionalfields);
|
|
|
|
}
|
|
|
|
foreach ($viewablefields as $field) {
|
|
$module[$field] = $lti->{$field};
|
|
}
|
|
|
|
$returnedltis[] = $module;
|
|
}
|
|
}
|
|
|
|
$result = array();
|
|
$result['ltis'] = $returnedltis;
|
|
$result['warnings'] = $warnings;
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Describes the get_ltis_by_courses return value.
|
|
*
|
|
* @return external_single_structure
|
|
* @since Moodle 3.0
|
|
*/
|
|
public static function get_ltis_by_courses_returns() {
|
|
|
|
return new external_single_structure(
|
|
array(
|
|
'ltis' => new external_multiple_structure(
|
|
new external_single_structure(
|
|
array(
|
|
'id' => new external_value(PARAM_INT, 'External tool id'),
|
|
'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
|
|
'course' => new external_value(PARAM_INT, 'Course id'),
|
|
'name' => new external_value(PARAM_RAW, 'LTI name'),
|
|
'intro' => new external_value(PARAM_RAW, 'The LTI intro', VALUE_OPTIONAL),
|
|
'introformat' => new external_format_value('intro', VALUE_OPTIONAL),
|
|
'timecreated' => new external_value(PARAM_INT, 'Time of creation', VALUE_OPTIONAL),
|
|
'timemodified' => new external_value(PARAM_INT, 'Time of last modification', VALUE_OPTIONAL),
|
|
'typeid' => new external_value(PARAM_INT, 'Type id', VALUE_OPTIONAL),
|
|
'toolurl' => new external_value(PARAM_URL, 'Tool url', VALUE_OPTIONAL),
|
|
'securetoolurl' => new external_value(PARAM_RAW, 'Secure tool url', VALUE_OPTIONAL),
|
|
'instructorchoicesendname' => new external_value(PARAM_TEXT, 'Instructor choice send name',
|
|
VALUE_OPTIONAL),
|
|
'instructorchoicesendemailaddr' => new external_value(PARAM_INT, 'instructor choice send mail address',
|
|
VALUE_OPTIONAL),
|
|
'instructorchoiceallowroster' => new external_value(PARAM_INT, 'Instructor choice allow roster',
|
|
VALUE_OPTIONAL),
|
|
'instructorchoiceallowsetting' => new external_value(PARAM_INT, 'Instructor choice allow setting',
|
|
VALUE_OPTIONAL),
|
|
'instructorcustomparameters' => new external_value(PARAM_RAW, 'instructor custom parameters',
|
|
VALUE_OPTIONAL),
|
|
'instructorchoiceacceptgrades' => new external_value(PARAM_INT, 'instructor choice accept grades',
|
|
VALUE_OPTIONAL),
|
|
'grade' => new external_value(PARAM_INT, 'Enable grades', VALUE_OPTIONAL),
|
|
'launchcontainer' => new external_value(PARAM_INT, 'Launch container mode', VALUE_OPTIONAL),
|
|
'resourcekey' => new external_value(PARAM_RAW, 'Resource key', VALUE_OPTIONAL),
|
|
'password' => new external_value(PARAM_RAW, 'Shared secret', VALUE_OPTIONAL),
|
|
'debuglaunch' => new external_value(PARAM_INT, 'Debug launch', VALUE_OPTIONAL),
|
|
'showtitlelaunch' => new external_value(PARAM_INT, 'Show title launch', VALUE_OPTIONAL),
|
|
'showdescriptionlaunch' => new external_value(PARAM_INT, 'Show description launch', VALUE_OPTIONAL),
|
|
'servicesalt' => new external_value(PARAM_RAW, 'Service salt', VALUE_OPTIONAL),
|
|
'icon' => new external_value(PARAM_URL, 'Alternative icon URL', VALUE_OPTIONAL),
|
|
'secureicon' => new external_value(PARAM_URL, 'Secure icon URL', VALUE_OPTIONAL),
|
|
'section' => new external_value(PARAM_INT, 'course section id', VALUE_OPTIONAL),
|
|
'visible' => new external_value(PARAM_INT, 'visible', VALUE_OPTIONAL),
|
|
'groupmode' => new external_value(PARAM_INT, 'group mode', VALUE_OPTIONAL),
|
|
'groupingid' => new external_value(PARAM_INT, 'group id', VALUE_OPTIONAL),
|
|
), 'Tool'
|
|
)
|
|
),
|
|
'warnings' => new external_warnings(),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns description of method parameters
|
|
*
|
|
* @return external_function_parameters
|
|
* @since Moodle 3.0
|
|
*/
|
|
public static function view_lti_parameters() {
|
|
return new external_function_parameters(
|
|
array(
|
|
'ltiid' => new external_value(PARAM_INT, 'lti instance id')
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Trigger the course module viewed event and update the module completion status.
|
|
*
|
|
* @param int $ltiid the lti instance id
|
|
* @return array of warnings and status result
|
|
* @since Moodle 3.0
|
|
* @throws moodle_exception
|
|
*/
|
|
public static function view_lti($ltiid) {
|
|
global $DB;
|
|
|
|
$params = self::validate_parameters(self::view_lti_parameters(),
|
|
array(
|
|
'ltiid' => $ltiid
|
|
));
|
|
$warnings = array();
|
|
|
|
// Request and permission validation.
|
|
$lti = $DB->get_record('lti', array('id' => $params['ltiid']), '*', MUST_EXIST);
|
|
list($course, $cm) = get_course_and_cm_from_instance($lti, 'lti');
|
|
|
|
$context = context_module::instance($cm->id);
|
|
self::validate_context($context);
|
|
require_capability('mod/lti:view', $context);
|
|
|
|
// Trigger course_module_viewed event and completion.
|
|
lti_view($lti, $course, $cm, $context);
|
|
|
|
$result = array();
|
|
$result['status'] = true;
|
|
$result['warnings'] = $warnings;
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Returns description of method result value
|
|
*
|
|
* @return external_description
|
|
* @since Moodle 3.0
|
|
*/
|
|
public static function view_lti_returns() {
|
|
return new external_single_structure(
|
|
array(
|
|
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
|
|
'warnings' => new external_warnings()
|
|
)
|
|
);
|
|
}
|
|
}
|