log usage statistics

coreshop · Aug 9, 2016 · d40aed3 · d40aed3
1 parent a22b602
commit d40aed3
Show file tree

Hide file tree

Showing 36 changed files with 188 additions and 67 deletions.
diff --git a/controllers/Admin/CarrierController.php b/controllers/Admin/CarrierController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Carrier;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_CarrierController

diff --git a/controllers/Admin/CarrierShippingRuleController.php b/controllers/Admin/CarrierShippingRuleController.php
@@ -12,7 +12,7 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use Pimcore\Tool as PimTool;
 
 /**

diff --git a/controllers/Admin/CountryController.php b/controllers/Admin/CountryController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Country;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_CountryController

diff --git a/controllers/Admin/CurrencyController.php b/controllers/Admin/CurrencyController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Currency;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_CurrencyController

diff --git a/controllers/Admin/CustomerGroupController.php b/controllers/Admin/CustomerGroupController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\CustomerGroup;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_CustomerGroupController

diff --git a/controllers/Admin/FilterController.php b/controllers/Admin/FilterController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Product\Filter;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_FilterController

diff --git a/controllers/Admin/HelperController.php b/controllers/Admin/HelperController.php
@@ -12,7 +12,7 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_HelperController

diff --git a/controllers/Admin/IndexesController.php b/controllers/Admin/IndexesController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Index;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use Pimcore\Model\Object;
 
 /**

diff --git a/controllers/Admin/InstallController.php b/controllers/Admin/InstallController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Plugin;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_InstallController

diff --git a/controllers/Admin/ManufacturerController.php b/controllers/Admin/ManufacturerController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Manufacturer;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_ManufacturerController

diff --git a/controllers/Admin/MessagingContactController.php b/controllers/Admin/MessagingContactController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Messaging\Contact;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_MessagingContactController

diff --git a/controllers/Admin/MessagingThreadController.php b/controllers/Admin/MessagingThreadController.php
@@ -12,7 +12,7 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_MessagingThreadController

diff --git a/controllers/Admin/MessagingThreadStateController.php b/controllers/Admin/MessagingThreadStateController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Messaging\Thread\State;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_MessagingThreadStateController

diff --git a/controllers/Admin/ObjectController.php b/controllers/Admin/ObjectController.php
@@ -12,7 +12,7 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_ObjectController

diff --git a/controllers/Admin/OrderController.php b/controllers/Admin/OrderController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Plugin;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use Pimcore\Model\Object;
 
 /**

diff --git a/controllers/Admin/OrderStateController.php b/controllers/Admin/OrderStateController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Order\State;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_OrderStateController

diff --git a/controllers/Admin/PriceRuleController.php b/controllers/Admin/PriceRuleController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Cart\PriceRule;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use Pimcore\Tool as PimTool;
 
 /**

diff --git a/controllers/Admin/ProductController.php b/controllers/Admin/ProductController.php
@@ -12,7 +12,7 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use Pimcore\Tool as PimTool;
 
 /**

diff --git a/controllers/Admin/ProductPriceRuleController.php b/controllers/Admin/ProductPriceRuleController.php
@@ -12,7 +12,7 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use Pimcore\Tool as PimTool;
 
 /**

diff --git a/controllers/Admin/ProductSpecificPriceController.php b/controllers/Admin/ProductSpecificPriceController.php
@@ -12,7 +12,7 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use Pimcore\Tool as PimTool;
 
 /**

diff --git a/controllers/Admin/ReportsController.php b/controllers/Admin/ReportsController.php
@@ -14,7 +14,7 @@
 
 use CoreShop\Tool;
 use CoreShop\Model;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 use CoreShop\Helper\ReportQuery;
 
 /**

diff --git a/controllers/Admin/SettingsController.php b/controllers/Admin/SettingsController.php
@@ -12,9 +12,8 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
-use CoreShop\Plugin;
 use CoreShop\Model;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_SettingsController

diff --git a/controllers/Admin/ShopController.php b/controllers/Admin/ShopController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Shop;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_ShopController

diff --git a/controllers/Admin/StateController.php b/controllers/Admin/StateController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\State;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_StateController

diff --git a/controllers/Admin/TaxController.php b/controllers/Admin/TaxController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Tax;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_TaxController

diff --git a/controllers/Admin/TaxRuleGroupController.php b/controllers/Admin/TaxRuleGroupController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\TaxRuleGroup;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_TaxRuleGroupController

diff --git a/controllers/Admin/TrackingController.php b/controllers/Admin/TrackingController.php
diff --git a/controllers/Admin/UpdateController.php b/controllers/Admin/UpdateController.php
@@ -12,10 +12,12 @@
  * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
  */
 
+use CoreShop\Controller\Action\Admin;
+
 /**
  * Class CoreShop_Admin_UpdateController+
  */
-class CoreShop_Admin_UpdateController extends \Pimcore\Controller\Action\Admin
+class CoreShop_Admin_UpdateController extends Admin
 {
     public function init()
     {

diff --git a/controllers/Admin/ZoneController.php b/controllers/Admin/ZoneController.php
@@ -13,7 +13,7 @@
  */
 
 use CoreShop\Model\Zone;
-use Pimcore\Controller\Action\Admin;
+use CoreShop\Controller\Action\Admin;
 
 /**
  * Class CoreShop_Admin_ZoneController

diff --git a/lib/CoreShop/Controller/Action/Admin.php b/lib/CoreShop/Controller/Action/Admin.php
@@ -20,4 +20,43 @@
  */
 class Admin extends \Pimcore\Controller\Action\Admin
 {
+    public function init()
+    {
+        parent::init();
+
+        $this->logCoreShopUsageStatistics();
+    }
+
+    /**
+     * @throws \Zend_Json_Exception
+     */
+    protected function logCoreShopUsageStatistics()
+    {
+        $params = [];
+        $disallowedKeys = ["_dc", "module", "controller", "action", "password"];
+        foreach ($this->getAllParams() as $key => $value) {
+            if (is_json($value)) {
+                $value = \Zend_Json::decode($value);
+                if (is_array($value)) {
+                    array_walk_recursive($value, function (&$item, $key) {
+                        if (strpos($key, "pass") !== false) {
+                            $item = "*************";
+                        }
+                    });
+                }
+                $value = \Zend_Json::encode($value);
+            }
+
+
+            if (!in_array($key, $disallowedKeys) && is_string($value)) {
+                $params[$key] = (strlen($value) > 40) ? substr($value, 0, 40) . "..." : $value;
+            }
+        }
+
+        \Pimcore\Log\Simple::log("coreshop-usagelog",
+            ($this->getUser() ? $this->getUser()->getId() : "0") . "|" .
+            $this->getParam("module") . "|" .
+            $this->getParam("controller") . "|" .
+            $this->getParam("action")."|" . @json_encode($params));
+    }
 }
diff --git a/lib/CoreShop/Maintenance/Log.php b/lib/CoreShop/Maintenance/Log.php
@@ -0,0 +1,42 @@
+<?php
+/**
+ * CoreShop.
+ *
+ * LICENSE
+ *
+ * This source file is subject to the GNU General Public License version 3 (GPLv3)
+ * For the full copyright and license information, please view the LICENSE.md and gpl-3.0.txt
+ * files that are distributed with this source code.
+ *
+ * @copyright  Copyright (c) 2015-2016 Dominik Pfaffenbauer (http://www.pfaffenbauer.at)
+ * @license    http://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
+ */
+
+namespace CoreShop\Maintenance;
+
+use Pimcore\Tool;
+
+/**
+ * Class Log
+ * @package CoreShop\Maintenance
+ */
+class Log {
+    /**
+     *
+     */
+    public static function maintenance()
+    {
+        $logFile = PIMCORE_LOG_DIRECTORY . "/coreshop-usagelog.log";
+
+        if (is_file($logFile) && filesize($logFile) > 200000) {
+            $data = gzencode(file_get_contents($logFile));
+            $response = Tool::getHttpData("https://www.coreshop.org/usage-statistics/", [], ["data" => $data, "hostname" => Tool::getHostname()]);
+            if (strpos($response, "true") !== false) {
+                @unlink($logFile);
+                \Logger::debug("Usage statistics are transmitted and logfile was cleaned");
+            } else {
+                \Logger::debug("Unable to send usage statistics");
+            }
+        }
+    }
+}
diff --git a/lib/CoreShop/Model/Configuration.php b/lib/CoreShop/Model/Configuration.php
@@ -35,7 +35,9 @@ class Configuration extends AbstractModel
      */
     protected static $systemKeys = [
         'SYSTEM.ISINSTALLED',
-        'SYSTEM.MULTISHOP.ENABLED'
+        'SYSTEM.MULTISHOP.ENABLED',
+        'SYSTEM.LOG.USAGESTATISTICS',
+        'SYSTEM.CURRENCY.AUTO_EXCHANGE_RATES'
     ];
 
     /**

diff --git a/lib/CoreShop/Plugin.php b/lib/CoreShop/Plugin.php
@@ -101,6 +101,9 @@ public function init()
                 if (Configuration::get('SYSTEM.CART.AUTO_CLEANUP')) {
                     $manager->registerJob(new Job('coreshop_cart_cleanup', '\\CoreShop\\Model\\Cart', 'maintenance'));
                 }
+                if (Configuration::get('SYSTEM.LOG.USAGESTATISTICS')) {
+                    $manager->registerJob(new Job('coreshop_send_usage_statistcs', '\\CoreShop\\Maintenance\\Log', 'maintenance'));
+                }
             }
         });
 

diff --git a/lib/CoreShop/Plugin/Install.php b/lib/CoreShop/Plugin/Install.php
@@ -730,6 +730,7 @@ public function createConfig()
         Configuration::set("SYSTEM.BASE.PRICES.GROSS", false);
         Configuration::set("SYSTEM.SHIPPING.CARRIER_SORT", "grade");
         Configuration::set("SYSTEM.BASE.TAX.ENABLED", true);
+        Configuration::set("SYSTEM.LOG.USAGESTATISTICS", true);
     }
 
     /**