doneUpdates = $doneUpdates; $this->bookmarkService = $linkDB; $this->conf = $conf; $this->isLoggedIn = $isLoggedIn; // Retrieve all update methods. $class = new \ReflectionClass($this); $this->methods = $class->getMethods(); } /** * Run all new updates. * Update methods have to start with 'updateMethod' and return true (on success). * * @param string $basePath Shaarli root directory (from HTTP Request) * * @return array An array containing ran updates. * * @throws UpdaterException If something went wrong. */ public function update(string $basePath = null) { $updatesRan = []; // If the user isn't logged in, exit without updating. if ($this->isLoggedIn !== true) { return $updatesRan; } if ($this->methods === null) { throw new UpdaterException('Couldn\'t retrieve LegacyUpdater class methods.'); } foreach ($this->methods as $method) { // Not an update method or already done, pass. if ( ! startsWith($method->getName(), 'updateMethod') || in_array($method->getName(), $this->doneUpdates) ) { continue; } try { $method->setAccessible(true); $res = $method->invoke($this); // Update method must return true to be considered processed. if ($res === true) { $updatesRan[] = $method->getName(); } } catch (\Exception $e) { throw new UpdaterException($method, $e); } } $this->doneUpdates = array_merge($this->doneUpdates, $updatesRan); return $updatesRan; } /** * @return array Updates methods already processed. */ public function getDoneUpdates() { return $this->doneUpdates; } public function readUpdates(string $updatesFilepath): array { return UpdaterUtils::readUpdatesFile($updatesFilepath); } public function writeUpdates(string $updatesFilepath, array $updates): void { UpdaterUtils::writeUpdatesFile($updatesFilepath, $updates); } /** * With the Slim routing system, default header link should be `/subfolder/` instead of `?`. * Otherwise you can not go back to the home page. * Example: `/subfolder/picture-wall` -> `/subfolder/picture-wall?` instead of `/subfolder/`. */ public function updateMethodRelativeHomeLink(): bool { if ('?' === trim($this->conf->get('general.header_link'))) { $this->conf->set('general.header_link', $this->basePath . '/', true, true); } return true; } /** * With the Slim routing system, note bookmarks URL formatted `?abcdef` * should be replaced with `/shaare/abcdef` */ public function updateMethodMigrateExistingNotesUrl(): bool { $updated = false; foreach ($this->bookmarkService->search()->getBookmarks() as $bookmark) { if ( $bookmark->isNote() && startsWith($bookmark->getUrl(), '?') && 1 === preg_match('/^\?([a-zA-Z0-9-_@]{6})($|&|#)/', $bookmark->getUrl(), $match) ) { $updated = true; $bookmark = $bookmark->setUrl('/shaare/' . $match[1]); $this->bookmarkService->set($bookmark, false); } } if ($updated) { $this->bookmarkService->save(); } return true; } public function updateMethodRemoveSettingRemoteBranch(): bool { if ($this->conf->exists('updates.check_updates_branch')) { $this->conf->remove('updates.check_updates_branch', true, true); } return true; } public function setBasePath(string $basePath): self { $this->basePath = $basePath; return $this; } }