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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
use Exception;
use Piwik\Db\Schema;
use Piwik\DataAccess\ArchiveTableCreator;
/**
* Contains database related helper functions.
*/
class DbHelper
{
/**
* Get list of tables installed
*
* @param bool $forceReload Invalidate cache
* @return array Tables installed
*/
public static function getTablesInstalled($forceReload = true)
{
return Schema::getInstance()->getTablesInstalled($forceReload);
}
/**
* Get list of installed columns in a table
*
* @param string $tableName The name of a table.
*
* @return array Installed columns indexed by the column name.
*/
public static function getTableColumns($tableName)
{
return Schema::getInstance()->getTableColumns($tableName);
}
/**
* Creates a new table in the database.
*
* Example:
* ```
* $tableDefinition = "`age` INT(11) NOT NULL AUTO_INCREMENT,
* `name` VARCHAR(255) NOT NULL";
*
* DbHelper::createTable('tablename', $tableDefinition);
* ``
*
* @param string $nameWithoutPrefix The name of the table without any piwik prefix.
* @param string $createDefinition The table create definition
*
* @api
*/
public static function createTable($nameWithoutPrefix, $createDefinition)
{
Schema::getInstance()->createTable($nameWithoutPrefix, $createDefinition);
}
/**
* Returns true if Piwik is installed
*
* @since 0.6.3
*
* @return bool True if installed; false otherwise
*/
public static function isInstalled()
{
try {
return Schema::getInstance()->hasTables();
} catch (Exception $e) {
return false;
}
}
/**
* Truncate all tables
*/
public static function truncateAllTables()
{
Schema::getInstance()->truncateAllTables();
}
/**
* Creates an entry in the User table for the "anonymous" user.
*/
public static function createAnonymousUser()
{
Schema::getInstance()->createAnonymousUser();
}
/**
* Records the Matomo version a user used when installing this Matomo for the first time
*/
public static function recordInstallVersion()
{
Schema::getInstance()->recordInstallVersion();
}
/**
* Returns which Matomo version was used to install this Matomo for the first time.
*/
public static function getInstallVersion()
{
return Schema::getInstance()->getInstallVersion();
}
public static function wasMatomoInstalledBeforeVersion($version)
{
$installVersion = self::getInstallVersion();
if (empty($installVersion)) {
return true; // we assume yes it was installed
}
return true === version_compare($version, $installVersion, '>');
}
/**
* Create all tables
*/
public static function createTables()
{
Schema::getInstance()->createTables();
}
/**
* Drop database, used in tests
*/
public static function dropDatabase($dbName = null)
{
if (defined('PIWIK_TEST_MODE') && PIWIK_TEST_MODE) {
Schema::getInstance()->dropDatabase($dbName);
}
}
/**
* Check database connection character set is utf8.
*
* @return bool True if it is (or doesn't matter); false otherwise
*/
public static function isDatabaseConnectionUTF8()
{
return Db::get()->isConnectionUTF8();
}
/**
* Checks the database server version against the required minimum
* version.
*
* @see config/global.ini.php
* @since 0.4.4
* @throws Exception if server version is less than the required version
*/
public static function checkDatabaseVersion()
{
Db::get()->checkServerVersion();
}
/**
* Disconnect from database
*/
public static function disconnectDatabase()
{
Db::get()->closeConnection();
}
/**
* Create database
*
* @param string|null $dbName
*/
public static function createDatabase($dbName = null)
{
Schema::getInstance()->createDatabase($dbName);
}
/**
* Returns if the given table has an index with the given name
*
* @param string $table
* @param string $indexName
*
* @return bool
* @throws Exception
*/
public static function tableHasIndex($table, $indexName)
{
$result = Db::get()->fetchOne('SHOW INDEX FROM '.$table.' WHERE Key_name = ?', [$indexName]);
return !empty($result);
}
/**
* Get the SQL to create Piwik tables
*
* @return array array of strings containing SQL
*/
public static function getTablesCreateSql()
{
return Schema::getInstance()->getTablesCreateSql();
}
/**
* Get the SQL to create a specific Piwik table
*
* @param string $tableName Unprefixed table name.
* @return string SQL
*/
public static function getTableCreateSql($tableName)
{
return Schema::getInstance()->getTableCreateSql($tableName);
}
/**
* Deletes archive tables. For use in tests.
*/
public static function deleteArchiveTables()
{
foreach (ArchiveTableCreator::getTablesArchivesInstalled() as $table) {
Log::debug("Dropping table $table");
Db::query("DROP TABLE IF EXISTS `$table`");
}
ArchiveTableCreator::refreshTableList($forceReload = true);
}
/**
* Adds a MAX_EXECUTION_TIME hint into a SELECT query if $limit is bigger than 1
*
* @param string $sql query to add hint to
* @param int $limit time limit in seconds
* @return string
*/
public static function addMaxExecutionTimeHintToQuery($sql, $limit)
{
if ($limit <= 0) {
return $sql;
}
$sql = trim($sql);
$pos = stripos($sql, 'SELECT');
if ($pos !== false) {
$timeInMs = $limit * 1000;
$timeInMs = (int) $timeInMs;
$maxExecutionTimeHint = ' /*+ MAX_EXECUTION_TIME('.$timeInMs.') */ ';
$sql = substr_replace($sql, 'SELECT ' . $maxExecutionTimeHint, $pos, strlen('SELECT'));
}
return $sql;
}
/**
* Returns true if the string is a valid database name for MySQL. MySQL allows + in the database names.
* Database names that start with a-Z or 0-9 and contain a-Z, 0-9, underscore(_), dash(-), plus(+), and dot(.) will be accepted.
* File names beginning with anything but a-Z or 0-9 will be rejected (including .htaccess for example).
* File names containing anything other than above mentioned will also be rejected (file names with spaces won't be accepted).
*
* @param string $dbname
* @return bool
*/
public static function isValidDbname($dbname)
{
return (0 !== preg_match('/(^[a-zA-Z0-9]+([a-zA-Z0-9\_\.\-\+]*))$/D', $dbname));
}
}
|