--- /dev/null
+<?php
+
+declare(strict_types=1);
+
+namespace Shaarli\Front\Controller\Visitor;
+
+use Shaarli\Bookmark\Bookmark;
+use Shaarli\Bookmark\Exception\BookmarkNotFoundException;
+use Shaarli\Legacy\LegacyController;
+use Shaarli\Legacy\UnknowLegacyRouteException;
+use Shaarli\Render\TemplatePage;
+use Shaarli\Thumbnailer;
+use Slim\Http\Request;
+use Slim\Http\Response;
+
+/**
+ * Class BookmarkListController
+ *
+ * Slim controller used to render the bookmark list, the home page of Shaarli.
+ * It also displays permalinks, and process legacy routes based on GET parameters.
+ */
+class BookmarkListController extends ShaarliVisitorController
+{
+ /**
+ * GET / - Displays the bookmark list, with optional filter parameters.
+ */
+ public function index(Request $request, Response $response): Response
+ {
+ $legacyResponse = $this->processLegacyController($request, $response);
+ if (null !== $legacyResponse) {
+ return $legacyResponse;
+ }
+
+ $formatter = $this->container->formatterFactory->getFormatter();
+
+ $searchTags = escape(normalize_spaces($request->getParam('searchtags') ?? ''));
+ $searchTerm = escape(normalize_spaces($request->getParam('searchterm') ?? ''));;
+
+ // Filter bookmarks according search parameters.
+ $visibility = $this->container->sessionManager->getSessionParameter('visibility');
+ $search = [
+ 'searchtags' => $searchTags,
+ 'searchterm' => $searchTerm,
+ ];
+ $linksToDisplay = $this->container->bookmarkService->search(
+ $search,
+ $visibility,
+ false,
+ !!$this->container->sessionManager->getSessionParameter('untaggedonly')
+ ) ?? [];
+
+ // ---- Handle paging.
+ $keys = [];
+ foreach ($linksToDisplay as $key => $value) {
+ $keys[] = $key;
+ }
+
+ $linksPerPage = $this->container->sessionManager->getSessionParameter('LINKS_PER_PAGE', 20) ?: 20;
+
+ // Select articles according to paging.
+ $pageCount = (int) ceil(count($keys) / $linksPerPage) ?: 1;
+ $page = (int) $request->getParam('page') ?? 1;
+ $page = $page < 1 ? 1 : $page;
+ $page = $page > $pageCount ? $pageCount : $page;
+
+ // Start index.
+ $i = ($page - 1) * $linksPerPage;
+ $end = $i + $linksPerPage;
+
+ $linkDisp = [];
+ $save = false;
+ while ($i < $end && $i < count($keys)) {
+ $save = $this->updateThumbnail($linksToDisplay[$keys[$i]], false) || $save;
+ $link = $formatter->format($linksToDisplay[$keys[$i]]);
+
+ $linkDisp[$keys[$i]] = $link;
+ $i++;
+ }
+
+ if ($save) {
+ $this->container->bookmarkService->save();
+ }
+
+ // Compute paging navigation
+ $searchtagsUrl = $searchTags === '' ? '' : '&searchtags=' . urlencode($searchTags);
+ $searchtermUrl = $searchTerm === '' ? '' : '&searchterm=' . urlencode($searchTerm);
+
+ $previous_page_url = '';
+ if ($i !== count($keys)) {
+ $previous_page_url = '?page=' . ($page + 1) . $searchtermUrl . $searchtagsUrl;
+ }
+ $next_page_url = '';
+ if ($page > 1) {
+ $next_page_url = '?page=' . ($page - 1) . $searchtermUrl . $searchtagsUrl;
+ }
+
+ // Fill all template fields.
+ $data = array_merge(
+ $this->initializeTemplateVars(),
+ [
+ 'previous_page_url' => $previous_page_url,
+ 'next_page_url' => $next_page_url,
+ 'page_current' => $page,
+ 'page_max' => $pageCount,
+ 'result_count' => count($linksToDisplay),
+ 'search_term' => $searchTerm,
+ 'search_tags' => $searchTags,
+ 'visibility' => $visibility,
+ 'links' => $linkDisp,
+ ]
+ );
+
+ if (!empty($searchTerm) || !empty($searchTags)) {
+ $data['pagetitle'] = t('Search: ');
+ $data['pagetitle'] .= ! empty($searchTerm) ? $searchTerm . ' ' : '';
+ $bracketWrap = function ($tag) {
+ return '[' . $tag . ']';
+ };
+ $data['pagetitle'] .= ! empty($searchTags)
+ ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchTags))) . ' '
+ : '';
+ $data['pagetitle'] .= '- ';
+ }
+
+ $data['pagetitle'] = ($data['pagetitle'] ?? '') . $this->container->conf->get('general.title', 'Shaarli');
+
+ $this->executeHooks($data);
+ $this->assignAllView($data);
+
+ return $response->write($this->render(TemplatePage::LINKLIST));
+ }
+
+ /**
+ * GET /shaare/{hash} - Display a single shaare
+ */
+ public function permalink(Request $request, Response $response, array $args): Response
+ {
+ try {
+ $bookmark = $this->container->bookmarkService->findByHash($args['hash']);
+ } catch (BookmarkNotFoundException $e) {
+ $this->assignView('error_message', $e->getMessage());
+
+ return $response->write($this->render(TemplatePage::ERROR_404));
+ }
+
+ $this->updateThumbnail($bookmark);
+
+ $data = array_merge(
+ $this->initializeTemplateVars(),
+ [
+ 'pagetitle' => $bookmark->getTitle() .' - '. $this->container->conf->get('general.title', 'Shaarli'),
+ 'links' => [$this->container->formatterFactory->getFormatter()->format($bookmark)],
+ ]
+ );
+
+ $this->executeHooks($data);
+ $this->assignAllView($data);
+
+ return $response->write($this->render(TemplatePage::LINKLIST));
+ }
+
+ /**
+ * Update the thumbnail of a single bookmark if necessary.
+ */
+ protected function updateThumbnail(Bookmark $bookmark, bool $writeDatastore = true): bool
+ {
+ // Logged in, thumbnails enabled, not a note, is HTTP
+ // and (never retrieved yet or no valid cache file)
+ if ($this->container->loginManager->isLoggedIn()
+ && $this->container->conf->get('thumbnails.mode', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE
+ && false !== $bookmark->getThumbnail()
+ && !$bookmark->isNote()
+ && (null === $bookmark->getThumbnail() || !is_file($bookmark->getThumbnail()))
+ && startsWith(strtolower($bookmark->getUrl()), 'http')
+ ) {
+ $bookmark->setThumbnail($this->container->thumbnailer->get($bookmark->getUrl()));
+ $this->container->bookmarkService->set($bookmark, $writeDatastore);
+
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * @param mixed[] $data Template vars to process in plugins, passed as reference.
+ */
+ protected function executeHooks(array &$data): void
+ {
+ $this->container->pluginManager->executeHooks(
+ 'render_linklist',
+ $data,
+ ['loggedin' => $this->container->loginManager->isLoggedIn()]
+ );
+ }
+
+ /**
+ * @return string[] Default template variables without values.
+ */
+ protected function initializeTemplateVars(): array
+ {
+ return [
+ 'previous_page_url' => '',
+ 'next_page_url' => '',
+ 'page_max' => '',
+ 'search_tags' => '',
+ 'result_count' => '',
+ ];
+ }
+
+ /**
+ * Process legacy routes if necessary. They used query parameters.
+ * If no legacy routes is passed, return null.
+ */
+ protected function processLegacyController(Request $request, Response $response): ?Response
+ {
+ // Legacy smallhash filter
+ $queryString = $this->container->environment['QUERY_STRING'] ?? null;
+ if (null !== $queryString && 1 === preg_match('/^([a-zA-Z0-9-_@]{6})($|&|#)/', $queryString, $match)) {
+ return $this->redirect($response, '/shaare/' . $match[1]);
+ }
+
+ // Legacy controllers (mostly used for redirections)
+ if (null !== $request->getQueryParam('do')) {
+ $legacyController = new LegacyController($this->container);
+
+ try {
+ return $legacyController->process($request, $response, $request->getQueryParam('do'));
+ } catch (UnknowLegacyRouteException $e) {
+ // We ignore legacy 404
+ return null;
+ }
+ }
+
+ // Legacy GET admin routes
+ $legacyGetRoutes = array_intersect(
+ LegacyController::LEGACY_GET_ROUTES,
+ array_keys($request->getQueryParams() ?? [])
+ );
+ if (1 === count($legacyGetRoutes)) {
+ $legacyController = new LegacyController($this->container);
+
+ return $legacyController->process($request, $response, $legacyGetRoutes[0]);
+ }
+
+ return null;
+ }
+}
projects / github / shaarli / Shaarli.git / blobdiff