Server : LiteSpeed System : Linux premium84.web-hosting.com 4.18.0-553.44.1.lve.el8.x86_64 #1 SMP Thu Mar 13 14:29:12 UTC 2025 x86_64 User : claqxcrl ( 523) PHP Version : 8.1.32 Disable Function : NONE Directory : /home/claqxcrl/anfangola.com/wp-content/plugins/matomo/app/core/Plugin/ |
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugin;
use Piwik\ArchiveProcessor;
use Piwik\Cache;
use Piwik\CacheId;
use Piwik\Config as PiwikConfig;
use Piwik\Container\StaticContainer;
use Piwik\ErrorHandler;
use Piwik\Piwik;
/**
* The base class that should be extended by plugins that compute their own
* analytics data.
*
* Descendants should implement the {@link aggregateDayReport()} and {@link aggregateMultipleReports()}
* methods.
*
* Both of these methods should persist analytics data using the {@link \Piwik\ArchiveProcessor}
* instance returned by {@link getProcessor()}. The {@link aggregateDayReport()} method should
* compute analytics data using the {@link \Piwik\DataAccess\LogAggregator} instance
* returned by {@link getLogAggregator()}.
*
* ### Examples
*
* **Extending Archiver**
*
* class MyArchiver extends Archiver
* {
* public function aggregateDayReport()
* {
* $logAggregator = $this->getLogAggregator();
*
* $data = $logAggregator->queryVisitsByDimension(...);
*
* $dataTable = new DataTable();
* $dataTable->addRowsFromSimpleArray($data);
*
* $archiveProcessor = $this->getProcessor();
* $archiveProcessor->insertBlobRecords('MyPlugin_myReport', $dataTable->getSerialized(500));
* }
*
* public function aggregateMultipleReports()
* {
* $archiveProcessor = $this->getProcessor();
* $archiveProcessor->aggregateDataTableRecords('MyPlugin_myReport', 500);
* }
* }
*
* @api
*/
class Archiver
{
public static $ARCHIVE_DEPENDENT = true;
/**
* @var \Piwik\ArchiveProcessor
*/
private $processor;
/**
* @var bool
*/
private $enabled;
/**
* @var mixed
*/
protected $maximumRows;
/**
* Used if a plugin has RecordBuilders but no Archiver subclass.
*
* @var string|null
*/
private $pluginName = null;
/**
* Constructor.
*
* @param ArchiveProcessor $processor The ArchiveProcessor instance to use when persisting archive
* data.
*/
public function __construct(ArchiveProcessor $processor, ?string $pluginName = null)
{
$this->maximumRows = PiwikConfig::getInstance()->General['datatable_archiving_maximum_rows_standard'];
$this->processor = $processor;
$this->enabled = true;
$this->pluginName = $pluginName;
}
private function getPluginName() : string
{
return $this->pluginName ?: Piwik::getPluginNameOfMatomoClass(get_class($this));
}
/**
* @return ArchiveProcessor\RecordBuilder[]
* @throws \DI\DependencyException
* @throws \DI\NotFoundException
*/
private function getRecordBuilders(string $pluginName) : array
{
$transientCache = Cache::getTransientCache();
$cacheKey = CacheId::siteAware('Archiver.RecordBuilders') . '.' . $pluginName;
$recordBuilders = $transientCache->fetch($cacheKey);
if ($recordBuilders === false) {
$recordBuilderClasses = $this->getAllRecordBuilderClasses();
// only select RecordBuilders for the selected plugin
$recordBuilderClasses = array_filter($recordBuilderClasses, function ($className) use($pluginName) {
return Piwik::getPluginNameOfMatomoClass($className) == $pluginName;
});
$recordBuilders = array_map(function ($className) {
return StaticContainer::getContainer()->make($className);
}, $recordBuilderClasses);
/**
* Triggered to add new RecordBuilders that cannot be picked up automatically by the platform.
* If you define RecordBuilders that take a parameter, for example, an ID to an entity your plugin
* manages, use this event to add instances of that RecordBuilder to the global list.
*
* **Example**
*
* public function addRecordBuilders(&$recordBuilders)
* {
* $recordBuilders[] = new MyParameterizedRecordBuilder($idOfThingToArchiveFor);
* }
*
* @param ArchiveProcessor\RecordBuilder[] $recordBuilders An array of RecordBuilder instances
* @api
*/
Piwik::postEvent('Archiver.addRecordBuilders', [&$recordBuilders], false, [$pluginName]);
$transientCache->save($cacheKey, $recordBuilders);
}
/**
* Triggered to filter / restrict reports.
*
* **Example**
*
* public function filterRecordBuilders(&$recordBuilders)
* {
* foreach ($reports as $index => $recordBuilder) {
* if ($recordBuilders instanceof AnotherPluginRecordBuilder) {
* unset($reports[$index]);
* }
* }
* }
*
* @param ArchiveProcessor\RecordBuilder[] $recordBuilders An array of RecordBuilder instances
* @api
*/
Piwik::postEvent('Archiver.filterRecordBuilders', [&$recordBuilders]);
$requestedReports = $this->processor->getParams()->getArchiveOnlyReportAsArray();
if (!empty($requestedReports)) {
$recordBuilders = array_filter($recordBuilders, function (ArchiveProcessor\RecordBuilder $builder) use($requestedReports) {
return $builder->isBuilderForAtLeastOneOf($this->processor, $requestedReports);
});
}
return $recordBuilders;
}
/**
* @ignore
*/
public final function callAggregateDayReport()
{
try {
ErrorHandler::pushFatalErrorBreadcrumb(static::class);
$pluginName = $this->getPluginName();
if (\Piwik\Plugin\Manager::getInstance()->isPluginLoaded($pluginName)) {
$recordBuilders = $this->getRecordBuilders($pluginName);
foreach ($recordBuilders as $recordBuilder) {
if (!$recordBuilder->isEnabled($this->getProcessor())) {
continue;
}
// if automatically handling "archive only report" in RecordBuilders, make sure the archive
// will be marked as partial
if ($this->processor->getParams()->getArchiveOnlyReport()) {
$this->processor->getParams()->setIsPartialArchive(true);
// make sure archive will be marked as partial
}
$originalQueryHint = $this->getProcessor()->getLogAggregator()->getQueryOriginHint();
$newQueryHint = $originalQueryHint . ' ' . $recordBuilder->getQueryOriginHint();
try {
$this->getProcessor()->getLogAggregator()->setQueryOriginHint($newQueryHint);
$recordBuilder->buildFromLogs($this->getProcessor());
} finally {
$this->getProcessor()->getLogAggregator()->setQueryOriginHint($originalQueryHint);
}
}
}
$this->aggregateDayReport();
$this->processDependentArchivesForPlugins();
} finally {
ErrorHandler::popFatalErrorBreadcrumb();
}
}
/**
* @ignore
*/
public final function callAggregateMultipleReports()
{
try {
ErrorHandler::pushFatalErrorBreadcrumb(static::class);
$pluginName = $this->getPluginName();
if (\Piwik\Plugin\Manager::getInstance()->isPluginLoaded($pluginName)) {
$recordBuilders = $this->getRecordBuilders($pluginName);
foreach ($recordBuilders as $recordBuilder) {
if (!$recordBuilder->isEnabled($this->getProcessor())) {
continue;
}
// if automatically handling "archive only report" in RecordBuilders, make sure the archive
// will be marked as partial
if ($this->processor->getParams()->getArchiveOnlyReport()) {
$this->processor->getParams()->setIsPartialArchive(true);
// make sure archive will be marked as partial
}
$originalQueryHint = $this->getProcessor()->getLogAggregator()->getQueryOriginHint();
$newQueryHint = $originalQueryHint . ' ' . $recordBuilder->getQueryOriginHint();
try {
$this->getProcessor()->getLogAggregator()->setQueryOriginHint($newQueryHint);
$recordBuilder->buildForNonDayPeriod($this->getProcessor());
} finally {
$this->getProcessor()->getLogAggregator()->setQueryOriginHint($originalQueryHint);
}
}
}
$this->aggregateMultipleReports();
$this->processDependentArchivesForPlugins();
} finally {
ErrorHandler::popFatalErrorBreadcrumb();
}
}
/**
* Archives data for a day period.
*
* Implementations of this method should do more computation intensive activities such
* as aggregating data across log tables. Since this method only deals w/ data logged for a day,
* aggregating individual log table rows isn't a problem. Doing this for any larger period,
* however, would cause performance degradation.
*
* Aggregate log table rows using a {@link Piwik\DataAccess\LogAggregator} instance. Get a
* {@link Piwik\DataAccess\LogAggregator} instance using the {@link getLogAggregator()} method.
*/
public function aggregateDayReport()
{
// empty
}
/**
* Archives data for a non-day period.
*
* Implementations of this method should only aggregate existing reports of subperiods of the
* current period. For example, it is more efficient to aggregate reports for each day of a
* week than to aggregate each log entry of the week.
*
* Use {@link Piwik\ArchiveProcessor::aggregateNumericMetrics()} and {@link Piwik\ArchiveProcessor::aggregateDataTableRecords()}
* to aggregate archived reports. Get the {@link Piwik\ArchiveProcessor} instance using the {@link getProcessor()}
* method.
*/
public function aggregateMultipleReports()
{
// empty
}
/**
* Returns a {@link Piwik\ArchiveProcessor} instance that can be used to insert archive data for
* the period, segment and site we are archiving data for.
*
* @return \Piwik\ArchiveProcessor
* @api
*/
protected function getProcessor()
{
return $this->processor;
}
/**
* Returns a {@link Piwik\DataAccess\LogAggregator} instance that can be used to aggregate log table rows
* for this period, segment and site.
*
* @return \Piwik\DataAccess\LogAggregator
* @api
*/
protected function getLogAggregator()
{
return $this->getProcessor()->getLogAggregator();
}
public function disable()
{
$this->enabled = false;
}
/**
* Whether this Archiver should be used or not.
*
* @return bool
*/
public function isEnabled()
{
return $this->enabled;
}
/**
* By overwriting this method and returning true, a plugin archiver can force the archiving to run even when there
* was no visit for the website/date/period/segment combination
* (by default, archivers are skipped when there is no visit).
*
* @return bool
*/
public static function shouldRunEvenWhenNoVisits()
{
return false;
}
/**
* Returns a list of segments that should be pre-archived along with the segment currently being archived.
* The segments in this list will be added to the current segment via an AND condition and archiving
* for the current plugin will be launched. This process will not recurse further.
*
* If your plugin's API appends conditions to the requested segment when fetching data, you will want to
* use this method to make sure those segments get pre-archived. Otherwise, if browser archiving is disabled,
* the modified segments will appear to have no data.
*
* To archive another plugin, use an array instead of a string segment, for example:
*
* ```
* ['plugin' => 'VisitsSummary', 'segment' => '...']
* ```
*
* See the Goals and VisitFrequency plugins for examples.
*
* @return array
* @api
*/
public function getDependentSegmentsToArchive() : array
{
return [];
}
protected function isRequestedReport(string $reportName)
{
$requestedReport = $this->getProcessor()->getParams()->getArchiveOnlyReport();
return empty($requestedReport) || $requestedReport == $reportName;
}
private function processDependentArchivesForPlugins()
{
if (!self::$ARCHIVE_DEPENDENT) {
return;
}
$dependentSegments = $this->getDependentSegmentsToArchive();
foreach ($dependentSegments as $dependentSegment) {
$plugin = $this->getPluginName();
$segment = $dependentSegment;
if (is_array($dependentSegment)) {
$plugin = $dependentSegment['plugin'] ?? $plugin;
$segment = $dependentSegment['segment'];
}
$this->getProcessor()->processDependentArchive($plugin, $segment);
}
}
private static function getDefaultConstructibleClasses(array $classes) : array
{
return array_filter($classes, function ($className) {
return (new \ReflectionClass($className))->getConstructor()->getNumberOfRequiredParameters() == 0;
});
}
private static function getAllRecordBuilderClasses() : array
{
$transientCache = Cache::getTransientCache();
$cacheKey = CacheId::siteAware('RecordBuilders.allRecordBuilders');
$recordBuilderClasses = $transientCache->fetch($cacheKey);
if ($recordBuilderClasses === false) {
$recordBuilderClasses = \Piwik\Plugin\Manager::getInstance()->findMultipleComponents('RecordBuilders', ArchiveProcessor\RecordBuilder::class);
$recordBuilderClasses = self::getDefaultConstructibleClasses($recordBuilderClasses);
$transientCache->save($cacheKey, $recordBuilderClasses);
}
return $recordBuilderClasses;
}
public static function doesPluginHaveRecordBuilders(string $pluginName) : bool
{
$recordBuilders = self::getAllRecordBuilderClasses();
foreach ($recordBuilders as $builder) {
if ($pluginName === Piwik::getPluginNameOfMatomoClass($builder)) {
return true;
}
}
return false;
}
}