JezK

Edit File: SharedSiteIds.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */
namespace Piwik\CronArchive;

use Exception;
use Piwik\CliMulti\Process;
use Piwik\Log;
use Piwik\Option;
/**
 * This class saves all to be processed siteIds in an Option named 'SharedSiteIdsToArchive' and processes all sites
 * within that list. If a user starts multiple archiver those archiver will help to finish processing that list.
 */
class SharedSiteIds
{
    public const OPTION_DEFAULT = 'SharedSiteIdsToArchive';
    public const OPTION_ALL_WEBSITES = 'SharedSiteIdsToArchive_AllWebsites';
    public const KEY_TIMESTAMP = '_ResetQueueTime';
    /**
     * @var string
     */
    private $optionName;
    private $siteIds = array();
    private $currentSiteId;
    private $done = \false;
    private $initialResetQueueTime = null;
    private $isContinuingPreviousRun = \false;
    public function __construct($websiteIds, $optionName = self::OPTION_DEFAULT)
    {
        $this->optionName = $optionName;
        if (empty($websiteIds)) {
            $websiteIds = array();
        }
        $self = $this;
        $this->siteIds = $this->runExclusive(function () use($self, $websiteIds) {
            // if there are already sites to be archived registered, prefer the list of existing archive, meaning help
            // to finish this queue of sites instead of starting a new queue
            $existingWebsiteIds = $self->getAllSiteIdsToArchive();
            if (!empty($existingWebsiteIds)) {
                $this->isContinuingPreviousRun = \true;
                return $existingWebsiteIds;
            }
            $self->setQueueWasReset();
            $self->setSiteIdsToArchive($websiteIds);
            return $websiteIds;
        });
        $this->initialResetQueueTime = $this->getResetQueueTime();
    }
    public function setQueueWasReset()
    {
        Option::set($this->optionName . self::KEY_TIMESTAMP, floor(microtime(\true) * 1000));
    }
    private function getResetQueueTime()
    {
        Option::clearCachedOption($this->optionName . self::KEY_TIMESTAMP);
        return (int) Option::get($this->optionName . self::KEY_TIMESTAMP);
    }
    public function getInitialSiteIds()
    {
        return $this->siteIds;
    }
    /**
     * Get the number of total websites that needs to be processed.
     *
     * @return int
     */
    public function getNumSites()
    {
        return count($this->siteIds);
    }
    /**
     * Get the number of already processed websites (not necessarily all of those where processed by this archiver).
     *
     * @return int
     */
    public function getNumProcessedWebsites()
    {
        if ($this->done) {
            return $this->getNumSites();
        }
        if (empty($this->currentSiteId)) {
            return 0;
        }
        $index = array_search($this->currentSiteId, $this->siteIds);
        if (\false === $index) {
            return 0;
        }
        return $index + 1;
    }
    public function setSiteIdsToArchive($siteIds)
    {
        if (!empty($siteIds)) {
            Option::set($this->optionName, implode(',', $siteIds));
        } else {
            Option::delete($this->optionName);
        }
    }
    public function getAllSiteIdsToArchive()
    {
        Option::clearCachedOption($this->optionName);
        $siteIdsToArchive = Option::get($this->optionName);
        if (empty($siteIdsToArchive)) {
            return array();
        }
        return explode(',', trim($siteIdsToArchive));
    }
    /**
     * If there are multiple archiver running on the same node it makes sure only one of them performs an action and it
     * will wait until another one has finished. Any closure you pass here should be very fast as other processes wait
     * for this closure to finish otherwise. Currently only used for making multiple archivers at the same time work.
     * If a closure takes more than 5 seconds we assume it is dead and simply continue.
     *
     * @param \Closure $closure
     * @return mixed
     * @throws \Exception
     */
    private function runExclusive($closure)
    {
        $process = new Process('archive.sharedsiteids');
        while ($process->isRunning() && $process->getSecondsSinceCreation() < 5) {
            // wait max 5 seconds, such an operation should not take longer
            usleep(25 * 1000);
        }
        $process->startProcess();
        try {
            $result = $closure();
        } catch (Exception $e) {
            $process->finishProcess();
            throw $e;
        }
        $process->finishProcess();
        return $result;
    }
    /**
     * Get the next site id that needs to be processed or null if all site ids where processed.
     *
     * @return int|null
     */
    public function getNextSiteId()
    {
        if ($this->done) {
            // we make sure we don't check again whether there are more sites to be archived as the list of
            // sharedSiteIds may have been reset by now.
            return null;
        }
        if ($this->initialResetQueueTime !== $this->getResetQueueTime()) {
            // queue was reset/finished by some other process
            $this->currentSiteId = null;
            $this->done = \true;
            Log::debug('The shared site ID queue was reset, stopping.');
            return null;
        }
        $self = $this;
        $this->currentSiteId = $this->runExclusive(function () use($self) {
            $siteIds = $self->getAllSiteIdsToArchive();
            if (empty($siteIds)) {
                // done... no sites left to be archived
                return null;
            }
            $nextSiteId = array_shift($siteIds);
            $self->setSiteIdsToArchive($siteIds);
            return $nextSiteId;
        });
        if (is_null($this->currentSiteId)) {
            $this->done = \true;
        }
        return $this->currentSiteId;
    }
    public static function isSupported()
    {
        return Process::isSupported();
    }
    /**
     * @return bool
     */
    public function isContinuingPreviousRun() : bool
    {
        return $this->isContinuingPreviousRun;
    }
}