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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
<?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
*/
require_once 'TablePartitioning.php';
require_once 'ArchiveProcessing/Record.php';
require_once 'DataTable.php';
/**
* The ArchiveProcessing module is a module that reads the Piwik logs from the DB and
* compute all the reports, which are then stored in the database.
*
* The ArchiveProcessing class is used by the Archive object to make sure the given Archive is processed and available in the DB.
*
* A record in the Database for a given report is defined by
* - idarchive = unique ID that is associated to all the data of this archive (idsite+period+date)
* - idsite = the ID of the website
* - date1 = starting day of the period
* - date2 = ending day of the period
* - period = integer that defines the period (day/week/etc.). @see period::getId()
* - ts_archived = timestamp when the archive was processed
* - name = the name of the report (ex: uniq_visitors or search_keywords_by_search_engines)
* - value = the actual data
*
* @package Piwik_ArchiveProcessing
*/
abstract class Piwik_ArchiveProcessing
{
/**
* Flag stored at the end of the archiving
*
* @var int
*/
const DONE_OK = 1;
/**
* Flag stored at the start of the archiving
* When requesting an Archive, we make sure that non-finished archive are not considered valid
*
* @var int
*/
const DONE_ERROR = 2;
/**
* Idarchive in the DB for the requested archive
*
* @var int
*/
protected $idArchive;
/**
* Period id @see Piwik_Period::getId()
*
* @var int
*/
protected $periodId;
/**
* Timestamp for the first date of the period
*
* @var int unix timestamp
*/
protected $timestampDateStart = null;
/**
* Starting date of the archive
*
* @var Piwik_Date
*/
protected $dateStart;
/**
* Ending date of the archive
*
* @var Piwik_Date
*/
protected $dateEnd;
/**
* Object used to generate (depending on the $dateStart) the name of the DB table to use to store numeric values
*
* @var Piwik_TablePartitioning
*/
protected $tableArchiveNumeric;
/**
* Object used to generate (depending on the $dateStart) the name of the DB table to use to store numeric values
*
* @var Piwik_TablePartitioning
*/
protected $tableArchiveBlob;
/**
* Maximum timestamp above which a given archive is considered out of date
*
* @var int
*/
protected $maxTimestampArchive;
/**
* Id of the current site
* Can be accessed by plugins (that is why it's public)
*
* @var int
*/
public $idsite = null;
/**
* Period of the current archive
* Can be accessed by plugins (that is why it's public)
*
* @var Piwik_Period
*/
public $period = null;
/**
* Site of the current archive
* Can be accessed by plugins (that is why it's public)
*
* @var Piwik_Site
*/
public $site = null;
/**
* Starting date @see Piwik_Date::toString()
*
* @var string
*/
public $strDateStart;
/**
* Ending date @see Piwik_Date::toString()
*
* @var string
*/
public $strDateEnd;
/**
* Name of the DB table _log_visit
*
* @var string
*/
public $logTable;
/**
* Name of the DB table _log_link_visit_action
*
* @var string
*/
public $logVisitActionTable;
/**
* Name of the DB table _log_action
*
* @var string
*/
public $logActionTable;
/**
* When set to true, we always archive, even if the archive is already available.
* You can change this settings automatically in the config/global.ini.php always_archive_data under the [Debug] section
*
* @var bool
*/
protected $debugAlwaysArchive = false;
/**
* Builds the archive processing object,
* Reads some configuration value from the config file
*
*/
public function __construct()
{
$this->debugAlwaysArchive = Zend_Registry::get('config')->Debug->always_archive_data;
}
/**
* Returns the Piwik_ArchiveProcessing_Day or Piwik_ArchiveProcessing_Period object
* depending on $name period string
*
* @param string $name day|week|month|year
* @return Piwik_ArchiveProcessing Piwik_ArchiveProcessing_Day|Piwik_ArchiveProcessing_Period
*/
static function factory($name )
{
switch($name)
{
case 'day':
require_once 'ArchiveProcessing/Day.php';
$process = new Piwik_ArchiveProcessing_Day;
break;
case 'week':
case 'month':
case 'year':
require_once 'ArchiveProcessing/Period.php';
$process = new Piwik_ArchiveProcessing_Period;
break;
default:
throw new Exception("Unknown period specified $name");
break;
}
return $process;
}
/**
* Inits the object
*
* @return void
*/
protected function loadArchiveProperties()
{
$this->idsite = $this->site->getId();
$this->periodId = $this->period->getId();
$this->dateStart = $this->period->getDateStart();
$this->dateEnd = $this->period->getDateEnd();
$this->tableArchiveNumeric = new Piwik_TablePartitioning_Monthly('archive_numeric');
$this->tableArchiveNumeric->setTimestamp($this->dateStart->get());
$this->tableArchiveBlob = new Piwik_TablePartitioning_Monthly('archive_blob');
$this->tableArchiveBlob->setTimestamp($this->dateStart->get());
$this->strDateStart = $this->dateStart->toString();
$this->strDateEnd = $this->dateEnd->toString();
// if the current archive is a DAY and if it's today,
// we set this maxTimestampArchive that defines the lifetime value of today's archive
$this->maxTimestampArchive = 0;
if( $this->period->getNumberOfSubperiods() == 0
&& $this->period->toString() == date("Y-m-d")
)
{
//TODO this TIMESTAMP should be a mysql NOW()!!!!
$this->maxTimestampArchive = time() - Zend_Registry::get('config')->General->time_before_archive_considered_outdated;
}
// either
// - if the period we're looking for is finished, we look for a ts_archived that
// is greater than the last day of the archive
// - if the period we're looking for is not finished, we look for a recent enough archive
// recent enough means maxTimestampArchive = 00:00:01 this morning
else
{
if($this->period->isFinished())
{
$this->maxTimestampArchive = $this->period->getDateEnd()->setTime('00:00:00')->addDay(1)->getTimestamp();
}
else
{
$this->maxTimestampArchive = Piwik_Date::today()->getTimestamp();
}
}
}
/**
* This method returns the idArchive ; if necessary, it triggers the archiving process.
*
* If the archive was not processed yet, it will launch the archiving process.
* If the current archive needs sub-archives (eg. a month archive needs all the days archive)
* it will recursively launch the archiving (using this loadArchive() on the sub-periods)
*
* @return int The idarchive of the archive
*/
public function loadArchive()
{
$this->loadArchiveProperties();
$this->idArchive = $this->isArchived();
if($this->idArchive === false
&& $this->isArchivingDisabled())
{
$this->isThereSomeVisits = false;
}
elseif($this->idArchive === false
|| $this->debugAlwaysArchive)
{
$this->launchArchiving();
}
else
{
$this->isThereSomeVisits = true;
}
return $this->idArchive;
}
/**
* @see loadArchive()
*
*/
protected function launchArchiving()
{
$this->archivesSubperiods = $this->loadSubperiodsArchive();
$this->initCompute();
$this->compute();
$this->postCompute();
// we execute again the isArchived that does some initialization work
$this->idArchive = $this->isArchived();
}
/**
* This methods reads the subperiods if necessary,
* and computes the archive of the current period.
*/
abstract protected function compute();
/**
* Init the object before launching the real archive processing
*
* @return void
*/
protected function initCompute()
{
$this->loadNextIdarchive();
$record = new Piwik_ArchiveProcessing_Record_Numeric('done', Piwik_ArchiveProcessing::DONE_ERROR);
$this->insertRecord( $record);
$record->delete();
$this->logTable = Piwik::prefixTable('log_visit');
$this->logVisitActionTable = Piwik::prefixTable('log_link_visit_action');
$this->logActionTable = Piwik::prefixTable('log_action');
}
/**
* Post processing called at the end of the main archive processing.
* Makes sure the new archive is marked as "successful" in the DB
*
* We also try to delete some stuff from memory but really there is still a lot...
*
* @return void
*/
protected function postCompute()
{
// echo "<br>".Piwik_ArchiveProcessing_Record_Manager::getInstance()->toString();
// delete the first done = ERROR
Zend_Registry::get('db')->query("
DELETE FROM ".$this->tableArchiveNumeric->getTableName()."
WHERE idarchive = ? AND name = 'done'",
array($this->idArchive)
);
$record = new Piwik_ArchiveProcessing_Record_Numeric('done', Piwik_ArchiveProcessing::DONE_OK);
// save in the database the records
$records = Piwik_ArchiveProcessing_Record_Manager::getInstance()->getRecords();
foreach($records as $record)
{
$this->insertRecord( $record);
}
// delete the records from the global manager
foreach($records as $record)
{
$record->delete();
}
unset($records);
// we delete all tables from the table register
Piwik_ArchiveProcessing_Record_Manager::getInstance()->deleteAll();
}
/**
* Returns the name of the numeric table where the archive numeric values are stored
*
* @return string
*/
public function getTableArchiveNumericName()
{
return $this->tableArchiveNumeric->getTableName();
}
/**
* Returns the name of the blob table where the archive blob values are stored
*
* @return string
*/
public function getTableArchiveBlobName()
{
return $this->tableArchiveBlob->getTableName();
}
/**
* Set the period
*
* @param Piwik_Period $period
*/
public function setPeriod( Piwik_Period $period )
{
$this->period = $period;
}
/**
* Set the site
*
* @param Piwik_Site $site
*/
public function setSite( Piwik_Site $site )
{
$this->site = $site;
}
/**
* Returns the timestamp of the first date of the period
*
* @return int
*/
public function getTimestampStartDate()
{
// case when archive processing is in the past or the future, the starting date has not been set or processed yet
if(is_null($this->timestampDateStart))
{
return Piwik_Date::factory($this->strDateStart)->getTimestamp();
}
return $this->timestampDateStart;
}
/**
* Returns the idArchive we will use for the current archive
*
* @return int IdArchive to use when saving the current Archive
*/
protected function loadNextIdarchive()
{
$db = Zend_Registry::get('db');
$id = $db->fetchOne("SELECT max(idarchive) FROM ".$this->tableArchiveNumeric->getTableName());
if(empty($id))
{
$id = 0;
}
$this->idArchive = $id + 1;
}
/**
* Inserts a record in the good table (either NUMERIC or BLOB)
*
* @param unknown_type $record
*/
protected function insertRecord($record)
{
// table to use to save the data
if(Piwik::isNumeric($record->value))
{
$table = $this->tableArchiveNumeric;
}
else
{
$table = $this->tableArchiveBlob;
}
$query = "INSERT INTO ".$table->getTableName()." (idarchive, idsite, date1, date2, period, ts_archived, name, value)
VALUES (?,?,?,?,?,?,?,?)";
Zend_Registry::get('db')->query($query,
array( $this->idArchive,
$this->idsite,
$this->strDateStart,
$this->strDateEnd,
$this->periodId,
date("Y-m-d H:i:s"),
$record->name,
$record->value,
)
);
}
/**
* 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;
}
/**
* Returns the idArchive if the archive is available in the database.
* Returns false if the archive needs to be computed.
*
* An archive is available if
* - for today, the archive was computed less than maxTimestampArchive seconds ago
* - for any other day, if the archive was computed once this day was finished
* - for other periods, if the archive was computed once the period was finished
*
* @return int|false
*/
protected function isArchived()
{
// Piwik::log("Is archive site=$idsite for period = ".$this->period->getLabel()." for date_start = $strDateStart ?");
$bindSQL = array( $this->idsite,
$this->strDateStart,
$this->strDateEnd,
$this->periodId,
);
// echo " p = ".$this->periodId." d = ".$this->strDateStart ."," . $this->strDateEnd;
$timeStampWhere = " AND UNIX_TIMESTAMP(ts_archived) >= ? ";
$bindSQL[] = $this->maxTimestampArchive;
$sqlQuery = " SELECT idarchive, value, name, UNIX_TIMESTAMP(date1) as timestamp
FROM ".$this->tableArchiveNumeric->getTableName()."
WHERE idsite = ?
AND date1 = ?
AND date2 = ?
AND period = ?
AND ( (name = 'done' AND value = ".Piwik_ArchiveProcessing::DONE_OK.")
OR name = 'nb_visits')
$timeStampWhere
ORDER BY ts_archived DESC";
$results = Zend_Registry::get('db')->fetchAll($sqlQuery, $bindSQL );
// the archive exists in the table
if(empty($results))
{
return false;
}
$idarchive = false;
// let's look for the more recent idarchive
foreach($results as $result)
{
if($result['name'] == 'done')
{
$idarchive = $result['idarchive'];
$this->timestampDateStart = $result['timestamp'];
break;
}
}
if($idarchive === false)
{
throw new Exception("Error during the archiving process: ". var_export($results,true));
}
// let's look for the nb_visits result for this more recent archive
foreach($results as $result)
{
if($result['name'] == 'nb_visits'
&& $result['idarchive'] == $idarchive)
{
$this->isThereSomeVisits = ($result['value'] != 0);
break;
}
}
return $idarchive;
}
/**
* Returns true if, for various reasons, archiving is disabled.
*
* @return bool
*/
protected function isArchivingDisabled()
{
static $archivingIsDisabled = null;
if(is_null($archivingIsDisabled))
{
$archivingIsDisabled = false;
$enableBrowserArchivingTriggering = (bool)Zend_Registry::get('config')->General->enable_browser_archiving_triggering;
if($enableBrowserArchivingTriggering == false)
{
$sapi_type = php_sapi_name();
if( !in_array(substr($sapi_type, 0, 3), array('cgi', 'cli')))
{
$archivingIsDisabled = true;
}
}
}
return $archivingIsDisabled;
}
}
|