3 * Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
5 * Friendly fork by the Shaarli community:
6 * - https://github.com/shaarli/Shaarli
8 * Original project by sebsauvage.net:
9 * - http://sebsauvage.net/wiki/doku.php?id=php:shaarli
10 * - https://github.com/sebsauvage/Shaarli
12 * Licence: http://www.opensource.org/licenses/zlib-license.php
15 // Set 'UTC' as the default timezone if it is not defined in php.ini
16 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
17 if (date_default_timezone_get() == '') {
18 date_default_timezone_set('UTC');
25 // http://server.com/x/shaarli --> /shaarli/
26 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+
strrpos($_SERVER['REQUEST_URI'], '/', 0)));
28 // High execution time in case of problematic imports/exports.
29 ini_set('max_input_time', '60');
31 // Try to set max upload file size and read
32 ini_set('memory_limit', '128M');
33 ini_set('post_max_size', '16M');
34 ini_set('upload_max_filesize', '16M');
36 // See all error except warnings
37 error_reporting(E_ALL^E_WARNING
);
39 // 3rd-party libraries
40 if (! file_exists(__DIR__
. '/vendor/autoload.php')) {
41 header('Content-Type: text/plain; charset=utf-8');
42 echo "Error: missing Composer configuration\n\n"
43 ."If you installed Shaarli through Git or using the development branch,\n"
44 ."please refer to the installation documentation to install PHP"
45 ." dependencies using Composer:\n"
46 ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n"
47 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
50 require_once 'inc/rain.tpl.class.php';
51 require_once __DIR__
. '/vendor/autoload.php';
54 require_once 'application/bookmark/LinkUtils.php';
55 require_once 'application/config/ConfigPlugin.php';
56 require_once 'application/feed/Cache.php';
57 require_once 'application/http/HttpUtils.php';
58 require_once 'application/http/UrlUtils.php';
59 require_once 'application/updater/UpdaterUtils.php';
60 require_once 'application/FileUtils.php';
61 require_once 'application/TimeZone.php';
62 require_once 'application/Utils.php';
64 use \Shaarli\ApplicationUtils
;
65 use Shaarli\Bookmark\BookmarkServiceInterface
;
66 use \Shaarli\Bookmark\Exception\BookmarkNotFoundException
;
67 use Shaarli\Bookmark\Bookmark
;
68 use Shaarli\Bookmark\BookmarkFilter
;
69 use Shaarli\Bookmark\BookmarkFileService
;
70 use \Shaarli\Config\ConfigManager
;
71 use \Shaarli\Feed\CachedPage
;
72 use \Shaarli\Feed\FeedBuilder
;
73 use Shaarli\Formatter\BookmarkMarkdownFormatter
;
74 use Shaarli\Formatter\FormatterFactory
;
76 use \Shaarli\Languages
;
77 use \Shaarli\Netscape\NetscapeBookmarkUtils
;
78 use \Shaarli\Plugin\PluginManager
;
79 use \Shaarli\Render\PageBuilder
;
80 use \Shaarli\Render\ThemeUtils
;
82 use \Shaarli\Security\LoginManager
;
83 use \Shaarli\Security\SessionManager
;
84 use \Shaarli\Thumbnailer
;
85 use \Shaarli\Updater\Updater
;
86 use \Shaarli\Updater\UpdaterUtils
;
88 // Ensure the PHP version is supported
90 ApplicationUtils
::checkPHPVersion('7.1', PHP_VERSION
);
91 } catch (Exception
$exc) {
92 header('Content-Type: text/plain; charset=utf-8');
93 echo $exc->getMessage();
97 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
99 // Force cookie path (but do not change lifetime)
100 $cookie = session_get_cookie_params();
102 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
103 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
105 // Set default cookie expiration and path.
106 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
107 // Set session parameters on server side.
108 // Use cookies to store session.
109 ini_set('session.use_cookies', 1);
110 // Force cookies for session (phpsessionID forbidden in URL).
111 ini_set('session.use_only_cookies', 1);
112 // Prevent PHP form using sessionID in URL if cookies are disabled.
113 ini_set('session.use_trans_sid', false);
115 session_name('shaarli');
116 // Start session if needed (Some server auto-start sessions).
117 if (session_status() == PHP_SESSION_NONE
) {
121 // Regenerate session ID if invalid or not defined in cookie.
122 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
123 session_regenerate_id(true);
124 $_COOKIE['shaarli'] = session_id();
127 $conf = new ConfigManager();
129 // In dev mode, throw exception on any warning
130 if ($conf->get('dev.debug', false)) {
131 // See all errors (for debugging only)
134 set_error_handler(function($errno, $errstr, $errfile, $errline, array $errcontext) {
135 throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
139 $sessionManager = new SessionManager($_SESSION, $conf);
140 $loginManager = new LoginManager($conf, $sessionManager);
141 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
142 $clientIpId = client_ip_id($_SERVER);
144 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
145 if (! defined('LC_MESSAGES')) {
146 define('LC_MESSAGES', LC_COLLATE
);
149 // Sniff browser language and set date format accordingly.
150 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
151 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
154 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
156 $conf->setEmpty('general.timezone', date_default_timezone_get());
157 $conf->setEmpty('general.title', t('Shared bookmarks on '). escape(index_url($_SERVER)));
158 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
159 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
161 $pluginManager = new PluginManager($conf);
162 $pluginManager->load($conf->get('general.enabled_plugins'));
164 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
166 ob_start(); // Output buffering for the page cache.
168 // Prevent caching on client side or proxy: (yes, it's ugly)
169 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
170 header("Cache-Control: no-store, no-cache, must-revalidate");
171 header("Cache-Control: post-check=0, pre-check=0", false);
172 header("Pragma: no-cache");
174 if (! is_file($conf->getConfigFileExt())) {
175 // Ensure Shaarli has proper access to its resources
176 $errors = ApplicationUtils
::checkResourcePermissions($conf);
178 if ($errors != array()) {
179 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
181 foreach ($errors as $error) {
182 $message .= '<li>'.$error.'</li>';
186 header('Content-Type: text/html; charset=utf-8');
191 // Display the installation form if no existing config is found
192 install($conf, $sessionManager, $loginManager);
195 $loginManager->checkLoginState($_COOKIE, $clientIpId);
198 * Adapter function to ensure compatibility with third-party templates
200 * @see https://github.com/shaarli/Shaarli/pull/1086
202 * @return bool true when the user is logged in, false otherwise
204 function isLoggedIn()
206 global $loginManager;
207 return $loginManager->isLoggedIn();
211 // ------------------------------------------------------------------------------------------
212 // Process login form: Check if login/password is correct.
213 if (isset($_POST['login'])) {
214 if (! $loginManager->canLogin($_SERVER)) {
215 die(t('I said: NO. You are banned for the moment. Go away.'));
217 if (isset($_POST['password'])
218 && $sessionManager->checkToken($_POST['token'])
219 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
221 $loginManager->handleSuccessfulLogin($_SERVER);
224 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
225 // Note: Never forget the trailing slash on the cookie path!
226 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
229 if (!empty($_POST['longlastingsession'])) {
230 // Keep the session cookie even after the browser closes
231 $sessionManager->setStaySignedIn(true);
232 $expirationTime = $sessionManager->extendSession();
235 $loginManager::$STAY_SIGNED_IN_COOKIE,
236 $loginManager->getStaySignedInToken(),
241 // Standard session expiration (=when browser closes)
245 // Send cookie with the new expiration date to the browser
247 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
249 session_regenerate_id(true);
251 // Optional redirect after login:
252 if (isset($_GET['post'])) {
253 $uri = '?post='. urlencode($_GET['post']);
254 foreach (array('description', 'source', 'title', 'tags') as $param) {
255 if (!empty($_GET[$param])) {
256 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
259 header('Location: '. $uri);
263 if (isset($_GET['edit_link'])) {
264 header('Location: ?edit_link='. escape($_GET['edit_link']));
268 if (isset($_POST['returnurl'])) {
269 // Prevent loops over login screen.
270 if (strpos($_POST['returnurl'], 'do=login') === false) {
271 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
275 header('Location: ?');
278 $loginManager->handleFailedLogin($_SERVER);
279 $redir = '&username='. urlencode($_POST['login']);
280 if (isset($_GET['post'])) {
281 $redir .= '&post=' . urlencode($_GET['post']);
282 foreach (array('description', 'source', 'title', 'tags') as $param) {
283 if (!empty($_GET[$param])) {
284 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
288 // Redirect to login screen.
289 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
294 // ------------------------------------------------------------------------------------------
295 // Token management for XSRF protection
296 // Token should be used in any form which acts on data (create,update,delete,import...).
297 if (!isset($_SESSION['tokens'])) {
298 $_SESSION['tokens']=array(); // Token are attached to the session.
302 * Daily RSS feed: 1 RSS entry per day giving all the bookmarks on that day.
303 * Gives the last 7 days (which have bookmarks).
304 * This RSS feed cannot be filtered.
306 * @param BookmarkServiceInterface $bookmarkService
307 * @param ConfigManager $conf Configuration Manager instance
308 * @param LoginManager $loginManager LoginManager instance
310 function showDailyRSS($bookmarkService, $conf, $loginManager)
313 $query = $_SERVER['QUERY_STRING'];
314 $cache = new CachedPage(
315 $conf->get('config.PAGE_CACHE'),
317 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
319 $cached = $cache->cachedVersion();
320 if (!empty($cached)) {
325 /* Some Shaarlies may have very few bookmarks, so we need to look
326 back in time until we have enough days ($nb_of_days).
328 $nb_of_days = 7; // We take 7 days.
329 $today = date('Ymd');
332 foreach ($bookmarkService->search() as $bookmark) {
333 $day = $bookmark->getCreated()->format('Ymd'); // Extract day (without time)
334 if (strcmp($day, $today) < 0) {
335 if (empty($days[$day])) {
336 $days[$day] = array();
338 $days[$day][] = $bookmark;
341 if (count($days) > $nb_of_days) {
342 break; // Have we collected enough days?
346 // Build the RSS feed.
347 header('Content-Type: application/rss+xml; charset=utf-8');
348 $pageaddr = escape(index_url($_SERVER));
349 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
351 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
352 echo '<link>'. $pageaddr .'</link>';
353 echo '<description>Daily shared bookmarks</description>';
354 echo '<language>en-en</language>';
355 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
357 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
358 $formatter = $factory->getFormatter();
359 $formatter->addContextData('index_url', index_url($_SERVER));
361 /** @var Bookmark[] $bookmarks */
362 foreach ($days as $day => $bookmarks) {
363 $formattedBookmarks = [];
364 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
365 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
367 // We pre-format some fields for proper output.
368 foreach ($bookmarks as $key => $bookmark) {
369 $formattedBookmarks[$key] = $formatter->format($bookmark);
370 // This page is a bit specific, we need raw description to calculate the length
371 $formattedBookmarks[$key]['formatedDescription'] = $formattedBookmarks[$key]['description'];
372 $formattedBookmarks[$key]['description'] = $bookmark->getDescription();
374 if ($bookmark->isNote()) {
375 $link['url'] = index_url($_SERVER) . $bookmark->getUrl(); // make permalink URL absolute
379 // Then build the HTML for this day:
380 $tpl = new RainTPL();
381 $tpl->assign('title', $conf->get('general.title'));
382 $tpl->assign('daydate', $dayDate->getTimestamp());
383 $tpl->assign('absurl', $absurl);
384 $tpl->assign('links', $formattedBookmarks);
385 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
386 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
387 $tpl->assign('index_url', $pageaddr);
388 $html = $tpl->draw('dailyrss', true);
390 echo $html . PHP_EOL
;
392 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
394 $cache->cache(ob_get_contents());
400 * Show the 'Daily' page.
402 * @param PageBuilder $pageBuilder Template engine wrapper.
403 * @param BookmarkServiceInterface $bookmarkService instance.
404 * @param ConfigManager $conf Configuration Manager instance.
405 * @param PluginManager $pluginManager Plugin Manager instance.
406 * @param LoginManager $loginManager Login Manager instance
408 function showDaily($pageBuilder, $bookmarkService, $conf, $pluginManager, $loginManager)
410 if (isset($_GET['day'])) {
412 if ($day === date('Ymd', strtotime('now'))) {
413 $pageBuilder->assign('dayDesc', t('Today'));
414 } elseif ($day === date('Ymd', strtotime('-1 days'))) {
415 $pageBuilder->assign('dayDesc', t('Yesterday'));
418 $day = date('Ymd', strtotime('now')); // Today, in format YYYYMMDD.
419 $pageBuilder->assign('dayDesc', t('Today'));
422 $days = $bookmarkService->days();
423 $i = array_search($day, $days);
424 if ($i === false && count($days)) {
425 // no bookmarks for day, but at least one day with bookmarks
426 $i = count($days) - 1;
434 $previousday = $days[$i - 1];
436 if ($i < count($days) - 1) {
437 $nextday = $days[$i +
1];
441 $linksToDisplay = $bookmarkService->filterDay($day);
442 } catch (Exception
$exc) {
444 $linksToDisplay = [];
447 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
448 $formatter = $factory->getFormatter();
449 // We pre-format some fields for proper output.
450 foreach ($linksToDisplay as $key => $bookmark) {
451 $linksToDisplay[$key] = $formatter->format($bookmark);
452 // This page is a bit specific, we need raw description to calculate the length
453 $linksToDisplay[$key]['formatedDescription'] = $linksToDisplay[$key]['description'];
454 $linksToDisplay[$key]['description'] = $bookmark->getDescription();
457 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
459 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
460 'linksToDisplay' => $linksToDisplay,
461 'day' => $dayDate->getTimestamp(),
462 'dayDate' => $dayDate,
463 'previousday' => $previousday,
464 'nextday' => $nextday,
467 /* Hook is called before column construction so that plugins don't have
468 to deal with columns. */
469 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
471 /* We need to spread the articles on 3 columns.
472 I did not want to use a JavaScript lib like http://masonry.desandro.com/
473 so I manually spread entries with a simple method: I roughly evaluate the
474 height of a div according to title and description length.
476 $columns = array(array(), array(), array()); // Entries to display, for each column.
477 $fill = array(0, 0, 0); // Rough estimate of columns fill.
478 foreach ($data['linksToDisplay'] as $key => $bookmark) {
479 // Roughly estimate length of entry (by counting characters)
480 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
481 // Description: 836 characters gives roughly 342 pixel height.
482 // This is not perfect, but it's usually OK.
483 $length = strlen($bookmark['title']) +
(342 * strlen($bookmark['description'])) / 836;
484 if (! empty($bookmark['thumbnail'])) {
485 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
487 // Then put in column which is the less filled:
488 $smallest = min($fill); // find smallest value in array.
489 $index = array_search($smallest, $fill); // find index of this smallest value.
490 array_push($columns[$index], $bookmark); // Put entry in this column.
491 $fill[$index] +
= $length;
494 $data['cols'] = $columns;
496 foreach ($data as $key => $value) {
497 $pageBuilder->assign($key, $value);
500 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
501 $pageBuilder->renderPage('daily');
506 * Renders the linklist
508 * @param pageBuilder $PAGE pageBuilder instance.
509 * @param BookmarkServiceInterface $linkDb instance.
510 * @param ConfigManager $conf Configuration Manager instance.
511 * @param PluginManager $pluginManager Plugin Manager instance.
513 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
515 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
516 $PAGE->renderPage('linklist');
520 * Render HTML page (according to URL parameters and user rights)
522 * @param ConfigManager $conf Configuration Manager instance.
523 * @param PluginManager $pluginManager Plugin Manager instance,
524 * @param BookmarkServiceInterface $bookmarkService
525 * @param History $history instance
526 * @param SessionManager $sessionManager SessionManager instance
527 * @param LoginManager $loginManager LoginManager instance
529 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
531 $updater = new Updater(
532 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
535 $loginManager->isLoggedIn()
538 $newUpdates = $updater->update();
539 if (! empty($newUpdates)) {
540 UpdaterUtils
::write_updates_file(
541 $conf->get('resource.updates'),
542 $updater->getDoneUpdates()
545 } catch (Exception
$e) {
546 die($e->getMessage());
549 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
550 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
551 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
552 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
554 // Determine which page will be rendered.
555 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
556 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
558 if (// if the user isn't logged in
559 !$loginManager->isLoggedIn() &&
560 // and Shaarli doesn't have public content...
561 $conf->get('privacy.hide_public_links') &&
562 // and is configured to enforce the login
563 $conf->get('privacy.force_login') &&
564 // and the current page isn't already the login page
565 $targetPage !== Router
::$PAGE_LOGIN &&
566 // and the user is not requesting a feed (which would lead to a different content-type as expected)
567 $targetPage !== Router
::$PAGE_FEED_ATOM &&
568 $targetPage !== Router
::$PAGE_FEED_RSS
570 // force current page to be the login page
571 $targetPage = Router
::$PAGE_LOGIN;
574 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
575 // Then assign generated data to RainTPL.
576 $common_hooks = array(
582 foreach ($common_hooks as $name) {
583 $plugin_data = array();
584 $pluginManager->executeHooks(
588 'target' => $targetPage,
589 'loggedin' => $loginManager->isLoggedIn()
592 $PAGE->assign('plugins_' . $name, $plugin_data);
595 // -------- Display login form.
596 if ($targetPage == Router
::$PAGE_LOGIN) {
597 if ($conf->get('security.open_shaarli')) {
598 header('Location: ?');
600 } // No need to login for open Shaarli
601 if (isset($_GET['username'])) {
602 $PAGE->assign('username', escape($_GET['username']));
604 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
605 // add default state of the 'remember me' checkbox
606 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
607 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
608 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
609 $PAGE->renderPage('loginform');
612 // -------- User wants to logout.
613 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
614 invalidateCaches($conf->get('resource.page_cache'));
615 $sessionManager->logout();
616 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
617 header('Location: ?');
621 // -------- Picture wall
622 if ($targetPage == Router
::$PAGE_PICWALL) {
623 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
624 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
625 $PAGE->assign('linksToDisplay', []);
626 $PAGE->renderPage('picwall');
630 // Optionally filter the results:
631 $links = $bookmarkService->search($_GET);
632 $linksToDisplay = [];
634 // Get only bookmarks which have a thumbnail.
635 // Note: we do not retrieve thumbnails here, the request is too heavy.
636 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
637 $formatter = $factory->getFormatter();
638 foreach ($links as $key => $link) {
639 if ($link->getThumbnail() !== false) {
640 $linksToDisplay[] = $formatter->format($link);
645 'linksToDisplay' => $linksToDisplay,
647 $pluginManager->executeHooks('render_picwall', $data, ['loggedin' => $loginManager->isLoggedIn()]);
649 foreach ($data as $key => $value) {
650 $PAGE->assign($key, $value);
653 $PAGE->renderPage('picwall');
657 // -------- Tag cloud
658 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
659 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
660 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
661 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
663 // We sort tags alphabetically, then choose a font size according to count.
664 // First, find max value.
666 foreach ($tags as $value) {
667 $maxcount = max($maxcount, $value);
670 alphabetical_sort($tags, false, true);
673 foreach ($tags as $key => $value) {
674 if (in_array($key, $filteringTags)) {
677 // Tag font size scaling:
678 // default 15 and 30 logarithm bases affect scaling,
679 // 22 and 6 are arbitrary font sizes for max and min sizes.
680 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
681 $tagList[$key] = array(
683 'size' => number_format($size, 2, '.', ''),
687 $searchTags = implode(' ', escape($filteringTags));
689 'search_tags' => $searchTags,
692 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
694 foreach ($data as $key => $value) {
695 $PAGE->assign($key, $value);
698 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
699 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
700 $PAGE->renderPage('tag.cloud');
705 if ($targetPage == Router
::$PAGE_TAGLIST) {
706 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
707 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
708 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
709 foreach ($filteringTags as $tag) {
710 if (array_key_exists($tag, $tags)) {
715 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
716 alphabetical_sort($tags, false, true);
719 $searchTags = implode(' ', escape($filteringTags));
721 'search_tags' => $searchTags,
724 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
726 foreach ($data as $key => $value) {
727 $PAGE->assign($key, $value);
730 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
731 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
732 $PAGE->renderPage('tag.list');
737 if ($targetPage == Router
::$PAGE_DAILY) {
738 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
741 // ATOM and RSS feed.
742 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
743 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
744 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
747 $query = $_SERVER['QUERY_STRING'];
748 $cache = new CachedPage(
749 $conf->get('resource.page_cache'),
751 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
753 $cached = $cache->cachedVersion();
754 if (!empty($cached)) {
759 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
761 $feedGenerator = new FeedBuilder(
763 $factory->getFormatter(),
767 $loginManager->isLoggedIn()
769 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
770 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
771 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
772 $data = $feedGenerator->buildData();
774 // Process plugin hook.
775 $pluginManager->executeHooks('render_feed', $data, array(
776 'loggedin' => $loginManager->isLoggedIn(),
777 'target' => $targetPage,
780 // Render the template.
781 $PAGE->assignAll($data);
782 $PAGE->renderPage('feed.'. $feedType);
783 $cache->cache(ob_get_contents());
788 // Display opensearch plugin (XML)
789 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
790 header('Content-Type: application/xml; charset=utf-8');
791 $PAGE->assign('serverurl', index_url($_SERVER));
792 $PAGE->renderPage('opensearch');
796 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
797 if (isset($_GET['addtag'])) {
798 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
799 if (empty($_SERVER['HTTP_REFERER'])) {
800 // In case browser does not send HTTP_REFERER
801 header('Location: ?searchtags='.urlencode($_GET['addtag']));
804 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
806 // Prevent redirection loop
807 if (isset($params['addtag'])) {
808 unset($params['addtag']);
811 // Check if this tag is already in the search query and ignore it if it is.
812 // Each tag is always separated by a space
813 if (isset($params['searchtags'])) {
814 $current_tags = explode(' ', $params['searchtags']);
816 $current_tags = array();
819 foreach ($current_tags as $value) {
820 if ($value === $_GET['addtag']) {
825 // Append the tag if necessary
826 if (empty($params['searchtags'])) {
827 $params['searchtags'] = trim($_GET['addtag']);
829 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
832 // We also remove page (keeping the same page has no sense, since the
833 // results are different)
834 unset($params['page']);
836 header('Location: ?'.http_build_query($params));
840 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
841 if (isset($_GET['removetag'])) {
842 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
843 if (empty($_SERVER['HTTP_REFERER'])) {
844 header('Location: ?');
848 // In case browser does not send HTTP_REFERER
849 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
851 // Prevent redirection loop
852 if (isset($params['removetag'])) {
853 unset($params['removetag']);
856 if (isset($params['searchtags'])) {
857 $tags = explode(' ', $params['searchtags']);
858 // Remove value from array $tags.
859 $tags = array_diff($tags, array($_GET['removetag']));
860 $params['searchtags'] = implode(' ', $tags);
862 if (empty($params['searchtags'])) {
863 unset($params['searchtags']);
866 // We also remove page (keeping the same page has no sense, since
867 // the results are different)
868 unset($params['page']);
870 header('Location: ?'.http_build_query($params));
874 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
875 if (isset($_GET['linksperpage'])) {
876 if (is_numeric($_GET['linksperpage'])) {
877 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
880 if (! empty($_SERVER['HTTP_REFERER'])) {
881 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
885 header('Location: '. $location);
889 // -------- User wants to see only private bookmarks (toggle)
890 if (isset($_GET['visibility'])) {
891 if ($_GET['visibility'] === 'private') {
892 // Visibility not set or not already private, set private, otherwise reset it
893 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
894 // See only private bookmarks
895 $_SESSION['visibility'] = 'private';
897 unset($_SESSION['visibility']);
899 } elseif ($_GET['visibility'] === 'public') {
900 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
901 // See only public bookmarks
902 $_SESSION['visibility'] = 'public';
904 unset($_SESSION['visibility']);
908 if (! empty($_SERVER['HTTP_REFERER'])) {
909 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
913 header('Location: '. $location);
917 // -------- User wants to see only untagged bookmarks (toggle)
918 if (isset($_GET['untaggedonly'])) {
919 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
921 if (! empty($_SERVER['HTTP_REFERER'])) {
922 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
926 header('Location: '. $location);
930 // -------- Handle other actions allowed for non-logged in users:
931 if (!$loginManager->isLoggedIn()) {
932 // User tries to post new link but is not logged in:
933 // Show login screen, then redirect to ?post=...
934 if (isset($_GET['post'])) {
935 header( // Redirect to login page, then back to post link.
936 'Location: ?do=login&post='.urlencode($_GET['post']).
937 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
938 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
939 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
940 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
945 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
946 if (isset($_GET['edit_link'])) {
947 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
951 exit; // Never remove this one! All operations below are reserved for logged in user.
954 // -------- All other functions are reserved for the registered user:
956 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
957 if ($targetPage == Router
::$PAGE_TOOLS) {
959 'pageabsaddr' => index_url($_SERVER),
960 'sslenabled' => is_https($_SERVER),
962 $pluginManager->executeHooks('render_tools', $data);
964 foreach ($data as $key => $value) {
965 $PAGE->assign($key, $value);
968 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
969 $PAGE->renderPage('tools');
973 // -------- User wants to change his/her password.
974 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
975 if ($conf->get('security.open_shaarli')) {
976 die(t('You are not supposed to change a password on an Open Shaarli.'));
979 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
980 if (!$sessionManager->checkToken($_POST['token'])) {
981 die(t('Wrong token.')); // Go away!
984 // Make sure old password is correct.
986 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
988 if ($oldhash != $conf->get('credentials.hash')) {
989 echo '<script>alert("'
990 . t('The old password is not correct.')
991 .'");document.location=\'?do=changepasswd\';</script>';
995 // Salt renders rainbow-tables attacks useless.
996 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
1000 $_POST['setpassword']
1001 . $conf->get('credentials.login')
1002 . $conf->get('credentials.salt')
1006 $conf->write($loginManager->isLoggedIn());
1007 } catch (Exception
$e) {
1009 'ERROR while writing config file after changing password.' . PHP_EOL
.
1013 // TODO: do not handle exceptions/errors in JS.
1014 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1017 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1020 // show the change password form.
1021 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1022 $PAGE->renderPage('changepassword');
1027 // -------- User wants to change configuration
1028 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1029 if (!empty($_POST['title'])) {
1030 if (!$sessionManager->checkToken($_POST['token'])) {
1031 die(t('Wrong token.')); // Go away!
1034 if (!empty($_POST['continent']) && !empty($_POST['city'])
1035 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1037 $tz = $_POST['continent'] . '/' . $_POST['city'];
1039 $conf->set('general.timezone', $tz);
1040 $conf->set('general.title', escape($_POST['title']));
1041 $conf->set('general.header_link', escape($_POST['titleLink']));
1042 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
1043 $conf->set('resource.theme', escape($_POST['theme']));
1044 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1045 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1046 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1047 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1048 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1049 $conf->set('api.enabled', !empty($_POST['enableApi']));
1050 $conf->set('api.secret', escape($_POST['apiSecret']));
1051 $conf->set('formatter', escape($_POST['formatter']));
1053 if (! empty($_POST['language'])) {
1054 $conf->set('translation.language', escape($_POST['language']));
1057 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1058 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1059 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1061 $_SESSION['warnings'][] = t(
1062 'You have enabled or changed thumbnails mode. '
1063 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1066 $conf->set('thumbnails.mode', $thumbnailsMode);
1069 $conf->write($loginManager->isLoggedIn());
1070 $history->updateSettings();
1071 invalidateCaches($conf->get('resource.page_cache'));
1072 } catch (Exception
$e) {
1074 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1078 // TODO: do not handle exceptions/errors in JS.
1079 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1082 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1085 // Show the configuration form.
1086 $PAGE->assign('title', $conf->get('general.title'));
1087 $PAGE->assign('theme', $conf->get('resource.theme'));
1088 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1089 $PAGE->assign('formatter_available', ['default', 'markdown']);
1090 list($continents, $cities) = generateTimeZoneData(
1091 timezone_identifiers_list(),
1092 $conf->get('general.timezone')
1094 $PAGE->assign('continents', $continents);
1095 $PAGE->assign('cities', $cities);
1096 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1097 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1098 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1099 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1100 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1101 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1102 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1103 $PAGE->assign('api_secret', $conf->get('api.secret'));
1104 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1105 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1106 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1107 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1108 $PAGE->renderPage('configure');
1113 // -------- User wants to rename a tag or delete it
1114 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1115 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1116 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1117 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1118 $PAGE->renderPage('changetag');
1122 if (!$sessionManager->checkToken($_POST['token'])) {
1123 die(t('Wrong token.'));
1126 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1127 $fromTag = escape($_POST['fromtag']);
1129 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1130 foreach ($bookmarks as $bookmark) {
1132 $bookmark->renameTag($fromTag, $toTag);
1134 $bookmark->deleteTag($fromTag);
1136 $bookmarkService->set($bookmark, false);
1137 $history->updateLink($bookmark);
1140 $bookmarkService->save();
1141 $delete = empty($_POST['totag']);
1142 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1144 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1145 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1146 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1150 // -------- User wants to add a link without using the bookmarklet: Show form.
1151 if ($targetPage == Router
::$PAGE_ADDLINK) {
1152 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1153 $PAGE->renderPage('addlink');
1157 // -------- User clicked the "Save" button when editing a link: Save link to database.
1158 if (isset($_POST['save_edit'])) {
1160 if (! $sessionManager->checkToken($_POST['token'])) {
1161 die(t('Wrong token.'));
1164 // lf_id should only be present if the link exists.
1165 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1166 if ($id && $bookmarkService->exists($id)) {
1168 $bookmark = $bookmarkService->get($id);
1171 $bookmark = new Bookmark();
1174 $bookmark->setTitle($_POST['lf_title']);
1175 $bookmark->setDescription($_POST['lf_description']);
1176 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1177 $bookmark->setPrivate(isset($_POST['lf_private']));
1178 $bookmark->setTagsString($_POST['lf_tags']);
1180 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1181 && ! $bookmark->isNote()
1183 $thumbnailer = new Thumbnailer($conf);
1184 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1186 $bookmarkService->addOrSet($bookmark, false);
1188 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1189 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1190 $formatter = $factory->getFormatter('raw');
1191 $data = $formatter->format($bookmark);
1192 $pluginManager->executeHooks('save_link', $data);
1194 $bookmark->fromArray($data);
1195 $bookmarkService->set($bookmark);
1197 // If we are called from the bookmarklet, we must close the popup:
1198 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1199 echo '<script>self.close();</script>';
1203 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1204 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1205 // Scroll to the link which has been edited.
1206 $location .= '#' . $bookmark->getShortUrl();
1207 // After saving the link, redirect to the page the user was on.
1208 header('Location: '. $location);
1212 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1213 if ($targetPage == Router
::$PAGE_DELETELINK) {
1214 if (! $sessionManager->checkToken($_GET['token'])) {
1215 die(t('Wrong token.'));
1218 $ids = trim($_GET['lf_linkdate']);
1219 if (strpos($ids, ' ') !== false) {
1220 // multiple, space-separated ids provided
1221 $ids = array_values(array_filter(
1222 preg_split('/\s+/', escape($ids)),
1224 return $item !== '';
1228 // only a single id provided
1229 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1232 // assert at least one id is given
1234 die('no id provided');
1236 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1237 $formatter = $factory->getFormatter('raw');
1238 foreach ($ids as $id) {
1239 $id = (int) escape($id);
1240 $bookmark = $bookmarkService->get($id);
1241 $data = $formatter->format($bookmark);
1242 $pluginManager->executeHooks('delete_link', $data);
1243 $bookmarkService->remove($bookmark, false);
1245 $bookmarkService->save();
1247 // If we are called from the bookmarklet, we must close the popup:
1248 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1249 echo '<script>self.close();</script>';
1254 if (isset($_SERVER['HTTP_REFERER'])) {
1255 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1256 $location = generateLocation(
1257 $_SERVER['HTTP_REFERER'],
1258 $_SERVER['HTTP_HOST'],
1259 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1263 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1267 // -------- User clicked either "Set public" or "Set private" bulk operation
1268 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1269 if (! $sessionManager->checkToken($_GET['token'])) {
1270 die(t('Wrong token.'));
1273 $ids = trim($_GET['ids']);
1274 if (strpos($ids, ' ') !== false) {
1275 // multiple, space-separated ids provided
1276 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1278 // only a single id provided
1282 // assert at least one id is given
1284 die('no id provided');
1286 // assert that the visibility is valid
1287 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1288 die('invalid visibility');
1290 $private = $_GET['newVisibility'] === 'private';
1292 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1293 $formatter = $factory->getFormatter('raw');
1294 foreach ($ids as $id) {
1295 $id = (int) escape($id);
1296 $bookmark = $bookmarkService->get($id);
1297 $bookmark->setPrivate($private);
1299 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1300 $data = $formatter->format($bookmark);
1301 $pluginManager->executeHooks('save_link', $data);
1302 $bookmark->fromArray($data);
1304 $bookmarkService->set($bookmark);
1306 $bookmarkService->save();
1309 if (isset($_SERVER['HTTP_REFERER'])) {
1310 $location = generateLocation(
1311 $_SERVER['HTTP_REFERER'],
1312 $_SERVER['HTTP_HOST']
1315 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1319 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1320 if (isset($_GET['edit_link'])) {
1321 $id = (int) escape($_GET['edit_link']);
1323 $link = $bookmarkService->get($id); // Read database
1324 } catch (BookmarkNotFoundException
$e) {
1325 // Link not found in database.
1326 header('Location: ?');
1330 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1331 $formatter = $factory->getFormatter('raw');
1332 $formattedLink = $formatter->format($link);
1333 $tags = $bookmarkService->bookmarksCountPerTag();
1334 if ($conf->get('formatter') === 'markdown') {
1335 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1338 'link' => $formattedLink,
1339 'link_is_new' => false,
1340 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1343 $pluginManager->executeHooks('render_editlink', $data);
1345 foreach ($data as $key => $value) {
1346 $PAGE->assign($key, $value);
1349 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1350 $PAGE->renderPage('editlink');
1354 // -------- User want to post a new link: Display link edit form.
1355 if (isset($_GET['post'])) {
1356 $url = cleanup_url($_GET['post']);
1358 $link_is_new = false;
1359 // Check if URL is not already in database (in this case, we will edit the existing link)
1360 $bookmark = $bookmarkService->findByUrl($url);
1362 $link_is_new = true;
1363 // Get title if it was provided in URL (by the bookmarklet).
1364 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1365 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1366 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1367 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1368 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1370 // If this is an HTTP(S) link, we try go get the page to extract
1371 // the title (otherwise we will to straight to the edit form.)
1372 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1373 $retrieveDescription = $conf->get('general.retrieve_description');
1374 // Short timeout to keep the application responsive
1375 // The callback will fill $charset and $title with data from the downloaded page.
1378 $conf->get('general.download_timeout', 30),
1379 $conf->get('general.download_max_size', 4194304),
1380 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1382 if (! empty($title) && strtolower($charset) != 'utf-8') {
1383 $title = mb_convert_encoding($title, 'utf-8', $charset);
1388 $title = $conf->get('general.default_note_title', t('Note: '));
1390 $url = escape($url);
1391 $title = escape($title);
1396 'description' => $description,
1398 'private' => $private,
1401 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1402 $formatter = $factory->getFormatter('raw');
1403 $link = $formatter->format($bookmark);
1406 $tags = $bookmarkService->bookmarksCountPerTag();
1407 if ($conf->get('formatter') === 'markdown') {
1408 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1412 'link_is_new' => $link_is_new,
1413 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1414 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1416 'default_private_links' => $conf->get('privacy.default_private_links', false),
1418 $pluginManager->executeHooks('render_editlink', $data);
1420 foreach ($data as $key => $value) {
1421 $PAGE->assign($key, $value);
1424 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1425 $PAGE->renderPage('editlink');
1429 if ($targetPage == Router
::$PAGE_PINLINK) {
1430 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1431 // FIXME! Use a proper error system.
1432 $msg = t('Invalid link ID provided');
1433 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1436 if (! $sessionManager->checkToken($_GET['token'])) {
1437 die('Wrong token.');
1440 $link = $bookmarkService->get($_GET['id']);
1441 $link->setSticky(! $link->isSticky());
1442 $bookmarkService->set($link);
1443 header('Location: '.index_url($_SERVER));
1447 if ($targetPage == Router
::$PAGE_EXPORT) {
1448 // Export bookmarks as a Netscape Bookmarks file
1450 if (empty($_GET['selection'])) {
1451 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1452 $PAGE->renderPage('export');
1456 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1457 $selection = $_GET['selection'];
1458 if (isset($_GET['prepend_note_url'])) {
1459 $prependNoteUrl = $_GET['prepend_note_url'];
1461 $prependNoteUrl = false;
1465 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1466 $formatter = $factory->getFormatter('raw');
1469 NetscapeBookmarkUtils
::filterAndFormat(
1477 } catch (Exception
$exc) {
1478 header('Content-Type: text/plain; charset=utf-8');
1479 echo $exc->getMessage();
1482 $now = new DateTime();
1483 header('Content-Type: text/html; charset=utf-8');
1485 'Content-disposition: attachment; filename=bookmarks_'
1486 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1488 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1489 $PAGE->assign('eol', PHP_EOL
);
1490 $PAGE->assign('selection', $selection);
1491 $PAGE->renderPage('export.bookmarks');
1495 if ($targetPage == Router
::$PAGE_IMPORT) {
1496 // Upload a Netscape bookmark dump to import its contents
1498 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1499 // Show import dialog
1502 get_max_upload_size(
1503 ini_get('post_max_size'),
1504 ini_get('upload_max_filesize'),
1510 get_max_upload_size(
1511 ini_get('post_max_size'),
1512 ini_get('upload_max_filesize'),
1516 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1517 $PAGE->renderPage('import');
1521 // Import bookmarks from an uploaded file
1522 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1523 // The file is too big or some form field may be missing.
1526 'The file you are trying to upload is probably bigger than what this webserver can accept'
1527 .' (%s). Please upload in smaller chunks.'
1529 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1531 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1534 if (! $sessionManager->checkToken($_POST['token'])) {
1535 die('Wrong token.');
1537 $status = NetscapeBookmarkUtils
::import(
1544 echo '<script>alert("'.$status.'");document.location=\'?do='
1545 .Router
::$PAGE_IMPORT .'\';</script>';
1549 // Plugin administration page
1550 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1551 $pluginMeta = $pluginManager->getPluginsMeta();
1553 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1554 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1555 return $v['order'] !== false;
1558 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1562 return $a['order'] - $b['order'];
1565 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1566 return $v['order'] === false;
1569 $PAGE->assign('enabledPlugins', $enabledPlugins);
1570 $PAGE->assign('disabledPlugins', $disabledPlugins);
1571 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1572 $PAGE->renderPage('pluginsadmin');
1576 // Plugin administration form action
1577 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1579 if (isset($_POST['parameters_form'])) {
1580 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1581 unset($_POST['parameters_form']);
1582 foreach ($_POST as $param => $value) {
1583 $conf->set('plugins.'. $param, escape($value));
1586 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1588 $conf->write($loginManager->isLoggedIn());
1589 $history->updateSettings();
1590 } catch (Exception
$e) {
1592 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1596 // TODO: do not handle exceptions/errors in JS.
1597 echo '<script>alert("'
1599 .'");document.location=\'?do='
1600 . Router
::$PAGE_PLUGINSADMIN
1604 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1608 // Get a fresh token
1609 if ($targetPage == Router
::$GET_TOKEN) {
1610 header('Content-Type:text/plain');
1611 echo $sessionManager->generateToken();
1615 // -------- Thumbnails Update
1616 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1618 foreach ($bookmarkService->search() as $bookmark) {
1619 // A note or not HTTP(S)
1620 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1623 $ids[] = $bookmark->getId();
1625 $PAGE->assign('ids', $ids);
1626 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1627 $PAGE->renderPage('thumbnails');
1631 // -------- Single Thumbnail Update
1632 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1633 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1634 http_response_code(400);
1637 $id = (int) $_POST['id'];
1638 if (! $bookmarkService->exists($id)) {
1639 http_response_code(404);
1642 $thumbnailer = new Thumbnailer($conf);
1643 $bookmark = $bookmarkService->get($id);
1644 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1645 $bookmarkService->set($bookmark);
1647 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1648 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1652 // -------- Otherwise, simply display search form and bookmarks:
1653 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1658 * Template for the list of bookmarks (<div id="linklist">)
1659 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1661 * @param pageBuilder $PAGE pageBuilder instance.
1662 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1663 * @param ConfigManager $conf Configuration Manager instance.
1664 * @param PluginManager $pluginManager Plugin Manager instance.
1665 * @param LoginManager $loginManager LoginManager instance
1667 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1669 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1670 $formatter = $factory->getFormatter();
1672 // Used in templates
1673 if (isset($_GET['searchtags'])) {
1674 if (! empty($_GET['searchtags'])) {
1675 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1677 $searchtags = false;
1682 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1685 if (! empty($_SERVER['QUERY_STRING'])
1686 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1688 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1689 } catch (BookmarkNotFoundException
$e) {
1690 $PAGE->render404($e->getMessage());
1694 // Filter bookmarks according search parameters.
1695 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1697 'searchtags' => $searchtags,
1698 'searchterm' => $searchterm,
1700 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1703 // ---- Handle paging.
1705 foreach ($linksToDisplay as $key => $value) {
1709 // Select articles according to paging.
1710 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1711 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1712 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1713 $page = $page < 1 ? 1 : $page;
1714 $page = $page > $pagecount ? $pagecount : $page;
1716 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1717 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1719 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1720 if ($thumbnailsEnabled) {
1721 $thumbnailer = new Thumbnailer($conf);
1724 $linkDisp = array();
1725 while ($i<$end && $i<count($keys)) {
1726 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1728 // Logged in, thumbnails enabled, not a note,
1729 // and (never retrieved yet or no valid cache file)
1730 if ($loginManager->isLoggedIn()
1731 && $thumbnailsEnabled
1732 && !$linksToDisplay[$keys[$i]]->isNote()
1733 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1734 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1736 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1737 $linkDb->set($linksToDisplay[$keys[$i]], false);
1739 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1742 // Check for both signs of a note: starting with ? and 7 chars long.
1743 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1744 // $link['url'] = index_url($_SERVER) . $link['url'];
1747 $linkDisp[$keys[$i]] = $link;
1751 // If we retrieved new thumbnails, we update the database.
1752 if (!empty($updateDB)) {
1756 // Compute paging navigation
1757 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1758 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1759 $previous_page_url = '';
1760 if ($i != count($keys)) {
1761 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1765 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1768 // Fill all template fields.
1770 'previous_page_url' => $previous_page_url,
1771 'next_page_url' => $next_page_url,
1772 'page_current' => $page,
1773 'page_max' => $pagecount,
1774 'result_count' => count($linksToDisplay),
1775 'search_term' => $searchterm,
1776 'search_tags' => $searchtags,
1777 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1778 'links' => $linkDisp,
1781 // If there is only a single link, we change on-the-fly the title of the page.
1782 if (count($linksToDisplay) == 1) {
1783 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1784 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1785 $data['pagetitle'] = t('Search: ');
1786 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1787 $bracketWrap = function ($tag) {
1788 return '['. $tag .']';
1790 $data['pagetitle'] .= ! empty($searchtags)
1791 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1793 $data['pagetitle'] .= '- '. $conf->get('general.title');
1796 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1798 foreach ($data as $key => $value) {
1799 $PAGE->assign($key, $value);
1807 * This function should NEVER be called if the file data/config.php exists.
1809 * @param ConfigManager $conf Configuration Manager instance.
1810 * @param SessionManager $sessionManager SessionManager instance
1811 * @param LoginManager $loginManager LoginManager instance
1813 function install($conf, $sessionManager, $loginManager)
1815 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1816 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1817 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1821 // This part makes sure sessions works correctly.
1822 // (Because on some hosts, session.save_path may not be set correctly,
1823 // or we may not have write access to it.)
1824 if (isset($_GET['test_session'])
1825 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1826 // Step 2: Check if data in session is correct.
1828 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1829 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1830 'and that you have write access to it.<br>'.
1831 'It currently points to %s.<br>'.
1832 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1833 'or any custom hostname without a dot causes cookie storage to fail. '.
1834 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1836 $msg = sprintf($msg, session_save_path());
1838 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1841 if (!isset($_SESSION['session_tested'])) {
1842 // Step 1 : Try to store data in session and reload page.
1843 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1844 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1846 if (isset($_GET['test_session'])) {
1847 // Step 3: Sessions are OK. Remove test parameter from URL.
1848 header('Location: '.index_url($_SERVER));
1852 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1854 if (!empty($_POST['continent']) && !empty($_POST['city'])
1855 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1857 $tz = $_POST['continent'].'/'.$_POST['city'];
1859 $conf->set('general.timezone', $tz);
1860 $login = $_POST['setlogin'];
1861 $conf->set('credentials.login', $login);
1862 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1863 $conf->set('credentials.salt', $salt);
1864 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1865 if (!empty($_POST['title'])) {
1866 $conf->set('general.title', escape($_POST['title']));
1868 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1870 $conf->set('translation.language', escape($_POST['language']));
1871 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1872 $conf->set('api.enabled', !empty($_POST['enableApi']));
1875 generate_api_secret(
1876 $conf->get('credentials.login'),
1877 $conf->get('credentials.salt')
1881 // Everything is ok, let's create config file.
1882 $conf->write($loginManager->isLoggedIn());
1883 } catch (Exception
$e) {
1885 'ERROR while writing config file after installation.' . PHP_EOL
.
1889 // TODO: do not handle exceptions/errors in JS.
1890 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1894 $history = new History($conf->get('resource.history'));
1895 $bookmarkService = new BookmarkFileService($conf, $history, true);
1896 if ($bookmarkService->count() === 0) {
1897 $bookmarkService->initialize();
1900 echo '<script>alert('
1901 .'"Shaarli is now configured. '
1902 .'Please enter your login/password and start shaaring your bookmarks!"'
1903 .');document.location=\'?do=login\';</script>';
1907 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1908 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1909 $PAGE->assign('continents', $continents);
1910 $PAGE->assign('cities', $cities);
1911 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1912 $PAGE->renderPage('install');
1916 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1917 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1921 $history = new History($conf->get('resource.history'));
1922 } catch (Exception
$e) {
1923 die($e->getMessage());
1926 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1928 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1929 showDailyRSS($linkDb, $conf, $loginManager);
1933 $container = new \Slim\
Container();
1934 $container['conf'] = $conf;
1935 $container['plugins'] = $pluginManager;
1936 $container['history'] = $history;
1937 $app = new \Slim\
App($container);
1940 $app->group('/api/v1', function () {
1941 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1942 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1943 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1944 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1945 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1946 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1948 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1949 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1950 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1951 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1953 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1954 })->add('\Shaarli\Api\ApiMiddleware');
1956 $response = $app->run(true);
1958 // Hack to make Slim and Shaarli router work together:
1959 // If a Slim route isn't found and NOT API call, we call renderPage().
1960 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1961 // We use UTF-8 for proper international characters handling.
1962 header('Content-Type: text/html; charset=utf-8');
1963 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1965 $response = $response
1966 ->withHeader('Access-Control-Allow-Origin', '*')
1968 'Access-Control-Allow-Headers',
1969 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1971 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1972 $app->respond($response);