application/front/controller/admin/ShaarePublishController.php

   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\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;
  15
  16 class ShaarePublishController extends ShaarliAdminController
  17 {
  18     /**
  19      * @var BookmarkFormatter[] Statically cached instances of formatters
  20      */
  21     protected $formatters = [];
  22
  23     /**
  24      * @var array Statically cached bookmark's tags counts
  25      */
  26     protected $tags;
  27
  28     /**
  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.
  31      */
  32     public function displayCreateForm(Request $request, Response $response): Response
  33     {
  34         $url = cleanup_url($request->getParam('post'));
  35         $link = $this->buildLinkDataFromUrl($request, $url);
  36
  37         return $this->displayForm($link, $link['linkIsNew'], $request, $response);
  38     }
  39
  40     /**
  41      * POST /admin/shaare-batch - Displays multiple creation/edit forms from bulk add in add-link page.
  42      */
  43     public function displayCreateBatchForms(Request $request, Response $response): Response
  44     {
  45         $urls = array_map('cleanup_url', explode(PHP_EOL, $request->getParam('urls')));
  46
  47         $links = [];
  48         foreach ($urls as $url) {
  49             if (empty($url)) {
  50                 continue;
  51             }
  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';
  56
  57             $this->executePageHooks('render_editlink', $data, TemplatePage::EDIT_LINK);
  58
  59             $links[] = $data;
  60         }
  61
  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));
  65
  66         return $response->write($this->render(TemplatePage::EDIT_LINK_BATCH));
  67     }
  68
  69     /**
  70      * GET /admin/shaare/{id} - Displays the bookmark form in edition mode.
  71      */
  72     public function displayEditForm(Request $request, Response $response, array $args): Response
  73     {
  74         $id = $args['id'] ?? '';
  75         try {
  76             if (false === ctype_digit($id)) {
  77                 throw new BookmarkNotFoundException();
  78             }
  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.'),
  83                 $id
  84             ));
  85
  86             return $this->redirect($response, '/');
  87         }
  88
  89         $formatter = $this->getFormatter('raw');
  90         $link = $formatter->format($bookmark);
  91
  92         return $this->displayForm($link, false, $request, $response);
  93     }
  94
  95     /**
  96      * POST /admin/shaare
  97      */
  98     public function save(Request $request, Response $response): Response
  99     {
 100         $this->checkToken($request);
 101
 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)) {
 105             // Edit
 106             $bookmark = $this->container->bookmarkService->get($id);
 107         } else {
 108             // New link
 109             $bookmark = new Bookmark();
 110         }
 111
 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', ' ')
 119         );
 120
 121         if ($this->container->conf->get('thumbnails.mode', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE
 122             && true !== $this->container->conf->get('general.enable_async_metadata', true)
 123             && $bookmark->shouldUpdateThumbnail()
 124         ) {
 125             $bookmark->setThumbnail($this->container->thumbnailer->get($bookmark->getUrl()));
 126         }
 127         $this->container->bookmarkService->addOrSet($bookmark, false);
 128
 129         // To preserve backward compatibility with 3rd parties, plugins still use arrays
 130         $formatter = $this->getFormatter('raw');
 131         $data = $formatter->format($bookmark);
 132         $this->executePageHooks('save_link', $data);
 133
 134         $bookmark->fromArray($data, $this->container->conf->get('general.tags_separator', ' '));
 135         $this->container->bookmarkService->set($bookmark);
 136
 137         // If we are called from the bookmarklet, we must close the popup:
 138         if ($request->getParam('source') === 'bookmarklet') {
 139             return $response->write('<script>self.close();</script>');
 140         } elseif ($request->getParam('source') === 'batch') {
 141             return $response;
 142         }
 143
 144         if (!empty($request->getParam('returnurl'))) {
 145             $this->container->environment['HTTP_REFERER'] = $request->getParam('returnurl');
 146         }
 147
 148         return $this->redirectFromReferer(
 149             $request,
 150             $response,
 151             ['/admin/add-shaare', '/admin/shaare'], ['addlink', 'post', 'edit_link'],
 152             $bookmark->getShortUrl()
 153         );
 154     }
 155
 156     /**
 157      * Helper function used to display the shaare form whether it's a new or existing bookmark.
 158      *
 159      * @param array $link data used in template, either from parameters or from the data store
 160      */
 161     protected function displayForm(array $link, bool $isNew, Request $request, Response $response): Response
 162     {
 163         $data = $this->buildFormData($link, $isNew, $request);
 164
 165         $this->executePageHooks('render_editlink', $data, TemplatePage::EDIT_LINK);
 166
 167         foreach ($data as $key => $value) {
 168             $this->assignView($key, $value);
 169         }
 170
 171         $editLabel = false === $isNew ? t('Edit') .' ' : '';
 172         $this->assignView(
 173             'pagetitle',
 174             $editLabel . t('Shaare') .' - '. $this->container->conf->get('general.title', 'Shaarli')
 175         );
 176
 177         return $response->write($this->render(TemplatePage::EDIT_LINK));
 178     }
 179
 180     protected function buildLinkDataFromUrl(Request $request, string $url): array
 181     {
 182         // Check if URL is not already in database (in this case, we will edit the existing link)
 183         $bookmark = $this->container->bookmarkService->findByUrl($url);
 184         if (null === $bookmark) {
 185             // Get shaare data if it was provided in URL (e.g.: by the bookmarklet).
 186             $title = $request->getParam('title');
 187             $description = $request->getParam('description');
 188             $tags = $request->getParam('tags');
 189             if ($request->getParam('private') !== null) {
 190                 $private = filter_var($request->getParam('private'), FILTER_VALIDATE_BOOLEAN);
 191             } else {
 192                 $private = $this->container->conf->get('privacy.default_private_links', false);
 193             }
 194
 195             // If this is an HTTP(S) link, we try go get the page to extract
 196             // the title (otherwise we will to straight to the edit form.)
 197             if (true !== $this->container->conf->get('general.enable_async_metadata', true)
 198                 && empty($title)
 199                 && strpos(get_url_scheme($url) ?: '', 'http') !== false
 200             ) {
 201                 $metadata = $this->container->metadataRetriever->retrieve($url);
 202             }
 203
 204             if (empty($url)) {
 205                 $metadata['title'] = $this->container->conf->get('general.default_note_title', t('Note: '));
 206             }
 207
 208             return [
 209                 'title' => $title ?? $metadata['title'] ?? '',
 210                 'url' => $url ?? '',
 211                 'description' => $description ?? $metadata['description'] ?? '',
 212                 'tags' => $tags ?? $metadata['tags'] ?? '',
 213                 'private' => $private,
 214                 'linkIsNew' => true,
 215             ];
 216         }
 217
 218         $formatter = $this->getFormatter('raw');
 219         $link = $formatter->format($bookmark);
 220         $link['linkIsNew'] = false;
 221
 222         return $link;
 223     }
 224
 225     protected function buildFormData(array $link, bool $isNew, Request $request): array
 226     {
 227         $link['tags'] = strlen($link['tags']) > 0
 228             ? $link['tags'] . $this->container->conf->get('general.tags_separator', ' ')
 229             : $link['tags']
 230         ;
 231
 232         return escape([
 233             'link' => $link,
 234             'link_is_new' => $isNew,
 235             'http_referer' => $this->container->environment['HTTP_REFERER'] ?? '',
 236             'source' => $request->getParam('source') ?? '',
 237             'tags' => $this->getTags(),
 238             'default_private_links' => $this->container->conf->get('privacy.default_private_links', false),
 239             'async_metadata' => $this->container->conf->get('general.enable_async_metadata', true),
 240             'retrieve_description' => $this->container->conf->get('general.retrieve_description', false),
 241         ]);
 242     }
 243
 244     /**
 245      * Memoize formatterFactory->getFormatter() calls.
 246      */
 247     protected function getFormatter(string $type): BookmarkFormatter
 248     {
 249         if (!array_key_exists($type, $this->formatters) || $this->formatters[$type] === null) {
 250             $this->formatters[$type] = $this->container->formatterFactory->getFormatter($type);
 251         }
 252
 253         return $this->formatters[$type];
 254     }
 255
 256     /**
 257      * Memoize bookmarkService->bookmarksCountPerTag() calls.
 258      */
 259     protected function getTags(): array
 260     {
 261         if ($this->tags === null) {
 262             $this->tags = $this->container->bookmarkService->bookmarksCountPerTag();
 263
 264             if ($this->container->conf->get('formatter') === 'markdown') {
 265                 $this->tags[BookmarkMarkdownFormatter::NO_MD_TAG] = 1;
 266             }
 267         }
 268
 269         return $this->tags;
 270     }
 271 }