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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @category Piwik
* @package Piwik
*/
/**
* @see core/Option.php
*/
require_once PIWIK_INCLUDE_PATH . '/core/Option.php';
/**
* Load and execute all relevant, incremental update scripts for Piwik core and plugins, and bump the component version numbers for completed updates.
*
* @package Piwik
* @subpackage Piwik_Updater
* @see Piwik_iUpdate
*/
class Piwik_Updater
{
const INDEX_CURRENT_VERSION = 0;
const INDEX_NEW_VERSION = 1;
public $pathUpdateFileCore;
public $pathUpdateFilePlugins;
private $componentsToCheck = array();
public function __construct()
{
$this->pathUpdateFileCore = PIWIK_INCLUDE_PATH . '/core/Updates/';
$this->pathUpdateFilePlugins = PIWIK_INCLUDE_PATH . '/plugins/%s/Updates/';
}
/**
* Add component to check
*
* @param string $name
* @param string $version
*/
public function addComponentToCheck($name, $version)
{
$this->componentsToCheck[$name] = $version;
}
/**
* Record version of successfully completed component update
*
* @param string $name
* @param string $version
*/
public function recordComponentSuccessfullyUpdated($name, $version)
{
try {
Piwik_SetOption($this->getNameInOptionTable($name), $version, $autoload = 1);
} catch(Exception $e) {
// case when the option table is not yet created (before 0.2.10)
}
}
/**
* Returns the flag name to use in the option table to record current schema version
* @param string $name
* @return string
*/
private function getNameInOptionTable($name)
{
return 'version_'.$name;
}
/**
* Returns a list of components (core | plugin) that need to run through the upgrade process.
*
* @return array( componentName => array( file1 => version1, [...]), [...])
*/
public function getComponentsWithUpdateFile()
{
$this->componentsWithNewVersion = $this->loadComponentsWithNewVersion();
$this->componentsWithUpdateFile = $this->loadComponentsWithUpdateFile();
return $this->componentsWithUpdateFile;
}
/**
* Component has a new version?
*
* @param string $componentName
* @return bool TRUE if compoment is to be updated; FALSE if not
*/
public function hasNewVersion($componentName)
{
return isset($this->componentsWithNewVersion) &&
isset($this->componentsWithNewVersion[$componentName]);
}
/**
* Returns the list of SQL queries that would be executed during the update
*
* @return array of SQL queries
*/
public function getSqlQueriesToExecute()
{
$queries = array();
foreach($this->componentsWithUpdateFile as $componentName => $componentUpdateInfo)
{
foreach($componentUpdateInfo as $file => $fileVersion)
{
require_once $file; // prefixed by PIWIK_INCLUDE_PATH
$className = $this->getUpdateClassName($componentName, $fileVersion);
if(class_exists($className, false))
{
$queriesForComponent = call_user_func( array($className, 'getSql'));
foreach($queriesForComponent as $query => $error) {
$queries[] = $query.';';
}
}
}
// unfortunately had to extract this query from the Piwik_Option class
$queries[] = 'UPDATE '.Piwik_Common::prefixTable('option').'
SET option_value = "' .$fileVersion.'"
WHERE option_name = "'. $this->getNameInOptionTable($componentName).'";';
}
return $queries;
}
private function getUpdateClassName($componentName, $fileVersion)
{
$suffix = strtolower(str_replace(array('-','.'), '_', $fileVersion));
if($componentName == 'core')
{
return 'Piwik_Updates_' . $suffix;
}
return 'Piwik_'. $componentName .'_Updates_' . $suffix;
}
/**
* Update the named component
*
* @param string $componentName 'core', or plugin name
* @return array of warning strings if applicable
*/
public function update($componentName)
{
$warningMessages = array();
foreach($this->componentsWithUpdateFile[$componentName] as $file => $fileVersion)
{
try {
require_once $file; // prefixed by PIWIK_INCLUDE_PATH
$className = $this->getUpdateClassName($componentName, $fileVersion);
if(class_exists($className, false))
{
call_user_func( array($className, 'update') );
}
$this->recordComponentSuccessfullyUpdated($componentName, $fileVersion);
} catch( Piwik_Updater_UpdateErrorException $e) {
throw $e;
} catch( Exception $e) {
$warningMessages[] = $e->getMessage();
}
}
// to debug, create core/Updates/X.php, update the core/Version.php, throw an Exception in the try, and comment the following line
$this->recordComponentSuccessfullyUpdated($componentName, $this->componentsWithNewVersion[$componentName][self::INDEX_NEW_VERSION]);
return $warningMessages;
}
/**
* Construct list of update files for the outdated components
*
* @return array( componentName => array( file1 => version1, [...]), [...])
*/
private function loadComponentsWithUpdateFile()
{
$componentsWithUpdateFile = array();
foreach($this->componentsWithNewVersion as $name => $versions)
{
$currentVersion = $versions[self::INDEX_CURRENT_VERSION];
$newVersion = $versions[self::INDEX_NEW_VERSION];
if($name == 'core')
{
$pathToUpdates = $this->pathUpdateFileCore . '*.php';
}
else
{
$pathToUpdates = sprintf($this->pathUpdateFilePlugins, $name) . '*.php';
}
$files = glob( $pathToUpdates );
if($files === false)
{
$files = array();
}
foreach( $files as $file)
{
$fileVersion = basename($file, '.php');
if(version_compare($currentVersion, $fileVersion) == -1)
{
$componentsWithUpdateFile[$name][$file] = $fileVersion;
}
}
if(isset($componentsWithUpdateFile[$name]))
{
// order the update files by version asc
uasort($componentsWithUpdateFile[$name], "version_compare");
}
else
{
// there are no update file => nothing to do, update to the new version is successful
$this->recordComponentSuccessfullyUpdated($name, $newVersion);
}
}
return $componentsWithUpdateFile;
}
/**
* Construct list of outdated components
*
* @return array array( componentName => array( oldVersion, newVersion), [...])
*/
private function loadComponentsWithNewVersion()
{
$componentsToUpdate = array();
// we make sure core updates are processed before any plugin updates
if(isset($this->componentsToCheck['core']))
{
$coreVersions = $this->componentsToCheck['core'];
unset($this->componentsToCheck['core']);
$this->componentsToCheck = array_merge( array('core' => $coreVersions), $this->componentsToCheck);
}
foreach($this->componentsToCheck as $name => $version)
{
try {
$currentVersion = Piwik_GetOption('version_'.$name);
} catch( Exception $e) {
// mysql error 1146: table doesn't exist
if(Zend_Registry::get('db')->isErrNo($e, '1146'))
{
// case when the option table is not yet created (before 0.2.10)
$currentVersion = false;
}
else
{
// failed for some other reason
throw $e;
}
}
if($currentVersion === false)
{
if($name === 'core')
{
$currentVersion = '0.2.9';
}
else
{
$currentVersion = '0.0.1';
}
$this->recordComponentSuccessfullyUpdated($name, $currentVersion);
}
$versionCompare = version_compare($currentVersion, $version);
if($versionCompare == -1)
{
$componentsToUpdate[$name] = array(
self::INDEX_CURRENT_VERSION => $currentVersion,
self::INDEX_NEW_VERSION => $version
);
}
else if($versionCompare == 1)
{
// the version in the DB is newest.. we choose to ignore (for the time being)
}
}
return $componentsToUpdate;
}
/**
* Performs database update(s)
*
* @param string $file Update script filename
* @param array $sqlarray An array of SQL queries to be executed
*/
static function updateDatabase($file, $sqlarray)
{
foreach($sqlarray as $update => $ignoreError)
{
try {
Piwik_Exec( $update );
} catch(Exception $e) {
if(($ignoreError === false)
|| !Zend_Registry::get('db')->isErrNo($e, $ignoreError))
{
$message = $file .":\nError trying to execute the query '". $update ."'.\nThe error was: ". $e->getMessage();
throw new Piwik_Updater_UpdateErrorException($message);
}
}
}
}
}
/**
* Exception thrown by updater if a non-recoverable error occurs
*
* @package Piwik
* @subpackage Piwik_Updater
*/
class Piwik_Updater_UpdateErrorException extends Exception {}
|