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.
11 * @var array Updates which are already done.
13 protected $doneUpdates;
16 * @var LinkDB instance.
21 * @var ConfigManager $conf Configuration Manager instance.
26 * @var bool True if the user is logged in, false otherwise.
28 protected $isLoggedIn;
31 * @var ReflectionMethod[] List of current class methods.
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.
43 public function __construct($doneUpdates, $linkDB, $conf, $isLoggedIn)
45 $this->doneUpdates
= $doneUpdates;
46 $this->linkDB
= $linkDB;
48 $this->isLoggedIn
= $isLoggedIn;
50 // Retrieve all update methods.
51 $class = new ReflectionClass($this);
52 $this->methods
= $class->getMethods();
56 * Run all new updates.
57 * Update methods have to start with 'updateMethod' and return true (on success).
59 * @return array An array containing ran updates.
61 * @throws UpdaterException If something went wrong.
63 public function update()
65 $updatesRan = array();
67 // If the user isn't logged in, exit without updating.
68 if ($this->isLoggedIn
!== true) {
72 if ($this->methods
== null) {
73 throw new UpdaterException('Couldn\'t retrieve Updater class methods.');
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
)
85 $method->setAccessible(true);
86 $res = $method->invoke($this);
87 // Update method must return true to be considered processed.
89 $updatesRan[] = $method->getName();
91 } catch (Exception
$e) {
92 throw new UpdaterException($method, $e);
96 $this->doneUpdates
= array_merge($this->doneUpdates
, $updatesRan);
102 * @return array Updates methods already processed.
104 public function getDoneUpdates()
106 return $this->doneUpdates
;
110 * Move deprecated options.php to config.php.
112 * Milestone 0.9 (old versioning) - shaarli/Shaarli#41:
113 * options.php is not supported anymore.
115 public function updateMethodMergeDeprecatedConfigFile()
117 if (is_file($this->conf
->get('resource.data_dir') . '/options.php')) {
118 include $this->conf
->get('resource.data_dir') . '/options.php';
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);
128 $this->conf
->write($this->isLoggedIn
);
129 unlink($this->conf
->get('resource.data_dir').'/options.php');
136 * Rename tags starting with a '-' to work with tag exclusion search.
138 public function updateMethodRenameDashTags()
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;
146 $this->linkDB->save($this->conf->get('resource.page_cache
'));
151 * Move old configuration in PHP to the new config system in JSON format.
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.
156 public function updateMethodConfigToJson()
158 // JSON config already exists, nothing to do.
159 if ($this->conf->getConfigIO() instanceof ConfigJson) {
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();
170 $legacyMap = array_flip(ConfigPhp::$LEGACY_KEYS_MAPPING);
171 foreach (ConfigPhp::$ROOT_KEYS as $key) {
172 $this->conf->set($legacyMap[$key], $oldConfig[$key]);
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];
182 $configKey = $sub .'.'. $key;
184 $this->conf->set($configKey, $value);
189 $this->conf->write($this->isLoggedIn);
191 } catch (IOException $e) {
192 error_log($e->getMessage());
198 * Escape settings which have been manually escaped in every request in previous versions:
200 * - general.header_link
203 * @return bool true if the update is successful, false otherwise.
205 public function updateMethodEscapeUnescapedConfig()
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());
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).
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.
226 * LinkDB also adds the field 'shorturl
' with the precedent format (linkdate smallhash),
227 * which will be saved by this method.
229 * @return bool true if the update is successful, false otherwise.
231 public function updateMethodDatastoreIds()
233 // up to date database
234 if (isset($this->linkDB[0])) {
238 $save = $this->conf->get('resource.data_dir
') .'/datastore
.'. date('YmdHis
') .'.php
';
239 copy($this->conf->get('resource.datastore
'), $save);
242 foreach ($this->linkDB as $offset => $value) {
244 unset($this->linkDB[$offset]);
246 $links = array_reverse($links);
248 foreach ($links as $l) {
249 unset($l['linkdate
']);
251 $this->linkDB[$cpt++] = $l;
254 $this->linkDB->save($this->conf->get('resource.page_cache
'));
255 $this->linkDB->reorder();
261 * Initialize API settings:
262 * - api.enabled: true
263 * - api.secret: generated secret
265 public function updateMethodApiSettings()
267 if ($this->conf->exists('api
.secret
')) {
271 $this->conf->set('api
.enabled
', true);
275 $this->conf->get('credentials
.login
'),
276 $this->conf->get('credentials
.salt
')
279 $this->conf->write($this->isLoggedIn);
284 * New setting: theme name. If the default theme is used, nothing to do.
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.
289 * @return bool true if the update is successful, false otherwise.
291 public function updateMethodDefaultTheme()
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)) {
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
);
306 // Dependency injection gore
307 RainTPL
::$tpl_dir = $tplDir;
314 * Class UpdaterException.
316 class UpdaterException
extends Exception
319 * @var string Method where the error occurred.
324 * @var Exception The parent exception.
331 * @param string $message Force the error message if set.
332 * @param string $method Method where the error occurred.
333 * @param Exception|bool $previous Parent exception.
335 public function __construct($message = '', $method = '', $previous = false)
337 $this->method
= $method;
338 $this->previous
= $previous;
339 $this->message
= $this->buildMessage($message);
343 * Build the exception error message.
345 * @param string $message Optional given error message.
347 * @return string The built error message.
349 private function buildMessage($message)
352 if (! empty($message)) {
353 $out .= $message . PHP_EOL
;
356 if (! empty($this->method
)) {
357 $out .= 'An error occurred while running the update '. $this->method
. PHP_EOL
;
360 if (! empty($this->previous
)) {
361 $out .= ' '. $this->previous
->getMessage();
369 * Read the updates file, and return already done updates.
371 * @param string $updatesFilepath Updates file path.
373 * @return array Already done update methods.
375 function read_updates_file($updatesFilepath)
377 if (! empty($updatesFilepath) && is_file($updatesFilepath)) {
378 $content = file_get_contents($updatesFilepath);
379 if (! empty($content)) {
380 return explode(';', $content);
387 * Write updates file.
389 * @param string $updatesFilepath Updates file path.
390 * @param array $updates Updates array to write.
392 * @throws Exception Couldn't write version number.
394 function write_updates_file($updatesFilepath, $updates)
396 if (empty($updatesFilepath)) {
397 throw new Exception('Updates file path is not set, can\'t write updates.');
400 $res = file_put_contents($updatesFilepath, implode(';', $updates));
401 if ($res === false) {
402 throw new Exception('Unable to write updates in '. $updatesFilepath . '.');