refs matomo-org#4903 added some comments and better naming

sabl0r · Mar 25, 2014 · 3827424 · 3827424
1 parent 5fcbc09
commit 3827424
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 6 deletions.
diff --git a/core/ArchiveProcessor/FixedSiteIds.php b/core/ArchiveProcessor/FixedSiteIds.php
@@ -23,11 +23,21 @@ public function __construct($websiteIds)
         $this->siteIds = $websiteIds;
     }
 
+    /**
+     * 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. All websites were processed by the current archiver.
+     *
+     * @return int
+     */
     public function getNumProcessedWebsites()
     {
         return $this->index + 1;

diff --git a/core/ArchiveProcessor/SharedSiteIds.php b/core/ArchiveProcessor/SharedSiteIds.php
@@ -12,6 +12,10 @@
 use Piwik\Option;
 use Piwik\CliMulti\Process;
 
+/**
+ * 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
 {
     private $siteIds = array();
@@ -21,6 +25,8 @@ public function __construct($websiteIds)
     {
         $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)) {
@@ -33,11 +39,21 @@ public function __construct($websiteIds)
         });
     }
 
+    /**
+     * 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 (empty($this->currentSiteId)) {
@@ -56,16 +72,16 @@ public function getNumProcessedWebsites()
     public function setSiteIdsToArchive($siteIds)
     {
         if (!empty($siteIds)) {
-            Option::set('SiteIdsToArchive', implode(',', $siteIds));
+            Option::set('SharedSiteIdsToArchive', implode(',', $siteIds));
         } else {
-            Option::delete('SiteIdsToArchive');
+            Option::delete('SharedSiteIdsToArchive');
         }
     }
 
     public function getAllSiteIdsToArchive()
     {
-        Option::clearCachedOption('SiteIdsToArchive');
-        $siteIdsToArchive = Option::get('SiteIdsToArchive');
+        Option::clearCachedOption('SharedSiteIdsToArchive');
+        $siteIdsToArchive = Option::get('SharedSiteIdsToArchive');
 
         if (empty($siteIdsToArchive)) {
             return array();
@@ -86,7 +102,7 @@ public function getAllSiteIdsToArchive()
      */
     private function runExclusive($closure)
     {
-        $process = new Process('archive.lock');
+        $process = new Process('archive.sharedsiteids');
         while ($process->isRunning() && $process->getSecondsSinceCreation() < 5) {
             // wait max 5 seconds, such an operation should not take longer
             usleep(25);
@@ -106,6 +122,11 @@ private function runExclusive($closure)
         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()
     {
         $self = $this;

diff --git a/core/CronArchive.php b/core/CronArchive.php
@@ -171,7 +171,7 @@ public function init()
             $this->websites = new SharedSiteIds($websitesIds);
         }
 
-        if($this->shouldStartProfiler) {
+        if ($this->shouldStartProfiler) {
             \Piwik\Profiler::setupProfilerXHProf($mainRun = true);
             $this->log("XHProf profiling is enabled.");
         }