MDL-70722 oauth2: move Facebook methods to service class
authorSara Arjona <sara@moodle.com>
Wed, 27 Jan 2021 16:37:16 +0000 (17:37 +0100)
committerSara Arjona <sara@moodle.com>
Fri, 26 Mar 2021 08:20:52 +0000 (09:20 +0100)
lib/classes/oauth2/api.php
lib/classes/oauth2/service/facebook.php [new file with mode: 0644]

index 5f76b38..6c1032d 100644 (file)
@@ -40,85 +40,6 @@ use moodle_exception;
  */
 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.
      * @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).
         if ($type == 'microsoft') {
             return self::init_microsoft();
-        } else if ($type == 'facebook') {
-            return self::init_facebook();
         } else if ($type == 'nextcloud') {
             return self::init_nextcloud();
         } else {
@@ -292,8 +211,6 @@ class api {
         // TODO: Move these methods to new service classes (to make this API easier to understand and maintain).
         if ($type == 'microsoft') {
             return self::create_endpoints_for_microsoft($issuer);
-        } else if ($type == 'facebook') {
-            return self::create_endpoints_for_facebook($issuer);
         } else if ($type == 'nextcloud') {
             return self::create_endpoints_for_nextcloud($issuer);
         } else {
@@ -322,6 +239,7 @@ class api {
                     throw new moodle_exception('IMS OBv2.1 service type requires the baseurl parameter.');
                 }
             case 'google':
+            case 'facebook':
                 $classname = self::get_service_classname($type);
                 $issuer = $classname::init();
                 if ($baseurl) {
@@ -335,11 +253,6 @@ class api {
                 $issuer->create();
                 return self::create_endpoints_for_microsoft($issuer);
 
-            case 'facebook':
-                $issuer = self::init_facebook();
-                $issuer->create();
-                return self::create_endpoints_for_facebook($issuer);
-
             case 'nextcloud':
                 if (!$baseurl) {
                     throw new moodle_exception('Nextcloud service type requires the baseurl parameter.');
diff --git a/lib/classes/oauth2/service/facebook.php b/lib/classes/oauth2/service/facebook.php
new file mode 100644 (file)
index 0000000..92ec1f5
--- /dev/null
@@ -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;
+    }
+}