Merge pull request #7612 from magento-performance/ims-phase1

CABPI-4: IMS identity | Adobe Commerce Core Admin Panel

Author: andimov

app/code/Magento/AdminAdobeIms/.gitignore

@@ -0,0 +1 @@
+view/adminhtml/web/node_modules/

app/code/Magento/AdminAdobeIms/Api/Data/ImsWebapiInterface.php

@@ -0,0 +1,145 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AdminAdobeIms\Api\Data;
+
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+/**
+ * Declare the ims token data service object
+ * @api
+ */
+interface ImsWebapiInterface extends ExtensibleDataInterface
+{
+    /**
+     * Get ID
+     *
+     * @return int|null
+     */
+    public function getId();
+
+    /**
+     * Get admin user ID
+     *
+     * @return int|null
+     */
+    public function getAdminUserId(): ?int;
+
+    /**
+     * Set admin user ID
+     *
+     * @param int $value
+     * @return $this
+     */
+    public function setAdminUserId(int $value): ImsWebapiInterface;
+
+    /**
+     * Get access token hash
+     *
+     * @return string|null
+     */
+    public function getAccessTokenHash(): ?string;
+
+    /**
+     * Set access token hash
+     *
+     * @param string $value
+     * @return $this
+     */
+    public function setAccessTokenHash(string $value): ImsWebapiInterface;
+
+    /**
+     * Get access token
+     *
+     * @return string|null
+     */
+    public function getAccessToken(): ?string;
+
+    /**
+     * Set access token
+     *
+     * @param string $value
+     * @return $this
+     */
+    public function setAccessToken(string $value): ImsWebapiInterface;
+
+    /**
+     * Get creation time
+     *
+     * @return string|null
+     */
+    public function getCreatedAt(): ?string;
+
+    /**
+     * Set creation time
+     *
+     * @param string $value
+     * @return $this
+     */
+    public function setCreatedAt(string $value): ImsWebapiInterface;
+
+    /**
+     * Get update time
+     *
+     * @return string|null
+     */
+    public function getUpdatedAt(): ?string;
+
+    /**
+     * Set update time
+     *
+     * @param string $value
+     * @return $this
+     */
+    public function setUpdatedAt(string $value): ImsWebapiInterface;
+
+    /**
+     * Get last check time
+     *
+     * @return string|null
+     */
+    public function getLastCheckTime(): ?string;
+
+    /**
+     * Set last check time
+     *
+     * @param string $value
+     * @return $this
+     */
+    public function setLastCheckTime(string $value): ImsWebapiInterface;
+
+    /**
+     * Get expires time of token
+     *
+     * @return string|null
+     */
+    public function getAccessTokenExpiresAt(): ?string;
+
+    /**
+     * Set expires time of token
+     *
+     * @param string $value
+     * @return $this
+     */
+    public function setAccessTokenExpiresAt(string $value): ImsWebapiInterface;
+
+    /**
+     * Retrieve existing extension attributes object or create a new one.
+     *
+     * @return \Magento\AdminAdobeIms\Api\Data\ImsWebapiExtensionInterface|null
+     */
+    public function getExtensionAttributes(): ImsWebapiExtensionInterface;
+
+    /**
+     * Set extension attributes
+     *
+     * @param \Magento\AdminAdobeIms\Api\Data\ImsWebapiExtensionInterface $extensionAttributes
+     * @return $this
+     */
+    public function setExtensionAttributes(ImsWebapiExtensionInterface $extensionAttributes): ImsWebapiInterface;
+}

app/code/Magento/AdminAdobeIms/Api/Data/ImsWebapiSearchResultsInterface.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AdminAdobeIms\Api\Data;
+
+use Magento\AdminAdobeIms\Api\Data\ImsWebapiInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+
+/**
+ * Interface ImsWebapiSearchResultsInterface
+ *
+ * @api
+ */
+interface ImsWebapiSearchResultsInterface extends SearchResultsInterface
+{
+    /**
+     * Get ims token list.
+     *
+     * @return ImsWebapiInterface[]
+     */
+    public function getItems();
+
+    /**
+     * Set ims token list.
+     *
+     * @param ImsWebapiInterface[] $items
+     * @return $this
+     */
+    public function setItems(array $items);
+}

app/code/Magento/AdminAdobeIms/Api/ImsLogOutInterface.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AdminAdobeIms\Api;
+
+/**
+ * Declare functionality for user logout from the Adobe IMS account
+ *
+ * @api
+ */
+interface ImsLogOutInterface
+{
+    /**
+     * LogOut User from Adobe IMS Account
+     *
+     * @param string|null $accessToken
+     * @return bool
+     */
+    public function execute(?string $accessToken = null) : bool;
+}

app/code/Magento/AdminAdobeIms/Api/ImsWebapiRepositoryInterface.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AdminAdobeIms\Api;
+
+use Magento\AdminAdobeIms\Api\Data\ImsWebapiInterface;
+
+use Magento\AdminAdobeIms\Api\Data\ImsWebapiSearchResultsInterface;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Exception\CouldNotSaveException;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+/**
+ * Declare ims web api repository
+ * @api
+ */
+interface ImsWebapiRepositoryInterface
+{
+    /**
+     * Save ims token
+     *
+     * @param ImsWebapiInterface $entity
+     * @return void
+     * @throws CouldNotSaveException
+     */
+    public function save(ImsWebapiInterface $entity): void;
+
+    /**
+     * Get ims token
+     *
+     * @param int $entityId
+     * @return ImsWebapiInterface
+     * @throws NoSuchEntityException
+     */
+    public function get(int $entityId): ImsWebapiInterface;
+
+    /**
+     * Get ims token(s) by admin user id
+     *
+     * @param int $adminUserId
+     * @return ImsWebapiInterface[]
+     * @throws NoSuchEntityException
+     */
+    public function getByAdminUserId(int $adminUserId): array;
+
+    /**
+     * Get entity by access token hash
+     *
+     * @param string $tokenHash
+     * @return ImsWebapiInterface
+     * @throws NoSuchEntityException
+     */
+    public function getByAccessTokenHash(string $tokenHash): ImsWebapiInterface;
+
+    /**
+     * Get ims token by search criteria
+     *
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return ImsWebapiSearchResultsInterface
+     * @throws NoSuchEntityException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): ImsWebapiSearchResultsInterface;
+
+    /**
+     * Delete ims tokens for admin user id.
+     *
+     * @param int $adminUserId
+     * @return bool
+     * @throws NoSuchEntityException
+     * @throws LocalizedException
+     */
+    public function deleteByAdminUserId(int $adminUserId): bool;
+}

app/code/Magento/AdminAdobeIms/Api/TokenReaderInterface.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AdminAdobeIms\Api;
+
+use Magento\Framework\Exception\AuthenticationException;
+use Magento\Framework\Exception\AuthorizationException;
+use Magento\Framework\Exception\InvalidArgumentException;
+
+/**
+ * Reads token data.
+ */
+interface TokenReaderInterface
+{
+    /**
+     * Read data from a token.
+     *
+     * @param string $token
+     * @return array
+     * @throws AuthenticationException
+     * @throws AuthorizationException
+     * @throws InvalidArgumentException
+     */
+    public function read(string $token);
+}

app/code/Magento/AdminAdobeIms/App/Action/Plugin/Authentication.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\AdminAdobeIms\App\Action\Plugin;
+
+use Magento\AdminAdobeIms\Controller\Adminhtml\OAuth\ImsCallback;
+use Magento\Backend\App\Action\Plugin\Authentication as CoreAuthentication;
+use Magento\Backend\App\BackendAppList;
+use Magento\Backend\Model\Auth;
+use Magento\Backend\Model\UrlInterface;
+use Magento\Framework\App\ActionFlag;
+use Magento\Framework\App\ResponseInterface;
+use Magento\Framework\Controller\Result\RedirectFactory;
+use Magento\Framework\Data\Form\FormKey\Validator;
+use Magento\Framework\Message\ManagerInterface;
+
+class Authentication extends CoreAuthentication
+{
+    /**
+     * @param Auth $auth
+     * @param UrlInterface $url
+     * @param ResponseInterface $response
+     * @param ActionFlag $actionFlag
+     * @param ManagerInterface $messageManager
+     * @param UrlInterface $backendUrl
+     * @param RedirectFactory $resultRedirectFactory
+     * @param BackendAppList $backendAppList
+     * @param Validator $formKeyValidator
+     */
+    public function __construct(
+        Auth $auth,
+        UrlInterface $url,
+        ResponseInterface $response,
+        ActionFlag $actionFlag,
+        ManagerInterface $messageManager,
+        UrlInterface $backendUrl,
+        RedirectFactory $resultRedirectFactory,
+        BackendAppList $backendAppList,
+        Validator $formKeyValidator
+    ) {
+        parent::__construct(
+            $auth,
+            $url,
+            $response,
+            $actionFlag,
+            $messageManager,
+            $backendUrl,
+            $resultRedirectFactory,
+            $backendAppList,
+            $formKeyValidator
+        );
+
+        $this->_openActions[] = ImsCallback::ACTION_NAME;
+    }
+}