3 namespace Shaarli\Updater
;
5 use Shaarli\Bookmark\BookmarkServiceInterface
;
6 use Shaarli\Config\ConfigManager
;
7 use Shaarli\Updater\Exception\UpdaterException
;
11 * Used to update stuff when a new Shaarli's version is reached.
12 * Update methods are ran only once, and the stored in a TXT file.
17 * @var array Updates which are already done.
19 protected $doneUpdates;
22 * @var BookmarkServiceInterface instance.
24 protected $bookmarkService;
27 * @var ConfigManager $conf Configuration Manager instance.
32 * @var bool True if the user is logged in, false otherwise.
34 protected $isLoggedIn;
37 * @var \ReflectionMethod[] List of current class methods.
42 * @var string $basePath Shaarli root directory (from HTTP Request)
44 protected $basePath = null;
49 * @param array $doneUpdates Updates which are already done.
50 * @param BookmarkServiceInterface $linkDB LinksService instance.
51 * @param ConfigManager $conf Configuration Manager instance.
52 * @param boolean $isLoggedIn True if the user is logged in.
54 public function __construct($doneUpdates, $linkDB, $conf, $isLoggedIn)
56 $this->doneUpdates
= $doneUpdates;
57 $this->bookmarkService
= $linkDB;
59 $this->isLoggedIn
= $isLoggedIn;
61 // Retrieve all update methods.
62 $class = new \
ReflectionClass($this);
63 $this->methods
= $class->getMethods();
67 * Run all new updates.
68 * Update methods have to start with 'updateMethod' and return true (on success).
70 * @param string $basePath Shaarli root directory (from HTTP Request)
72 * @return array An array containing ran updates.
74 * @throws UpdaterException If something went wrong.
76 public function update(string $basePath = null)
80 // If the user isn't logged in, exit without updating.
81 if ($this->isLoggedIn
!== true) {
85 if ($this->methods
=== null) {
86 throw new UpdaterException('Couldn\'t retrieve LegacyUpdater class methods.');
89 foreach ($this->methods
as $method) {
90 // Not an update method or already done, pass.
91 if (! startsWith($method->getName(), 'updateMethod')
92 || in_array($method->getName(), $this->doneUpdates
)
98 $method->setAccessible(true);
99 $res = $method->invoke($this);
100 // Update method must return true to be considered processed.
102 $updatesRan[] = $method->getName();
104 } catch (\Exception
$e) {
105 throw new UpdaterException($method, $e);
109 $this->doneUpdates
= array_merge($this->doneUpdates
, $updatesRan);
115 * @return array Updates methods already processed.
117 public function getDoneUpdates()
119 return $this->doneUpdates
;
122 public function readUpdates(string $updatesFilepath): array
124 return UpdaterUtils
::read_updates_file($updatesFilepath);
127 public function writeUpdates(string $updatesFilepath, array $updates): void
129 UpdaterUtils
::write_updates_file($updatesFilepath, $updates);
133 * With the Slim routing system, default header link should be `/subfolder/` instead of `?`.
134 * Otherwise you can not go back to the home page.
135 * Example: `/subfolder/picture-wall` -> `/subfolder/picture-wall?` instead of `/subfolder/`.
137 public function updateMethodRelativeHomeLink(): bool
139 if ('?' === trim($this->conf
->get('general.header_link'))) {
140 $this->conf
->set('general.header_link', $this->basePath
. '/', true, true);
147 * With the Slim routing system, note bookmarks URL formatted `?abcdef`
148 * should be replaced with `/shaare/abcdef`
150 public function updateMethodMigrateExistingNotesUrl(): bool
154 foreach ($this->bookmarkService
->search() as $bookmark) {
155 if ($bookmark->isNote()
156 && startsWith($bookmark->getUrl(), '?')
157 && 1 === preg_match('/^\?([a-zA-Z0-9-_@]{6})($|&|#)/', $bookmark->getUrl(), $match)
160 $bookmark = $bookmark->setUrl($this->basePath
. '/shaare/' . $match[1]);
162 $this->bookmarkService
->set($bookmark, false);
167 $this->bookmarkService
->save();
173 public function setBasePath(string $basePath): self
175 $this->basePath
= $basePath;