Merge pull request #6 from gaertnermarkus/master

add UserAgent "CacheWarmer"

Application/Controller/CacheWarmer.php

@@ -1,207 +0,0 @@
-<?php
-/**
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * @copyright (c) Proud Sourcing GmbH | 2016
- * @link www.proudcommerce.com
- * @package psCacheWarmer
- * @version 1.0.1
- **/
-
-namespace ProudCommerce\CacheWarmer\Application\Controller;
-
-use OxidEsales\Eshop\Core\Registry;
-use OxidEsales\Eshop\Core\Controller\BaseController;
-
-class CacheWarmer extends BaseController
-{
-    protected $_sFileAndPathToExportFile = '';
-    protected $_handle = null;
-    protected $_sSeparator = ";";
-    protected $_sEnclosure = "'";
-
-    // todo: add to config
-    protected $_aHttpCodesIsOkay = array('200','302');
-    /**
-     * Executes cache warmer
-     */
-    public function render()
-    {
-        $sMessage = "<b>psCacheWarmer</b><br>".$this->_getSitemapUrl()."<br>---<br>";
-
-        $this->_sFileAndPathToExportFile = $this->_getPathWithFileName();
-        if(Registry::getConfig()->getShopConfVar('psCacheWarmerWriteCsv') == true)
-        {
-            $this->_handle = fopen( $this->_sFileAndPathToExportFile, "w+");;
-        }
-
-        if($this->_checkAuthentification()) {
-            $aUrls = $this->_getSitemapContent();
-            if(!empty(Registry::getConfig()->getShopConfVar('psCacheWarmerSitemapUrl'))  && count($aUrls) > 0) {
-                foreach($aUrls as $sUrl) {
-                    $oCurl = $this->_runCurlConnect($sUrl);
-                    $sMessage .= $this->_checkCurlResults($oCurl,$sUrl);
-                    curl_close($oCurl);
-                }
-            } else {
-                $sMessage .= '<span style="color: red;">Keine Daten vorhanden!</span>';
-            }
-        } else {
-            $sMessage .= '<span style="color: red;">Authentifizierung fehlgeschlagen!</span>';
-        }
-
-        if(Registry::getConfig()->getShopConfVar('psCacheWarmerWriteCsv') == true)
-        {
-            fclose($this->_handle);
-        }
-        echo '<pre>'.$sMessage.'</pre>';
-        exit;
-    }
-
-    /**
-     * @param $sUrl
-     * @return false|resource
-     */
-    protected function _runCurlConnect($sUrl)
-    {
-        $oCurl = curl_init();
-        curl_setopt($oCurl, CURLOPT_URL, $sUrl);
-        curl_setopt($oCurl, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($oCurl, CURLOPT_CONNECTTIMEOUT, 25);
-        curl_setopt($oCurl, CURLOPT_HEADER, true);
-        $sUsername = Registry::getConfig()->getShopConfVar('psCacheWarmerUser');
-        $sPassword = Registry::getConfig()->getShopConfVar('psCacheWarmerPass');
-        curl_setopt($oCurl, CURLOPT_USERPWD, $sUsername . ":" . $sPassword);
-        curl_exec($oCurl);
-        return $oCurl;
-    }
-
-    protected function _checkCurlResults($oCurl,$sUrl)
-    {
-        $sMessage = '';
-        $httpStatus = curl_getinfo($oCurl, CURLINFO_HTTP_CODE);
-        if(curl_error($oCurl)) {
-            $sMessage .= '<span style="color: orange;">ERROR '.$httpStatus.': ' . curl_error($oCurl) . '</span><br>';
-            $sStatusMsg = 'ERROR';
-            $sTmpText = curl_error($oCurl);
-        } else {
-            $sTmpText = $sUrl;
-            if(in_array(trim($httpStatus),$this->_aHttpCodesIsOkay))
-            {
-                $sMessage .= '<span style="color: green;">OK '.$httpStatus.': ' . $sUrl . '</span><br>';
-                $sStatusMsg = 'OK';
-            }
-            else{
-                $sMessage .= '<span style="color: red;">ERROR <b>'.$httpStatus.'</b>: ' . $sUrl. '</span><br>';
-                $sStatusMsg = 'ERROR';
-            }
-        }
-
-        if(Registry::getConfig()->getShopConfVar('psCacheWarmerWriteCsv') == true)
-        {
-            $aTmp = array($sStatusMsg,
-                        $httpStatus,
-                          $sTmpText
-            );
-
-            if(trim($httpStatus) == '200' && Registry::getConfig()->getShopConfVar('psCacheWarmerWriteCsvOnlyError') == true)
-            {
-                $aTmp = array();
-            }
-
-            if(count($aTmp)) {
-                fputcsv($this->_handle, $aTmp, $this->_sSeparator, $this->_sEnclosure);
-            }
-        }
-
-        return $sMessage;
-    }
-
-    /**
-     * Returens urls from sitemap
-     *
-     * @return array    urls
-     */
-    protected function _getSitemapContent($sSitemapUrl = "")
-    {
-        $aUrls = array();
-        if(empty($sSitemapUrl)) {
-            $sSitemapUrl = $this->_getSitemapUrl();
-        }
-
-        $sUsername = Registry::getConfig()->getShopConfVar('psCacheWarmerUser');
-        $sPassword = Registry::getConfig()->getShopConfVar('psCacheWarmerPass');
-        $sSitemapUrl = str_replace("://", "://".$sUsername.":".$sPassword."@", $sSitemapUrl);
-
-        $sSitemapXmlData = @file_get_contents($sSitemapUrl);
-        if($oSitemap = @simplexml_load_string($sSitemapXmlData)) {
-            if (count($oSitemap->sitemap) > 0) {
-                foreach ($oSitemap->sitemap as $oSubSitemap) {
-                    $sNextSitemapUrl = (string)$oSubSitemap->loc;
-                    $aUrls = array_merge($aUrls, $this->_getSitemapContent($sNextSitemapUrl));
-                }
-            }
-
-            if(count($oSitemap->url) > 0) {
-                foreach($oSitemap->url as $oSitemapUrl) {
-                    $aUrls[] = (string)$oSitemapUrl->loc;
-                }
-            }
-        }
-        #print_r($aUrls);
-        return $aUrls;
-    }
-
-    /**
-     * Returens sitemap url
-     *
-     * @return string   sitemap url
-     */
-    protected function _getSitemapUrl()
-    {
-        $sSitemapUrl = Registry::getConfig()->getConfigParam('sShopURL');
-        $sSitemapUrl .= Registry::getConfig()->getShopConfVar('psCacheWarmerSitemapUrl');
-        return $sSitemapUrl;
-    }
-
-    /**
-     * Checks authentification
-     *
-     * @return bool true|false
-     */
-    protected function _checkAuthentification()
-    {
-        $oConfig = Registry::getConfig();
-        $sKey = Registry::getConfig()->getRequestParameter("key");
-        $sSavedKey = $oConfig->getShopConfVar('psCacheWarmerKey', $oConfig->getShopId());
-        if($sSavedKey == $sKey) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Return Path with Filename, from /log
-     *
-     * @return string
-     */
-    protected function _getPathWithFileName()
-    {
-        return Registry::getConfig()->getConfigParam('sShopDir').'/log/'.$this->_getFileName();
-    }
-
-    /**
-     * Return Filename, Formae psCacheWarmerReport_20190717-122345.csv
-     *
-     * @return string
-     */
-    protected function _getFileName()
-    {
-        return 'psCacheWarmerReport_'.date("Ymd-His").".csv";
-    }
-
-}

Application/views/admin/de/pscachewarmer_lang.php

@@ -5,28 +5,26 @@
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
- * @copyright (c) Proud Sourcing GmbH | 2016
- * @link www.proudcommerce.com
- * @package psCacheWarmer
- * @version 1.0.1
+ * @copyright (c) ProudCommerce | 2020
+ * @link          www.proudcommerce.com
+ * @package       psCacheWarmer
+ * @version       3.0.0
  **/
-$sLangName  = "Deutsch";
+
+$sLangName = "Deutsch";
 // -------------------------------
 // RESOURCE IDENTITFIER = STRING
 // -------------------------------
-$aLang = array(
-    'charset'                                           => 'UTF-8',
+$aLang = [
+    'charset' => 'UTF-8',
 
-    'SHOP_MODULE_GROUP_psCacheWarmerConfig'             => 'Einstellungen',
-    'SHOP_MODULE_psCacheWarmerSitemapUrl'               => 'XML-Sitemap URL',
-    'SHOP_MODULE_psCacheWarmerKey'                      => 'Cronjob-Key',
-    'SHOP_MODULE_psCacheWarmerUser'                     => 'Basic-Auth Benutzer',
-    'SHOP_MODULE_psCacheWarmerPass'                     => 'Basic-Auth Kennwort',
-    'SHOP_MODULE_psCacheWarmerWriteCsv'                 => 'Report als CSV-Datei im Log-Ordner abspeichern',
-    'SHOP_MODULE_psCacheWarmerWriteCsvOnlyError'         => 'Alle Ergebnisse ausser HTTP-Code 200 loggen',
+    'SHOP_MODULE_GROUP_psCacheWarmerConfig'      => 'Einstellungen',
+    'SHOP_MODULE_psCacheWarmerSitemapUrl'        => 'XML-Sitemap URL',
+    'SHOP_MODULE_psCacheWarmerKey'               => 'Cronjob-Key',
+    'SHOP_MODULE_psCacheWarmerHttpCodes'         => 'gültige HTTP-Responsecode (OK im LOG-File, sonst ERROR)',
+    'SHOP_MODULE_psCacheWarmerUser'              => 'Basic-Auth Benutzer',
+    'SHOP_MODULE_psCacheWarmerPass'              => 'Basic-Auth Kennwort',
+    'SHOP_MODULE_psCacheWarmerWriteCsv'          => 'LOG-File für gesamten Crawl',
+    'SHOP_MODULE_psCacheWarmerWriteCsvOnlyError' => 'LOG-File nur wenn HTTP-Responsecode != 200',
 
-);
-
-/*
-[{ oxmultilang ident="GENERAL_YOUWANTTODELETE" }]
-*/
+];

Core/CacheWarmer.php

@@ -0,0 +1,152 @@
+<?php
+/**
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @copyright (c) ProudCommerce | 2020
+ * @link          www.proudcommerce.com
+ * @package       psCacheWarmer
+ * @version       3.1.1
+ **/
+
+namespace ProudCommerce\CacheWarmer\Core;
+
+use OxidEsales\Eshop\Core\Registry;
+
+/**
+ * Class CacheWarmer
+ *
+ * @package ProudCommerce\CacheWarmer\Core
+ */
+class CacheWarmer
+{
+    private string $sCliSiteMapFile = '';
+
+    /**
+     *
+     */
+    public function run($sFileSitemap)
+    {
+        $this->sCliSiteMapFile = trim($sFileSitemap);
+
+        $aUrls = $this->_getSitemapContent();
+        if ((!empty(Registry::getConfig()->getShopConfVar('psCacheWarmerSitemapUrl'))
+                || !empty($sFileSitemap))
+            && !empty($aUrls)) {
+            foreach ($aUrls as $sUrl) {
+                $oCurl = $this->_runCurlConnect($sUrl);
+                $this->_checkCurlResults($oCurl, $sUrl);
+                curl_close($oCurl);
+            }
+        }
+    }
+
+    /**
+     * @param $sUrl
+     *
+     * @return false|resource
+     */
+    protected function _runCurlConnect($sUrl)
+    {
+        $oCurl = curl_init();
+        curl_setopt($oCurl, CURLOPT_URL, $sUrl);
+        curl_setopt($oCurl, CURLOPT_RETURNTRANSFER, 1);
+        curl_setopt($oCurl, CURLOPT_CONNECTTIMEOUT, 25);
+        curl_setopt($oCurl, CURLOPT_HEADER, true);
+        curl_setopt($oCurl, CURLOPT_USERAGENT, 'CacheWarmer');
+        $sUsername = Registry::getConfig()->getShopConfVar('psCacheWarmerUser');
+        $sPassword = Registry::getConfig()->getShopConfVar('psCacheWarmerPass');
+        curl_setopt($oCurl, CURLOPT_USERPWD, $sUsername . ":" . $sPassword);
+        curl_exec($oCurl);
+
+        return $oCurl;
+    }
+
+    /**
+     * @param $oCurl
+     * @param $sUrl
+     */
+    protected function _checkCurlResults($oCurl, $sUrl)
+    {
+        $httpStatus = curl_getinfo($oCurl, CURLINFO_HTTP_CODE);
+        if (curl_error($oCurl)) {
+            $sStatusMsg = 'ERROR';
+            $sMessage = curl_error($oCurl);
+        } else {
+            $sMessage = $sUrl;
+            if (in_array(trim($httpStatus), Registry::getConfig()->getShopConfVar('psCacheWarmerHttpCodes'))) {
+                $sStatusMsg = 'OK';
+            } else {
+                $sStatusMsg = 'ERROR';
+            }
+        }
+        $httpStatus = trim($httpStatus);
+        $aLog = [$sStatusMsg, $httpStatus, $sMessage];
+        print_r($aLog);
+
+        if (!empty($aLog) && ((Registry::getConfig()->getShopConfVar('psCacheWarmerWriteCsvOnlyError') == true && $httpStatus != '200') || Registry::getConfig()->getShopConfVar('psCacheWarmerWriteCsv') == true)) {
+            $logger = Logging::getLogger('psCacheWarmer', Registry::getConfig()->getLogsDir() . 'pscachewarmer_' . date("dmY_His") . '.log');
+            $logger->info(implode(' | ', $aLog) . "\r");
+        }
+    }
+
+    /**
+     * @param string $sSitemapUrl
+     *
+     * @return array
+     */
+    protected function _getSitemapContent($sSitemapUrl = "")
+    {
+        $aUrls = [];
+        if (empty($sSitemapUrl) && $this->sCliSiteMapFile == '')
+        {
+            $sSitemapUrl = $this->_getSitemapUrl($sSitemapUrl);
+        }
+        elseif (empty($sSitemapUrl) && $this->sCliSiteMapFile != '')
+        {
+            $sSitemapUrl = $this->_getSitemapUrl($this->sCliSiteMapFile);
+        }
+        $sUsername = Registry::getConfig()->getShopConfVar('psCacheWarmerUser');
+        $sPassword = Registry::getConfig()->getShopConfVar('psCacheWarmerPass');
+        $sSitemapUrl = str_replace("://", "://" . $sUsername . ":" . $sPassword . "@", $sSitemapUrl);
+
+        $sSitemapXmlData = @file_get_contents($sSitemapUrl);
+        if ($oSitemap = @simplexml_load_string($sSitemapXmlData)) {
+            if (count($oSitemap->sitemap) > 0) {
+                foreach ($oSitemap->sitemap as $oSubSitemap) {
+                    $sNextSitemapUrl = (string) $oSubSitemap->loc;
+                    $aUrls = array_merge($aUrls, $this->_getSitemapContent($sNextSitemapUrl));
+                }
+            }
+
+            if (count($oSitemap->url) > 0) {
+                foreach ($oSitemap->url as $oSitemapUrl) {
+                    $aUrls[] = (string) $oSitemapUrl->loc;
+                }
+            }
+        }
+
+        return $aUrls;
+    }
+
+    /**
+     * @return string
+     */
+    protected function _getSitemapUrl($sSitemapFile)
+    {
+        $sSitemapUrl = Registry::getConfig()->getShopURL();
+
+        if($sSitemapFile != '')
+        {
+            $sSitemapUrl .= $sSitemapFile;
+        }
+        else{
+            $sSitemapUrl .= Registry::getConfig()->getShopConfVar('psCacheWarmerSitemapUrl');
+        }
+
+        return $sSitemapUrl;
+    }
+
+}

Core/Logging.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @copyright (c) ProudCommerce | 2020
+ * @link          www.proudcommerce.com
+ * @package       psCacheWarmer
+ * @version       3.1.0
+ **/
+
+namespace ProudCommerce\CacheWarmer\Core;
+
+use \OxidEsales\Eshop\Core\Registry;
+use \Monolog\Logger;
+use \Monolog\Handler\StreamHandler;
+
+/**
+ * Class Logging
+ *
+ * @package ProudCommerce\CacheWarmer\Core
+ */
+class Logging
+{
+
+    /**
+     * @var array
+     */
+    protected static $_aLogger = [];
+
+
+    /**
+     * @param string $sLogger
+     * @param string $sPath
+     * @param string $sLogLevel
+     *
+     * @return mixed
+     * @throws \Exception
+     */
+    public static function getLogger(string $sLogger = '', string $sPath = '', string $sLogLevel = ''): Logger
+    {
+        $sLogger = (!empty($sLogger) ? $sLogger : 'OXID Logger');
+        if (!array_key_exists($sLogger, self::$_aLogger)) {
+            $sPath = ((!empty($sPath)) ? $sPath : Registry::getConfig()->getLogsDir() . 'oxideshop.log');
+            $sLogLevel = strtoupper($sLogLevel);
+            $sLogLevel = ((!empty($sLogLevel) && defined("Logger::$sLogLevel")) ? constant("Logger::$sLogLevel") : Logger::DEBUG);
+            self::$_aLogger[ $sLogger ] = new Logger($sLogger);
+            self::$_aLogger[ $sLogger ]->pushHandler(
+                new StreamHandler(
+                    $sPath,
+                    $sLogLevel
+                )
+            );
+        }
+
+        return self::$_aLogger[ $sLogger ];
+    }
+}

README.md

@@ -6,23 +6,35 @@ Free module for OXID eshop 6.
 
 Features
 
-	- admin setting sitemap url
-	- admin setting security key (cronjob)
-	- admin setting basic auth user/password
+	- set sitemap url in admin / or cli parameter
+	- optional basic auth user/password
+	- optional csv logfile
 
 Installation
 
-	1. composer config repo.ProudCommerce/CacheWarmer git https://github.com/Josef-A-Puckl/psCacheWarmer/
-	2. composer require proudcommerce/cachewarmer
+	composer require proudcommerce/cachewarmer
 
+Usage
+
+	php source/modules/pc/cachewarmer/bin/warmup.php [optional parameter s for shop-id, eg. warmup.php -s 2 -f sitemaps/categories.xml]
+
+Parameters:
+
+    -s: ShopId: -s 2
+    -f: Path to separte Sitemap: -f sitemaps/categories.xml
 	
 Changelog
 
-	2019-07-19	2.2.0	Write Report in a file (PR #3)
-	2019-07-17	2.1.0	add error 500 check (PR #2)
-	2019-06-26	2.0.0	OXID eShop 6 (PR #1)
-	2016-10-12	1.0.1	fix reading sitemap url with user/pass,fix checking sitemap object
-	2016-08-25	1.0.0	module release for oxid 4.7, 4.8, 4.9, 4.10
+    2021-03-17  3.1.2   add new new parameter -f for separate File
+    2020-09-15  3.1.1   readd ee shopurl fix (missing 3.0.1)
+	2020-09-14  3.1.0   add own logger
+    2020-08-17  3.0.0   cli only, some improvements
+	2020-08-06  2.2.1   fix for OXID 6.2
+	2019-07-19  2.2.0   Write Report in a file (PR #3)
+	2019-07-17  2.1.0   add error 500 check (PR #2)
+	2019-06-26  2.0.0   OXID eShop 6 (PR #1)
+	2016-10-12  1.0.1   fix reading sitemap url with user/pass,fix checking sitemap object
+	2016-08-25  1.0.0   module release for oxid 4.7, 4.8, 4.9, 4.10
 
 License
 
@@ -42,5 +54,4 @@ License
 
 Copyright
 
-	Proud Sourcing GmbH 2016
-	www.proudcommerce.com / www.proudsourcing.de
+	ProudCommerce { www.proudcommerce.com }

bin/warmup.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @copyright (c) ProudCommerce | 2020
+ * @link www.proudcommerce.com
+ * @package psCacheWarmer
+ * @version 3.0.0
+ **/
+
+if (PHP_SAPI != 'cli') {
+    die('Only cli execution allowed!'."\r\n");
+}
+
+$options = getopt('s:f:');
+$shopId = $options['s'] ?? 0;
+if (!$shopId) {
+    $shopId = 1;
+}
+
+$sFileSiteMap = $options['f'] ?? '';
+if (!$sFileSiteMap) {
+    $sFileSitemap = '';
+}
+require_once dirname(__FILE__) . '/../../../../bootstrap.php';
+
+use OxidEsales\Eshop\Core\Registry;
+use ProudCommerce\CacheWarmer\Core\CacheWarmer;
+
+echo 'Shop-ID '.$shopId." is used!\r\n";
+if($sFileSiteMap != '') {
+    echo 'Sitemap: ' . $sFileSiteMap . " is used!\r\n";
+}
+Registry::getConfig()->setShopId($shopId);
+Registry::set(Config::class, null);
+
+
+$cacheWarmer = new CacheWarmer();
+$cacheWarmer->run($sFileSiteMap);

composer.json

@@ -1,33 +1,32 @@
 {
-  "name": "proudcommerce/cachewarmer",
-  "version": "2.2.0",
-  "description": "psCacheWarmer",
-  "type": "oxideshop-module",
-  "license": [
-    "proprietary"
-  ],
-  "authors": [
-    {
-      "name": "ProudCommerce",
-      "homepage": "https://www.proudcommerce.com/",
-      "email": "welcome@proudcommerce.com",
-      "role": "Developer"
+    "name": "proudcommerce/cachewarmer",
+    "description": "Website anhand der XML-Sitemap automatisch aufrufen, z. B. zum 'Aufwärmen' eines Caches.",
+    "type": "oxideshop-module",
+    "license": [
+        "GPL-3.0-or-later"
+    ],
+    "authors": [
+        {
+            "name": "ProudCommerce",
+            "homepage": "https://www.proudcommerce.com/",
+            "email": "welcome@proudcommerce.com",
+            "role": "Developer"
+        }
+    ],
+    "support": {
+        "email": "support@proudcommerce.com"
+    },
+    "require": {
+        "php": ">= 7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "ProudCommerce\\CacheWarmer\\": "../../../source/modules/pc/cachewarmer"
+        }
+    },
+    "extra": {
+        "oxideshop": {
+            "target-directory": "pc/cachewarmer"
+        }
     }
-  ],
-  "support": {
-    "email": "support@proudcommerce.com"
-  },
-  "require": {
-    "php": ">= 7.0"
-  },
-  "autoload": {
-    "psr-4": {
-      "ProudCommerce\\CacheWarmer\\": "../../../source/modules/proudsourcing/psCacheWarmer"
-    }
-  },
-  "extra": {
-    "oxideshop": {
-      "target-directory": "proudsourcing/psCacheWarmer"
-    }
-  }
 }

metadata.php

@@ -5,11 +5,11 @@
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
- * @copyright (c) Proud Sourcing GmbH | 2016
- * @link www.proudcommerce.com
- * @package psCacheWarmer
- * @version 1.0.1
-**/
+ * @copyright (c) ProudCommerce | 2020
+ * @link          www.proudcommerce.com
+ * @package       psCacheWarmer
+ * @version       3.1.1
+ **/
 
 /**
  * Metadata version
@@ -19,65 +19,68 @@ $sMetadataVersion = '2.0';
 /**
  * Module information
  */
-$aModule = array(
-    'id'           => 'psCacheWarmer',
-    'title'        => 'psCacheWarmer',
-    'description'  => array(
-        'de' => 'Website anhand der XML-Sitemap automatisch aufrufen, z. B. zum "Aufwärmen" eines Caches.<br>
-                <b>URL:</b> <a href="'.oxRegistry::getConfig()->getConfigParam('sShopURL').'?cl=psCacheWarmer&key='.oxRegistry::getConfig()->getShopConfVar('psCacheWarmerKey', oxRegistry::getConfig()->getShopId()).'" target="_blank">'.oxRegistry::getConfig()->getConfigParam('sShopURL').'?cl=psCacheWarmer&key='.oxRegistry::getConfig()->getShopConfVar('psCacheWarmerKey', oxRegistry::getConfig()->getShopId()).'</a>',
-        'en' => 'Automatically calling urls using the xml-sitemap, eg. for cache warming.
-                <b>URL:</b> <a href="'.oxRegistry::getConfig()->getConfigParam('sShopURL').'?cl=psCacheWarmer&key='.oxRegistry::getConfig()->getShopConfVar('psCacheWarmerKey', oxRegistry::getConfig()->getShopId()).'" target="_blank">'.oxRegistry::getConfig()->getConfigParam('sShopURL').'?cl=psCacheWarmer&key='.oxRegistry::getConfig()->getShopConfVar('psCacheWarmerKey', oxRegistry::getConfig()->getShopId()).'</a>',
-    ),
-    'thumbnail'    => 'logo_pc-os.jpg',
-    'version'      => '2.2.0',
-    'author'       => 'Proud Sourcing GmbH',
-    'url'          => 'http://www.proudcommerce.com/',
-    'email'        => 'support@proudcommerce.com',
-    'extend'       => array(
-    ),
-    'controllers' => array(
-        'pscachewarmer' => \ProudCommerce\CacheWarmer\Application\Controller\CacheWarmer::class,
-    ),
-    'templates' => array(
-    ),
-    'blocks' => array(
-    ),
-    'settings' => array(
-        array(
+$aModule = [
+    'id'          => 'psCacheWarmer',
+    'title'       => 'psCacheWarmer',
+    'description' => [
+        'de' => 'Website anhand der XML-Sitemap automatisch aufrufen, z. B. zum "Aufwärmen" eines Caches.',
+        'en' => 'Automatically calling urls using the xml-sitemap, eg. for cache warmup.',
+    ],
+    'thumbnail'   => 'logo_pc-os.jpg',
+    'version'     => '3.1.2',
+    'author'      => 'ProudCommerce',
+    'url'         => 'https://github.com/proudcommerce/psCacheWarmer',
+    'email'       => '',
+    'extend'      => [
+    ],
+    'controllers' => [
+    ],
+    'templates'   => [
+    ],
+    'blocks'      => [
+    ],
+    'settings'    => [
+        [
             'group' => 'psCacheWarmerConfig',
             'name'  => 'psCacheWarmerSitemapUrl',
             'type'  => 'str',
             'value' => 'sitemap.xml',
-        ),
-        array(
+        ],
+        [
             'group' => 'psCacheWarmerConfig',
             'name'  => 'psCacheWarmerKey',
             'type'  => 'str',
             'value' => md5(time()),
-        ),
-        array(
+        ],
+        [
             'group' => 'psCacheWarmerConfig',
             'name'  => 'psCacheWarmerUser',
             'type'  => 'str',
             'value' => '',
-        ),
-        array(
+        ],
+        [
             'group' => 'psCacheWarmerConfig',
             'name'  => 'psCacheWarmerPass',
             'type'  => 'str',
             'value' => '',
-        ),
-        array(
+        ],
+        [
+            'group' => 'psCacheWarmerConfig',
+            'name'  => 'psCacheWarmerHttpCodes',
+            'type'  => 'arr',
+            'value' => [200, 302],
+        ],
+        [
             'group' => 'psCacheWarmerConfig',
             'name'  => 'psCacheWarmerWriteCsv',
             'type'  => 'bool',
-            'value' => '',
-        ),
-        array(
+            'value' => false,
+        ],
+        [
             'group' => 'psCacheWarmerConfig',
             'name'  => 'psCacheWarmerWriteCsvOnlyError',
             'type'  => 'bool',
-            'value' => '',
-        ),
-    ),
-);
+            'value' => true,
+        ]
+    ],
+];

views/admin/de/pscachewarmer_lang.php

@@ -1,30 +0,0 @@
-<?php
-/**
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * @copyright (c) Proud Sourcing GmbH | 2016
- * @link www.proudcommerce.com
- * @package psCacheWarmer
- * @version 1.0.1
- **/
-$sLangName  = "Deutsch";
-// -------------------------------
-// RESOURCE IDENTITFIER = STRING
-// -------------------------------
-$aLang = array(
-    'charset'                                           => 'UTF-8',
-
-    'SHOP_MODULE_GROUP_psCacheWarmerConfig'             => 'Einstellungen',
-    'SHOP_MODULE_psCacheWarmerSitemapUrl'               => 'XML-Sitemap URL',
-    'SHOP_MODULE_psCacheWarmerKey'                      => 'Cronjob-Key',
-    'SHOP_MODULE_psCacheWarmerUser'                     => 'Basic-Auth Benutzer',
-    'SHOP_MODULE_psCacheWarmerPass'                     => 'Basic-Auth Kennwort',
-
-);
-
-/*
-[{ oxmultilang ident="GENERAL_YOUWANTTODELETE" }]
-*/