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
|
<?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 PluginsFunctions
*/
namespace Piwik;
use Exception;
use Piwik\Db\Adapter;
use Piwik\Tracker;
/**
* SQL wrapper
*
* @package PluginsFunctions
* @api
*/
class Db
{
private static $connection = null;
/**
* Returns the database adapter to use
*
* @return \Piwik\Tracker\Db|\Piwik\Db\AdapterInterface|\Piwik\Db
*/
static public function get()
{
if (!empty($GLOBALS['PIWIK_TRACKER_MODE'])) {
return Tracker::getDatabase();
}
if (self::$connection === null) {
self::createDatabaseObject();
}
return self::$connection;
}
/**
* Create database object and connect to database
* @param array|null $dbInfos
*/
public static function createDatabaseObject($dbInfos = null)
{
$config = Config::getInstance();
if (is_null($dbInfos)) {
$dbInfos = $config->database;
}
/**
* This event is triggered before a connection to the database is established. Use it to dynamically change the
* datatabase settings defined in the config. The reporting database config is used in case someone accesses
* the Piwik UI.
*/
Piwik_PostEvent('Reporting.getDatabaseConfig', array(&$dbInfos));
$dbInfos['profiler'] = $config->Debug['enable_sql_profiler'];
$db = null;
/**
* This event is triggered after the database config is loaded but immediately before a connection to the
* database is established. Use this event to create your own database handler instead of the default Piwik
* DB handler.
*/
Piwik_PostEvent('Reporting.createDatabase', array(&$db));
if (is_null($db)) {
$adapter = $dbInfos['adapter'];
$db = @Adapter::factory($adapter, $dbInfos);
}
self::$connection = $db;
}
/**
* Executes an unprepared SQL query on the DB. Recommended for DDL statements, e.g., CREATE/DROP/ALTER.
* The return result is DBMS-specific. For MySQLI, it returns the number of rows affected. For PDO, it returns the Zend_Db_Statement object
* If you want to fetch data from the DB you should use the function Db::fetchAll()
*
* @param string $sql SQL Query
* @throws \Exception
* @return integer|\Zend_Db_Statement
*/
static public function exec($sql)
{
/** @var \Zend_Db_Adapter_Abstract $db */
$db = self::get();
$profiler = $db->getProfiler();
$q = $profiler->queryStart($sql, \Zend_Db_Profiler::INSERT);
try {
$return = self::get()->exec($sql);
} catch (Exception $ex) {
self::logExtraInfoIfDeadlock($ex);
throw $ex;
}
$profiler->queryEnd($q);
return $return;
}
/**
* Executes a SQL query on the DB and returns the Zend_Db_Statement object
* If you want to fetch data from the DB you should use the function Db::fetchAll()
*
* See also http://framework.zend.com/manual/en/zend.db.statement.html
*
* @param string $sql SQL Query
* @param array $parameters Parameters to bind in the query, array( param1 => value1, param2 => value2)
* @throws \Exception
* @return \Zend_Db_Statement
*/
static public function query($sql, $parameters = array())
{
try {
return self::get()->query($sql, $parameters);
} catch (Exception $ex) {
self::logExtraInfoIfDeadlock($ex);
throw $ex;
}
}
/**
* Executes the SQL Query and fetches all the rows from the database query
*
* @param string $sql SQL Query
* @param array $parameters Parameters to bind in the query, array( param1 => value1, param2 => value2)
* @throws \Exception
* @return array (one row in the array per row fetched in the DB)
*/
static public function fetchAll($sql, $parameters = array())
{
try {
return self::get()->fetchAll($sql, $parameters);
} catch (Exception $ex) {
self::logExtraInfoIfDeadlock($ex);
throw $ex;
}
}
/**
* Fetches first row of result from the database query
*
* @param string $sql SQL Query
* @param array $parameters Parameters to bind in the query, array( param1 => value1, param2 => value2)
* @return array
* @throws \Exception
*/
static public function fetchRow($sql, $parameters = array())
{
try {
return self::get()->fetchRow($sql, $parameters);
} catch (Exception $ex) {
self::logExtraInfoIfDeadlock($ex);
throw $ex;
}
}
/**
* Fetches first column of first row of result from the database query
*
* @param string $sql SQL Query
* @param array $parameters Parameters to bind in the query, array( param1 => value1, param2 => value2)
* @return string
* @throws \Exception
*/
static public function fetchOne($sql, $parameters = array())
{
try {
return self::get()->fetchOne($sql, $parameters);
} catch (Exception $ex) {
self::logExtraInfoIfDeadlock($ex);
throw $ex;
}
}
/**
* Fetches result from the database query as an array of associative arrays.
*
* @param string $sql SQL query
* @param array $parameters Parameters to bind in the query, array( param1 => value1, param2 => value2)
* @return array
* @throws \Exception
*/
static public function fetchAssoc($sql, $parameters = array())
{
try {
return self::get()->fetchAssoc($sql, $parameters);
} catch (Exception $ex) {
self::logExtraInfoIfDeadlock($ex);
throw $ex;
}
}
/**
* Deletes all desired rows in a table, while using a limit. This function will execute a
* DELETE query until there are no more rows to delete.
*
* @param string $table The name of the table to delete from. Must be prefixed.
* @param string $where The where clause of the query. Must include the WHERE keyword.
* @param $orderBy
* @param int $maxRowsPerQuery The maximum number of rows to delete per DELETE query.
* @param array $parameters Parameters to bind in the query.
* @return int The total number of rows deleted.
*/
static public function deleteAllRows($table, $where, $orderBy, $maxRowsPerQuery = 100000, $parameters = array())
{
$sql = "DELETE FROM $table
$where
ORDER BY $orderBy ASC
LIMIT " . (int)$maxRowsPerQuery;
// delete rows w/ a limit
$totalRowsDeleted = 0;
do {
$rowsDeleted = self::query($sql, $parameters)->rowCount();
$totalRowsDeleted += $rowsDeleted;
} while ($rowsDeleted >= $maxRowsPerQuery);
return $totalRowsDeleted;
}
/**
* Runs an OPTIMIZE TABLE query on the supplied table or tables. The table names must be prefixed.
*
* @param string|array $tables The name of the table to optimize or an array of tables to optimize.
* @return \Zend_Db_Statement
*/
static public function optimizeTables($tables)
{
$optimize = Config::getInstance()->General['enable_sql_optimize_queries'];
if (empty($optimize)) {
return;
}
if (empty($tables)) {
return false;
}
if (!is_array($tables)) {
$tables = array($tables);
}
// filter out all InnoDB tables
$nonInnoDbTables = array();
foreach (Db::fetchAll("SHOW TABLE STATUS") as $row) {
if (strtolower($row['Engine']) != 'innodb'
&& in_array($row['Name'], $tables)
) {
$nonInnoDbTables[] = $row['Name'];
}
}
if (empty($nonInnoDbTables)) {
return false;
}
// optimize the tables
return self::query("OPTIMIZE TABLE " . implode(',', $nonInnoDbTables));
}
/**
* Drops the supplied table or tables. The table names must be prefixed.
*
* @param string|array $tables The name of the table to drop or an array of table names to drop.
* @return \Zend_Db_Statement
*/
static public function dropTables($tables)
{
if (!is_array($tables)) {
$tables = array($tables);
}
return self::query("DROP TABLE " . implode(',', $tables));
}
/**
* Locks the supplied table or tables. The table names must be prefixed.
*
* @param string|array $tablesToRead The table or tables to obtain 'read' locks on.
* @param string|array $tablesToWrite The table or tables to obtain 'write' locks on.
* @return \Zend_Db_Statement
*/
static public function lockTables($tablesToRead, $tablesToWrite = array())
{
if (!is_array($tablesToRead)) {
$tablesToRead = array($tablesToRead);
}
if (!is_array($tablesToWrite)) {
$tablesToWrite = array($tablesToWrite);
}
$lockExprs = array();
foreach ($tablesToWrite as $table) {
$lockExprs[] = $table . " WRITE";
}
foreach ($tablesToRead as $table) {
$lockExprs[] = $table . " READ";
}
return self::exec("LOCK TABLES " . implode(', ', $lockExprs));
}
/**
* Releases all table locks.
*
* @return \Zend_Db_Statement
*/
static public function unlockAllTables()
{
return self::exec("UNLOCK TABLES");
}
/**
* Performs a SELECT on a table one chunk at a time and returns the first
* fetched value.
*
* This function will break up a SELECT into several smaller SELECTs and
* should be used when performing a SELECT that can take a long time to finish.
* Using several smaller SELECTs will ensure that the table will not be locked
* for too long.
*
* @param string $sql The SQL to perform. The last two conditions of the WHERE
* expression must be as follows: 'id >= ? AND id < ?' where
* 'id' is the int id of the table.
* @param int $first The minimum ID to loop from.
* @param int $last The maximum ID to loop to.
* @param int $step The maximum number of rows to scan in each smaller SELECT.
* @param array $params Parameters to bind in the query, array( param1 => value1, param2 => value2)
*
* @return string
*/
static public function segmentedFetchFirst($sql, $first, $last, $step, $params = array())
{
$result = false;
if ($step > 0) {
for ($i = $first; $result === false && $i <= $last; $i += $step) {
$result = self::fetchOne($sql, array_merge($params, array($i, $i + $step)));
}
} else {
for ($i = $first; $result === false && $i >= $last; $i += $step) {
$result = self::fetchOne($sql, array_merge($params, array($i, $i + $step)));
}
}
return $result;
}
/**
* Performs a SELECT on a table one chunk at a time and returns an array
* of every fetched value.
*
* This function will break up a SELECT into several smaller SELECTs and
* should be used when performing a SELECT that can take a long time to finish.
* Using several smaller SELECTs will ensure that the table will not be locked
* for too long.
*
*
* @param string $sql The SQL to perform. The last two conditions of the WHERE
* expression must be as follows: 'id >= ? AND id < ?' where
* 'id' is the int id of the table.
* @param int $first The minimum ID to loop from.
* @param int $last The maximum ID to loop to.
* @param int $step The maximum number of rows to scan in each smaller SELECT.
* @param array $params Parameters to bind in the query, array( param1 => value1, param2 => value2)
*
* @return array
*/
static public function segmentedFetchOne($sql, $first, $last, $step, $params = array())
{
$result = array();
if ($step > 0) {
for ($i = $first; $i <= $last; $i += $step) {
$result[] = self::fetchOne($sql, array_merge($params, array($i, $i + $step)));
}
} else {
for ($i = $first; $i >= $last; $i += $step) {
$result[] = self::fetchOne($sql, array_merge($params, array($i, $i + $step)));
}
}
return $result;
}
/**
* Performs a SELECT on a table one chunk at a time and returns an array
* of every fetched row.
*
* @param string $sql The SQL to perform. The last two conditions of the WHERE
* expression must be as follows: 'id >= ? AND id < ?' where
* 'id' is the int id of the table.
* @param int $first The minimum ID to loop from.
* @param int $last The maximum ID to loop to.
* @param int $step The maximum number of rows to scan in each smaller SELECT.
* @param array $params Parameters to bind in the query, array( param1 => value1, param2 => value2)
*
* @return array
*/
static public function segmentedFetchAll($sql, $first, $last, $step, $params = array())
{
$result = array();
if ($step > 0) {
for ($i = $first; $i <= $last; $i += $step) {
$currentParams = array_merge($params, array($i, $i + $step));
$result = array_merge($result, self::fetchAll($sql, $currentParams));
}
} else {
for ($i = $first; $i >= $last; $i += $step) {
$currentParams = array_merge($params, array($i, $i + $step));
$result = array_merge($result, self::fetchAll($sql, $currentParams));
}
}
return $result;
}
/**
* Performs a non-SELECT query on a table one chunk at a time.
*
* @param string $sql The SQL to perform. The last two conditions of the WHERE
* expression must be as follows: 'id >= ? AND id < ?' where
* 'id' is the int id of the table.
* @param int $first The minimum ID to loop from.
* @param int $last The maximum ID to loop to.
* @param int $step The maximum number of rows to scan in each smaller query.
* @param array $params Parameters to bind in the query, array( param1 => value1, param2 => value2)
*
* @return array
*/
static public function segmentedQuery($sql, $first, $last, $step, $params = array())
{
if ($step > 0) {
for ($i = $first; $i <= $last; $i += $step) {
$currentParams = array_merge($params, array($i, $i + $step));
self::query($sql, $currentParams);
}
} else {
for ($i = $first; $i >= $last; $i += $step) {
$currentParams = array_merge($params, array($i, $i + $step));
self::query($sql, $currentParams);
}
}
}
/**
* Attempts to get a named lock. This function uses a timeout of 1s, but will
* retry a set number of time.
*
* @param string $lockName The lock name.
* @param int $maxRetries The max number of times to retry.
* @return bool true if the lock was obtained, false if otherwise.
*/
static public function getDbLock($lockName, $maxRetries = 30)
{
/*
* the server (e.g., shared hosting) may have a low wait timeout
* so instead of a single GET_LOCK() with a 30 second timeout,
* we use a 1 second timeout and loop, to avoid losing our MySQL
* connection
*/
$sql = 'SELECT GET_LOCK(?, 1)';
$db = self::get();
while ($maxRetries > 0) {
if ($db->fetchOne($sql, array($lockName)) == '1') {
return true;
}
$maxRetries--;
}
return false;
}
/**
* Releases a named lock.
*
* @param string $lockName The lock name.
* @return bool true if the lock was released, false if otherwise.
*/
static public function releaseDbLock($lockName)
{
$sql = 'SELECT RELEASE_LOCK(?)';
$db = self::get();
return $db->fetchOne($sql, array($lockName)) == '1';
}
/**
* Cached result of isLockprivilegeGranted function.
*
* Public so tests can simulate the situation where the lock tables privilege isn't granted.
*
* @var bool
*/
public static $lockPrivilegeGranted = null;
/**
* Checks whether the database user is allowed to lock tables.
*
* @return bool
*/
public static function isLockPrivilegeGranted()
{
if (is_null(self::$lockPrivilegeGranted)) {
try {
Db::lockTables(Common::prefixTable('log_visit'));
Db::unlockAllTables();
self::$lockPrivilegeGranted = true;
} catch (Exception $ex) {
self::$lockPrivilegeGranted = false;
}
}
return self::$lockPrivilegeGranted;
}
private static function logExtraInfoIfDeadlock($ex)
{
if (self::get()->isErrNo($ex, 1213)) {
$deadlockInfo = self::fetchAll("SHOW ENGINE INNODB STATUS");
// log using exception so backtrace appears in log output
Log::debug(new Exception("Encountered deadlock: " . print_r($deadlockInfo, true)));
}
}
}
|