Merge pull request #47 from experius/feature/IN-23-453

[FEATURE][IN23-453] Add configurable exclude list to be able to exclude url's from the logging

Author: DRdevil27

Helper/Settings.php

@@ -16,7 +16,10 @@ class Settings extends AbstractHelper
     const IS_CRON_ENABLED = 'pagenotfound/cron_config/is_cron_enabled';
     const CONFIG_DAYS_TO_CLEAN = 'pagenotfound/cron_config/days_to_clean';
     const DELETE_NOT_EMPTY_REDIRECT = 'pagenotfound/cron_config/delete_not_empty_redirect';
-
+    const ENABLED = 'pagenotfound/general/enabled';
+    const INCLUDED_PARAMS_REDIRECT = 'pagenotfound/general/included_params_redirect';
+    const INCLUDED_PARAMS_FROM_URL = 'pagenotfound/general/included_params_from_url';
+    const EXCLUDE_LIST = 'pagenotfound/general/exclude_list';
     /**
      * @param Context $context
      */
@@ -50,4 +53,23 @@ public function getDeleteNotEmpyRedirect()
         return $this->scopeConfig->getValue(self::DELETE_NOT_EMPTY_REDIRECT);
     }
 
+    public function isEnabled()
+    {
+        return $this->scopeConfig->getValue(self::ENABLED,\Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+    }
+
+    public function includedParamsInRedirect()
+    {
+        return $this->scopeConfig->getValue(self::INCLUDED_PARAMS_REDIRECT,\Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+    }
+
+    public function includedParamsInFromUrl()
+    {
+        return $this->scopeConfig->getValue(self::INCLUDED_PARAMS_FROM_URL,\Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+    }
+
+    public function getExcludeList()
+    {
+        return $this->scopeConfig->getValue(self::EXCLUDE_LIST,\Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+    }
 }

Observer/Controller/ActionPredispatch.php

@@ -27,6 +27,9 @@ class ActionPredispatch implements \Magento\Framework\Event\ObserverInterface
     protected $urlParts = [];
 
     protected $storeManager;
+
+    protected $settings;
+
     private $resultFactory;
 
     public function __construct(
@@ -38,6 +41,7 @@ public function __construct(
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
         \Magento\Framework\Controller\ResultFactory $resultFactory,
         \Magento\Store\Model\StoreManagerInterface $storeManager,
+        \Experius\PageNotFound\Helper\Settings $settings
 
     ) {
         $this->url = $url;
@@ -48,32 +52,34 @@ public function __construct(
         $this->scopeConfig = $scopeConfig;
         $this->resultFactory = $resultFactory;
         $this->storeManager = $storeManager;
-
+        $this->settings = $settings;
     }
 
-    private function isEnabled()
-    {
-        $configValue = $this->scopeConfig->getValue('pagenotfound/general/enabled',\Magento\Store\Model\ScopeInterface::SCOPE_STORE);
-        return $configValue ? explode(',',$configValue) : [];
-    }
 
-    private function includedParamsInRedirect()
+    protected function shouldExcludeUrl($url)
     {
-        $configValue = $this->scopeConfig->getValue('pagenotfound/general/included_params_redirect',\Magento\Store\Model\ScopeInterface::SCOPE_STORE);
-        return $configValue ? explode(',',$configValue) : [];
-    }
+        $excludeList = $this->settings->getExcludeList();
+        if (empty($excludeList)) {
+            return false;
+        }
 
-    private function includedParamsInFromUrl()
-    {
-        $configValue = $this->scopeConfig->getValue('pagenotfound/general/included_params_from_url',\Magento\Store\Model\ScopeInterface::SCOPE_STORE);
-        return $configValue ? explode(',',$configValue) : [];
+        $urlPath = parse_url($url, PHP_URL_PATH);
+        $urlPath = ltrim($urlPath, '/');
+        
+        foreach ($excludeList as $excludeItem) {        
+            if (strpos($urlPath, $excludeItem) !== false) {
+                return true;
+            }
+        }
+        
+        return false;
     }
 
     public function execute(
         \Magento\Framework\Event\Observer $observer
     ) {
 
-        if(!$this->isEnabled()){
+        if(!$this->settings->isEnabled()){
             return;
         }
 
@@ -86,7 +92,11 @@ public function execute(
 
         $this->urlParts = parse_url($this->url->getCurrentUrl());
 
-        $this->savePageNotFound($this->getCurrentUrl());
+        $currentUrl = $this->getCurrentUrl();
+        
+        if (!$this->shouldExcludeUrl($currentUrl)) {
+            $this->savePageNotFound($currentUrl);
+        }
 
     }
 
@@ -173,7 +183,7 @@ protected function getParams($redirect=true){
 
         $queryArray = $this->getRequest()->getParams();
 
-        $unsetParams = ($redirect) ? $this->includedParamsInRedirect() : $this->includedParamsInFromUrl();
+        $unsetParams = ($redirect) ? $this->settings->includedParamsInRedirect() : $this->settings->includedParamsInFromUrl();
 
         foreach($queryArray as $key=>$value){
 

etc/adminhtml/system.xml

@@ -20,6 +20,10 @@
                     <label>Included Params in To Url</label>
                     <comment>comma separated. For example language,p,id</comment>
                 </field>
+                <field id="exclude_list" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="60" translate="label" type="textarea">
+                    <label>Exclude List</label>
+                    <comment>Comma separated values that should not be logged to database. For example: wp-content,wp-admin,.htaccess,robots.txt</comment>
+                </field>
             </group>
             <group id="cron_config" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="10" translate="label">
                 <label>config</label>

etc/config.xml

@@ -6,6 +6,7 @@
                 <enabled>1</enabled>
                 <included_params_redirect/>
                 <included_params_from_url/>
+                <exclude_list>wp-content,wp-admin,.htaccess,robots.txt,favicon.ico,apple-touch-icon,sitemap.xml,wp-json,wp-includes,wp-config.php,license.txt,admin,phpmyadmin,backup,backups,old,test,tmp,temp,index.html,index.php</exclude_list>
             </general>
             <cron_config>
                 <is_cron_enabled>0</is_cron_enabled>