diff options
Diffstat (limited to 'core/Archive/Array/IndexedBySite.php')
| -rw-r--r-- | core/Archive/Array/IndexedBySite.php | 504 |
1 files changed, 242 insertions, 262 deletions
diff --git a/core/Archive/Array/IndexedBySite.php b/core/Archive/Array/IndexedBySite.php index c6fee07bcc..1ac9ff682a 100644 --- a/core/Archive/Array/IndexedBySite.php +++ b/core/Archive/Array/IndexedBySite.php @@ -1,10 +1,10 @@ <?php /** * Piwik - Open source web analytics - * + * * @link http://piwik.org * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later - * + * * @category Piwik * @package Piwik */ @@ -13,274 +13,254 @@ * @package Piwik * @subpackage Piwik_Archive */ -class Piwik_Archive_Array_IndexedBySite extends Piwik_Archive_Array +class Piwik_Archive_Array_IndexedBySite extends Piwik_Archive_Array { - /** - * Used to cache the name of the table that holds the data this archive. - * - * This will only be used if the archives held by this instance are instances of - * Piwik_Archive_Single. - */ - private $tableName = null; - - /** - * @param array $sites array of siteIds - * @param string $strPeriod eg. 'day' 'week' etc. - * @param string $strDate A date range, eg. 'last10', 'previous5' or 'YYYY-MM-DD,YYYY-MM-DD' - * @param Piwik_Segment $segment - * @param string $_restrictSitesToLogin - */ - function __construct($sites, $strPeriod, $strDate, Piwik_Segment $segment, $_restrictSitesToLogin) - { - foreach($sites as $idSite) - { - $archive = Piwik_Archive::build($idSite, $strPeriod, $strDate, $segment, $_restrictSitesToLogin ); - $this->archives[$idSite] = $archive; - } - ksort( $this->archives ); - } - - /** - * @return string - */ - protected function getIndexName() - { - return 'idSite'; - } - - /** - * @param Piwik_Archive $archive - * @return mixed - */ - protected function getDataTableLabelValue( $archive ) - { - return $archive->getIdSite(); - } - - /** - * Given a list of fields defining numeric values, it will return a Piwik_DataTable_Array - * ordered by idsite - * - * @param array|string $fields array( fieldName1, fieldName2, ...) Names of the mysql table fields to load - * @return Piwik_DataTable_Array - */ - public function getDataTableFromNumeric( $fields ) - { - $tableArray = $this->getNewDataTableArray(); - if ($this->getFirstArchive() instanceof Piwik_Archive_Single) - { - $values = $this->getValues($fields); - foreach($this->archives as $idSite => $archive) - { - $table = $archive->makeDataTable($isSimple = true); - if (array_key_exists($idSite, $values)) - { - $table->addRowsFromArray($values[$idSite]); - } - $tableArray->addTable($table, $idSite); - } - } - elseif ($this->getFirstArchive() instanceof Piwik_Archive_Array) - { - foreach($this->archives as $idSite => $archive) - { - $tableArray->addTable($archive->getDataTableFromNumeric($fields), $idSite); - } - } - - return $tableArray; - } - - /** - * Returns the values of the requested fields - * - * @param array $fields - * @return array - */ - private function getValues($fields) - { - // Creating the default array, to ensure consistent order - $defaultValues = array(); - foreach($fields as $field) { $defaultValues[$field] = null; } - - $arrayValues = array(); - foreach($this->loadValuesFromDB($fields) as $value) - { - if(!isset($arrayValues[$value['idsite']])) - { - $arrayValues[$value['idsite']] = $defaultValues; - } - $arrayValues[$value['idsite']][$value['name']] = $this->formatNumericValue( $value['value'] ); - } - return $arrayValues; - } - - /** - * @param $fields - * @return array|array (one row in the array per row fetched in the DB) - */ - private function loadValuesFromDB($fields) - { - $requestedMetrics = is_string($fields) ? array($fields) : $fields; - $inNames = Piwik_Common::getSqlStringFieldsArray($fields); - - // get the archive ids - if (!$this->getFirstArchive()->isArchivingDisabled()) - { - $archiveIds = $this->getArchiveIdsAfterLaunching($requestedMetrics); - } - else - { - $archiveIds = $this->getArchiveIdsWithoutLaunching($requestedMetrics); - } - - $archiveIds = implode(', ', array_filter($archiveIds)); - - // if no archive ids are found, avoid executing any SQL queries - if(empty($archiveIds)) - { - return array(); - } - - // select archive data - $sql = "SELECT value, name, idarchive, idsite + /** + * Used to cache the name of the table that holds the data this archive. + * + * This will only be used if the archives held by this instance are instances of + * Piwik_Archive_Single. + */ + private $tableName = null; + + /** + * @param array $sites array of siteIds + * @param string $strPeriod eg. 'day' 'week' etc. + * @param string $strDate A date range, eg. 'last10', 'previous5' or 'YYYY-MM-DD,YYYY-MM-DD' + * @param Piwik_Segment $segment + * @param string $_restrictSitesToLogin + */ + function __construct($sites, $strPeriod, $strDate, Piwik_Segment $segment, $_restrictSitesToLogin) + { + foreach ($sites as $idSite) { + $archive = Piwik_Archive::build($idSite, $strPeriod, $strDate, $segment, $_restrictSitesToLogin); + $this->archives[$idSite] = $archive; + } + ksort($this->archives); + } + + /** + * @return string + */ + protected function getIndexName() + { + return 'idSite'; + } + + /** + * @param Piwik_Archive $archive + * @return mixed + */ + protected function getDataTableLabelValue($archive) + { + return $archive->getIdSite(); + } + + /** + * Given a list of fields defining numeric values, it will return a Piwik_DataTable_Array + * ordered by idsite + * + * @param array|string $fields array( fieldName1, fieldName2, ...) Names of the mysql table fields to load + * @return Piwik_DataTable_Array + */ + public function getDataTableFromNumeric($fields) + { + $tableArray = $this->getNewDataTableArray(); + if ($this->getFirstArchive() instanceof Piwik_Archive_Single) { + $values = $this->getValues($fields); + foreach ($this->archives as $idSite => $archive) { + $table = $archive->makeDataTable($isSimple = true); + if (array_key_exists($idSite, $values)) { + $table->addRowsFromArray($values[$idSite]); + } + $tableArray->addTable($table, $idSite); + } + } elseif ($this->getFirstArchive() instanceof Piwik_Archive_Array) { + foreach ($this->archives as $idSite => $archive) { + $tableArray->addTable($archive->getDataTableFromNumeric($fields), $idSite); + } + } + + return $tableArray; + } + + /** + * Returns the values of the requested fields + * + * @param array $fields + * @return array + */ + private function getValues($fields) + { + // Creating the default array, to ensure consistent order + $defaultValues = array(); + foreach ($fields as $field) { + $defaultValues[$field] = null; + } + + $arrayValues = array(); + foreach ($this->loadValuesFromDB($fields) as $value) { + if (!isset($arrayValues[$value['idsite']])) { + $arrayValues[$value['idsite']] = $defaultValues; + } + $arrayValues[$value['idsite']][$value['name']] = $this->formatNumericValue($value['value']); + } + return $arrayValues; + } + + /** + * @param $fields + * @return array|array (one row in the array per row fetched in the DB) + */ + private function loadValuesFromDB($fields) + { + $requestedMetrics = is_string($fields) ? array($fields) : $fields; + $inNames = Piwik_Common::getSqlStringFieldsArray($fields); + + // get the archive ids + if (!$this->getFirstArchive()->isArchivingDisabled()) { + $archiveIds = $this->getArchiveIdsAfterLaunching($requestedMetrics); + } else { + $archiveIds = $this->getArchiveIdsWithoutLaunching($requestedMetrics); + } + + $archiveIds = implode(', ', array_filter($archiveIds)); + + // if no archive ids are found, avoid executing any SQL queries + if (empty($archiveIds)) { + return array(); + } + + // select archive data + $sql = "SELECT value, name, idarchive, idsite FROM {$this->getNumericTableName()} WHERE idarchive IN ( $archiveIds ) AND name IN ( $inNames )"; - - return Piwik_FetchAll($sql, $fields); - } - - /** - * Returns the first archive in the list - * - * @return Piwik_Archive - */ - private function getFirstArchive() - { - return reset($this->archives); - } - - /** - * Gets the archive id of every Single archive this archive holds. This method - * will launch the archiving process if appropriate. - * - * @param array $metrics The requested archive metrics. - * @throws Exception - * @return array - */ - private function getArchiveIdsAfterLaunching( $metrics ) - { - // collect the individual report names for the requested metrics - $reports = array(); - foreach($metrics as $metric) - { - $report = Piwik_Archive_Single::getRequestedReportFor($metric); - $reports[$report] = $metric; - } - - // process archives for each individual report - $archiveIds = array(); - foreach($reports as $report => $metric) - { - // prepare archives (this will launch archiving when appropriate) - foreach($this->archives as $archive) - { - // NOTE: Piwik_Archive_Single expects a metric here, not a report - $archive->setRequestedReport( $metric ); - $archive->prepareArchive(); - } - - // collect archive ids for archives that have visits - foreach($this->archives as $archive) - { - if( !$archive->isThereSomeVisits ) - { - continue; - } - - $archiveIds[] = $archive->getIdArchive(); - - if( $this->getNumericTableName() != $archive->archiveProcessing->getTableArchiveNumericName()) - { - throw new Exception("Piwik_Archive_Array_IndexedBySite::getDataTableFromNumeric() algorithm won't work if data is stored in different tables"); - } - } - } - - return $archiveIds; - } - - /** - * Gets the archive id of every Single archive this archive holds. This method - * will not launch the archiving process. - * - * @param array $metrics The requested archive metrics. - * @return array - */ - private function getArchiveIdsWithoutLaunching( $metrics ) - { - $firstArchive = $this->getFirstArchive(); - $segment = $firstArchive->getSegment(); - $period = $firstArchive->getPeriod(); - - // the flags used to tell how the archiving process for a specific archive was completed, - // if it was completed - $doneFlags = array(); - foreach ($metrics as $metric) - { - $done = Piwik_ArchiveProcessing::getDoneStringFlagFor($segment, $period, $metric); - $donePlugins = Piwik_ArchiveProcessing::getDoneStringFlagFor($segment, $period, $metric, true); - - $doneFlags[$done] = $done; - $doneFlags[$donePlugins] = $donePlugins; - } - - $allDoneFlags = "'".implode("','", $doneFlags)."'"; - - // create the SQL to query every archive ID - $nameCondition = "(name IN ($allDoneFlags)) AND - (value = '".Piwik_ArchiveProcessing::DONE_OK."' OR - value = '".Piwik_ArchiveProcessing::DONE_OK_TEMPORARY."')"; - - $sql = "SELECT idsite, + + return Piwik_FetchAll($sql, $fields); + } + + /** + * Returns the first archive in the list + * + * @return Piwik_Archive + */ + private function getFirstArchive() + { + return reset($this->archives); + } + + /** + * Gets the archive id of every Single archive this archive holds. This method + * will launch the archiving process if appropriate. + * + * @param array $metrics The requested archive metrics. + * @throws Exception + * @return array + */ + private function getArchiveIdsAfterLaunching($metrics) + { + // collect the individual report names for the requested metrics + $reports = array(); + foreach ($metrics as $metric) { + $report = Piwik_Archive_Single::getRequestedReportFor($metric); + $reports[$report] = $metric; + } + + // process archives for each individual report + $archiveIds = array(); + foreach ($reports as $report => $metric) { + // prepare archives (this will launch archiving when appropriate) + foreach ($this->archives as $archive) { + // NOTE: Piwik_Archive_Single expects a metric here, not a report + $archive->setRequestedReport($metric); + $archive->prepareArchive(); + } + + // collect archive ids for archives that have visits + foreach ($this->archives as $archive) { + if (!$archive->isThereSomeVisits) { + continue; + } + + $archiveIds[] = $archive->getIdArchive(); + + if ($this->getNumericTableName() != $archive->archiveProcessing->getTableArchiveNumericName()) { + throw new Exception("Piwik_Archive_Array_IndexedBySite::getDataTableFromNumeric() algorithm won't work if data is stored in different tables"); + } + } + } + + return $archiveIds; + } + + /** + * Gets the archive id of every Single archive this archive holds. This method + * will not launch the archiving process. + * + * @param array $metrics The requested archive metrics. + * @return array + */ + private function getArchiveIdsWithoutLaunching($metrics) + { + $firstArchive = $this->getFirstArchive(); + $segment = $firstArchive->getSegment(); + $period = $firstArchive->getPeriod(); + + // the flags used to tell how the archiving process for a specific archive was completed, + // if it was completed + $doneFlags = array(); + foreach ($metrics as $metric) { + $done = Piwik_ArchiveProcessing::getDoneStringFlagFor($segment, $period, $metric); + $donePlugins = Piwik_ArchiveProcessing::getDoneStringFlagFor($segment, $period, $metric, true); + + $doneFlags[$done] = $done; + $doneFlags[$donePlugins] = $donePlugins; + } + + $allDoneFlags = "'" . implode("','", $doneFlags) . "'"; + + // create the SQL to query every archive ID + $nameCondition = "(name IN ($allDoneFlags)) AND + (value = '" . Piwik_ArchiveProcessing::DONE_OK . "' OR + value = '" . Piwik_ArchiveProcessing::DONE_OK_TEMPORARY . "')"; + + $sql = "SELECT idsite, MAX(idarchive) AS idarchive - FROM ".$this->getNumericTableName()." + FROM " . $this->getNumericTableName() . " WHERE date1 = ? AND date2 = ? AND period = ? AND $nameCondition - AND idsite IN (".implode(',', array_keys($this->archives)).") + AND idsite IN (" . implode(',', array_keys($this->archives)) . ") GROUP BY idsite"; - - $bind = array($period->getDateStart()->toString('Y-m-d'), - $period->getDateEnd()->toString('Y-m-d'), - $period->getId()); - - // execute the query and process the results. - $archiveIds = array(); - foreach (Piwik_FetchAll($sql, $bind) as $row) - { - $archiveIds[] = $row['idarchive']; - } - - return $archiveIds; - } - - /** - * Gets the name of the database table that holds the numeric archive data for - * this archive. - * - * @return string - */ - private function getNumericTableName() - { - if (is_null($this->tableName)) - { - $table = Piwik_ArchiveProcessing::makeNumericArchiveTable($this->getFirstArchive()->getPeriod()); - $this->tableName = $table->getTableName(); - } - - return $this->tableName; - } + + $bind = array($period->getDateStart()->toString('Y-m-d'), + $period->getDateEnd()->toString('Y-m-d'), + $period->getId()); + + // execute the query and process the results. + $archiveIds = array(); + foreach (Piwik_FetchAll($sql, $bind) as $row) { + $archiveIds[] = $row['idarchive']; + } + + return $archiveIds; + } + + /** + * Gets the name of the database table that holds the numeric archive data for + * this archive. + * + * @return string + */ + private function getNumericTableName() + { + if (is_null($this->tableName)) { + $table = Piwik_ArchiveProcessing::makeNumericArchiveTable($this->getFirstArchive()->getPeriod()); + $this->tableName = $table->getTableName(); + } + + return $this->tableName; + } } |