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
246 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
247 session_regenerate_id(true);
249 // Optional redirect after login:
250 if (isset($_GET['post'])) {
251 $uri = '?post='. urlencode($_GET['post']);
252 foreach (array('description', 'source', 'title', 'tags') as $param) {
253 if (!empty($_GET[$param])) {
254 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
257 header('Location: '. $uri);
261 if (isset($_GET['edit_link'])) {
262 header('Location: ?edit_link='. escape($_GET['edit_link']));
266 if (isset($_POST['returnurl'])) {
267 // Prevent loops over login screen.
268 if (strpos($_POST['returnurl'], 'do=login') === false) {
269 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
273 header('Location: ?');
276 $loginManager->handleFailedLogin($_SERVER);
277 $redir = '&username='. urlencode($_POST['login']);
278 if (isset($_GET['post'])) {
279 $redir .= '&post=' . urlencode($_GET['post']);
280 foreach (array('description', 'source', 'title', 'tags') as $param) {
281 if (!empty($_GET[$param])) {
282 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
286 // Redirect to login screen.
287 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
292 // ------------------------------------------------------------------------------------------
293 // Token management for XSRF protection
294 // Token should be used in any form which acts on data (create,update,delete,import...).
295 if (!isset($_SESSION['tokens'])) {
296 $_SESSION['tokens']=array(); // Token are attached to the session.
300 * Daily RSS feed: 1 RSS entry per day giving all the bookmarks on that day.
301 * Gives the last 7 days (which have bookmarks).
302 * This RSS feed cannot be filtered.
304 * @param BookmarkServiceInterface $bookmarkService
305 * @param ConfigManager $conf Configuration Manager instance
306 * @param LoginManager $loginManager LoginManager instance
308 function showDailyRSS($bookmarkService, $conf, $loginManager)
311 $query = $_SERVER['QUERY_STRING'];
312 $cache = new CachedPage(
313 $conf->get('config.PAGE_CACHE'),
315 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
317 $cached = $cache->cachedVersion();
318 if (!empty($cached)) {
323 /* Some Shaarlies may have very few bookmarks, so we need to look
324 back in time until we have enough days ($nb_of_days).
326 $nb_of_days = 7; // We take 7 days.
327 $today = date('Ymd');
330 foreach ($bookmarkService->search() as $bookmark) {
331 $day = $bookmark->getCreated()->format('Ymd'); // Extract day (without time)
332 if (strcmp($day, $today) < 0) {
333 if (empty($days[$day])) {
334 $days[$day] = array();
336 $days[$day][] = $bookmark;
339 if (count($days) > $nb_of_days) {
340 break; // Have we collected enough days?
344 // Build the RSS feed.
345 header('Content-Type: application/rss+xml; charset=utf-8');
346 $pageaddr = escape(index_url($_SERVER));
347 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
349 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
350 echo '<link>'. $pageaddr .'</link>';
351 echo '<description>Daily shared bookmarks</description>';
352 echo '<language>en-en</language>';
353 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
355 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
356 $formatter = $factory->getFormatter();
357 $formatter->addContextData('index_url', index_url($_SERVER));
359 /** @var Bookmark[] $bookmarks */
360 foreach ($days as $day => $bookmarks) {
361 $formattedBookmarks = [];
362 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
363 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
365 // We pre-format some fields for proper output.
366 foreach ($bookmarks as $key => $bookmark) {
367 $formattedBookmarks[$key] = $formatter->format($bookmark);
368 // This page is a bit specific, we need raw description to calculate the length
369 $formattedBookmarks[$key]['formatedDescription'] = $formattedBookmarks[$key]['description'];
370 $formattedBookmarks[$key]['description'] = $bookmark->getDescription();
372 if ($bookmark->isNote()) {
373 $link['url'] = index_url($_SERVER) . $bookmark->getUrl(); // make permalink URL absolute
377 // Then build the HTML for this day:
378 $tpl = new RainTPL();
379 $tpl->assign('title', $conf->get('general.title'));
380 $tpl->assign('daydate', $dayDate->getTimestamp());
381 $tpl->assign('absurl', $absurl);
382 $tpl->assign('links', $formattedBookmarks);
383 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
384 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
385 $tpl->assign('index_url', $pageaddr);
386 $html = $tpl->draw('dailyrss', true);
388 echo $html . PHP_EOL
;
390 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
392 $cache->cache(ob_get_contents());
398 * Show the 'Daily' page.
400 * @param PageBuilder $pageBuilder Template engine wrapper.
401 * @param BookmarkServiceInterface $bookmarkService instance.
402 * @param ConfigManager $conf Configuration Manager instance.
403 * @param PluginManager $pluginManager Plugin Manager instance.
404 * @param LoginManager $loginManager Login Manager instance
406 function showDaily($pageBuilder, $bookmarkService, $conf, $pluginManager, $loginManager)
408 if (isset($_GET['day'])) {
410 if ($day === date('Ymd', strtotime('now'))) {
411 $pageBuilder->assign('dayDesc', t('Today'));
412 } elseif ($day === date('Ymd', strtotime('-1 days'))) {
413 $pageBuilder->assign('dayDesc', t('Yesterday'));
416 $day = date('Ymd', strtotime('now')); // Today, in format YYYYMMDD.
417 $pageBuilder->assign('dayDesc', t('Today'));
420 $days = $bookmarkService->days();
421 $i = array_search($day, $days);
422 if ($i === false && count($days)) {
423 // no bookmarks for day, but at least one day with bookmarks
424 $i = count($days) - 1;
432 $previousday = $days[$i - 1];
434 if ($i < count($days) - 1) {
435 $nextday = $days[$i +
1];
439 $linksToDisplay = $bookmarkService->filterDay($day);
440 } catch (Exception
$exc) {
442 $linksToDisplay = [];
445 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
446 $formatter = $factory->getFormatter();
447 // We pre-format some fields for proper output.
448 foreach ($linksToDisplay as $key => $bookmark) {
449 $linksToDisplay[$key] = $formatter->format($bookmark);
450 // This page is a bit specific, we need raw description to calculate the length
451 $linksToDisplay[$key]['formatedDescription'] = $linksToDisplay[$key]['description'];
452 $linksToDisplay[$key]['description'] = $bookmark->getDescription();
455 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
457 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
458 'linksToDisplay' => $linksToDisplay,
459 'day' => $dayDate->getTimestamp(),
460 'dayDate' => $dayDate,
461 'previousday' => $previousday,
462 'nextday' => $nextday,
465 /* Hook is called before column construction so that plugins don't have
466 to deal with columns. */
467 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
469 /* We need to spread the articles on 3 columns.
470 I did not want to use a JavaScript lib like http://masonry.desandro.com/
471 so I manually spread entries with a simple method: I roughly evaluate the
472 height of a div according to title and description length.
474 $columns = array(array(), array(), array()); // Entries to display, for each column.
475 $fill = array(0, 0, 0); // Rough estimate of columns fill.
476 foreach ($data['linksToDisplay'] as $key => $bookmark) {
477 // Roughly estimate length of entry (by counting characters)
478 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
479 // Description: 836 characters gives roughly 342 pixel height.
480 // This is not perfect, but it's usually OK.
481 $length = strlen($bookmark['title']) +
(342 * strlen($bookmark['description'])) / 836;
482 if (! empty($bookmark['thumbnail'])) {
483 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
485 // Then put in column which is the less filled:
486 $smallest = min($fill); // find smallest value in array.
487 $index = array_search($smallest, $fill); // find index of this smallest value.
488 array_push($columns[$index], $bookmark); // Put entry in this column.
489 $fill[$index] +
= $length;
492 $data['cols'] = $columns;
494 foreach ($data as $key => $value) {
495 $pageBuilder->assign($key, $value);
498 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
499 $pageBuilder->renderPage('daily');
504 * Renders the linklist
506 * @param pageBuilder $PAGE pageBuilder instance.
507 * @param BookmarkServiceInterface $linkDb instance.
508 * @param ConfigManager $conf Configuration Manager instance.
509 * @param PluginManager $pluginManager Plugin Manager instance.
511 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
513 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
514 $PAGE->renderPage('linklist');
518 * Render HTML page (according to URL parameters and user rights)
520 * @param ConfigManager $conf Configuration Manager instance.
521 * @param PluginManager $pluginManager Plugin Manager instance,
522 * @param BookmarkServiceInterface $bookmarkService
523 * @param History $history instance
524 * @param SessionManager $sessionManager SessionManager instance
525 * @param LoginManager $loginManager LoginManager instance
527 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
529 $updater = new Updater(
530 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
533 $loginManager->isLoggedIn()
536 $newUpdates = $updater->update();
537 if (! empty($newUpdates)) {
538 UpdaterUtils
::write_updates_file(
539 $conf->get('resource.updates'),
540 $updater->getDoneUpdates()
543 } catch (Exception
$e) {
544 die($e->getMessage());
547 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
548 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
549 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
550 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
552 // Determine which page will be rendered.
553 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
554 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
556 if (// if the user isn't logged in
557 !$loginManager->isLoggedIn() &&
558 // and Shaarli doesn't have public content...
559 $conf->get('privacy.hide_public_links') &&
560 // and is configured to enforce the login
561 $conf->get('privacy.force_login') &&
562 // and the current page isn't already the login page
563 $targetPage !== Router
::$PAGE_LOGIN &&
564 // and the user is not requesting a feed (which would lead to a different content-type as expected)
565 $targetPage !== Router
::$PAGE_FEED_ATOM &&
566 $targetPage !== Router
::$PAGE_FEED_RSS
568 // force current page to be the login page
569 $targetPage = Router
::$PAGE_LOGIN;
572 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
573 // Then assign generated data to RainTPL.
574 $common_hooks = array(
580 foreach ($common_hooks as $name) {
581 $plugin_data = array();
582 $pluginManager->executeHooks(
586 'target' => $targetPage,
587 'loggedin' => $loginManager->isLoggedIn()
590 $PAGE->assign('plugins_' . $name, $plugin_data);
593 // -------- Display login form.
594 if ($targetPage == Router
::$PAGE_LOGIN) {
595 if ($conf->get('security.open_shaarli')) {
596 header('Location: ?');
598 } // No need to login for open Shaarli
599 if (isset($_GET['username'])) {
600 $PAGE->assign('username', escape($_GET['username']));
602 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
603 // add default state of the 'remember me' checkbox
604 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
605 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
606 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
607 $PAGE->renderPage('loginform');
610 // -------- User wants to logout.
611 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
612 invalidateCaches($conf->get('resource.page_cache'));
613 $sessionManager->logout();
614 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
615 header('Location: ?');
619 // -------- Picture wall
620 if ($targetPage == Router
::$PAGE_PICWALL) {
621 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
622 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
623 $PAGE->assign('linksToDisplay', []);
624 $PAGE->renderPage('picwall');
628 // Optionally filter the results:
629 $links = $bookmarkService->search($_GET);
630 $linksToDisplay = [];
632 // Get only bookmarks which have a thumbnail.
633 // Note: we do not retrieve thumbnails here, the request is too heavy.
634 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
635 $formatter = $factory->getFormatter();
636 foreach ($links as $key => $link) {
637 if ($link->getThumbnail() !== false) {
638 $linksToDisplay[] = $formatter->format($link);
643 'linksToDisplay' => $linksToDisplay,
645 $pluginManager->executeHooks('render_picwall', $data, ['loggedin' => $loginManager->isLoggedIn()]);
647 foreach ($data as $key => $value) {
648 $PAGE->assign($key, $value);
651 $PAGE->renderPage('picwall');
655 // -------- Tag cloud
656 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
657 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
658 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
659 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
661 // We sort tags alphabetically, then choose a font size according to count.
662 // First, find max value.
664 foreach ($tags as $value) {
665 $maxcount = max($maxcount, $value);
668 alphabetical_sort($tags, false, true);
671 foreach ($tags as $key => $value) {
672 if (in_array($key, $filteringTags)) {
675 // Tag font size scaling:
676 // default 15 and 30 logarithm bases affect scaling,
677 // 22 and 6 are arbitrary font sizes for max and min sizes.
678 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
679 $tagList[$key] = array(
681 'size' => number_format($size, 2, '.', ''),
685 $searchTags = implode(' ', escape($filteringTags));
687 'search_tags' => $searchTags,
690 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
692 foreach ($data as $key => $value) {
693 $PAGE->assign($key, $value);
696 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
697 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
698 $PAGE->renderPage('tag.cloud');
703 if ($targetPage == Router
::$PAGE_TAGLIST) {
704 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
705 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
706 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
707 foreach ($filteringTags as $tag) {
708 if (array_key_exists($tag, $tags)) {
713 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
714 alphabetical_sort($tags, false, true);
717 $searchTags = implode(' ', escape($filteringTags));
719 'search_tags' => $searchTags,
722 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
724 foreach ($data as $key => $value) {
725 $PAGE->assign($key, $value);
728 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
729 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
730 $PAGE->renderPage('tag.list');
735 if ($targetPage == Router
::$PAGE_DAILY) {
736 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
739 // ATOM and RSS feed.
740 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
741 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
742 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
745 $query = $_SERVER['QUERY_STRING'];
746 $cache = new CachedPage(
747 $conf->get('resource.page_cache'),
749 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
751 $cached = $cache->cachedVersion();
752 if (!empty($cached)) {
757 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
759 $feedGenerator = new FeedBuilder(
761 $factory->getFormatter(),
765 $loginManager->isLoggedIn()
767 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
768 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
769 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
770 $data = $feedGenerator->buildData();
772 // Process plugin hook.
773 $pluginManager->executeHooks('render_feed', $data, array(
774 'loggedin' => $loginManager->isLoggedIn(),
775 'target' => $targetPage,
778 // Render the template.
779 $PAGE->assignAll($data);
780 $PAGE->renderPage('feed.'. $feedType);
781 $cache->cache(ob_get_contents());
786 // Display opensearch plugin (XML)
787 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
788 header('Content-Type: application/xml; charset=utf-8');
789 $PAGE->assign('serverurl', index_url($_SERVER));
790 $PAGE->renderPage('opensearch');
794 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
795 if (isset($_GET['addtag'])) {
796 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
797 if (empty($_SERVER['HTTP_REFERER'])) {
798 // In case browser does not send HTTP_REFERER
799 header('Location: ?searchtags='.urlencode($_GET['addtag']));
802 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
804 // Prevent redirection loop
805 if (isset($params['addtag'])) {
806 unset($params['addtag']);
809 // Check if this tag is already in the search query and ignore it if it is.
810 // Each tag is always separated by a space
811 if (isset($params['searchtags'])) {
812 $current_tags = explode(' ', $params['searchtags']);
814 $current_tags = array();
817 foreach ($current_tags as $value) {
818 if ($value === $_GET['addtag']) {
823 // Append the tag if necessary
824 if (empty($params['searchtags'])) {
825 $params['searchtags'] = trim($_GET['addtag']);
827 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
830 // We also remove page (keeping the same page has no sense, since the
831 // results are different)
832 unset($params['page']);
834 header('Location: ?'.http_build_query($params));
838 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
839 if (isset($_GET['removetag'])) {
840 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
841 if (empty($_SERVER['HTTP_REFERER'])) {
842 header('Location: ?');
846 // In case browser does not send HTTP_REFERER
847 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
849 // Prevent redirection loop
850 if (isset($params['removetag'])) {
851 unset($params['removetag']);
854 if (isset($params['searchtags'])) {
855 $tags = explode(' ', $params['searchtags']);
856 // Remove value from array $tags.
857 $tags = array_diff($tags, array($_GET['removetag']));
858 $params['searchtags'] = implode(' ', $tags);
860 if (empty($params['searchtags'])) {
861 unset($params['searchtags']);
864 // We also remove page (keeping the same page has no sense, since
865 // the results are different)
866 unset($params['page']);
868 header('Location: ?'.http_build_query($params));
872 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
873 if (isset($_GET['linksperpage'])) {
874 if (is_numeric($_GET['linksperpage'])) {
875 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
878 if (! empty($_SERVER['HTTP_REFERER'])) {
879 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
883 header('Location: '. $location);
887 // -------- User wants to see only private bookmarks (toggle)
888 if (isset($_GET['visibility'])) {
889 if ($_GET['visibility'] === 'private') {
890 // Visibility not set or not already private, set private, otherwise reset it
891 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
892 // See only private bookmarks
893 $_SESSION['visibility'] = 'private';
895 unset($_SESSION['visibility']);
897 } elseif ($_GET['visibility'] === 'public') {
898 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
899 // See only public bookmarks
900 $_SESSION['visibility'] = 'public';
902 unset($_SESSION['visibility']);
906 if (! empty($_SERVER['HTTP_REFERER'])) {
907 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
911 header('Location: '. $location);
915 // -------- User wants to see only untagged bookmarks (toggle)
916 if (isset($_GET['untaggedonly'])) {
917 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
919 if (! empty($_SERVER['HTTP_REFERER'])) {
920 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
924 header('Location: '. $location);
928 // -------- Handle other actions allowed for non-logged in users:
929 if (!$loginManager->isLoggedIn()) {
930 // User tries to post new link but is not logged in:
931 // Show login screen, then redirect to ?post=...
932 if (isset($_GET['post'])) {
933 header( // Redirect to login page, then back to post link.
934 'Location: ?do=login&post='.urlencode($_GET['post']).
935 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
936 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
937 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
938 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
943 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
944 if (isset($_GET['edit_link'])) {
945 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
949 exit; // Never remove this one! All operations below are reserved for logged in user.
952 // -------- All other functions are reserved for the registered user:
954 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
955 if ($targetPage == Router
::$PAGE_TOOLS) {
957 'pageabsaddr' => index_url($_SERVER),
958 'sslenabled' => is_https($_SERVER),
960 $pluginManager->executeHooks('render_tools', $data);
962 foreach ($data as $key => $value) {
963 $PAGE->assign($key, $value);
966 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
967 $PAGE->renderPage('tools');
971 // -------- User wants to change his/her password.
972 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
973 if ($conf->get('security.open_shaarli')) {
974 die(t('You are not supposed to change a password on an Open Shaarli.'));
977 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
978 if (!$sessionManager->checkToken($_POST['token'])) {
979 die(t('Wrong token.')); // Go away!
982 // Make sure old password is correct.
984 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
986 if ($oldhash != $conf->get('credentials.hash')) {
987 echo '<script>alert("'
988 . t('The old password is not correct.')
989 .'");document.location=\'?do=changepasswd\';</script>';
993 // Salt renders rainbow-tables attacks useless.
994 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
998 $_POST['setpassword']
999 . $conf->get('credentials.login')
1000 . $conf->get('credentials.salt')
1004 $conf->write($loginManager->isLoggedIn());
1005 } catch (Exception
$e) {
1007 'ERROR while writing config file after changing password.' . PHP_EOL
.
1011 // TODO: do not handle exceptions/errors in JS.
1012 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1015 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1018 // show the change password form.
1019 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1020 $PAGE->renderPage('changepassword');
1025 // -------- User wants to change configuration
1026 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1027 if (!empty($_POST['title'])) {
1028 if (!$sessionManager->checkToken($_POST['token'])) {
1029 die(t('Wrong token.')); // Go away!
1032 if (!empty($_POST['continent']) && !empty($_POST['city'])
1033 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1035 $tz = $_POST['continent'] . '/' . $_POST['city'];
1037 $conf->set('general.timezone', $tz);
1038 $conf->set('general.title', escape($_POST['title']));
1039 $conf->set('general.header_link', escape($_POST['titleLink']));
1040 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
1041 $conf->set('resource.theme', escape($_POST['theme']));
1042 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1043 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1044 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1045 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1046 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1047 $conf->set('api.enabled', !empty($_POST['enableApi']));
1048 $conf->set('api.secret', escape($_POST['apiSecret']));
1049 $conf->set('formatter', escape($_POST['formatter']));
1051 if (! empty($_POST['language'])) {
1052 $conf->set('translation.language', escape($_POST['language']));
1055 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1056 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1057 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1059 $_SESSION['warnings'][] = t(
1060 'You have enabled or changed thumbnails mode. '
1061 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1064 $conf->set('thumbnails.mode', $thumbnailsMode);
1067 $conf->write($loginManager->isLoggedIn());
1068 $history->updateSettings();
1069 invalidateCaches($conf->get('resource.page_cache'));
1070 } catch (Exception
$e) {
1072 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1076 // TODO: do not handle exceptions/errors in JS.
1077 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1080 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1083 // Show the configuration form.
1084 $PAGE->assign('title', $conf->get('general.title'));
1085 $PAGE->assign('theme', $conf->get('resource.theme'));
1086 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1087 $PAGE->assign('formatter_available', ['default', 'markdown']);
1088 list($continents, $cities) = generateTimeZoneData(
1089 timezone_identifiers_list(),
1090 $conf->get('general.timezone')
1092 $PAGE->assign('continents', $continents);
1093 $PAGE->assign('cities', $cities);
1094 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1095 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1096 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1097 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1098 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1099 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1100 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1101 $PAGE->assign('api_secret', $conf->get('api.secret'));
1102 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1103 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1104 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1105 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1106 $PAGE->renderPage('configure');
1111 // -------- User wants to rename a tag or delete it
1112 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1113 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1114 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1115 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1116 $PAGE->renderPage('changetag');
1120 if (!$sessionManager->checkToken($_POST['token'])) {
1121 die(t('Wrong token.'));
1124 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1125 $fromTag = escape($_POST['fromtag']);
1127 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1128 foreach ($bookmarks as $bookmark) {
1130 $bookmark->renameTag($fromTag, $toTag);
1132 $bookmark->deleteTag($fromTag);
1134 $bookmarkService->set($bookmark, false);
1135 $history->updateLink($bookmark);
1138 $bookmarkService->save();
1139 $delete = empty($_POST['totag']);
1140 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1142 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1143 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1144 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1148 // -------- User wants to add a link without using the bookmarklet: Show form.
1149 if ($targetPage == Router
::$PAGE_ADDLINK) {
1150 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1151 $PAGE->renderPage('addlink');
1155 // -------- User clicked the "Save" button when editing a link: Save link to database.
1156 if (isset($_POST['save_edit'])) {
1158 if (! $sessionManager->checkToken($_POST['token'])) {
1159 die(t('Wrong token.'));
1162 // lf_id should only be present if the link exists.
1163 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1164 if ($id && $bookmarkService->exists($id)) {
1166 $bookmark = $bookmarkService->get($id);
1169 $bookmark = new Bookmark();
1172 $bookmark->setTitle($_POST['lf_title']);
1173 $bookmark->setDescription($_POST['lf_description']);
1174 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1175 $bookmark->setPrivate(isset($_POST['lf_private']));
1176 $bookmark->setTagsString($_POST['lf_tags']);
1178 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1179 && ! $bookmark->isNote()
1181 $thumbnailer = new Thumbnailer($conf);
1182 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1184 $bookmarkService->addOrSet($bookmark, false);
1186 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1187 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1188 $formatter = $factory->getFormatter('raw');
1189 $data = $formatter->format($bookmark);
1190 $pluginManager->executeHooks('save_link', $data);
1192 $bookmark->fromArray($data);
1193 $bookmarkService->set($bookmark);
1195 // If we are called from the bookmarklet, we must close the popup:
1196 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1197 echo '<script>self.close();</script>';
1201 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1202 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1203 // Scroll to the link which has been edited.
1204 $location .= '#' . $bookmark->getShortUrl();
1205 // After saving the link, redirect to the page the user was on.
1206 header('Location: '. $location);
1210 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1211 if ($targetPage == Router
::$PAGE_DELETELINK) {
1212 if (! $sessionManager->checkToken($_GET['token'])) {
1213 die(t('Wrong token.'));
1216 $ids = trim($_GET['lf_linkdate']);
1217 if (strpos($ids, ' ') !== false) {
1218 // multiple, space-separated ids provided
1219 $ids = array_values(array_filter(
1220 preg_split('/\s+/', escape($ids)),
1222 return $item !== '';
1226 // only a single id provided
1227 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1230 // assert at least one id is given
1232 die('no id provided');
1234 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1235 $formatter = $factory->getFormatter('raw');
1236 foreach ($ids as $id) {
1237 $id = (int) escape($id);
1238 $bookmark = $bookmarkService->get($id);
1239 $data = $formatter->format($bookmark);
1240 $pluginManager->executeHooks('delete_link', $data);
1241 $bookmarkService->remove($bookmark, false);
1243 $bookmarkService->save();
1245 // If we are called from the bookmarklet, we must close the popup:
1246 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1247 echo '<script>self.close();</script>';
1252 if (isset($_SERVER['HTTP_REFERER'])) {
1253 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1254 $location = generateLocation(
1255 $_SERVER['HTTP_REFERER'],
1256 $_SERVER['HTTP_HOST'],
1257 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1261 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1265 // -------- User clicked either "Set public" or "Set private" bulk operation
1266 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1267 if (! $sessionManager->checkToken($_GET['token'])) {
1268 die(t('Wrong token.'));
1271 $ids = trim($_GET['ids']);
1272 if (strpos($ids, ' ') !== false) {
1273 // multiple, space-separated ids provided
1274 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1276 // only a single id provided
1280 // assert at least one id is given
1282 die('no id provided');
1284 // assert that the visibility is valid
1285 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1286 die('invalid visibility');
1288 $private = $_GET['newVisibility'] === 'private';
1290 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1291 $formatter = $factory->getFormatter('raw');
1292 foreach ($ids as $id) {
1293 $id = (int) escape($id);
1294 $bookmark = $bookmarkService->get($id);
1295 $bookmark->setPrivate($private);
1297 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1298 $data = $formatter->format($bookmark);
1299 $pluginManager->executeHooks('save_link', $data);
1300 $bookmark->fromArray($data);
1302 $bookmarkService->set($bookmark);
1304 $bookmarkService->save();
1307 if (isset($_SERVER['HTTP_REFERER'])) {
1308 $location = generateLocation(
1309 $_SERVER['HTTP_REFERER'],
1310 $_SERVER['HTTP_HOST']
1313 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1317 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1318 if (isset($_GET['edit_link'])) {
1319 $id = (int) escape($_GET['edit_link']);
1321 $link = $bookmarkService->get($id); // Read database
1322 } catch (BookmarkNotFoundException
$e) {
1323 // Link not found in database.
1324 header('Location: ?');
1328 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1329 $formatter = $factory->getFormatter('raw');
1330 $formattedLink = $formatter->format($link);
1331 $tags = $bookmarkService->bookmarksCountPerTag();
1332 if ($conf->get('formatter') === 'markdown') {
1333 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1336 'link' => $formattedLink,
1337 'link_is_new' => false,
1338 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1341 $pluginManager->executeHooks('render_editlink', $data);
1343 foreach ($data as $key => $value) {
1344 $PAGE->assign($key, $value);
1347 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1348 $PAGE->renderPage('editlink');
1352 // -------- User want to post a new link: Display link edit form.
1353 if (isset($_GET['post'])) {
1354 $url = cleanup_url($_GET['post']);
1356 $link_is_new = false;
1357 // Check if URL is not already in database (in this case, we will edit the existing link)
1358 $bookmark = $bookmarkService->findByUrl($url);
1360 $link_is_new = true;
1361 // Get title if it was provided in URL (by the bookmarklet).
1362 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1363 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1364 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1365 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1366 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1368 // If this is an HTTP(S) link, we try go get the page to extract
1369 // the title (otherwise we will to straight to the edit form.)
1370 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1371 $retrieveDescription = $conf->get('general.retrieve_description');
1372 // Short timeout to keep the application responsive
1373 // The callback will fill $charset and $title with data from the downloaded page.
1376 $conf->get('general.download_timeout', 30),
1377 $conf->get('general.download_max_size', 4194304),
1378 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1380 if (! empty($title) && strtolower($charset) != 'utf-8') {
1381 $title = mb_convert_encoding($title, 'utf-8', $charset);
1386 $title = $conf->get('general.default_note_title', t('Note: '));
1388 $url = escape($url);
1389 $title = escape($title);
1394 'description' => $description,
1396 'private' => $private,
1399 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1400 $formatter = $factory->getFormatter('raw');
1401 $link = $formatter->format($bookmark);
1404 $tags = $bookmarkService->bookmarksCountPerTag();
1405 if ($conf->get('formatter') === 'markdown') {
1406 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1410 'link_is_new' => $link_is_new,
1411 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1412 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1414 'default_private_links' => $conf->get('privacy.default_private_links', false),
1416 $pluginManager->executeHooks('render_editlink', $data);
1418 foreach ($data as $key => $value) {
1419 $PAGE->assign($key, $value);
1422 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1423 $PAGE->renderPage('editlink');
1427 if ($targetPage == Router
::$PAGE_PINLINK) {
1428 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1429 // FIXME! Use a proper error system.
1430 $msg = t('Invalid link ID provided');
1431 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1434 if (! $sessionManager->checkToken($_GET['token'])) {
1435 die('Wrong token.');
1438 $link = $bookmarkService->get($_GET['id']);
1439 $link->setSticky(! $link->isSticky());
1440 $bookmarkService->set($link);
1441 header('Location: '.index_url($_SERVER));
1445 if ($targetPage == Router
::$PAGE_EXPORT) {
1446 // Export bookmarks as a Netscape Bookmarks file
1448 if (empty($_GET['selection'])) {
1449 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1450 $PAGE->renderPage('export');
1454 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1455 $selection = $_GET['selection'];
1456 if (isset($_GET['prepend_note_url'])) {
1457 $prependNoteUrl = $_GET['prepend_note_url'];
1459 $prependNoteUrl = false;
1463 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1464 $formatter = $factory->getFormatter('raw');
1467 NetscapeBookmarkUtils
::filterAndFormat(
1475 } catch (Exception
$exc) {
1476 header('Content-Type: text/plain; charset=utf-8');
1477 echo $exc->getMessage();
1480 $now = new DateTime();
1481 header('Content-Type: text/html; charset=utf-8');
1483 'Content-disposition: attachment; filename=bookmarks_'
1484 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1486 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1487 $PAGE->assign('eol', PHP_EOL
);
1488 $PAGE->assign('selection', $selection);
1489 $PAGE->renderPage('export.bookmarks');
1493 if ($targetPage == Router
::$PAGE_IMPORT) {
1494 // Upload a Netscape bookmark dump to import its contents
1496 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1497 // Show import dialog
1500 get_max_upload_size(
1501 ini_get('post_max_size'),
1502 ini_get('upload_max_filesize'),
1508 get_max_upload_size(
1509 ini_get('post_max_size'),
1510 ini_get('upload_max_filesize'),
1514 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1515 $PAGE->renderPage('import');
1519 // Import bookmarks from an uploaded file
1520 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1521 // The file is too big or some form field may be missing.
1524 'The file you are trying to upload is probably bigger than what this webserver can accept'
1525 .' (%s). Please upload in smaller chunks.'
1527 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1529 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1532 if (! $sessionManager->checkToken($_POST['token'])) {
1533 die('Wrong token.');
1535 $status = NetscapeBookmarkUtils
::import(
1542 echo '<script>alert("'.$status.'");document.location=\'?do='
1543 .Router
::$PAGE_IMPORT .'\';</script>';
1547 // Plugin administration page
1548 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1549 $pluginMeta = $pluginManager->getPluginsMeta();
1551 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1552 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1553 return $v['order'] !== false;
1556 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1560 return $a['order'] - $b['order'];
1563 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1564 return $v['order'] === false;
1567 $PAGE->assign('enabledPlugins', $enabledPlugins);
1568 $PAGE->assign('disabledPlugins', $disabledPlugins);
1569 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1570 $PAGE->renderPage('pluginsadmin');
1574 // Plugin administration form action
1575 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1577 if (isset($_POST['parameters_form'])) {
1578 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1579 unset($_POST['parameters_form']);
1580 foreach ($_POST as $param => $value) {
1581 $conf->set('plugins.'. $param, escape($value));
1584 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1586 $conf->write($loginManager->isLoggedIn());
1587 $history->updateSettings();
1588 } catch (Exception
$e) {
1590 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1594 // TODO: do not handle exceptions/errors in JS.
1595 echo '<script>alert("'
1597 .'");document.location=\'?do='
1598 . Router
::$PAGE_PLUGINSADMIN
1602 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1606 // Get a fresh token
1607 if ($targetPage == Router
::$GET_TOKEN) {
1608 header('Content-Type:text/plain');
1609 echo $sessionManager->generateToken();
1613 // -------- Thumbnails Update
1614 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1616 foreach ($bookmarkService->search() as $bookmark) {
1617 // A note or not HTTP(S)
1618 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1621 $ids[] = $bookmark->getId();
1623 $PAGE->assign('ids', $ids);
1624 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1625 $PAGE->renderPage('thumbnails');
1629 // -------- Single Thumbnail Update
1630 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1631 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1632 http_response_code(400);
1635 $id = (int) $_POST['id'];
1636 if (! $bookmarkService->exists($id)) {
1637 http_response_code(404);
1640 $thumbnailer = new Thumbnailer($conf);
1641 $bookmark = $bookmarkService->get($id);
1642 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1643 $bookmarkService->set($bookmark);
1645 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1646 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1650 // -------- Otherwise, simply display search form and bookmarks:
1651 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1656 * Template for the list of bookmarks (<div id="linklist">)
1657 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1659 * @param pageBuilder $PAGE pageBuilder instance.
1660 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1661 * @param ConfigManager $conf Configuration Manager instance.
1662 * @param PluginManager $pluginManager Plugin Manager instance.
1663 * @param LoginManager $loginManager LoginManager instance
1665 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1667 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1668 $formatter = $factory->getFormatter();
1670 // Used in templates
1671 if (isset($_GET['searchtags'])) {
1672 if (! empty($_GET['searchtags'])) {
1673 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1675 $searchtags = false;
1680 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1683 if (! empty($_SERVER['QUERY_STRING'])
1684 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1686 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1687 } catch (BookmarkNotFoundException
$e) {
1688 $PAGE->render404($e->getMessage());
1692 // Filter bookmarks according search parameters.
1693 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1695 'searchtags' => $searchtags,
1696 'searchterm' => $searchterm,
1698 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1701 // ---- Handle paging.
1703 foreach ($linksToDisplay as $key => $value) {
1707 // Select articles according to paging.
1708 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1709 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1710 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1711 $page = $page < 1 ? 1 : $page;
1712 $page = $page > $pagecount ? $pagecount : $page;
1714 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1715 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1717 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1718 if ($thumbnailsEnabled) {
1719 $thumbnailer = new Thumbnailer($conf);
1722 $linkDisp = array();
1723 while ($i<$end && $i<count($keys)) {
1724 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1726 // Logged in, thumbnails enabled, not a note,
1727 // and (never retrieved yet or no valid cache file)
1728 if ($loginManager->isLoggedIn()
1729 && $thumbnailsEnabled
1730 && !$linksToDisplay[$keys[$i]]->isNote()
1731 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1732 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1734 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1735 $linkDb->set($linksToDisplay[$keys[$i]], false);
1737 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1740 // Check for both signs of a note: starting with ? and 7 chars long.
1741 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1742 // $link['url'] = index_url($_SERVER) . $link['url'];
1745 $linkDisp[$keys[$i]] = $link;
1749 // If we retrieved new thumbnails, we update the database.
1750 if (!empty($updateDB)) {
1754 // Compute paging navigation
1755 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1756 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1757 $previous_page_url = '';
1758 if ($i != count($keys)) {
1759 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1763 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1766 // Fill all template fields.
1768 'previous_page_url' => $previous_page_url,
1769 'next_page_url' => $next_page_url,
1770 'page_current' => $page,
1771 'page_max' => $pagecount,
1772 'result_count' => count($linksToDisplay),
1773 'search_term' => $searchterm,
1774 'search_tags' => $searchtags,
1775 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1776 'links' => $linkDisp,
1779 // If there is only a single link, we change on-the-fly the title of the page.
1780 if (count($linksToDisplay) == 1) {
1781 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1782 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1783 $data['pagetitle'] = t('Search: ');
1784 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1785 $bracketWrap = function ($tag) {
1786 return '['. $tag .']';
1788 $data['pagetitle'] .= ! empty($searchtags)
1789 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1791 $data['pagetitle'] .= '- '. $conf->get('general.title');
1794 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1796 foreach ($data as $key => $value) {
1797 $PAGE->assign($key, $value);
1805 * This function should NEVER be called if the file data/config.php exists.
1807 * @param ConfigManager $conf Configuration Manager instance.
1808 * @param SessionManager $sessionManager SessionManager instance
1809 * @param LoginManager $loginManager LoginManager instance
1811 function install($conf, $sessionManager, $loginManager)
1813 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1814 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1815 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1819 // This part makes sure sessions works correctly.
1820 // (Because on some hosts, session.save_path may not be set correctly,
1821 // or we may not have write access to it.)
1822 if (isset($_GET['test_session'])
1823 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1824 // Step 2: Check if data in session is correct.
1826 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1827 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1828 'and that you have write access to it.<br>'.
1829 'It currently points to %s.<br>'.
1830 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1831 'or any custom hostname without a dot causes cookie storage to fail. '.
1832 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1834 $msg = sprintf($msg, session_save_path());
1836 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1839 if (!isset($_SESSION['session_tested'])) {
1840 // Step 1 : Try to store data in session and reload page.
1841 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1842 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1844 if (isset($_GET['test_session'])) {
1845 // Step 3: Sessions are OK. Remove test parameter from URL.
1846 header('Location: '.index_url($_SERVER));
1850 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1852 if (!empty($_POST['continent']) && !empty($_POST['city'])
1853 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1855 $tz = $_POST['continent'].'/'.$_POST['city'];
1857 $conf->set('general.timezone', $tz);
1858 $login = $_POST['setlogin'];
1859 $conf->set('credentials.login', $login);
1860 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1861 $conf->set('credentials.salt', $salt);
1862 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1863 if (!empty($_POST['title'])) {
1864 $conf->set('general.title', escape($_POST['title']));
1866 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1868 $conf->set('translation.language', escape($_POST['language']));
1869 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1870 $conf->set('api.enabled', !empty($_POST['enableApi']));
1873 generate_api_secret(
1874 $conf->get('credentials.login'),
1875 $conf->get('credentials.salt')
1879 // Everything is ok, let's create config file.
1880 $conf->write($loginManager->isLoggedIn());
1881 } catch (Exception
$e) {
1883 'ERROR while writing config file after installation.' . PHP_EOL
.
1887 // TODO: do not handle exceptions/errors in JS.
1888 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1892 $history = new History($conf->get('resource.history'));
1893 $bookmarkService = new BookmarkFileService($conf, $history, true);
1894 if ($bookmarkService->count() === 0) {
1895 $bookmarkService->initialize();
1898 echo '<script>alert('
1899 .'"Shaarli is now configured. '
1900 .'Please enter your login/password and start shaaring your bookmarks!"'
1901 .');document.location=\'?do=login\';</script>';
1905 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1906 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1907 $PAGE->assign('continents', $continents);
1908 $PAGE->assign('cities', $cities);
1909 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1910 $PAGE->renderPage('install');
1914 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1915 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1919 $history = new History($conf->get('resource.history'));
1920 } catch (Exception
$e) {
1921 die($e->getMessage());
1924 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1926 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1927 showDailyRSS($linkDb, $conf, $loginManager);
1931 $container = new \Slim\
Container();
1932 $container['conf'] = $conf;
1933 $container['plugins'] = $pluginManager;
1934 $container['history'] = $history;
1935 $app = new \Slim\
App($container);
1938 $app->group('/api/v1', function () {
1939 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1940 $this->get('/bookmarks', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1941 $this->get('/bookmarks/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1942 $this->post('/bookmarks', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1943 $this->put('/bookmarks/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1944 $this->delete('/bookmarks/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1946 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1947 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1948 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1949 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1951 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1952 })->add('\Shaarli\Api\ApiMiddleware');
1954 $response = $app->run(true);
1956 // Hack to make Slim and Shaarli router work together:
1957 // If a Slim route isn't found and NOT API call, we call renderPage().
1958 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1959 // We use UTF-8 for proper international characters handling.
1960 header('Content-Type: text/html; charset=utf-8');
1961 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1963 $response = $response
1964 ->withHeader('Access-Control-Allow-Origin', '*')
1966 'Access-Control-Allow-Headers',
1967 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1969 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1970 $app->respond($response);