mirror of
https://github.com/moodle/moodle.git
synced 2025-08-06 09:26:35 +02:00
MDL-70722 oauth2: move Facebook methods to service class
This commit is contained in:
Sara Arjona
parent
5d93de8b67
commit
0b53d70ae9
2 changed files with 112 additions and 88 deletions
|
|
@ -40,85 +40,6 @@ use moodle_exception;
|
||||||
*/
|
*/
|
||||||
class api {
|
class api {
|
||||||
|
|
||||||
/**
|
|
||||||
* Build a facebook ready OAuth 2 service.
|
|
||||||
* @return \core\oauth2\issuer
|
|
||||||
*/
|
|
||||||
private static function init_facebook() {
|
|
||||||
// Facebook is a custom setup.
|
|
||||||
$record = (object) [
|
|
||||||
'name' => 'Facebook',
|
|
||||||
'image' => 'https://facebookbrand.com/wp-content/uploads/2016/05/flogo_rgb_hex-brc-site-250.png',
|
|
||||||
'baseurl' => '',
|
|
||||||
'loginscopes' => 'public_profile email',
|
|
||||||
'loginscopesoffline' => 'public_profile email',
|
|
||||||
'showonloginpage' => true,
|
|
||||||
'servicetype' => 'facebook',
|
|
||||||
];
|
|
||||||
|
|
||||||
$issuer = new issuer(0, $record);
|
|
||||||
return $issuer;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create endpoints for facebook issuers.
|
|
||||||
* @param issuer $issuer issuer the endpoints should be created for.
|
|
||||||
* @return mixed
|
|
||||||
* @throws \coding_exception
|
|
||||||
* @throws \core\invalid_persistent_exception
|
|
||||||
*/
|
|
||||||
private static function create_endpoints_for_facebook($issuer) {
|
|
||||||
// The Facebook API version.
|
|
||||||
$apiversion = '2.12';
|
|
||||||
// The Graph API URL.
|
|
||||||
$graphurl = 'https://graph.facebook.com/v' . $apiversion;
|
|
||||||
// User information fields that we want to fetch.
|
|
||||||
$infofields = [
|
|
||||||
'id',
|
|
||||||
'first_name',
|
|
||||||
'last_name',
|
|
||||||
'link',
|
|
||||||
'picture.type(large)',
|
|
||||||
'name',
|
|
||||||
'email',
|
|
||||||
];
|
|
||||||
$endpoints = [
|
|
||||||
'authorization_endpoint' => sprintf('https://www.facebook.com/v%s/dialog/oauth', $apiversion),
|
|
||||||
'token_endpoint' => $graphurl . '/oauth/access_token',
|
|
||||||
'userinfo_endpoint' => $graphurl . '/me?fields=' . implode(',', $infofields)
|
|
||||||
];
|
|
||||||
|
|
||||||
foreach ($endpoints as $name => $url) {
|
|
||||||
$record = (object) [
|
|
||||||
'issuerid' => $issuer->get('id'),
|
|
||||||
'name' => $name,
|
|
||||||
'url' => $url
|
|
||||||
];
|
|
||||||
$endpoint = new endpoint(0, $record);
|
|
||||||
$endpoint->create();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Create the field mappings.
|
|
||||||
$mapping = [
|
|
||||||
'name' => 'alternatename',
|
|
||||||
'last_name' => 'lastname',
|
|
||||||
'email' => 'email',
|
|
||||||
'first_name' => 'firstname',
|
|
||||||
'picture-data-url' => 'picture',
|
|
||||||
'link' => 'url',
|
|
||||||
];
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build a microsoft ready OAuth 2 service.
|
* Build a microsoft ready OAuth 2 service.
|
||||||
* @return \core\oauth2\issuer
|
* @return \core\oauth2\issuer
|
||||||
|
|
@ -267,8 +188,6 @@ class api {
|
||||||
// TODO: Move these methods to new service classes (to make this API easier to understand and maintain).
|
// TODO: Move these methods to new service classes (to make this API easier to understand and maintain).
|
||||||
if ($type == 'microsoft') {
|
if ($type == 'microsoft') {
|
||||||
return self::init_microsoft();
|
return self::init_microsoft();
|
||||||
} else if ($type == 'facebook') {
|
|
||||||
return self::init_facebook();
|
|
||||||
} else if ($type == 'nextcloud') {
|
} else if ($type == 'nextcloud') {
|
||||||
return self::init_nextcloud();
|
return self::init_nextcloud();
|
||||||
} else {
|
} else {
|
||||||
|
|
@ -292,8 +211,6 @@ class api {
|
||||||
// TODO: Move these methods to new service classes (to make this API easier to understand and maintain).
|
// TODO: Move these methods to new service classes (to make this API easier to understand and maintain).
|
||||||
if ($type == 'microsoft') {
|
if ($type == 'microsoft') {
|
||||||
return self::create_endpoints_for_microsoft($issuer);
|
return self::create_endpoints_for_microsoft($issuer);
|
||||||
} else if ($type == 'facebook') {
|
|
||||||
return self::create_endpoints_for_facebook($issuer);
|
|
||||||
} else if ($type == 'nextcloud') {
|
} else if ($type == 'nextcloud') {
|
||||||
return self::create_endpoints_for_nextcloud($issuer);
|
return self::create_endpoints_for_nextcloud($issuer);
|
||||||
} else {
|
} else {
|
||||||
|
|
@ -322,6 +239,7 @@ class api {
|
||||||
throw new moodle_exception('IMS OBv2.1 service type requires the baseurl parameter.');
|
throw new moodle_exception('IMS OBv2.1 service type requires the baseurl parameter.');
|
||||||
}
|
}
|
||||||
case 'google':
|
case 'google':
|
||||||
|
case 'facebook':
|
||||||
$classname = self::get_service_classname($type);
|
$classname = self::get_service_classname($type);
|
||||||
$issuer = $classname::init();
|
$issuer = $classname::init();
|
||||||
if ($baseurl) {
|
if ($baseurl) {
|
||||||
|
|
@ -335,11 +253,6 @@ class api {
|
||||||
$issuer->create();
|
$issuer->create();
|
||||||
return self::create_endpoints_for_microsoft($issuer);
|
return self::create_endpoints_for_microsoft($issuer);
|
||||||
|
|
||||||
case 'facebook':
|
|
||||||
$issuer = self::init_facebook();
|
|
||||||
$issuer->create();
|
|
||||||
return self::create_endpoints_for_facebook($issuer);
|
|
||||||
|
|
||||||
case 'nextcloud':
|
case 'nextcloud':
|
||||||
if (!$baseurl) {
|
if (!$baseurl) {
|
||||||
throw new moodle_exception('Nextcloud service type requires the baseurl parameter.');
|
throw new moodle_exception('Nextcloud service type requires the baseurl parameter.');
|
||||||
|
|
|
||||||
111
lib/classes/oauth2/service/facebook.php
Normal file
111
lib/classes/oauth2/service/facebook.php
Normal file
|
|
@ -0,0 +1,111 @@
|
||||||
|
<?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\service;
|
||||||
|
|
||||||
|
use core\oauth2\issuer;
|
||||||
|
use core\oauth2\endpoint;
|
||||||
|
use core\oauth2\user_field_mapping;
|
||||||
|
use core\oauth2\discovery\openidconnect;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class for Facebook oAuth service, with the specific methods related to it.
|
||||||
|
*
|
||||||
|
* @package core
|
||||||
|
* @copyright 2021 Sara Arjona (sara@moodle.com)
|
||||||
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||||
|
*/
|
||||||
|
class facebook extends openidconnect implements issuer_interface {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build an OAuth2 issuer, with all the default values for this service.
|
||||||
|
*
|
||||||
|
* @return issuer The issuer initialised with proper default values.
|
||||||
|
*/
|
||||||
|
public static function init(): issuer {
|
||||||
|
$record = (object) [
|
||||||
|
'name' => 'Facebook',
|
||||||
|
'image' => 'https://facebookbrand.com/wp-content/uploads/2016/05/flogo_rgb_hex-brc-site-250.png',
|
||||||
|
'baseurl' => '',
|
||||||
|
'loginscopes' => 'public_profile email',
|
||||||
|
'loginscopesoffline' => 'public_profile email',
|
||||||
|
'showonloginpage' => true,
|
||||||
|
'servicetype' => 'facebook',
|
||||||
|
];
|
||||||
|
|
||||||
|
$issuer = new issuer(0, $record);
|
||||||
|
return $issuer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create endpoints for this issuer.
|
||||||
|
*
|
||||||
|
* @param issuer $issuer Issuer the endpoints should be created for.
|
||||||
|
* @return issuer
|
||||||
|
*/
|
||||||
|
public static function create_endpoints(issuer $issuer): issuer {
|
||||||
|
// The Facebook API version.
|
||||||
|
$apiversion = '2.12';
|
||||||
|
// The Graph API URL.
|
||||||
|
$graphurl = 'https://graph.facebook.com/v' . $apiversion;
|
||||||
|
// User information fields that we want to fetch.
|
||||||
|
$infofields = [
|
||||||
|
'id',
|
||||||
|
'first_name',
|
||||||
|
'last_name',
|
||||||
|
'link',
|
||||||
|
'picture.type(large)',
|
||||||
|
'name',
|
||||||
|
'email',
|
||||||
|
];
|
||||||
|
$endpoints = [
|
||||||
|
'authorization_endpoint' => sprintf('https://www.facebook.com/v%s/dialog/oauth', $apiversion),
|
||||||
|
'token_endpoint' => $graphurl . '/oauth/access_token',
|
||||||
|
'userinfo_endpoint' => $graphurl . '/me?fields=' . implode(',', $infofields)
|
||||||
|
];
|
||||||
|
|
||||||
|
foreach ($endpoints as $name => $url) {
|
||||||
|
$record = (object) [
|
||||||
|
'issuerid' => $issuer->get('id'),
|
||||||
|
'name' => $name,
|
||||||
|
'url' => $url
|
||||||
|
];
|
||||||
|
$endpoint = new endpoint(0, $record);
|
||||||
|
$endpoint->create();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create the field mappings.
|
||||||
|
$mapping = [
|
||||||
|
'name' => 'alternatename',
|
||||||
|
'last_name' => 'lastname',
|
||||||
|
'email' => 'email',
|
||||||
|
'first_name' => 'firstname',
|
||||||
|
'picture-data-url' => 'picture',
|
||||||
|
'link' => 'url',
|
||||||
|
];
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue