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 header('Location: ./picture-wall');
617 // -------- Tag cloud
618 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
619 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
620 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
621 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
623 // We sort tags alphabetically, then choose a font size according to count.
624 // First, find max value.
626 foreach ($tags as $value) {
627 $maxcount = max($maxcount, $value);
630 alphabetical_sort($tags, false, true);
632 $logMaxCount = $maxcount > 1 ? log($maxcount, 30) : 1;
634 foreach ($tags as $key => $value) {
635 if (in_array($key, $filteringTags)) {
638 // Tag font size scaling:
639 // default 15 and 30 logarithm bases affect scaling,
640 // 2.2 and 0.8 are arbitrary font sizes in em.
641 $size = log($value, 15) / $logMaxCount * 2.2 +
0.8;
642 $tagList[$key] = array(
644 'size' => number_format($size, 2, '.', ''),
648 $searchTags = implode(' ', escape($filteringTags));
650 'search_tags' => $searchTags,
653 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
655 foreach ($data as $key => $value) {
656 $PAGE->assign($key, $value);
659 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
660 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
661 $PAGE->renderPage('tag.cloud');
666 if ($targetPage == Router
::$PAGE_TAGLIST) {
667 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
668 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
669 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
670 foreach ($filteringTags as $tag) {
671 if (array_key_exists($tag, $tags)) {
676 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
677 alphabetical_sort($tags, false, true);
680 $searchTags = implode(' ', escape($filteringTags));
682 'search_tags' => $searchTags,
685 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
687 foreach ($data as $key => $value) {
688 $PAGE->assign($key, $value);
691 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
692 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
693 $PAGE->renderPage('tag.list');
698 if ($targetPage == Router
::$PAGE_DAILY) {
699 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
702 // ATOM and RSS feed.
703 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
704 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
705 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
708 $query = $_SERVER['QUERY_STRING'];
709 $cache = new CachedPage(
710 $conf->get('resource.page_cache'),
712 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
714 $cached = $cache->cachedVersion();
715 if (!empty($cached)) {
720 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
722 $feedGenerator = new FeedBuilder(
724 $factory->getFormatter(),
728 $loginManager->isLoggedIn()
730 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
731 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
732 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
733 $data = $feedGenerator->buildData();
735 // Process plugin hook.
736 $pluginManager->executeHooks('render_feed', $data, array(
737 'loggedin' => $loginManager->isLoggedIn(),
738 'target' => $targetPage,
741 // Render the template.
742 $PAGE->assignAll($data);
743 $PAGE->renderPage('feed.'. $feedType);
744 $cache->cache(ob_get_contents());
749 // Display opensearch plugin (XML)
750 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
751 header('Content-Type: application/xml; charset=utf-8');
752 $PAGE->assign('serverurl', index_url($_SERVER));
753 $PAGE->renderPage('opensearch');
757 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
758 if (isset($_GET['addtag'])) {
759 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
760 if (empty($_SERVER['HTTP_REFERER'])) {
761 // In case browser does not send HTTP_REFERER
762 header('Location: ?searchtags='.urlencode($_GET['addtag']));
765 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
767 // Prevent redirection loop
768 if (isset($params['addtag'])) {
769 unset($params['addtag']);
772 // Check if this tag is already in the search query and ignore it if it is.
773 // Each tag is always separated by a space
774 if (isset($params['searchtags'])) {
775 $current_tags = explode(' ', $params['searchtags']);
777 $current_tags = array();
780 foreach ($current_tags as $value) {
781 if ($value === $_GET['addtag']) {
786 // Append the tag if necessary
787 if (empty($params['searchtags'])) {
788 $params['searchtags'] = trim($_GET['addtag']);
790 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
793 // We also remove page (keeping the same page has no sense, since the
794 // results are different)
795 unset($params['page']);
797 header('Location: ?'.http_build_query($params));
801 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
802 if (isset($_GET['removetag'])) {
803 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
804 if (empty($_SERVER['HTTP_REFERER'])) {
805 header('Location: ?');
809 // In case browser does not send HTTP_REFERER
810 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
812 // Prevent redirection loop
813 if (isset($params['removetag'])) {
814 unset($params['removetag']);
817 if (isset($params['searchtags'])) {
818 $tags = explode(' ', $params['searchtags']);
819 // Remove value from array $tags.
820 $tags = array_diff($tags, array($_GET['removetag']));
821 $params['searchtags'] = implode(' ', $tags);
823 if (empty($params['searchtags'])) {
824 unset($params['searchtags']);
827 // We also remove page (keeping the same page has no sense, since
828 // the results are different)
829 unset($params['page']);
831 header('Location: ?'.http_build_query($params));
835 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
836 if (isset($_GET['linksperpage'])) {
837 if (is_numeric($_GET['linksperpage'])) {
838 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
841 if (! empty($_SERVER['HTTP_REFERER'])) {
842 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
846 header('Location: '. $location);
850 // -------- User wants to see only private bookmarks (toggle)
851 if (isset($_GET['visibility'])) {
852 if ($_GET['visibility'] === 'private') {
853 // Visibility not set or not already private, set private, otherwise reset it
854 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
855 // See only private bookmarks
856 $_SESSION['visibility'] = 'private';
858 unset($_SESSION['visibility']);
860 } elseif ($_GET['visibility'] === 'public') {
861 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
862 // See only public bookmarks
863 $_SESSION['visibility'] = 'public';
865 unset($_SESSION['visibility']);
869 if (! empty($_SERVER['HTTP_REFERER'])) {
870 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
874 header('Location: '. $location);
878 // -------- User wants to see only untagged bookmarks (toggle)
879 if (isset($_GET['untaggedonly'])) {
880 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
882 if (! empty($_SERVER['HTTP_REFERER'])) {
883 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
887 header('Location: '. $location);
891 // -------- Handle other actions allowed for non-logged in users:
892 if (!$loginManager->isLoggedIn()) {
893 // User tries to post new link but is not logged in:
894 // Show login screen, then redirect to ?post=...
895 if (isset($_GET['post'])) {
896 header( // Redirect to login page, then back to post link.
897 'Location: /login?post='.urlencode($_GET['post']).
898 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
899 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
900 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
901 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
906 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
907 if (isset($_GET['edit_link'])) {
908 header('Location: /login?edit_link='. escape($_GET['edit_link']));
912 exit; // Never remove this one! All operations below are reserved for logged in user.
915 // -------- All other functions are reserved for the registered user:
917 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
918 if ($targetPage == Router
::$PAGE_TOOLS) {
920 'pageabsaddr' => index_url($_SERVER),
921 'sslenabled' => is_https($_SERVER),
923 $pluginManager->executeHooks('render_tools', $data);
925 foreach ($data as $key => $value) {
926 $PAGE->assign($key, $value);
929 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
930 $PAGE->renderPage('tools');
934 // -------- User wants to change his/her password.
935 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
936 if ($conf->get('security.open_shaarli')) {
937 die(t('You are not supposed to change a password on an Open Shaarli.'));
940 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
941 if (!$sessionManager->checkToken($_POST['token'])) {
942 die(t('Wrong token.')); // Go away!
945 // Make sure old password is correct.
947 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
949 if ($oldhash != $conf->get('credentials.hash')) {
950 echo '<script>alert("'
951 . t('The old password is not correct.')
952 .'");document.location=\'./?do=changepasswd\';</script>';
956 // Salt renders rainbow-tables attacks useless.
957 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
961 $_POST['setpassword']
962 . $conf->get('credentials.login')
963 . $conf->get('credentials.salt')
967 $conf->write($loginManager->isLoggedIn());
968 } catch (Exception
$e) {
970 'ERROR while writing config file after changing password.' . PHP_EOL
.
974 // TODO: do not handle exceptions/errors in JS.
975 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
978 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
981 // show the change password form.
982 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
983 $PAGE->renderPage('changepassword');
988 // -------- User wants to change configuration
989 if ($targetPage == Router
::$PAGE_CONFIGURE) {
990 if (!empty($_POST['title'])) {
991 if (!$sessionManager->checkToken($_POST['token'])) {
992 die(t('Wrong token.')); // Go away!
995 if (!empty($_POST['continent']) && !empty($_POST['city'])
996 && isTimeZoneValid($_POST['continent'], $_POST['city'])
998 $tz = $_POST['continent'] . '/' . $_POST['city'];
1000 $conf->set('general.timezone', $tz);
1001 $conf->set('general.title', escape($_POST['title']));
1002 $conf->set('general.header_link', escape($_POST['titleLink']));
1003 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
1004 $conf->set('resource.theme', escape($_POST['theme']));
1005 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1006 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1007 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1008 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1009 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1010 $conf->set('api.enabled', !empty($_POST['enableApi']));
1011 $conf->set('api.secret', escape($_POST['apiSecret']));
1012 $conf->set('formatter', escape($_POST['formatter']));
1014 if (! empty($_POST['language'])) {
1015 $conf->set('translation.language', escape($_POST['language']));
1018 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1019 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1020 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1022 $_SESSION['warnings'][] = t(
1023 'You have enabled or changed thumbnails mode. '
1024 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
1027 $conf->set('thumbnails.mode', $thumbnailsMode);
1030 $conf->write($loginManager->isLoggedIn());
1031 $history->updateSettings();
1032 invalidateCaches($conf->get('resource.page_cache'));
1033 } catch (Exception
$e) {
1035 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1039 // TODO: do not handle exceptions/errors in JS.
1040 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
1043 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
1046 // Show the configuration form.
1047 $PAGE->assign('title', $conf->get('general.title'));
1048 $PAGE->assign('theme', $conf->get('resource.theme'));
1049 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1050 $PAGE->assign('formatter_available', ['default', 'markdown']);
1051 list($continents, $cities) = generateTimeZoneData(
1052 timezone_identifiers_list(),
1053 $conf->get('general.timezone')
1055 $PAGE->assign('continents', $continents);
1056 $PAGE->assign('cities', $cities);
1057 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1058 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1059 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1060 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1061 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1062 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1063 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1064 $PAGE->assign('api_secret', $conf->get('api.secret'));
1065 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1066 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1067 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1068 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1069 $PAGE->renderPage('configure');
1074 // -------- User wants to rename a tag or delete it
1075 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1076 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1077 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1078 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1079 $PAGE->renderPage('changetag');
1083 if (!$sessionManager->checkToken($_POST['token'])) {
1084 die(t('Wrong token.'));
1087 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1088 $fromTag = escape($_POST['fromtag']);
1090 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1091 foreach ($bookmarks as $bookmark) {
1093 $bookmark->renameTag($fromTag, $toTag);
1095 $bookmark->deleteTag($fromTag);
1097 $bookmarkService->set($bookmark, false);
1098 $history->updateLink($bookmark);
1101 $bookmarkService->save();
1102 $delete = empty($_POST['totag']);
1103 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1105 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1106 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1107 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1111 // -------- User wants to add a link without using the bookmarklet: Show form.
1112 if ($targetPage == Router
::$PAGE_ADDLINK) {
1113 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1114 $PAGE->renderPage('addlink');
1118 // -------- User clicked the "Save" button when editing a link: Save link to database.
1119 if (isset($_POST['save_edit'])) {
1121 if (! $sessionManager->checkToken($_POST['token'])) {
1122 die(t('Wrong token.'));
1125 // lf_id should only be present if the link exists.
1126 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1127 if ($id && $bookmarkService->exists($id)) {
1129 $bookmark = $bookmarkService->get($id);
1132 $bookmark = new Bookmark();
1135 $bookmark->setTitle($_POST['lf_title']);
1136 $bookmark->setDescription($_POST['lf_description']);
1137 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1138 $bookmark->setPrivate(isset($_POST['lf_private']));
1139 $bookmark->setTagsString($_POST['lf_tags']);
1141 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1142 && ! $bookmark->isNote()
1144 $thumbnailer = new Thumbnailer($conf);
1145 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1147 $bookmarkService->addOrSet($bookmark, false);
1149 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1150 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1151 $formatter = $factory->getFormatter('raw');
1152 $data = $formatter->format($bookmark);
1153 $pluginManager->executeHooks('save_link', $data);
1155 $bookmark->fromArray($data);
1156 $bookmarkService->set($bookmark);
1158 // If we are called from the bookmarklet, we must close the popup:
1159 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1160 echo '<script>self.close();</script>';
1164 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1165 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1166 // Scroll to the link which has been edited.
1167 $location .= '#' . $bookmark->getShortUrl();
1168 // After saving the link, redirect to the page the user was on.
1169 header('Location: '. $location);
1173 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1174 if ($targetPage == Router
::$PAGE_DELETELINK) {
1175 if (! $sessionManager->checkToken($_GET['token'])) {
1176 die(t('Wrong token.'));
1179 $ids = trim($_GET['lf_linkdate']);
1180 if (strpos($ids, ' ') !== false) {
1181 // multiple, space-separated ids provided
1182 $ids = array_values(array_filter(
1183 preg_split('/\s+/', escape($ids)),
1185 return $item !== '';
1189 // only a single id provided
1190 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1193 // assert at least one id is given
1195 die('no id provided');
1197 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1198 $formatter = $factory->getFormatter('raw');
1199 foreach ($ids as $id) {
1200 $id = (int) escape($id);
1201 $bookmark = $bookmarkService->get($id);
1202 $data = $formatter->format($bookmark);
1203 $pluginManager->executeHooks('delete_link', $data);
1204 $bookmarkService->remove($bookmark, false);
1206 $bookmarkService->save();
1208 // If we are called from the bookmarklet, we must close the popup:
1209 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1210 echo '<script>self.close();</script>';
1215 if (isset($_SERVER['HTTP_REFERER'])) {
1216 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1217 $location = generateLocation(
1218 $_SERVER['HTTP_REFERER'],
1219 $_SERVER['HTTP_HOST'],
1220 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1224 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1228 // -------- User clicked either "Set public" or "Set private" bulk operation
1229 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1230 if (! $sessionManager->checkToken($_GET['token'])) {
1231 die(t('Wrong token.'));
1234 $ids = trim($_GET['ids']);
1235 if (strpos($ids, ' ') !== false) {
1236 // multiple, space-separated ids provided
1237 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1239 // only a single id provided
1243 // assert at least one id is given
1245 die('no id provided');
1247 // assert that the visibility is valid
1248 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1249 die('invalid visibility');
1251 $private = $_GET['newVisibility'] === 'private';
1253 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1254 $formatter = $factory->getFormatter('raw');
1255 foreach ($ids as $id) {
1256 $id = (int) escape($id);
1257 $bookmark = $bookmarkService->get($id);
1258 $bookmark->setPrivate($private);
1260 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1261 $data = $formatter->format($bookmark);
1262 $pluginManager->executeHooks('save_link', $data);
1263 $bookmark->fromArray($data);
1265 $bookmarkService->set($bookmark);
1267 $bookmarkService->save();
1270 if (isset($_SERVER['HTTP_REFERER'])) {
1271 $location = generateLocation(
1272 $_SERVER['HTTP_REFERER'],
1273 $_SERVER['HTTP_HOST']
1276 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1280 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1281 if (isset($_GET['edit_link'])) {
1282 $id = (int) escape($_GET['edit_link']);
1284 $link = $bookmarkService->get($id); // Read database
1285 } catch (BookmarkNotFoundException
$e) {
1286 // Link not found in database.
1287 header('Location: ?');
1291 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1292 $formatter = $factory->getFormatter('raw');
1293 $formattedLink = $formatter->format($link);
1294 $tags = $bookmarkService->bookmarksCountPerTag();
1295 if ($conf->get('formatter') === 'markdown') {
1296 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1299 'link' => $formattedLink,
1300 'link_is_new' => false,
1301 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1304 $pluginManager->executeHooks('render_editlink', $data);
1306 foreach ($data as $key => $value) {
1307 $PAGE->assign($key, $value);
1310 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1311 $PAGE->renderPage('editlink');
1315 // -------- User want to post a new link: Display link edit form.
1316 if (isset($_GET['post'])) {
1317 $url = cleanup_url($_GET['post']);
1319 $link_is_new = false;
1320 // Check if URL is not already in database (in this case, we will edit the existing link)
1321 $bookmark = $bookmarkService->findByUrl($url);
1323 $link_is_new = true;
1324 // Get title if it was provided in URL (by the bookmarklet).
1325 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1326 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1327 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1328 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1329 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1331 // If this is an HTTP(S) link, we try go get the page to extract
1332 // the title (otherwise we will to straight to the edit form.)
1333 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1334 $retrieveDescription = $conf->get('general.retrieve_description');
1335 // Short timeout to keep the application responsive
1336 // The callback will fill $charset and $title with data from the downloaded page.
1339 $conf->get('general.download_timeout', 30),
1340 $conf->get('general.download_max_size', 4194304),
1341 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1343 if (! empty($title) && strtolower($charset) != 'utf-8') {
1344 $title = mb_convert_encoding($title, 'utf-8', $charset);
1349 $title = $conf->get('general.default_note_title', t('Note: '));
1351 $url = escape($url);
1352 $title = escape($title);
1357 'description' => $description,
1359 'private' => $private,
1362 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1363 $formatter = $factory->getFormatter('raw');
1364 $link = $formatter->format($bookmark);
1367 $tags = $bookmarkService->bookmarksCountPerTag();
1368 if ($conf->get('formatter') === 'markdown') {
1369 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1373 'link_is_new' => $link_is_new,
1374 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1375 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1377 'default_private_links' => $conf->get('privacy.default_private_links', false),
1379 $pluginManager->executeHooks('render_editlink', $data);
1381 foreach ($data as $key => $value) {
1382 $PAGE->assign($key, $value);
1385 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1386 $PAGE->renderPage('editlink');
1390 if ($targetPage == Router
::$PAGE_PINLINK) {
1391 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1392 // FIXME! Use a proper error system.
1393 $msg = t('Invalid link ID provided');
1394 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1397 if (! $sessionManager->checkToken($_GET['token'])) {
1398 die('Wrong token.');
1401 $link = $bookmarkService->get($_GET['id']);
1402 $link->setSticky(! $link->isSticky());
1403 $bookmarkService->set($link);
1404 header('Location: '.index_url($_SERVER));
1408 if ($targetPage == Router
::$PAGE_EXPORT) {
1409 // Export bookmarks as a Netscape Bookmarks file
1411 if (empty($_GET['selection'])) {
1412 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1413 $PAGE->renderPage('export');
1417 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1418 $selection = $_GET['selection'];
1419 if (isset($_GET['prepend_note_url'])) {
1420 $prependNoteUrl = $_GET['prepend_note_url'];
1422 $prependNoteUrl = false;
1426 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1427 $formatter = $factory->getFormatter('raw');
1430 NetscapeBookmarkUtils
::filterAndFormat(
1438 } catch (Exception
$exc) {
1439 header('Content-Type: text/plain; charset=utf-8');
1440 echo $exc->getMessage();
1443 $now = new DateTime();
1444 header('Content-Type: text/html; charset=utf-8');
1446 'Content-disposition: attachment; filename=bookmarks_'
1447 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1449 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1450 $PAGE->assign('eol', PHP_EOL
);
1451 $PAGE->assign('selection', $selection);
1452 $PAGE->renderPage('export.bookmarks');
1456 if ($targetPage == Router
::$PAGE_IMPORT) {
1457 // Upload a Netscape bookmark dump to import its contents
1459 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1460 // Show import dialog
1463 get_max_upload_size(
1464 ini_get('post_max_size'),
1465 ini_get('upload_max_filesize'),
1471 get_max_upload_size(
1472 ini_get('post_max_size'),
1473 ini_get('upload_max_filesize'),
1477 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1478 $PAGE->renderPage('import');
1482 // Import bookmarks from an uploaded file
1483 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1484 // The file is too big or some form field may be missing.
1487 'The file you are trying to upload is probably bigger than what this webserver can accept'
1488 .' (%s). Please upload in smaller chunks.'
1490 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1492 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1495 if (! $sessionManager->checkToken($_POST['token'])) {
1496 die('Wrong token.');
1498 $status = NetscapeBookmarkUtils
::import(
1505 echo '<script>alert("'.$status.'");document.location=\'./?do='
1506 .Router
::$PAGE_IMPORT .'\';</script>';
1510 // Plugin administration page
1511 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1512 $pluginMeta = $pluginManager->getPluginsMeta();
1514 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1515 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1516 return $v['order'] !== false;
1519 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1523 return $a['order'] - $b['order'];
1526 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1527 return $v['order'] === false;
1530 $PAGE->assign('enabledPlugins', $enabledPlugins);
1531 $PAGE->assign('disabledPlugins', $disabledPlugins);
1532 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1533 $PAGE->renderPage('pluginsadmin');
1537 // Plugin administration form action
1538 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1540 if (isset($_POST['parameters_form'])) {
1541 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1542 unset($_POST['parameters_form']);
1543 foreach ($_POST as $param => $value) {
1544 $conf->set('plugins.'. $param, escape($value));
1547 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1549 $conf->write($loginManager->isLoggedIn());
1550 $history->updateSettings();
1551 } catch (Exception
$e) {
1553 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1557 // TODO: do not handle exceptions/errors in JS.
1558 echo '<script>alert("'
1560 .'");document.location=\'./?do='
1561 . Router
::$PAGE_PLUGINSADMIN
1565 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1569 // Get a fresh token
1570 if ($targetPage == Router
::$GET_TOKEN) {
1571 header('Content-Type:text/plain');
1572 echo $sessionManager->generateToken();
1576 // -------- Thumbnails Update
1577 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1579 foreach ($bookmarkService->search() as $bookmark) {
1580 // A note or not HTTP(S)
1581 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1584 $ids[] = $bookmark->getId();
1586 $PAGE->assign('ids', $ids);
1587 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1588 $PAGE->renderPage('thumbnails');
1592 // -------- Single Thumbnail Update
1593 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1594 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1595 http_response_code(400);
1598 $id = (int) $_POST['id'];
1599 if (! $bookmarkService->exists($id)) {
1600 http_response_code(404);
1603 $thumbnailer = new Thumbnailer($conf);
1604 $bookmark = $bookmarkService->get($id);
1605 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1606 $bookmarkService->set($bookmark);
1608 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1609 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1613 // -------- Otherwise, simply display search form and bookmarks:
1614 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1619 * Template for the list of bookmarks (<div id="linklist">)
1620 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1622 * @param pageBuilder $PAGE pageBuilder instance.
1623 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1624 * @param ConfigManager $conf Configuration Manager instance.
1625 * @param PluginManager $pluginManager Plugin Manager instance.
1626 * @param LoginManager $loginManager LoginManager instance
1628 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1630 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1631 $formatter = $factory->getFormatter();
1633 // Used in templates
1634 if (isset($_GET['searchtags'])) {
1635 if (! empty($_GET['searchtags'])) {
1636 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1638 $searchtags = false;
1643 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1646 if (! empty($_SERVER['QUERY_STRING'])
1647 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1649 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1650 } catch (BookmarkNotFoundException
$e) {
1651 $PAGE->render404($e->getMessage());
1655 // Filter bookmarks according search parameters.
1656 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1658 'searchtags' => $searchtags,
1659 'searchterm' => $searchterm,
1661 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1664 // ---- Handle paging.
1666 foreach ($linksToDisplay as $key => $value) {
1670 // Select articles according to paging.
1671 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1672 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1673 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1674 $page = $page < 1 ? 1 : $page;
1675 $page = $page > $pagecount ? $pagecount : $page;
1677 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1678 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1680 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1681 if ($thumbnailsEnabled) {
1682 $thumbnailer = new Thumbnailer($conf);
1685 $linkDisp = array();
1686 while ($i<$end && $i<count($keys)) {
1687 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1689 // Logged in, thumbnails enabled, not a note,
1690 // and (never retrieved yet or no valid cache file)
1691 if ($loginManager->isLoggedIn()
1692 && $thumbnailsEnabled
1693 && !$linksToDisplay[$keys[$i]]->isNote()
1694 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1695 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1697 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1698 $linkDb->set($linksToDisplay[$keys[$i]], false);
1700 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1703 // Check for both signs of a note: starting with ? and 7 chars long.
1704 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1705 // $link['url'] = index_url($_SERVER) . $link['url'];
1708 $linkDisp[$keys[$i]] = $link;
1712 // If we retrieved new thumbnails, we update the database.
1713 if (!empty($updateDB)) {
1717 // Compute paging navigation
1718 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1719 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1720 $previous_page_url = '';
1721 if ($i != count($keys)) {
1722 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1726 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1729 // Fill all template fields.
1731 'previous_page_url' => $previous_page_url,
1732 'next_page_url' => $next_page_url,
1733 'page_current' => $page,
1734 'page_max' => $pagecount,
1735 'result_count' => count($linksToDisplay),
1736 'search_term' => $searchterm,
1737 'search_tags' => $searchtags,
1738 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1739 'links' => $linkDisp,
1742 // If there is only a single link, we change on-the-fly the title of the page.
1743 if (count($linksToDisplay) == 1) {
1744 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1745 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1746 $data['pagetitle'] = t('Search: ');
1747 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1748 $bracketWrap = function ($tag) {
1749 return '['. $tag .']';
1751 $data['pagetitle'] .= ! empty($searchtags)
1752 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1754 $data['pagetitle'] .= '- '. $conf->get('general.title');
1757 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1759 foreach ($data as $key => $value) {
1760 $PAGE->assign($key, $value);
1768 * This function should NEVER be called if the file data/config.php exists.
1770 * @param ConfigManager $conf Configuration Manager instance.
1771 * @param SessionManager $sessionManager SessionManager instance
1772 * @param LoginManager $loginManager LoginManager instance
1774 function install($conf, $sessionManager, $loginManager)
1776 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1777 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1778 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1782 // This part makes sure sessions works correctly.
1783 // (Because on some hosts, session.save_path may not be set correctly,
1784 // or we may not have write access to it.)
1785 if (isset($_GET['test_session'])
1786 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1787 // Step 2: Check if data in session is correct.
1789 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1790 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1791 'and that you have write access to it.<br>'.
1792 'It currently points to %s.<br>'.
1793 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1794 'or any custom hostname without a dot causes cookie storage to fail. '.
1795 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1797 $msg = sprintf($msg, session_save_path());
1799 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1802 if (!isset($_SESSION['session_tested'])) {
1803 // Step 1 : Try to store data in session and reload page.
1804 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1805 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1807 if (isset($_GET['test_session'])) {
1808 // Step 3: Sessions are OK. Remove test parameter from URL.
1809 header('Location: '.index_url($_SERVER));
1813 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1815 if (!empty($_POST['continent']) && !empty($_POST['city'])
1816 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1818 $tz = $_POST['continent'].'/'.$_POST['city'];
1820 $conf->set('general.timezone', $tz);
1821 $login = $_POST['setlogin'];
1822 $conf->set('credentials.login', $login);
1823 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1824 $conf->set('credentials.salt', $salt);
1825 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1826 if (!empty($_POST['title'])) {
1827 $conf->set('general.title', escape($_POST['title']));
1829 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1831 $conf->set('translation.language', escape($_POST['language']));
1832 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1833 $conf->set('api.enabled', !empty($_POST['enableApi']));
1836 generate_api_secret(
1837 $conf->get('credentials.login'),
1838 $conf->get('credentials.salt')
1842 // Everything is ok, let's create config file.
1843 $conf->write($loginManager->isLoggedIn());
1844 } catch (Exception
$e) {
1846 'ERROR while writing config file after installation.' . PHP_EOL
.
1850 // TODO: do not handle exceptions/errors in JS.
1851 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1855 $history = new History($conf->get('resource.history'));
1856 $bookmarkService = new BookmarkFileService($conf, $history, true);
1857 if ($bookmarkService->count() === 0) {
1858 $bookmarkService->initialize();
1861 echo '<script>alert('
1862 .'"Shaarli is now configured. '
1863 .'Please enter your login/password and start shaaring your bookmarks!"'
1864 .');document.location=\'./login\';</script>';
1868 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1869 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1870 $PAGE->assign('continents', $continents);
1871 $PAGE->assign('cities', $cities);
1872 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1873 $PAGE->renderPage('install');
1877 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1878 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1882 $history = new History($conf->get('resource.history'));
1883 } catch (Exception
$e) {
1884 die($e->getMessage());
1887 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1889 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1890 showDailyRSS($linkDb, $conf, $loginManager);
1894 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager);
1895 $container = $containerBuilder->build();
1896 $app = new App($container);
1899 $app->group('/api/v1', function () {
1900 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1901 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1902 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1903 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1904 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1905 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1907 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1908 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1909 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1910 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1912 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1913 })->add('\Shaarli\Api\ApiMiddleware');
1915 $app->group('', function () {
1916 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1917 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1918 })->add('\Shaarli\Front\ShaarliMiddleware');
1920 $response = $app->run(true);
1922 // Hack to make Slim and Shaarli router work together:
1923 // If a Slim route isn't found and NOT API call, we call renderPage().
1924 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1925 // We use UTF-8 for proper international characters handling.
1926 header('Content-Type: text/html; charset=utf-8');
1927 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1929 $response = $response
1930 ->withHeader('Access-Control-Allow-Origin', '*')
1932 'Access-Control-Allow-Headers',
1933 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1935 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1936 $app->respond($response);