]>
Commit | Line | Data |
---|---|---|
1 | <?php | |
2 | ||
3 | declare(strict_types=1); | |
4 | ||
5 | namespace Shaarli\Front\Controller\Admin; | |
6 | ||
7 | use Shaarli\Bookmark\Bookmark; | |
8 | use Shaarli\Bookmark\Exception\BookmarkNotFoundException; | |
9 | use Shaarli\Formatter\BookmarkMarkdownFormatter; | |
10 | use Shaarli\Render\TemplatePage; | |
11 | use Shaarli\Thumbnailer; | |
12 | use Slim\Http\Request; | |
13 | use Slim\Http\Response; | |
14 | ||
15 | /** | |
16 | * Class PostBookmarkController | |
17 | * | |
18 | * Slim controller used to handle Shaarli create or edit bookmarks. | |
19 | */ | |
20 | class ManageShaareController extends ShaarliAdminController | |
21 | { | |
22 | /** | |
23 | * GET /admin/add-shaare - Displays the form used to create a new bookmark from an URL | |
24 | */ | |
25 | public function addShaare(Request $request, Response $response): Response | |
26 | { | |
27 | $this->assignView( | |
28 | 'pagetitle', | |
29 | t('Shaare a new link') .' - '. $this->container->conf->get('general.title', 'Shaarli') | |
30 | ); | |
31 | ||
32 | return $response->write($this->render(TemplatePage::ADDLINK)); | |
33 | } | |
34 | ||
35 | /** | |
36 | * GET /admin/shaare - Displays the bookmark form for creation. | |
37 | * Note that if the URL is found in existing bookmarks, then it will be in edit mode. | |
38 | */ | |
39 | public function displayCreateForm(Request $request, Response $response): Response | |
40 | { | |
41 | $url = cleanup_url($request->getParam('post')); | |
42 | ||
43 | $linkIsNew = false; | |
44 | // Check if URL is not already in database (in this case, we will edit the existing link) | |
45 | $bookmark = $this->container->bookmarkService->findByUrl($url); | |
46 | if (null === $bookmark) { | |
47 | $linkIsNew = true; | |
48 | // Get shaare data if it was provided in URL (e.g.: by the bookmarklet). | |
49 | $title = $request->getParam('title'); | |
50 | $description = $request->getParam('description'); | |
51 | $tags = $request->getParam('tags'); | |
52 | $private = filter_var($request->getParam('private'), FILTER_VALIDATE_BOOLEAN); | |
53 | ||
54 | // If this is an HTTP(S) link, we try go get the page to extract | |
55 | // the title (otherwise we will to straight to the edit form.) | |
56 | if (empty($title) && strpos(get_url_scheme($url) ?: '', 'http') !== false) { | |
57 | $retrieveDescription = $this->container->conf->get('general.retrieve_description'); | |
58 | // Short timeout to keep the application responsive | |
59 | // The callback will fill $charset and $title with data from the downloaded page. | |
60 | $this->container->httpAccess->getHttpResponse( | |
61 | $url, | |
62 | $this->container->conf->get('general.download_timeout', 30), | |
63 | $this->container->conf->get('general.download_max_size', 4194304), | |
64 | $this->container->httpAccess->getCurlDownloadCallback( | |
65 | $charset, | |
66 | $title, | |
67 | $description, | |
68 | $tags, | |
69 | $retrieveDescription | |
70 | ) | |
71 | ); | |
72 | if (! empty($title) && strtolower($charset) !== 'utf-8') { | |
73 | $title = mb_convert_encoding($title, 'utf-8', $charset); | |
74 | } | |
75 | } | |
76 | ||
77 | if (empty($url) && empty($title)) { | |
78 | $title = $this->container->conf->get('general.default_note_title', t('Note: ')); | |
79 | } | |
80 | ||
81 | $link = escape([ | |
82 | 'title' => $title, | |
83 | 'url' => $url ?? '', | |
84 | 'description' => $description ?? '', | |
85 | 'tags' => $tags ?? '', | |
86 | 'private' => $private, | |
87 | ]); | |
88 | } else { | |
89 | $formatter = $this->container->formatterFactory->getFormatter('raw'); | |
90 | $link = $formatter->format($bookmark); | |
91 | } | |
92 | ||
93 | return $this->displayForm($link, $linkIsNew, $request, $response); | |
94 | } | |
95 | ||
96 | /** | |
97 | * GET /admin/shaare/{id} - Displays the bookmark form in edition mode. | |
98 | */ | |
99 | public function displayEditForm(Request $request, Response $response, array $args): Response | |
100 | { | |
101 | $id = $args['id'] ?? ''; | |
102 | try { | |
103 | if (false === ctype_digit($id)) { | |
104 | throw new BookmarkNotFoundException(); | |
105 | } | |
106 | $bookmark = $this->container->bookmarkService->get((int) $id); // Read database | |
107 | } catch (BookmarkNotFoundException $e) { | |
108 | $this->saveErrorMessage(sprintf( | |
109 | t('Bookmark with identifier %s could not be found.'), | |
110 | $id | |
111 | )); | |
112 | ||
113 | return $this->redirect($response, '/'); | |
114 | } | |
115 | ||
116 | $formatter = $this->container->formatterFactory->getFormatter('raw'); | |
117 | $link = $formatter->format($bookmark); | |
118 | ||
119 | return $this->displayForm($link, false, $request, $response); | |
120 | } | |
121 | ||
122 | /** | |
123 | * POST /admin/shaare | |
124 | */ | |
125 | public function save(Request $request, Response $response): Response | |
126 | { | |
127 | $this->checkToken($request); | |
128 | ||
129 | // lf_id should only be present if the link exists. | |
130 | $id = $request->getParam('lf_id') ? intval(escape($request->getParam('lf_id'))) : null; | |
131 | if (null !== $id && true === $this->container->bookmarkService->exists($id)) { | |
132 | // Edit | |
133 | $bookmark = $this->container->bookmarkService->get($id); | |
134 | } else { | |
135 | // New link | |
136 | $bookmark = new Bookmark(); | |
137 | } | |
138 | ||
139 | $bookmark->setTitle($request->getParam('lf_title')); | |
140 | $bookmark->setDescription($request->getParam('lf_description')); | |
141 | $bookmark->setUrl($request->getParam('lf_url'), $this->container->conf->get('security.allowed_protocols', [])); | |
142 | $bookmark->setPrivate(filter_var($request->getParam('lf_private'), FILTER_VALIDATE_BOOLEAN)); | |
143 | $bookmark->setTagsString($request->getParam('lf_tags')); | |
144 | ||
145 | if ($this->container->conf->get('thumbnails.mode', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE | |
146 | && false === $bookmark->isNote() | |
147 | ) { | |
148 | $bookmark->setThumbnail($this->container->thumbnailer->get($bookmark->getUrl())); | |
149 | } | |
150 | $this->container->bookmarkService->addOrSet($bookmark, false); | |
151 | ||
152 | // To preserve backward compatibility with 3rd parties, plugins still use arrays | |
153 | $formatter = $this->container->formatterFactory->getFormatter('raw'); | |
154 | $data = $formatter->format($bookmark); | |
155 | $data = $this->executeHooks('save_link', $data); | |
156 | ||
157 | $bookmark->fromArray($data); | |
158 | $this->container->bookmarkService->set($bookmark); | |
159 | ||
160 | // If we are called from the bookmarklet, we must close the popup: | |
161 | if ($request->getParam('source') === 'bookmarklet') { | |
162 | return $response->write('<script>self.close();</script>'); | |
163 | } | |
164 | ||
165 | if (!empty($request->getParam('returnurl'))) { | |
166 | $this->container->environment['HTTP_REFERER'] = escape($request->getParam('returnurl')); | |
167 | } | |
168 | ||
169 | return $this->redirectFromReferer( | |
170 | $request, | |
171 | $response, | |
172 | ['add-shaare', 'shaare'], ['addlink', 'post', 'edit_link'], | |
173 | $bookmark->getShortUrl() | |
174 | ); | |
175 | } | |
176 | ||
177 | /** | |
178 | * GET /admin/shaare/delete - Delete one or multiple bookmarks (depending on `id` query parameter). | |
179 | */ | |
180 | public function deleteBookmark(Request $request, Response $response): Response | |
181 | { | |
182 | $this->checkToken($request); | |
183 | ||
184 | $ids = escape(trim($request->getParam('id') ?? '')); | |
185 | if (empty($ids) || strpos($ids, ' ') !== false) { | |
186 | // multiple, space-separated ids provided | |
187 | $ids = array_values(array_filter(preg_split('/\s+/', $ids), 'ctype_digit')); | |
188 | } else { | |
189 | $ids = [$ids]; | |
190 | } | |
191 | ||
192 | // assert at least one id is given | |
193 | if (0 === count($ids)) { | |
194 | $this->saveErrorMessage(t('Invalid bookmark ID provided.')); | |
195 | ||
196 | return $this->redirectFromReferer($request, $response, [], ['delete-shaare']); | |
197 | } | |
198 | ||
199 | $formatter = $this->container->formatterFactory->getFormatter('raw'); | |
200 | $count = 0; | |
201 | foreach ($ids as $id) { | |
202 | try { | |
203 | $bookmark = $this->container->bookmarkService->get((int) $id); | |
204 | } catch (BookmarkNotFoundException $e) { | |
205 | $this->saveErrorMessage(sprintf( | |
206 | t('Bookmark with identifier %s could not be found.'), | |
207 | $id | |
208 | )); | |
209 | ||
210 | continue; | |
211 | } | |
212 | ||
213 | $data = $formatter->format($bookmark); | |
214 | $this->container->pluginManager->executeHooks('delete_link', $data); | |
215 | $this->container->bookmarkService->remove($bookmark, false); | |
216 | ++ $count; | |
217 | } | |
218 | ||
219 | if ($count > 0) { | |
220 | $this->container->bookmarkService->save(); | |
221 | } | |
222 | ||
223 | // If we are called from the bookmarklet, we must close the popup: | |
224 | if ($request->getParam('source') === 'bookmarklet') { | |
225 | return $response->write('<script>self.close();</script>'); | |
226 | } | |
227 | ||
228 | // Don't redirect to where we were previously because the datastore has changed. | |
229 | return $this->redirect($response, '/'); | |
230 | } | |
231 | ||
232 | /** | |
233 | * GET /admin/shaare/visibility | |
234 | * | |
235 | * Change visibility (public/private) of one or multiple bookmarks (depending on `id` query parameter). | |
236 | */ | |
237 | public function changeVisibility(Request $request, Response $response): Response | |
238 | { | |
239 | $this->checkToken($request); | |
240 | ||
241 | $ids = trim(escape($request->getParam('id') ?? '')); | |
242 | if (empty($ids) || strpos($ids, ' ') !== false) { | |
243 | // multiple, space-separated ids provided | |
244 | $ids = array_values(array_filter(preg_split('/\s+/', $ids), 'ctype_digit')); | |
245 | } else { | |
246 | // only a single id provided | |
247 | $ids = [$ids]; | |
248 | } | |
249 | ||
250 | // assert at least one id is given | |
251 | if (0 === count($ids)) { | |
252 | $this->saveErrorMessage(t('Invalid bookmark ID provided.')); | |
253 | ||
254 | return $this->redirectFromReferer($request, $response, [], ['change_visibility']); | |
255 | } | |
256 | ||
257 | // assert that the visibility is valid | |
258 | $visibility = $request->getParam('newVisibility'); | |
259 | if (null === $visibility || false === in_array($visibility, ['public', 'private'], true)) { | |
260 | $this->saveErrorMessage(t('Invalid visibility provided.')); | |
261 | ||
262 | return $this->redirectFromReferer($request, $response, [], ['change_visibility']); | |
263 | } else { | |
264 | $isPrivate = $visibility === 'private'; | |
265 | } | |
266 | ||
267 | $formatter = $this->container->formatterFactory->getFormatter('raw'); | |
268 | $count = 0; | |
269 | ||
270 | foreach ($ids as $id) { | |
271 | try { | |
272 | $bookmark = $this->container->bookmarkService->get((int) $id); | |
273 | } catch (BookmarkNotFoundException $e) { | |
274 | $this->saveErrorMessage(sprintf( | |
275 | t('Bookmark with identifier %s could not be found.'), | |
276 | $id | |
277 | )); | |
278 | ||
279 | continue; | |
280 | } | |
281 | ||
282 | $bookmark->setPrivate($isPrivate); | |
283 | ||
284 | // To preserve backward compatibility with 3rd parties, plugins still use arrays | |
285 | $data = $formatter->format($bookmark); | |
286 | $this->container->pluginManager->executeHooks('save_link', $data); | |
287 | $bookmark->fromArray($data); | |
288 | ||
289 | $this->container->bookmarkService->set($bookmark, false); | |
290 | ++$count; | |
291 | } | |
292 | ||
293 | if ($count > 0) { | |
294 | $this->container->bookmarkService->save(); | |
295 | } | |
296 | ||
297 | return $this->redirectFromReferer($request, $response, ['/visibility'], ['change_visibility']); | |
298 | } | |
299 | ||
300 | /** | |
301 | * GET /admin/shaare/{id}/pin - Pin or unpin a bookmark. | |
302 | */ | |
303 | public function pinBookmark(Request $request, Response $response, array $args): Response | |
304 | { | |
305 | $this->checkToken($request); | |
306 | ||
307 | $id = $args['id'] ?? ''; | |
308 | try { | |
309 | if (false === ctype_digit($id)) { | |
310 | throw new BookmarkNotFoundException(); | |
311 | } | |
312 | $bookmark = $this->container->bookmarkService->get((int) $id); // Read database | |
313 | } catch (BookmarkNotFoundException $e) { | |
314 | $this->saveErrorMessage(sprintf( | |
315 | t('Bookmark with identifier %s could not be found.'), | |
316 | $id | |
317 | )); | |
318 | ||
319 | return $this->redirectFromReferer($request, $response, ['/pin'], ['pin']); | |
320 | } | |
321 | ||
322 | $formatter = $this->container->formatterFactory->getFormatter('raw'); | |
323 | ||
324 | $bookmark->setSticky(!$bookmark->isSticky()); | |
325 | ||
326 | // To preserve backward compatibility with 3rd parties, plugins still use arrays | |
327 | $data = $formatter->format($bookmark); | |
328 | $this->container->pluginManager->executeHooks('save_link', $data); | |
329 | $bookmark->fromArray($data); | |
330 | ||
331 | $this->container->bookmarkService->set($bookmark); | |
332 | ||
333 | return $this->redirectFromReferer($request, $response, ['/pin'], ['pin']); | |
334 | } | |
335 | ||
336 | /** | |
337 | * Helper function used to display the shaare form whether it's a new or existing bookmark. | |
338 | * | |
339 | * @param array $link data used in template, either from parameters or from the data store | |
340 | */ | |
341 | protected function displayForm(array $link, bool $isNew, Request $request, Response $response): Response | |
342 | { | |
343 | $tags = $this->container->bookmarkService->bookmarksCountPerTag(); | |
344 | if ($this->container->conf->get('formatter') === 'markdown') { | |
345 | $tags[BookmarkMarkdownFormatter::NO_MD_TAG] = 1; | |
346 | } | |
347 | ||
348 | $data = [ | |
349 | 'link' => $link, | |
350 | 'link_is_new' => $isNew, | |
351 | 'http_referer' => escape($this->container->environment['HTTP_REFERER'] ?? ''), | |
352 | 'source' => $request->getParam('source') ?? '', | |
353 | 'tags' => $tags, | |
354 | 'default_private_links' => $this->container->conf->get('privacy.default_private_links', false), | |
355 | ]; | |
356 | ||
357 | $data = $this->executeHooks('render_editlink', $data); | |
358 | ||
359 | foreach ($data as $key => $value) { | |
360 | $this->assignView($key, $value); | |
361 | } | |
362 | ||
363 | $editLabel = false === $isNew ? t('Edit') .' ' : ''; | |
364 | $this->assignView( | |
365 | 'pagetitle', | |
366 | $editLabel . t('Shaare') .' - '. $this->container->conf->get('general.title', 'Shaarli') | |
367 | ); | |
368 | ||
369 | return $response->write($this->render(TemplatePage::EDIT_LINK)); | |
370 | } | |
371 | ||
372 | /** | |
373 | * @param mixed[] $data Variables passed to the template engine | |
374 | * | |
375 | * @return mixed[] Template data after active plugins render_picwall hook execution. | |
376 | */ | |
377 | protected function executeHooks(string $hook, array $data): array | |
378 | { | |
379 | $this->container->pluginManager->executeHooks( | |
380 | $hook, | |
381 | $data | |
382 | ); | |
383 | ||
384 | return $data; | |
385 | } | |
386 | } |