From 3ee128fbbf85e1994e1fa3a30a4c890d84640590 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Tue, 27 Oct 2020 03:02:28 -0700
Subject: [PATCH] dev/core#2141 - APIv4 - Add OAuthProvider.get w/test. Split
 dist/local/test lists.

---
 ext/oauth-client/Civi/Api4/OAuthProvider.php  | 78 +++++++++++++++++++
 .../Civi/OAuth/CiviGenericProvider.php        |  6 ++
 .../data/oauth-providers.dist.json            | 30 +++++++
 .../data/oauth-providers.test.json            | 21 +++++
 ext/oauth-client/oauth_client.php             | 21 +++++
 .../phpunit/api/v4/OAuthProviderTest.php      | 46 +++++++++++
 ext/oauth-client/tests/phpunit/bootstrap.php  |  1 +
 7 files changed, 203 insertions(+)
 create mode 100644 ext/oauth-client/Civi/Api4/OAuthProvider.php
 create mode 100644 ext/oauth-client/Civi/OAuth/CiviGenericProvider.php
 create mode 100644 ext/oauth-client/data/oauth-providers.dist.json
 create mode 100644 ext/oauth-client/data/oauth-providers.test.json
 create mode 100644 ext/oauth-client/tests/phpunit/api/v4/OAuthProviderTest.php

diff --git a/ext/oauth-client/Civi/Api4/OAuthProvider.php b/ext/oauth-client/Civi/Api4/OAuthProvider.php
new file mode 100644
index 0000000000..47b33005e2
--- /dev/null
+++ b/ext/oauth-client/Civi/Api4/OAuthProvider.php
@@ -0,0 +1,78 @@
+<?php
+
+namespace Civi\Api4;
+
+use Civi\Core\Event\GenericHookEvent;
+use Civi\OAuth\CiviGenericProvider;
+
+class OAuthProvider extends Generic\AbstractEntity {
+
+  const TTL = 600;
+
+  /**
+   * @param bool $checkPermissions
+   * @return Generic\BasicGetAction
+   */
+  public static function get($checkPermissions = TRUE) {
+    $action = new Generic\BasicGetAction('OAuthProvider', __FUNCTION__, function () {
+      $cache = \Civi::cache('short');
+      if (!$cache->has('OAuthProvider_list')) {
+        $providers = [];
+        $event = GenericHookEvent::create([
+          'providers' => &$providers,
+        ]);
+        \Civi::dispatcher()->dispatch('hook_civicrm_oauthProviders', $event);
+
+        foreach ($providers as $name => &$provider) {
+          if ($provider['name'] !== $name) {
+            throw new \API_Exception(sprintf("Mismatched OAuth provider names: \"%s\" vs \"%s\"",
+              $provider['name'], $name));
+          }
+          if (!isset($provider['class'])) {
+            $provider['class'] = CiviGenericProvider::class;
+          }
+        }
+
+        $cache->set('OAuthProvider_list', $providers, self::TTL);
+      }
+      return $cache->get('OAuthProvider_list');
+    });
+    return $action->setCheckPermissions($checkPermissions);
+  }
+
+  /**
+   * @param bool $checkPermissions
+   * @return Generic\BasicGetFieldsAction
+   */
+  public static function getFields($checkPermissions = TRUE) {
+    $action = new Generic\BasicGetFieldsAction('OAuthProvider', __FUNCTION__, function () {
+      return [
+        [
+          'name' => 'name',
+        ],
+        [
+          'name' => 'title',
+        ],
+        [
+          'name' => 'class',
+        ],
+        [
+          'name' => 'options',
+        ],
+      ];
+    });
+    return $action->setCheckPermissions($checkPermissions);
+  }
+
+  /**
+   * @return array
+   */
+  public static function permissions() {
+    return [
+      "meta" => ["access CiviCRM"],
+      "get" => ["access CiviCRM"],
+      "default" => ["administer CiviCRM"],
+    ];
+  }
+
+}
diff --git a/ext/oauth-client/Civi/OAuth/CiviGenericProvider.php b/ext/oauth-client/Civi/OAuth/CiviGenericProvider.php
new file mode 100644
index 0000000000..03969977be
--- /dev/null
+++ b/ext/oauth-client/Civi/OAuth/CiviGenericProvider.php
@@ -0,0 +1,6 @@
+<?php
+namespace Civi\OAuth;
+
+class CiviGenericProvider extends \League\OAuth2\Client\Provider\GenericProvider {
+
+}
diff --git a/ext/oauth-client/data/oauth-providers.dist.json b/ext/oauth-client/data/oauth-providers.dist.json
new file mode 100644
index 0000000000..685ee5000b
--- /dev/null
+++ b/ext/oauth-client/data/oauth-providers.dist.json
@@ -0,0 +1,30 @@
+[
+  {
+    "name": "ms-exchange",
+    "title": "Microsoft: Exchange Online",
+    "options": {
+      "urlAuthorize": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize",
+      "urlAccessToken": "https://login.microsoftonline.com/common/oauth2/v2.0/token",
+      "urlResourceOwnerDetails": "https://graph.microsoft.com/v1.0/me",
+      "scopeSeparator": " ",
+      "scopes": [
+        "User.Read",
+        "https://outlook.office.com/IMAP.AccessAsUser.All",
+        "https://outlook.office.com/POP.AccessAsUser.All",
+        "https://outlook.office.com/SMTP.Send",
+        "offline_access"
+      ]
+    },
+    "mailSettingsTemplate": {
+      "name": "{{provider.name}}: {{token.resource_owner.mail}}",
+      "domain": "{{token.resource_owner.mail|getMailDomain}}",
+      "localpart": null,
+      "return_path": null,
+      "protocol:name": "IMAP",
+      "server": "outlook.office365.com",
+      "username": "{{token.resource_owner.mail}}",
+      "password": null,
+      "is_ssl": true
+    }
+  }
+]
diff --git a/ext/oauth-client/data/oauth-providers.test.json b/ext/oauth-client/data/oauth-providers.test.json
new file mode 100644
index 0000000000..7f2339f33d
--- /dev/null
+++ b/ext/oauth-client/data/oauth-providers.test.json
@@ -0,0 +1,21 @@
+[
+  {
+    "name": "test_example_1",
+    "title": "First Test Example",
+    "options": {
+      "urlAuthorize": "https://example.com/one/auth",
+      "urlAccessToken": "https://example.com/one/token",
+      "urlResourceOwnerDetails": "https://example.com/one/owner",
+      "scopes": ["scope-1-foo", "scope-1-bar"]
+    }
+  },
+  {
+    "name": "test_example_2",
+    "title": "Second Test Example",
+    "class": "My\\Example2",
+    "options": {
+      "urlAuthorize": "https://example.com/two",
+      "scopes": ["scope-2-foo", "scope-2-bar"]
+    }
+  }
+]
diff --git a/ext/oauth-client/oauth_client.php b/ext/oauth-client/oauth_client.php
index 7865798986..0940263af5 100644
--- a/ext/oauth-client/oauth_client.php
+++ b/ext/oauth-client/oauth_client.php
@@ -188,3 +188,24 @@ function oauth_client_civicrm_themes(&$themes) {
 //  ));
 //  _oauth_client_civix_navigationMenu($menu);
 //}
+
+/**
+ * Implements hook_civicrm_oauthProviders().
+ */
+function oauth_client_civicrm_oauthProviders(&$providers) {
+  $ingest = function($file) use (&$providers) {
+    $parsed = json_decode(file_get_contents($file), 1);
+    foreach ($parsed as $provider) {
+      $providers[$provider['name']] = $provider;
+    }
+  };
+
+  $ingest(__DIR__ . '/data/oauth-providers.dist.json');
+  if (defined('CIVICRM_TEST')) {
+    $ingest(__DIR__ . '/data/oauth-providers.test.json');
+  }
+  $localFile = Civi::paths()->getPath('[civicrm.private]/oauth-providers.local.json');
+  if (file_exists($localFile)) {
+    $ingest($localFile);
+  }
+}
diff --git a/ext/oauth-client/tests/phpunit/api/v4/OAuthProviderTest.php b/ext/oauth-client/tests/phpunit/api/v4/OAuthProviderTest.php
new file mode 100644
index 0000000000..a7f54e880e
--- /dev/null
+++ b/ext/oauth-client/tests/phpunit/api/v4/OAuthProviderTest.php
@@ -0,0 +1,46 @@
+<?php
+use CRM_OAuth_ExtensionUtil as E;
+use Civi\Test\HeadlessInterface;
+use Civi\Test\HookInterface;
+use Civi\Test\TransactionalInterface;
+
+/**
+ * Read list of OAuth providers
+ *
+ * @group headless
+ */
+class api_v4_OAuthProviderTest extends \PHPUnit\Framework\TestCase implements HeadlessInterface, HookInterface, TransactionalInterface {
+
+  public function setUpHeadless() {
+    // Civi\Test has many helpers, like install(), uninstall(), sql(), and sqlFile().
+    // See: https://docs.civicrm.org/dev/en/latest/testing/phpunit/#civitest
+    return \Civi\Test::headless()->install('oauth-client')->apply();
+  }
+
+  public function setUp() {
+    parent::setUp();
+  }
+
+  public function tearDown() {
+    parent::tearDown();
+  }
+
+  /**
+   * Create, read, and destroy token - with full access to secrets.
+   */
+  public function testGet() {
+    \CRM_Core_Config::singleton()->userPermissionClass->permissions = ['access CiviCRM'];
+
+    $examples = Civi\Api4\OAuthProvider::get()
+      ->addWhere('name', 'LIKE', 'test_example%')
+      ->addOrderBy('name', 'DESC')
+      ->execute();
+    $this->assertEquals(2, $examples->count());
+
+    $this->assertEquals('Civi\OAuth\CiviGenericProvider', $examples->last()['class']);
+    $this->assertEquals('My\Example2', $examples->first()['class']);
+    $this->assertEquals('https://example.com/one/auth', $examples->last()['options']['urlAuthorize']);
+    $this->assertEquals('https://example.com/two', $examples->first()['options']['urlAuthorize']);
+  }
+
+}
diff --git a/ext/oauth-client/tests/phpunit/bootstrap.php b/ext/oauth-client/tests/phpunit/bootstrap.php
index a5b49253c8..41c0800198 100644
--- a/ext/oauth-client/tests/phpunit/bootstrap.php
+++ b/ext/oauth-client/tests/phpunit/bootstrap.php
@@ -2,6 +2,7 @@
 
 ini_set('memory_limit', '2G');
 ini_set('safe_mode', 0);
+define('CIVICRM_TEST', 1);
 // phpcs:disable
 eval(cv('php:boot --level=classloader', 'phpcode'));
 // phpcs:enable
-- 
2.25.1