moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-04 08:26:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'MDL-69251-master' of https://github.com/snake/moodle

Browse source
This commit is contained in:
Jun Pataleta 2022-08-04 11:16:22 +08:00
commit da9aec83a6
2 changed files with 29 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

39
enrol/lti/classes/task/sync_members.php
View file

@ -50,9 +50,6 @@ class sync_members extends scheduled_task {
/** @var array Array of user photos. */ /** @var array Array of user photos. */
protected $userphotos = []; protected $userphotos = [];
/** @var array Array of current LTI users. */
protected $currentusers = [];
/** @var data_connector $dataconnector A data_connector instance. */ /** @var data_connector $dataconnector A data_connector instance. */
protected $dataconnector; protected $dataconnector;
@ -112,15 +109,15 @@ class sync_members extends scheduled_task {
// Fetched members count. // Fetched members count.
$membercount = count($members); $membercount = count($members);
$usercount += $membercount;
mtrace("$membercount members received.\n"); mtrace("$membercount members received.\n");
// Process member information. // Process member information.
list($usercount, $enrolcount) = $this->sync_member_information($tool, $consumer, $members); list($users, $enrolledcount) = $this->sync_member_information($tool, $consumer, $members);
} $enrolcount += $enrolledcount;
// Now we check if we have to unenrol users who were not listed. // Now sync unenrolments for the consumer.
if ($this->should_sync_unenrol($tool->membersyncmode)) { $unenrolcount += $this->sync_unenrol($tool, $consumer->getKey(), $users);
$unenrolcount = $this->sync_unenrol($tool);
} }
mtrace("Completed - Synced members for tool '$tool->id' in the course '$tool->courseid'. " . mtrace("Completed - Synced members for tool '$tool->id' in the course '$tool->courseid'. " .
@ -217,17 +214,15 @@ class sync_members extends scheduled_task {
* @param stdClass $tool * @param stdClass $tool
* @param ToolConsumer $consumer * @param ToolConsumer $consumer
* @param User[] $members * @param User[] $members
* @return array An array containing the number of members that were processed and the number of members that were enrolled. * @return array An array of users from processed members and the number that were enrolled.
*/ */
protected function sync_member_information(stdClass $tool, ToolConsumer $consumer, $members) { protected function sync_member_information(stdClass $tool, ToolConsumer $consumer, $members) {
global $DB; global $DB;
$usercount = 0; $users = [];
$enrolcount = 0; $enrolcount = 0;
// Process member information. // Process member information.
foreach ($members as $member) { foreach ($members as $member) {
$usercount++;
// Set the user data. // Set the user data.
$user = new stdClass(); $user = new stdClass();
$user->username = helper::create_username($consumer->getKey(), $member->ltiUserId); $user->username = helper::create_username($consumer->getKey(), $member->ltiUserId);
@ -249,9 +244,7 @@ class sync_members extends scheduled_task {
user_update_user($user); user_update_user($user);
// Add the information to the necessary arrays. // Add the information to the necessary arrays.
if (!in_array($user->id, $this->currentusers)) { $users[$user->id] = $user;
$this->currentusers[] = $user->id;
}
$this->userphotos[$user->id] = $member->image; $this->userphotos[$user->id] = $member->image;
} else { } else {
if ($this->should_sync_enrol($tool->membersyncmode)) { if ($this->should_sync_enrol($tool->membersyncmode)) {
@ -265,7 +258,7 @@ class sync_members extends scheduled_task {
$user->id = user_create_user($user); $user->id = user_create_user($user);
// Add the information to the necessary arrays. // Add the information to the necessary arrays.
$this->currentusers[] = $user->id; $users[$user->id] = $user;
$this->userphotos[$user->id] = $member->image; $this->userphotos[$user->id] = $member->image;
} }
} }
@ -291,16 +284,18 @@ class sync_members extends scheduled_task {
} }
} }
return [$usercount, $enrolcount]; return [$users, $enrolcount];
} }
/** /**
* Performs unenrolment of users that are no longer enrolled in the consumer side. * Performs unenrolment of users that are no longer enrolled in the consumer side.
* *
* @param stdClass $tool The tool record object. * @param stdClass $tool The tool record object.
* @param string $consumerkey ensure we only unenrol users from this tool consumer.
* @param array $currentusers The list of current users.
* @return int The number of users that have been unenrolled. * @return int The number of users that have been unenrolled.
*/ */
protected function sync_unenrol(stdClass $tool) { protected function sync_unenrol(stdClass $tool, string $consumerkey, array $currentusers) {
global $DB; global $DB;
$ltiplugin = enrol_get_plugin('lti'); $ltiplugin = enrol_get_plugin('lti');
@ -309,16 +304,18 @@ class sync_members extends scheduled_task {
return 0; return 0;
} }
if (empty($this->currentusers)) { if (empty($currentusers)) {
return 0; return 0;
} }
$unenrolcount = 0; $unenrolcount = 0;
$ltiusersrs = $DB->get_recordset('enrol_lti_users', array('toolid' => $tool->id), 'lastaccess DESC', 'userid'); $select = "toolid = :toolid AND " . $DB->sql_compare_text('consumerkey', 255) . " = :consumerkey";
$ltiusersrs = $DB->get_recordset_select('enrol_lti_users', $select, ['toolid' => $tool->id, 'consumerkey' => $consumerkey],
'lastaccess DESC', 'userid');
// Go through the users and check if any were never listed, if so, remove them. // Go through the users and check if any were never listed, if so, remove them.
foreach ($ltiusersrs as $ltiuser) { foreach ($ltiusersrs as $ltiuser) {
if (!in_array($ltiuser->userid, $this->currentusers)) { if (!array_key_exists($ltiuser->userid, $currentusers)) {
$instance = new stdClass(); $instance = new stdClass();
$instance->id = $tool->enrolid; $instance->id = $tool->enrolid;
$instance->courseid = $tool->courseid; $instance->courseid = $tool->courseid;

27
enrol/lti/tests/sync_members_test.php
View file

@ -213,10 +213,10 @@ class sync_members_test extends \advanced_testcase {
* Test for sync_members::sync_member_information(). * Test for sync_members::sync_member_information().
*/ */
public function test_sync_member_information() { public function test_sync_member_information() {
list($totalcount, $enrolledcount) = $this->task->sync_member_information($this->tool, $this->consumer, $this->members); list($users, $enrolledcount) = $this->task->sync_member_information($this->tool, $this->consumer, $this->members);
$membercount = count($this->members); $membercount = count($this->members);
$this->assertCount(10, $this->members); $this->assertCount(10, $this->members);
$this->assertEquals($membercount, $totalcount); $this->assertCount($membercount, $users);
$this->assertEquals($membercount, $enrolledcount); $this->assertEquals($membercount, $enrolledcount);
} }
@ -225,10 +225,10 @@ class sync_members_test extends \advanced_testcase {
*/ */
public function test_sync_profile_images() { public function test_sync_profile_images() {
$task = $this->task; $task = $this->task;
list($totalcount, $enrolledcount) = $task->sync_member_information($this->tool, $this->consumer, $this->members); list($users, $enrolledcount) = $task->sync_member_information($this->tool, $this->consumer, $this->members);
$membercount = count($this->members); $membercount = count($this->members);
$this->assertCount(10, $this->members); $this->assertCount(10, $this->members);
$this->assertEquals($membercount, $totalcount); $this->assertCount($membercount, $users);
$this->assertEquals($membercount, $enrolledcount); $this->assertEquals($membercount, $enrolledcount);
// Suppress output. // Suppress output.
@ -244,14 +244,14 @@ class sync_members_test extends \advanced_testcase {
$tool = $this->tool; $tool = $this->tool;
$task = $this->task; $task = $this->task;
$task->sync_member_information($tool, $this->consumer, $this->members); list($users) = $task->sync_member_information($tool, $this->consumer, $this->members);
// Simulate that the fetched list of current users has been reduced by 3. // Simulate that the fetched list of current users has been reduced by 3.
$unenrolcount = 3; $unenrolcount = 3;
for ($i = 0; $i < $unenrolcount; $i++) { for ($i = 0; $i < $unenrolcount; $i++) {
$task->pop_current_users(); array_pop($users);
} }
$this->assertEquals($unenrolcount, $task->sync_unenrol($tool)); $this->assertEquals($unenrolcount, $task->sync_unenrol($tool, 'Consumer1Key', $users));
} }
/** /**
@ -297,13 +297,6 @@ class dummy_sync_members_task extends sync_members {
return $this->dataconnector; return $this->dataconnector;
} }
/**
* Helper method that removes an element in the array of current users.
*/
public function pop_current_users() {
array_pop($this->currentusers);
}
/** /**
* Exposes sync_members::do_context_membership_request() * Exposes sync_members::do_context_membership_request()
* *
@ -390,10 +383,12 @@ class dummy_sync_members_task extends sync_members {
* Exposes sync_members::sync_unenrol() * Exposes sync_members::sync_unenrol()
* *
* @param \stdClass $tool * @param \stdClass $tool
* @param string $consumerkey
* @param array $currentusers
* @return int * @return int
*/ */
public function sync_unenrol(\stdClass $tool) { public function sync_unenrol(\stdClass $tool, string $consumerkey, array $currentusers) {
$count = parent::sync_unenrol($tool); $count = parent::sync_unenrol($tool, $consumerkey, $currentusers);
return $count; return $count;
} }
} }