L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'MDL-79520-main' of https://github.com/snake/moodle

Browse Source
This commit is contained in:
Jun Pataleta
2024-02-20 22:22:05 +08:00
parent 307ec03056 b2e184f9ad
commit ea4874094b
3 changed files with 95 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/classes/oauth2/client/clever.php
-64
View File
@@ -1,64 +0,0 @@
<?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/>.
namespace core\oauth2\client;
use core\oauth2\client;
/**
* Class clever - Custom client handler to fetch data from Clever
*
* @package core
* @copyright 2022 OpenStax
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class clever extends client {
/**
* Fetch the user id from the userinfo endpoint and then query userdata
*
* @return array|false
*/
public function get_userinfo() {
$userinfo = parent::get_userinfo();
$userid = $userinfo['idnumber'];
return $this->get_userdata($userid);
}
/**
* Obtain user name and email data via the userdata endpoint
*
* @param string $userid User ID value
* @return array|false
*/
private function get_userdata($userid) {
$url = $this->get_issuer()->get_endpoint_url('userdata');
$url .= '/' . $userid;
$response = $this->get($url);
if (!$response) {
return false;
}
$userinfo = json_decode($response);
if (json_last_error() != JSON_ERROR_NONE) {
debugging('Error encountered while decoding user information: ' . json_last_error_msg());
return false;
}
return $this->map_userinfo_to_fields($userinfo);
}
}
lib/classes/oauth2/service/clever.php
+13 -38
View File
@@ -18,7 +18,6 @@ namespace core\oauth2\service;
use core\oauth2\issuer;
use core\oauth2\discovery\openidconnect;
use core\oauth2\endpoint;
use core\oauth2\user_field_mapping;
/**
@@ -39,7 +38,7 @@ class clever extends openidconnect implements issuer_interface {
'name' => 'Clever',
'image' => 'https://apps.clever.com/favicon.ico',
'basicauth' => 1,
'baseurl' => '',
'baseurl' => 'https://clever.com',
'showonloginpage' => issuer::LOGINONLY,
'servicetype' => 'clever',
];
@@ -48,45 +47,21 @@ class clever extends openidconnect implements issuer_interface {
}
/**
* Create endpoints for this issuer.
* Create field mappings for this issuer.
*
* @param issuer $issuer Issuer the endpoints should be created for.
* @return issuer
* @param issuer $issuer Issuer the field mappings should be created for.
*/
public static function create_endpoints(issuer $issuer): issuer {
$endpoints = [
'authorization_endpoint' => 'https://clever.com/oauth/authorize',
'token_endpoint' => 'https://clever.com/oauth/tokens',
'userinfo_endpoint' => 'https://api.clever.com/v3.0/me',
'userdata_endpoint' => 'https://api.clever.com/v3.0/users'
];
foreach ($endpoints as $name => $url) {
$record = (object) [
'issuerid' => $issuer->get('id'),
'name' => $name,
'url' => $url
];
$endpoint = new endpoint(0, $record);
$endpoint->create();
}
public static function create_field_mappings(issuer $issuer): void {
// Perform OIDC default field mapping.
parent::create_field_mappings($issuer);
// Create the field mappings.
$mapping = [
'data-id' => 'idnumber',
'data-name-first' => 'firstname',
'data-name-last' => 'lastname',
'data-email' => 'email'
// Create the additional 'sub' field mapping.
$record = (object) [
'issuerid' => $issuer->get('id'),
'externalfield' => 'sub',
'internalfield' => 'idnumber',
];
foreach ($mapping as $external => $internal) {
$record = (object) [
'issuerid' => $issuer->get('id'),
'externalfield' => $external,
'internalfield' => $internal
];
$userfieldmapping = new user_field_mapping(0, $record);
$userfieldmapping->create();
}
return $issuer;
$userfieldmapping = new user_field_mapping(0, $record);
$userfieldmapping->create();
}
}
lib/db/upgrade.php
+82
View File
@@ -1004,5 +1004,87 @@ function xmldb_main_upgrade($oldversion) {
upgrade_main_savepoint(true, 2024021500.01);
}
if ($oldversion < 2024021500.01) {
// A [name => url] map of new OIDC endpoints to be updated/created.
$endpointuris = [
'authorization_endpoint' => 'https://clever.com/oauth/authorize',
'token_endpoint' => 'https://clever.com/oauth/tokens',
'userinfo_endpoint' => 'https://api.clever.com/userinfo',
'jwks_uri' => 'https://clever.com/oauth/certs',
];
// A [internalfield => externalfield] map of new OIDC-based user field mappings to be updated/created.
$userfieldmappings = [
'idnumber' => 'sub',
'firstname' => 'given_name',
'lastname' => 'family_name',
'email' => 'email',
];
$admin = get_admin();
$adminid = $admin ? $admin->id : '0';
$cleverservices = $DB->get_records('oauth2_issuer', ['servicetype' => 'clever']);
foreach ($cleverservices as $cleverservice) {
$time = time();
// Insert/update the new endpoints.
foreach ($endpointuris as $endpointname => $endpointuri) {
$endpoint = ['issuerid' => $cleverservice->id, 'name' => $endpointname];
$endpointid = $DB->get_field('oauth2_endpoint', 'id', $endpoint);
if ($endpointid) {
$endpoint = array_merge($endpoint, [
'id' => $endpointid,
'url' => $endpointuri,
'timemodified' => $time,
'usermodified' => $adminid,
]);
$DB->update_record('oauth2_endpoint', $endpoint);
} else {
$endpoint = array_merge($endpoint, [
'url' => $endpointuri,
'timecreated' => $time,
'timemodified' => $time,
'usermodified' => $adminid,
]);
$DB->insert_record('oauth2_endpoint', $endpoint);
}
}
// Insert/update new user field mappings.
foreach ($userfieldmappings as $internalfieldname => $externalfieldname) {
$fieldmap = ['issuerid' => $cleverservice->id, 'internalfield' => $internalfieldname];
$fieldmapid = $DB->get_field('oauth2_user_field_mapping', 'id', $fieldmap);
if ($fieldmapid) {
$fieldmap = array_merge($fieldmap, [
'id' => $fieldmapid,
'externalfield' => $externalfieldname,
'timemodified' => $time,
'usermodified' => $adminid,
]);
$DB->update_record('oauth2_user_field_mapping', $fieldmap);
} else {
$fieldmap = array_merge($fieldmap, [
'externalfield' => $externalfieldname,
'timecreated' => $time,
'timemodified' => $time,
'usermodified' => $adminid,
]);
$DB->insert_record('oauth2_user_field_mapping', $fieldmap);
}
}
// Update the baseurl for the issuer.
$cleverservice->baseurl = 'https://clever.com';
$cleverservice->timemodified = $time;
$cleverservice->usermodified = $adminid;
$DB->update_record('oauth2_issuer', $cleverservice);
}
upgrade_main_savepoint(true, 2024021500.01);
}
return true;
}