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/http/HttpUtils.php';
57 require_once 'application/http/UrlUtils.php';
58 require_once 'application/updater/UpdaterUtils.php';
59 require_once 'application/FileUtils.php';
60 require_once 'application/TimeZone.php';
61 require_once 'application/Utils.php';
63 use Shaarli\ApplicationUtils
;
64 use Shaarli\Bookmark\Bookmark
;
65 use Shaarli\Bookmark\BookmarkFileService
;
66 use Shaarli\Bookmark\BookmarkFilter
;
67 use Shaarli\Bookmark\BookmarkServiceInterface
;
68 use Shaarli\Bookmark\Exception\BookmarkNotFoundException
;
69 use Shaarli\Config\ConfigManager
;
70 use Shaarli\Container\ContainerBuilder
;
71 use Shaarli\Feed\CachedPage
;
72 use Shaarli\Feed\FeedBuilder
;
73 use Shaarli\Formatter\BookmarkMarkdownFormatter
;
74 use Shaarli\Formatter\FormatterFactory
;
76 use Shaarli\Languages
;
77 use Shaarli\Netscape\NetscapeBookmarkUtils
;
78 use Shaarli\Plugin\PluginManager
;
79 use Shaarli\Render\PageBuilder
;
80 use Shaarli\Render\PageCacheManager
;
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 $pageCacheManager = new PageCacheManager($conf->get('resource.page_cache'));
534 $updater = new Updater(
535 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
538 $loginManager->isLoggedIn()
541 $newUpdates = $updater->update();
542 if (! empty($newUpdates)) {
543 UpdaterUtils
::write_updates_file(
544 $conf->get('resource.updates'),
545 $updater->getDoneUpdates()
548 $pageCacheManager->invalidateCaches();
550 } catch (Exception
$e) {
551 die($e->getMessage());
554 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
555 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
556 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
557 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
559 // Determine which page will be rendered.
560 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
561 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
563 if (// if the user isn't logged in
564 !$loginManager->isLoggedIn() &&
565 // and Shaarli doesn't have public content...
566 $conf->get('privacy.hide_public_links') &&
567 // and is configured to enforce the login
568 $conf->get('privacy.force_login') &&
569 // and the current page isn't already the login page
570 $targetPage !== Router
::$PAGE_LOGIN &&
571 // and the user is not requesting a feed (which would lead to a different content-type as expected)
572 $targetPage !== Router
::$PAGE_FEED_ATOM &&
573 $targetPage !== Router
::$PAGE_FEED_RSS
575 // force current page to be the login page
576 $targetPage = Router
::$PAGE_LOGIN;
579 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
580 // Then assign generated data to RainTPL.
581 $common_hooks = array(
587 foreach ($common_hooks as $name) {
588 $plugin_data = array();
589 $pluginManager->executeHooks(
593 'target' => $targetPage,
594 'loggedin' => $loginManager->isLoggedIn()
597 $PAGE->assign('plugins_' . $name, $plugin_data);
600 // -------- Display login form.
601 if ($targetPage == Router
::$PAGE_LOGIN) {
602 header('Location: ./login');
605 // -------- User wants to logout.
606 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
607 header('Location: ./logout');
611 // -------- Picture wall
612 if ($targetPage == Router
::$PAGE_PICWALL) {
613 header('Location: ./picture-wall');
617 // -------- Tag cloud
618 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
619 header('Location: ./tag-cloud');
624 if ($targetPage == Router
::$PAGE_TAGLIST) {
625 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
626 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
627 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
628 foreach ($filteringTags as $tag) {
629 if (array_key_exists($tag, $tags)) {
634 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
635 alphabetical_sort($tags, false, true);
638 $searchTags = implode(' ', escape($filteringTags));
640 'search_tags' => $searchTags,
643 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
645 foreach ($data as $key => $value) {
646 $PAGE->assign($key, $value);
649 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
650 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
651 $PAGE->renderPage('tag.list');
656 if ($targetPage == Router
::$PAGE_DAILY) {
657 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
660 // ATOM and RSS feed.
661 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
662 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
663 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
666 $query = $_SERVER['QUERY_STRING'];
667 $cache = new CachedPage(
668 $conf->get('resource.page_cache'),
670 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
672 $cached = $cache->cachedVersion();
673 if (!empty($cached)) {
678 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
680 $feedGenerator = new FeedBuilder(
682 $factory->getFormatter(),
686 $loginManager->isLoggedIn()
688 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
689 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
690 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
691 $data = $feedGenerator->buildData();
693 // Process plugin hook.
694 $pluginManager->executeHooks('render_feed', $data, array(
695 'loggedin' => $loginManager->isLoggedIn(),
696 'target' => $targetPage,
699 // Render the template.
700 $PAGE->assignAll($data);
701 $PAGE->renderPage('feed.'. $feedType);
702 $cache->cache(ob_get_contents());
707 // Display opensearch plugin (XML)
708 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
709 header('Content-Type: application/xml; charset=utf-8');
710 $PAGE->assign('serverurl', index_url($_SERVER));
711 $PAGE->renderPage('opensearch');
715 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
716 if (isset($_GET['addtag'])) {
717 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
718 if (empty($_SERVER['HTTP_REFERER'])) {
719 // In case browser does not send HTTP_REFERER
720 header('Location: ?searchtags='.urlencode($_GET['addtag']));
723 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
725 // Prevent redirection loop
726 if (isset($params['addtag'])) {
727 unset($params['addtag']);
730 // Check if this tag is already in the search query and ignore it if it is.
731 // Each tag is always separated by a space
732 if (isset($params['searchtags'])) {
733 $current_tags = explode(' ', $params['searchtags']);
735 $current_tags = array();
738 foreach ($current_tags as $value) {
739 if ($value === $_GET['addtag']) {
744 // Append the tag if necessary
745 if (empty($params['searchtags'])) {
746 $params['searchtags'] = trim($_GET['addtag']);
748 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
751 // We also remove page (keeping the same page has no sense, since the
752 // results are different)
753 unset($params['page']);
755 header('Location: ?'.http_build_query($params));
759 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
760 if (isset($_GET['removetag'])) {
761 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
762 if (empty($_SERVER['HTTP_REFERER'])) {
763 header('Location: ?');
767 // In case browser does not send HTTP_REFERER
768 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
770 // Prevent redirection loop
771 if (isset($params['removetag'])) {
772 unset($params['removetag']);
775 if (isset($params['searchtags'])) {
776 $tags = explode(' ', $params['searchtags']);
777 // Remove value from array $tags.
778 $tags = array_diff($tags, array($_GET['removetag']));
779 $params['searchtags'] = implode(' ', $tags);
781 if (empty($params['searchtags'])) {
782 unset($params['searchtags']);
785 // We also remove page (keeping the same page has no sense, since
786 // the results are different)
787 unset($params['page']);
789 header('Location: ?'.http_build_query($params));
793 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
794 if (isset($_GET['linksperpage'])) {
795 if (is_numeric($_GET['linksperpage'])) {
796 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
799 if (! empty($_SERVER['HTTP_REFERER'])) {
800 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
804 header('Location: '. $location);
808 // -------- User wants to see only private bookmarks (toggle)
809 if (isset($_GET['visibility'])) {
810 if ($_GET['visibility'] === 'private') {
811 // Visibility not set or not already private, set private, otherwise reset it
812 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
813 // See only private bookmarks
814 $_SESSION['visibility'] = 'private';
816 unset($_SESSION['visibility']);
818 } elseif ($_GET['visibility'] === 'public') {
819 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
820 // See only public bookmarks
821 $_SESSION['visibility'] = 'public';
823 unset($_SESSION['visibility']);
827 if (! empty($_SERVER['HTTP_REFERER'])) {
828 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
832 header('Location: '. $location);
836 // -------- User wants to see only untagged bookmarks (toggle)
837 if (isset($_GET['untaggedonly'])) {
838 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
840 if (! empty($_SERVER['HTTP_REFERER'])) {
841 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
845 header('Location: '. $location);
849 // -------- Handle other actions allowed for non-logged in users:
850 if (!$loginManager->isLoggedIn()) {
851 // User tries to post new link but is not logged in:
852 // Show login screen, then redirect to ?post=...
853 if (isset($_GET['post'])) {
854 header( // Redirect to login page, then back to post link.
855 'Location: /login?post='.urlencode($_GET['post']).
856 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
857 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
858 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
859 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
864 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
865 if (isset($_GET['edit_link'])) {
866 header('Location: /login?edit_link='. escape($_GET['edit_link']));
870 exit; // Never remove this one! All operations below are reserved for logged in user.
873 // -------- All other functions are reserved for the registered user:
875 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
876 if ($targetPage == Router
::$PAGE_TOOLS) {
878 'pageabsaddr' => index_url($_SERVER),
879 'sslenabled' => is_https($_SERVER),
881 $pluginManager->executeHooks('render_tools', $data);
883 foreach ($data as $key => $value) {
884 $PAGE->assign($key, $value);
887 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
888 $PAGE->renderPage('tools');
892 // -------- User wants to change his/her password.
893 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
894 if ($conf->get('security.open_shaarli')) {
895 die(t('You are not supposed to change a password on an Open Shaarli.'));
898 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
899 if (!$sessionManager->checkToken($_POST['token'])) {
900 die(t('Wrong token.')); // Go away!
903 // Make sure old password is correct.
905 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
907 if ($oldhash != $conf->get('credentials.hash')) {
908 echo '<script>alert("'
909 . t('The old password is not correct.')
910 .'");document.location=\'./?do=changepasswd\';</script>';
914 // Salt renders rainbow-tables attacks useless.
915 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
919 $_POST['setpassword']
920 . $conf->get('credentials.login')
921 . $conf->get('credentials.salt')
925 $conf->write($loginManager->isLoggedIn());
926 } catch (Exception
$e) {
928 'ERROR while writing config file after changing password.' . PHP_EOL
.
932 // TODO: do not handle exceptions/errors in JS.
933 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
936 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
939 // show the change password form.
940 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
941 $PAGE->renderPage('changepassword');
946 // -------- User wants to change configuration
947 if ($targetPage == Router
::$PAGE_CONFIGURE) {
948 if (!empty($_POST['title'])) {
949 if (!$sessionManager->checkToken($_POST['token'])) {
950 die(t('Wrong token.')); // Go away!
953 if (!empty($_POST['continent']) && !empty($_POST['city'])
954 && isTimeZoneValid($_POST['continent'], $_POST['city'])
956 $tz = $_POST['continent'] . '/' . $_POST['city'];
958 $conf->set('general.timezone', $tz);
959 $conf->set('general.title', escape($_POST['title']));
960 $conf->set('general.header_link', escape($_POST['titleLink']));
961 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
962 $conf->set('resource.theme', escape($_POST['theme']));
963 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
964 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
965 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
966 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
967 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
968 $conf->set('api.enabled', !empty($_POST['enableApi']));
969 $conf->set('api.secret', escape($_POST['apiSecret']));
970 $conf->set('formatter', escape($_POST['formatter']));
972 if (! empty($_POST['language'])) {
973 $conf->set('translation.language', escape($_POST['language']));
976 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
977 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
978 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
980 $_SESSION['warnings'][] = t(
981 'You have enabled or changed thumbnails mode. '
982 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
985 $conf->set('thumbnails.mode', $thumbnailsMode);
988 $conf->write($loginManager->isLoggedIn());
989 $history->updateSettings();
990 $pageCacheManager->invalidateCaches();
991 } catch (Exception
$e) {
993 'ERROR while writing config file after configuration update.' . PHP_EOL
.
997 // TODO: do not handle exceptions/errors in JS.
998 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
1001 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
1004 // Show the configuration form.
1005 $PAGE->assign('title', $conf->get('general.title'));
1006 $PAGE->assign('theme', $conf->get('resource.theme'));
1007 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1008 $PAGE->assign('formatter_available', ['default', 'markdown']);
1009 list($continents, $cities) = generateTimeZoneData(
1010 timezone_identifiers_list(),
1011 $conf->get('general.timezone')
1013 $PAGE->assign('continents', $continents);
1014 $PAGE->assign('cities', $cities);
1015 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1016 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1017 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1018 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1019 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1020 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1021 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1022 $PAGE->assign('api_secret', $conf->get('api.secret'));
1023 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1024 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1025 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1026 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1027 $PAGE->renderPage('configure');
1032 // -------- User wants to rename a tag or delete it
1033 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1034 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1035 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1036 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1037 $PAGE->renderPage('changetag');
1041 if (!$sessionManager->checkToken($_POST['token'])) {
1042 die(t('Wrong token.'));
1045 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1046 $fromTag = escape($_POST['fromtag']);
1048 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1049 foreach ($bookmarks as $bookmark) {
1051 $bookmark->renameTag($fromTag, $toTag);
1053 $bookmark->deleteTag($fromTag);
1055 $bookmarkService->set($bookmark, false);
1056 $history->updateLink($bookmark);
1059 $bookmarkService->save();
1060 $delete = empty($_POST['totag']);
1061 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1063 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1064 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1065 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1069 // -------- User wants to add a link without using the bookmarklet: Show form.
1070 if ($targetPage == Router
::$PAGE_ADDLINK) {
1071 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1072 $PAGE->renderPage('addlink');
1076 // -------- User clicked the "Save" button when editing a link: Save link to database.
1077 if (isset($_POST['save_edit'])) {
1079 if (! $sessionManager->checkToken($_POST['token'])) {
1080 die(t('Wrong token.'));
1083 // lf_id should only be present if the link exists.
1084 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1085 if ($id && $bookmarkService->exists($id)) {
1087 $bookmark = $bookmarkService->get($id);
1090 $bookmark = new Bookmark();
1093 $bookmark->setTitle($_POST['lf_title']);
1094 $bookmark->setDescription($_POST['lf_description']);
1095 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1096 $bookmark->setPrivate(isset($_POST['lf_private']));
1097 $bookmark->setTagsString($_POST['lf_tags']);
1099 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1100 && ! $bookmark->isNote()
1102 $thumbnailer = new Thumbnailer($conf);
1103 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1105 $bookmarkService->addOrSet($bookmark, false);
1107 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1108 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1109 $formatter = $factory->getFormatter('raw');
1110 $data = $formatter->format($bookmark);
1111 $pluginManager->executeHooks('save_link', $data);
1113 $bookmark->fromArray($data);
1114 $bookmarkService->set($bookmark);
1116 // If we are called from the bookmarklet, we must close the popup:
1117 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1118 echo '<script>self.close();</script>';
1122 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1123 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1124 // Scroll to the link which has been edited.
1125 $location .= '#' . $bookmark->getShortUrl();
1126 // After saving the link, redirect to the page the user was on.
1127 header('Location: '. $location);
1131 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1132 if ($targetPage == Router
::$PAGE_DELETELINK) {
1133 if (! $sessionManager->checkToken($_GET['token'])) {
1134 die(t('Wrong token.'));
1137 $ids = trim($_GET['lf_linkdate']);
1138 if (strpos($ids, ' ') !== false) {
1139 // multiple, space-separated ids provided
1140 $ids = array_values(array_filter(
1141 preg_split('/\s+/', escape($ids)),
1143 return $item !== '';
1147 // only a single id provided
1148 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1151 // assert at least one id is given
1153 die('no id provided');
1155 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1156 $formatter = $factory->getFormatter('raw');
1157 foreach ($ids as $id) {
1158 $id = (int) escape($id);
1159 $bookmark = $bookmarkService->get($id);
1160 $data = $formatter->format($bookmark);
1161 $pluginManager->executeHooks('delete_link', $data);
1162 $bookmarkService->remove($bookmark, false);
1164 $bookmarkService->save();
1166 // If we are called from the bookmarklet, we must close the popup:
1167 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1168 echo '<script>self.close();</script>';
1173 if (isset($_SERVER['HTTP_REFERER'])) {
1174 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1175 $location = generateLocation(
1176 $_SERVER['HTTP_REFERER'],
1177 $_SERVER['HTTP_HOST'],
1178 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1182 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1186 // -------- User clicked either "Set public" or "Set private" bulk operation
1187 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1188 if (! $sessionManager->checkToken($_GET['token'])) {
1189 die(t('Wrong token.'));
1192 $ids = trim($_GET['ids']);
1193 if (strpos($ids, ' ') !== false) {
1194 // multiple, space-separated ids provided
1195 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1197 // only a single id provided
1201 // assert at least one id is given
1203 die('no id provided');
1205 // assert that the visibility is valid
1206 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1207 die('invalid visibility');
1209 $private = $_GET['newVisibility'] === 'private';
1211 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1212 $formatter = $factory->getFormatter('raw');
1213 foreach ($ids as $id) {
1214 $id = (int) escape($id);
1215 $bookmark = $bookmarkService->get($id);
1216 $bookmark->setPrivate($private);
1218 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1219 $data = $formatter->format($bookmark);
1220 $pluginManager->executeHooks('save_link', $data);
1221 $bookmark->fromArray($data);
1223 $bookmarkService->set($bookmark);
1225 $bookmarkService->save();
1228 if (isset($_SERVER['HTTP_REFERER'])) {
1229 $location = generateLocation(
1230 $_SERVER['HTTP_REFERER'],
1231 $_SERVER['HTTP_HOST']
1234 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1238 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1239 if (isset($_GET['edit_link'])) {
1240 $id = (int) escape($_GET['edit_link']);
1242 $link = $bookmarkService->get($id); // Read database
1243 } catch (BookmarkNotFoundException
$e) {
1244 // Link not found in database.
1245 header('Location: ?');
1249 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1250 $formatter = $factory->getFormatter('raw');
1251 $formattedLink = $formatter->format($link);
1252 $tags = $bookmarkService->bookmarksCountPerTag();
1253 if ($conf->get('formatter') === 'markdown') {
1254 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1257 'link' => $formattedLink,
1258 'link_is_new' => false,
1259 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1262 $pluginManager->executeHooks('render_editlink', $data);
1264 foreach ($data as $key => $value) {
1265 $PAGE->assign($key, $value);
1268 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1269 $PAGE->renderPage('editlink');
1273 // -------- User want to post a new link: Display link edit form.
1274 if (isset($_GET['post'])) {
1275 $url = cleanup_url($_GET['post']);
1277 $link_is_new = false;
1278 // Check if URL is not already in database (in this case, we will edit the existing link)
1279 $bookmark = $bookmarkService->findByUrl($url);
1281 $link_is_new = true;
1282 // Get title if it was provided in URL (by the bookmarklet).
1283 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1284 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1285 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1286 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1287 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1289 // If this is an HTTP(S) link, we try go get the page to extract
1290 // the title (otherwise we will to straight to the edit form.)
1291 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1292 $retrieveDescription = $conf->get('general.retrieve_description');
1293 // Short timeout to keep the application responsive
1294 // The callback will fill $charset and $title with data from the downloaded page.
1297 $conf->get('general.download_timeout', 30),
1298 $conf->get('general.download_max_size', 4194304),
1299 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1301 if (! empty($title) && strtolower($charset) != 'utf-8') {
1302 $title = mb_convert_encoding($title, 'utf-8', $charset);
1307 $title = $conf->get('general.default_note_title', t('Note: '));
1309 $url = escape($url);
1310 $title = escape($title);
1315 'description' => $description,
1317 'private' => $private,
1320 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1321 $formatter = $factory->getFormatter('raw');
1322 $link = $formatter->format($bookmark);
1325 $tags = $bookmarkService->bookmarksCountPerTag();
1326 if ($conf->get('formatter') === 'markdown') {
1327 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1331 'link_is_new' => $link_is_new,
1332 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1333 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1335 'default_private_links' => $conf->get('privacy.default_private_links', false),
1337 $pluginManager->executeHooks('render_editlink', $data);
1339 foreach ($data as $key => $value) {
1340 $PAGE->assign($key, $value);
1343 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1344 $PAGE->renderPage('editlink');
1348 if ($targetPage == Router
::$PAGE_PINLINK) {
1349 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1350 // FIXME! Use a proper error system.
1351 $msg = t('Invalid link ID provided');
1352 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1355 if (! $sessionManager->checkToken($_GET['token'])) {
1356 die('Wrong token.');
1359 $link = $bookmarkService->get($_GET['id']);
1360 $link->setSticky(! $link->isSticky());
1361 $bookmarkService->set($link);
1362 header('Location: '.index_url($_SERVER));
1366 if ($targetPage == Router
::$PAGE_EXPORT) {
1367 // Export bookmarks as a Netscape Bookmarks file
1369 if (empty($_GET['selection'])) {
1370 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1371 $PAGE->renderPage('export');
1375 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1376 $selection = $_GET['selection'];
1377 if (isset($_GET['prepend_note_url'])) {
1378 $prependNoteUrl = $_GET['prepend_note_url'];
1380 $prependNoteUrl = false;
1384 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1385 $formatter = $factory->getFormatter('raw');
1388 NetscapeBookmarkUtils
::filterAndFormat(
1396 } catch (Exception
$exc) {
1397 header('Content-Type: text/plain; charset=utf-8');
1398 echo $exc->getMessage();
1401 $now = new DateTime();
1402 header('Content-Type: text/html; charset=utf-8');
1404 'Content-disposition: attachment; filename=bookmarks_'
1405 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1407 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1408 $PAGE->assign('eol', PHP_EOL
);
1409 $PAGE->assign('selection', $selection);
1410 $PAGE->renderPage('export.bookmarks');
1414 if ($targetPage == Router
::$PAGE_IMPORT) {
1415 // Upload a Netscape bookmark dump to import its contents
1417 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1418 // Show import dialog
1421 get_max_upload_size(
1422 ini_get('post_max_size'),
1423 ini_get('upload_max_filesize'),
1429 get_max_upload_size(
1430 ini_get('post_max_size'),
1431 ini_get('upload_max_filesize'),
1435 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1436 $PAGE->renderPage('import');
1440 // Import bookmarks from an uploaded file
1441 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1442 // The file is too big or some form field may be missing.
1445 'The file you are trying to upload is probably bigger than what this webserver can accept'
1446 .' (%s). Please upload in smaller chunks.'
1448 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1450 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1453 if (! $sessionManager->checkToken($_POST['token'])) {
1454 die('Wrong token.');
1456 $status = NetscapeBookmarkUtils
::import(
1463 echo '<script>alert("'.$status.'");document.location=\'./?do='
1464 .Router
::$PAGE_IMPORT .'\';</script>';
1468 // Plugin administration page
1469 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1470 $pluginMeta = $pluginManager->getPluginsMeta();
1472 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1473 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1474 return $v['order'] !== false;
1477 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1481 return $a['order'] - $b['order'];
1484 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1485 return $v['order'] === false;
1488 $PAGE->assign('enabledPlugins', $enabledPlugins);
1489 $PAGE->assign('disabledPlugins', $disabledPlugins);
1490 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1491 $PAGE->renderPage('pluginsadmin');
1495 // Plugin administration form action
1496 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1498 if (isset($_POST['parameters_form'])) {
1499 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1500 unset($_POST['parameters_form']);
1501 foreach ($_POST as $param => $value) {
1502 $conf->set('plugins.'. $param, escape($value));
1505 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1507 $conf->write($loginManager->isLoggedIn());
1508 $history->updateSettings();
1509 } catch (Exception
$e) {
1511 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1515 // TODO: do not handle exceptions/errors in JS.
1516 echo '<script>alert("'
1518 .'");document.location=\'./?do='
1519 . Router
::$PAGE_PLUGINSADMIN
1523 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1527 // Get a fresh token
1528 if ($targetPage == Router
::$GET_TOKEN) {
1529 header('Content-Type:text/plain');
1530 echo $sessionManager->generateToken();
1534 // -------- Thumbnails Update
1535 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1537 foreach ($bookmarkService->search() as $bookmark) {
1538 // A note or not HTTP(S)
1539 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1542 $ids[] = $bookmark->getId();
1544 $PAGE->assign('ids', $ids);
1545 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1546 $PAGE->renderPage('thumbnails');
1550 // -------- Single Thumbnail Update
1551 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1552 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1553 http_response_code(400);
1556 $id = (int) $_POST['id'];
1557 if (! $bookmarkService->exists($id)) {
1558 http_response_code(404);
1561 $thumbnailer = new Thumbnailer($conf);
1562 $bookmark = $bookmarkService->get($id);
1563 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1564 $bookmarkService->set($bookmark);
1566 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1567 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1571 // -------- Otherwise, simply display search form and bookmarks:
1572 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1577 * Template for the list of bookmarks (<div id="linklist">)
1578 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1580 * @param pageBuilder $PAGE pageBuilder instance.
1581 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1582 * @param ConfigManager $conf Configuration Manager instance.
1583 * @param PluginManager $pluginManager Plugin Manager instance.
1584 * @param LoginManager $loginManager LoginManager instance
1586 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1588 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1589 $formatter = $factory->getFormatter();
1591 // Used in templates
1592 if (isset($_GET['searchtags'])) {
1593 if (! empty($_GET['searchtags'])) {
1594 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1596 $searchtags = false;
1601 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1604 if (! empty($_SERVER['QUERY_STRING'])
1605 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1607 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1608 } catch (BookmarkNotFoundException
$e) {
1609 $PAGE->render404($e->getMessage());
1613 // Filter bookmarks according search parameters.
1614 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1616 'searchtags' => $searchtags,
1617 'searchterm' => $searchterm,
1619 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1622 // ---- Handle paging.
1624 foreach ($linksToDisplay as $key => $value) {
1628 // Select articles according to paging.
1629 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1630 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1631 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1632 $page = $page < 1 ? 1 : $page;
1633 $page = $page > $pagecount ? $pagecount : $page;
1635 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1636 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1638 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1639 if ($thumbnailsEnabled) {
1640 $thumbnailer = new Thumbnailer($conf);
1643 $linkDisp = array();
1644 while ($i<$end && $i<count($keys)) {
1645 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1647 // Logged in, thumbnails enabled, not a note,
1648 // and (never retrieved yet or no valid cache file)
1649 if ($loginManager->isLoggedIn()
1650 && $thumbnailsEnabled
1651 && !$linksToDisplay[$keys[$i]]->isNote()
1652 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1653 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1655 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1656 $linkDb->set($linksToDisplay[$keys[$i]], false);
1658 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1661 // Check for both signs of a note: starting with ? and 7 chars long.
1662 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1663 // $link['url'] = index_url($_SERVER) . $link['url'];
1666 $linkDisp[$keys[$i]] = $link;
1670 // If we retrieved new thumbnails, we update the database.
1671 if (!empty($updateDB)) {
1675 // Compute paging navigation
1676 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1677 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1678 $previous_page_url = '';
1679 if ($i != count($keys)) {
1680 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1684 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1687 // Fill all template fields.
1689 'previous_page_url' => $previous_page_url,
1690 'next_page_url' => $next_page_url,
1691 'page_current' => $page,
1692 'page_max' => $pagecount,
1693 'result_count' => count($linksToDisplay),
1694 'search_term' => $searchterm,
1695 'search_tags' => $searchtags,
1696 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1697 'links' => $linkDisp,
1700 // If there is only a single link, we change on-the-fly the title of the page.
1701 if (count($linksToDisplay) == 1) {
1702 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1703 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1704 $data['pagetitle'] = t('Search: ');
1705 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1706 $bracketWrap = function ($tag) {
1707 return '['. $tag .']';
1709 $data['pagetitle'] .= ! empty($searchtags)
1710 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1712 $data['pagetitle'] .= '- '. $conf->get('general.title');
1715 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1717 foreach ($data as $key => $value) {
1718 $PAGE->assign($key, $value);
1726 * This function should NEVER be called if the file data/config.php exists.
1728 * @param ConfigManager $conf Configuration Manager instance.
1729 * @param SessionManager $sessionManager SessionManager instance
1730 * @param LoginManager $loginManager LoginManager instance
1732 function install($conf, $sessionManager, $loginManager)
1734 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1735 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1736 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1740 // This part makes sure sessions works correctly.
1741 // (Because on some hosts, session.save_path may not be set correctly,
1742 // or we may not have write access to it.)
1743 if (isset($_GET['test_session'])
1744 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1745 // Step 2: Check if data in session is correct.
1747 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1748 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1749 'and that you have write access to it.<br>'.
1750 'It currently points to %s.<br>'.
1751 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1752 'or any custom hostname without a dot causes cookie storage to fail. '.
1753 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1755 $msg = sprintf($msg, session_save_path());
1757 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1760 if (!isset($_SESSION['session_tested'])) {
1761 // Step 1 : Try to store data in session and reload page.
1762 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1763 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1765 if (isset($_GET['test_session'])) {
1766 // Step 3: Sessions are OK. Remove test parameter from URL.
1767 header('Location: '.index_url($_SERVER));
1771 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1773 if (!empty($_POST['continent']) && !empty($_POST['city'])
1774 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1776 $tz = $_POST['continent'].'/'.$_POST['city'];
1778 $conf->set('general.timezone', $tz);
1779 $login = $_POST['setlogin'];
1780 $conf->set('credentials.login', $login);
1781 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1782 $conf->set('credentials.salt', $salt);
1783 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1784 if (!empty($_POST['title'])) {
1785 $conf->set('general.title', escape($_POST['title']));
1787 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1789 $conf->set('translation.language', escape($_POST['language']));
1790 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1791 $conf->set('api.enabled', !empty($_POST['enableApi']));
1794 generate_api_secret(
1795 $conf->get('credentials.login'),
1796 $conf->get('credentials.salt')
1800 // Everything is ok, let's create config file.
1801 $conf->write($loginManager->isLoggedIn());
1802 } catch (Exception
$e) {
1804 'ERROR while writing config file after installation.' . PHP_EOL
.
1808 // TODO: do not handle exceptions/errors in JS.
1809 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1813 $history = new History($conf->get('resource.history'));
1814 $bookmarkService = new BookmarkFileService($conf, $history, true);
1815 if ($bookmarkService->count() === 0) {
1816 $bookmarkService->initialize();
1819 echo '<script>alert('
1820 .'"Shaarli is now configured. '
1821 .'Please enter your login/password and start shaaring your bookmarks!"'
1822 .');document.location=\'./login\';</script>';
1826 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1827 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1828 $PAGE->assign('continents', $continents);
1829 $PAGE->assign('cities', $cities);
1830 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1831 $PAGE->renderPage('install');
1835 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1836 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1840 $history = new History($conf->get('resource.history'));
1841 } catch (Exception
$e) {
1842 die($e->getMessage());
1845 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1847 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1848 showDailyRSS($linkDb, $conf, $loginManager);
1852 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1853 $container = $containerBuilder->build();
1854 $app = new App($container);
1857 $app->group('/api/v1', function () {
1858 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1859 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1860 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1861 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1862 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1863 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1865 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1866 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1867 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1868 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1870 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1871 })->add('\Shaarli\Api\ApiMiddleware');
1873 $app->group('', function () {
1874 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1875 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1876 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1877 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:index')->setName('tagcloud');
1878 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1879 })->add('\Shaarli\Front\ShaarliMiddleware');
1881 $response = $app->run(true);
1883 // Hack to make Slim and Shaarli router work together:
1884 // If a Slim route isn't found and NOT API call, we call renderPage().
1885 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1886 // We use UTF-8 for proper international characters handling.
1887 header('Content-Type: text/html; charset=utf-8');
1888 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1890 $response = $response
1891 ->withHeader('Access-Control-Allow-Origin', '*')
1893 'Access-Control-Allow-Headers',
1894 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1896 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1897 $app->respond($response);