Implementation of the LTI Memberships service.
// a real LTI instance.
$coursecontext = context_course::instance($courseid);
- if (has_capability('moodle/course:manageactivities', $coursecontext)) {
+ if (has_capability('moodle/course:manageactivities', $coursecontext, $user)) {
array_push($roles, 'Instructor');
} else {
array_push($roles, 'Learner');
--- /dev/null
+<?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/>.
+
+/**
+ * This file contains a class definition for the Context Memberships resource
+ *
+ * @package ltiservice_memberships
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @author Stephen Vickers
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+namespace ltiservice_memberships\local\resource;
+
+use \mod_lti\local\ltiservice\service_base;
+use ltiservice_memberships\local\service\memberships;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * A resource implementing Context Memberships.
+ *
+ * @package ltiservice_memberships
+ * @since Moodle 3.0
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class contextmemberships extends \mod_lti\local\ltiservice\resource_base {
+
+ /**
+ * Class constructor.
+ *
+ * @param ltiservice_memberships\local\service\memberships $service Service instance
+ */
+ public function __construct($service) {
+
+ parent::__construct($service);
+ $this->id = 'ToolProxyBindingMemberships';
+ $this->template = '/{context_type}/{context_id}/bindings/{vendor_code}/{product_code}/{tool_code}/memberships';
+ $this->variables[] = 'ToolProxyBinding.memberships.url';
+ $this->formats[] = 'application/vnd.ims.lis.v2.membershipcontainer+json';
+ $this->methods[] = 'GET';
+
+ }
+
+ /**
+ * Execute the request for this resource.
+ *
+ * @param mod_lti\local\ltiservice\response $response Response object for this request.
+ */
+ public function execute($response) {
+ global $CFG, $DB;
+
+ $params = $this->parse_template();
+ $role = optional_param('role', '', PARAM_TEXT);
+ $limitnum = optional_param('limit', 0, PARAM_INT);
+ $limitfrom = optional_param('from', 0, PARAM_INT);
+ if ($limitnum <= 0) {
+ $limitfrom = 0;
+ }
+
+ try {
+ if (!$this->get_service()->check_tool_proxy($params['product_code'])) {
+ throw new \Exception(null, 401);
+ }
+ if (!($course = $DB->get_record('course', array('id' => $params['context_id']), 'id', IGNORE_MISSING))) {
+ throw new \Exception(null, 404);
+ }
+ if (!($context = \context_course::instance($course->id))) {
+ throw new \Exception(null, 404);
+ }
+ if (!($tool = $DB->get_record('lti_types', array('id' => $params['tool_code']),
+ 'toolproxyid,enabledcapability,parameter', IGNORE_MISSING))) {
+ throw new \Exception(null, 404);
+ }
+ $toolproxy = $DB->get_record('lti_tool_proxies', array('id' => $tool->toolproxyid), 'guid', IGNORE_MISSING);
+ if (!$toolproxy || ($toolproxy->guid !== $this->get_service()->get_tool_proxy()->guid)) {
+ throw new \Exception(null, 400);
+ }
+ $json = memberships::get_users_json($this, $context, $course->id, $tool, $role, $limitfrom, $limitnum, null, null);
+
+ $response->set_content_type($this->formats[0]);
+ $response->set_body($json);
+
+ } catch (\Exception $e) {
+ $response->set_code($e->getCode());
+ }
+ }
+
+ /**
+ * Parse a value for custom parameter substitution variables.
+ *
+ * @param string $value String to be parsed
+ *
+ * @return string
+ */
+ public function parse_value($value) {
+ global $COURSE, $DB;
+
+ if ($COURSE->id === SITEID) {
+ $this->params['context_type'] = 'Group';
+ } else {
+ $this->params['context_type'] = 'CourseSection';
+ }
+ $this->params['context_id'] = $COURSE->id;
+ $this->params['vendor_code'] = $this->get_service()->get_tool_proxy()->vendorcode;
+ $this->params['product_code'] = $this->get_service()->get_tool_proxy()->guid;
+
+ $id = optional_param('id', 0, PARAM_INT); // Course Module ID.
+ if (!empty($id)) {
+ $cm = get_coursemodule_from_id('lti', $id, 0, false, IGNORE_MISSING);
+ $lti = $DB->get_record('lti', array('id' => $cm->instance), 'typeid', IGNORE_MISSING);
+ if ($lti && !empty($lti->typeid)) {
+ $this->params['tool_code'] = $lti->typeid;
+ }
+ }
+ $value = str_replace('$ToolProxyBinding.memberships.url', parent::get_endpoint(), $value);
+
+ return $value;
+
+ }
+
+}
--- /dev/null
+<?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/>.
+
+/**
+ * This file contains a class definition for the Link Memberships resource
+ *
+ * @package ltiservice_memberships
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @author Stephen Vickers
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+namespace ltiservice_memberships\local\resource;
+
+use \mod_lti\local\ltiservice\service_base;
+use ltiservice_memberships\local\service\memberships;
+use core_availability\info;
+use core_availability\info_module;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * A resource implementing Link Memberships.
+ *
+ * @package ltiservice_memberships
+ * @since Moodle 3.0
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class linkmemberships extends \mod_lti\local\ltiservice\resource_base {
+
+ /**
+ * Class constructor.
+ *
+ * @param ltiservice_memberships\local\service\memberships $service Service instance
+ */
+ public function __construct($service) {
+
+ parent::__construct($service);
+ $this->id = 'LtiLinkMemberships';
+ $this->template = '/links/{link_id}/memberships';
+ $this->variables[] = 'LtiLink.memberships.url';
+ $this->formats[] = 'application/vnd.ims.lis.v2.membershipcontainer+json';
+ $this->methods[] = 'GET';
+
+ }
+
+ /**
+ * Execute the request for this resource.
+ *
+ * @param mod_lti\local\ltiservice\response $response Response object for this request.
+ */
+ public function execute($response) {
+ global $CFG, $DB;
+
+ $params = $this->parse_template();
+ $linkid = $params['link_id'];
+ $role = optional_param('role', '', PARAM_TEXT);
+ $limitnum = optional_param('limit', 0, PARAM_INT);
+ $limitfrom = optional_param('from', 0, PARAM_INT);
+ if ($limitnum <= 0) {
+ $limitfrom = 0;
+ }
+
+ try {
+ if (empty($linkid)) {
+ throw new \Exception(null, 404);
+ }
+ if (!($lti = $DB->get_record('lti', array('id' => $linkid), 'id,course,typeid,servicesalt', IGNORE_MISSING))) {
+ throw new \Exception(null, 404);
+ }
+ $tool = $DB->get_record('lti_types', array('id' => $lti->typeid));
+ $toolproxy = $DB->get_record('lti_tool_proxies', array('id' => $tool->toolproxyid));
+ if (!$this->check_tool_proxy($toolproxy->guid, $response->get_request_data())) {
+ throw new \Exception(null, 401);
+ }
+ if (!($course = $DB->get_record('course', array('id' => $lti->course), 'id', IGNORE_MISSING))) {
+ throw new \Exception(null, 404);
+ }
+ if (!($context = \context_course::instance($lti->course))) {
+ throw new \Exception(null, 404);
+ }
+ $modinfo = get_fast_modinfo($course);
+ $cm = get_coursemodule_from_instance('lti', $linkid, $lti->course, false, MUST_EXIST);
+ $cm = $modinfo->get_cm($cm->id);
+ $info = new info_module($cm);
+ if ($info->is_available_for_all()) {
+ $info = null;
+ }
+
+ $json = memberships::get_users_json($this, $context, $lti->course, $tool, $role, $limitfrom, $limitnum, $lti, $info);
+
+ $response->set_content_type($this->formats[0]);
+ $response->set_body($json);
+
+ } catch (\Exception $e) {
+ $response->set_code($e->getCode());
+ }
+
+ }
+
+ /**
+ * Parse a value for custom parameter substitution variables.
+ *
+ * @param string $value String to be parsed
+ *
+ * @return string
+ */
+ public function parse_value($value) {
+
+ $id = optional_param('id', 0, PARAM_INT); // Course Module ID.
+ if (!empty($id)) {
+ $cm = get_coursemodule_from_id('lti', $id, 0, false, MUST_EXIST);
+ $this->params['link_id'] = $cm->instance;
+ }
+ $value = str_replace('$LtiLink.memberships.url', parent::get_endpoint(), $value);
+
+ return $value;
+
+ }
+
+}
--- /dev/null
+<?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/>.
+
+/**
+ * This file contains a class definition for the Memberships service
+ *
+ * @package ltiservice_memberships
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @author Stephen Vickers
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+namespace ltiservice_memberships\local\service;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * A service implementing Memberships.
+ *
+ * @package ltiservice_memberships
+ * @since Moodle 3.0
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class memberships extends \mod_lti\local\ltiservice\service_base {
+
+ /** Default prefix for context-level roles */
+ const CONTEXT_ROLE_PREFIX = 'http://purl.imsglobal.org/vocab/lis/v2/membership#';
+ /** Context-level role for Instructor */
+ const CONTEXT_ROLE_INSTRUCTOR = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor';
+ /** Context-level role for Learner */
+ const CONTEXT_ROLE_LEARNER = 'http://purl.imsglobal.org/vocab/lis/v2/membership#Learner';
+ /** Capability used to identify Instructors */
+ const INSTRUCTOR_CAPABILITY = 'moodle/course:manageactivities';
+
+ /**
+ * Class constructor.
+ */
+ public function __construct() {
+
+ parent::__construct();
+ $this->id = 'memberships';
+ $this->name = get_string('servicename', 'ltiservice_memberships');
+
+ }
+
+ /**
+ * Get the resources for this service.
+ *
+ * @return array
+ */
+ public function get_resources() {
+
+ if (empty($this->resources)) {
+ $this->resources = array();
+ $this->resources[] = new \ltiservice_memberships\local\resource\contextmemberships($this);
+ $this->resources[] = new \ltiservice_memberships\local\resource\linkmemberships($this);
+ }
+
+ return $this->resources;
+
+ }
+
+ /**
+ * Get the JSON for members.
+ *
+ * @param \mod_lti\local\ltiservice\resource_base $resource Resource handling the request
+ * @param \context_course $context Course context
+ * @param string $id Course ID
+ * @param object $tool Tool instance object
+ * @param string $role User role requested (empty if none)
+ * @param int $limitfrom Position of first record to be returned
+ * @param int $limitnum Maximum number of records to be returned
+ * @param object $lti LTI instance record
+ * @param info_module $info Conditional availability information for LTI instance (null if context-level request)
+ *
+ * @return array
+ */
+ public static function get_users_json($resource, $context, $id, $tool, $role, $limitfrom, $limitnum, $lti, $info) {
+
+ $withcapability = '';
+ $exclude = array();
+ if (!empty($role)) {
+ if ((strpos($role, 'http://') !== 0) && (strpos($role, 'https://') !== 0)) {
+ $role = self::CONTEXT_ROLE_PREFIX . $role;
+ }
+ if ($role === self::CONTEXT_ROLE_INSTRUCTOR) {
+ $withcapability = self::INSTRUCTOR_CAPABILITY;
+ } else if ($role === self::CONTEXT_ROLE_LEARNER) {
+ $exclude = array_keys(get_enrolled_users($context, self::INSTRUCTOR_CAPABILITY, 0, 'u.id',
+ null, null, null, true));
+ }
+ }
+ $users = get_enrolled_users($context, $withcapability, 0, 'u.*', null, $limitfrom, $limitnum, true);
+ if (count($users) < $limitnum) {
+ $limitfrom = 0;
+ $limitnum = 0;
+ }
+ $json = self::users_to_json($resource, $users, $id, $tool, $exclude, $limitfrom, $limitnum, $lti, $info);
+
+ return $json;
+
+ }
+
+ /**
+ * Get the JSON representation of the users.
+ *
+ * Note that when a limit is set and the exclude array is not empty, then the number of memberships
+ * returned may be less than the limit.
+ *
+ * @param \mod_lti\local\ltiservice\resource_base $resource Resource handling the request
+ * @param array $users Array of user records
+ * @param string $id Course ID
+ * @param object $tool Tool instance object
+ * @param array $exclude Array of user records to be excluded from the response
+ * @param int $limitfrom Position of first record to be returned
+ * @param int $limitnum Maximum number of records to be returned
+ * @param object $lti LTI instance record
+ * @param \core_availability\info_module $info Conditional availability information for LTI instance
+ *
+ * @return string
+ */
+ private static function users_to_json($resource, $users, $id, $tool, $exclude, $limitfrom, $limitnum,
+ $lti, $info) {
+
+ $nextpage = 'null';
+ if ($limitnum > 0) {
+ $limitfrom += $limitnum;
+ $nextpage = "\"{$resource->get_endpoint()}?limit={$limitnum}&from={$limitfrom}\"";
+ }
+ $json = <<< EOD
+{
+ "@context" : "http://purl.imsglobal.org/ctx/lis/v2/MembershipContainer",
+ "@type" : "Page",
+ "@id" : "{$resource->get_endpoint()}",
+ "nextPage" : {$nextpage},
+ "pageOf" : {
+ "@type" : "LISMembershipContainer",
+ "membershipSubject" : {
+ "@type" : "Context",
+ "contextId" : "{$id}",
+ "membership" : [
+
+EOD;
+ $enabledcapabilities = lti_get_enabled_capabilities($tool);
+ $sep = ' ';
+ foreach ($users as $user) {
+ $include = !in_array($user->id, $exclude);
+ if ($include && !empty($info)) {
+ $include = $info->is_user_visible($info->get_course_module(), $user->id);
+ }
+ if ($include) {
+ $member = new \stdClass();
+ if (in_array('User.id', $enabledcapabilities)) {
+ $member->userId = $user->id;
+ }
+ if (in_array('Person.sourcedId', $enabledcapabilities)) {
+ $member->sourcedId = format_string($user->idnumber);
+ }
+ if (in_array('Person.name.full', $enabledcapabilities)) {
+ $member->name = format_string("{$user->firstname} {$user->lastname}");
+ }
+ if (in_array('Person.name.given', $enabledcapabilities)) {
+ $member->givenName = format_string($user->firstname);
+ }
+ if (in_array('Person.name.family', $enabledcapabilities)) {
+ $member->familyName = format_string($user->lastname);
+ }
+ if (in_array('Person.email.primary', $enabledcapabilities)) {
+ $member->email = format_string($user->email);
+ }
+ if (in_array('Result.sourcedId', $enabledcapabilities) && !empty($lti) && !empty($lti->servicesalt)) {
+ $member->resultSourcedId = json_encode(lti_build_sourcedid($lti->id, $user->id, $lti->servicesalt,
+ $lti->typeid));
+ }
+ $roles = explode(',', lti_get_ims_role($user->id, null, $id, true));
+
+ $membership = new \stdClass();
+ $membership->status = 'Active';
+ $membership->member = $member;
+ $membership->role = $roles;
+
+ $json .= $sep . json_encode($membership);
+ $sep = ",\n ";
+ }
+
+ }
+
+ $json .= <<< EOD
+
+ ]
+ }
+ }
+}
+EOD;
+
+ return $json;
+
+ }
+
+}
--- /dev/null
+<?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/>.
+
+/**
+ * Strings for component 'ltiservice_memberships', language 'en'
+ *
+ * @package ltiservice_memberships
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @author Stephen Vickers
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['pluginname'] = 'Memberships LTI Service';
+$string['servicename'] = 'Memberships';
--- /dev/null
+<?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/>.
+
+/**
+ * Version information for the ltiservice_memberships service.
+ *
+ * @package ltiservice_memberships
+ * @copyright 2015 Vital Source Technologies http://vitalsource.com
+ * @author Stephen Vickers
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+defined('MOODLE_INTERNAL') || die();
+
+
+$plugin->version = 2015092000;
+$plugin->requires = 2014111000;
+$plugin->component = 'ltiservice_memberships';
