]>
Commit | Line | Data |
---|---|---|
1 | <?php | |
2 | ||
3 | /** | |
4 | * Class Updater. | |
5 | * Used to update stuff when a new Shaarli's version is reached. | |
6 | * Update methods are ran only once, and the stored in a JSON file. | |
7 | */ | |
8 | class Updater | |
9 | { | |
10 | /** | |
11 | * @var array Updates which are already done. | |
12 | */ | |
13 | protected $doneUpdates; | |
14 | ||
15 | /** | |
16 | * @var LinkDB instance. | |
17 | */ | |
18 | protected $linkDB; | |
19 | ||
20 | /** | |
21 | * @var ConfigManager $conf Configuration Manager instance. | |
22 | */ | |
23 | protected $conf; | |
24 | ||
25 | /** | |
26 | * @var bool True if the user is logged in, false otherwise. | |
27 | */ | |
28 | protected $isLoggedIn; | |
29 | ||
30 | /** | |
31 | * @var ReflectionMethod[] List of current class methods. | |
32 | */ | |
33 | protected $methods; | |
34 | ||
35 | /** | |
36 | * Object constructor. | |
37 | * | |
38 | * @param array $doneUpdates Updates which are already done. | |
39 | * @param LinkDB $linkDB LinkDB instance. | |
40 | * @param ConfigManager $conf Configuration Manager instance. | |
41 | * @param boolean $isLoggedIn True if the user is logged in. | |
42 | */ | |
43 | public function __construct($doneUpdates, $linkDB, $conf, $isLoggedIn) | |
44 | { | |
45 | $this->doneUpdates = $doneUpdates; | |
46 | $this->linkDB = $linkDB; | |
47 | $this->conf = $conf; | |
48 | $this->isLoggedIn = $isLoggedIn; | |
49 | ||
50 | // Retrieve all update methods. | |
51 | $class = new ReflectionClass($this); | |
52 | $this->methods = $class->getMethods(); | |
53 | } | |
54 | ||
55 | /** | |
56 | * Run all new updates. | |
57 | * Update methods have to start with 'updateMethod' and return true (on success). | |
58 | * | |
59 | * @return array An array containing ran updates. | |
60 | * | |
61 | * @throws UpdaterException If something went wrong. | |
62 | */ | |
63 | public function update() | |
64 | { | |
65 | $updatesRan = array(); | |
66 | ||
67 | // If the user isn't logged in, exit without updating. | |
68 | if ($this->isLoggedIn !== true) { | |
69 | return $updatesRan; | |
70 | } | |
71 | ||
72 | if ($this->methods === null) { | |
73 | throw new UpdaterException('Couldn\'t retrieve Updater class methods.'); | |
74 | } | |
75 | ||
76 | foreach ($this->methods as $method) { | |
77 | // Not an update method or already done, pass. | |
78 | if (! startsWith($method->getName(), 'updateMethod') | |
79 | || in_array($method->getName(), $this->doneUpdates) | |
80 | ) { | |
81 | continue; | |
82 | } | |
83 | ||
84 | try { | |
85 | $method->setAccessible(true); | |
86 | $res = $method->invoke($this); | |
87 | // Update method must return true to be considered processed. | |
88 | if ($res === true) { | |
89 | $updatesRan[] = $method->getName(); | |
90 | } | |
91 | } catch (Exception $e) { | |
92 | throw new UpdaterException($method, $e); | |
93 | } | |
94 | } | |
95 | ||
96 | $this->doneUpdates = array_merge($this->doneUpdates, $updatesRan); | |
97 | ||
98 | return $updatesRan; | |
99 | } | |
100 | ||
101 | /** | |
102 | * @return array Updates methods already processed. | |
103 | */ | |
104 | public function getDoneUpdates() | |
105 | { | |
106 | return $this->doneUpdates; | |
107 | } | |
108 | ||
109 | /** | |
110 | * Move deprecated options.php to config.php. | |
111 | * | |
112 | * Milestone 0.9 (old versioning) - shaarli/Shaarli#41: | |
113 | * options.php is not supported anymore. | |
114 | */ | |
115 | public function updateMethodMergeDeprecatedConfigFile() | |
116 | { | |
117 | if (is_file($this->conf->get('resource.data_dir') . '/options.php')) { | |
118 | include $this->conf->get('resource.data_dir') . '/options.php'; | |
119 | ||
120 | // Load GLOBALS into config | |
121 | $allowedKeys = array_merge(ConfigPhp::$ROOT_KEYS); | |
122 | $allowedKeys[] = 'config'; | |
123 | foreach ($GLOBALS as $key => $value) { | |
124 | if (in_array($key, $allowedKeys)) { | |
125 | $this->conf->set($key, $value); | |
126 | } | |
127 | } | |
128 | $this->conf->write($this->isLoggedIn); | |
129 | unlink($this->conf->get('resource.data_dir').'/options.php'); | |
130 | } | |
131 | ||
132 | return true; | |
133 | } | |
134 | ||
135 | /** | |
136 | * Rename tags starting with a '-' to work with tag exclusion search. | |
137 | */ | |
138 | public function updateMethodRenameDashTags() | |
139 | { | |
140 | $linklist = $this->linkDB->filterSearch(); | |
141 | foreach ($linklist as $key => $link) { | |
142 | $link['tags'] = preg_replace('/(^| )\-/', '$1', $link['tags']); | |
143 | $link['tags'] = implode(' ', array_unique(LinkFilter::tagsStrToArray($link['tags'], true))); | |
144 | $this->linkDB[$key] = $link; | |
145 | } | |
146 | $this->linkDB->save($this->conf->get('resource.page_cache')); | |
147 | return true; | |
148 | } | |
149 | ||
150 | /** | |
151 | * Move old configuration in PHP to the new config system in JSON format. | |
152 | * | |
153 | * Will rename 'config.php' into 'config.save.php' and create 'config.json.php'. | |
154 | * It will also convert legacy setting keys to the new ones. | |
155 | */ | |
156 | public function updateMethodConfigToJson() | |
157 | { | |
158 | // JSON config already exists, nothing to do. | |
159 | if ($this->conf->getConfigIO() instanceof ConfigJson) { | |
160 | return true; | |
161 | } | |
162 | ||
163 | $configPhp = new ConfigPhp(); | |
164 | $configJson = new ConfigJson(); | |
165 | $oldConfig = $configPhp->read($this->conf->getConfigFile() . '.php'); | |
166 | rename($this->conf->getConfigFileExt(), $this->conf->getConfigFile() . '.save.php'); | |
167 | $this->conf->setConfigIO($configJson); | |
168 | $this->conf->reload(); | |
169 | ||
170 | $legacyMap = array_flip(ConfigPhp::$LEGACY_KEYS_MAPPING); | |
171 | foreach (ConfigPhp::$ROOT_KEYS as $key) { | |
172 | $this->conf->set($legacyMap[$key], $oldConfig[$key]); | |
173 | } | |
174 | ||
175 | // Set sub config keys (config and plugins) | |
176 | $subConfig = array('config', 'plugins'); | |
177 | foreach ($subConfig as $sub) { | |
178 | foreach ($oldConfig[$sub] as $key => $value) { | |
179 | if (isset($legacyMap[$sub .'.'. $key])) { | |
180 | $configKey = $legacyMap[$sub .'.'. $key]; | |
181 | } else { | |
182 | $configKey = $sub .'.'. $key; | |
183 | } | |
184 | $this->conf->set($configKey, $value); | |
185 | } | |
186 | } | |
187 | ||
188 | try{ | |
189 | $this->conf->write($this->isLoggedIn); | |
190 | return true; | |
191 | } catch (IOException $e) { | |
192 | error_log($e->getMessage()); | |
193 | return false; | |
194 | } | |
195 | } | |
196 | ||
197 | /** | |
198 | * Escape settings which have been manually escaped in every request in previous versions: | |
199 | * - general.title | |
200 | * - general.header_link | |
201 | * - redirector.url | |
202 | * | |
203 | * @return bool true if the update is successful, false otherwise. | |
204 | */ | |
205 | public function updateMethodEscapeUnescapedConfig() | |
206 | { | |
207 | try { | |
208 | $this->conf->set('general.title', escape($this->conf->get('general.title'))); | |
209 | $this->conf->set('general.header_link', escape($this->conf->get('general.header_link'))); | |
210 | $this->conf->set('redirector.url', escape($this->conf->get('redirector.url'))); | |
211 | $this->conf->write($this->isLoggedIn); | |
212 | } catch (Exception $e) { | |
213 | error_log($e->getMessage()); | |
214 | return false; | |
215 | } | |
216 | return true; | |
217 | } | |
218 | ||
219 | /** | |
220 | * Update the database to use the new ID system, which replaces linkdate primary keys. | |
221 | * Also, creation and update dates are now DateTime objects (done by LinkDB). | |
222 | * | |
223 | * Since this update is very sensitve (changing the whole database), the datastore will be | |
224 | * automatically backed up into the file datastore.<datetime>.php. | |
225 | * | |
226 | * LinkDB also adds the field 'shorturl' with the precedent format (linkdate smallhash), | |
227 | * which will be saved by this method. | |
228 | * | |
229 | * @return bool true if the update is successful, false otherwise. | |
230 | */ | |
231 | public function updateMethodDatastoreIds() | |
232 | { | |
233 | // up to date database | |
234 | if (isset($this->linkDB[0])) { | |
235 | return true; | |
236 | } | |
237 | ||
238 | $save = $this->conf->get('resource.data_dir') .'/datastore.'. date('YmdHis') .'.php'; | |
239 | copy($this->conf->get('resource.datastore'), $save); | |
240 | ||
241 | $links = array(); | |
242 | foreach ($this->linkDB as $offset => $value) { | |
243 | $links[] = $value; | |
244 | unset($this->linkDB[$offset]); | |
245 | } | |
246 | $links = array_reverse($links); | |
247 | $cpt = 0; | |
248 | foreach ($links as $l) { | |
249 | unset($l['linkdate']); | |
250 | $l['id'] = $cpt; | |
251 | $this->linkDB[$cpt++] = $l; | |
252 | } | |
253 | ||
254 | $this->linkDB->save($this->conf->get('resource.page_cache')); | |
255 | $this->linkDB->reorder(); | |
256 | ||
257 | return true; | |
258 | } | |
259 | ||
260 | /** | |
261 | * Initialize API settings: | |
262 | * - api.enabled: true | |
263 | * - api.secret: generated secret | |
264 | */ | |
265 | public function updateMethodApiSettings() | |
266 | { | |
267 | if ($this->conf->exists('api.secret')) { | |
268 | return true; | |
269 | } | |
270 | ||
271 | $this->conf->set('api.enabled', true); | |
272 | $this->conf->set( | |
273 | 'api.secret', | |
274 | generate_api_secret( | |
275 | $this->conf->get('credentials.login'), | |
276 | $this->conf->get('credentials.salt') | |
277 | ) | |
278 | ); | |
279 | $this->conf->write($this->isLoggedIn); | |
280 | return true; | |
281 | } | |
282 | ||
283 | /** | |
284 | * New setting: theme name. If the default theme is used, nothing to do. | |
285 | * | |
286 | * If the user uses a custom theme, raintpl_tpl dir is updated to the parent directory, | |
287 | * and the current theme is set as default in the theme setting. | |
288 | * | |
289 | * @return bool true if the update is successful, false otherwise. | |
290 | */ | |
291 | public function updateMethodDefaultTheme() | |
292 | { | |
293 | // raintpl_tpl isn't the root template directory anymore. | |
294 | // We run the update only if this folder still contains the template files. | |
295 | $tplDir = $this->conf->get('resource.raintpl_tpl'); | |
296 | $tplFile = $tplDir . '/linklist.html'; | |
297 | if (! file_exists($tplFile)) { | |
298 | return true; | |
299 | } | |
300 | ||
301 | $parent = dirname($tplDir); | |
302 | $this->conf->set('resource.raintpl_tpl', $parent); | |
303 | $this->conf->set('resource.theme', trim(str_replace($parent, '', $tplDir), '/')); | |
304 | $this->conf->write($this->isLoggedIn); | |
305 | ||
306 | // Dependency injection gore | |
307 | RainTPL::$tpl_dir = $tplDir; | |
308 | ||
309 | return true; | |
310 | } | |
311 | ||
312 | /** | |
313 | * Move the file to inc/user.css to data/user.css. | |
314 | * | |
315 | * Note: Due to hardcoded paths, it's not unit testable. But one line of code should be fine. | |
316 | * | |
317 | * @return bool true if the update is successful, false otherwise. | |
318 | */ | |
319 | public function updateMethodMoveUserCss() | |
320 | { | |
321 | if (! is_file('inc/user.css')) { | |
322 | return true; | |
323 | } | |
324 | ||
325 | return rename('inc/user.css', 'data/user.css'); | |
326 | } | |
327 | } | |
328 | ||
329 | /** | |
330 | * Class UpdaterException. | |
331 | */ | |
332 | class UpdaterException extends Exception | |
333 | { | |
334 | /** | |
335 | * @var string Method where the error occurred. | |
336 | */ | |
337 | protected $method; | |
338 | ||
339 | /** | |
340 | * @var Exception The parent exception. | |
341 | */ | |
342 | protected $previous; | |
343 | ||
344 | /** | |
345 | * Constructor. | |
346 | * | |
347 | * @param string $message Force the error message if set. | |
348 | * @param string $method Method where the error occurred. | |
349 | * @param Exception|bool $previous Parent exception. | |
350 | */ | |
351 | public function __construct($message = '', $method = '', $previous = false) | |
352 | { | |
353 | $this->method = $method; | |
354 | $this->previous = $previous; | |
355 | $this->message = $this->buildMessage($message); | |
356 | } | |
357 | ||
358 | /** | |
359 | * Build the exception error message. | |
360 | * | |
361 | * @param string $message Optional given error message. | |
362 | * | |
363 | * @return string The built error message. | |
364 | */ | |
365 | private function buildMessage($message) | |
366 | { | |
367 | $out = ''; | |
368 | if (! empty($message)) { | |
369 | $out .= $message . PHP_EOL; | |
370 | } | |
371 | ||
372 | if (! empty($this->method)) { | |
373 | $out .= 'An error occurred while running the update '. $this->method . PHP_EOL; | |
374 | } | |
375 | ||
376 | if (! empty($this->previous)) { | |
377 | $out .= ' '. $this->previous->getMessage(); | |
378 | } | |
379 | ||
380 | return $out; | |
381 | } | |
382 | } | |
383 | ||
384 | /** | |
385 | * Read the updates file, and return already done updates. | |
386 | * | |
387 | * @param string $updatesFilepath Updates file path. | |
388 | * | |
389 | * @return array Already done update methods. | |
390 | */ | |
391 | function read_updates_file($updatesFilepath) | |
392 | { | |
393 | if (! empty($updatesFilepath) && is_file($updatesFilepath)) { | |
394 | $content = file_get_contents($updatesFilepath); | |
395 | if (! empty($content)) { | |
396 | return explode(';', $content); | |
397 | } | |
398 | } | |
399 | return array(); | |
400 | } | |
401 | ||
402 | /** | |
403 | * Write updates file. | |
404 | * | |
405 | * @param string $updatesFilepath Updates file path. | |
406 | * @param array $updates Updates array to write. | |
407 | * | |
408 | * @throws Exception Couldn't write version number. | |
409 | */ | |
410 | function write_updates_file($updatesFilepath, $updates) | |
411 | { | |
412 | if (empty($updatesFilepath)) { | |
413 | throw new Exception('Updates file path is not set, can\'t write updates.'); | |
414 | } | |
415 | ||
416 | $res = file_put_contents($updatesFilepath, implode(';', $updates)); | |
417 | if ($res === false) { | |
418 | throw new Exception('Unable to write updates in '. $updatesFilepath . '.'); | |
419 | } | |
420 | } |