application/legacy/LegacyUpdater.php

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