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
|
<?php
require_once "Option.php";
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/';
}
/**
* @param string $name
* @param string $version
* @return void
*/
public function addComponentToCheck($name, $version)
{
$this->componentsToCheck[$name] = $version;
}
/**
* @param string $name
* @param string $version
* @return void
*/
public function recordComponentSuccessfullyUpdated($name, $version)
{
try {
Piwik_UpdateOption('version_'.$name, $version, $autoload = 1);
} catch(Exception $e) {
// case when the option table is not yet created (before 0.2.10)
}
}
/**
* Returns a list of components (core | plugin) that need to run through the upgrade process.
*
* @return array( componentName => array( updateFile1, [...]), [...])
*/
public function getComponentsWithUpdateFile()
{
$this->componentsWithNewVersion = $this->loadComponentsWithNewVersion();
$this->componentsWithUpdateFile = $this->loadComponentsWithUpdateFile();
return $this->componentsWithUpdateFile;
}
/**
* @param string $name
* @return array of warning strings if applicable
*/
public function update($name)
{
$warningMessages = array();
foreach($this->componentsWithUpdateFile[$name] as $file)
{
try {
require_once $file;
} catch( 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($name, $this->componentsWithNewVersion[$name][self::INDEX_NEW_VERSION]);
return $warningMessages;
}
/**
* @return array array( componentName => array( file1, [...]), [...])
*/
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 . '*';
}
else
{
$pathToUpdates = sprintf($this->pathUpdateFilePlugins, $name) . '*';
}
foreach( glob( $pathToUpdates ) as $file)
{
$fileVersion = basename($file, '.php');
if(version_compare($currentVersion, $fileVersion) == -1)
{
$componentsWithUpdateFile[$name][] = $file;
}
}
if(isset($componentsWithUpdateFile[$name]))
{
// order the update files by version asc
usort($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;
}
/**
* @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) {
// case when the option table is not yet created (before 0.2.10)
$currentVersion = false;
}
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;
}
}
class UpdateErrorException extends Exception {}
|
