make api permission configurable

dachcom-digital · Oct 16, 2020 · 48fc8a3 · 48fc8a3
1 parent 18e6b98
commit 48fc8a3
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -74,6 +74,21 @@ Otherwise, you'll receive an error message. You may then need to repeat the conn
 | `Page Id` | Defines which page entries should be imported |
 | `Limit` | Define a limit to restrict the amount of social posts to import (Default: 50) |
 
+## Extended Connector Configuration
+Normally you don't need to modify connector (`connector_config`) configuration, so most of the time you can skip this step.
+However, if you need to change some core setting of a connector, you're able to change them of course.
+
+```yaml
+# app/config/config.yml
+social_data:
+    available_connectors:
+        -   connector_name: facebook
+            connector_config:
+                api_connect_permission: ['pages_show_list'] # default value
+```
+
+***
+
 ## Copyright and license
 Copyright: [DACHCOM.DIGITAL](http://dachcom-digital.ch)  
 For licensing details please visit [LICENSE.md](LICENSE.md)  

diff --git a/src/Controller/Admin/FacebookController.php b/src/Controller/Admin/FacebookController.php
@@ -8,6 +8,7 @@
 use Pimcore\Bundle\AdminBundle\HttpFoundation\JsonResponse;
 use SocialData\Connector\Facebook\Client\FacebookClient;
 use SocialData\Connector\Facebook\Model\EngineConfiguration;
+use SocialDataBundle\Connector\ConnectorDefinitionInterface;
 use SocialDataBundle\Controller\Admin\Traits\ConnectResponseTrait;
 use SocialDataBundle\Service\ConnectorServiceInterface;
 use SocialDataBundle\Service\EnvironmentServiceInterface;
@@ -64,20 +65,19 @@ public function __construct(
     public function connectAction(Request $request)
     {
         try {
-            $connectorEngineConfig = $this->getConnectorEngineConfig();
+            $connectorDefinition = $this->getConnectorDefinition();
+            $connectorEngineConfig = $this->getConnectorEngineConfig($connectorDefinition);
         } catch (\Throwable $e) {
             return $this->buildConnectErrorResponse(500, 'general_error', 'connector engine configuration error', $e->getMessage());
         }
 
         $fb = $this->facebookClient->getClient($connectorEngineConfig);
+
         $helper = $fb->getRedirectLoginHelper();
+        $definitionConfiguration = $connectorDefinition->getDefinitionConfiguration();
 
         $callbackUrl = $this->generateUrl('social_data_connector_facebook_connect_check', [], UrlGeneratorInterface::ABSOLUTE_URL);
-
-        // @todo: make this configurable (e.g. via connector config?)
-        $permissions = ['pages_show_list'];
-
-        $loginUrl = $helper->getLoginUrl($callbackUrl, $permissions);
+        $loginUrl = $helper->getLoginUrl($callbackUrl, $definitionConfiguration['api_connect_permission']);
 
         return $this->redirect($loginUrl);
     }
@@ -92,7 +92,7 @@ public function connectAction(Request $request)
     public function checkAction(Request $request)
     {
         try {
-            $connectorEngineConfig = $this->getConnectorEngineConfig();
+            $connectorEngineConfig = $this->getConnectorEngineConfig($this->getConnectorDefinition());
         } catch (\Throwable $e) {
             return $this->buildConnectErrorResponse(500, 'general_error', 'connector engine configuration error', $e->getMessage());
         }
@@ -145,7 +145,7 @@ public function checkAction(Request $request)
     public function debugTokenAction(Request $request)
     {
         try {
-            $connectorEngineConfig = $this->getConnectorEngineConfig();
+            $connectorEngineConfig = $this->getConnectorEngineConfig($this->getConnectorDefinition());
         } catch (\Throwable $e) {
             return $this->adminJson(['error' => true, 'message' => $e->getMessage()]);
         }
@@ -197,16 +197,26 @@ public function debugTokenAction(Request $request)
     }
 
     /**
-     * @return EngineConfiguration
+     * @return ConnectorDefinitionInterface
      */
-    protected function getConnectorEngineConfig()
+    protected function getConnectorDefinition()
     {
         $connectorDefinition = $this->connectorService->getConnectorDefinition('facebook', true);
 
         if (!$connectorDefinition->engineIsLoaded()) {
             throw new HttpException(400, 'Engine is not loaded.');
         }
 
+        return $connectorDefinition;
+    }
+
+    /**
+     * @param ConnectorDefinitionInterface $connectorDefinition
+     *
+     * @return EngineConfiguration
+     */
+    protected function getConnectorEngineConfig(ConnectorDefinitionInterface $connectorDefinition)
+    {
         $connectorEngineConfig = $connectorDefinition->getEngineConfiguration();
         if (!$connectorEngineConfig instanceof EngineConfiguration) {
             throw new HttpException(400, 'Invalid facebook configuration. Please configure your connector "facebook" in backend first.');

diff --git a/src/Definition/ConnectorDefinition.php b/src/Definition/ConnectorDefinition.php
@@ -66,10 +66,10 @@ public function setDefinitionConfiguration(array $definitionConfiguration)
     {
         $resolver = new OptionsResolver();
         $resolver->setDefaults([
-            'core_disabled' => false
+            'api_connect_permission' => ['pages_show_list']
         ]);
 
-        $resolver->setAllowedTypes('core_disabled', 'bool');
+        $resolver->setAllowedTypes('api_connect_permission', 'string[]');
 
         try {
             $this->definitionConfiguration = $resolver->resolve($definitionConfiguration);
@@ -99,10 +99,6 @@ public function engineIsLoaded()
      */
     public function isOnline()
     {
-        if ($this->definitionConfiguration['core_disabled'] === true) {
-            return false;
-        }
-
         if (!$this->engineIsLoaded()) {
             return false;
         }
@@ -190,14 +186,6 @@ public function needsEngineConfiguration()
         return true;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function hasLogPanel()
-    {
-        return false;
-    }
-
     /**
      * {@inheritdoc}
      */