aboutsummaryrefslogtreecommitdiffhomepage
path: root/application
diff options
context:
space:
mode:
Diffstat (limited to 'application')
-rw-r--r--application/Config.php27
-rw-r--r--application/LinkDB.php10
-rw-r--r--application/LinkFilter.php1
-rw-r--r--application/Updater.php228
4 files changed, 232 insertions, 34 deletions
diff --git a/application/Config.php b/application/Config.php
index 9af5a535..05a59452 100644
--- a/application/Config.php
+++ b/application/Config.php
@@ -174,33 +174,6 @@ function load_plugin_parameter_values($plugins, $config)
174} 174}
175 175
176/** 176/**
177 * Milestone 0.9 - shaarli/Shaarli#41: options.php is not supported anymore.
178 * ==> if user is loggedIn, merge its content with config.php, then delete options.php.
179 *
180 * @param array $config contains all configuration fields.
181 * @param bool $isLoggedIn true if user is logged in.
182 *
183 * @return void
184 */
185function mergeDeprecatedConfig($config, $isLoggedIn)
186{
187 $config_file = $config['config']['CONFIG_FILE'];
188
189 if (is_file($config['config']['DATADIR'].'/options.php') && $isLoggedIn) {
190 include $config['config']['DATADIR'].'/options.php';
191
192 // Load GLOBALS into config
193 foreach ($GLOBALS as $key => $value) {
194 $config[$key] = $value;
195 }
196 $config['config']['CONFIG_FILE'] = $config_file;
197 writeConfig($config, $isLoggedIn);
198
199 unlink($config['config']['DATADIR'].'/options.php');
200 }
201}
202
203/**
204 * Exception used if a mandatory field is missing in given configuration. 177 * Exception used if a mandatory field is missing in given configuration.
205 */ 178 */
206class MissingFieldConfigException extends Exception 179class MissingFieldConfigException extends Exception
diff --git a/application/LinkDB.php b/application/LinkDB.php
index 19ca6435..a95b3f36 100644
--- a/application/LinkDB.php
+++ b/application/LinkDB.php
@@ -260,14 +260,11 @@ You use the community supported version of the original Shaarli project, by Seba
260 } 260 }
261 } 261 }
262 262
263 // Keep the list of the mapping URLs-->linkdate up-to-date.
264 $this->_urls = array(); 263 $this->_urls = array();
265 foreach ($this->_links as $link) { 264 foreach ($this->_links as &$link) {
265 // Keep the list of the mapping URLs-->linkdate up-to-date.
266 $this->_urls[$link['url']] = $link['linkdate']; 266 $this->_urls[$link['url']] = $link['linkdate'];
267 } 267 // Sanitize data fields.
268
269 // Escape links data
270 foreach($this->_links as &$link) {
271 sanitizeLink($link); 268 sanitizeLink($link);
272 // Do not use the redirector for internal links (Shaarli note URL starting with a '?'). 269 // Do not use the redirector for internal links (Shaarli note URL starting with a '?').
273 if (!empty($this->_redirector) && !startsWith($link['url'], '?')) { 270 if (!empty($this->_redirector) && !startsWith($link['url'], '?')) {
@@ -381,6 +378,7 @@ You use the community supported version of the original Shaarli project, by Seba
381 } 378 }
382 $linkDays = array_keys($linkDays); 379 $linkDays = array_keys($linkDays);
383 sort($linkDays); 380 sort($linkDays);
381
384 return $linkDays; 382 return $linkDays;
385 } 383 }
386} 384}
diff --git a/application/LinkFilter.php b/application/LinkFilter.php
index b2e6530f..096d3b04 100644
--- a/application/LinkFilter.php
+++ b/application/LinkFilter.php
@@ -260,7 +260,6 @@ class LinkFilter
260 * Convert a list of tags (str) to an array. Also 260 * Convert a list of tags (str) to an array. Also
261 * - handle case sensitivity. 261 * - handle case sensitivity.
262 * - accepts spaces commas as separator. 262 * - accepts spaces commas as separator.
263 * - remove private tags for loggedout users.
264 * 263 *
265 * @param string $tags string containing a list of tags. 264 * @param string $tags string containing a list of tags.
266 * @param bool $casesensitive will convert everything to lowercase if false. 265 * @param bool $casesensitive will convert everything to lowercase if false.
diff --git a/application/Updater.php b/application/Updater.php
new file mode 100644
index 00000000..20ae0c4d
--- /dev/null
+++ b/application/Updater.php
@@ -0,0 +1,228 @@
1<?php
2
3/**
4 * Class Updater.
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.
7 */
8class Updater
9{
10 /**
11 * @var array Updates which are already done.
12 */
13 protected $doneUpdates;
14
15 /**
16 * @var array Shaarli's configuration array.
17 */
18 protected $config;
19
20 /**
21 * @var LinkDB instance.
22 */
23 protected $linkDB;
24
25 /**
26 * @var bool True if the user is logged in, false otherwise.
27 */
28 protected $isLoggedIn;
29
30 /**
31 * @var ReflectionMethod[] List of current class methods.
32 */
33 protected $methods;
34
35 /**
36 * Object constructor.
37 *
38 * @param array $doneUpdates Updates which are already done.
39 * @param array $config Shaarli's configuration array.
40 * @param LinkDB $linkDB LinkDB instance.
41 * @param boolean $isLoggedIn True if the user is logged in.
42 */
43 public function __construct($doneUpdates, $config, $linkDB, $isLoggedIn)
44 {
45 $this->doneUpdates = $doneUpdates;
46 $this->config = $config;
47 $this->linkDB = $linkDB;
48 $this->isLoggedIn = $isLoggedIn;
49
50 // Retrieve all update methods.
51 $class = new ReflectionClass($this);
52 $this->methods = $class->getMethods();
53 }
54
55 /**
56 * Run all new updates.
57 * Update methods have to start with 'updateMethod' and return true (on success).
58 *
59 * @return array An array containing ran updates.
60 *
61 * @throws UpdaterException If something went wrong.
62 */
63 public function update()
64 {
65 $updatesRan = array();
66
67 // If the user isn't logged in, exit without updating.
68 if ($this->isLoggedIn !== true) {
69 return $updatesRan;
70 }
71
72 if ($this->methods == null) {
73 throw new UpdaterException('Couldn\'t retrieve Updater class methods.');
74 }
75
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)
80 ) {
81 continue;
82 }
83
84 try {
85 $method->setAccessible(true);
86 $res = $method->invoke($this);
87 // Update method must return true to be considered processed.
88 if ($res === true) {
89 $updatesRan[] = $method->getName();
90 }
91 } catch (Exception $e) {
92 throw new UpdaterException($method, $e);
93 }
94 }
95
96 $this->doneUpdates = array_merge($this->doneUpdates, $updatesRan);
97
98 return $updatesRan;
99 }
100
101 /**
102 * @return array Updates methods already processed.
103 */
104 public function getDoneUpdates()
105 {
106 return $this->doneUpdates;
107 }
108
109 /**
110 * Move deprecated options.php to config.php.
111 *
112 * Milestone 0.9 (old versioning) - shaarli/Shaarli#41:
113 * options.php is not supported anymore.
114 */
115 public function updateMethodMergeDeprecatedConfigFile()
116 {
117 $config_file = $this->config['config']['CONFIG_FILE'];
118
119 if (is_file($this->config['config']['DATADIR'].'/options.php')) {
120 include $this->config['config']['DATADIR'].'/options.php';
121
122 // Load GLOBALS into config
123 foreach ($GLOBALS as $key => $value) {
124 $this->config[$key] = $value;
125 }
126 $this->config['config']['CONFIG_FILE'] = $config_file;
127 writeConfig($this->config, $this->isLoggedIn);
128
129 unlink($this->config['config']['DATADIR'].'/options.php');
130 }
131
132 return true;
133 }
134}
135
136/**
137 * Class UpdaterException.
138 */
139class UpdaterException extends Exception
140{
141 /**
142 * @var string Method where the error occurred.
143 */
144 protected $method;
145
146 /**
147 * @var Exception The parent exception.
148 */
149 protected $previous;
150
151 /**
152 * Constructor.
153 *
154 * @param string $message Force the error message if set.
155 * @param string $method Method where the error occurred.
156 * @param Exception|bool $previous Parent exception.
157 */
158 public function __construct($message = '', $method = '', $previous = false)
159 {
160 $this->method = $method;
161 $this->previous = $previous;
162 $this->message = $this->buildMessage($message);
163 }
164
165 /**
166 * Build the exception error message.
167 *
168 * @param string $message Optional given error message.
169 *
170 * @return string The built error message.
171 */
172 private function buildMessage($message)
173 {
174 $out = '';
175 if (! empty($message)) {
176 $out .= $message . PHP_EOL;
177 }
178
179 if (! empty($this->method)) {
180 $out .= 'An error occurred while running the update '. $this->method . PHP_EOL;
181 }
182
183 if (! empty($this->previous)) {
184 $out .= ' '. $this->previous->getMessage();
185 }
186
187 return $out;
188 }
189}
190
191
192/**
193 * Read the updates file, and return already done updates.
194 *
195 * @param string $updatesFilepath Updates file path.
196 *
197 * @return array Already done update methods.
198 */
199function read_updates_file($updatesFilepath)
200{
201 if (! empty($updatesFilepath) && is_file($updatesFilepath)) {
202 $content = file_get_contents($updatesFilepath);
203 if (! empty($content)) {
204 return explode(';', $content);
205 }
206 }
207 return array();
208}
209
210/**
211 * Write updates file.
212 *
213 * @param string $updatesFilepath Updates file path.
214 * @param array $updates Updates array to write.
215 *
216 * @throws Exception Couldn't write version number.
217 */
218function write_updates_file($updatesFilepath, $updates)
219{
220 if (empty($updatesFilepath)) {
221 throw new Exception('Updates file path is not set, can\'t write updates.');
222 }
223
224 $res = file_put_contents($updatesFilepath, implode(';', $updates));
225 if ($res === false) {
226 throw new Exception('Unable to write updates in '. $updatesFilepath . '.');
227 }
228}