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
|
<?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\Updates;
use Piwik\DataAccess\TableMetadata;
use Piwik\Date;
use Piwik\DbHelper;
use Piwik\Plugin\Manager;
use Piwik\Plugins\CoreHome\Columns\VisitorSecondsSinceFirst;
use Piwik\Plugins\CoreHome\Columns\VisitorSecondsSinceOrder;
use Piwik\Plugins\UsersManager\Model;
use Piwik\Common;
use Piwik\Config;
use Piwik\Plugins\UserCountry\LocationProvider;
use Piwik\Plugins\VisitorInterest\Columns\VisitorSecondsSinceLast;
use Piwik\Updater;
use Piwik\Updates as PiwikUpdates;
use Piwik\Updater\Migration\Factory as MigrationFactory;
/**
* Update for version 4.0.0-b1.
*/
class Updates_4_0_0_b1 extends PiwikUpdates
{
/**
* @var MigrationFactory
*/
private $migration;
public function __construct(MigrationFactory $factory)
{
$this->migration = $factory;
}
public function getMigrations(Updater $updater)
{
$tableMetadata = new TableMetadata();
$columnsToAdd = [];
$migrations = [];
$migrations[] = $this->migration->db->changeColumnType('log_action', 'name', 'VARCHAR(4096)');
$migrations[] = $this->migration->db->changeColumnType('log_conversion', 'url', 'VARCHAR(4096)');
$migrations[] = $this->migration->db->dropColumn('log_visit', 'config_gears');
$migrations[] = $this->migration->db->dropColumn('log_visit', 'config_director');
$migrations[] = $this->migration->db->changeColumn('log_link_visit_action', 'interaction_position', 'pageview_position', 'MEDIUMINT UNSIGNED DEFAULT NULL');
/** APP SPECIFIC TOKEN START */
$migrations[] = $this->migration->db->createTable('user_token_auth', array(
'idusertokenauth' => 'BIGINT UNSIGNED NOT NULL AUTO_INCREMENT',
'login' => 'VARCHAR(100) NOT NULL',
'description' => 'VARCHAR('.Model::MAX_LENGTH_TOKEN_DESCRIPTION.') NOT NULL',
'password' => 'VARCHAR(191) NOT NULL',
'system_token' => 'TINYINT(1) NOT NULL DEFAULT 0',
'hash_algo' => 'VARCHAR(30) NOT NULL',
'last_used' => 'DATETIME NULL',
'date_created' => ' DATETIME NOT NULL',
'date_expired' => ' DATETIME NULL',
), 'idusertokenauth');
$migrations[] = $this->migration->db->addUniqueKey('user_token_auth', 'password', 'uniq_password');
$migrations[] = $this->migration->db->dropIndex('user', 'uniq_keytoken');
$userModel = new Model();
foreach ($userModel->getUsers(array()) as $user) {
if (!empty($user['token_auth'])) {
$migrations[] = $this->migration->db->insert('user_token_auth', array(
'login' => $user['login'],
'description' => 'Created by Matomo 4 migration',
'password' => $userModel->hashTokenAuth($user['token_auth']),
'date_created' => Date::now()->getDatetime()
));
}
}
$migrations[] = $this->migration->db->dropColumn('user', 'alias');
$migrations[] = $this->migration->db->dropColumn('user', 'token_auth');
/** APP SPECIFIC TOKEN END */
$customTrackerPluginActive = false;
if (in_array('CustomPiwikJs', Config::getInstance()->Plugins['Plugins'])) {
$customTrackerPluginActive = true;
}
$migrations[] = $this->migration->plugin->activate('BulkTracking');
$migrations[] = $this->migration->plugin->deactivate('CustomPiwikJs');
$migrations[] = $this->migration->plugin->uninstall('CustomPiwikJs');
if ($customTrackerPluginActive) {
$migrations[] = $this->migration->plugin->activate('CustomJsTracker');
}
// Prepare all installed tables for utf8mb4 conversions. e.g. make some indexed fields smaller so they don't exceed the maximum key length
$allTables = DbHelper::getTablesInstalled();
$migrations[] = $this->migration->db->changeColumnType('session', 'id', 'VARCHAR(191)');
$migrations[] = $this->migration->db->changeColumnType('site_url', 'url', 'VARCHAR(190)');
$migrations[] = $this->migration->db->changeColumnType('option', 'option_name', 'VARCHAR(191)');
foreach ($allTables as $table) {
if (preg_match('/archive_/', $table) == 1) {
$tableNameUnprefixed = Common::unprefixTable($table);
$migrations[] = $this->migration->db->changeColumnType($tableNameUnprefixed, 'name', 'VARCHAR(190)');
}
}
// Move the site search fields of log_visit out of custom variables into their own fields
$columnsToAdd['log_link_visit_action']['search_cat'] = 'VARCHAR(200) NULL';
$columnsToAdd['log_link_visit_action']['search_count'] = 'INTEGER(10) UNSIGNED NULL';
// replace days to ... dimensions w/ seconds dimensions
foreach (['log_visit', 'log_conversion'] as $table) {
$columnsToAdd[$table]['visitor_seconds_since_first'] = VisitorSecondsSinceFirst::COLUMN_TYPE;
$columnsToAdd[$table]['visitor_seconds_since_order'] = VisitorSecondsSinceOrder::COLUMN_TYPE;
}
$columnsToAdd['log_visit']['visitor_seconds_since_last'] = VisitorSecondsSinceLast::COLUMN_TYPE;
$columnsToMaybeAdd = ['revenue', 'revenue_discount', 'revenue_shipping', 'revenue_subtotal', 'revenue_tax'];
$columnsLogConversion = $tableMetadata->getColumns(Common::prefixTable('log_conversion'));
foreach ($columnsToMaybeAdd as $columnToMaybeAdd) {
if (!in_array($columnToMaybeAdd, $columnsLogConversion, true)) {
$columnsToAdd['log_conversion'][$columnToMaybeAdd] = 'DOUBLE NULL DEFAULT NULL';
}
}
foreach ($columnsToAdd as $table => $columns) {
$migrations[] = $this->migration->db->addColumns($table, $columns);
foreach ($columns as $columnName => $columnType) {
$optionKey = 'version_' . $table . '.' . $columnName;
$optionValue = $columnType;
if ($table == 'log_visit' && isset($columnsToAdd['log_conversion'][$columnName])) {
$optionValue .= '1'; // column is in log_conversion too
}
$migrations[] = $this->migration->db->sql("INSERT IGNORE INTO `" . Common::prefixTable('option')
. "` (option_name, option_value) VALUES ('$optionKey', '$optionValue')");
}
}
if (Manager::getInstance()->isPluginInstalled('CustomVariables')) {
$visitActionTable = Common::prefixTable('log_link_visit_action');
$migrations[] = $this->migration->db->sql("UPDATE $visitActionTable SET search_cat = custom_var_v4 WHERE custom_var_k4 = '_pk_scat'");
$migrations[] = $this->migration->db->sql("UPDATE $visitActionTable SET search_count = custom_var_v5 WHERE custom_var_k5 = '_pk_scount'");
}
if ($this->usesGeoIpLegacyLocationProvider()) {
// activate GeoIp2 plugin for users still using GeoIp2 Legacy (others might have it disabled on purpose)
$migrations[] = $this->migration->plugin->activate('GeoIp2');
}
// remove old options
$migrations[] = $this->migration->db->sql('DELETE FROM `' . Common::prefixTable('option') . '` WHERE option_name IN ("geoip.updater_period", "geoip.loc_db_url", "geoip.isp_db_url", "geoip.org_db_url")');
// init seconds_to_... columns
$logVisitColumns = $tableMetadata->getColumns(Common::prefixTable('log_visit'));
$hasDaysColumnInVisit = in_array('visitor_days_since_first', $logVisitColumns);
$logConvColumns = $tableMetadata->getColumns(Common::prefixTable('log_conversion'));
$hasDaysColumnInConv = in_array('visitor_days_since_first', $logConvColumns);
if ($hasDaysColumnInVisit && $hasDaysColumnInConv) {
$migrations[] = $this->migration->db->sql("UPDATE " . Common::prefixTable('log_visit')
. " SET visitor_seconds_since_first = visitor_days_since_first * 86400,
visitor_seconds_since_order = visitor_days_since_order * 86400,
visitor_seconds_since_last = visitor_days_since_last * 86400");
}
if ($hasDaysColumnInConv) {
$migrations[] = $this->migration->db->sql("UPDATE " . Common::prefixTable('log_conversion')
. " SET visitor_seconds_since_first = visitor_days_since_first * 86400,
visitor_seconds_since_order = visitor_days_since_order * 86400");
}
// remove old days_to_... columns
$migrations[] = $this->migration->db->dropColumn('log_visit', 'visitor_days_since_first');
$migrations[] = $this->migration->db->dropColumn('log_visit', 'visitor_days_since_order');
$migrations[] = $this->migration->db->dropColumn('log_visit', 'visitor_days_since_last');
$migrations[] = $this->migration->db->dropColumn('log_conversion', 'visitor_days_since_first');
$migrations[] = $this->migration->db->dropColumn('log_conversion', 'visitor_days_since_order');
$config = Config::getInstance();
if (!empty($config->mail['type']) && $config->mail['type'] === 'Crammd5') {
$migrations[] = $this->migration->config->set('mail', 'type', 'Cram-md5');
}
return $migrations;
}
public function doUpdate(Updater $updater)
{
$updater->executeMigrations(__FILE__, $this->getMigrations($updater));
if ($this->usesGeoIpLegacyLocationProvider()) {
// switch to default provider if GeoIp Legacy was still in use
LocationProvider::setCurrentProvider(LocationProvider\DefaultProvider::ID);
}
}
protected function usesGeoIpLegacyLocationProvider()
{
$currentProvider = LocationProvider::getCurrentProviderId();
return in_array($currentProvider, [
'geoip_pecl',
'geoip_php',
'geoip_serverbased',
]);
}
}
|