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\BookmarkFormatter
;
10 use Shaarli\Formatter\BookmarkMarkdownFormatter
;
11 use Shaarli\Render\TemplatePage
;
12 use Shaarli\Thumbnailer
;
13 use Slim\Http\Request
;
14 use Slim\Http\Response
;
16 class ShaarePublishController
extends ShaarliAdminController
19 * @var BookmarkFormatter[] Statically cached instances of formatters
21 protected $formatters = [];
24 * @var array Statically cached bookmark's tags counts
29 * GET /admin/shaare - Displays the bookmark form for creation.
30 * Note that if the URL is found in existing bookmarks, then it will be in edit mode.
32 public function displayCreateForm(Request
$request, Response
$response): Response
34 $url = cleanup_url($request->getParam('post'));
35 $link = $this->buildLinkDataFromUrl($request, $url);
37 return $this->displayForm($link, $link['linkIsNew'], $request, $response);
41 * POST /admin/shaare-batch - Displays multiple creation/edit forms from bulk add in add-link page.
43 public function displayCreateBatchForms(Request
$request, Response
$response): Response
45 $urls = array_map('cleanup_url', explode(PHP_EOL
, $request->getParam('urls')));
48 foreach ($urls as $url) {
52 $link = $this->buildLinkDataFromUrl($request, $url);
53 $data = $this->buildFormData($link, $link['linkIsNew'], $request);
54 $data['token'] = $this->container
->sessionManager
->generateToken();
55 $data['source'] = 'batch';
57 $this->executePageHooks('render_editlink', $data, TemplatePage
::EDIT_LINK
);
62 $this->assignView('links', $links);
63 $this->assignView('batch_mode', true);
64 $this->assignView('async_metadata', $this->container
->conf
->get('general.enable_async_metadata', true));
66 return $response->write($this->render(TemplatePage
::EDIT_LINK_BATCH
));
70 * GET /admin/shaare/{id} - Displays the bookmark form in edition mode.
72 public function displayEditForm(Request
$request, Response
$response, array $args): Response
74 $id = $args['id'] ?? '';
76 if (false === ctype_digit($id)) {
77 throw new BookmarkNotFoundException();
79 $bookmark = $this->container
->bookmarkService
->get((int) $id); // Read database
80 } catch (BookmarkNotFoundException
$e) {
81 $this->saveErrorMessage(sprintf(
82 t('Bookmark with identifier %s could not be found.'),
86 return $this->redirect($response, '/');
89 $formatter = $this->getFormatter('raw');
90 $link = $formatter->format($bookmark);
92 return $this->displayForm($link, false, $request, $response);
98 public function save(Request
$request, Response
$response): Response
100 $this->checkToken($request);
102 // lf_id should only be present if the link exists.
103 $id = $request->getParam('lf_id') !== null ? intval(escape($request->getParam('lf_id'))) : null;
104 if (null !== $id && true === $this->container
->bookmarkService
->exists($id)) {
106 $bookmark = $this->container
->bookmarkService
->get($id);
109 $bookmark = new Bookmark();
112 $bookmark->setTitle($request->getParam('lf_title'));
113 $bookmark->setDescription($request->getParam('lf_description'));
114 $bookmark->setUrl($request->getParam('lf_url'), $this->container
->conf
->get('security.allowed_protocols', []));
115 $bookmark->setPrivate(filter_var($request->getParam('lf_private'), FILTER_VALIDATE_BOOLEAN
));
116 $bookmark->setTagsString(
117 $request->getParam('lf_tags'),
118 $this->container
->conf
->get('general.tags_separator', ' ')
122 $this->container
->conf
->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
123 && true !== $this->container
->conf
->get('general.enable_async_metadata', true)
124 && $bookmark->shouldUpdateThumbnail()
126 $bookmark->setThumbnail($this->container
->thumbnailer
->get($bookmark->getUrl()));
128 $this->container
->bookmarkService
->addOrSet($bookmark, false);
130 // To preserve backward compatibility with 3rd parties, plugins still use arrays
131 $formatter = $this->getFormatter('raw');
132 $data = $formatter->format($bookmark);
133 $this->executePageHooks('save_link', $data);
135 $bookmark->fromArray($data, $this->container
->conf
->get('general.tags_separator', ' '));
136 $this->container
->bookmarkService
->set($bookmark);
138 // If we are called from the bookmarklet, we must close the popup:
139 if ($request->getParam('source') === 'bookmarklet') {
140 return $response->write('<script>self.close();</script>');
141 } elseif ($request->getParam('source') === 'batch') {
145 if (!empty($request->getParam('returnurl'))) {
146 $this->container
->environment
['HTTP_REFERER'] = $request->getParam('returnurl');
149 return $this->redirectFromReferer(
152 ['/admin/add-shaare', '/admin/shaare'],
153 ['addlink', 'post', 'edit_link'],
154 $bookmark->getShortUrl()
159 * Helper function used to display the shaare form whether it's a new or existing bookmark.
161 * @param array $link data used in template, either from parameters or from the data store
163 protected function displayForm(array $link, bool $isNew, Request
$request, Response
$response): Response
165 $data = $this->buildFormData($link, $isNew, $request);
167 $this->executePageHooks('render_editlink', $data, TemplatePage
::EDIT_LINK
);
169 foreach ($data as $key => $value) {
170 $this->assignView($key, $value);
173 $editLabel = false === $isNew ? t('Edit') . ' ' : '';
176 $editLabel . t('Shaare') . ' - ' . $this->container
->conf
->get('general.title', 'Shaarli')
179 return $response->write($this->render(TemplatePage
::EDIT_LINK
));
182 protected function buildLinkDataFromUrl(Request
$request, string $url): array
184 // Check if URL is not already in database (in this case, we will edit the existing link)
185 $bookmark = $this->container
->bookmarkService
->findByUrl($url);
186 if (null === $bookmark) {
187 // Get shaare data if it was provided in URL (e.g.: by the bookmarklet).
188 $title = $request->getParam('title');
189 $description = $request->getParam('description');
190 $tags = $request->getParam('tags');
191 if ($request->getParam('private') !== null) {
192 $private = filter_var($request->getParam('private'), FILTER_VALIDATE_BOOLEAN
);
194 $private = $this->container
->conf
->get('privacy.default_private_links', false);
197 // If this is an HTTP(S) link, we try go get the page to extract
198 // the title (otherwise we will to straight to the edit form.)
200 true !== $this->container
->conf
->get('general.enable_async_metadata', true)
202 && strpos(get_url_scheme($url) ?: '', 'http') !== false
204 $metadata = $this->container
->metadataRetriever
->retrieve($url);
208 $metadata['title'] = $this->container
->conf
->get('general.default_note_title', t('Note: '));
212 'title' => $title ?? $metadata['title'] ?? '',
214 'description' => $description ?? $metadata['description'] ?? '',
215 'tags' => $tags ?? $metadata['tags'] ?? '',
216 'private' => $private,
221 $formatter = $this->getFormatter('raw');
222 $link = $formatter->format($bookmark);
223 $link['linkIsNew'] = false;
228 protected function buildFormData(array $link, bool $isNew, Request
$request): array
230 $link['tags'] = $link['tags'] !== null && strlen($link['tags']) > 0
231 ? $link['tags'] . $this->container
->conf
->get('general.tags_separator', ' ')
237 'link_is_new' => $isNew,
238 'http_referer' => $this->container
->environment
['HTTP_REFERER'] ?? '',
239 'source' => $request->getParam('source') ?? '',
240 'tags' => $this->getTags(),
241 'default_private_links' => $this->container
->conf
->get('privacy.default_private_links', false),
242 'async_metadata' => $this->container
->conf
->get('general.enable_async_metadata', true),
243 'retrieve_description' => $this->container
->conf
->get('general.retrieve_description', false),
248 * Memoize formatterFactory->getFormatter() calls.
250 protected function getFormatter(string $type): BookmarkFormatter
252 if (!array_key_exists($type, $this->formatters
) || $this->formatters
[$type] === null) {
253 $this->formatters
[$type] = $this->container
->formatterFactory
->getFormatter($type);
256 return $this->formatters
[$type];
260 * Memoize bookmarkService->bookmarksCountPerTag() calls.
262 protected function getTags(): array
264 if ($this->tags
=== null) {
265 $this->tags
= $this->container
->bookmarkService
->bookmarksCountPerTag();
267 if ($this->container
->conf
->get('formatter') === 'markdown') {
268 $this->tags
[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;