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

Merge branch 'MDL-80380-500' of https://github.com/HuongNV13/moodle into MOODLE_500_STABLE

Browse Source
This commit is contained in:
Michael Hawkins
2025-06-05 12:19:35 +08:00
parent 9d8cf5fb22 d0a00b74d8
commit 7db7444d53
12 changed files with 134 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.upgradenotes/MDL-80380-2025052104135989.yml
+9
View File
@@ -0,0 +1,9 @@
issueNumber: MDL-80380
notes:
core_auth:
- message: >
A new method called `get_additional_upgrade_token_parameters` has been
added to `oauth2_client` class. This will allow custom clients to
override this one and add their extra parameters for upgrade token
request.
type: improved
admin/tool/oauth2/classes/form/issuer.php
+8
View File
@@ -129,6 +129,7 @@ class issuer extends persistent {
\core\oauth2\issuer::EVERYWHERE => get_string('issueruseineverywhere', 'tool_oauth2'),
\core\oauth2\issuer::LOGINONLY => get_string('issueruseinloginonly', 'tool_oauth2'),
\core\oauth2\issuer::SERVICEONLY => get_string('issueruseininternalonly', 'tool_oauth2'),
\core\oauth2\issuer::SMTPWITHXOAUTH2 => get_string('issueruseinsmtpwithoauth', 'tool_oauth2'),
];
$mform->addElement('select', 'showonloginpage', get_string('issuerusein', 'tool_oauth2'), $options);
$mform->addHelpButton('showonloginpage', 'issuerusein', 'tool_oauth2');
@@ -138,6 +139,13 @@ class issuer extends persistent {
$mform->addRule('loginpagename', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
$mform->addHelpButton('loginpagename', 'issuerloginpagename', 'tool_oauth2');
$mform->hideIf('loginpagename', 'showonloginpage', 'eq', \core\oauth2\issuer::SERVICEONLY);
$mform->hideIf('loginpagename', 'showonloginpage', 'eq', \core\oauth2\issuer::SMTPWITHXOAUTH2);
// Connected email for XOAUTH2.
$mform->addElement('text', 'systememail', get_string('issuersmtpsystememail', 'tool_oauth2'));
$mform->setType('systememail', PARAM_EMAIL);
$mform->addHelpButton('systememail', 'issuersmtpsystememail', 'tool_oauth2');
$mform->hideIf('systememail', 'showonloginpage', 'ne', \core\oauth2\issuer::SMTPWITHXOAUTH2);
// Login scopes.
$mform->addElement('text', 'loginscopes', get_string('issuerloginscopes', 'tool_oauth2'));
admin/tool/oauth2/classes/output/renderer.php
+2 -1
View File
@@ -86,7 +86,8 @@ class renderer extends plugin_renderer_base {
$namecell->header = true;
// Login issuer.
if ((int)$issuer->get('showonloginpage') == issuer::SERVICEONLY) {
if ((int)$issuer->get('showonloginpage') == issuer::SERVICEONLY ||
(int)$issuer->get('showonloginpage') == issuer::SMTPWITHXOAUTH2) {
$loginissuer = $this->pix_icon('no', get_string('notloginissuer', 'tool_oauth2'), 'tool_oauth2');
$logindisplayas = '';
} else {
admin/tool/oauth2/lang/en/tool_oauth2.php
+4 -1
View File
@@ -89,13 +89,16 @@ $string['issuershowonloginpage'] = 'Show on login page';
$string['issuerrequireconfirmation_help'] = 'Require that all users verify their email address before they can log in with OAuth. This applies to newly created accounts as part of the login process, or when an existing Moodle account is connected to an OAuth login via matching email addresses.';
$string['issuerrequireconfirmation'] = 'Require email verification';
$string['issuers'] = 'Issuers';
$string['issuersmtpsystememail'] = 'SMTP email';
$string['issuersmtpsystememail_help'] = 'If specified, this email will be used to connect a system account for sending email via SMTP. This is required for some OAuth 2 services (e.g. Microsoft). Please check the documentation for your OAuth 2 service to see if this is required.';
$string['issuersservicesallow'] = 'Allow services';
$string['issuersservicesnotallow'] = 'Do not allow services';
$string['issuerusein'] = 'This service will be used';
$string['issuerusein_help'] = 'OAuth 2 services can be used for internal services, on the login page, or both, if required.';
$string['issuerusein_help'] = 'OAuth 2 services can be used for internal services, on the login page, SMTP with XOAUTH2, or both login page and internal services, if required.';
$string['issueruseineverywhere'] = 'Login page and internal services';
$string['issueruseininternalonly'] = 'Internal services only';
$string['issueruseinloginonly'] = 'Login page only';
$string['issueruseinsmtpwithoauth'] = 'SMTP with XOAUTH2 only';
$string['issuerusedforlogin'] = 'Login';
$string['issuerusedforinternal'] = 'Internal services';
$string['linkedin_service'] = 'LinkedIn';
lib/classes/oauth2/api.php
+14 -2
View File
@@ -641,8 +641,20 @@ class api {
$record->issuerid = $issuer->get('id');
$record->refreshtoken = $refreshtoken;
$record->grantedscopes = $scopes;
$record->email = isset($userinfo['email']) ? $userinfo['email'] : '';
$record->username = $userinfo['username'];
// Get email.
if (isset($userinfo['email'])) {
$record->email = $userinfo['email'];
} else if ($issuer->get_system_email()) {
$record->email = $issuer->get_system_email();
} else {
$record->email = '';
}
// Get username.
if (isset($userinfo['username'])) {
$record->username = $userinfo['username'];
} else if ($issuer->get_system_email()) {
$record->username = $issuer->get_system_email();
}
$systemaccount = new system_account(0, $record);
lib/classes/oauth2/client/microsoft.php
+42
View File
@@ -0,0 +1,42 @@
<?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;
/**
* Custom oauth2 client for Microsoft to handle specific requirements.
*
* @package core
* @copyright 2025 Huong Nguyen <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class microsoft extends client {
#[\Override]
public function get_additional_upgrade_token_parameters(): array {
$issuer = $this->get_issuer();
if ($issuer->get('showonloginpage') == $issuer::SMTPWITHXOAUTH2) {
// We are using this issuer for SMTP with XOAUTH2.
// We need to add the SMTP scope to the token request.
return [
'scope' => 'https://outlook.office.com/SMTP.Send',
];
}
return parent::get_additional_upgrade_token_parameters();
}
}
lib/classes/oauth2/issuer.php
+17
View File
@@ -40,6 +40,8 @@ class issuer extends persistent {
const EVERYWHERE = 1;
/** @var int Issuer is displayed on the login page only */
const LOGINONLY = 2;
/** @var int Issuer is used for sending email using SMTP with XOAUTH2 */
const SMTPWITHXOAUTH2 = 3;
/** @var int Issuer is displayed only in the services lists and can not be used for login */
const SERVICEONLY = 0;
@@ -127,6 +129,11 @@ class issuer extends persistent {
'null' => NULL_ALLOWED,
'default' => null,
),
'systememail' => [
'type' => PARAM_EMAIL,
'null' => NULL_ALLOWED,
'default' => null,
],
);
}
@@ -200,6 +207,7 @@ class issuer extends persistent {
return $this->get('id') &&
$this->is_configured() &&
$this->get('showonloginpage') != self::SERVICEONLY &&
$this->get('showonloginpage') != self::SMTPWITHXOAUTH2 &&
$this->get('enabled') &&
!empty($this->get_endpoint_url('userinfo'));
}
@@ -268,4 +276,13 @@ class issuer extends persistent {
public function get_display_name(): string {
return $this->get('loginpagename') ? $this->get('loginpagename') : $this->get('name');
}
/**
* Get the system email address for this issuer.
*
* @return string|null The system email address or null if not set.
*/
public function get_system_email(): ?string {
return $this->get('systememail') ? $this->get('systememail') : null;
}
}
lib/db/install.xml
+2 -1
View File
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<XMLDB PATH="lib/db" VERSION="20250312" COMMENT="XMLDB file for core Moodle tables"
<XMLDB PATH="lib/db" VERSION="20250520" COMMENT="XMLDB file for core Moodle tables"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../lib/xmldb/xmldb.xsd"
>
@@ -3982,6 +3982,7 @@
<FIELD NAME="requireconfirmation" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="1" SEQUENCE="false"/>
<FIELD NAME="servicetype" TYPE="char" LENGTH="255" NOTNULL="false" SEQUENCE="false" COMMENT="Issuer service type, such as 'google' or 'facebook'."/>
<FIELD NAME="loginpagename" TYPE="char" LENGTH="255" NOTNULL="false" SEQUENCE="false"/>
<FIELD NAME="systememail" TYPE="char" LENGTH="100" NOTNULL="false" SEQUENCE="false" COMMENT="The email that will be used connect system account for sending email via SMTP"/>
</FIELDS>
<KEYS>
<KEY NAME="primary" TYPE="primary" FIELDS="id"/>
lib/db/upgrade.php
+15
View File
@@ -1782,5 +1782,20 @@ function xmldb_main_upgrade($oldversion) {
upgrade_main_savepoint(true, 2025041400.08);
}
if ($oldversion < 2025041400.09) {
// Define field systememail to be added to oauth2_issuer.
$table = new xmldb_table('oauth2_issuer');
$field = new xmldb_field('systememail', XMLDB_TYPE_CHAR, '100', null, null, null, null, 'loginpagename');
// Conditionally launch add field systememail.
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Main savepoint reached.
upgrade_main_savepoint(true, 2025041400.09);
}
return true;
}
lib/oauthlib.php
+14
View File
@@ -581,6 +581,11 @@ abstract class oauth2_client extends curl {
$params['client_secret'] = $this->clientsecret;
}
// If we have additional parameters, add them to the request.
if ($this->get_additional_upgrade_token_parameters()) {
$params = array_merge($params, $this->get_additional_upgrade_token_parameters());
}
// Requests can either use http GET or POST.
if ($this->use_http_get()) {
$response = $this->get($this->token_url(), $params);
@@ -781,4 +786,13 @@ abstract class oauth2_client extends curl {
protected function use_http_get() {
return false;
}
/**
* An additional array of url params to pass with upgrade token request.
*
* @return array of name value pairs.
*/
public function get_additional_upgrade_token_parameters(): array {
return [];
}
}
lib/tests/oauth2_test.php
+6
View File
@@ -420,6 +420,12 @@ final class oauth2_test extends \advanced_testcase {
$this->assertFalse($googleissuer->is_available_for_login());
// Set showonloginpage to SMTP with XOAUTH2 only.
$googleissuer->set('showonloginpage', issuer::SMTPWITHXOAUTH2);
$googleissuer->update();
$this->assertFalse($googleissuer->is_available_for_login());
// Set showonloginpage to everywhere (service and login) and disable issuer.
$googleissuer->set('showonloginpage', issuer::EVERYWHERE);
$googleissuer->set('enabled', 0);
version.php
+1 -1
View File
@@ -29,7 +29,7 @@
defined('MOODLE_INTERNAL') || die();
$version = 2025041400.08; // 20250414 = branching date YYYYMMDD - do not modify!
$version = 2025041400.09; // 20250414 = branching date YYYYMMDD - do not modify!
// RR = release increments - 00 in DEV branches.
// .XX = incremental changes.
$release = '5.0+ (Build: 20250530)'; // Human-friendly version name