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\Bookmark
;
66 use Shaarli\Bookmark\BookmarkFileService
;
67 use Shaarli\Bookmark\BookmarkFilter
;
68 use Shaarli\Bookmark\BookmarkServiceInterface
;
69 use Shaarli\Bookmark\Exception\BookmarkNotFoundException
;
70 use Shaarli\Config\ConfigManager
;
71 use Shaarli\Container\ContainerBuilder
;
72 use Shaarli\Feed\CachedPage
;
73 use Shaarli\Feed\FeedBuilder
;
74 use Shaarli\Formatter\BookmarkMarkdownFormatter
;
75 use Shaarli\Formatter\FormatterFactory
;
77 use Shaarli\Languages
;
78 use Shaarli\Netscape\NetscapeBookmarkUtils
;
79 use Shaarli\Plugin\PluginManager
;
80 use Shaarli\Render\PageBuilder
;
81 use Shaarli\Render\ThemeUtils
;
83 use Shaarli\Security\LoginManager
;
84 use Shaarli\Security\SessionManager
;
85 use Shaarli\Thumbnailer
;
86 use Shaarli\Updater\Updater
;
87 use Shaarli\Updater\UpdaterUtils
;
90 // Ensure the PHP version is supported
92 ApplicationUtils
::checkPHPVersion('7.1', PHP_VERSION
);
93 } catch (Exception
$exc) {
94 header('Content-Type: text/plain; charset=utf-8');
95 echo $exc->getMessage();
99 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
101 // Force cookie path (but do not change lifetime)
102 $cookie = session_get_cookie_params();
104 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
105 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
107 // Set default cookie expiration and path.
108 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
109 // Set session parameters on server side.
110 // Use cookies to store session.
111 ini_set('session.use_cookies', 1);
112 // Force cookies for session (phpsessionID forbidden in URL).
113 ini_set('session.use_only_cookies', 1);
114 // Prevent PHP form using sessionID in URL if cookies are disabled.
115 ini_set('session.use_trans_sid', false);
117 session_name('shaarli');
118 // Start session if needed (Some server auto-start sessions).
119 if (session_status() == PHP_SESSION_NONE
) {
123 // Regenerate session ID if invalid or not defined in cookie.
124 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
125 session_regenerate_id(true);
126 $_COOKIE['shaarli'] = session_id();
129 $conf = new ConfigManager();
131 // In dev mode, throw exception on any warning
132 if ($conf->get('dev.debug', false)) {
133 // See all errors (for debugging only)
136 set_error_handler(function($errno, $errstr, $errfile, $errline, array $errcontext) {
137 throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
141 $sessionManager = new SessionManager($_SESSION, $conf);
142 $loginManager = new LoginManager($conf, $sessionManager);
143 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
144 $clientIpId = client_ip_id($_SERVER);
146 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
147 if (! defined('LC_MESSAGES')) {
148 define('LC_MESSAGES', LC_COLLATE
);
151 // Sniff browser language and set date format accordingly.
152 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
153 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
156 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
158 $conf->setEmpty('general.timezone', date_default_timezone_get());
159 $conf->setEmpty('general.title', t('Shared bookmarks on '). escape(index_url($_SERVER)));
160 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
161 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
163 $pluginManager = new PluginManager($conf);
164 $pluginManager->load($conf->get('general.enabled_plugins'));
166 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
168 ob_start(); // Output buffering for the page cache.
170 // Prevent caching on client side or proxy: (yes, it's ugly)
171 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
172 header("Cache-Control: no-store, no-cache, must-revalidate");
173 header("Cache-Control: post-check=0, pre-check=0", false);
174 header("Pragma: no-cache");
176 if (! is_file($conf->getConfigFileExt())) {
177 // Ensure Shaarli has proper access to its resources
178 $errors = ApplicationUtils
::checkResourcePermissions($conf);
180 if ($errors != array()) {
181 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
183 foreach ($errors as $error) {
184 $message .= '<li>'.$error.'</li>';
188 header('Content-Type: text/html; charset=utf-8');
193 // Display the installation form if no existing config is found
194 install($conf, $sessionManager, $loginManager);
197 $loginManager->checkLoginState($_COOKIE, $clientIpId);
200 * Adapter function to ensure compatibility with third-party templates
202 * @see https://github.com/shaarli/Shaarli/pull/1086
204 * @return bool true when the user is logged in, false otherwise
206 function isLoggedIn()
208 global $loginManager;
209 return $loginManager->isLoggedIn();
213 // ------------------------------------------------------------------------------------------
214 // Process login form: Check if login/password is correct.
215 if (isset($_POST['login'])) {
216 if (! $loginManager->canLogin($_SERVER)) {
217 die(t('I said: NO. You are banned for the moment. Go away.'));
219 if (isset($_POST['password'])
220 && $sessionManager->checkToken($_POST['token'])
221 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
223 $loginManager->handleSuccessfulLogin($_SERVER);
226 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
227 // Note: Never forget the trailing slash on the cookie path!
228 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
231 if (!empty($_POST['longlastingsession'])) {
232 // Keep the session cookie even after the browser closes
233 $sessionManager->setStaySignedIn(true);
234 $expirationTime = $sessionManager->extendSession();
237 $loginManager::$STAY_SIGNED_IN_COOKIE,
238 $loginManager->getStaySignedInToken(),
243 // Standard session expiration (=when browser closes)
247 // Send cookie with the new expiration date to the browser
249 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
251 session_regenerate_id(true);
253 // Optional redirect after login:
254 if (isset($_GET['post'])) {
255 $uri = './?post='. urlencode($_GET['post']);
256 foreach (array('description', 'source', 'title', 'tags') as $param) {
257 if (!empty($_GET[$param])) {
258 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
261 header('Location: '. $uri);
265 if (isset($_GET['edit_link'])) {
266 header('Location: ./?edit_link='. escape($_GET['edit_link']));
270 if (isset($_POST['returnurl'])) {
271 // Prevent loops over login screen.
272 if (strpos($_POST['returnurl'], '/login') === false) {
273 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
277 header('Location: ./?');
280 $loginManager->handleFailedLogin($_SERVER);
281 $redir = '?username='. urlencode($_POST['login']);
282 if (isset($_GET['post'])) {
283 $redir .= '&post=' . urlencode($_GET['post']);
284 foreach (array('description', 'source', 'title', 'tags') as $param) {
285 if (!empty($_GET[$param])) {
286 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
290 // Redirect to login screen.
291 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'./login'.$redir.'\';</script>';
296 // ------------------------------------------------------------------------------------------
297 // Token management for XSRF protection
298 // Token should be used in any form which acts on data (create,update,delete,import...).
299 if (!isset($_SESSION['tokens'])) {
300 $_SESSION['tokens']=array(); // Token are attached to the session.
304 * Daily RSS feed: 1 RSS entry per day giving all the bookmarks on that day.
305 * Gives the last 7 days (which have bookmarks).
306 * This RSS feed cannot be filtered.
308 * @param BookmarkServiceInterface $bookmarkService
309 * @param ConfigManager $conf Configuration Manager instance
310 * @param LoginManager $loginManager LoginManager instance
312 function showDailyRSS($bookmarkService, $conf, $loginManager)
315 $query = $_SERVER['QUERY_STRING'];
316 $cache = new CachedPage(
317 $conf->get('config.PAGE_CACHE'),
319 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
321 $cached = $cache->cachedVersion();
322 if (!empty($cached)) {
327 /* Some Shaarlies may have very few bookmarks, so we need to look
328 back in time until we have enough days ($nb_of_days).
330 $nb_of_days = 7; // We take 7 days.
331 $today = date('Ymd');
334 foreach ($bookmarkService->search() as $bookmark) {
335 $day = $bookmark->getCreated()->format('Ymd'); // Extract day (without time)
336 if (strcmp($day, $today) < 0) {
337 if (empty($days[$day])) {
338 $days[$day] = array();
340 $days[$day][] = $bookmark;
343 if (count($days) > $nb_of_days) {
344 break; // Have we collected enough days?
348 // Build the RSS feed.
349 header('Content-Type: application/rss+xml; charset=utf-8');
350 $pageaddr = escape(index_url($_SERVER));
351 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
353 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
354 echo '<link>'. $pageaddr .'</link>';
355 echo '<description>Daily shared bookmarks</description>';
356 echo '<language>en-en</language>';
357 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
359 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
360 $formatter = $factory->getFormatter();
361 $formatter->addContextData('index_url', index_url($_SERVER));
363 /** @var Bookmark[] $bookmarks */
364 foreach ($days as $day => $bookmarks) {
365 $formattedBookmarks = [];
366 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
367 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
369 // We pre-format some fields for proper output.
370 foreach ($bookmarks as $key => $bookmark) {
371 $formattedBookmarks[$key] = $formatter->format($bookmark);
372 // This page is a bit specific, we need raw description to calculate the length
373 $formattedBookmarks[$key]['formatedDescription'] = $formattedBookmarks[$key]['description'];
374 $formattedBookmarks[$key]['description'] = $bookmark->getDescription();
376 if ($bookmark->isNote()) {
377 $link['url'] = index_url($_SERVER) . $bookmark->getUrl(); // make permalink URL absolute
381 // Then build the HTML for this day:
382 $tpl = new RainTPL();
383 $tpl->assign('title', $conf->get('general.title'));
384 $tpl->assign('daydate', $dayDate->getTimestamp());
385 $tpl->assign('absurl', $absurl);
386 $tpl->assign('links', $formattedBookmarks);
387 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
388 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
389 $tpl->assign('index_url', $pageaddr);
390 $html = $tpl->draw('dailyrss', true);
392 echo $html . PHP_EOL
;
394 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
396 $cache->cache(ob_get_contents());
402 * Show the 'Daily' page.
404 * @param PageBuilder $pageBuilder Template engine wrapper.
405 * @param BookmarkServiceInterface $bookmarkService instance.
406 * @param ConfigManager $conf Configuration Manager instance.
407 * @param PluginManager $pluginManager Plugin Manager instance.
408 * @param LoginManager $loginManager Login Manager instance
410 function showDaily($pageBuilder, $bookmarkService, $conf, $pluginManager, $loginManager)
412 if (isset($_GET['day'])) {
414 if ($day === date('Ymd', strtotime('now'))) {
415 $pageBuilder->assign('dayDesc', t('Today'));
416 } elseif ($day === date('Ymd', strtotime('-1 days'))) {
417 $pageBuilder->assign('dayDesc', t('Yesterday'));
420 $day = date('Ymd', strtotime('now')); // Today, in format YYYYMMDD.
421 $pageBuilder->assign('dayDesc', t('Today'));
424 $days = $bookmarkService->days();
425 $i = array_search($day, $days);
426 if ($i === false && count($days)) {
427 // no bookmarks for day, but at least one day with bookmarks
428 $i = count($days) - 1;
436 $previousday = $days[$i - 1];
438 if ($i < count($days) - 1) {
439 $nextday = $days[$i +
1];
443 $linksToDisplay = $bookmarkService->filterDay($day);
444 } catch (Exception
$exc) {
446 $linksToDisplay = [];
449 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
450 $formatter = $factory->getFormatter();
451 // We pre-format some fields for proper output.
452 foreach ($linksToDisplay as $key => $bookmark) {
453 $linksToDisplay[$key] = $formatter->format($bookmark);
454 // This page is a bit specific, we need raw description to calculate the length
455 $linksToDisplay[$key]['formatedDescription'] = $linksToDisplay[$key]['description'];
456 $linksToDisplay[$key]['description'] = $bookmark->getDescription();
459 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
461 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
462 'linksToDisplay' => $linksToDisplay,
463 'day' => $dayDate->getTimestamp(),
464 'dayDate' => $dayDate,
465 'previousday' => $previousday,
466 'nextday' => $nextday,
469 /* Hook is called before column construction so that plugins don't have
470 to deal with columns. */
471 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
473 /* We need to spread the articles on 3 columns.
474 I did not want to use a JavaScript lib like http://masonry.desandro.com/
475 so I manually spread entries with a simple method: I roughly evaluate the
476 height of a div according to title and description length.
478 $columns = array(array(), array(), array()); // Entries to display, for each column.
479 $fill = array(0, 0, 0); // Rough estimate of columns fill.
480 foreach ($data['linksToDisplay'] as $key => $bookmark) {
481 // Roughly estimate length of entry (by counting characters)
482 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
483 // Description: 836 characters gives roughly 342 pixel height.
484 // This is not perfect, but it's usually OK.
485 $length = strlen($bookmark['title']) +
(342 * strlen($bookmark['description'])) / 836;
486 if (! empty($bookmark['thumbnail'])) {
487 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
489 // Then put in column which is the less filled:
490 $smallest = min($fill); // find smallest value in array.
491 $index = array_search($smallest, $fill); // find index of this smallest value.
492 array_push($columns[$index], $bookmark); // Put entry in this column.
493 $fill[$index] +
= $length;
496 $data['cols'] = $columns;
498 foreach ($data as $key => $value) {
499 $pageBuilder->assign($key, $value);
502 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
503 $pageBuilder->renderPage('daily');
508 * Renders the linklist
510 * @param pageBuilder $PAGE pageBuilder instance.
511 * @param BookmarkServiceInterface $linkDb instance.
512 * @param ConfigManager $conf Configuration Manager instance.
513 * @param PluginManager $pluginManager Plugin Manager instance.
515 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
517 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
518 $PAGE->renderPage('linklist');
522 * Render HTML page (according to URL parameters and user rights)
524 * @param ConfigManager $conf Configuration Manager instance.
525 * @param PluginManager $pluginManager Plugin Manager instance,
526 * @param BookmarkServiceInterface $bookmarkService
527 * @param History $history instance
528 * @param SessionManager $sessionManager SessionManager instance
529 * @param LoginManager $loginManager LoginManager instance
531 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
533 $updater = new Updater(
534 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
537 $loginManager->isLoggedIn()
540 $newUpdates = $updater->update();
541 if (! empty($newUpdates)) {
542 UpdaterUtils
::write_updates_file(
543 $conf->get('resource.updates'),
544 $updater->getDoneUpdates()
547 } catch (Exception
$e) {
548 die($e->getMessage());
551 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
552 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
553 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
554 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
556 // Determine which page will be rendered.
557 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
558 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
560 if (// if the user isn't logged in
561 !$loginManager->isLoggedIn() &&
562 // and Shaarli doesn't have public content...
563 $conf->get('privacy.hide_public_links') &&
564 // and is configured to enforce the login
565 $conf->get('privacy.force_login') &&
566 // and the current page isn't already the login page
567 $targetPage !== Router
::$PAGE_LOGIN &&
568 // and the user is not requesting a feed (which would lead to a different content-type as expected)
569 $targetPage !== Router
::$PAGE_FEED_ATOM &&
570 $targetPage !== Router
::$PAGE_FEED_RSS
572 // force current page to be the login page
573 $targetPage = Router
::$PAGE_LOGIN;
576 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
577 // Then assign generated data to RainTPL.
578 $common_hooks = array(
584 foreach ($common_hooks as $name) {
585 $plugin_data = array();
586 $pluginManager->executeHooks(
590 'target' => $targetPage,
591 'loggedin' => $loginManager->isLoggedIn()
594 $PAGE->assign('plugins_' . $name, $plugin_data);
597 // -------- Display login form.
598 if ($targetPage == Router
::$PAGE_LOGIN) {
599 header('Location: ./login');
602 // -------- User wants to logout.
603 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
604 invalidateCaches($conf->get('resource.page_cache'));
605 $sessionManager->logout();
606 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
607 header('Location: ?');
611 // -------- Picture wall
612 if ($targetPage == Router
::$PAGE_PICWALL) {
613 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
614 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
615 $PAGE->assign('linksToDisplay', []);
616 $PAGE->renderPage('picwall');
620 // Optionally filter the results:
621 $links = $bookmarkService->search($_GET);
622 $linksToDisplay = [];
624 // Get only bookmarks which have a thumbnail.
625 // Note: we do not retrieve thumbnails here, the request is too heavy.
626 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
627 $formatter = $factory->getFormatter();
628 foreach ($links as $key => $link) {
629 if ($link->getThumbnail() !== false) {
630 $linksToDisplay[] = $formatter->format($link);
635 'linksToDisplay' => $linksToDisplay,
637 $pluginManager->executeHooks('render_picwall', $data, ['loggedin' => $loginManager->isLoggedIn()]);
639 foreach ($data as $key => $value) {
640 $PAGE->assign($key, $value);
643 $PAGE->renderPage('picwall');
647 // -------- Tag cloud
648 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
649 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
650 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
651 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
653 // We sort tags alphabetically, then choose a font size according to count.
654 // First, find max value.
656 foreach ($tags as $value) {
657 $maxcount = max($maxcount, $value);
660 alphabetical_sort($tags, false, true);
662 $logMaxCount = $maxcount > 1 ? log($maxcount, 30) : 1;
664 foreach ($tags as $key => $value) {
665 if (in_array($key, $filteringTags)) {
668 // Tag font size scaling:
669 // default 15 and 30 logarithm bases affect scaling,
670 // 2.2 and 0.8 are arbitrary font sizes in em.
671 $size = log($value, 15) / $logMaxCount * 2.2 +
0.8;
672 $tagList[$key] = array(
674 'size' => number_format($size, 2, '.', ''),
678 $searchTags = implode(' ', escape($filteringTags));
680 'search_tags' => $searchTags,
683 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
685 foreach ($data as $key => $value) {
686 $PAGE->assign($key, $value);
689 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
690 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
691 $PAGE->renderPage('tag.cloud');
696 if ($targetPage == Router
::$PAGE_TAGLIST) {
697 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
698 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
699 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
700 foreach ($filteringTags as $tag) {
701 if (array_key_exists($tag, $tags)) {
706 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
707 alphabetical_sort($tags, false, true);
710 $searchTags = implode(' ', escape($filteringTags));
712 'search_tags' => $searchTags,
715 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
717 foreach ($data as $key => $value) {
718 $PAGE->assign($key, $value);
721 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
722 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
723 $PAGE->renderPage('tag.list');
728 if ($targetPage == Router
::$PAGE_DAILY) {
729 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
732 // ATOM and RSS feed.
733 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
734 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
735 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
738 $query = $_SERVER['QUERY_STRING'];
739 $cache = new CachedPage(
740 $conf->get('resource.page_cache'),
742 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
744 $cached = $cache->cachedVersion();
745 if (!empty($cached)) {
750 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
752 $feedGenerator = new FeedBuilder(
754 $factory->getFormatter(),
758 $loginManager->isLoggedIn()
760 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
761 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
762 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
763 $data = $feedGenerator->buildData();
765 // Process plugin hook.
766 $pluginManager->executeHooks('render_feed', $data, array(
767 'loggedin' => $loginManager->isLoggedIn(),
768 'target' => $targetPage,
771 // Render the template.
772 $PAGE->assignAll($data);
773 $PAGE->renderPage('feed.'. $feedType);
774 $cache->cache(ob_get_contents());
779 // Display opensearch plugin (XML)
780 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
781 header('Content-Type: application/xml; charset=utf-8');
782 $PAGE->assign('serverurl', index_url($_SERVER));
783 $PAGE->renderPage('opensearch');
787 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
788 if (isset($_GET['addtag'])) {
789 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
790 if (empty($_SERVER['HTTP_REFERER'])) {
791 // In case browser does not send HTTP_REFERER
792 header('Location: ?searchtags='.urlencode($_GET['addtag']));
795 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
797 // Prevent redirection loop
798 if (isset($params['addtag'])) {
799 unset($params['addtag']);
802 // Check if this tag is already in the search query and ignore it if it is.
803 // Each tag is always separated by a space
804 if (isset($params['searchtags'])) {
805 $current_tags = explode(' ', $params['searchtags']);
807 $current_tags = array();
810 foreach ($current_tags as $value) {
811 if ($value === $_GET['addtag']) {
816 // Append the tag if necessary
817 if (empty($params['searchtags'])) {
818 $params['searchtags'] = trim($_GET['addtag']);
820 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
823 // We also remove page (keeping the same page has no sense, since the
824 // results are different)
825 unset($params['page']);
827 header('Location: ?'.http_build_query($params));
831 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
832 if (isset($_GET['removetag'])) {
833 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
834 if (empty($_SERVER['HTTP_REFERER'])) {
835 header('Location: ?');
839 // In case browser does not send HTTP_REFERER
840 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
842 // Prevent redirection loop
843 if (isset($params['removetag'])) {
844 unset($params['removetag']);
847 if (isset($params['searchtags'])) {
848 $tags = explode(' ', $params['searchtags']);
849 // Remove value from array $tags.
850 $tags = array_diff($tags, array($_GET['removetag']));
851 $params['searchtags'] = implode(' ', $tags);
853 if (empty($params['searchtags'])) {
854 unset($params['searchtags']);
857 // We also remove page (keeping the same page has no sense, since
858 // the results are different)
859 unset($params['page']);
861 header('Location: ?'.http_build_query($params));
865 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
866 if (isset($_GET['linksperpage'])) {
867 if (is_numeric($_GET['linksperpage'])) {
868 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
871 if (! empty($_SERVER['HTTP_REFERER'])) {
872 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
876 header('Location: '. $location);
880 // -------- User wants to see only private bookmarks (toggle)
881 if (isset($_GET['visibility'])) {
882 if ($_GET['visibility'] === 'private') {
883 // Visibility not set or not already private, set private, otherwise reset it
884 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
885 // See only private bookmarks
886 $_SESSION['visibility'] = 'private';
888 unset($_SESSION['visibility']);
890 } elseif ($_GET['visibility'] === 'public') {
891 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
892 // See only public bookmarks
893 $_SESSION['visibility'] = 'public';
895 unset($_SESSION['visibility']);
899 if (! empty($_SERVER['HTTP_REFERER'])) {
900 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
904 header('Location: '. $location);
908 // -------- User wants to see only untagged bookmarks (toggle)
909 if (isset($_GET['untaggedonly'])) {
910 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
912 if (! empty($_SERVER['HTTP_REFERER'])) {
913 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
917 header('Location: '. $location);
921 // -------- Handle other actions allowed for non-logged in users:
922 if (!$loginManager->isLoggedIn()) {
923 // User tries to post new link but is not logged in:
924 // Show login screen, then redirect to ?post=...
925 if (isset($_GET['post'])) {
926 header( // Redirect to login page, then back to post link.
927 'Location: /login?post='.urlencode($_GET['post']).
928 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
929 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
930 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
931 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
936 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
937 if (isset($_GET['edit_link'])) {
938 header('Location: /login?edit_link='. escape($_GET['edit_link']));
942 exit; // Never remove this one! All operations below are reserved for logged in user.
945 // -------- All other functions are reserved for the registered user:
947 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
948 if ($targetPage == Router
::$PAGE_TOOLS) {
950 'pageabsaddr' => index_url($_SERVER),
951 'sslenabled' => is_https($_SERVER),
953 $pluginManager->executeHooks('render_tools', $data);
955 foreach ($data as $key => $value) {
956 $PAGE->assign($key, $value);
959 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
960 $PAGE->renderPage('tools');
964 // -------- User wants to change his/her password.
965 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
966 if ($conf->get('security.open_shaarli')) {
967 die(t('You are not supposed to change a password on an Open Shaarli.'));
970 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
971 if (!$sessionManager->checkToken($_POST['token'])) {
972 die(t('Wrong token.')); // Go away!
975 // Make sure old password is correct.
977 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
979 if ($oldhash != $conf->get('credentials.hash')) {
980 echo '<script>alert("'
981 . t('The old password is not correct.')
982 .'");document.location=\'./?do=changepasswd\';</script>';
986 // Salt renders rainbow-tables attacks useless.
987 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
991 $_POST['setpassword']
992 . $conf->get('credentials.login')
993 . $conf->get('credentials.salt')
997 $conf->write($loginManager->isLoggedIn());
998 } catch (Exception
$e) {
1000 'ERROR while writing config file after changing password.' . PHP_EOL
.
1004 // TODO: do not handle exceptions/errors in JS.
1005 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
1008 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
1011 // show the change password form.
1012 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1013 $PAGE->renderPage('changepassword');
1018 // -------- User wants to change configuration
1019 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1020 if (!empty($_POST['title'])) {
1021 if (!$sessionManager->checkToken($_POST['token'])) {
1022 die(t('Wrong token.')); // Go away!
1025 if (!empty($_POST['continent']) && !empty($_POST['city'])
1026 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1028 $tz = $_POST['continent'] . '/' . $_POST['city'];
1030 $conf->set('general.timezone', $tz);
1031 $conf->set('general.title', escape($_POST['title']));
1032 $conf->set('general.header_link', escape($_POST['titleLink']));
1033 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
1034 $conf->set('resource.theme', escape($_POST['theme']));
1035 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1036 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1037 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1038 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1039 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1040 $conf->set('api.enabled', !empty($_POST['enableApi']));
1041 $conf->set('api.secret', escape($_POST['apiSecret']));
1042 $conf->set('formatter', escape($_POST['formatter']));
1044 if (! empty($_POST['language'])) {
1045 $conf->set('translation.language', escape($_POST['language']));
1048 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1049 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1050 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1052 $_SESSION['warnings'][] = t(
1053 'You have enabled or changed thumbnails mode. '
1054 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
1057 $conf->set('thumbnails.mode', $thumbnailsMode);
1060 $conf->write($loginManager->isLoggedIn());
1061 $history->updateSettings();
1062 invalidateCaches($conf->get('resource.page_cache'));
1063 } catch (Exception
$e) {
1065 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1069 // TODO: do not handle exceptions/errors in JS.
1070 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
1073 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
1076 // Show the configuration form.
1077 $PAGE->assign('title', $conf->get('general.title'));
1078 $PAGE->assign('theme', $conf->get('resource.theme'));
1079 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1080 $PAGE->assign('formatter_available', ['default', 'markdown']);
1081 list($continents, $cities) = generateTimeZoneData(
1082 timezone_identifiers_list(),
1083 $conf->get('general.timezone')
1085 $PAGE->assign('continents', $continents);
1086 $PAGE->assign('cities', $cities);
1087 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1088 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1089 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1090 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1091 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1092 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1093 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1094 $PAGE->assign('api_secret', $conf->get('api.secret'));
1095 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1096 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1097 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1098 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1099 $PAGE->renderPage('configure');
1104 // -------- User wants to rename a tag or delete it
1105 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1106 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1107 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1108 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1109 $PAGE->renderPage('changetag');
1113 if (!$sessionManager->checkToken($_POST['token'])) {
1114 die(t('Wrong token.'));
1117 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1118 $fromTag = escape($_POST['fromtag']);
1120 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1121 foreach ($bookmarks as $bookmark) {
1123 $bookmark->renameTag($fromTag, $toTag);
1125 $bookmark->deleteTag($fromTag);
1127 $bookmarkService->set($bookmark, false);
1128 $history->updateLink($bookmark);
1131 $bookmarkService->save();
1132 $delete = empty($_POST['totag']);
1133 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1135 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1136 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1137 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1141 // -------- User wants to add a link without using the bookmarklet: Show form.
1142 if ($targetPage == Router
::$PAGE_ADDLINK) {
1143 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1144 $PAGE->renderPage('addlink');
1148 // -------- User clicked the "Save" button when editing a link: Save link to database.
1149 if (isset($_POST['save_edit'])) {
1151 if (! $sessionManager->checkToken($_POST['token'])) {
1152 die(t('Wrong token.'));
1155 // lf_id should only be present if the link exists.
1156 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1157 if ($id && $bookmarkService->exists($id)) {
1159 $bookmark = $bookmarkService->get($id);
1162 $bookmark = new Bookmark();
1165 $bookmark->setTitle($_POST['lf_title']);
1166 $bookmark->setDescription($_POST['lf_description']);
1167 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1168 $bookmark->setPrivate(isset($_POST['lf_private']));
1169 $bookmark->setTagsString($_POST['lf_tags']);
1171 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1172 && ! $bookmark->isNote()
1174 $thumbnailer = new Thumbnailer($conf);
1175 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1177 $bookmarkService->addOrSet($bookmark, false);
1179 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1180 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1181 $formatter = $factory->getFormatter('raw');
1182 $data = $formatter->format($bookmark);
1183 $pluginManager->executeHooks('save_link', $data);
1185 $bookmark->fromArray($data);
1186 $bookmarkService->set($bookmark);
1188 // If we are called from the bookmarklet, we must close the popup:
1189 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1190 echo '<script>self.close();</script>';
1194 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1195 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1196 // Scroll to the link which has been edited.
1197 $location .= '#' . $bookmark->getShortUrl();
1198 // After saving the link, redirect to the page the user was on.
1199 header('Location: '. $location);
1203 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1204 if ($targetPage == Router
::$PAGE_DELETELINK) {
1205 if (! $sessionManager->checkToken($_GET['token'])) {
1206 die(t('Wrong token.'));
1209 $ids = trim($_GET['lf_linkdate']);
1210 if (strpos($ids, ' ') !== false) {
1211 // multiple, space-separated ids provided
1212 $ids = array_values(array_filter(
1213 preg_split('/\s+/', escape($ids)),
1215 return $item !== '';
1219 // only a single id provided
1220 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1223 // assert at least one id is given
1225 die('no id provided');
1227 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1228 $formatter = $factory->getFormatter('raw');
1229 foreach ($ids as $id) {
1230 $id = (int) escape($id);
1231 $bookmark = $bookmarkService->get($id);
1232 $data = $formatter->format($bookmark);
1233 $pluginManager->executeHooks('delete_link', $data);
1234 $bookmarkService->remove($bookmark, false);
1236 $bookmarkService->save();
1238 // If we are called from the bookmarklet, we must close the popup:
1239 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1240 echo '<script>self.close();</script>';
1245 if (isset($_SERVER['HTTP_REFERER'])) {
1246 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1247 $location = generateLocation(
1248 $_SERVER['HTTP_REFERER'],
1249 $_SERVER['HTTP_HOST'],
1250 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1254 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1258 // -------- User clicked either "Set public" or "Set private" bulk operation
1259 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1260 if (! $sessionManager->checkToken($_GET['token'])) {
1261 die(t('Wrong token.'));
1264 $ids = trim($_GET['ids']);
1265 if (strpos($ids, ' ') !== false) {
1266 // multiple, space-separated ids provided
1267 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1269 // only a single id provided
1273 // assert at least one id is given
1275 die('no id provided');
1277 // assert that the visibility is valid
1278 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1279 die('invalid visibility');
1281 $private = $_GET['newVisibility'] === 'private';
1283 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1284 $formatter = $factory->getFormatter('raw');
1285 foreach ($ids as $id) {
1286 $id = (int) escape($id);
1287 $bookmark = $bookmarkService->get($id);
1288 $bookmark->setPrivate($private);
1290 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1291 $data = $formatter->format($bookmark);
1292 $pluginManager->executeHooks('save_link', $data);
1293 $bookmark->fromArray($data);
1295 $bookmarkService->set($bookmark);
1297 $bookmarkService->save();
1300 if (isset($_SERVER['HTTP_REFERER'])) {
1301 $location = generateLocation(
1302 $_SERVER['HTTP_REFERER'],
1303 $_SERVER['HTTP_HOST']
1306 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1310 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1311 if (isset($_GET['edit_link'])) {
1312 $id = (int) escape($_GET['edit_link']);
1314 $link = $bookmarkService->get($id); // Read database
1315 } catch (BookmarkNotFoundException
$e) {
1316 // Link not found in database.
1317 header('Location: ?');
1321 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1322 $formatter = $factory->getFormatter('raw');
1323 $formattedLink = $formatter->format($link);
1324 $tags = $bookmarkService->bookmarksCountPerTag();
1325 if ($conf->get('formatter') === 'markdown') {
1326 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1329 'link' => $formattedLink,
1330 'link_is_new' => false,
1331 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1334 $pluginManager->executeHooks('render_editlink', $data);
1336 foreach ($data as $key => $value) {
1337 $PAGE->assign($key, $value);
1340 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1341 $PAGE->renderPage('editlink');
1345 // -------- User want to post a new link: Display link edit form.
1346 if (isset($_GET['post'])) {
1347 $url = cleanup_url($_GET['post']);
1349 $link_is_new = false;
1350 // Check if URL is not already in database (in this case, we will edit the existing link)
1351 $bookmark = $bookmarkService->findByUrl($url);
1353 $link_is_new = true;
1354 // Get title if it was provided in URL (by the bookmarklet).
1355 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1356 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1357 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1358 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1359 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1361 // If this is an HTTP(S) link, we try go get the page to extract
1362 // the title (otherwise we will to straight to the edit form.)
1363 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1364 $retrieveDescription = $conf->get('general.retrieve_description');
1365 // Short timeout to keep the application responsive
1366 // The callback will fill $charset and $title with data from the downloaded page.
1369 $conf->get('general.download_timeout', 30),
1370 $conf->get('general.download_max_size', 4194304),
1371 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1373 if (! empty($title) && strtolower($charset) != 'utf-8') {
1374 $title = mb_convert_encoding($title, 'utf-8', $charset);
1379 $title = $conf->get('general.default_note_title', t('Note: '));
1381 $url = escape($url);
1382 $title = escape($title);
1387 'description' => $description,
1389 'private' => $private,
1392 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1393 $formatter = $factory->getFormatter('raw');
1394 $link = $formatter->format($bookmark);
1397 $tags = $bookmarkService->bookmarksCountPerTag();
1398 if ($conf->get('formatter') === 'markdown') {
1399 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1403 'link_is_new' => $link_is_new,
1404 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1405 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1407 'default_private_links' => $conf->get('privacy.default_private_links', false),
1409 $pluginManager->executeHooks('render_editlink', $data);
1411 foreach ($data as $key => $value) {
1412 $PAGE->assign($key, $value);
1415 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1416 $PAGE->renderPage('editlink');
1420 if ($targetPage == Router
::$PAGE_PINLINK) {
1421 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1422 // FIXME! Use a proper error system.
1423 $msg = t('Invalid link ID provided');
1424 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1427 if (! $sessionManager->checkToken($_GET['token'])) {
1428 die('Wrong token.');
1431 $link = $bookmarkService->get($_GET['id']);
1432 $link->setSticky(! $link->isSticky());
1433 $bookmarkService->set($link);
1434 header('Location: '.index_url($_SERVER));
1438 if ($targetPage == Router
::$PAGE_EXPORT) {
1439 // Export bookmarks as a Netscape Bookmarks file
1441 if (empty($_GET['selection'])) {
1442 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1443 $PAGE->renderPage('export');
1447 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1448 $selection = $_GET['selection'];
1449 if (isset($_GET['prepend_note_url'])) {
1450 $prependNoteUrl = $_GET['prepend_note_url'];
1452 $prependNoteUrl = false;
1456 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1457 $formatter = $factory->getFormatter('raw');
1460 NetscapeBookmarkUtils
::filterAndFormat(
1468 } catch (Exception
$exc) {
1469 header('Content-Type: text/plain; charset=utf-8');
1470 echo $exc->getMessage();
1473 $now = new DateTime();
1474 header('Content-Type: text/html; charset=utf-8');
1476 'Content-disposition: attachment; filename=bookmarks_'
1477 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1479 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1480 $PAGE->assign('eol', PHP_EOL
);
1481 $PAGE->assign('selection', $selection);
1482 $PAGE->renderPage('export.bookmarks');
1486 if ($targetPage == Router
::$PAGE_IMPORT) {
1487 // Upload a Netscape bookmark dump to import its contents
1489 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1490 // Show import dialog
1493 get_max_upload_size(
1494 ini_get('post_max_size'),
1495 ini_get('upload_max_filesize'),
1501 get_max_upload_size(
1502 ini_get('post_max_size'),
1503 ini_get('upload_max_filesize'),
1507 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1508 $PAGE->renderPage('import');
1512 // Import bookmarks from an uploaded file
1513 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1514 // The file is too big or some form field may be missing.
1517 'The file you are trying to upload is probably bigger than what this webserver can accept'
1518 .' (%s). Please upload in smaller chunks.'
1520 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1522 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1525 if (! $sessionManager->checkToken($_POST['token'])) {
1526 die('Wrong token.');
1528 $status = NetscapeBookmarkUtils
::import(
1535 echo '<script>alert("'.$status.'");document.location=\'./?do='
1536 .Router
::$PAGE_IMPORT .'\';</script>';
1540 // Plugin administration page
1541 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1542 $pluginMeta = $pluginManager->getPluginsMeta();
1544 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1545 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1546 return $v['order'] !== false;
1549 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1553 return $a['order'] - $b['order'];
1556 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1557 return $v['order'] === false;
1560 $PAGE->assign('enabledPlugins', $enabledPlugins);
1561 $PAGE->assign('disabledPlugins', $disabledPlugins);
1562 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1563 $PAGE->renderPage('pluginsadmin');
1567 // Plugin administration form action
1568 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1570 if (isset($_POST['parameters_form'])) {
1571 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1572 unset($_POST['parameters_form']);
1573 foreach ($_POST as $param => $value) {
1574 $conf->set('plugins.'. $param, escape($value));
1577 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1579 $conf->write($loginManager->isLoggedIn());
1580 $history->updateSettings();
1581 } catch (Exception
$e) {
1583 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1587 // TODO: do not handle exceptions/errors in JS.
1588 echo '<script>alert("'
1590 .'");document.location=\'./?do='
1591 . Router
::$PAGE_PLUGINSADMIN
1595 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1599 // Get a fresh token
1600 if ($targetPage == Router
::$GET_TOKEN) {
1601 header('Content-Type:text/plain');
1602 echo $sessionManager->generateToken();
1606 // -------- Thumbnails Update
1607 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1609 foreach ($bookmarkService->search() as $bookmark) {
1610 // A note or not HTTP(S)
1611 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1614 $ids[] = $bookmark->getId();
1616 $PAGE->assign('ids', $ids);
1617 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1618 $PAGE->renderPage('thumbnails');
1622 // -------- Single Thumbnail Update
1623 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1624 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1625 http_response_code(400);
1628 $id = (int) $_POST['id'];
1629 if (! $bookmarkService->exists($id)) {
1630 http_response_code(404);
1633 $thumbnailer = new Thumbnailer($conf);
1634 $bookmark = $bookmarkService->get($id);
1635 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1636 $bookmarkService->set($bookmark);
1638 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1639 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1643 // -------- Otherwise, simply display search form and bookmarks:
1644 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1649 * Template for the list of bookmarks (<div id="linklist">)
1650 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1652 * @param pageBuilder $PAGE pageBuilder instance.
1653 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1654 * @param ConfigManager $conf Configuration Manager instance.
1655 * @param PluginManager $pluginManager Plugin Manager instance.
1656 * @param LoginManager $loginManager LoginManager instance
1658 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1660 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1661 $formatter = $factory->getFormatter();
1663 // Used in templates
1664 if (isset($_GET['searchtags'])) {
1665 if (! empty($_GET['searchtags'])) {
1666 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1668 $searchtags = false;
1673 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1676 if (! empty($_SERVER['QUERY_STRING'])
1677 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1679 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1680 } catch (BookmarkNotFoundException
$e) {
1681 $PAGE->render404($e->getMessage());
1685 // Filter bookmarks according search parameters.
1686 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1688 'searchtags' => $searchtags,
1689 'searchterm' => $searchterm,
1691 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1694 // ---- Handle paging.
1696 foreach ($linksToDisplay as $key => $value) {
1700 // Select articles according to paging.
1701 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1702 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1703 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1704 $page = $page < 1 ? 1 : $page;
1705 $page = $page > $pagecount ? $pagecount : $page;
1707 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1708 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1710 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1711 if ($thumbnailsEnabled) {
1712 $thumbnailer = new Thumbnailer($conf);
1715 $linkDisp = array();
1716 while ($i<$end && $i<count($keys)) {
1717 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1719 // Logged in, thumbnails enabled, not a note,
1720 // and (never retrieved yet or no valid cache file)
1721 if ($loginManager->isLoggedIn()
1722 && $thumbnailsEnabled
1723 && !$linksToDisplay[$keys[$i]]->isNote()
1724 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1725 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1727 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1728 $linkDb->set($linksToDisplay[$keys[$i]], false);
1730 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1733 // Check for both signs of a note: starting with ? and 7 chars long.
1734 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1735 // $link['url'] = index_url($_SERVER) . $link['url'];
1738 $linkDisp[$keys[$i]] = $link;
1742 // If we retrieved new thumbnails, we update the database.
1743 if (!empty($updateDB)) {
1747 // Compute paging navigation
1748 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1749 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1750 $previous_page_url = '';
1751 if ($i != count($keys)) {
1752 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1756 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1759 // Fill all template fields.
1761 'previous_page_url' => $previous_page_url,
1762 'next_page_url' => $next_page_url,
1763 'page_current' => $page,
1764 'page_max' => $pagecount,
1765 'result_count' => count($linksToDisplay),
1766 'search_term' => $searchterm,
1767 'search_tags' => $searchtags,
1768 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1769 'links' => $linkDisp,
1772 // If there is only a single link, we change on-the-fly the title of the page.
1773 if (count($linksToDisplay) == 1) {
1774 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1775 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1776 $data['pagetitle'] = t('Search: ');
1777 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1778 $bracketWrap = function ($tag) {
1779 return '['. $tag .']';
1781 $data['pagetitle'] .= ! empty($searchtags)
1782 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1784 $data['pagetitle'] .= '- '. $conf->get('general.title');
1787 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1789 foreach ($data as $key => $value) {
1790 $PAGE->assign($key, $value);
1798 * This function should NEVER be called if the file data/config.php exists.
1800 * @param ConfigManager $conf Configuration Manager instance.
1801 * @param SessionManager $sessionManager SessionManager instance
1802 * @param LoginManager $loginManager LoginManager instance
1804 function install($conf, $sessionManager, $loginManager)
1806 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1807 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1808 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1812 // This part makes sure sessions works correctly.
1813 // (Because on some hosts, session.save_path may not be set correctly,
1814 // or we may not have write access to it.)
1815 if (isset($_GET['test_session'])
1816 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1817 // Step 2: Check if data in session is correct.
1819 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1820 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1821 'and that you have write access to it.<br>'.
1822 'It currently points to %s.<br>'.
1823 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1824 'or any custom hostname without a dot causes cookie storage to fail. '.
1825 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1827 $msg = sprintf($msg, session_save_path());
1829 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1832 if (!isset($_SESSION['session_tested'])) {
1833 // Step 1 : Try to store data in session and reload page.
1834 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1835 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1837 if (isset($_GET['test_session'])) {
1838 // Step 3: Sessions are OK. Remove test parameter from URL.
1839 header('Location: '.index_url($_SERVER));
1843 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1845 if (!empty($_POST['continent']) && !empty($_POST['city'])
1846 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1848 $tz = $_POST['continent'].'/'.$_POST['city'];
1850 $conf->set('general.timezone', $tz);
1851 $login = $_POST['setlogin'];
1852 $conf->set('credentials.login', $login);
1853 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1854 $conf->set('credentials.salt', $salt);
1855 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1856 if (!empty($_POST['title'])) {
1857 $conf->set('general.title', escape($_POST['title']));
1859 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1861 $conf->set('translation.language', escape($_POST['language']));
1862 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1863 $conf->set('api.enabled', !empty($_POST['enableApi']));
1866 generate_api_secret(
1867 $conf->get('credentials.login'),
1868 $conf->get('credentials.salt')
1872 // Everything is ok, let's create config file.
1873 $conf->write($loginManager->isLoggedIn());
1874 } catch (Exception
$e) {
1876 'ERROR while writing config file after installation.' . PHP_EOL
.
1880 // TODO: do not handle exceptions/errors in JS.
1881 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1885 $history = new History($conf->get('resource.history'));
1886 $bookmarkService = new BookmarkFileService($conf, $history, true);
1887 if ($bookmarkService->count() === 0) {
1888 $bookmarkService->initialize();
1891 echo '<script>alert('
1892 .'"Shaarli is now configured. '
1893 .'Please enter your login/password and start shaaring your bookmarks!"'
1894 .');document.location=\'./login\';</script>';
1898 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1899 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1900 $PAGE->assign('continents', $continents);
1901 $PAGE->assign('cities', $cities);
1902 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1903 $PAGE->renderPage('install');
1907 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1908 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1912 $history = new History($conf->get('resource.history'));
1913 } catch (Exception
$e) {
1914 die($e->getMessage());
1917 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1919 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1920 showDailyRSS($linkDb, $conf, $loginManager);
1924 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager);
1925 $container = $containerBuilder->build();
1926 $app = new App($container);
1929 $app->group('/api/v1', function () {
1930 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1931 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1932 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1933 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1934 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1935 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1937 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1938 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1939 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1940 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1942 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1943 })->add('\Shaarli\Api\ApiMiddleware');
1945 $app->group('', function () {
1946 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1947 })->add('\Shaarli\Front\ShaarliMiddleware');
1949 $response = $app->run(true);
1951 // Hack to make Slim and Shaarli router work together:
1952 // If a Slim route isn't found and NOT API call, we call renderPage().
1953 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1954 // We use UTF-8 for proper international characters handling.
1955 header('Content-Type: text/html; charset=utf-8');
1956 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1958 $response = $response
1959 ->withHeader('Access-Control-Allow-Origin', '*')
1961 'Access-Control-Allow-Headers',
1962 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1964 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1965 $app->respond($response);