3 * Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
5 * Friendly fork by the Shaarli community:
6 * - https://github.com/shaarli/Shaarli
8 * Original project by sebsauvage.net:
9 * - http://sebsauvage.net/wiki/doku.php?id=php:shaarli
10 * - https://github.com/sebsauvage/Shaarli
12 * Licence: http://www.opensource.org/licenses/zlib-license.php
15 // Set 'UTC' as the default timezone if it is not defined in php.ini
16 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
17 if (date_default_timezone_get() == '') {
18 date_default_timezone_set('UTC');
25 // http://server.com/x/shaarli --> /shaarli/
26 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+
strrpos($_SERVER['REQUEST_URI'], '/', 0)));
28 // High execution time in case of problematic imports/exports.
29 ini_set('max_input_time', '60');
31 // Try to set max upload file size and read
32 ini_set('memory_limit', '128M');
33 ini_set('post_max_size', '16M');
34 ini_set('upload_max_filesize', '16M');
36 // See all error except warnings
37 error_reporting(E_ALL^E_WARNING
);
39 // 3rd-party libraries
40 if (! file_exists(__DIR__
. '/vendor/autoload.php')) {
41 header('Content-Type: text/plain; charset=utf-8');
42 echo "Error: missing Composer configuration\n\n"
43 ."If you installed Shaarli through Git or using the development branch,\n"
44 ."please refer to the installation documentation to install PHP"
45 ." dependencies using Composer:\n"
46 ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n"
47 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
50 require_once 'inc/rain.tpl.class.php';
51 require_once __DIR__
. '/vendor/autoload.php';
54 require_once 'application/bookmark/LinkUtils.php';
55 require_once 'application/config/ConfigPlugin.php';
56 require_once 'application/feed/Cache.php';
57 require_once 'application/http/HttpUtils.php';
58 require_once 'application/http/UrlUtils.php';
59 require_once 'application/updater/UpdaterUtils.php';
60 require_once 'application/FileUtils.php';
61 require_once 'application/TimeZone.php';
62 require_once 'application/Utils.php';
64 use Shaarli\ApplicationUtils
;
65 use Shaarli\Bookmark\Bookmark
;
66 use Shaarli\Bookmark\BookmarkFileService
;
67 use Shaarli\Bookmark\BookmarkFilter
;
68 use Shaarli\Bookmark\BookmarkServiceInterface
;
69 use Shaarli\Bookmark\Exception\BookmarkNotFoundException
;
70 use Shaarli\Config\ConfigManager
;
71 use Shaarli\Container\ContainerBuilder
;
72 use Shaarli\Feed\CachedPage
;
73 use Shaarli\Feed\FeedBuilder
;
74 use Shaarli\Formatter\BookmarkMarkdownFormatter
;
75 use Shaarli\Formatter\FormatterFactory
;
77 use Shaarli\Languages
;
78 use Shaarli\Netscape\NetscapeBookmarkUtils
;
79 use Shaarli\Plugin\PluginManager
;
80 use Shaarli\Render\PageBuilder
;
81 use Shaarli\Render\ThemeUtils
;
83 use Shaarli\Security\LoginManager
;
84 use Shaarli\Security\SessionManager
;
85 use Shaarli\Thumbnailer
;
86 use Shaarli\Updater\Updater
;
87 use Shaarli\Updater\UpdaterUtils
;
90 // Ensure the PHP version is supported
92 ApplicationUtils
::checkPHPVersion('7.1', PHP_VERSION
);
93 } catch (Exception
$exc) {
94 header('Content-Type: text/plain; charset=utf-8');
95 echo $exc->getMessage();
99 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
101 // Force cookie path (but do not change lifetime)
102 $cookie = session_get_cookie_params();
104 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
105 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
107 // Set default cookie expiration and path.
108 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
109 // Set session parameters on server side.
110 // Use cookies to store session.
111 ini_set('session.use_cookies', 1);
112 // Force cookies for session (phpsessionID forbidden in URL).
113 ini_set('session.use_only_cookies', 1);
114 // Prevent PHP form using sessionID in URL if cookies are disabled.
115 ini_set('session.use_trans_sid', false);
117 session_name('shaarli');
118 // Start session if needed (Some server auto-start sessions).
119 if (session_status() == PHP_SESSION_NONE
) {
123 // Regenerate session ID if invalid or not defined in cookie.
124 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
125 session_regenerate_id(true);
126 $_COOKIE['shaarli'] = session_id();
129 $conf = new ConfigManager();
131 // In dev mode, throw exception on any warning
132 if ($conf->get('dev.debug', false)) {
133 // See all errors (for debugging only)
136 set_error_handler(function($errno, $errstr, $errfile, $errline, array $errcontext) {
137 throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
141 $sessionManager = new SessionManager($_SESSION, $conf);
142 $loginManager = new LoginManager($conf, $sessionManager);
143 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
144 $clientIpId = client_ip_id($_SERVER);
146 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
147 if (! defined('LC_MESSAGES')) {
148 define('LC_MESSAGES', LC_COLLATE
);
151 // Sniff browser language and set date format accordingly.
152 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
153 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
156 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
158 $conf->setEmpty('general.timezone', date_default_timezone_get());
159 $conf->setEmpty('general.title', t('Shared bookmarks on '). escape(index_url($_SERVER)));
160 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
161 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
163 $pluginManager = new PluginManager($conf);
164 $pluginManager->load($conf->get('general.enabled_plugins'));
166 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
168 ob_start(); // Output buffering for the page cache.
170 // Prevent caching on client side or proxy: (yes, it's ugly)
171 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
172 header("Cache-Control: no-store, no-cache, must-revalidate");
173 header("Cache-Control: post-check=0, pre-check=0", false);
174 header("Pragma: no-cache");
176 if (! is_file($conf->getConfigFileExt())) {
177 // Ensure Shaarli has proper access to its resources
178 $errors = ApplicationUtils
::checkResourcePermissions($conf);
180 if ($errors != array()) {
181 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
183 foreach ($errors as $error) {
184 $message .= '<li>'.$error.'</li>';
188 header('Content-Type: text/html; charset=utf-8');
193 // Display the installation form if no existing config is found
194 install($conf, $sessionManager, $loginManager);
197 $loginManager->checkLoginState($_COOKIE, $clientIpId);
200 * Adapter function to ensure compatibility with third-party templates
202 * @see https://github.com/shaarli/Shaarli/pull/1086
204 * @return bool true when the user is logged in, false otherwise
206 function isLoggedIn()
208 global $loginManager;
209 return $loginManager->isLoggedIn();
213 // ------------------------------------------------------------------------------------------
214 // Process login form: Check if login/password is correct.
215 if (isset($_POST['login'])) {
216 if (! $loginManager->canLogin($_SERVER)) {
217 die(t('I said: NO. You are banned for the moment. Go away.'));
219 if (isset($_POST['password'])
220 && $sessionManager->checkToken($_POST['token'])
221 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
223 $loginManager->handleSuccessfulLogin($_SERVER);
226 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
227 // Note: Never forget the trailing slash on the cookie path!
228 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
231 if (!empty($_POST['longlastingsession'])) {
232 // Keep the session cookie even after the browser closes
233 $sessionManager->setStaySignedIn(true);
234 $expirationTime = $sessionManager->extendSession();
237 $loginManager::$STAY_SIGNED_IN_COOKIE,
238 $loginManager->getStaySignedInToken(),
243 // Standard session expiration (=when browser closes)
247 // Send cookie with the new expiration date to the browser
249 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
251 session_regenerate_id(true);
253 // Optional redirect after login:
254 if (isset($_GET['post'])) {
255 $uri = './?post='. urlencode($_GET['post']);
256 foreach (array('description', 'source', 'title', 'tags') as $param) {
257 if (!empty($_GET[$param])) {
258 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
261 header('Location: '. $uri);
265 if (isset($_GET['edit_link'])) {
266 header('Location: ./?edit_link='. escape($_GET['edit_link']));
270 if (isset($_POST['returnurl'])) {
271 // Prevent loops over login screen.
272 if (strpos($_POST['returnurl'], '/login') === false) {
273 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
277 header('Location: ./?');
280 $loginManager->handleFailedLogin($_SERVER);
281 $redir = '?username='. urlencode($_POST['login']);
282 if (isset($_GET['post'])) {
283 $redir .= '&post=' . urlencode($_GET['post']);
284 foreach (array('description', 'source', 'title', 'tags') as $param) {
285 if (!empty($_GET[$param])) {
286 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
290 // Redirect to login screen.
291 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'./login'.$redir.'\';</script>';
296 // ------------------------------------------------------------------------------------------
297 // Token management for XSRF protection
298 // Token should be used in any form which acts on data (create,update,delete,import...).
299 if (!isset($_SESSION['tokens'])) {
300 $_SESSION['tokens']=array(); // Token are attached to the session.
304 * Daily RSS feed: 1 RSS entry per day giving all the bookmarks on that day.
305 * Gives the last 7 days (which have bookmarks).
306 * This RSS feed cannot be filtered.
308 * @param BookmarkServiceInterface $bookmarkService
309 * @param ConfigManager $conf Configuration Manager instance
310 * @param LoginManager $loginManager LoginManager instance
312 function showDailyRSS($bookmarkService, $conf, $loginManager)
315 $query = $_SERVER['QUERY_STRING'];
316 $cache = new CachedPage(
317 $conf->get('config.PAGE_CACHE'),
319 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
321 $cached = $cache->cachedVersion();
322 if (!empty($cached)) {
327 /* Some Shaarlies may have very few bookmarks, so we need to look
328 back in time until we have enough days ($nb_of_days).
330 $nb_of_days = 7; // We take 7 days.
331 $today = date('Ymd');
334 foreach ($bookmarkService->search() as $bookmark) {
335 $day = $bookmark->getCreated()->format('Ymd'); // Extract day (without time)
336 if (strcmp($day, $today) < 0) {
337 if (empty($days[$day])) {
338 $days[$day] = array();
340 $days[$day][] = $bookmark;
343 if (count($days) > $nb_of_days) {
344 break; // Have we collected enough days?
348 // Build the RSS feed.
349 header('Content-Type: application/rss+xml; charset=utf-8');
350 $pageaddr = escape(index_url($_SERVER));
351 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
353 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
354 echo '<link>'. $pageaddr .'</link>';
355 echo '<description>Daily shared bookmarks</description>';
356 echo '<language>en-en</language>';
357 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
359 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
360 $formatter = $factory->getFormatter();
361 $formatter->addContextData('index_url', index_url($_SERVER));
363 /** @var Bookmark[] $bookmarks */
364 foreach ($days as $day => $bookmarks) {
365 $formattedBookmarks = [];
366 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
367 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
369 // We pre-format some fields for proper output.
370 foreach ($bookmarks as $key => $bookmark) {
371 $formattedBookmarks[$key] = $formatter->format($bookmark);
372 // This page is a bit specific, we need raw description to calculate the length
373 $formattedBookmarks[$key]['formatedDescription'] = $formattedBookmarks[$key]['description'];
374 $formattedBookmarks[$key]['description'] = $bookmark->getDescription();
376 if ($bookmark->isNote()) {
377 $link['url'] = index_url($_SERVER) . $bookmark->getUrl(); // make permalink URL absolute
381 // Then build the HTML for this day:
382 $tpl = new RainTPL();
383 $tpl->assign('title', $conf->get('general.title'));
384 $tpl->assign('daydate', $dayDate->getTimestamp());
385 $tpl->assign('absurl', $absurl);
386 $tpl->assign('links', $formattedBookmarks);
387 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
388 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
389 $tpl->assign('index_url', $pageaddr);
390 $html = $tpl->draw('dailyrss', true);
392 echo $html . PHP_EOL
;
394 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
396 $cache->cache(ob_get_contents());
402 * Show the 'Daily' page.
404 * @param PageBuilder $pageBuilder Template engine wrapper.
405 * @param BookmarkServiceInterface $bookmarkService instance.
406 * @param ConfigManager $conf Configuration Manager instance.
407 * @param PluginManager $pluginManager Plugin Manager instance.
408 * @param LoginManager $loginManager Login Manager instance
410 function showDaily($pageBuilder, $bookmarkService, $conf, $pluginManager, $loginManager)
412 if (isset($_GET['day'])) {
414 if ($day === date('Ymd', strtotime('now'))) {
415 $pageBuilder->assign('dayDesc', t('Today'));
416 } elseif ($day === date('Ymd', strtotime('-1 days'))) {
417 $pageBuilder->assign('dayDesc', t('Yesterday'));
420 $day = date('Ymd', strtotime('now')); // Today, in format YYYYMMDD.
421 $pageBuilder->assign('dayDesc', t('Today'));
424 $days = $bookmarkService->days();
425 $i = array_search($day, $days);
426 if ($i === false && count($days)) {
427 // no bookmarks for day, but at least one day with bookmarks
428 $i = count($days) - 1;
436 $previousday = $days[$i - 1];
438 if ($i < count($days) - 1) {
439 $nextday = $days[$i +
1];
443 $linksToDisplay = $bookmarkService->filterDay($day);
444 } catch (Exception
$exc) {
446 $linksToDisplay = [];
449 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
450 $formatter = $factory->getFormatter();
451 // We pre-format some fields for proper output.
452 foreach ($linksToDisplay as $key => $bookmark) {
453 $linksToDisplay[$key] = $formatter->format($bookmark);
454 // This page is a bit specific, we need raw description to calculate the length
455 $linksToDisplay[$key]['formatedDescription'] = $linksToDisplay[$key]['description'];
456 $linksToDisplay[$key]['description'] = $bookmark->getDescription();
459 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
461 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
462 'linksToDisplay' => $linksToDisplay,
463 'day' => $dayDate->getTimestamp(),
464 'dayDate' => $dayDate,
465 'previousday' => $previousday,
466 'nextday' => $nextday,
469 /* Hook is called before column construction so that plugins don't have
470 to deal with columns. */
471 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
473 /* We need to spread the articles on 3 columns.
474 I did not want to use a JavaScript lib like http://masonry.desandro.com/
475 so I manually spread entries with a simple method: I roughly evaluate the
476 height of a div according to title and description length.
478 $columns = array(array(), array(), array()); // Entries to display, for each column.
479 $fill = array(0, 0, 0); // Rough estimate of columns fill.
480 foreach ($data['linksToDisplay'] as $key => $bookmark) {
481 // Roughly estimate length of entry (by counting characters)
482 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
483 // Description: 836 characters gives roughly 342 pixel height.
484 // This is not perfect, but it's usually OK.
485 $length = strlen($bookmark['title']) +
(342 * strlen($bookmark['description'])) / 836;
486 if (! empty($bookmark['thumbnail'])) {
487 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
489 // Then put in column which is the less filled:
490 $smallest = min($fill); // find smallest value in array.
491 $index = array_search($smallest, $fill); // find index of this smallest value.
492 array_push($columns[$index], $bookmark); // Put entry in this column.
493 $fill[$index] +
= $length;
496 $data['cols'] = $columns;
498 foreach ($data as $key => $value) {
499 $pageBuilder->assign($key, $value);
502 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
503 $pageBuilder->renderPage('daily');
508 * Renders the linklist
510 * @param pageBuilder $PAGE pageBuilder instance.
511 * @param BookmarkServiceInterface $linkDb instance.
512 * @param ConfigManager $conf Configuration Manager instance.
513 * @param PluginManager $pluginManager Plugin Manager instance.
515 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
517 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
518 $PAGE->renderPage('linklist');
522 * Render HTML page (according to URL parameters and user rights)
524 * @param ConfigManager $conf Configuration Manager instance.
525 * @param PluginManager $pluginManager Plugin Manager instance,
526 * @param BookmarkServiceInterface $bookmarkService
527 * @param History $history instance
528 * @param SessionManager $sessionManager SessionManager instance
529 * @param LoginManager $loginManager LoginManager instance
531 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
533 $updater = new Updater(
534 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
537 $loginManager->isLoggedIn()
540 $newUpdates = $updater->update();
541 if (! empty($newUpdates)) {
542 UpdaterUtils
::write_updates_file(
543 $conf->get('resource.updates'),
544 $updater->getDoneUpdates()
547 } catch (Exception
$e) {
548 die($e->getMessage());
551 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
552 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
553 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
554 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
556 // Determine which page will be rendered.
557 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
558 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
560 if (// if the user isn't logged in
561 !$loginManager->isLoggedIn() &&
562 // and Shaarli doesn't have public content...
563 $conf->get('privacy.hide_public_links') &&
564 // and is configured to enforce the login
565 $conf->get('privacy.force_login') &&
566 // and the current page isn't already the login page
567 $targetPage !== Router
::$PAGE_LOGIN &&
568 // and the user is not requesting a feed (which would lead to a different content-type as expected)
569 $targetPage !== Router
::$PAGE_FEED_ATOM &&
570 $targetPage !== Router
::$PAGE_FEED_RSS
572 // force current page to be the login page
573 $targetPage = Router
::$PAGE_LOGIN;
576 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
577 // Then assign generated data to RainTPL.
578 $common_hooks = array(
584 foreach ($common_hooks as $name) {
585 $plugin_data = array();
586 $pluginManager->executeHooks(
590 'target' => $targetPage,
591 'loggedin' => $loginManager->isLoggedIn()
594 $PAGE->assign('plugins_' . $name, $plugin_data);
597 // -------- Display login form.
598 if ($targetPage == Router
::$PAGE_LOGIN) {
599 header('Location: ./login');
602 // -------- User wants to logout.
603 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
604 invalidateCaches($conf->get('resource.page_cache'));
605 $sessionManager->logout();
606 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
607 header('Location: ?');
611 // -------- Picture wall
612 if ($targetPage == Router
::$PAGE_PICWALL) {
613 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
614 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
615 $PAGE->assign('linksToDisplay', []);
616 $PAGE->renderPage('picwall');
620 // Optionally filter the results:
621 $links = $bookmarkService->search($_GET);
622 $linksToDisplay = [];
624 // Get only bookmarks which have a thumbnail.
625 // Note: we do not retrieve thumbnails here, the request is too heavy.
626 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
627 $formatter = $factory->getFormatter();
628 foreach ($links as $key => $link) {
629 if ($link->getThumbnail() !== false) {
630 $linksToDisplay[] = $formatter->format($link);
635 'linksToDisplay' => $linksToDisplay,
637 $pluginManager->executeHooks('render_picwall', $data, ['loggedin' => $loginManager->isLoggedIn()]);
639 foreach ($data as $key => $value) {
640 $PAGE->assign($key, $value);
643 $PAGE->renderPage('picwall');
647 // -------- Tag cloud
648 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
649 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
650 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
651 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
653 // We sort tags alphabetically, then choose a font size according to count.
654 // First, find max value.
656 foreach ($tags as $value) {
657 $maxcount = max($maxcount, $value);
660 alphabetical_sort($tags, false, true);
663 foreach ($tags as $key => $value) {
664 if (in_array($key, $filteringTags)) {
667 // Tag font size scaling:
668 // default 15 and 30 logarithm bases affect scaling,
669 // 22 and 6 are arbitrary font sizes for max and min sizes.
670 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
671 $tagList[$key] = array(
673 'size' => number_format($size, 2, '.', ''),
677 $searchTags = implode(' ', escape($filteringTags));
679 'search_tags' => $searchTags,
682 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
684 foreach ($data as $key => $value) {
685 $PAGE->assign($key, $value);
688 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
689 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
690 $PAGE->renderPage('tag.cloud');
695 if ($targetPage == Router
::$PAGE_TAGLIST) {
696 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
697 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
698 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
699 foreach ($filteringTags as $tag) {
700 if (array_key_exists($tag, $tags)) {
705 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
706 alphabetical_sort($tags, false, true);
709 $searchTags = implode(' ', escape($filteringTags));
711 'search_tags' => $searchTags,
714 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
716 foreach ($data as $key => $value) {
717 $PAGE->assign($key, $value);
720 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
721 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
722 $PAGE->renderPage('tag.list');
727 if ($targetPage == Router
::$PAGE_DAILY) {
728 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
731 // ATOM and RSS feed.
732 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
733 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
734 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
737 $query = $_SERVER['QUERY_STRING'];
738 $cache = new CachedPage(
739 $conf->get('resource.page_cache'),
741 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
743 $cached = $cache->cachedVersion();
744 if (!empty($cached)) {
749 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
751 $feedGenerator = new FeedBuilder(
753 $factory->getFormatter(),
757 $loginManager->isLoggedIn()
759 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
760 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
761 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
762 $data = $feedGenerator->buildData();
764 // Process plugin hook.
765 $pluginManager->executeHooks('render_feed', $data, array(
766 'loggedin' => $loginManager->isLoggedIn(),
767 'target' => $targetPage,
770 // Render the template.
771 $PAGE->assignAll($data);
772 $PAGE->renderPage('feed.'. $feedType);
773 $cache->cache(ob_get_contents());
778 // Display opensearch plugin (XML)
779 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
780 header('Content-Type: application/xml; charset=utf-8');
781 $PAGE->assign('serverurl', index_url($_SERVER));
782 $PAGE->renderPage('opensearch');
786 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
787 if (isset($_GET['addtag'])) {
788 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
789 if (empty($_SERVER['HTTP_REFERER'])) {
790 // In case browser does not send HTTP_REFERER
791 header('Location: ?searchtags='.urlencode($_GET['addtag']));
794 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
796 // Prevent redirection loop
797 if (isset($params['addtag'])) {
798 unset($params['addtag']);
801 // Check if this tag is already in the search query and ignore it if it is.
802 // Each tag is always separated by a space
803 if (isset($params['searchtags'])) {
804 $current_tags = explode(' ', $params['searchtags']);
806 $current_tags = array();
809 foreach ($current_tags as $value) {
810 if ($value === $_GET['addtag']) {
815 // Append the tag if necessary
816 if (empty($params['searchtags'])) {
817 $params['searchtags'] = trim($_GET['addtag']);
819 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
822 // We also remove page (keeping the same page has no sense, since the
823 // results are different)
824 unset($params['page']);
826 header('Location: ?'.http_build_query($params));
830 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
831 if (isset($_GET['removetag'])) {
832 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
833 if (empty($_SERVER['HTTP_REFERER'])) {
834 header('Location: ?');
838 // In case browser does not send HTTP_REFERER
839 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
841 // Prevent redirection loop
842 if (isset($params['removetag'])) {
843 unset($params['removetag']);
846 if (isset($params['searchtags'])) {
847 $tags = explode(' ', $params['searchtags']);
848 // Remove value from array $tags.
849 $tags = array_diff($tags, array($_GET['removetag']));
850 $params['searchtags'] = implode(' ', $tags);
852 if (empty($params['searchtags'])) {
853 unset($params['searchtags']);
856 // We also remove page (keeping the same page has no sense, since
857 // the results are different)
858 unset($params['page']);
860 header('Location: ?'.http_build_query($params));
864 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
865 if (isset($_GET['linksperpage'])) {
866 if (is_numeric($_GET['linksperpage'])) {
867 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
870 if (! empty($_SERVER['HTTP_REFERER'])) {
871 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
875 header('Location: '. $location);
879 // -------- User wants to see only private bookmarks (toggle)
880 if (isset($_GET['visibility'])) {
881 if ($_GET['visibility'] === 'private') {
882 // Visibility not set or not already private, set private, otherwise reset it
883 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
884 // See only private bookmarks
885 $_SESSION['visibility'] = 'private';
887 unset($_SESSION['visibility']);
889 } elseif ($_GET['visibility'] === 'public') {
890 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
891 // See only public bookmarks
892 $_SESSION['visibility'] = 'public';
894 unset($_SESSION['visibility']);
898 if (! empty($_SERVER['HTTP_REFERER'])) {
899 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
903 header('Location: '. $location);
907 // -------- User wants to see only untagged bookmarks (toggle)
908 if (isset($_GET['untaggedonly'])) {
909 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
911 if (! empty($_SERVER['HTTP_REFERER'])) {
912 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
916 header('Location: '. $location);
920 // -------- Handle other actions allowed for non-logged in users:
921 if (!$loginManager->isLoggedIn()) {
922 // User tries to post new link but is not logged in:
923 // Show login screen, then redirect to ?post=...
924 if (isset($_GET['post'])) {
925 header( // Redirect to login page, then back to post link.
926 'Location: /login?post='.urlencode($_GET['post']).
927 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
928 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
929 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
930 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
935 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
936 if (isset($_GET['edit_link'])) {
937 header('Location: /login?edit_link='. escape($_GET['edit_link']));
941 exit; // Never remove this one! All operations below are reserved for logged in user.
944 // -------- All other functions are reserved for the registered user:
946 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
947 if ($targetPage == Router
::$PAGE_TOOLS) {
949 'pageabsaddr' => index_url($_SERVER),
950 'sslenabled' => is_https($_SERVER),
952 $pluginManager->executeHooks('render_tools', $data);
954 foreach ($data as $key => $value) {
955 $PAGE->assign($key, $value);
958 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
959 $PAGE->renderPage('tools');
963 // -------- User wants to change his/her password.
964 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
965 if ($conf->get('security.open_shaarli')) {
966 die(t('You are not supposed to change a password on an Open Shaarli.'));
969 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
970 if (!$sessionManager->checkToken($_POST['token'])) {
971 die(t('Wrong token.')); // Go away!
974 // Make sure old password is correct.
976 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
978 if ($oldhash != $conf->get('credentials.hash')) {
979 echo '<script>alert("'
980 . t('The old password is not correct.')
981 .'");document.location=\'?do=changepasswd\';</script>';
985 // Salt renders rainbow-tables attacks useless.
986 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
990 $_POST['setpassword']
991 . $conf->get('credentials.login')
992 . $conf->get('credentials.salt')
996 $conf->write($loginManager->isLoggedIn());
997 } catch (Exception
$e) {
999 'ERROR while writing config file after changing password.' . PHP_EOL
.
1003 // TODO: do not handle exceptions/errors in JS.
1004 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
1007 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
1010 // show the change password form.
1011 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1012 $PAGE->renderPage('changepassword');
1017 // -------- User wants to change configuration
1018 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1019 if (!empty($_POST['title'])) {
1020 if (!$sessionManager->checkToken($_POST['token'])) {
1021 die(t('Wrong token.')); // Go away!
1024 if (!empty($_POST['continent']) && !empty($_POST['city'])
1025 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1027 $tz = $_POST['continent'] . '/' . $_POST['city'];
1029 $conf->set('general.timezone', $tz);
1030 $conf->set('general.title', escape($_POST['title']));
1031 $conf->set('general.header_link', escape($_POST['titleLink']));
1032 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
1033 $conf->set('resource.theme', escape($_POST['theme']));
1034 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1035 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1036 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1037 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1038 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1039 $conf->set('api.enabled', !empty($_POST['enableApi']));
1040 $conf->set('api.secret', escape($_POST['apiSecret']));
1041 $conf->set('formatter', escape($_POST['formatter']));
1043 if (! empty($_POST['language'])) {
1044 $conf->set('translation.language', escape($_POST['language']));
1047 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1048 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1049 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1051 $_SESSION['warnings'][] = t(
1052 'You have enabled or changed thumbnails mode. '
1053 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1056 $conf->set('thumbnails.mode', $thumbnailsMode);
1059 $conf->write($loginManager->isLoggedIn());
1060 $history->updateSettings();
1061 invalidateCaches($conf->get('resource.page_cache'));
1062 } catch (Exception
$e) {
1064 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1068 // TODO: do not handle exceptions/errors in JS.
1069 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1072 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1075 // Show the configuration form.
1076 $PAGE->assign('title', $conf->get('general.title'));
1077 $PAGE->assign('theme', $conf->get('resource.theme'));
1078 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1079 $PAGE->assign('formatter_available', ['default', 'markdown']);
1080 list($continents, $cities) = generateTimeZoneData(
1081 timezone_identifiers_list(),
1082 $conf->get('general.timezone')
1084 $PAGE->assign('continents', $continents);
1085 $PAGE->assign('cities', $cities);
1086 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1087 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1088 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1089 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1090 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1091 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1092 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1093 $PAGE->assign('api_secret', $conf->get('api.secret'));
1094 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1095 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1096 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1097 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1098 $PAGE->renderPage('configure');
1103 // -------- User wants to rename a tag or delete it
1104 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1105 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1106 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1107 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1108 $PAGE->renderPage('changetag');
1112 if (!$sessionManager->checkToken($_POST['token'])) {
1113 die(t('Wrong token.'));
1116 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1117 $fromTag = escape($_POST['fromtag']);
1119 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1120 foreach ($bookmarks as $bookmark) {
1122 $bookmark->renameTag($fromTag, $toTag);
1124 $bookmark->deleteTag($fromTag);
1126 $bookmarkService->set($bookmark, false);
1127 $history->updateLink($bookmark);
1130 $bookmarkService->save();
1131 $delete = empty($_POST['totag']);
1132 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1134 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1135 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1136 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1140 // -------- User wants to add a link without using the bookmarklet: Show form.
1141 if ($targetPage == Router
::$PAGE_ADDLINK) {
1142 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1143 $PAGE->renderPage('addlink');
1147 // -------- User clicked the "Save" button when editing a link: Save link to database.
1148 if (isset($_POST['save_edit'])) {
1150 if (! $sessionManager->checkToken($_POST['token'])) {
1151 die(t('Wrong token.'));
1154 // lf_id should only be present if the link exists.
1155 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1156 if ($id && $bookmarkService->exists($id)) {
1158 $bookmark = $bookmarkService->get($id);
1161 $bookmark = new Bookmark();
1164 $bookmark->setTitle($_POST['lf_title']);
1165 $bookmark->setDescription($_POST['lf_description']);
1166 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1167 $bookmark->setPrivate(isset($_POST['lf_private']));
1168 $bookmark->setTagsString($_POST['lf_tags']);
1170 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1171 && ! $bookmark->isNote()
1173 $thumbnailer = new Thumbnailer($conf);
1174 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1176 $bookmarkService->addOrSet($bookmark, false);
1178 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1179 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1180 $formatter = $factory->getFormatter('raw');
1181 $data = $formatter->format($bookmark);
1182 $pluginManager->executeHooks('save_link', $data);
1184 $bookmark->fromArray($data);
1185 $bookmarkService->set($bookmark);
1187 // If we are called from the bookmarklet, we must close the popup:
1188 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1189 echo '<script>self.close();</script>';
1193 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1194 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1195 // Scroll to the link which has been edited.
1196 $location .= '#' . $bookmark->getShortUrl();
1197 // After saving the link, redirect to the page the user was on.
1198 header('Location: '. $location);
1202 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1203 if ($targetPage == Router
::$PAGE_DELETELINK) {
1204 if (! $sessionManager->checkToken($_GET['token'])) {
1205 die(t('Wrong token.'));
1208 $ids = trim($_GET['lf_linkdate']);
1209 if (strpos($ids, ' ') !== false) {
1210 // multiple, space-separated ids provided
1211 $ids = array_values(array_filter(
1212 preg_split('/\s+/', escape($ids)),
1214 return $item !== '';
1218 // only a single id provided
1219 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1222 // assert at least one id is given
1224 die('no id provided');
1226 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1227 $formatter = $factory->getFormatter('raw');
1228 foreach ($ids as $id) {
1229 $id = (int) escape($id);
1230 $bookmark = $bookmarkService->get($id);
1231 $data = $formatter->format($bookmark);
1232 $pluginManager->executeHooks('delete_link', $data);
1233 $bookmarkService->remove($bookmark, false);
1235 $bookmarkService->save();
1237 // If we are called from the bookmarklet, we must close the popup:
1238 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1239 echo '<script>self.close();</script>';
1244 if (isset($_SERVER['HTTP_REFERER'])) {
1245 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1246 $location = generateLocation(
1247 $_SERVER['HTTP_REFERER'],
1248 $_SERVER['HTTP_HOST'],
1249 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1253 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1257 // -------- User clicked either "Set public" or "Set private" bulk operation
1258 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1259 if (! $sessionManager->checkToken($_GET['token'])) {
1260 die(t('Wrong token.'));
1263 $ids = trim($_GET['ids']);
1264 if (strpos($ids, ' ') !== false) {
1265 // multiple, space-separated ids provided
1266 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1268 // only a single id provided
1272 // assert at least one id is given
1274 die('no id provided');
1276 // assert that the visibility is valid
1277 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1278 die('invalid visibility');
1280 $private = $_GET['newVisibility'] === 'private';
1282 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1283 $formatter = $factory->getFormatter('raw');
1284 foreach ($ids as $id) {
1285 $id = (int) escape($id);
1286 $bookmark = $bookmarkService->get($id);
1287 $bookmark->setPrivate($private);
1289 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1290 $data = $formatter->format($bookmark);
1291 $pluginManager->executeHooks('save_link', $data);
1292 $bookmark->fromArray($data);
1294 $bookmarkService->set($bookmark);
1296 $bookmarkService->save();
1299 if (isset($_SERVER['HTTP_REFERER'])) {
1300 $location = generateLocation(
1301 $_SERVER['HTTP_REFERER'],
1302 $_SERVER['HTTP_HOST']
1305 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1309 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1310 if (isset($_GET['edit_link'])) {
1311 $id = (int) escape($_GET['edit_link']);
1313 $link = $bookmarkService->get($id); // Read database
1314 } catch (BookmarkNotFoundException
$e) {
1315 // Link not found in database.
1316 header('Location: ?');
1320 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1321 $formatter = $factory->getFormatter('raw');
1322 $formattedLink = $formatter->format($link);
1323 $tags = $bookmarkService->bookmarksCountPerTag();
1324 if ($conf->get('formatter') === 'markdown') {
1325 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1328 'link' => $formattedLink,
1329 'link_is_new' => false,
1330 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1333 $pluginManager->executeHooks('render_editlink', $data);
1335 foreach ($data as $key => $value) {
1336 $PAGE->assign($key, $value);
1339 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1340 $PAGE->renderPage('editlink');
1344 // -------- User want to post a new link: Display link edit form.
1345 if (isset($_GET['post'])) {
1346 $url = cleanup_url($_GET['post']);
1348 $link_is_new = false;
1349 // Check if URL is not already in database (in this case, we will edit the existing link)
1350 $bookmark = $bookmarkService->findByUrl($url);
1352 $link_is_new = true;
1353 // Get title if it was provided in URL (by the bookmarklet).
1354 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1355 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1356 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1357 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1358 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1360 // If this is an HTTP(S) link, we try go get the page to extract
1361 // the title (otherwise we will to straight to the edit form.)
1362 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1363 $retrieveDescription = $conf->get('general.retrieve_description');
1364 // Short timeout to keep the application responsive
1365 // The callback will fill $charset and $title with data from the downloaded page.
1368 $conf->get('general.download_timeout', 30),
1369 $conf->get('general.download_max_size', 4194304),
1370 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1372 if (! empty($title) && strtolower($charset) != 'utf-8') {
1373 $title = mb_convert_encoding($title, 'utf-8', $charset);
1378 $title = $conf->get('general.default_note_title', t('Note: '));
1380 $url = escape($url);
1381 $title = escape($title);
1386 'description' => $description,
1388 'private' => $private,
1391 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1392 $formatter = $factory->getFormatter('raw');
1393 $link = $formatter->format($bookmark);
1396 $tags = $bookmarkService->bookmarksCountPerTag();
1397 if ($conf->get('formatter') === 'markdown') {
1398 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1402 'link_is_new' => $link_is_new,
1403 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1404 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1406 'default_private_links' => $conf->get('privacy.default_private_links', false),
1408 $pluginManager->executeHooks('render_editlink', $data);
1410 foreach ($data as $key => $value) {
1411 $PAGE->assign($key, $value);
1414 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1415 $PAGE->renderPage('editlink');
1419 if ($targetPage == Router
::$PAGE_PINLINK) {
1420 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1421 // FIXME! Use a proper error system.
1422 $msg = t('Invalid link ID provided');
1423 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1426 if (! $sessionManager->checkToken($_GET['token'])) {
1427 die('Wrong token.');
1430 $link = $bookmarkService->get($_GET['id']);
1431 $link->setSticky(! $link->isSticky());
1432 $bookmarkService->set($link);
1433 header('Location: '.index_url($_SERVER));
1437 if ($targetPage == Router
::$PAGE_EXPORT) {
1438 // Export bookmarks as a Netscape Bookmarks file
1440 if (empty($_GET['selection'])) {
1441 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1442 $PAGE->renderPage('export');
1446 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1447 $selection = $_GET['selection'];
1448 if (isset($_GET['prepend_note_url'])) {
1449 $prependNoteUrl = $_GET['prepend_note_url'];
1451 $prependNoteUrl = false;
1455 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1456 $formatter = $factory->getFormatter('raw');
1459 NetscapeBookmarkUtils
::filterAndFormat(
1467 } catch (Exception
$exc) {
1468 header('Content-Type: text/plain; charset=utf-8');
1469 echo $exc->getMessage();
1472 $now = new DateTime();
1473 header('Content-Type: text/html; charset=utf-8');
1475 'Content-disposition: attachment; filename=bookmarks_'
1476 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1478 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1479 $PAGE->assign('eol', PHP_EOL
);
1480 $PAGE->assign('selection', $selection);
1481 $PAGE->renderPage('export.bookmarks');
1485 if ($targetPage == Router
::$PAGE_IMPORT) {
1486 // Upload a Netscape bookmark dump to import its contents
1488 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1489 // Show import dialog
1492 get_max_upload_size(
1493 ini_get('post_max_size'),
1494 ini_get('upload_max_filesize'),
1500 get_max_upload_size(
1501 ini_get('post_max_size'),
1502 ini_get('upload_max_filesize'),
1506 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1507 $PAGE->renderPage('import');
1511 // Import bookmarks from an uploaded file
1512 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1513 // The file is too big or some form field may be missing.
1516 'The file you are trying to upload is probably bigger than what this webserver can accept'
1517 .' (%s). Please upload in smaller chunks.'
1519 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1521 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1524 if (! $sessionManager->checkToken($_POST['token'])) {
1525 die('Wrong token.');
1527 $status = NetscapeBookmarkUtils
::import(
1534 echo '<script>alert("'.$status.'");document.location=\'?do='
1535 .Router
::$PAGE_IMPORT .'\';</script>';
1539 // Plugin administration page
1540 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1541 $pluginMeta = $pluginManager->getPluginsMeta();
1543 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1544 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1545 return $v['order'] !== false;
1548 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1552 return $a['order'] - $b['order'];
1555 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1556 return $v['order'] === false;
1559 $PAGE->assign('enabledPlugins', $enabledPlugins);
1560 $PAGE->assign('disabledPlugins', $disabledPlugins);
1561 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1562 $PAGE->renderPage('pluginsadmin');
1566 // Plugin administration form action
1567 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1569 if (isset($_POST['parameters_form'])) {
1570 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1571 unset($_POST['parameters_form']);
1572 foreach ($_POST as $param => $value) {
1573 $conf->set('plugins.'. $param, escape($value));
1576 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1578 $conf->write($loginManager->isLoggedIn());
1579 $history->updateSettings();
1580 } catch (Exception
$e) {
1582 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1586 // TODO: do not handle exceptions/errors in JS.
1587 echo '<script>alert("'
1589 .'");document.location=\'?do='
1590 . Router
::$PAGE_PLUGINSADMIN
1594 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1598 // Get a fresh token
1599 if ($targetPage == Router
::$GET_TOKEN) {
1600 header('Content-Type:text/plain');
1601 echo $sessionManager->generateToken();
1605 // -------- Thumbnails Update
1606 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1608 foreach ($bookmarkService->search() as $bookmark) {
1609 // A note or not HTTP(S)
1610 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1613 $ids[] = $bookmark->getId();
1615 $PAGE->assign('ids', $ids);
1616 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1617 $PAGE->renderPage('thumbnails');
1621 // -------- Single Thumbnail Update
1622 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1623 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1624 http_response_code(400);
1627 $id = (int) $_POST['id'];
1628 if (! $bookmarkService->exists($id)) {
1629 http_response_code(404);
1632 $thumbnailer = new Thumbnailer($conf);
1633 $bookmark = $bookmarkService->get($id);
1634 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1635 $bookmarkService->set($bookmark);
1637 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1638 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1642 // -------- Otherwise, simply display search form and bookmarks:
1643 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1648 * Template for the list of bookmarks (<div id="linklist">)
1649 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1651 * @param pageBuilder $PAGE pageBuilder instance.
1652 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1653 * @param ConfigManager $conf Configuration Manager instance.
1654 * @param PluginManager $pluginManager Plugin Manager instance.
1655 * @param LoginManager $loginManager LoginManager instance
1657 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1659 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1660 $formatter = $factory->getFormatter();
1662 // Used in templates
1663 if (isset($_GET['searchtags'])) {
1664 if (! empty($_GET['searchtags'])) {
1665 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1667 $searchtags = false;
1672 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1675 if (! empty($_SERVER['QUERY_STRING'])
1676 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1678 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1679 } catch (BookmarkNotFoundException
$e) {
1680 $PAGE->render404($e->getMessage());
1684 // Filter bookmarks according search parameters.
1685 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1687 'searchtags' => $searchtags,
1688 'searchterm' => $searchterm,
1690 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1693 // ---- Handle paging.
1695 foreach ($linksToDisplay as $key => $value) {
1699 // Select articles according to paging.
1700 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1701 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1702 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1703 $page = $page < 1 ? 1 : $page;
1704 $page = $page > $pagecount ? $pagecount : $page;
1706 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1707 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1709 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1710 if ($thumbnailsEnabled) {
1711 $thumbnailer = new Thumbnailer($conf);
1714 $linkDisp = array();
1715 while ($i<$end && $i<count($keys)) {
1716 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1718 // Logged in, thumbnails enabled, not a note,
1719 // and (never retrieved yet or no valid cache file)
1720 if ($loginManager->isLoggedIn()
1721 && $thumbnailsEnabled
1722 && !$linksToDisplay[$keys[$i]]->isNote()
1723 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1724 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1726 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1727 $linkDb->set($linksToDisplay[$keys[$i]], false);
1729 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1732 // Check for both signs of a note: starting with ? and 7 chars long.
1733 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1734 // $link['url'] = index_url($_SERVER) . $link['url'];
1737 $linkDisp[$keys[$i]] = $link;
1741 // If we retrieved new thumbnails, we update the database.
1742 if (!empty($updateDB)) {
1746 // Compute paging navigation
1747 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1748 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1749 $previous_page_url = '';
1750 if ($i != count($keys)) {
1751 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1755 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1758 // Fill all template fields.
1760 'previous_page_url' => $previous_page_url,
1761 'next_page_url' => $next_page_url,
1762 'page_current' => $page,
1763 'page_max' => $pagecount,
1764 'result_count' => count($linksToDisplay),
1765 'search_term' => $searchterm,
1766 'search_tags' => $searchtags,
1767 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1768 'links' => $linkDisp,
1771 // If there is only a single link, we change on-the-fly the title of the page.
1772 if (count($linksToDisplay) == 1) {
1773 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1774 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1775 $data['pagetitle'] = t('Search: ');
1776 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1777 $bracketWrap = function ($tag) {
1778 return '['. $tag .']';
1780 $data['pagetitle'] .= ! empty($searchtags)
1781 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1783 $data['pagetitle'] .= '- '. $conf->get('general.title');
1786 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1788 foreach ($data as $key => $value) {
1789 $PAGE->assign($key, $value);
1797 * This function should NEVER be called if the file data/config.php exists.
1799 * @param ConfigManager $conf Configuration Manager instance.
1800 * @param SessionManager $sessionManager SessionManager instance
1801 * @param LoginManager $loginManager LoginManager instance
1803 function install($conf, $sessionManager, $loginManager)
1805 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1806 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1807 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1811 // This part makes sure sessions works correctly.
1812 // (Because on some hosts, session.save_path may not be set correctly,
1813 // or we may not have write access to it.)
1814 if (isset($_GET['test_session'])
1815 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1816 // Step 2: Check if data in session is correct.
1818 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1819 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1820 'and that you have write access to it.<br>'.
1821 'It currently points to %s.<br>'.
1822 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1823 'or any custom hostname without a dot causes cookie storage to fail. '.
1824 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1826 $msg = sprintf($msg, session_save_path());
1828 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1831 if (!isset($_SESSION['session_tested'])) {
1832 // Step 1 : Try to store data in session and reload page.
1833 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1834 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1836 if (isset($_GET['test_session'])) {
1837 // Step 3: Sessions are OK. Remove test parameter from URL.
1838 header('Location: '.index_url($_SERVER));
1842 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1844 if (!empty($_POST['continent']) && !empty($_POST['city'])
1845 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1847 $tz = $_POST['continent'].'/'.$_POST['city'];
1849 $conf->set('general.timezone', $tz);
1850 $login = $_POST['setlogin'];
1851 $conf->set('credentials.login', $login);
1852 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1853 $conf->set('credentials.salt', $salt);
1854 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1855 if (!empty($_POST['title'])) {
1856 $conf->set('general.title', escape($_POST['title']));
1858 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1860 $conf->set('translation.language', escape($_POST['language']));
1861 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1862 $conf->set('api.enabled', !empty($_POST['enableApi']));
1865 generate_api_secret(
1866 $conf->get('credentials.login'),
1867 $conf->get('credentials.salt')
1871 // Everything is ok, let's create config file.
1872 $conf->write($loginManager->isLoggedIn());
1873 } catch (Exception
$e) {
1875 'ERROR while writing config file after installation.' . PHP_EOL
.
1879 // TODO: do not handle exceptions/errors in JS.
1880 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1884 $history = new History($conf->get('resource.history'));
1885 $bookmarkService = new BookmarkFileService($conf, $history, true);
1886 if ($bookmarkService->count() === 0) {
1887 $bookmarkService->initialize();
1890 echo '<script>alert('
1891 .'"Shaarli is now configured. '
1892 .'Please enter your login/password and start shaaring your bookmarks!"'
1893 .');document.location=\'./login\';</script>';
1897 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1898 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1899 $PAGE->assign('continents', $continents);
1900 $PAGE->assign('cities', $cities);
1901 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1902 $PAGE->renderPage('install');
1906 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1907 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1911 $history = new History($conf->get('resource.history'));
1912 } catch (Exception
$e) {
1913 die($e->getMessage());
1916 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1918 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1919 showDailyRSS($linkDb, $conf, $loginManager);
1923 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager);
1924 $container = $containerBuilder->build();
1925 $app = new App($container);
1928 $app->group('/api/v1', function () {
1929 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1930 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1931 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1932 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1933 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1934 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1936 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1937 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1938 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1939 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1941 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1942 })->add('\Shaarli\Api\ApiMiddleware');
1944 $app->group('', function () {
1945 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1946 })->add('\Shaarli\Front\ShaarliMiddleware');
1948 $response = $app->run(true);
1950 // Hack to make Slim and Shaarli router work together:
1951 // If a Slim route isn't found and NOT API call, we call renderPage().
1952 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1953 // We use UTF-8 for proper international characters handling.
1954 header('Content-Type: text/html; charset=utf-8');
1955 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1957 $response = $response
1958 ->withHeader('Access-Control-Allow-Origin', '*')
1960 'Access-Control-Allow-Headers',
1961 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1963 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1964 $app->respond($response);