add piwik installation

www/analytics/core/ArchiveProcessor/PluginsArchiver.php

@@ -0,0 +1,197 @@
+<?php
+/**
+ * Piwik - Open source web analytics
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+
+namespace Piwik\ArchiveProcessor;
+
+use Piwik\Archive;
+use Piwik\ArchiveProcessor;
+use Piwik\DataAccess\ArchiveSelector;
+use Piwik\DataAccess\ArchiveWriter;
+use Piwik\DataTable\Manager;
+use Piwik\Metrics;
+use Piwik\Plugin\Archiver;
+
+/**
+ * This class creates the Archiver objects found in plugins and will trigger aggregation,
+ * so each plugin can process their reports.
+ */
+class PluginsArchiver
+{
+    /**
+     * @param ArchiveProcessor $archiveProcessor
+     */
+    public $archiveProcessor;
+
+    /**
+     * @var Parameters
+     */
+    protected $params;
+
+    /**
+     * @var Archiver[] $archivers
+     */
+    private static $archivers = array();
+
+    public function __construct(Parameters $params, $isTemporaryArchive)
+    {
+        $this->params = $params;
+
+        $this->archiveWriter = new ArchiveWriter($this->params, $isTemporaryArchive);
+        $this->archiveWriter->initNewArchive();
+
+        $this->archiveProcessor = new ArchiveProcessor($this->params, $this->archiveWriter);
+
+        $this->isSingleSiteDayArchive = $this->params->isSingleSiteDayArchive();
+    }
+
+    /**
+     * If period is day, will get the core metrics (including visits) from the logs.
+     * If period is != day, will sum the core metrics from the existing archives.
+     * @return array Core metrics
+     */
+    public function callAggregateCoreMetrics()
+    {
+        if($this->isSingleSiteDayArchive) {
+            $metrics = $this->aggregateDayVisitsMetrics();
+        } else {
+            $metrics = $this->aggregateMultipleVisitsMetrics();
+        }
+
+        if (empty($metrics)) {
+            return array(
+                'nb_visits' => false,
+                'nb_visits_converted' => false
+            );
+        }
+        return array(
+            'nb_visits' => $metrics['nb_visits'],
+            'nb_visits_converted' => $metrics['nb_visits_converted']
+        );
+    }
+
+    /**
+     * Instantiates the Archiver class in each plugin that defines it,
+     * and triggers Aggregation processing on these plugins.
+     */
+    public function callAggregateAllPlugins($visits, $visitsConverted)
+    {
+        $this->archiveProcessor->setNumberOfVisits($visits, $visitsConverted);
+
+        $archivers = $this->getPluginArchivers();
+
+        foreach($archivers as $pluginName => $archiverClass) {
+
+            // We clean up below all tables created during this function call (and recursive calls)
+            $latestUsedTableId = Manager::getInstance()->getMostRecentTableId();
+
+            /** @var Archiver $archiver */
+            $archiver = new $archiverClass($this->archiveProcessor);
+
+            if(!$archiver->isEnabled()) {
+                continue;
+            }
+            if($this->shouldProcessReportsForPlugin($pluginName)) {
+                if($this->isSingleSiteDayArchive) {
+                    $archiver->aggregateDayReport();
+                } else {
+                    $archiver->aggregateMultipleReports();
+                }
+            }
+
+            Manager::getInstance()->deleteAll($latestUsedTableId);
+            unset($archiver);
+        }
+    }
+
+    public function finalizeArchive()
+    {
+        $this->params->logStatusDebug( $this->archiveWriter->isArchiveTemporary );
+        $this->archiveWriter->finalizeArchive();
+        return $this->archiveWriter->getIdArchive();
+    }
+
+    /**
+     * Loads Archiver class from any plugin that defines one.
+     *
+     * @return \Piwik\Plugin\Archiver[]
+     */
+    protected function getPluginArchivers()
+    {
+        if (empty(static::$archivers)) {
+            $pluginNames = \Piwik\Plugin\Manager::getInstance()->getActivatedPlugins();
+            $archivers = array();
+            foreach ($pluginNames as $pluginName) {
+                $archivers[$pluginName] = self::getPluginArchiverClass($pluginName);
+            }
+            static::$archivers = array_filter($archivers);
+        }
+        return static::$archivers;
+    }
+
+    private static function getPluginArchiverClass($pluginName)
+    {
+        $klassName = 'Piwik\\Plugins\\' . $pluginName . '\\Archiver';
+        if (class_exists($klassName)
+            && is_subclass_of($klassName, 'Piwik\\Plugin\\Archiver')) {
+            return $klassName;
+        }
+        return false;
+    }
+
+    /**
+     * Whether the specified plugin's reports should be archived
+     * @param string $pluginName
+     * @return bool
+     */
+    protected function shouldProcessReportsForPlugin($pluginName)
+    {
+        if ($this->params->getRequestedPlugin() == $pluginName) {
+            return true;
+        }
+        if (Rules::shouldProcessReportsAllPlugins(
+                            $this->params->getIdSites(),
+                            $this->params->getSegment(),
+                            $this->params->getPeriod()->getLabel())) {
+            return true;
+        }
+
+        if (!\Piwik\Plugin\Manager::getInstance()->isPluginLoaded($this->params->getRequestedPlugin())) {
+            return true;
+        }
+        return false;
+    }
+
+    protected function aggregateDayVisitsMetrics()
+    {
+        $query = $this->archiveProcessor->getLogAggregator()->queryVisitsByDimension();
+        $data = $query->fetch();
+
+        $metrics = $this->convertMetricsIdToName($data);
+        $this->archiveProcessor->insertNumericRecords($metrics);
+        return $metrics;
+    }
+
+    protected function convertMetricsIdToName($data)
+    {
+        $metrics = array();
+        foreach ($data as $metricId => $value) {
+            $readableMetric = Metrics::$mappingFromIdToName[$metricId];
+            $metrics[$readableMetric] = $value;
+        }
+        return $metrics;
+    }
+
+    protected function aggregateMultipleVisitsMetrics()
+    {
+        $toSum = Metrics::getVisitsMetricNames();
+        $metrics = $this->archiveProcessor->aggregateNumericMetrics($toSum);
+        return $metrics;
+    }
+
+}