diff options
Diffstat (limited to 'core/DataAccess/ArchiveWriter.php')
| -rw-r--r-- | core/DataAccess/ArchiveWriter.php | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/core/DataAccess/ArchiveWriter.php b/core/DataAccess/ArchiveWriter.php new file mode 100644 index 0000000000..1f8be90156 --- /dev/null +++ b/core/DataAccess/ArchiveWriter.php @@ -0,0 +1,249 @@ +<?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 + */ + +/** + * This class is used to create a new Archive. + * An Archive is a set of reports (numeric and data tables). + * New data can be inserted in the archive with insertRecord/insertBulkRecords + */ +class Piwik_DataAccess_ArchiveWriter +{ + const PREFIX_SQL_LOCK = "locked_"; + + protected $fields = array('idarchive', + 'idsite', + 'date1', + 'date2', + 'period', + 'ts_archived', + 'name', + 'value'); + + public function __construct($idSite, Piwik_Segment $segment, Piwik_Period $period, $requestedPlugin, $isArchiveTemporary) + { + $this->idArchive = false; + $this->idSite = $idSite; + $this->segment = $segment; + $this->period = $period; + $this->doneFlag = Piwik_ArchiveProcessor_Rules::getDoneStringFlagFor($segment, $period->getLabel(), $requestedPlugin); + $this->isArchiveTemporary = $isArchiveTemporary; + + $this->dateStart = $this->period->getDateStart(); + } + + public function getIdArchive() + { + if ($this->idArchive === false) { + throw new Exception("Must call allocateNewArchiveId() first"); + } + return $this->idArchive; + } + + public function initNewArchive() + { + $this->acquireLock(); + $this->allocateNewArchiveId(); + $this->logArchiveStatusAsIncomplete(); + } + + protected function acquireLock() + { + $lockName = $this->getArchiveProcessorLockName(); + $result = Piwik_GetDbLock($lockName, $maxRetries = 30); + if (!$result) { + Piwik::log("SELECT GET_LOCK failed to acquire lock. Proceeding anyway."); + } + } + + protected function allocateNewArchiveId() + { + $this->idArchive = $this->insertNewArchiveId(); + return $this->idArchive; + } + + protected function insertNewArchiveId() + { + $numericTable = $this->getTableNumeric(); + $idSite = $this->idSite; + + $db = Zend_Registry::get('db'); + $locked = self::PREFIX_SQL_LOCK . Piwik_Common::generateUniqId(); + $date = date("Y-m-d H:i:s"); + $dbLockName = "allocateNewArchiveId.$numericTable"; + + if (Piwik_GetDbLock($dbLockName, $maxRetries = 30) === false) { + throw new Exception("allocateNewArchiveId: Cannot get named lock for table $numericTable."); + } + $insertSql = "INSERT INTO $numericTable " + . " SELECT ifnull(max(idarchive),0)+1, + '" . $locked . "', + " . (int)$idSite . ", + '" . $date . "', + '" . $date . "', + 0, + '" . $date . "', + 0 " + . " FROM $numericTable as tb1"; + $db->exec($insertSql); + Piwik_ReleaseDbLock($dbLockName); + $selectIdSql = "SELECT idarchive FROM $numericTable WHERE name = ? LIMIT 1"; + $id = $db->fetchOne($selectIdSql, $locked); + return $id; + } + + protected function logArchiveStatusAsIncomplete() + { + $statusWhileProcessing = Piwik_ArchiveProcessor::DONE_ERROR; + $this->insertRecord($this->doneFlag, $statusWhileProcessing); + } + + protected function getArchiveProcessorLockName() + { + return self::makeLockName($this->idSite, $this->period, $this->segment); + } + + protected static function makeLockName($idsite, Piwik_Period $period, Piwik_Segment $segment) + { + $config = Piwik_Config::getInstance(); + + $lockName = 'piwik.' + . $config->database['dbname'] . '.' + . $config->database['tables_prefix'] . '/' + . $idsite . '/' + . (!$segment->isEmpty() ? $segment->getHash() . '/' : '') + . $period->getId() . '/' + . $period->getDateStart()->toString('Y-m-d') . ',' + . $period->getDateEnd()->toString('Y-m-d'); + return $lockName . '/' . md5($lockName . Piwik_Common::getSalt()); + } + + public function finalizeArchive() + { + $this->deletePreviousArchiveStatus(); + $this->logArchiveStatusAsFinal(); + $this->releaseArchiveProcessorLock(); + } + + protected function deletePreviousArchiveStatus() + { + + Piwik_Query("DELETE FROM " . $this->getTableNumeric() . " + WHERE idarchive = ? AND (name = '" . $this->doneFlag . "' OR name LIKE '" . self::PREFIX_SQL_LOCK . "%')", + array($this->getIdArchive()) + ); + } + + protected function logArchiveStatusAsFinal() + { + $status = Piwik_ArchiveProcessor::DONE_OK; + if ($this->isArchiveTemporary) { + $status = Piwik_ArchiveProcessor::DONE_OK_TEMPORARY; + } + $this->insertRecord($this->doneFlag, $status); + } + + protected function releaseArchiveProcessorLock() + { + $lockName = $this->getArchiveProcessorLockName(); + return Piwik_ReleaseDbLock($lockName); + } + + public function insertBulkRecords($records) + { + // Using standard plain INSERT if there is only one record to insert + if ($DEBUG_DO_NOT_USE_BULK_INSERT = false + || count($records) == 1 + ) { + foreach ($records as $record) { + $this->insertRecord($record[0], $record[1]); + } + return true; + } + $bindSql = $this->getInsertRecordBind(); + $values = array(); + + $valueSeen = false; + foreach ($records as $record) { + // don't record zero + if (empty($record[1])) continue; + + $bind = $bindSql; + $bind[] = $record[0]; // name + $bind[] = $record[1]; // value + $values[] = $bind; + + $valueSeen = $record[1]; + } + if (empty($values)) return true; + + $tableName = $this->getTableNameToInsert($valueSeen); + Piwik::tableInsertBatch($tableName, $this->getInsertFields(), $values); + return true; + } + + /** + * Inserts a record in the right table (either NUMERIC or BLOB) + * + * @param string $name + * @param mixed $value + */ + public function insertRecord($name, $value) + { + if ($this->isRecordZero($value)) { + return false; + } + + $tableName = $this->getTableNameToInsert($value); + + // duplicate idarchives are Ignored, see http://dev.piwik.org/trac/ticket/987 + $query = "INSERT IGNORE INTO " . $tableName . " + (" . implode(", ", $this->getInsertFields()) . ") + VALUES (?,?,?,?,?,?,?,?)"; + $bindSql = $this->getInsertRecordBind(); + $bindSql[] = $name; + $bindSql[] = $value; + Piwik_Query($query, $bindSql); + return true; + } + + protected function getInsertRecordBind() + { + return array($this->getIdArchive(), + $this->idSite, + $this->dateStart->toString('Y-m-d'), + $this->period->getDateEnd()->toString('Y-m-d'), + $this->period->getId(), + date("Y-m-d H:i:s")); + } + + protected function getTableNameToInsert($value) + { + if (is_numeric($value)) { + return $this->getTableNumeric(); + } + return Piwik_DataAccess_ArchiveTableCreator::getBlobTable($this->dateStart);; + } + + protected function getTableNumeric() + { + return Piwik_DataAccess_ArchiveTableCreator::getNumericTable($this->dateStart); + } + + protected function getInsertFields() + { + return $this->fields; + } + + protected function isRecordZero($value) + { + return ($value === '0' || $value === false || $value === 0 || $value === 0.0); + } +}
\ No newline at end of file |