Skip to content
This repository
tag: 0.4.2
Fetching contributors…

Cannot retrieve contributors at this time

file 344 lines (311 sloc) 11.268 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @package Piwik_ArchiveProcessing
*/

/**
* Handles the archiving process for a period
*
* This class provides generic methods to archive data for a period (week / month / year).
*
* These methods are called by the plugins that do the logic of archiving their own data. \
* They hook on the event 'ArchiveProcessing_Period.compute'
*
* @package Piwik_ArchiveProcessing
*/
class Piwik_ArchiveProcessing_Period extends Piwik_ArchiveProcessing
{
/*
* Array of (column name before => column name renamed) of the columns for which sum operation is invalid.
* The summed value is not accurate and these columns will be renamed accordingly.
*/
static public $invalidSummedColumnNameToRenamedName = array(
Piwik_Archive::INDEX_NB_UNIQ_VISITORS => Piwik_Archive::INDEX_SUM_DAILY_NB_UNIQ_VISITORS
);

public function __construct()
{
parent::__construct();
$this->debugAlwaysArchive = Zend_Registry::get('config')->Debug->always_archive_data_period;
}

/**
* Sums all values for the given field names $aNames over the period
* See @archiveNumericValuesGeneral for more information
*
* @param string|array
* @return Piwik_ArchiveProcessing_Record_Numeric
*
*/
public function archiveNumericValuesSum( $aNames )
{
return $this->archiveNumericValuesGeneral($aNames, 'sum');
}

/**
* Get the maximum value for all values for the given field names $aNames over the period
* See @archiveNumericValuesGeneral for more information
*
* @param string|array
* @return Piwik_ArchiveProcessing_Record_Numeric
*
*/
public function archiveNumericValuesMax( $aNames )
{
return $this->archiveNumericValuesGeneral($aNames, 'max');
}

/**
* Given a list of fields names, the method will fetch all their values over the period, and archive them using the given operation.
*
* For example if $operationToApply = 'sum' and $aNames = array('nb_visits', 'sum_time_visit')
* it will sum all values of nb_visits for the period (for example give the number of visits for the month by summing the visits of every day)
*
* @param array|string $aNames Array of strings or string containg the field names to select
* @param string $operationToApply Available operations = sum, max, min
* @return Piwik_ArchiveProcessing_Record_Numeric Returns the record if $aNames is a string,
* an array of Piwik_ArchiveProcessing_Record_Numeric indexed by their field names if aNames is an array of strings
*/
private function archiveNumericValuesGeneral($aNames, $operationToApply)
{
if(!is_array($aNames))
{
$aNames = array($aNames);
}

// fetch the numeric values and apply the operation on them
$results = array();
foreach($this->archives as $archive)
{
foreach($aNames as $name)
{
if(!isset($results[$name]))
{
$results[$name] = 0;
}
$valueToSum = $archive->getNumeric($name);

if($valueToSum !== false)
{
switch ($operationToApply) {
case 'sum':
$results[$name] += $valueToSum;
break;
case 'max':
$results[$name] = max($results[$name], $valueToSum);
break;
case 'min':
$results[$name] = min($results[$name], $valueToSum);
break;
default:
throw new Exception("Operation not applicable.");
break;
}
}
}
}

// build the Record Numeric objects
$records = array();
foreach($results as $name => $value)
{
if($name == 'nb_uniq_visitors' && ($this->periodId == Piwik::$idPeriods['week'] || $this->periodId == Piwik::$idPeriods['month']))
{
$value = (float) $this->computeNbUniqVisitors();
}
$records[$name] = new Piwik_ArchiveProcessing_Record_Numeric(
$name,
$value
);
$this->insertRecord($records[$name]);
}

// if asked for only one field to sum
if(count($records) == 1)
{
return $records[$name];
}

// returns the array of records once summed
return $records;
}


/**
* This method will compute the sum of DataTables over the period for the given fields $aRecordName.
* The resulting DataTable will be then added to queue of data to be recorded in the database.
* It will usually be called in a plugin that listens to the hook 'ArchiveProcessing_Period.compute'
*
* For example if $aRecordName = 'UserCountry_country' the method will select all UserCountry_country DataTable for the period
* (eg. the 31 dataTable of the last month), sum them, and create the Piwik_ArchiveProcessing_RecordArray so that
* the resulting dataTable is AUTOMATICALLY recorded in the database.
*
*
* This method works on recursive dataTable. For example for the 'Actions' it will select all subtables of all dataTable of all the sub periods
* and get the sum.
*
* It returns an array that gives information about the "final" DataTable. The array gives for every field name, the number of rows in the
* final DataTable (ie. the number of distinct LABEL over the period) (eg. the number of distinct keywords over the last month)
*
* @param string|array Field name(s) of DataTable to select so we can get the sum
* @return array array (
* nameTable1 => number of rows,
* nameTable2 => number of rows,
* )
*/
public function archiveDataTable( $aRecordName,
$invalidSummedColumnNameToRenamedName = null,
$maximumRowsInDataTableLevelZero = null,
$maximumRowsInSubDataTable = null,
$columnToSortByBeforeTruncation = null )
{
if(!is_array($aRecordName))
{
$aRecordName = array($aRecordName);
}

$nameToCount = array();
foreach($aRecordName as $recordName)
{
$table = $this->getRecordDataTableSum($recordName, $invalidSummedColumnNameToRenamedName);

$nameToCount[$recordName]['level0'] = $table->getRowsCount();
$nameToCount[$recordName]['recursive'] = $table->getRowsCountRecursive();

$blob = $table->getSerialized( $maximumRowsInDataTableLevelZero, $maximumRowsInSubDataTable, $columnToSortByBeforeTruncation );
destroy($table);
$this->insertBlobRecord($recordName, $blob);
}
Piwik_DataTable_Manager::getInstance()->deleteAll();

return $nameToCount;
}

/**
* This method selects all DataTables that have the name $name over the period.
* It calls the appropriate methods that sum all these tables together.
* The resulting DataTable is returned.
*
* @param string $name
* @param array columns in the array (old name, new name) to be renamed as the sum operation is not valid on them (eg. nb_uniq_visitors->sum_daily_nb_uniq_visitors)
* @return Piwik_DataTable
*/
protected function getRecordDataTableSum( $name, $invalidSummedColumnNameToRenamedName )
{
$table = new Piwik_DataTable();
foreach($this->archives as $archive)
{
$archive->preFetchBlob($name);
$datatableToSum = $archive->getDataTable($name);
$archive->loadSubDataTables($name, $datatableToSum);
$table->addDataTable($datatableToSum);
$archive->freeBlob($name);
}

if(is_null($invalidSummedColumnNameToRenamedName))
{
$invalidSummedColumnNameToRenamedName = self::$invalidSummedColumnNameToRenamedName;
}
foreach($invalidSummedColumnNameToRenamedName as $oldName => $newName)
{
$table->renameColumn($oldName, $newName);
}
return $table;
}

protected function initCompute()
{
parent::initCompute();
$this->archives = $this->loadSubperiodsArchive();
}

/**
* Returns the ID of the archived subperiods.
*
* @return array Array of the idArchive of the subperiods
*/
protected function loadSubperiodsArchive()
{
$periods = array();

// we first compute every subperiod of the archive
foreach($this->period->getSubperiods() as $period)
{
$archivePeriod = new Piwik_Archive_Single();
$archivePeriod->setSite( $this->site );
$archivePeriod->setPeriod( $period );
$archivePeriod->prepareArchive();

$periods[] = $archivePeriod;
}
return $periods;
}

/**
* Main method to process logs for a period.
* The only logic done here is computing the number of visits, actions, etc.
*
* All the other reports are computed inside plugins listening to the event 'ArchiveProcessing_Period.compute'.
* See some of the plugins for an example.
*
* @return void
*/
protected function compute()
{
$this->archiveNumericValuesMax( 'max_actions' );
$toSum = array(
'nb_uniq_visitors',
'nb_visits',
'nb_actions',
'sum_visit_length',
'bounce_count',
'nb_visits_converted',
);
$record = $this->archiveNumericValuesSum($toSum);

$nbVisits = $record['nb_visits']->value;
$nbVisitsConverted = $record['nb_visits_converted']->value;
$this->isThereSomeVisits = ( $nbVisits > 0);
if($this->isThereSomeVisits === false)
{
return;
}
$this->setNumberOfVisits($nbVisits);
$this->setNumberOfVisitsConverted($nbVisitsConverted);
Piwik_PostEvent('ArchiveProcessing_Period.compute', $this);
}

protected function computeNbUniqVisitors()
{
$query = "SELECT count(distinct visitor_idcookie) as nb_uniq_visitors FROM ".$this->logTable."
WHERE visit_server_date >= ? AND visit_server_date <= ? AND idsite = ?";

return Zend_Registry::get('db')->fetchOne($query, array( $this->strDateStart, $this->strDateEnd, $this->idsite ));
}

/**
* Called at the end of the archiving process.
* Does some cleaning job in the database.
*
* @return void
*/
protected function postCompute()
{
parent::postCompute();

$blobTable = $this->tableArchiveBlob->getTableName();
$numericTable = $this->tableArchiveNumeric->getTableName();

// delete out of date records maximum once per day (DELETE request is costly)
$key = 'lastPurge_' . $blobTable;
$timestamp = Piwik_GetOption($key);
if(!$timestamp
|| $timestamp < time() - 86400 )
{
// we delete out of date daily archives from table, maximum once per day
// those for day N that were processed on day N (means the archives are only partial as the day wasn't finished)
$query = "/* SHARDING_ID_SITE = ".$this->idsite." */ DELETE
FROM %s
WHERE period = ?
AND date1 = DATE(ts_archived)
AND DATE(ts_archived) <> CURRENT_DATE()
";
Piwik_Query(sprintf($query, $blobTable), Piwik::$idPeriods['day']);
Piwik_Query(sprintf($query, $numericTable), Piwik::$idPeriods['day']);

// we delete out of date Period records (week/month/etc)
// we delete archives that were archived before the end of the period
// and only if they are at least 1 day old (so we don't delete archives computed today that may be stil valid)
$query = " DELETE
FROM %s
WHERE period > ?
AND DATE(ts_archived) <= date2
AND date(ts_archived) < date_sub(CURRENT_DATE(), INTERVAL 1 DAY)
";

Piwik_Query(sprintf($query, $blobTable), Piwik::$idPeriods['day']);
Piwik_Query(sprintf($query, $numericTable), Piwik::$idPeriods['day']);

Piwik_SetOption($key, time());
}

foreach($this->archives as $archive)
{
destroy($archive);
}
$this->archives = array();
}
}
Something went wrong with that request. Please try again.