/
DatabaseAbilitiesCheck.php
181 lines (150 loc) · 6.62 KB
/
DatabaseAbilitiesCheck.php
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
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Diagnostics\Diagnostic;
use Piwik\Common;
use Piwik\Config;
use Piwik\Db;
use Piwik\DbHelper;
use Piwik\Translation\Translator;
/**
* Check if Piwik can use LOAD DATA INFILE.
*/
class DatabaseAbilitiesCheck implements Diagnostic
{
/**
* @var Translator
*/
private $translator;
public function __construct(Translator $translator)
{
$this->translator = $translator;
}
public function execute()
{
$isPiwikInstalling = !Config::getInstance()->existsLocalConfig();
if ($isPiwikInstalling) {
// Skip the diagnostic if Piwik is being installed
return array();
}
$result = new DiagnosticResult($this->translator->translate('Installation_DatabaseAbilities'));
$result->addItem($this->checkUtf8mb4Charset());
if (Config::getInstance()->General['enable_load_data_infile']) {
$result->addItem($this->checkLoadDataInfile());
}
$result->addItem($this->checkTemporaryTables());
$result->addItem($this->checkTransactionLevel());
return [$result];
}
protected function checkUtf8mb4Charset()
{
$dbSettings = new Db\Settings();
$charset = $dbSettings->getUsedCharset();
if (DbHelper::getDefaultCharset() === 'utf8mb4' && $charset === 'utf8mb4') {
return new DiagnosticResultItem(DiagnosticResult::STATUS_OK, 'UTF8mb4 charset');
}
if (DbHelper::getDefaultCharset() === 'utf8mb4') {
return new DiagnosticResultItem(
DiagnosticResult::STATUS_WARNING, 'UTF8mb4 charset<br/><br/>' .
$this->translator->translate('Diagnostics_DatabaseUtf8mb4CharsetAvailableButNotUsed', '<code>' . PIWIK_INCLUDE_PATH . '/console core:convert-to-utf8mb4</code>') .
'<br/><br/>' .
$this->translator->translate('Diagnostics_DatabaseUtf8Requirement', ['�', '<a href="https://matomo.org/faq/how-to-update/how-to-convert-the-database-to-utf8mb4-charset/" rel="noreferrer noopener" target="_blank">', '</a>']) .
'<br/>'
);
}
return new DiagnosticResultItem(
DiagnosticResult::STATUS_WARNING, 'UTF8mb4 charset<br/><br/>' .
$this->translator->translate('Diagnostics_DatabaseUtf8mb4CharsetRecommended') .
'<br/><br/>' .
$this->translator->translate('Diagnostics_DatabaseUtf8Requirement', ['�', '<a href="https://matomo.org/faq/how-to-update/how-to-convert-the-database-to-utf8mb4-charset/" rel="noreferrer noopener" target="_blank">', '</a>']) .
'<br/>'
);
}
protected function checkLoadDataInfile()
{
$optionTable = Common::prefixTable('option');
$testOptionNames = array('test_system_check1', 'test_system_check2');
$loadDataInfile = false;
$errorMessage = null;
try {
$loadDataInfile = Db\BatchInsert::tableInsertBatch(
$optionTable,
array('option_name', 'option_value'),
array(
array($testOptionNames[0], '1'),
array($testOptionNames[1], '2'),
),
$throwException = true,
$charset = 'latin1'
);
} catch (\Exception $ex) {
$errorMessage = str_replace("\n", "<br/>", $ex->getMessage());
}
// delete the temporary rows that were created
Db::exec("DELETE FROM `$optionTable` WHERE option_name IN ('" . implode("','", $testOptionNames) . "')");
if ($loadDataInfile) {
return new DiagnosticResultItem(DiagnosticResult::STATUS_OK, 'LOAD DATA INFILE');
}
$comment = sprintf(
'LOAD DATA INFILE<br/>%s<br/>%s',
$this->translator->translate('Installation_LoadDataInfileUnavailableHelp', array(
'LOAD DATA INFILE',
'FILE',
)),
$this->translator->translate('Installation_LoadDataInfileRecommended')
);
if ($errorMessage) {
$comment .= sprintf(
'<br/><strong>%s:</strong> %s<br/>%s',
$this->translator->translate('General_Error'),
$errorMessage,
'Troubleshooting: <a target="_blank" rel="noreferrer noopener" href="https://matomo.org/faq/troubleshooting/#faq_194">FAQ on matomo.org</a>'
);
}
return new DiagnosticResultItem(DiagnosticResult::STATUS_WARNING, $comment);
}
protected function checkTemporaryTables()
{
$status = DiagnosticResult::STATUS_OK;
$comment = 'CREATE TEMPORARY TABLES';
try {
// create a temporary table
Db::exec("CREATE TEMPORARY TABLE `piwik_test_table_temp` (
id INT,
val VARCHAR(5) NULL,
PRIMARY KEY (id)
)");
// insert an entry into the new temporary table
Db::exec('INSERT INTO `piwik_test_table_temp` (`id`, `val`) VALUES ("1", "val1");');
for ($i=0; $i < 5; $i++) {
// try reading the entry a few times to ensure it doesn't fail, which might be possible when using load balanced databases
$result = Db::fetchRow('SELECT * FROM `piwik_test_table_temp` WHERE `id` = 1');
if (empty($result)) {
throw new \Exception('read failed');
}
}
} catch (\Exception $e) {
$status = DiagnosticResult::STATUS_ERROR;
$comment .= '<br/>' . $this->translator->translate('Diagnostics_MysqlTemporaryTablesWarning');
$comment .= '<br/>Troubleshooting: <a target="_blank" rel="noreferrer noopener" href="https://matomo.org/faq/how-to-install/faq_23484/">FAQ on matomo.org</a>';
}
return new DiagnosticResultItem($status, $comment);
}
protected function checkTransactionLevel()
{
$status = DiagnosticResult::STATUS_OK;
$comment = 'Changing transaction isolation level';
$level = new Db\TransactionLevel(Db::getReader());
if (!$level->setUncommitted()) {
$status = DiagnosticResult::STATUS_WARNING;
$comment .= '<br/>' . $this->translator->translate('Diagnostics_MysqlTransactionLevel');
} else {
$level->restorePreviousStatus();
}
return new DiagnosticResultItem($status, $comment);
}
}