3 declare(strict_types
=1);
5 namespace Shaarli\Front\Controller\Admin
;
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
;
16 * Class PostBookmarkController
18 * Slim controller used to handle Shaarli create or edit bookmarks.
20 class ManageShaareController
extends ShaarliAdminController
23 * GET /admin/add-shaare - Displays the form used to create a new bookmark from an URL
25 public function addShaare(Request
$request, Response
$response): Response
29 t('Shaare a new link') .' - '. $this->container
->conf
->get('general.title', 'Shaarli')
32 return $response->write($this->render(TemplatePage
::ADDLINK
));
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.
39 public function displayCreateForm(Request
$request, Response
$response): Response
41 $url = cleanup_url($request->getParam('post'));
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) {
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
);
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 (true !== $this->container
->conf
->get('general.enable_async_metadata', true)
58 && strpos(get_url_scheme($url) ?: '', 'http') !== false
60 $metadata = $this->container
->metadataRetriever
->retrieve($url);
64 $metadata['title'] = $this->container
->conf
->get('general.default_note_title', t('Note: '));
68 'title' => $title ?? $metadata['title'] ?? '',
70 'description' => $description ?? $metadata['description'] ?? '',
71 'tags' => $tags ?? $metadata['tags'] ?? '',
72 'private' => $private,
75 $formatter = $this->container
->formatterFactory
->getFormatter('raw');
76 $link = $formatter->format($bookmark);
79 return $this->displayForm($link, $linkIsNew, $request, $response);
83 * GET /admin/shaare/{id} - Displays the bookmark form in edition mode.
85 public function displayEditForm(Request
$request, Response
$response, array $args): Response
87 $id = $args['id'] ?? '';
89 if (false === ctype_digit($id)) {
90 throw new BookmarkNotFoundException();
92 $bookmark = $this->container
->bookmarkService
->get((int) $id); // Read database
93 } catch (BookmarkNotFoundException
$e) {
94 $this->saveErrorMessage(sprintf(
95 t('Bookmark with identifier %s could not be found.'),
99 return $this->redirect($response, '/');
102 $formatter = $this->container
->formatterFactory
->getFormatter('raw');
103 $link = $formatter->format($bookmark);
105 return $this->displayForm($link, false, $request, $response);
111 public function save(Request
$request, Response
$response): Response
113 $this->checkToken($request);
115 // lf_id should only be present if the link exists.
116 $id = $request->getParam('lf_id') !== null ? intval(escape($request->getParam('lf_id'))) : null;
117 if (null !== $id && true === $this->container
->bookmarkService
->exists($id)) {
119 $bookmark = $this->container
->bookmarkService
->get($id);
122 $bookmark = new Bookmark();
125 $bookmark->setTitle($request->getParam('lf_title'));
126 $bookmark->setDescription($request->getParam('lf_description'));
127 $bookmark->setUrl($request->getParam('lf_url'), $this->container
->conf
->get('security.allowed_protocols', []));
128 $bookmark->setPrivate(filter_var($request->getParam('lf_private'), FILTER_VALIDATE_BOOLEAN
));
129 $bookmark->setTagsString($request->getParam('lf_tags'));
131 if ($this->container
->conf
->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
132 && true !== $this->container
->conf
->get('general.enable_async_metadata', true)
133 && $bookmark->shouldUpdateThumbnail()
135 $bookmark->setThumbnail($this->container
->thumbnailer
->get($bookmark->getUrl()));
137 $this->container
->bookmarkService
->addOrSet($bookmark, false);
139 // To preserve backward compatibility with 3rd parties, plugins still use arrays
140 $formatter = $this->container
->formatterFactory
->getFormatter('raw');
141 $data = $formatter->format($bookmark);
142 $this->executePageHooks('save_link', $data);
144 $bookmark->fromArray($data);
145 $this->container
->bookmarkService
->set($bookmark);
147 // If we are called from the bookmarklet, we must close the popup:
148 if ($request->getParam('source') === 'bookmarklet') {
149 return $response->write('<script>self.close();</script>');
152 if (!empty($request->getParam('returnurl'))) {
153 $this->container
->environment
['HTTP_REFERER'] = escape($request->getParam('returnurl'));
156 return $this->redirectFromReferer(
159 ['/admin/add-shaare', '/admin/shaare'], ['addlink', 'post', 'edit_link'],
160 $bookmark->getShortUrl()
165 * GET /admin/shaare/delete - Delete one or multiple bookmarks (depending on `id` query parameter).
167 public function deleteBookmark(Request
$request, Response
$response): Response
169 $this->checkToken($request);
171 $ids = escape(trim($request->getParam('id') ?? ''));
172 if (empty($ids) || strpos($ids, ' ') !== false) {
173 // multiple, space-separated ids provided
174 $ids = array_values(array_filter(preg_split('/\s+/', $ids), 'ctype_digit'));
179 // assert at least one id is given
180 if (0 === count($ids)) {
181 $this->saveErrorMessage(t('Invalid bookmark ID provided.'));
183 return $this->redirectFromReferer($request, $response, [], ['delete-shaare']);
186 $formatter = $this->container
->formatterFactory
->getFormatter('raw');
188 foreach ($ids as $id) {
190 $bookmark = $this->container
->bookmarkService
->get((int) $id);
191 } catch (BookmarkNotFoundException
$e) {
192 $this->saveErrorMessage(sprintf(
193 t('Bookmark with identifier %s could not be found.'),
200 $data = $formatter->format($bookmark);
201 $this->executePageHooks('delete_link', $data);
202 $this->container
->bookmarkService
->remove($bookmark, false);
207 $this->container
->bookmarkService
->save();
210 // If we are called from the bookmarklet, we must close the popup:
211 if ($request->getParam('source') === 'bookmarklet') {
212 return $response->write('<script>self.close();</script>');
215 // Don't redirect to where we were previously because the datastore has changed.
216 return $this->redirect($response, '/');
220 * GET /admin/shaare/visibility
222 * Change visibility (public/private) of one or multiple bookmarks (depending on `id` query parameter).
224 public function changeVisibility(Request
$request, Response
$response): Response
226 $this->checkToken($request);
228 $ids = trim(escape($request->getParam('id') ?? ''));
229 if (empty($ids) || strpos($ids, ' ') !== false) {
230 // multiple, space-separated ids provided
231 $ids = array_values(array_filter(preg_split('/\s+/', $ids), 'ctype_digit'));
233 // only a single id provided
237 // assert at least one id is given
238 if (0 === count($ids)) {
239 $this->saveErrorMessage(t('Invalid bookmark ID provided.'));
241 return $this->redirectFromReferer($request, $response, [], ['change_visibility']);
244 // assert that the visibility is valid
245 $visibility = $request->getParam('newVisibility');
246 if (null === $visibility || false === in_array($visibility, ['public', 'private'], true)) {
247 $this->saveErrorMessage(t('Invalid visibility provided.'));
249 return $this->redirectFromReferer($request, $response, [], ['change_visibility']);
251 $isPrivate = $visibility === 'private';
254 $formatter = $this->container
->formatterFactory
->getFormatter('raw');
257 foreach ($ids as $id) {
259 $bookmark = $this->container
->bookmarkService
->get((int) $id);
260 } catch (BookmarkNotFoundException
$e) {
261 $this->saveErrorMessage(sprintf(
262 t('Bookmark with identifier %s could not be found.'),
269 $bookmark->setPrivate($isPrivate);
271 // To preserve backward compatibility with 3rd parties, plugins still use arrays
272 $data = $formatter->format($bookmark);
273 $this->executePageHooks('save_link', $data);
274 $bookmark->fromArray($data);
276 $this->container
->bookmarkService
->set($bookmark, false);
281 $this->container
->bookmarkService
->save();
284 return $this->redirectFromReferer($request, $response, ['/visibility'], ['change_visibility']);
288 * GET /admin/shaare/{id}/pin - Pin or unpin a bookmark.
290 public function pinBookmark(Request
$request, Response
$response, array $args): Response
292 $this->checkToken($request);
294 $id = $args['id'] ?? '';
296 if (false === ctype_digit($id)) {
297 throw new BookmarkNotFoundException();
299 $bookmark = $this->container
->bookmarkService
->get((int) $id); // Read database
300 } catch (BookmarkNotFoundException
$e) {
301 $this->saveErrorMessage(sprintf(
302 t('Bookmark with identifier %s could not be found.'),
306 return $this->redirectFromReferer($request, $response, ['/pin'], ['pin']);
309 $formatter = $this->container
->formatterFactory
->getFormatter('raw');
311 $bookmark->setSticky(!$bookmark->isSticky());
313 // To preserve backward compatibility with 3rd parties, plugins still use arrays
314 $data = $formatter->format($bookmark);
315 $this->executePageHooks('save_link', $data);
316 $bookmark->fromArray($data);
318 $this->container
->bookmarkService
->set($bookmark);
320 return $this->redirectFromReferer($request, $response, ['/pin'], ['pin']);
324 * GET /admin/shaare/private/{hash} - Attach a private key to given bookmark, then redirect to the sharing URL.
326 public function sharePrivate(Request
$request, Response
$response, array $args): Response
328 $this->checkToken($request);
330 $hash = $args['hash'] ?? '';
331 $bookmark = $this->container
->bookmarkService
->findByHash($hash);
333 if ($bookmark->isPrivate() !== true) {
334 return $this->redirect($response, '/shaare/' . $hash);
337 if (empty($bookmark->getAdditionalContentEntry('private_key'))) {
338 $privateKey = bin2hex(random_bytes(16));
339 $bookmark->addAdditionalContentEntry('private_key', $privateKey);
340 $this->container
->bookmarkService
->set($bookmark);
343 return $this->redirect(
345 '/shaare/' . $hash . '?key=' . $bookmark->getAdditionalContentEntry('private_key')
350 * Helper function used to display the shaare form whether it's a new or existing bookmark.
352 * @param array $link data used in template, either from parameters or from the data store
354 protected function displayForm(array $link, bool $isNew, Request
$request, Response
$response): Response
356 $tags = $this->container
->bookmarkService
->bookmarksCountPerTag();
357 if ($this->container
->conf
->get('formatter') === 'markdown') {
358 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
363 'link_is_new' => $isNew,
364 'http_referer' => $this->container
->environment
['HTTP_REFERER'] ?? '',
365 'source' => $request->getParam('source') ?? '',
367 'default_private_links' => $this->container
->conf
->get('privacy.default_private_links', false),
368 'async_metadata' => $this->container
->conf
->get('general.enable_async_metadata', true),
369 'retrieve_description' => $this->container
->conf
->get('general.retrieve_description', false),
372 $this->executePageHooks('render_editlink', $data, TemplatePage
::EDIT_LINK
);
374 foreach ($data as $key => $value) {
375 $this->assignView($key, $value);
378 $editLabel = false === $isNew ? t('Edit') .' ' : '';
381 $editLabel . t('Shaare') .' - '. $this->container
->conf
->get('general.title', 'Shaarli')
384 return $response->write($this->render(TemplatePage
::EDIT_LINK
));