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
|
<?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\CoreUpdater\Commands;
use Piwik\Config;
use Piwik\Db;
use Piwik\DbHelper;
use Piwik\Piwik;
use Piwik\Plugin\ConsoleCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
/**
* @package CoreUpdater
*/
class ConvertToUtf8mb4 extends ConsoleCommand
{
protected function configure()
{
$this->setName('core:convert-to-utf8mb4');
$this->setDescription('Converts the database to utf8mb4');
$this->addOption('show', null, InputOption::VALUE_NONE, Piwik::translate('Show all commands / queries only.'));
$this->addOption('yes', null, InputOption::VALUE_NONE, Piwik::translate('CoreUpdater_ConsoleParameterDescription'));
$this->addOption('keep-tracking', null, InputOption::VALUE_NONE, 'Do not disable tracking while conversion is running');
}
public function isEnabled()
{
$dbSettings = new Db\Settings();
$charset = $dbSettings->getUsedCharset();
return $charset !== 'utf8mb4';
}
/**
* Execute command like: ./console core:convert-to-utf8mb4 --yes
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$yes = $input->getOption('yes');
$keepTracking = $input->getOption('keep-tracking');
$show = $input->getOption('show');
$queries = DbHelper::getUtf8mb4ConversionQueries();
if ($show) {
$this->showCommands($queries, $keepTracking, $output);
return;
}
$output->writeln("This command will convert all Matomo database tables to utf8mb4.\n");
if (DbHelper::getDefaultCharset() !== 'utf8mb4') {
$this->writeSuccessMessage($output, array('Your database does not support utf8mb4'));
return;
}
if (!$keepTracking) {
$output->writeln("Tracking will be disabled during this process.\n");
}
$output->writeln('If you want to see what this command is going to do use the --show option.');
if (!$yes) {
$yes = $this->askForUpdateConfirmation($input, $output);
}
if ($yes) {
$config = Config::getInstance();
if (!$keepTracking) {
$output->writeln("\n" . Piwik::translate('Disabling Matomo Tracking'));
$config->Tracker['record_statistics'] = '0';
$config->forceSave();
}
$output->writeln("\n" . Piwik::translate('CoreUpdater_ConsoleStartingDbUpgrade'));
try {
foreach ($queries as $query) {
$output->write("\n" . 'Executing ' . $query . '... ');
Db::get()->exec($query);
$output->write(' done.');
}
$output->writeln("\n" . 'Updating used database charset in config.ini.php.');
$config->database['charset'] = 'utf8mb4';
} finally {
if (!$keepTracking) {
$output->writeln("\n" . Piwik::translate('Enabling Matomo Tracking'));
$config->Tracker['record_statistics'] = '1';
}
$config->forceSave();
}
$this->writeSuccessMessage($output, array('Conversion to utf8mb4 successful.'));
} else {
$this->writeSuccessMessage($output, array('Database conversion skipped.'));
}
}
protected function showCommands($queries, $keepTracking, OutputInterface $output)
{
$output->writeln("To manually convert all Matomo database tables to utf8mb4 follow these steps.");
if (!$keepTracking) {
$output->writeln('');
$output->writeln('** Disable Matomo Tracking with this command: **');
$output->writeln('./console config:set --section=Tracker --key=record_statistics --value=0');
}
$output->writeln('');
$output->writeln('** Execute the following database queries: **');
$output->writeln(implode("\n", $queries));
$output->writeln('');
$output->writeln('** Change configured database charset to utf8mb4 with this command: **');
$output->writeln('./console config:set --section=database --key=charset --value=utf8mb4');
if (!$keepTracking) {
$output->writeln('');
$output->writeln('** Enable Matomo Tracking again with this command: **');
$output->writeln('./console config:set --section=Tracker --key=record_statistics --value=1');
}
}
private function askForUpdateConfirmation(InputInterface $input, OutputInterface $output)
{
$helper = $this->getHelper('question');
$question = new ConfirmationQuestion('<comment>Execute updates? (y/N) </comment>', false);
return $helper->ask($input, $output, $question);
}
}
|
