AC-2653: Fix an admin custom URL functionality

Author: arhiopterecs

app/code/Magento/Config/Model/Config/Backend/Admin/Custom.php

@@ -17,46 +17,46 @@
  */
 class Custom extends \Magento\Framework\App\Config\Value
 {
-    const CONFIG_SCOPE = 'stores';
+    public const CONFIG_SCOPE = 'stores';
 
-    const CONFIG_SCOPE_ID = 0;
+    public const CONFIG_SCOPE_ID = 0;
 
-    const XML_PATH_UNSECURE_BASE_URL = 'web/unsecure/base_url';
-    const XML_PATH_SECURE_BASE_URL = 'web/secure/base_url';
-    const XML_PATH_UNSECURE_BASE_LINK_URL = 'web/unsecure/base_link_url';
-    const XML_PATH_SECURE_BASE_LINK_URL = 'web/secure/base_link_url';
-    const XML_PATH_CURRENCY_OPTIONS_BASE = 'currency/options/base';
-    const XML_PATH_ADMIN_SECURITY_USEFORMKEY = 'admin/security/use_form_key';
-    const XML_PATH_MAINTENANCE_MODE = 'maintenance_mode';
-    const XML_PATH_WEB_COOKIE_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime';
+    public const XML_PATH_UNSECURE_BASE_URL = 'web/unsecure/base_url';
+    public const XML_PATH_SECURE_BASE_URL = 'web/secure/base_url';
+    public const XML_PATH_UNSECURE_BASE_LINK_URL = 'web/unsecure/base_link_url';
+    public const XML_PATH_SECURE_BASE_LINK_URL = 'web/secure/base_link_url';
+    public const XML_PATH_CURRENCY_OPTIONS_BASE = 'currency/options/base';
+    public const XML_PATH_ADMIN_SECURITY_USEFORMKEY = 'admin/security/use_form_key';
+    public const XML_PATH_MAINTENANCE_MODE = 'maintenance_mode';
+    public const XML_PATH_WEB_COOKIE_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime';
     /**
      * @deprecated Misspelled constant - use XML_PATH_WEB_COOKIE_COOKIE_PATH instead
      */
-    const XML_PATH_WEB_COOKIE_COOKE_PATH = 'web/cookie/cookie_path';
-    const XML_PATH_WEB_COOKIE_COOKIE_PATH = 'web/cookie/cookie_path';
-    const XML_PATH_WEB_COOKIE_COOKIE_DOMAIN = 'web/cookie/cookie_domain';
-    const XML_PATH_WEB_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly';
-    const XML_PATH_WEB_COOKIE_RESTRICTION = 'web/cookie/cookie_restriction';
-    const XML_PATH_GENERAL_LOCALE_TIMEZONE = 'general/locale/timezone';
-    const XML_PATH_GENERAL_LOCALE_CODE = 'general/locale/code';
-    const XML_PATH_GENERAL_COUNTRY_DEFAULT = 'general/country/default';
-    const XML_PATH_SYSTEM_BACKUP_ENABLED = 'system/backup/enabled';
-    const XML_PATH_DEV_JS_MERGE_FILES = 'dev/js/merge_files';
-    const XML_PATH_DEV_JS_MINIFY_FILES = 'dev/js/minify_files';
-    const XML_PATH_DEV_CSS_MERGE_CSS_FILES = 'dev/css/merge_css_files';
-    const XML_PATH_DEV_CSS_MINIFY_FILES = 'dev/css/minify_files';
-    const XML_PATH_DEV_IMAGE_DEFAULT_ADAPTER = 'dev/image/default_adapter';
-    const XML_PATH_WEB_SESSION_USE_FRONTEND_SID = 'web/session/use_frontend_sid';
-    const XML_PATH_WEB_SESSION_USE_HTTP_X_FORWARDED_FOR = 'web/session/use_http_x_forwarded_for';
-    const XML_PATH_WEB_SESSION_USE_HTTP_VIA = 'web/session/use_http_via';
-    const XML_PATH_WEB_SESSION_USE_REMOTE_ADDR = 'web/session/use_remote_addr';
-    const XML_PATH_WEB_SESSION_USE_HTTP_USER_AGENT = 'web/session/use_http_user_agent';
-    const XML_PATH_CATALOG_FRONTEND_FLAT_CATALOG_CATEGORY = 'catalog/frontend/flat_catalog_category';
-    const XML_PATH_CATALOG_FRONTEND_FLAT_CATALOG_PRODUCT = 'catalog/frontend/flat_catalog_product';
-    const XML_PATH_TAX_WEEE_ENABLE = 'tax/weee/enable';
-    const XML_PATH_CATALOG_SEARCH_ENGINE = 'catalog/search/engine';
-    const XML_PATH_CARRIERS = 'carriers';
-    const XML_PATH_PAYMENT = 'payment';
+    public const XML_PATH_WEB_COOKIE_COOKE_PATH = 'web/cookie/cookie_path';
+    public const XML_PATH_WEB_COOKIE_COOKIE_PATH = 'web/cookie/cookie_path';
+    public const XML_PATH_WEB_COOKIE_COOKIE_DOMAIN = 'web/cookie/cookie_domain';
+    public const XML_PATH_WEB_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly';
+    public const XML_PATH_WEB_COOKIE_RESTRICTION = 'web/cookie/cookie_restriction';
+    public const XML_PATH_GENERAL_LOCALE_TIMEZONE = 'general/locale/timezone';
+    public const XML_PATH_GENERAL_LOCALE_CODE = 'general/locale/code';
+    public const XML_PATH_GENERAL_COUNTRY_DEFAULT = 'general/country/default';
+    public const XML_PATH_SYSTEM_BACKUP_ENABLED = 'system/backup/enabled';
+    public const XML_PATH_DEV_JS_MERGE_FILES = 'dev/js/merge_files';
+    public const XML_PATH_DEV_JS_MINIFY_FILES = 'dev/js/minify_files';
+    public const XML_PATH_DEV_CSS_MERGE_CSS_FILES = 'dev/css/merge_css_files';
+    public const XML_PATH_DEV_CSS_MINIFY_FILES = 'dev/css/minify_files';
+    public const XML_PATH_DEV_IMAGE_DEFAULT_ADAPTER = 'dev/image/default_adapter';
+    public const XML_PATH_WEB_SESSION_USE_FRONTEND_SID = 'web/session/use_frontend_sid';
+    public const XML_PATH_WEB_SESSION_USE_HTTP_X_FORWARDED_FOR = 'web/session/use_http_x_forwarded_for';
+    public const XML_PATH_WEB_SESSION_USE_HTTP_VIA = 'web/session/use_http_via';
+    public const XML_PATH_WEB_SESSION_USE_REMOTE_ADDR = 'web/session/use_remote_addr';
+    public const XML_PATH_WEB_SESSION_USE_HTTP_USER_AGENT = 'web/session/use_http_user_agent';
+    public const XML_PATH_CATALOG_FRONTEND_FLAT_CATALOG_CATEGORY = 'catalog/frontend/flat_catalog_category';
+    public const XML_PATH_CATALOG_FRONTEND_FLAT_CATALOG_PRODUCT = 'catalog/frontend/flat_catalog_product';
+    public const XML_PATH_TAX_WEEE_ENABLE = 'tax/weee/enable';
+    public const XML_PATH_CATALOG_SEARCH_ENGINE = 'catalog/search/engine';
+    public const XML_PATH_CARRIERS = 'carriers';
+    public const XML_PATH_PAYMENT = 'payment';
 
     /**
      * @var \Magento\Framework\App\Config\Storage\WriterInterface

app/code/Magento/Security/Model/AdminSessionsManager.php

@@ -8,8 +8,11 @@
 namespace Magento\Security\Model;
 
 use Exception;
+use Magento\Backend\Model\Auth\Session;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\HTTP\PhpEnvironment\RemoteAddress;
+use Magento\Framework\Stdlib\DateTime\DateTime;
+use Magento\Security\Model\ResourceModel\AdminSessionInfo\Collection;
 use Magento\Security\Model\ResourceModel\AdminSessionInfo\CollectionFactory;
 
 /**
@@ -23,12 +26,12 @@ class AdminSessionsManager
     /**
      * Admin Session lifetime (sec)
      */
-    const ADMIN_SESSION_LIFETIME = 86400;
+    public const ADMIN_SESSION_LIFETIME = 86400;
 
     /**
      * Logout reason when current user has been locked out
      */
-    const LOGOUT_REASON_USER_LOCKED = 10;
+    public const LOGOUT_REASON_USER_LOCKED = 10;
 
     /**
      * @var ConfigInterface
@@ -37,7 +40,7 @@ class AdminSessionsManager
     protected $securityConfig;
 
     /**
-     * @var \Magento\Backend\Model\Auth\Session
+     * @var Session
      * @since 100.1.0
      */
     protected $authSession;
@@ -49,19 +52,19 @@ class AdminSessionsManager
     protected $adminSessionInfoFactory;
 
     /**
-     * @var \Magento\Security\Model\ResourceModel\AdminSessionInfo\CollectionFactory
+     * @var CollectionFactory
      * @since 100.1.0
      */
     protected $adminSessionInfoCollectionFactory;
 
     /**
-     * @var \Magento\Security\Model\AdminSessionInfo
+     * @var AdminSessionInfo
      * @since 100.1.0
      */
     protected $currentSession;
 
     /**
-     * @var \Magento\Framework\Stdlib\DateTime\DateTime
+     * @var DateTime
      */
     private $dateTime;
 
@@ -75,23 +78,25 @@ class AdminSessionsManager
      *
      * Means that after session was prolonged
      * all other prolongs will be ignored within this period
+     *
+     * @var int
      */
     private $maxIntervalBetweenConsecutiveProlongs = 60;
 
     /**
      * @param ConfigInterface $securityConfig
-     * @param \Magento\Backend\Model\Auth\Session $authSession
+     * @param Session $authSession
      * @param AdminSessionInfoFactory $adminSessionInfoFactory
      * @param CollectionFactory $adminSessionInfoCollectionFactory
-     * @param \Magento\Framework\Stdlib\DateTime\DateTime $dateTime
+     * @param DateTime $dateTime
      * @param RemoteAddress $remoteAddress
      */
     public function __construct(
         ConfigInterface $securityConfig,
-        \Magento\Backend\Model\Auth\Session $authSession,
-        \Magento\Security\Model\AdminSessionInfoFactory $adminSessionInfoFactory,
-        \Magento\Security\Model\ResourceModel\AdminSessionInfo\CollectionFactory $adminSessionInfoCollectionFactory,
-        \Magento\Framework\Stdlib\DateTime\DateTime $dateTime,
+        Session $authSession,
+        AdminSessionInfoFactory $adminSessionInfoFactory,
+        CollectionFactory $adminSessionInfoCollectionFactory,
+        DateTime $dateTime,
         RemoteAddress $remoteAddress
     ) {
         $this->securityConfig = $securityConfig;
@@ -106,6 +111,7 @@ public function __construct(
      * Handle all others active sessions according Sharing Account Setting
      *
      * @return $this
+     * @throws Exception
      * @since 100.1.0
      */
     public function processLogin()
@@ -132,6 +138,7 @@ public function processLogin()
      * Handle Prolong process
      *
      * @return $this
+     * @throws Exception
      * @since 100.1.0
      */
     public function processProlong()
@@ -172,6 +179,7 @@ public function processLogout()
      * Get current session record
      *
      * @return AdminSessionInfo
+     * @throws Exception
      * @since 100.1.0
      */
     public function getCurrentSession()
@@ -244,13 +252,13 @@ public function getLogoutReasonMessage()
     /**
      * Get sessions for current user
      *
-     * @return \Magento\Security\Model\ResourceModel\AdminSessionInfo\Collection
+     * @return Collection
      * @since 100.1.0
      */
     public function getSessionsForCurrentUser()
     {
         return $this->createAdminSessionInfoCollection()
-            ->filterByUser($this->authSession->getUser()->getId(), \Magento\Security\Model\AdminSessionInfo::LOGGED_IN)
+            ->filterByUser($this->authSession->getUser()->getId(), AdminSessionInfo::LOGGED_IN)
             ->filterExpiredSessions($this->securityConfig->getAdminSessionLifetime())
             ->loadData();
     }
@@ -266,13 +274,13 @@ public function logoutOtherUserSessions()
         $collection = $this->createAdminSessionInfoCollection()
             ->filterByUser(
                 $this->authSession->getUser()->getId(),
-                \Magento\Security\Model\AdminSessionInfo::LOGGED_IN,
+                AdminSessionInfo::LOGGED_IN,
                 $this->authSession->getAdminSessionInfoId()
             )
             ->filterExpiredSessions($this->securityConfig->getAdminSessionLifetime())
             ->loadData();
 
-        $collection->setDataToAll('status', \Magento\Security\Model\AdminSessionInfo::LOGGED_OUT_MANUALLY)
+        $collection->setDataToAll('status', AdminSessionInfo::LOGGED_OUT_MANUALLY)
             ->save();
 
         return $this;
@@ -304,8 +312,8 @@ protected function createNewSession()
     {
         $user = $this->authSession->getUser();
         if (null === $user) {
-           $this->processLogout();
-           throw new LocalizedException(__('User not found'));
+            $this->processLogout();
+            throw new LocalizedException(__('User not found'));
         }
 
         $adminSessionInfo = $this->adminSessionInfoFactory
@@ -324,7 +332,9 @@ protected function createNewSession()
     }
 
     /**
-     * @return \Magento\Security\Model\ResourceModel\AdminSessionInfo\Collection
+     * Creates the collection of admin session
+     *
+     * @return Collection
      * @since 100.1.0
      */
     protected function createAdminSessionInfoCollection()
@@ -333,8 +343,7 @@ protected function createAdminSessionInfoCollection()
     }
 
     /**
-     * Calculates diff between now and last session updated_at
-     * and decides whether new prolong must be triggered or not
+     * Calculates diff between now and last session updated_at and decides whether new prolong must be triggered or not
      *
      * This is done to limit amount of session prolongs and updates to database
      * within some period of time - X