]>
Commit | Line | Data |
---|---|---|
510377d2 | 1 | <?php |
f24896b2 | 2 | |
bcf056c9 V |
3 | namespace Shaarli\Updater; |
4 | ||
bcf056c9 V |
5 | use Exception; |
6 | use RainTPL; | |
7 | use ReflectionClass; | |
8 | use ReflectionException; | |
9 | use ReflectionMethod; | |
dea72c71 | 10 | use Shaarli\ApplicationUtils; |
f24896b2 | 11 | use Shaarli\Bookmark\LinkDB; |
6696729b | 12 | use Shaarli\Bookmark\LinkFilter; |
3c66e564 | 13 | use Shaarli\Config\ConfigJson; |
fe83d45c | 14 | use Shaarli\Config\ConfigManager; |
bcf056c9 | 15 | use Shaarli\Config\ConfigPhp; |
f3d2f257 | 16 | use Shaarli\Exceptions\IOException; |
b302b3c5 | 17 | use Shaarli\Thumbnailer; |
bcf056c9 | 18 | use Shaarli\Updater\Exception\UpdaterException; |
510377d2 A |
19 | |
20 | /** | |
bcf056c9 | 21 | * Class updater. |
510377d2 A |
22 | * Used to update stuff when a new Shaarli's version is reached. |
23 | * Update methods are ran only once, and the stored in a JSON file. | |
24 | */ | |
25 | class Updater | |
26 | { | |
27 | /** | |
28 | * @var array Updates which are already done. | |
29 | */ | |
30 | protected $doneUpdates; | |
31 | ||
510377d2 A |
32 | /** |
33 | * @var LinkDB instance. | |
34 | */ | |
35 | protected $linkDB; | |
36 | ||
278d9ee2 A |
37 | /** |
38 | * @var ConfigManager $conf Configuration Manager instance. | |
39 | */ | |
40 | protected $conf; | |
41 | ||
510377d2 A |
42 | /** |
43 | * @var bool True if the user is logged in, false otherwise. | |
44 | */ | |
45 | protected $isLoggedIn; | |
46 | ||
28f26524 A |
47 | /** |
48 | * @var array $_SESSION | |
49 | */ | |
50 | protected $session; | |
51 | ||
510377d2 A |
52 | /** |
53 | * @var ReflectionMethod[] List of current class methods. | |
54 | */ | |
55 | protected $methods; | |
56 | ||
57 | /** | |
58 | * Object constructor. | |
59 | * | |
278d9ee2 A |
60 | * @param array $doneUpdates Updates which are already done. |
61 | * @param LinkDB $linkDB LinkDB instance. | |
7af9a418 | 62 | * @param ConfigManager $conf Configuration Manager instance. |
278d9ee2 | 63 | * @param boolean $isLoggedIn True if the user is logged in. |
28f26524 A |
64 | * @param array $session $_SESSION (by reference) |
65 | * | |
66 | * @throws ReflectionException | |
510377d2 | 67 | */ |
28f26524 | 68 | public function __construct($doneUpdates, $linkDB, $conf, $isLoggedIn, &$session = []) |
510377d2 A |
69 | { |
70 | $this->doneUpdates = $doneUpdates; | |
510377d2 | 71 | $this->linkDB = $linkDB; |
278d9ee2 | 72 | $this->conf = $conf; |
510377d2 | 73 | $this->isLoggedIn = $isLoggedIn; |
28f26524 | 74 | $this->session = &$session; |
510377d2 A |
75 | |
76 | // Retrieve all update methods. | |
77 | $class = new ReflectionClass($this); | |
78 | $this->methods = $class->getMethods(); | |
79 | } | |
80 | ||
81 | /** | |
82 | * Run all new updates. | |
83 | * Update methods have to start with 'updateMethod' and return true (on success). | |
84 | * | |
85 | * @return array An array containing ran updates. | |
86 | * | |
87 | * @throws UpdaterException If something went wrong. | |
88 | */ | |
89 | public function update() | |
90 | { | |
91 | $updatesRan = array(); | |
92 | ||
93 | // If the user isn't logged in, exit without updating. | |
94 | if ($this->isLoggedIn !== true) { | |
95 | return $updatesRan; | |
96 | } | |
97 | ||
ee6f4b64 | 98 | if ($this->methods === null) { |
bcf056c9 | 99 | throw new UpdaterException(t('Couldn\'t retrieve updater class methods.')); |
510377d2 A |
100 | } |
101 | ||
102 | foreach ($this->methods as $method) { | |
103 | // Not an update method or already done, pass. | |
bcf056c9 | 104 | if (!startsWith($method->getName(), 'updateMethod') |
510377d2 A |
105 | || in_array($method->getName(), $this->doneUpdates) |
106 | ) { | |
107 | continue; | |
108 | } | |
109 | ||
110 | try { | |
111 | $method->setAccessible(true); | |
112 | $res = $method->invoke($this); | |
113 | // Update method must return true to be considered processed. | |
114 | if ($res === true) { | |
115 | $updatesRan[] = $method->getName(); | |
116 | } | |
117 | } catch (Exception $e) { | |
118 | throw new UpdaterException($method, $e); | |
119 | } | |
120 | } | |
121 | ||
122 | $this->doneUpdates = array_merge($this->doneUpdates, $updatesRan); | |
123 | ||
124 | return $updatesRan; | |
125 | } | |
126 | ||
127 | /** | |
128 | * @return array Updates methods already processed. | |
129 | */ | |
130 | public function getDoneUpdates() | |
131 | { | |
132 | return $this->doneUpdates; | |
133 | } | |
134 | ||
135 | /** | |
136 | * Move deprecated options.php to config.php. | |
137 | * | |
138 | * Milestone 0.9 (old versioning) - shaarli/Shaarli#41: | |
139 | * options.php is not supported anymore. | |
140 | */ | |
141 | public function updateMethodMergeDeprecatedConfigFile() | |
142 | { | |
894a3c4b A |
143 | if (is_file($this->conf->get('resource.data_dir') . '/options.php')) { |
144 | include $this->conf->get('resource.data_dir') . '/options.php'; | |
510377d2 A |
145 | |
146 | // Load GLOBALS into config | |
684e662a A |
147 | $allowedKeys = array_merge(ConfigPhp::$ROOT_KEYS); |
148 | $allowedKeys[] = 'config'; | |
510377d2 | 149 | foreach ($GLOBALS as $key => $value) { |
684e662a | 150 | if (in_array($key, $allowedKeys)) { |
278d9ee2 | 151 | $this->conf->set($key, $value); |
684e662a | 152 | } |
510377d2 | 153 | } |
278d9ee2 | 154 | $this->conf->write($this->isLoggedIn); |
bcf056c9 | 155 | unlink($this->conf->get('resource.data_dir') . '/options.php'); |
510377d2 A |
156 | } |
157 | ||
158 | return true; | |
159 | } | |
21979ff1 | 160 | |
b74b96bf A |
161 | /** |
162 | * Move old configuration in PHP to the new config system in JSON format. | |
163 | * | |
da10377b A |
164 | * Will rename 'config.php' into 'config.save.php' and create 'config.json.php'. |
165 | * It will also convert legacy setting keys to the new ones. | |
b74b96bf A |
166 | */ |
167 | public function updateMethodConfigToJson() | |
168 | { | |
b74b96bf | 169 | // JSON config already exists, nothing to do. |
278d9ee2 | 170 | if ($this->conf->getConfigIO() instanceof ConfigJson) { |
b74b96bf A |
171 | return true; |
172 | } | |
173 | ||
174 | $configPhp = new ConfigPhp(); | |
175 | $configJson = new ConfigJson(); | |
278d9ee2 A |
176 | $oldConfig = $configPhp->read($this->conf->getConfigFile() . '.php'); |
177 | rename($this->conf->getConfigFileExt(), $this->conf->getConfigFile() . '.save.php'); | |
178 | $this->conf->setConfigIO($configJson); | |
179 | $this->conf->reload(); | |
b74b96bf | 180 | |
da10377b | 181 | $legacyMap = array_flip(ConfigPhp::$LEGACY_KEYS_MAPPING); |
b74b96bf | 182 | foreach (ConfigPhp::$ROOT_KEYS as $key) { |
278d9ee2 | 183 | $this->conf->set($legacyMap[$key], $oldConfig[$key]); |
b74b96bf A |
184 | } |
185 | ||
186 | // Set sub config keys (config and plugins) | |
187 | $subConfig = array('config', 'plugins'); | |
188 | foreach ($subConfig as $sub) { | |
189 | foreach ($oldConfig[$sub] as $key => $value) { | |
bcf056c9 V |
190 | if (isset($legacyMap[$sub . '.' . $key])) { |
191 | $configKey = $legacyMap[$sub . '.' . $key]; | |
da10377b | 192 | } else { |
bcf056c9 | 193 | $configKey = $sub . '.' . $key; |
da10377b | 194 | } |
278d9ee2 | 195 | $this->conf->set($configKey, $value); |
b74b96bf A |
196 | } |
197 | } | |
198 | ||
f211e417 | 199 | try { |
278d9ee2 | 200 | $this->conf->write($this->isLoggedIn); |
b74b96bf A |
201 | return true; |
202 | } catch (IOException $e) { | |
203 | error_log($e->getMessage()); | |
204 | return false; | |
205 | } | |
206 | } | |
7f179985 A |
207 | |
208 | /** | |
209 | * Escape settings which have been manually escaped in every request in previous versions: | |
210 | * - general.title | |
211 | * - general.header_link | |
b9f8b837 | 212 | * - redirector.url |
7f179985 A |
213 | * |
214 | * @return bool true if the update is successful, false otherwise. | |
215 | */ | |
b9f8b837 | 216 | public function updateMethodEscapeUnescapedConfig() |
7f179985 | 217 | { |
7f179985 | 218 | try { |
278d9ee2 A |
219 | $this->conf->set('general.title', escape($this->conf->get('general.title'))); |
220 | $this->conf->set('general.header_link', escape($this->conf->get('general.header_link'))); | |
278d9ee2 | 221 | $this->conf->write($this->isLoggedIn); |
7f179985 A |
222 | } catch (Exception $e) { |
223 | error_log($e->getMessage()); | |
224 | return false; | |
225 | } | |
226 | return true; | |
227 | } | |
1dc37f9c A |
228 | |
229 | /** | |
230 | * Update the database to use the new ID system, which replaces linkdate primary keys. | |
01878a75 | 231 | * Also, creation and update dates are now DateTime objects (done by LinkDB). |
1dc37f9c A |
232 | * |
233 | * Since this update is very sensitve (changing the whole database), the datastore will be | |
234 | * automatically backed up into the file datastore.<datetime>.php. | |
235 | * | |
d592daea A |
236 | * LinkDB also adds the field 'shorturl' with the precedent format (linkdate smallhash), |
237 | * which will be saved by this method. | |
238 | * | |
1dc37f9c A |
239 | * @return bool true if the update is successful, false otherwise. |
240 | */ | |
241 | public function updateMethodDatastoreIds() | |
242 | { | |
243 | // up to date database | |
244 | if (isset($this->linkDB[0])) { | |
245 | return true; | |
246 | } | |
247 | ||
bcf056c9 | 248 | $save = $this->conf->get('resource.data_dir') . '/datastore.' . date('YmdHis') . '.php'; |
1dc37f9c A |
249 | copy($this->conf->get('resource.datastore'), $save); |
250 | ||
251 | $links = array(); | |
252 | foreach ($this->linkDB as $offset => $value) { | |
253 | $links[] = $value; | |
254 | unset($this->linkDB[$offset]); | |
255 | } | |
256 | $links = array_reverse($links); | |
257 | $cpt = 0; | |
258 | foreach ($links as $l) { | |
1dc37f9c A |
259 | unset($l['linkdate']); |
260 | $l['id'] = $cpt; | |
261 | $this->linkDB[$cpt++] = $l; | |
262 | } | |
263 | ||
264 | $this->linkDB->save($this->conf->get('resource.page_cache')); | |
265 | $this->linkDB->reorder(); | |
266 | ||
267 | return true; | |
268 | } | |
cbfdcff2 | 269 | |
c03455af A |
270 | /** |
271 | * Rename tags starting with a '-' to work with tag exclusion search. | |
272 | */ | |
273 | public function updateMethodRenameDashTags() | |
274 | { | |
275 | $linklist = $this->linkDB->filterSearch(); | |
276 | foreach ($linklist as $key => $link) { | |
277 | $link['tags'] = preg_replace('/(^| )\-/', '$1', $link['tags']); | |
278 | $link['tags'] = implode(' ', array_unique(LinkFilter::tagsStrToArray($link['tags'], true))); | |
279 | $this->linkDB[$key] = $link; | |
280 | } | |
281 | $this->linkDB->save($this->conf->get('resource.page_cache')); | |
282 | return true; | |
283 | } | |
284 | ||
cbfdcff2 A |
285 | /** |
286 | * Initialize API settings: | |
287 | * - api.enabled: true | |
288 | * - api.secret: generated secret | |
289 | */ | |
290 | public function updateMethodApiSettings() | |
291 | { | |
292 | if ($this->conf->exists('api.secret')) { | |
293 | return true; | |
294 | } | |
295 | ||
296 | $this->conf->set('api.enabled', true); | |
297 | $this->conf->set( | |
298 | 'api.secret', | |
299 | generate_api_secret( | |
300 | $this->conf->get('credentials.login'), | |
301 | $this->conf->get('credentials.salt') | |
302 | ) | |
303 | ); | |
304 | $this->conf->write($this->isLoggedIn); | |
305 | return true; | |
306 | } | |
04a0e8ea A |
307 | |
308 | /** | |
309 | * New setting: theme name. If the default theme is used, nothing to do. | |
310 | * | |
311 | * If the user uses a custom theme, raintpl_tpl dir is updated to the parent directory, | |
312 | * and the current theme is set as default in the theme setting. | |
313 | * | |
314 | * @return bool true if the update is successful, false otherwise. | |
315 | */ | |
316 | public function updateMethodDefaultTheme() | |
317 | { | |
318 | // raintpl_tpl isn't the root template directory anymore. | |
319 | // We run the update only if this folder still contains the template files. | |
320 | $tplDir = $this->conf->get('resource.raintpl_tpl'); | |
321 | $tplFile = $tplDir . '/linklist.html'; | |
bcf056c9 | 322 | if (!file_exists($tplFile)) { |
04a0e8ea A |
323 | return true; |
324 | } | |
325 | ||
326 | $parent = dirname($tplDir); | |
327 | $this->conf->set('resource.raintpl_tpl', $parent); | |
328 | $this->conf->set('resource.theme', trim(str_replace($parent, '', $tplDir), '/')); | |
329 | $this->conf->write($this->isLoggedIn); | |
330 | ||
331 | // Dependency injection gore | |
332 | RainTPL::$tpl_dir = $tplDir; | |
333 | ||
334 | return true; | |
335 | } | |
7282418b A |
336 | |
337 | /** | |
338 | * Move the file to inc/user.css to data/user.css. | |
339 | * | |
340 | * Note: Due to hardcoded paths, it's not unit testable. But one line of code should be fine. | |
341 | * | |
342 | * @return bool true if the update is successful, false otherwise. | |
343 | */ | |
344 | public function updateMethodMoveUserCss() | |
345 | { | |
bcf056c9 | 346 | if (!is_file('inc/user.css')) { |
7282418b A |
347 | return true; |
348 | } | |
349 | ||
350 | return rename('inc/user.css', 'data/user.css'); | |
351 | } | |
7dcbfde5 | 352 | |
e0376101 A |
353 | /** |
354 | * * `markdown_escape` is a new setting, set to true as default. | |
355 | * | |
356 | * If the markdown plugin was already enabled, escaping is disabled to avoid | |
357 | * breaking existing entries. | |
358 | */ | |
359 | public function updateMethodEscapeMarkdown() | |
360 | { | |
361 | if ($this->conf->exists('security.markdown_escape')) { | |
362 | return true; | |
363 | } | |
364 | ||
365 | if (in_array('markdown', $this->conf->get('general.enabled_plugins'))) { | |
366 | $this->conf->set('security.markdown_escape', false); | |
367 | } else { | |
368 | $this->conf->set('security.markdown_escape', true); | |
369 | } | |
370 | $this->conf->write($this->isLoggedIn); | |
371 | ||
7dcbfde5 A |
372 | return true; |
373 | } | |
fe83d45c A |
374 | |
375 | /** | |
376 | * Add 'http://' to Piwik URL the setting is set. | |
377 | * | |
378 | * @return bool true if the update is successful, false otherwise. | |
379 | */ | |
380 | public function updateMethodPiwikUrl() | |
381 | { | |
bcf056c9 | 382 | if (!$this->conf->exists('plugins.PIWIK_URL') || startsWith($this->conf->get('plugins.PIWIK_URL'), 'http')) { |
fe83d45c A |
383 | return true; |
384 | } | |
385 | ||
bcf056c9 | 386 | $this->conf->set('plugins.PIWIK_URL', 'http://' . $this->conf->get('plugins.PIWIK_URL')); |
fe83d45c | 387 | $this->conf->write($this->isLoggedIn); |
2ea89aba A |
388 | |
389 | return true; | |
390 | } | |
391 | ||
392 | /** | |
393 | * Use ATOM feed as default. | |
394 | */ | |
395 | public function updateMethodAtomDefault() | |
396 | { | |
397 | if (!$this->conf->exists('feed.show_atom') || $this->conf->get('feed.show_atom') === true) { | |
398 | return true; | |
399 | } | |
400 | ||
401 | $this->conf->set('feed.show_atom', true); | |
402 | $this->conf->write($this->isLoggedIn); | |
403 | ||
fe83d45c A |
404 | return true; |
405 | } | |
bbc6b844 A |
406 | |
407 | /** | |
408 | * Update updates.check_updates_branch setting. | |
409 | * | |
410 | * If the current major version digit matches the latest branch | |
411 | * major version digit, we set the branch to `latest`, | |
412 | * otherwise we'll check updates on the `stable` branch. | |
413 | * | |
414 | * No update required for the dev version. | |
415 | * | |
416 | * Note: due to hardcoded URL and lack of dependency injection, this is not unit testable. | |
417 | * | |
418 | * FIXME! This needs to be removed when we switch to first digit major version | |
419 | * instead of the second one since the versionning process will change. | |
420 | */ | |
421 | public function updateMethodCheckUpdateRemoteBranch() | |
422 | { | |
b3e1f92e | 423 | if (SHAARLI_VERSION === 'dev' || $this->conf->get('updates.check_updates_branch') === 'latest') { |
bbc6b844 A |
424 | return true; |
425 | } | |
426 | ||
427 | // Get latest branch major version digit | |
428 | $latestVersion = ApplicationUtils::getLatestGitVersionCode( | |
429 | 'https://raw.githubusercontent.com/shaarli/Shaarli/latest/shaarli_version.php', | |
430 | 5 | |
431 | ); | |
432 | if (preg_match('/(\d+)\.\d+$/', $latestVersion, $matches) === false) { | |
433 | return false; | |
434 | } | |
435 | $latestMajor = $matches[1]; | |
436 | ||
437 | // Get current major version digit | |
b3e1f92e | 438 | preg_match('/(\d+)\.\d+$/', SHAARLI_VERSION, $matches); |
bbc6b844 A |
439 | $currentMajor = $matches[1]; |
440 | ||
441 | if ($currentMajor === $latestMajor) { | |
442 | $branch = 'latest'; | |
443 | } else { | |
444 | $branch = 'stable'; | |
445 | } | |
446 | $this->conf->set('updates.check_updates_branch', $branch); | |
447 | $this->conf->write($this->isLoggedIn); | |
448 | return true; | |
449 | } | |
57ce6dae A |
450 | |
451 | /** | |
452 | * Reset history store file due to date format change. | |
453 | */ | |
454 | public function updateMethodResetHistoryFile() | |
455 | { | |
456 | if (is_file($this->conf->get('resource.history'))) { | |
457 | unlink($this->conf->get('resource.history')); | |
458 | } | |
459 | return true; | |
460 | } | |
9ec0a611 A |
461 | |
462 | /** | |
463 | * Save the datastore -> the link order is now applied when links are saved. | |
464 | */ | |
465 | public function updateMethodReorderDatastore() | |
466 | { | |
467 | $this->linkDB->save($this->conf->get('resource.page_cache')); | |
270da705 | 468 | return true; |
9ec0a611 | 469 | } |
9d4736a3 A |
470 | |
471 | /** | |
472 | * Change privateonly session key to visibility. | |
473 | */ | |
474 | public function updateMethodVisibilitySession() | |
475 | { | |
476 | if (isset($_SESSION['privateonly'])) { | |
477 | unset($_SESSION['privateonly']); | |
478 | $_SESSION['visibility'] = 'private'; | |
479 | } | |
480 | return true; | |
481 | } | |
4ff3ed1c A |
482 | |
483 | /** | |
484 | * Add download size and timeout to the configuration file | |
485 | * | |
486 | * @return bool true if the update is successful, false otherwise. | |
487 | */ | |
488 | public function updateMethodDownloadSizeAndTimeoutConf() | |
489 | { | |
490 | if ($this->conf->exists('general.download_max_size') | |
491 | && $this->conf->exists('general.download_timeout') | |
492 | ) { | |
493 | return true; | |
494 | } | |
495 | ||
bcf056c9 V |
496 | if (!$this->conf->exists('general.download_max_size')) { |
497 | $this->conf->set('general.download_max_size', 1024 * 1024 * 4); | |
4ff3ed1c A |
498 | } |
499 | ||
bcf056c9 | 500 | if (!$this->conf->exists('general.download_timeout')) { |
4ff3ed1c A |
501 | $this->conf->set('general.download_timeout', 30); |
502 | } | |
503 | ||
504 | $this->conf->write($this->isLoggedIn); | |
e85b7a05 A |
505 | return true; |
506 | } | |
4ff3ed1c | 507 | |
e85b7a05 A |
508 | /** |
509 | * * Move thumbnails management to WebThumbnailer, coming with new settings. | |
510 | */ | |
511 | public function updateMethodWebThumbnailer() | |
512 | { | |
b302b3c5 | 513 | if ($this->conf->exists('thumbnails.mode')) { |
28f26524 A |
514 | return true; |
515 | } | |
516 | ||
b5c368b8 | 517 | $thumbnailsEnabled = extension_loaded('gd') && $this->conf->get('thumbnail.enable_thumbnails', true); |
b302b3c5 | 518 | $this->conf->set('thumbnails.mode', $thumbnailsEnabled ? Thumbnailer::MODE_ALL : Thumbnailer::MODE_NONE); |
e85b7a05 A |
519 | $this->conf->set('thumbnails.width', 125); |
520 | $this->conf->set('thumbnails.height', 90); | |
521 | $this->conf->remove('thumbnail'); | |
522 | $this->conf->write(true); | |
28f26524 A |
523 | |
524 | if ($thumbnailsEnabled) { | |
525 | $this->session['warnings'][] = t( | |
7b4fea0e | 526 | 'You have enabled or changed thumbnails mode. <a href="?do=thumbs_update">Please synchronize them</a>.' |
28f26524 A |
527 | ); |
528 | } | |
529 | ||
4ff3ed1c A |
530 | return true; |
531 | } | |
4154c25b A |
532 | |
533 | /** | |
534 | * Set sticky = false on all links | |
535 | * | |
536 | * @return bool true if the update is successful, false otherwise. | |
537 | */ | |
538 | public function updateMethodSetSticky() | |
539 | { | |
540 | foreach ($this->linkDB as $key => $link) { | |
541 | if (isset($link['sticky'])) { | |
542 | return true; | |
543 | } | |
544 | $link['sticky'] = false; | |
545 | $this->linkDB[$key] = $link; | |
546 | } | |
547 | ||
548 | $this->linkDB->save($this->conf->get('resource.page_cache')); | |
549 | ||
550 | return true; | |
551 | } | |
520d2957 A |
552 | |
553 | /** | |
554 | * Remove redirector settings. | |
555 | */ | |
556 | public function updateMethodRemoveRedirector() | |
557 | { | |
558 | $this->conf->remove('redirector'); | |
559 | $this->conf->write(true); | |
560 | return true; | |
561 | } | |
510377d2 | 562 | } |