Ubuntu

[], 'blob' => [] ]; const MAX_SPOOL_SIZE = 50; /** * @var int|false */ public $idArchive; /** * @var int|null */ private $idSite; /** * @var \Piwik\Segment */ private $segment; /** * @var \Piwik\Period */ private $period; /** * @var ArchiveProcessor\Parameters */ private $parameters; /** * @var string */ private $earliestNow; /** * @var string */ private $doneFlag; /** * @var Date|null */ private $dateStart; /** * ArchiveWriter constructor. * @param ArchiveProcessor\Parameters $params * @param bool $isArchiveTemporary Deprecated. Has no effect. * @throws Exception */ public function __construct(ArchiveProcessor\Parameters $params) { $this->idArchive = false; $this->idSite = $params->getSite()->getId(); $this->segment = $params->getSegment(); $this->period = $params->getPeriod(); $this->parameters = $params; $idSites = [$this->idSite]; $this->doneFlag = Rules::getDoneStringFlagFor($idSites, $this->segment, $this->period->getLabel(), $params->getRequestedPlugin()); $this->dateStart = $this->period->getDateStart(); } /** * @param string $name * @param string|string[] $values A blob string or an array of blob strings. If an array * is used, the first element in the array will be inserted * with the `$name` name. The others will be splitted into chunks. All subtables * within one chunk will be serialized as an array where the index is the * subtableId. */ public function insertBlobRecord($name, $values) { if (is_array($values)) { if (isset($values[0])) { // we always store the root table in a single blob for fast access $this->insertRecord($name, $this->compress($values[0])); unset($values[0]); } if (!empty($values)) { // we move all subtables into chunks $chunk = new Chunk(); $chunks = $chunk->moveArchiveBlobsIntoChunks($name, $values); foreach ($chunks as $index => $subtables) { $this->insertRecord($index, $this->compress(serialize($subtables))); } } } else { $values = $this->compress($values); $this->insertRecord($name, $values); } } public function getIdArchive() { if ($this->idArchive === false) { throw new Exception("Must call allocateNewArchiveId() first"); } return $this->idArchive; } public function initNewArchive() { $idArchive = $this->allocateNewArchiveId(); $this->logArchiveStatusAsIncomplete(); return $idArchive; } public function finalizeArchive() { $this->flushSpools(); $numericTable = $this->getTableNumeric(); $idArchive = $this->getIdArchive(); $doneValue = $this->parameters->isPartialArchive() ? self::DONE_PARTIAL : self::DONE_OK; $this->checkDoneValueIsOnlyPartialForPluginArchives($doneValue); // check and log $this->getModel()->updateArchiveStatus($numericTable, $idArchive, $this->doneFlag, $doneValue); if (!$this->parameters->isPartialArchive() // sanity check, just in case nothing was inserted (the archive status should always be inserted) && !empty($this->earliestNow) ) { $this->getModel()->deleteOlderArchives($this->parameters, $this->doneFlag, $this->earliestNow, $this->idArchive); } } protected function compress($data) { if (Db::get()->hasBlobDataType()) { return gzcompress($data); } return $data; } protected function allocateNewArchiveId() { $numericTable = $this->getTableNumeric(); $this->idArchive = $this->getModel()->allocateNewArchiveId($numericTable); return $this->idArchive; } private function getModel() { return new Model(); } protected function logArchiveStatusAsIncomplete() { $this->insertRecord($this->doneFlag, self::DONE_ERROR); } private function batchInsertSpool($valueType) { $records = $this->recordsToWriteSpool[$valueType]; $bindSql = $this->getInsertRecordBind(); $values = []; $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); $fields = $this->getInsertFields(); // For numeric records it's faster to do the insert directly; for blobs the data infile is better if ($valueType === 'numeric') { BatchInsert::tableInsertBatchSql($tableName, $fields, $values); } else { BatchInsert::tableInsertBatch($tableName, $fields, $values, $throwException = false, $charset = 'latin1'); } return true; } /** * Inserts a record in the right table (either NUMERIC or BLOB) * * @param string $name * @param mixed $value * * @return bool */ public function insertRecord($name, $value) { if ($this->isRecordZero($value)) { return false; } $valueType = $this->isRecordNumeric($value) ? 'numeric' : 'blob'; $this->recordsToWriteSpool[$valueType][] = [ 0 => $name, 1 => $value ]; if (count($this->recordsToWriteSpool[$valueType]) >= self::MAX_SPOOL_SIZE) { $this->flushSpool($valueType); } return true; } public function flushSpools() { $this->flushSpool('numeric'); $this->flushSpool('blob'); } private function flushSpool($valueType) { $numRecords = count($this->recordsToWriteSpool[$valueType]); if ($numRecords > 1) { $this->batchInsertSpool($valueType); } elseif ($numRecords === 1) { [$name, $value] = $this->recordsToWriteSpool[$valueType][0]; $tableName = $this->getTableNameToInsert($value); $fields = $this->getInsertFields(); $record = $this->getInsertRecordBind(); $this->getModel()->insertRecord($tableName, $fields, $record, $name, $value); } $this->recordsToWriteSpool[$valueType] = []; } protected function getInsertRecordBind() { $now = Date::now()->getDatetime(); if (empty($this->earliestNow)) { $this->earliestNow = $now; } return [$this->getIdArchive(), $this->idSite, $this->dateStart->toString('Y-m-d'), $this->period->getDateEnd()->toString('Y-m-d'), $this->period->getId(), $now]; } protected function getTableNameToInsert($value) { if ($this->isRecordNumeric($value)) { return $this->getTableNumeric(); } return ArchiveTableCreator::getBlobTable($this->dateStart); } protected function getTableNumeric() { return ArchiveTableCreator::getNumericTable($this->dateStart); } protected function getInsertFields() { return $this->fields; } protected function isRecordZero($value) { return ($value === '0' || $value === false || $value === 0 || $value === 0.0); } private function isRecordNumeric($value) { return is_numeric($value); } private function checkDoneValueIsOnlyPartialForPluginArchives($doneValue) { // if the done flag is not like done%.PluginName, then it shouldn't be a partial archive. // log a warning. if ($doneValue == self::DONE_PARTIAL && strpos($this->doneFlag, '.') == false) { $ex = new \Exception(sprintf("Trying to create a partial archive w/ an all plugins done flag (done flag = %s). This should not happen.", $this->doneFlag)); StaticContainer::get(LoggerInterface::class)->warning('{exception}', [ 'exception' => $ex, ]); } } }