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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
|
<?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
*/
require_once "Config.php";
require_once "Zend/Db.php";
require_once "Zend/Db/Table.php";
require_once "Log.php";
require_once "PluginsManager.php";
require_once "Translate.php";
/**
* Main piwik helper class.
* Contains static functions you can call from the plugins.
*
* @package Piwik
*/
class Piwik
{
const CLASSES_PREFIX = "Piwik_";
public static $idPeriods = array(
'day' => 1,
'week' => 2,
'month' => 3,
'year' => 4,
);
/**
* ending WITHOUT slashs
*/
static public function getPathToPiwikRoot()
{
return realpath( dirname(__FILE__). "/../" );
}
/**
* path without trailing slash
*/
static public function createHtAccess( $path )
{
@file_put_contents($path . "/.htaccess", "Deny from all");
}
static public function mkdir( $path, $mode = 0755, $denyAccess = true )
{
if(!is_dir($path))
{
$directoryParent = realpath(dirname($path));
// test that the dir we are trying to write has write access
if( is_writable($directoryParent) )
{
mkdir($path, $mode, true);
}
}
if($denyAccess)
{
Piwik::createHtAccess($path);
}
}
/**
* Checks if directories are writable and create them if they do not exist.
*
* @param array $directoriesToCheck array of directories to check - if not given default Piwik directories that needs write permission are checked
*
* @return array direcory name => true|false (is writable)
*/
static public function checkDirectoriesWritable($directoriesToCheck = null)
{
if( $directoriesToCheck == null )
{
$directoriesToCheck = array(
'/',
'/config',
'/tmp',
'/tmp/templates_c',
'/tmp/cache',
);
}
$resultCheck = array();
foreach($directoriesToCheck as $directoryToCheck)
{
if( !ereg('^'.preg_quote(PIWIK_INCLUDE_PATH), $directoryToCheck) )
{
$directoryToCheck = PIWIK_INCLUDE_PATH . $directoryToCheck;
}
if(!file_exists($directoryToCheck))
{
Piwik::mkdir($directoryToCheck, 0755, false);
}
$directory = realpath($directoryToCheck);
$resultCheck[$directory] = false;
if(is_writable($directoryToCheck))
{
$resultCheck[$directory] = true;
}
}
return $resultCheck;
}
static public function getJavascriptCode($idSite, $piwikUrl, $actionName = "''")
{
$jsTag = file_get_contents( "modules/LogStats/javascriptTag.tpl");
$jsTag = nl2br(htmlentities($jsTag));
$jsTag = str_replace('{$actionName}', $actionName, $jsTag);
$jsTag = str_replace('{$idSite}', $idSite, $jsTag);
$jsTag = str_replace('{$piwikUrl}', $piwikUrl, $jsTag);
$jsTag = str_replace('{$hrefTitle}', Piwik::getRandomTitle(), $jsTag);
return $jsTag;
}
static public function getMemoryLimitValue()
{
if($memory = ini_get('memory_limit'))
{
return substr($memory, 0, strlen($memory) - 1);
}
return false;
}
static public function setMemoryLimit($minimumMemoryLimit)
{
$currentValue = self::getMemoryLimitValue();
if( ($currentValue === false
|| $currentValue < $minimumMemoryLimit )
&& @ini_set('memory_limit', $minimumMemoryLimit.'M'))
{
return true;
}
return false;
}
static public function raiseMemoryLimitIfNecessary()
{
$minimumMemoryLimit = Zend_Registry::get('config')->General->minimumMemoryLimit;
if(self::getMemoryLimitValue() < $minimumMemoryLimit)
{
return self::setMemoryLimit($minimumMemoryLimit);
}
return false;
}
static public function log($message = '')
{
Zend_Registry::get('logger_message')->log($message);
Zend_Registry::get('logger_message')->log( "<br>" . PHP_EOL);
}
static public function error($message = '')
{
trigger_error($message, E_USER_ERROR);
}
/**
* Display the message in a nice red font with a nice icon
* ... and dies
*/
static public function exitWithErrorMessage( $message )
{
print("<style> a { color:red } </style>
<div style='color:red;font-family:Georgia;font-size:120%'>
<p><img src='themes/default/images/error_medium.png' style='vertical-align:middle; float:left;padding:20 20 20 20'>
$message
</p></div>"
);
exit;
}
/**
* Computes the division of i1 by i2. If either i1 or i2 are not number, or if i2 has a value of zero
* we return 0 to avoid the division by zero.
*
* @param numeric $i1
* @param numeric $i2
* @return numeric The result of the division or zero
*/
static public function secureDiv( $i1, $i2 )
{
if ( is_numeric($i1) && is_numeric($i2) && floatval($i2) != 0)
{
return $i1 / $i2;
}
return 0;
}
static public function getQueryCount()
{
$profiler = Zend_Registry::get('db')->getProfiler();
return $profiler->getTotalNumQueries();
}
static public function getDbElapsedSecs()
{
$profiler = Zend_Registry::get('db')->getProfiler();
return $profiler->getTotalElapsedSecs();
}
static public function printQueryCount()
{
$totalTime = self::getDbElapsedSecs();
$queryCount = self::getQueryCount();
Piwik::log("Total queries = $queryCount (total sql time = ".round($totalTime,2)."s)");
}
static public function printSqlProfilingReportLogStats( $db = null )
{
function maxSumMsFirst($a,$b)
{
return $a['sum_time_ms'] < $b['sum_time_ms'];
}
if(is_null($db))
{
$db = Zend_Registry::get('db');
$tableName = Piwik::prefixTable('log_profiling');
}
else
{
$tableName = $db->prefixTable('log_profiling');
}
$all = $db->fetchAll(' SELECT *, sum_time_ms / count as avg_time_ms
FROM '.$tableName );
if($all === false)
{
return;
}
usort($all, 'maxSumMsFirst');
$infoIndexedByQuery = array();
foreach($all as $infoQuery)
{
$query = $infoQuery['query'];
$count = $infoQuery['count'];
$sum_time_ms = $infoQuery['sum_time_ms'];
$infoIndexedByQuery[$query] = array('count' => $count, 'sumTimeMs' => $sum_time_ms);
}
Piwik::getSqlProfilingQueryBreakdownOutput($infoIndexedByQuery);
}
/**
* Outputs SQL Profiling reports
* It is automatically called when enabling the SQL profiling in the config file enable_sql_profiler
*
*/
static function printSqlProfilingReportZend()
{
$profiler = Zend_Registry::get('db')->getProfiler();
if(!$profiler->getEnabled())
{
throw new Exception("To display the profiler you should enable enable_sql_profiler on your config/config.ini.php file");
}
$infoIndexedByQuery = array();
foreach($profiler->getQueryProfiles() as $query)
{
if(isset($infoIndexedByQuery[$query->getQuery()]))
{
$existing = $infoIndexedByQuery[$query->getQuery()];
}
else
{
$existing = array( 'count' => 0, 'sumTimeMs' => 0);
}
$new = array( 'count' => $existing['count'] + 1,
'sumTimeMs' => $existing['count'] + $query->getElapsedSecs() * 1000);
$infoIndexedByQuery[$query->getQuery()] = $new;
}
function sortTimeDesc($a,$b)
{
return $a['sumTimeMs'] < $b['sumTimeMs'];
}
uasort( $infoIndexedByQuery, 'sortTimeDesc');
Piwik::log('<hr><b>SQL Profiler</b>');
Piwik::log('<hr><b>Summary</b>');
$totalTime = $profiler->getTotalElapsedSecs();
$queryCount = $profiler->getTotalNumQueries();
$longestTime = 0;
$longestQuery = null;
foreach ($profiler->getQueryProfiles() as $query) {
if ($query->getElapsedSecs() > $longestTime) {
$longestTime = $query->getElapsedSecs();
$longestQuery = $query->getQuery();
}
}
$str = 'Executed ' . $queryCount . ' queries in ' . round($totalTime,3) . ' seconds' . "\n";
$str .= '(Average query length: ' . round($totalTime / $queryCount,3) . ' seconds)' . "\n";
$str .= '<br>Queries per second: ' . round($queryCount / $totalTime,1) . "\n";
$str .= '<br>Longest query length: ' . round($longestTime,3) . " seconds (<code>$longestQuery</code>) \n";
Piwik::log($str);
Piwik::getSqlProfilingQueryBreakdownOutput($infoIndexedByQuery);
}
static private function getSqlProfilingQueryBreakdownOutput( $infoIndexedByQuery )
{
Piwik::log('<hr><b>Breakdown by query</b>');
$output = '';
foreach($infoIndexedByQuery as $query => $queryInfo)
{
$timeMs = round($queryInfo['sumTimeMs'],1);
$count = $queryInfo['count'];
$avgTimeString = '';
if($count > 1)
{
$avgTimeMs = $timeMs / $count;
$avgTimeString = " (average = <b>". round($avgTimeMs,1) . "ms</b>)";
}
$query = str_replace(array("\t","\n","\r\n","\r"), "_toberemoved_", $query);
$query = str_replace('_toberemoved__toberemoved_','',$query);
$query = str_replace('_toberemoved_', ' ',$query);
$output .= "Executed <b>$count</b> time". ($count==1?'':'s') ." in <b>".$timeMs."ms</b> $avgTimeString <pre>\t$query</pre>";
}
Piwik::log($output);
}
static public function printTimer()
{
echo Zend_Registry::get('timer');
}
static public function printMemoryUsage( $prefixString = null )
{
$memory = false;
if(function_exists('xdebug_memory_usage'))
{
$memory = xdebug_memory_usage();
}
elseif(function_exists('memory_get_usage'))
{
$memory = memory_get_usage();
}
if($memory !== false)
{
$usage = round( $memory / 1024 / 1024, 2);
if(!is_null($prefixString))
{
Piwik::log($prefixString);
}
Piwik::log("Memory usage = $usage Mb");
Piwik::log();
}
else
{
Piwik::log("Memory usage function not found.");
}
}
static public function isNumeric($value)
{
return !is_array($value) && ereg('^([-]{0,1}[0-9]{1,}[.]{0,1}[0-9]*)$', $value);
}
static public function getRandomTitle()
{
$titles = array( 'Web analytics',
'Website analytics',
'Analytics',
'Web analytics api',
'Open source analytics',
'Open source web analytics',
'Free analytics',
'Analytics software',
'Free web analytics',
'Free web statistics',
'Web 2.0 analytics',
'Web analytic',
'Web statistics',
'Web stats',
'Web 2.0 stats',
'Statistics web 2.0',
);
$id = abs(intval(md5(substr(Piwik_Url::getCurrentHost(),7))));
$title = $titles[ $id % count($titles)];
return $title;
}
static public function loadPlugins()
{
Piwik_PluginsManager::getInstance()->setLanguageToLoad( Piwik_Translate::getInstance()->getLanguageToLoad() );
Piwik_PluginsManager::getInstance()->setPluginsToLoad( Zend_Registry::get('config')->Plugins->Plugins->toArray() );
}
static public function terminateLoadPlugins()
{
Piwik_PluginsManager::getInstance()->installLoadedPlugins();
}
static public function getTableCreateSql( $tableName )
{
$tables = Piwik::getTablesCreateSql();
if(!isset($tables[$tableName]))
{
throw new Exception("The table '$tableName' SQL creation code couldn't be found.");
}
return $tables[$tableName];
}
static public function getTablesCreateSql()
{
$config = Zend_Registry::get('config');
$prefixTables = $config->database->tables_prefix;
$tables = array(
'user' => "CREATE TABLE {$prefixTables}user (
login VARCHAR(20) NOT NULL,
password CHAR(32) NOT NULL,
alias VARCHAR(45) NOT NULL,
email VARCHAR(100) NOT NULL,
token_auth CHAR(32) NOT NULL,
date_registered TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY(login),
UNIQUE INDEX uniq_keytoken(token_auth)
)
",
'access' => "CREATE TABLE {$prefixTables}access (
login VARCHAR(20) NOT NULL,
idsite INTEGER UNSIGNED NOT NULL,
access VARCHAR(10) NULL,
PRIMARY KEY(login, idsite)
)
",
'site' => "CREATE TABLE {$prefixTables}site (
idsite INTEGER(10) UNSIGNED NOT NULL AUTO_INCREMENT,
name VARCHAR(90) NOT NULL,
main_url VARCHAR(255) NOT NULL,
ts_created TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY(idsite)
)
",
'site_url' => "CREATE TABLE {$prefixTables}site_url (
idsite INTEGER(10) UNSIGNED NOT NULL,
url VARCHAR(255) NOT NULL,
PRIMARY KEY(idsite, url)
)
",
'logger_message' => "CREATE TABLE {$prefixTables}logger_message (
idlogger_message INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
timestamp TIMESTAMP NULL,
message TEXT NULL,
PRIMARY KEY(idlogger_message)
)
",
'logger_api_call' => "CREATE TABLE {$prefixTables}logger_api_call (
idlogger_api_call INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
class_name VARCHAR(255) NULL,
method_name VARCHAR(255) NULL,
parameter_names_default_values TEXT NULL,
parameter_values TEXT NULL,
execution_time FLOAT NULL,
caller_ip BIGINT NULL,
timestamp TIMESTAMP NULL,
returned_value TEXT NULL,
PRIMARY KEY(idlogger_api_call)
)
",
'logger_error' => "CREATE TABLE {$prefixTables}logger_error (
idlogger_error INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
timestamp TIMESTAMP NULL,
message TEXT NULL,
errno INTEGER UNSIGNED NULL,
errline INTEGER UNSIGNED NULL,
errfile VARCHAR(255) NULL,
backtrace TEXT NULL,
PRIMARY KEY(idlogger_error)
)
",
'logger_exception' => "CREATE TABLE {$prefixTables}logger_exception (
idlogger_exception INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
timestamp TIMESTAMP NULL,
message TEXT NULL,
errno INTEGER UNSIGNED NULL,
errline INTEGER UNSIGNED NULL,
errfile VARCHAR(255) NULL,
backtrace TEXT NULL,
PRIMARY KEY(idlogger_exception)
)
",
'log_action' => "CREATE TABLE {$prefixTables}log_action (
idaction INTEGER(10) UNSIGNED NOT NULL AUTO_INCREMENT,
name VARCHAR(255) NOT NULL,
type TINYINT UNSIGNED NULL,
PRIMARY KEY(idaction)
)
",
'log_visit' => "CREATE TABLE {$prefixTables}log_visit (
idvisit INTEGER(10) UNSIGNED NOT NULL AUTO_INCREMENT,
idsite INTEGER(10) UNSIGNED NOT NULL,
visitor_localtime TIME NOT NULL,
visitor_idcookie CHAR(32) NOT NULL,
visitor_returning TINYINT(1) NOT NULL,
visit_first_action_time DATETIME NOT NULL,
visit_last_action_time DATETIME NOT NULL,
visit_server_date DATE NOT NULL,
visit_exit_idaction INTEGER(11) NOT NULL,
visit_entry_idaction INTEGER(11) NOT NULL,
visit_total_actions SMALLINT(5) UNSIGNED NOT NULL,
visit_total_time SMALLINT(5) UNSIGNED NOT NULL,
referer_type INTEGER UNSIGNED NULL,
referer_name VARCHAR(70) NULL,
referer_url TEXT NOT NULL,
referer_keyword VARCHAR(255) NULL,
config_md5config CHAR(32) NOT NULL,
config_os CHAR(3) NOT NULL,
config_browser_name VARCHAR(10) NOT NULL,
config_browser_version VARCHAR(20) NOT NULL,
config_resolution VARCHAR(9) NOT NULL,
config_color_depth TINYINT(2) UNSIGNED NOT NULL,
config_pdf TINYINT(1) NOT NULL,
config_flash TINYINT(1) NOT NULL,
config_java TINYINT(1) NOT NULL,
config_director TINYINT(1) NOT NULL,
config_quicktime TINYINT(1) NOT NULL,
config_realplayer TINYINT(1) NOT NULL,
config_windowsmedia TINYINT(1) NOT NULL,
config_cookie TINYINT(1) NOT NULL,
location_ip BIGINT(11) NOT NULL,
location_browser_lang VARCHAR(20) NOT NULL,
location_country CHAR(3) NOT NULL,
location_continent CHAR(3) NOT NULL,
PRIMARY KEY(idvisit)
)
",
'log_link_visit_action' => "CREATE TABLE {$prefixTables}log_link_visit_action (
idlink_va INTEGER(11) NOT NULL AUTO_INCREMENT,
idvisit INTEGER(10) UNSIGNED NOT NULL,
idaction INTEGER(10) UNSIGNED NOT NULL,
idaction_ref INTEGER(11) UNSIGNED NOT NULL,
time_spent_ref_action INTEGER(10) UNSIGNED NOT NULL,
PRIMARY KEY(idlink_va)
)
",
'log_profiling' => "CREATE TABLE {$prefixTables}log_profiling (
query TEXT NOT NULL,
count INTEGER UNSIGNED NULL,
sum_time_ms FLOAT NULL,
UNIQUE INDEX query(query(100))
)
",
'archive_numeric' => "CREATE TABLE {$prefixTables}archive_numeric (
idarchive INTEGER UNSIGNED NOT NULL,
name VARCHAR(255) NOT NULL,
idsite INTEGER UNSIGNED NULL,
date1 DATE NULL,
date2 DATE NULL,
period TINYINT UNSIGNED NULL,
ts_archived DATETIME NULL,
value FLOAT NULL,
PRIMARY KEY(idarchive, name)
)
",
'archive_blob' => "CREATE TABLE {$prefixTables}archive_blob (
idarchive INTEGER UNSIGNED NOT NULL,
name VARCHAR(255) NOT NULL,
idsite INTEGER UNSIGNED NULL,
date1 DATE NULL,
date2 DATE NULL,
period TINYINT UNSIGNED NULL,
ts_archived DATETIME NULL,
value MEDIUMBLOB NULL,
PRIMARY KEY(idarchive, name)
)
",
);
return $tables;
}
static public function getCurrentUserLogin()
{
return Zend_Registry::get('access')->getIdentity();
}
static public function isUserIsSuperUserOrTheUser( $theUser )
{
try{
self::checkUserIsSuperUserOrTheUser( $theUser );
return true;
} catch( Exception $e){
return false;
}
}
// Accessible either to the user itself
static public function checkUserIsSuperUserOrTheUser( $theUser )
{
try{
if( Piwik::getCurrentUserLogin() !== $theUser)
{
// or to the super user
Piwik::checkUserIsSuperUser();
}
} catch( Piwik_Access_NoAccessException $e){
throw new Piwik_Access_NoAccessException("The user has to be either the Super User or the user '$theUser' itself.");
}
}
static public function isUserIsSuperUser()
{
try{
self::checkUserIsSuperUser();
return true;
} catch( Exception $e){
return false;
}
}
static public function setUserIsSuperUser()
{
Zend_Registry::get('access')->setSuperUser();
}
static public function checkUserIsSuperUser()
{
Zend_Registry::get('access')->checkUserIsSuperUser();
}
static public function isUserHasAdminAccess( $idSites )
{
try{
self::checkUserHasAdminAccess( $idSites );
return true;
} catch( Exception $e){
return false;
}
}
static public function checkUserHasAdminAccess( $idSites )
{
Zend_Registry::get('access')->checkUserHasAdminAccess( $idSites );
}
static public function isUserHasSomeAdminAccess()
{
try{
self::checkUserHasSomeAdminAccess();
return true;
} catch( Exception $e){
return false;
}
}
static public function checkUserHasSomeAdminAccess()
{
Zend_Registry::get('access')->checkUserHasSomeAdminAccess();
}
static public function isUserHasViewAccess( $idSites )
{
try{
self::checkUserHasViewAccess( $idSites );
return true;
} catch( Exception $e){
return false;
}
}
static public function checkUserHasViewAccess( $idSites )
{
Zend_Registry::get('access')->checkUserHasViewAccess( $idSites );
}
static public function prefixClass( $class )
{
if(substr_count($class, Piwik::CLASSES_PREFIX) > 0)
{
return $class;
}
return Piwik::CLASSES_PREFIX.$class;
}
static public function unprefixClass( $class )
{
$lenPrefix = strlen(Piwik::CLASSES_PREFIX);
if(substr($class, 0, $lenPrefix) == Piwik::CLASSES_PREFIX)
{
return substr($class, $lenPrefix);
}
return $class;
}
/**
* returns false if the URL to redirect to is already this URL
*/
static public function redirectToModule( $newModule, $newAction = '' )
{
$currentModule = Piwik_Common::getRequestVar('module', '', 'string');
$currentAction = Piwik_Common::getRequestVar('action', '', 'string');
if($currentModule != $newModule
|| $currentAction != $newAction )
{
$newUrl = Piwik_URL::getCurrentUrlWithoutQueryString()
. Piwik_Url::getCurrentQueryStringWithParametersModified(
array('module' => $newModule, 'action' => $newAction)
);
Piwik_Url::redirectToUrl($newUrl);
}
return false;
}
static public function prefixTable( $table )
{
$config = Zend_Registry::get('config');
$prefixTables = $config->database->tables_prefix;
return $prefixTables . $table;
}
/**
* Names of all the prefixed tables in piwik
* Doesn't use the DB
*/
static public function getTablesNames()
{
$aTables = array_keys(self::getTablesCreateSql());
$config = Zend_Registry::get('config');
$prefixTables = $config->database->tables_prefix;
$return = array();
foreach($aTables as $table)
{
$return[] = $prefixTables.$table;
}
return $return;
}
static $tablesInstalled = null;
static public function getTablesInstalled( $forceReload = true )
{
if(is_null(self::$tablesInstalled)
|| $forceReload === true)
{
$db = Zend_Registry::get('db');
$config = Zend_Registry::get('config');
$prefixTables = $config->database->tables_prefix;
$allTables = $db->fetchCol("SHOW TABLES");
// all the tables to be installed
$allMyTables = self::getTablesNames();
// we get the intersection between all the tables in the DB and the tables to be installed
$tablesInstalled = array_intersect($allMyTables, $allTables);
// at this point we have only the piwik tables which is good
// but we still miss the piwik generated tables (using the class Piwik_TablePartitioning)
$allArchiveNumeric = $db->fetchCol("SHOW TABLES LIKE '".$prefixTables."archive_numeric%'");
$allArchiveBlob = $db->fetchCol("SHOW TABLES LIKE '".$prefixTables."archive_blob%'");
$allTablesReallyInstalled = array_merge($tablesInstalled, $allArchiveNumeric, $allArchiveBlob);
self::$tablesInstalled = $allTablesReallyInstalled;
}
return self::$tablesInstalled;
}
static public function createDatabase()
{
$db = Zend_Registry::get('db');
$dbName = Zend_Registry::get('config')->database->dbname;
$db->query("CREATE DATABASE IF NOT EXISTS ".$dbName);
}
static public function dropDatabase()
{
$db = Zend_Registry::get('db');
$dbName = Zend_Registry::get('config')->database->dbname;
$db->query("DROP DATABASE IF EXISTS ".$dbName);
}
static public function createDatabaseObject( $dbInfos = null )
{
$config = Zend_Registry::get('config');
if(is_null($dbInfos))
{
$dbInfos = $config->database->toArray();
}
if(!isset($dbInfos['password']))
{
$dbInfos['password'] = '';
}
// test with the password ='][{}!3456&&^#gegq"eQ for example
if(substr($dbInfos['password'],0,1) == '"'
&& substr($dbInfos['password'],-1,1) == '"'
&& strlen($dbInfos['password']) >= 2 )
{
$dbInfos['password'] = substr($dbInfos['password'], 1, -1);
}
$dbInfos['password'] = htmlspecialchars_decode($dbInfos['password']);
$dbInfos['profiler'] = $config->Debug->enable_sql_profiler;
$db = Zend_Db::factory($config->database->adapter, $dbInfos);
$db->getConnection();
// see http://framework.zend.com/issues/browse/ZF-1398
$db->getConnection()->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
$db->getConnection()->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, true);
Zend_Db_Table::setDefaultAdapter($db);
$db->resetConfigArray(); // we don't want this information to appear in the logs
Zend_Registry::set('db', $db);
}
static public function createLogObject()
{
require_once "Log/APICall.php";
require_once "Log/Exception.php";
require_once "Log/Error.php";
require_once "Log/Message.php";
$configAPI = Zend_Registry::get('config')->log;
$aLoggers = array(
'logger_api_call' => new Piwik_Log_APICall,
'logger_exception' => new Piwik_Log_Exception,
'logger_error' => new Piwik_Log_Error,
'logger_message' => new Piwik_Log_Message,
);
foreach($configAPI as $loggerType => $aRecordTo)
{
if(isset($aLoggers[$loggerType]))
{
$logger = $aLoggers[$loggerType];
foreach($aRecordTo as $recordTo)
{
switch($recordTo)
{
case 'screen':
$logger->addWriteToScreen();
break;
case 'database':
$logger->addWriteToDatabase();
break;
case 'file':
$logger->addWriteToFile();
break;
default:
throw new Exception("TODO");
break;
}
}
}
}
foreach($aLoggers as $loggerType =>$logger)
{
if($logger->getWritersCount() == 0)
{
$logger->addWriteToNull();
}
Zend_Registry::set($loggerType, $logger);
}
}
static public function createConfigObject( $pathConfigFile = null )
{
$config = new Piwik_Config($pathConfigFile);
}
static public function dropTables( $doNotDelete = array() )
{
$tablesAlreadyInstalled = self::getTablesInstalled();
$db = Zend_Registry::get('db');
$doNotDeletePattern = "(".implode("|",$doNotDelete).")";
foreach($tablesAlreadyInstalled as $tableName)
{
if( count($doNotDelete) == 0
|| (!in_array($tableName,$doNotDelete)
&& !ereg($doNotDeletePattern,$tableName)
)
)
{
$db->query("DROP TABLE $tableName");
}
}
}
/**
* Returns true if the email is a valid email
*
* @param string email
* @return bool
*/
static public function isValidEmailString( $email )
{
return (preg_match('/^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.-]+\.[a-zA-Z]{2,4}$/', $email) > 0);
}
/**
* Creates an entry in the User table for the "anonymous" user.
*
* @return void
*/
static public function createAnonymousUser()
{
// The anonymous user is the user that is assigned by default
// note that the token_auth value is anonymous, which is assigned by default as well in the Login plugin
$db = Zend_Registry::get('db');
$db->query("INSERT INTO ". Piwik::prefixTable("user") . "
VALUES ( 'anonymous', '', 'anonymous', 'anonymous@example.org', 'anonymous', CURRENT_TIMESTAMP );" );
}
static public function createTablesIndex()
{
$db = Zend_Registry::get('db');
$prefixTables = Zend_Registry::get('config')->database->tables_prefix;
$db->query('CREATE INDEX index_idvisit ON '.$prefixTables.'log_link_visit_action (idvisit)');
$db->query('CREATE INDEX index_idaction ON '.$prefixTables.'log_action (idaction)');
$db->query('CREATE INDEX index_idsite ON '.$prefixTables.'log_visit (idsite)');
$db->query('CREATE INDEX index_visit_server_date ON '.$prefixTables.'log_visit (visit_server_date);');
}
static public function createTables()
{
$db = Zend_Registry::get('db');
$config = Zend_Registry::get('config');
$prefixTables = $config->database->tables_prefix;
//Piwik::log("Creating ". implode(", ", self::getTablesNames()));
$tablesToCreate = self::getTablesCreateSql();
unset($tablesToCreate['archive_blob']);
unset($tablesToCreate['archive_numeric']);
$tablesAlreadyInstalled = self::getTablesInstalled();
foreach($tablesToCreate as $tableName => $tableSql)
{
$tableName = $prefixTables . $tableName;
// if the table doesn't exist already
if(!in_array($tableName, $tablesAlreadyInstalled))
{
$db->query( $tableSql );
}
}
}
static public function install()
{
// create directories
Piwik::mkdir(Zend_Registry::get('config')->smarty->compile_dir);
Piwik::mkdir(Zend_Registry::get('config')->smarty->cache_dir);
}
static public function uninstall()
{
// delete tables
$db = Zend_Registry::get('db');
$db->query( "DROP TABLE IF EXISTS ". implode(", ", self::getTablesNames()) );
}
}
|