mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 00:46:50 +02:00
MDL-55825 enrol_lti: Upgrade member sync to use the new LTI library
This commit is contained in:
Jun Pataleta
parent
826ee7370e
commit
08237c3aa8
3 changed files with 467 additions and 173 deletions
|
|
@ -908,6 +908,79 @@ class data_connector extends DataConnector {
|
|||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the list of Context objects that are linked to a ToolConsumer.
|
||||
*
|
||||
* @param ToolConsumer $consumer
|
||||
* @return Context[]
|
||||
*/
|
||||
public function get_contexts_from_consumer(ToolConsumer $consumer) {
|
||||
global $DB;
|
||||
|
||||
$contexts = [];
|
||||
$contextrecords = $DB->get_records($this->contexttable, ['consumerid' => $consumer->getRecordId()], '', 'lticontextkey');
|
||||
foreach ($contextrecords as $record) {
|
||||
$context = Context::fromConsumer($consumer, $record->lticontextkey);
|
||||
$contexts[] = $context;
|
||||
}
|
||||
|
||||
return $contexts;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches a resource link record that is associated with a ToolConsumer.
|
||||
*
|
||||
* @param ToolConsumer $consumer
|
||||
* @return ResourceLink
|
||||
*/
|
||||
public function get_resourcelink_from_consumer(ToolConsumer $consumer) {
|
||||
global $DB;
|
||||
|
||||
$resourcelink = null;
|
||||
if ($resourcelinkrecord = $DB->get_record($this->resourcelinktable, ['consumerid' => $consumer->getRecordId()],
|
||||
'ltiresourcelinkkey')) {
|
||||
$resourcelink = ResourceLink::fromConsumer($consumer, $resourcelinkrecord->ltiresourcelinkkey);
|
||||
}
|
||||
|
||||
return $resourcelink;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches a resource link record that is associated with a Context object.
|
||||
*
|
||||
* @param Context $context
|
||||
* @return ResourceLink
|
||||
*/
|
||||
public function get_resourcelink_from_context(Context $context) {
|
||||
global $DB;
|
||||
|
||||
$resourcelink = null;
|
||||
if ($resourcelinkrecord = $DB->get_record($this->resourcelinktable, ['contextid' => $context->getRecordId()],
|
||||
'ltiresourcelinkkey')) {
|
||||
$resourcelink = ResourceLink::fromContext($context, $resourcelinkrecord->ltiresourcelinkkey);
|
||||
}
|
||||
|
||||
return $resourcelink;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Fetches the list of ToolConsumer objects that are linked to a tool.
|
||||
*
|
||||
* @param int $toolid
|
||||
* @return ToolConsumer[]
|
||||
*/
|
||||
public function get_consumers_mapped_to_tool($toolid) {
|
||||
global $DB;
|
||||
|
||||
$consumers = [];
|
||||
$consumerrecords = $DB->get_records('enrol_lti_tool_consumer_map', ['toolid' => $toolid], '', 'consumerid');
|
||||
foreach ($consumerrecords as $record) {
|
||||
$consumers[] = ToolConsumer::fromRecordId($record->consumerid, $this);
|
||||
}
|
||||
return $consumers;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a ToolConsumer object from a record object from the DB.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -24,6 +24,20 @@
|
|||
|
||||
namespace enrol_lti\task;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
use core\task\scheduled_task;
|
||||
use core_user;
|
||||
use enrol_lti\data_connector;
|
||||
use enrol_lti\helper;
|
||||
use IMSGlobal\LTI\ToolProvider\Context;
|
||||
use IMSGlobal\LTI\ToolProvider\ResourceLink;
|
||||
use IMSGlobal\LTI\ToolProvider\ToolConsumer;
|
||||
use IMSGlobal\LTI\ToolProvider\User;
|
||||
use stdClass;
|
||||
|
||||
require_once($CFG->dirroot . '/user/lib.php');
|
||||
|
||||
/**
|
||||
* Task for synchronising members using the enrolment LTI.
|
||||
*
|
||||
|
|
@ -31,17 +45,16 @@ namespace enrol_lti\task;
|
|||
* @copyright 2016 Mark Nelson <markn@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class sync_members extends \core\task\scheduled_task {
|
||||
class sync_members extends scheduled_task {
|
||||
|
||||
/**
|
||||
* The LTI message type.
|
||||
*/
|
||||
const LTI_MESSAGE_TYPE = 'basic-lis-readmembershipsforcontext';
|
||||
/** @var array Array of user photos. */
|
||||
protected $userphotos = [];
|
||||
|
||||
/**
|
||||
* The LTI version.
|
||||
*/
|
||||
const LTI_VERSION = 'LTI-1p0';
|
||||
/** @var array Array of current LTI users. */
|
||||
protected $currentusers = [];
|
||||
|
||||
/** @var data_connector $dataconnector A data_connector instance. */
|
||||
protected $dataconnector;
|
||||
|
||||
/**
|
||||
* Get a descriptive name for this task.
|
||||
|
|
@ -54,122 +67,193 @@ class sync_members extends \core\task\scheduled_task {
|
|||
|
||||
/**
|
||||
* Performs the synchronisation of members.
|
||||
*
|
||||
* @return bool|void
|
||||
*/
|
||||
public function execute() {
|
||||
global $CFG, $DB;
|
||||
|
||||
require_once($CFG->dirroot . '/enrol/lti/ims-blti/OAuth.php');
|
||||
require_once($CFG->dirroot . '/enrol/lti/ims-blti/OAuthBody.php');
|
||||
|
||||
// Check if the authentication plugin is disabled.
|
||||
if (!is_enabled_auth('lti')) {
|
||||
mtrace('Skipping task - ' . get_string('pluginnotenabled', 'auth', get_string('pluginname', 'auth_lti')));
|
||||
return true;
|
||||
return;
|
||||
}
|
||||
|
||||
// Check if the enrolment plugin is disabled - isn't really necessary as the task should not run if
|
||||
// the plugin is disabled, but there is no harm in making sure core hasn't done something wrong.
|
||||
if (!enrol_is_enabled('lti')) {
|
||||
mtrace('Skipping task - ' . get_string('enrolisdisabled', 'enrol_lti'));
|
||||
return true;
|
||||
return;
|
||||
}
|
||||
|
||||
$this->dataconnector = new data_connector();
|
||||
|
||||
// Get all the enabled tools.
|
||||
if ($tools = \enrol_lti\helper::get_lti_tools(array('status' => ENROL_INSTANCE_ENABLED, 'membersync' => 1))) {
|
||||
$ltiplugin = enrol_get_plugin('lti');
|
||||
$consumers = array();
|
||||
$currentusers = array();
|
||||
$userphotos = array();
|
||||
$tools = helper::get_lti_tools(array('status' => ENROL_INSTANCE_ENABLED, 'membersync' => 1));
|
||||
foreach ($tools as $tool) {
|
||||
mtrace("Starting - Member sync for shared tool '$tool->id' for the course '$tool->courseid'.");
|
||||
mtrace("Starting - Member sync for published tool '$tool->id' for course '$tool->courseid'.");
|
||||
|
||||
// Variables to keep track of information to display later.
|
||||
$usercount = 0;
|
||||
$enrolcount = 0;
|
||||
$unenrolcount = 0;
|
||||
|
||||
// We check for all the users - users can access the same tool from different consumers.
|
||||
if ($ltiusers = $DB->get_records('enrol_lti_users', array('toolid' => $tool->id), 'lastaccess DESC')) {
|
||||
foreach ($ltiusers as $ltiuser) {
|
||||
$mtracecontent = "for the user '$ltiuser->userid' in the tool '$tool->id' for the course " .
|
||||
"'$tool->courseid'";
|
||||
// Fetch consumer records mapped to this tool.
|
||||
$consumers = $this->dataconnector->get_consumers_mapped_to_tool($tool->id);
|
||||
|
||||
// Perform processing for each consumer.
|
||||
foreach ($consumers as $consumer) {
|
||||
mtrace("Requesting membership service for the tool consumer '{$consumer->getRecordId()}'");
|
||||
|
||||
// Get members through this tool consumer.
|
||||
$members = $this->fetch_members_from_consumer($consumer);
|
||||
|
||||
// Check if we were able to fetch the members.
|
||||
if ($members === false) {
|
||||
mtrace("Skipping - Membership service request failed.\n");
|
||||
continue;
|
||||
}
|
||||
|
||||
// Fetched members count.
|
||||
$membercount = count($members);
|
||||
mtrace("$membercount members received.\n");
|
||||
|
||||
// Process member information.
|
||||
list($usercount, $enrolcount) = $this->sync_member_information($tool, $consumer, $members);
|
||||
}
|
||||
|
||||
// Now we check if we have to unenrol users who were not listed.
|
||||
if ($this->should_sync_unenrol($tool->membersyncmode)) {
|
||||
$this->sync_unenrol($tool);
|
||||
}
|
||||
|
||||
mtrace("Completed - Synced members for tool '$tool->id' in the course '$tool->courseid'. " .
|
||||
"Processed $usercount users; enrolled $enrolcount members; unenrolled $unenrolcount members.\n");
|
||||
}
|
||||
|
||||
// Sync the user profile photos.
|
||||
mtrace("Started - Syncing user profile images.");
|
||||
$countsyncedimages = $this->sync_profile_images();
|
||||
mtrace("Completed - Synced $countsyncedimages profile images.");
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the members that belong to a ToolConsumer.
|
||||
*
|
||||
* @param ToolConsumer $consumer
|
||||
* @return bool|User[]
|
||||
*/
|
||||
protected function fetch_members_from_consumer(ToolConsumer $consumer) {
|
||||
$dataconnector = $this->dataconnector;
|
||||
|
||||
// Get membership URL template from consumer profile data.
|
||||
$defaultmembershipsurl = null;
|
||||
if (isset($consumer->profile->service_offered)) {
|
||||
$servicesoffered = $consumer->profile->service_offered;
|
||||
foreach ($servicesoffered as $service) {
|
||||
if (isset($service->{'@id'}) && strpos($service->{'@id'}, 'tcp:ToolProxyBindingMemberships') !== false &&
|
||||
isset($service->endpoint)) {
|
||||
$defaultmembershipsurl = $service->endpoint;
|
||||
if (isset($consumer->profile->product_instance->product_info->product_family->vendor->code)) {
|
||||
$vendorcode = $consumer->profile->product_instance->product_info->product_family->vendor->code;
|
||||
$defaultmembershipsurl = str_replace('{vendor_code}', $vendorcode, $defaultmembershipsurl);
|
||||
}
|
||||
$defaultmembershipsurl = str_replace('{product_code}', $consumer->getKey(), $defaultmembershipsurl);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$members = false;
|
||||
|
||||
// Fetch the resource link linked to the consumer.
|
||||
$resourcelink = $dataconnector->get_resourcelink_from_consumer($consumer);
|
||||
if ($resourcelink !== null) {
|
||||
// Try to perform a membership service request using this resource link.
|
||||
$members = $this->do_resourcelink_membership_request($resourcelink);
|
||||
}
|
||||
|
||||
// If membership service can't be performed through resource link, fallback through context memberships.
|
||||
if ($members === false) {
|
||||
// Fetch context records that are mapped to this ToolConsumer.
|
||||
$contexts = $dataconnector->get_contexts_from_consumer($consumer);
|
||||
|
||||
// Perform membership service request for each of these contexts.
|
||||
foreach ($contexts as $context) {
|
||||
$contextmembership = $this->do_context_membership_request($context, $resourcelink, $defaultmembershipsurl);
|
||||
if ($contextmembership) {
|
||||
// Add $contextmembership contents to $members array.
|
||||
if (is_array($members)) {
|
||||
$members = array_merge($members, $contextmembership);
|
||||
} else {
|
||||
$members = $contextmembership;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $members;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to determine whether to sync unenrolments or not.
|
||||
*
|
||||
* @param int $syncmode The tool's membersyncmode.
|
||||
* @return bool
|
||||
*/
|
||||
protected function should_sync_unenrol($syncmode) {
|
||||
return $syncmode == helper::MEMBER_SYNC_ENROL_AND_UNENROL || $syncmode == helper::MEMBER_SYNC_UNENROL_MISSING;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to determine whether to sync enrolments or not.
|
||||
*
|
||||
* @param int $syncmode The tool's membersyncmode.
|
||||
* @return bool
|
||||
*/
|
||||
protected function should_sync_enrol($syncmode) {
|
||||
return $syncmode == helper::MEMBER_SYNC_ENROL_AND_UNENROL || $syncmode == helper::MEMBER_SYNC_ENROL_NEW;
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs synchronisation of member information and enrolments.
|
||||
*
|
||||
* @param stdClass $tool
|
||||
* @param ToolConsumer $consumer
|
||||
* @param User[] $members
|
||||
* @return array An array containing the number of members that were processed and the number of members that were enrolled.
|
||||
*/
|
||||
protected function sync_member_information(stdClass $tool, ToolConsumer $consumer, $members) {
|
||||
global $DB;
|
||||
$usercount = 0;
|
||||
$enrolcount = 0;
|
||||
|
||||
// Process member information.
|
||||
foreach ($members as $member) {
|
||||
$usercount++;
|
||||
|
||||
// Check if we do not have a membershipsurl - this can happen if the sync process has an unexpected error.
|
||||
if (!$ltiuser->membershipsurl) {
|
||||
mtrace("Skipping - Empty membershipsurl $mtracecontent.");
|
||||
continue;
|
||||
}
|
||||
|
||||
// Check if we do not have a membershipsid - this can happen if the sync process has an unexpected error.
|
||||
if (!$ltiuser->membershipsid) {
|
||||
mtrace("Skipping - Empty membershipsid $mtracecontent.");
|
||||
continue;
|
||||
}
|
||||
|
||||
$consumer = sha1($ltiuser->membershipsurl . ':' . $ltiuser->membershipsid . ':' .
|
||||
$ltiuser->consumerkey . ':' . $ltiuser->consumersecret);
|
||||
if (in_array($consumer, $consumers)) {
|
||||
// We have already synchronised with this consumer.
|
||||
continue;
|
||||
}
|
||||
|
||||
$consumers[] = $consumer;
|
||||
|
||||
$params = array(
|
||||
'lti_message_type' => self::LTI_MESSAGE_TYPE,
|
||||
'id' => $ltiuser->membershipsid,
|
||||
'lti_version' => self::LTI_VERSION
|
||||
);
|
||||
|
||||
mtrace("Calling memberships url '$ltiuser->membershipsurl' with body '" .
|
||||
json_encode($params) . "'");
|
||||
|
||||
try {
|
||||
$response = sendOAuthParamsPOST('POST', $ltiuser->membershipsurl, $ltiuser->consumerkey,
|
||||
$ltiuser->consumersecret, 'application/x-www-form-urlencoded', $params);
|
||||
} catch (\Exception $e) {
|
||||
mtrace("Skipping - No response received $mtracecontent from '$ltiuser->membershipsurl'");
|
||||
mtrace($e->getMessage());
|
||||
continue;
|
||||
}
|
||||
|
||||
// Check the response from the consumer.
|
||||
$data = new \SimpleXMLElement($response);
|
||||
|
||||
// Check if we did not receive a valid response.
|
||||
if (empty($data->statusinfo)) {
|
||||
mtrace("Skipping - Bad response received $mtracecontent from '$ltiuser->membershipsurl'");
|
||||
mtrace('Skipping - Error parsing the XML received \'' . substr($response, 0, 125) .
|
||||
'\' ... (Displaying only 125 chars)');
|
||||
continue;
|
||||
}
|
||||
|
||||
// Check if we did not receive a valid response.
|
||||
if (strpos(strtolower($data->statusinfo->codemajor), 'success') === false) {
|
||||
mtrace('Skipping - Error received from the remote system: ' . $data->statusinfo->codemajor
|
||||
. ' ' . $data->statusinfo->severity . ' ' . $data->statusinfo->codeminor);
|
||||
continue;
|
||||
}
|
||||
|
||||
$members = $data->memberships->member;
|
||||
mtrace(count($members) . ' members received.');
|
||||
foreach ($members as $member) {
|
||||
// Set the user data.
|
||||
$user = new \stdClass();
|
||||
$user->username = \enrol_lti\helper::create_username($ltiuser->consumerkey, $member->user_id);
|
||||
$user->firstname = \core_user::clean_field($member->person_name_given, 'firstname');
|
||||
$user->lastname = \core_user::clean_field($member->person_name_family, 'lastname');
|
||||
$user->email = \core_user::clean_field($member->person_contact_email_primary, 'email');
|
||||
$user = new stdClass();
|
||||
$user->username = helper::create_username($consumer->getKey(), $member->ltiUserId);
|
||||
$user->firstname = core_user::clean_field($member->firstname, 'firstname');
|
||||
$user->lastname = core_user::clean_field($member->lastname, 'lastname');
|
||||
$user->email = core_user::clean_field($member->email, 'email');
|
||||
|
||||
// Get the user data from the LTI consumer.
|
||||
$user = \enrol_lti\helper::assign_user_tool_data($tool, $user);
|
||||
$user = helper::assign_user_tool_data($tool, $user);
|
||||
|
||||
if (!$dbuser = $DB->get_record('user', array('username' => $user->username, 'deleted' => 0))) {
|
||||
if ($tool->membersyncmode == \enrol_lti\helper::MEMBER_SYNC_ENROL_AND_UNENROL ||
|
||||
$tool->membersyncmode == \enrol_lti\helper::MEMBER_SYNC_ENROL_NEW) {
|
||||
$dbuser = core_user::get_user_by_username($user->username, 'id');
|
||||
if ($dbuser) {
|
||||
// If email is empty remove it, so we don't update the user with an empty email.
|
||||
if (empty($user->email)) {
|
||||
unset($user->email);
|
||||
}
|
||||
|
||||
$user->id = $dbuser->id;
|
||||
user_update_user($user);
|
||||
|
||||
// Add the information to the necessary arrays.
|
||||
if (!in_array($user->id, $this->currentusers)) {
|
||||
$this->currentusers[] = $user->id;
|
||||
}
|
||||
$this->userphotos[$user->id] = $member->image;
|
||||
} else {
|
||||
if ($this->should_sync_enrol($tool->membersyncmode)) {
|
||||
// If the email was stripped/not set then fill it with a default one. This
|
||||
// stops the user from being redirected to edit their profile page.
|
||||
if (empty($user->email)) {
|
||||
|
|
@ -180,57 +264,83 @@ class sync_members extends \core\task\scheduled_task {
|
|||
$user->id = user_create_user($user);
|
||||
|
||||
// Add the information to the necessary arrays.
|
||||
$currentusers[] = $user->id;
|
||||
$userphotos[$user->id] = $member->user_image;
|
||||
$this->currentusers[] = $user->id;
|
||||
$this->userphotos[$user->id] = $member->image;
|
||||
}
|
||||
} else {
|
||||
// If email is empty remove it, so we don't update the user with an empty email.
|
||||
if (empty($user->email)) {
|
||||
unset($user->email);
|
||||
}
|
||||
|
||||
$user->id = $dbuser->id;
|
||||
user_update_user($user);
|
||||
|
||||
// Add the information to the necessary arrays.
|
||||
$currentusers[] = $user->id;
|
||||
$userphotos[$user->id] = $member->user_image;
|
||||
}
|
||||
if ($tool->membersyncmode == \enrol_lti\helper::MEMBER_SYNC_ENROL_AND_UNENROL ||
|
||||
$tool->membersyncmode == \enrol_lti\helper::MEMBER_SYNC_ENROL_NEW) {
|
||||
// Sync enrolments.
|
||||
if ($this->should_sync_enrol($tool->membersyncmode)) {
|
||||
// Enrol the user in the course.
|
||||
\enrol_lti\helper::enrol_user($tool, $user->id);
|
||||
if (helper::enrol_user($tool, $user->id) === helper::ENROLMENT_SUCCESSFUL) {
|
||||
// Increment enrol count.
|
||||
$enrolcount++;
|
||||
}
|
||||
|
||||
// Check if this user has already been registered in the enrol_lti_users table.
|
||||
if (!$DB->record_exists('enrol_lti_users', ['toolid' => $tool->id, 'userid' => $user->id])) {
|
||||
// Create an initial enrol_lti_user record that we can use later when syncing grades and members.
|
||||
$userlog = new stdClass();
|
||||
$userlog->userid = $user->id;
|
||||
$userlog->toolid = $tool->id;
|
||||
$userlog->consumerkey = $consumer->getKey();
|
||||
|
||||
$DB->insert_record('enrol_lti_users', $userlog);
|
||||
}
|
||||
}
|
||||
}
|
||||
// Now we check if we have to unenrol users who were not listed.
|
||||
if ($tool->membersyncmode == \enrol_lti\helper::MEMBER_SYNC_ENROL_AND_UNENROL ||
|
||||
$tool->membersyncmode == \enrol_lti\helper::MEMBER_SYNC_UNENROL_MISSING) {
|
||||
|
||||
return [$usercount, $enrolcount];
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs unenrolment of users that are no longer enrolled in the consumer side.
|
||||
*
|
||||
* @param stdClass $tool The tool record object.
|
||||
* @return int The number of users that have been unenrolled.
|
||||
*/
|
||||
protected function sync_unenrol(stdClass $tool) {
|
||||
global $DB;
|
||||
|
||||
$ltiplugin = enrol_get_plugin('lti');
|
||||
|
||||
if (!$this->should_sync_unenrol($tool->membersyncmode)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (empty($this->currentusers)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$unenrolcount = 0;
|
||||
|
||||
$ltiusersrs = $DB->get_recordset('enrol_lti_users', array('toolid' => $tool->id), 'lastaccess DESC', 'userid');
|
||||
// Go through the users and check if any were never listed, if so, remove them.
|
||||
foreach ($ltiusers as $ltiuser) {
|
||||
if (!in_array($ltiuser->userid, $currentusers)) {
|
||||
$instance = new \stdClass();
|
||||
foreach ($ltiusersrs as $ltiuser) {
|
||||
if (!in_array($ltiuser->userid, $this->currentusers)) {
|
||||
$instance = new stdClass();
|
||||
$instance->id = $tool->enrolid;
|
||||
$instance->courseid = $tool->courseid;
|
||||
$instance->enrol = 'lti';
|
||||
$ltiplugin->unenrol_user($instance, $ltiuser->id);
|
||||
$ltiplugin->unenrol_user($instance, $ltiuser->userid);
|
||||
// Increment unenrol count.
|
||||
$unenrolcount++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
mtrace("Completed - Synced members for tool '$tool->id' in the course '$tool->courseid'. " .
|
||||
"Processed $usercount users; enrolled $enrolcount members; unenrolled $unenrolcount members.");
|
||||
mtrace("");
|
||||
$ltiusersrs->close();
|
||||
|
||||
return $unenrolcount;
|
||||
}
|
||||
|
||||
// Sync the user profile photos.
|
||||
mtrace("Started - Syncing user profile images.");
|
||||
/**
|
||||
* Performs synchronisation of user profile images.
|
||||
*/
|
||||
protected function sync_profile_images() {
|
||||
$counter = 0;
|
||||
if (!empty($userphotos)) {
|
||||
foreach ($userphotos as $userid => $url) {
|
||||
foreach ($this->userphotos as $userid => $url) {
|
||||
if ($url) {
|
||||
$result = \enrol_lti\helper::update_user_profile_image($userid, $url);
|
||||
if ($result === \enrol_lti\helper::PROFILE_IMAGE_UPDATE_SUCCESSFUL) {
|
||||
$result = helper::update_user_profile_image($userid, $url);
|
||||
if ($result === helper::PROFILE_IMAGE_UPDATE_SUCCESSFUL) {
|
||||
$counter++;
|
||||
mtrace("Profile image succesfully downloaded and created for user '$userid' from $url.");
|
||||
} else {
|
||||
|
|
@ -238,8 +348,118 @@ class sync_members extends \core\task\scheduled_task {
|
|||
}
|
||||
}
|
||||
}
|
||||
return $counter;
|
||||
}
|
||||
mtrace("Completed - Synced $counter profile images.");
|
||||
|
||||
/**
|
||||
* Performs membership service request using an LTI Context object.
|
||||
*
|
||||
* If the context has a 'custom_context_memberships_url' setting, we use this to perform the membership service request.
|
||||
* Otherwise, if a context is associated with resource link, we try first to get the members using the
|
||||
* ResourceLink::doMembershipsService() method.
|
||||
* If we're still unable to fetch members from the resource link, we try to build a memberships URL from the memberships URL
|
||||
* endpoint template that is defined in the ToolConsumer profile and substitute the parameters accordingly.
|
||||
*
|
||||
* @param Context $context The context object.
|
||||
* @param ResourceLink $resourcelink The resource link object.
|
||||
* @param string $membershipsurltemplate The memberships endpoint URL template.
|
||||
* @return bool|User[] Array of User objects upon successful membership service request. False, otherwise.
|
||||
*/
|
||||
protected function do_context_membership_request(Context $context, ResourceLink $resourcelink = null,
|
||||
$membershipsurltemplate = '') {
|
||||
$dataconnector = $this->dataconnector;
|
||||
|
||||
// Flag to indicate whether to save the context later.
|
||||
$contextupdated = false;
|
||||
|
||||
// If membership URL is not set, try to generate using the default membership URL from the consumer profile.
|
||||
if (!$context->hasMembershipService()) {
|
||||
if (empty($membershipsurltemplate)) {
|
||||
mtrace("Skipping - No membership service available.\n");
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($resourcelink === null) {
|
||||
$resourcelink = $dataconnector->get_resourcelink_from_context($context);
|
||||
}
|
||||
|
||||
if ($resourcelink !== null) {
|
||||
// Try to perform a membership service request using this resource link.
|
||||
$resourcelinkmembers = $this->do_resourcelink_membership_request($resourcelink);
|
||||
if ($resourcelinkmembers) {
|
||||
// If we're able to fetch members using this resource link, return these.
|
||||
return $resourcelinkmembers;
|
||||
}
|
||||
}
|
||||
|
||||
// If fetching memberships through resource link failed and we don't have a memberships URL, build one from template.
|
||||
mtrace("'custom_context_memberships_url' not set. Fetching default template: $membershipsurltemplate");
|
||||
$membershipsurl = $membershipsurltemplate;
|
||||
|
||||
// Check if we need to fetch tool code.
|
||||
$needstoolcode = strpos($membershipsurl, '{tool_code}') !== false;
|
||||
if ($needstoolcode) {
|
||||
$toolcode = false;
|
||||
|
||||
// Fetch tool code from the resource link data.
|
||||
$lisresultsourcedidjson = $resourcelink->getSetting('lis_result_sourcedid');
|
||||
if ($lisresultsourcedidjson) {
|
||||
$lisresultsourcedid = json_decode($lisresultsourcedidjson);
|
||||
if (isset($lisresultsourcedid->data->typeid)) {
|
||||
$toolcode = $lisresultsourcedid->data->typeid;
|
||||
}
|
||||
}
|
||||
|
||||
if ($toolcode) {
|
||||
// Substitute fetched tool code value.
|
||||
$membershipsurl = str_replace('{tool_code}', $toolcode, $membershipsurl);
|
||||
} else {
|
||||
// We're unable to determine the tool code. End this processing.
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// Get context_id parameter and substitute, if applicable.
|
||||
$membershipsurl = str_replace('{context_id}', $context->getId(), $membershipsurl);
|
||||
|
||||
// Get context_type and substitute, if applicable.
|
||||
if (strpos($membershipsurl, '{context_type}') !== false) {
|
||||
$contexttype = $context->type !== null ? $context->type : 'CourseSection';
|
||||
$membershipsurl = str_replace('{context_type}', $contexttype, $membershipsurl);
|
||||
}
|
||||
|
||||
// Save this URL for the context's custom_context_memberships_url setting.
|
||||
$context->setSetting('custom_context_memberships_url', $membershipsurl);
|
||||
$contextupdated = true;
|
||||
}
|
||||
|
||||
// Perform membership service request.
|
||||
$url = $context->getSetting('custom_context_memberships_url');
|
||||
mtrace("Performing membership service request from context with URL {$url}.");
|
||||
$members = $context->getMembership();
|
||||
|
||||
// Save the context if membership request succeeded and if it has been updated.
|
||||
if ($members && $contextupdated) {
|
||||
$context->save();
|
||||
}
|
||||
|
||||
return $members;
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs membership service request using ResourceLink::doMembershipsService() method.
|
||||
*
|
||||
* @param ResourceLink $resourcelink
|
||||
* @return bool|User[] Array of User objects upon successful membership service request. False, otherwise.
|
||||
*/
|
||||
protected function do_resourcelink_membership_request(ResourceLink $resourcelink) {
|
||||
$members = false;
|
||||
$membershipsurl = $resourcelink->getSetting('ext_ims_lis_memberships_url');
|
||||
$membershipsid = $resourcelink->getSetting('ext_ims_lis_memberships_id');
|
||||
if ($membershipsurl && $membershipsid) {
|
||||
mtrace("Performing membership service request from resource link with membership URL: " . $membershipsurl);
|
||||
$members = $resourcelink->doMembershipsService(true);
|
||||
}
|
||||
return $members;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -160,6 +160,7 @@ class tool_provider extends ToolProvider {
|
|||
);
|
||||
|
||||
$this->requiredServices[] = new ServiceDefinition(['application/vnd.ims.lti.v2.toolproxy+json'], ['POST']);
|
||||
$this->requiredServices[] = new ServiceDefinition(['application/vnd.ims.lis.v2.membershipcontainer+json'], ['GET']);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue