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 * Renders the linklist
404 * @param pageBuilder $PAGE pageBuilder instance.
405 * @param BookmarkServiceInterface $linkDb instance.
406 * @param ConfigManager $conf Configuration Manager instance.
407 * @param PluginManager $pluginManager Plugin Manager instance.
409 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
411 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
412 $PAGE->renderPage('linklist');
416 * Render HTML page (according to URL parameters and user rights)
418 * @param ConfigManager $conf Configuration Manager instance.
419 * @param PluginManager $pluginManager Plugin Manager instance,
420 * @param BookmarkServiceInterface $bookmarkService
421 * @param History $history instance
422 * @param SessionManager $sessionManager SessionManager instance
423 * @param LoginManager $loginManager LoginManager instance
425 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
427 $pageCacheManager = new PageCacheManager($conf->get('resource.page_cache'));
428 $updater = new Updater(
429 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
432 $loginManager->isLoggedIn()
435 $newUpdates = $updater->update();
436 if (! empty($newUpdates)) {
437 UpdaterUtils
::write_updates_file(
438 $conf->get('resource.updates'),
439 $updater->getDoneUpdates()
442 $pageCacheManager->invalidateCaches();
444 } catch (Exception
$e) {
445 die($e->getMessage());
448 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
449 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
450 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
451 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
453 // Determine which page will be rendered.
454 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
455 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
457 if (// if the user isn't logged in
458 !$loginManager->isLoggedIn() &&
459 // and Shaarli doesn't have public content...
460 $conf->get('privacy.hide_public_links') &&
461 // and is configured to enforce the login
462 $conf->get('privacy.force_login') &&
463 // and the current page isn't already the login page
464 $targetPage !== Router
::$PAGE_LOGIN &&
465 // and the user is not requesting a feed (which would lead to a different content-type as expected)
466 $targetPage !== Router
::$PAGE_FEED_ATOM &&
467 $targetPage !== Router
::$PAGE_FEED_RSS
469 // force current page to be the login page
470 $targetPage = Router
::$PAGE_LOGIN;
473 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
474 // Then assign generated data to RainTPL.
475 $common_hooks = array(
481 foreach ($common_hooks as $name) {
482 $plugin_data = array();
483 $pluginManager->executeHooks(
487 'target' => $targetPage,
488 'loggedin' => $loginManager->isLoggedIn()
491 $PAGE->assign('plugins_' . $name, $plugin_data);
494 // -------- Display login form.
495 if ($targetPage == Router
::$PAGE_LOGIN) {
496 header('Location: ./login');
499 // -------- User wants to logout.
500 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
501 header('Location: ./logout');
505 // -------- Picture wall
506 if ($targetPage == Router
::$PAGE_PICWALL) {
507 header('Location: ./picture-wall');
511 // -------- Tag cloud
512 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
513 header('Location: ./tag-cloud');
518 if ($targetPage == Router
::$PAGE_TAGLIST) {
519 header('Location: ./tag-list');
524 if ($targetPage == Router
::$PAGE_DAILY) {
525 header('Location: ./daily');
529 // ATOM and RSS feed.
530 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
531 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
532 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
535 $query = $_SERVER['QUERY_STRING'];
536 $cache = new CachedPage(
537 $conf->get('resource.page_cache'),
539 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
541 $cached = $cache->cachedVersion();
542 if (!empty($cached)) {
547 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
549 $feedGenerator = new FeedBuilder(
551 $factory->getFormatter(),
555 $loginManager->isLoggedIn()
557 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
558 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
559 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
560 $data = $feedGenerator->buildData();
562 // Process plugin hook.
563 $pluginManager->executeHooks('render_feed', $data, array(
564 'loggedin' => $loginManager->isLoggedIn(),
565 'target' => $targetPage,
568 // Render the template.
569 $PAGE->assignAll($data);
570 $PAGE->renderPage('feed.'. $feedType);
571 $cache->cache(ob_get_contents());
576 // Display opensearch plugin (XML)
577 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
578 header('Content-Type: application/xml; charset=utf-8');
579 $PAGE->assign('serverurl', index_url($_SERVER));
580 $PAGE->renderPage('opensearch');
584 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
585 if (isset($_GET['addtag'])) {
586 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
587 if (empty($_SERVER['HTTP_REFERER'])) {
588 // In case browser does not send HTTP_REFERER
589 header('Location: ?searchtags='.urlencode($_GET['addtag']));
592 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
594 // Prevent redirection loop
595 if (isset($params['addtag'])) {
596 unset($params['addtag']);
599 // Check if this tag is already in the search query and ignore it if it is.
600 // Each tag is always separated by a space
601 if (isset($params['searchtags'])) {
602 $current_tags = explode(' ', $params['searchtags']);
604 $current_tags = array();
607 foreach ($current_tags as $value) {
608 if ($value === $_GET['addtag']) {
613 // Append the tag if necessary
614 if (empty($params['searchtags'])) {
615 $params['searchtags'] = trim($_GET['addtag']);
617 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
620 // We also remove page (keeping the same page has no sense, since the
621 // results are different)
622 unset($params['page']);
624 header('Location: ?'.http_build_query($params));
628 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
629 if (isset($_GET['removetag'])) {
630 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
631 if (empty($_SERVER['HTTP_REFERER'])) {
632 header('Location: ?');
636 // In case browser does not send HTTP_REFERER
637 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
639 // Prevent redirection loop
640 if (isset($params['removetag'])) {
641 unset($params['removetag']);
644 if (isset($params['searchtags'])) {
645 $tags = explode(' ', $params['searchtags']);
646 // Remove value from array $tags.
647 $tags = array_diff($tags, array($_GET['removetag']));
648 $params['searchtags'] = implode(' ', $tags);
650 if (empty($params['searchtags'])) {
651 unset($params['searchtags']);
654 // We also remove page (keeping the same page has no sense, since
655 // the results are different)
656 unset($params['page']);
658 header('Location: ?'.http_build_query($params));
662 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
663 if (isset($_GET['linksperpage'])) {
664 if (is_numeric($_GET['linksperpage'])) {
665 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
668 if (! empty($_SERVER['HTTP_REFERER'])) {
669 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
673 header('Location: '. $location);
677 // -------- User wants to see only private bookmarks (toggle)
678 if (isset($_GET['visibility'])) {
679 if ($_GET['visibility'] === 'private') {
680 // Visibility not set or not already private, set private, otherwise reset it
681 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
682 // See only private bookmarks
683 $_SESSION['visibility'] = 'private';
685 unset($_SESSION['visibility']);
687 } elseif ($_GET['visibility'] === 'public') {
688 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
689 // See only public bookmarks
690 $_SESSION['visibility'] = 'public';
692 unset($_SESSION['visibility']);
696 if (! empty($_SERVER['HTTP_REFERER'])) {
697 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
701 header('Location: '. $location);
705 // -------- User wants to see only untagged bookmarks (toggle)
706 if (isset($_GET['untaggedonly'])) {
707 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
709 if (! empty($_SERVER['HTTP_REFERER'])) {
710 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
714 header('Location: '. $location);
718 // -------- Handle other actions allowed for non-logged in users:
719 if (!$loginManager->isLoggedIn()) {
720 // User tries to post new link but is not logged in:
721 // Show login screen, then redirect to ?post=...
722 if (isset($_GET['post'])) {
723 header( // Redirect to login page, then back to post link.
724 'Location: ./login?post='.urlencode($_GET['post']).
725 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
726 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
727 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
728 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
733 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
734 if (isset($_GET['edit_link'])) {
735 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
739 exit; // Never remove this one! All operations below are reserved for logged in user.
742 // -------- All other functions are reserved for the registered user:
744 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
745 if ($targetPage == Router
::$PAGE_TOOLS) {
747 'pageabsaddr' => index_url($_SERVER),
748 'sslenabled' => is_https($_SERVER),
750 $pluginManager->executeHooks('render_tools', $data);
752 foreach ($data as $key => $value) {
753 $PAGE->assign($key, $value);
756 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
757 $PAGE->renderPage('tools');
761 // -------- User wants to change his/her password.
762 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
763 if ($conf->get('security.open_shaarli')) {
764 die(t('You are not supposed to change a password on an Open Shaarli.'));
767 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
768 if (!$sessionManager->checkToken($_POST['token'])) {
769 die(t('Wrong token.')); // Go away!
772 // Make sure old password is correct.
774 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
776 if ($oldhash != $conf->get('credentials.hash')) {
777 echo '<script>alert("'
778 . t('The old password is not correct.')
779 .'");document.location=\'./?do=changepasswd\';</script>';
783 // Salt renders rainbow-tables attacks useless.
784 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
788 $_POST['setpassword']
789 . $conf->get('credentials.login')
790 . $conf->get('credentials.salt')
794 $conf->write($loginManager->isLoggedIn());
795 } catch (Exception
$e) {
797 'ERROR while writing config file after changing password.' . PHP_EOL
.
801 // TODO: do not handle exceptions/errors in JS.
802 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
805 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
808 // show the change password form.
809 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
810 $PAGE->renderPage('changepassword');
815 // -------- User wants to change configuration
816 if ($targetPage == Router
::$PAGE_CONFIGURE) {
817 if (!empty($_POST['title'])) {
818 if (!$sessionManager->checkToken($_POST['token'])) {
819 die(t('Wrong token.')); // Go away!
822 if (!empty($_POST['continent']) && !empty($_POST['city'])
823 && isTimeZoneValid($_POST['continent'], $_POST['city'])
825 $tz = $_POST['continent'] . '/' . $_POST['city'];
827 $conf->set('general.timezone', $tz);
828 $conf->set('general.title', escape($_POST['title']));
829 $conf->set('general.header_link', escape($_POST['titleLink']));
830 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
831 $conf->set('resource.theme', escape($_POST['theme']));
832 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
833 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
834 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
835 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
836 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
837 $conf->set('api.enabled', !empty($_POST['enableApi']));
838 $conf->set('api.secret', escape($_POST['apiSecret']));
839 $conf->set('formatter', escape($_POST['formatter']));
841 if (! empty($_POST['language'])) {
842 $conf->set('translation.language', escape($_POST['language']));
845 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
846 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
847 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
849 $_SESSION['warnings'][] = t(
850 'You have enabled or changed thumbnails mode. '
851 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
854 $conf->set('thumbnails.mode', $thumbnailsMode);
857 $conf->write($loginManager->isLoggedIn());
858 $history->updateSettings();
859 $pageCacheManager->invalidateCaches();
860 } catch (Exception
$e) {
862 'ERROR while writing config file after configuration update.' . PHP_EOL
.
866 // TODO: do not handle exceptions/errors in JS.
867 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
870 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
873 // Show the configuration form.
874 $PAGE->assign('title', $conf->get('general.title'));
875 $PAGE->assign('theme', $conf->get('resource.theme'));
876 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
877 $PAGE->assign('formatter_available', ['default', 'markdown']);
878 list($continents, $cities) = generateTimeZoneData(
879 timezone_identifiers_list(),
880 $conf->get('general.timezone')
882 $PAGE->assign('continents', $continents);
883 $PAGE->assign('cities', $cities);
884 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
885 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
886 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
887 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
888 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
889 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
890 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
891 $PAGE->assign('api_secret', $conf->get('api.secret'));
892 $PAGE->assign('languages', Languages
::getAvailableLanguages());
893 $PAGE->assign('gd_enabled', extension_loaded('gd'));
894 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
895 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
896 $PAGE->renderPage('configure');
901 // -------- User wants to rename a tag or delete it
902 if ($targetPage == Router
::$PAGE_CHANGETAG) {
903 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
904 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
905 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
906 $PAGE->renderPage('changetag');
910 if (!$sessionManager->checkToken($_POST['token'])) {
911 die(t('Wrong token.'));
914 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
915 $fromTag = escape($_POST['fromtag']);
917 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
918 foreach ($bookmarks as $bookmark) {
920 $bookmark->renameTag($fromTag, $toTag);
922 $bookmark->deleteTag($fromTag);
924 $bookmarkService->set($bookmark, false);
925 $history->updateLink($bookmark);
928 $bookmarkService->save();
929 $delete = empty($_POST['totag']);
930 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
932 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
933 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
934 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
938 // -------- User wants to add a link without using the bookmarklet: Show form.
939 if ($targetPage == Router
::$PAGE_ADDLINK) {
940 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
941 $PAGE->renderPage('addlink');
945 // -------- User clicked the "Save" button when editing a link: Save link to database.
946 if (isset($_POST['save_edit'])) {
948 if (! $sessionManager->checkToken($_POST['token'])) {
949 die(t('Wrong token.'));
952 // lf_id should only be present if the link exists.
953 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
954 if ($id && $bookmarkService->exists($id)) {
956 $bookmark = $bookmarkService->get($id);
959 $bookmark = new Bookmark();
962 $bookmark->setTitle($_POST['lf_title']);
963 $bookmark->setDescription($_POST['lf_description']);
964 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
965 $bookmark->setPrivate(isset($_POST['lf_private']));
966 $bookmark->setTagsString($_POST['lf_tags']);
968 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
969 && ! $bookmark->isNote()
971 $thumbnailer = new Thumbnailer($conf);
972 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
974 $bookmarkService->addOrSet($bookmark, false);
976 // To preserve backward compatibility with 3rd parties, plugins still use arrays
977 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
978 $formatter = $factory->getFormatter('raw');
979 $data = $formatter->format($bookmark);
980 $pluginManager->executeHooks('save_link', $data);
982 $bookmark->fromArray($data);
983 $bookmarkService->set($bookmark);
985 // If we are called from the bookmarklet, we must close the popup:
986 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
987 echo '<script>self.close();</script>';
991 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
992 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
993 // Scroll to the link which has been edited.
994 $location .= '#' . $bookmark->getShortUrl();
995 // After saving the link, redirect to the page the user was on.
996 header('Location: '. $location);
1000 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1001 if ($targetPage == Router
::$PAGE_DELETELINK) {
1002 if (! $sessionManager->checkToken($_GET['token'])) {
1003 die(t('Wrong token.'));
1006 $ids = trim($_GET['lf_linkdate']);
1007 if (strpos($ids, ' ') !== false) {
1008 // multiple, space-separated ids provided
1009 $ids = array_values(array_filter(
1010 preg_split('/\s+/', escape($ids)),
1012 return $item !== '';
1016 // only a single id provided
1017 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1020 // assert at least one id is given
1022 die('no id provided');
1024 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1025 $formatter = $factory->getFormatter('raw');
1026 foreach ($ids as $id) {
1027 $id = (int) escape($id);
1028 $bookmark = $bookmarkService->get($id);
1029 $data = $formatter->format($bookmark);
1030 $pluginManager->executeHooks('delete_link', $data);
1031 $bookmarkService->remove($bookmark, false);
1033 $bookmarkService->save();
1035 // If we are called from the bookmarklet, we must close the popup:
1036 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1037 echo '<script>self.close();</script>';
1042 if (isset($_SERVER['HTTP_REFERER'])) {
1043 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1044 $location = generateLocation(
1045 $_SERVER['HTTP_REFERER'],
1046 $_SERVER['HTTP_HOST'],
1047 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1051 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1055 // -------- User clicked either "Set public" or "Set private" bulk operation
1056 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1057 if (! $sessionManager->checkToken($_GET['token'])) {
1058 die(t('Wrong token.'));
1061 $ids = trim($_GET['ids']);
1062 if (strpos($ids, ' ') !== false) {
1063 // multiple, space-separated ids provided
1064 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1066 // only a single id provided
1070 // assert at least one id is given
1072 die('no id provided');
1074 // assert that the visibility is valid
1075 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1076 die('invalid visibility');
1078 $private = $_GET['newVisibility'] === 'private';
1080 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1081 $formatter = $factory->getFormatter('raw');
1082 foreach ($ids as $id) {
1083 $id = (int) escape($id);
1084 $bookmark = $bookmarkService->get($id);
1085 $bookmark->setPrivate($private);
1087 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1088 $data = $formatter->format($bookmark);
1089 $pluginManager->executeHooks('save_link', $data);
1090 $bookmark->fromArray($data);
1092 $bookmarkService->set($bookmark);
1094 $bookmarkService->save();
1097 if (isset($_SERVER['HTTP_REFERER'])) {
1098 $location = generateLocation(
1099 $_SERVER['HTTP_REFERER'],
1100 $_SERVER['HTTP_HOST']
1103 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1107 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1108 if (isset($_GET['edit_link'])) {
1109 $id = (int) escape($_GET['edit_link']);
1111 $link = $bookmarkService->get($id); // Read database
1112 } catch (BookmarkNotFoundException
$e) {
1113 // Link not found in database.
1114 header('Location: ?');
1118 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1119 $formatter = $factory->getFormatter('raw');
1120 $formattedLink = $formatter->format($link);
1121 $tags = $bookmarkService->bookmarksCountPerTag();
1122 if ($conf->get('formatter') === 'markdown') {
1123 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1126 'link' => $formattedLink,
1127 'link_is_new' => false,
1128 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1131 $pluginManager->executeHooks('render_editlink', $data);
1133 foreach ($data as $key => $value) {
1134 $PAGE->assign($key, $value);
1137 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1138 $PAGE->renderPage('editlink');
1142 // -------- User want to post a new link: Display link edit form.
1143 if (isset($_GET['post'])) {
1144 $url = cleanup_url($_GET['post']);
1146 $link_is_new = false;
1147 // Check if URL is not already in database (in this case, we will edit the existing link)
1148 $bookmark = $bookmarkService->findByUrl($url);
1150 $link_is_new = true;
1151 // Get title if it was provided in URL (by the bookmarklet).
1152 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1153 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1154 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1155 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1156 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1158 // If this is an HTTP(S) link, we try go get the page to extract
1159 // the title (otherwise we will to straight to the edit form.)
1160 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1161 $retrieveDescription = $conf->get('general.retrieve_description');
1162 // Short timeout to keep the application responsive
1163 // The callback will fill $charset and $title with data from the downloaded page.
1166 $conf->get('general.download_timeout', 30),
1167 $conf->get('general.download_max_size', 4194304),
1168 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1170 if (! empty($title) && strtolower($charset) != 'utf-8') {
1171 $title = mb_convert_encoding($title, 'utf-8', $charset);
1176 $title = $conf->get('general.default_note_title', t('Note: '));
1178 $url = escape($url);
1179 $title = escape($title);
1184 'description' => $description,
1186 'private' => $private,
1189 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1190 $formatter = $factory->getFormatter('raw');
1191 $link = $formatter->format($bookmark);
1194 $tags = $bookmarkService->bookmarksCountPerTag();
1195 if ($conf->get('formatter') === 'markdown') {
1196 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1200 'link_is_new' => $link_is_new,
1201 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1202 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1204 'default_private_links' => $conf->get('privacy.default_private_links', false),
1206 $pluginManager->executeHooks('render_editlink', $data);
1208 foreach ($data as $key => $value) {
1209 $PAGE->assign($key, $value);
1212 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1213 $PAGE->renderPage('editlink');
1217 if ($targetPage == Router
::$PAGE_PINLINK) {
1218 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1219 // FIXME! Use a proper error system.
1220 $msg = t('Invalid link ID provided');
1221 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1224 if (! $sessionManager->checkToken($_GET['token'])) {
1225 die('Wrong token.');
1228 $link = $bookmarkService->get($_GET['id']);
1229 $link->setSticky(! $link->isSticky());
1230 $bookmarkService->set($link);
1231 header('Location: '.index_url($_SERVER));
1235 if ($targetPage == Router
::$PAGE_EXPORT) {
1236 // Export bookmarks as a Netscape Bookmarks file
1238 if (empty($_GET['selection'])) {
1239 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1240 $PAGE->renderPage('export');
1244 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1245 $selection = $_GET['selection'];
1246 if (isset($_GET['prepend_note_url'])) {
1247 $prependNoteUrl = $_GET['prepend_note_url'];
1249 $prependNoteUrl = false;
1253 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1254 $formatter = $factory->getFormatter('raw');
1257 NetscapeBookmarkUtils
::filterAndFormat(
1265 } catch (Exception
$exc) {
1266 header('Content-Type: text/plain; charset=utf-8');
1267 echo $exc->getMessage();
1270 $now = new DateTime();
1271 header('Content-Type: text/html; charset=utf-8');
1273 'Content-disposition: attachment; filename=bookmarks_'
1274 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1276 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1277 $PAGE->assign('eol', PHP_EOL
);
1278 $PAGE->assign('selection', $selection);
1279 $PAGE->renderPage('export.bookmarks');
1283 if ($targetPage == Router
::$PAGE_IMPORT) {
1284 // Upload a Netscape bookmark dump to import its contents
1286 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1287 // Show import dialog
1290 get_max_upload_size(
1291 ini_get('post_max_size'),
1292 ini_get('upload_max_filesize'),
1298 get_max_upload_size(
1299 ini_get('post_max_size'),
1300 ini_get('upload_max_filesize'),
1304 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1305 $PAGE->renderPage('import');
1309 // Import bookmarks from an uploaded file
1310 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1311 // The file is too big or some form field may be missing.
1314 'The file you are trying to upload is probably bigger than what this webserver can accept'
1315 .' (%s). Please upload in smaller chunks.'
1317 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1319 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1322 if (! $sessionManager->checkToken($_POST['token'])) {
1323 die('Wrong token.');
1325 $status = NetscapeBookmarkUtils
::import(
1332 echo '<script>alert("'.$status.'");document.location=\'./?do='
1333 .Router
::$PAGE_IMPORT .'\';</script>';
1337 // Plugin administration page
1338 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1339 $pluginMeta = $pluginManager->getPluginsMeta();
1341 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1342 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1343 return $v['order'] !== false;
1346 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1350 return $a['order'] - $b['order'];
1353 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1354 return $v['order'] === false;
1357 $PAGE->assign('enabledPlugins', $enabledPlugins);
1358 $PAGE->assign('disabledPlugins', $disabledPlugins);
1359 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1360 $PAGE->renderPage('pluginsadmin');
1364 // Plugin administration form action
1365 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1367 if (isset($_POST['parameters_form'])) {
1368 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1369 unset($_POST['parameters_form']);
1370 foreach ($_POST as $param => $value) {
1371 $conf->set('plugins.'. $param, escape($value));
1374 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1376 $conf->write($loginManager->isLoggedIn());
1377 $history->updateSettings();
1378 } catch (Exception
$e) {
1380 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1384 // TODO: do not handle exceptions/errors in JS.
1385 echo '<script>alert("'
1387 .'");document.location=\'./?do='
1388 . Router
::$PAGE_PLUGINSADMIN
1392 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1396 // Get a fresh token
1397 if ($targetPage == Router
::$GET_TOKEN) {
1398 header('Content-Type:text/plain');
1399 echo $sessionManager->generateToken();
1403 // -------- Thumbnails Update
1404 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1406 foreach ($bookmarkService->search() as $bookmark) {
1407 // A note or not HTTP(S)
1408 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1411 $ids[] = $bookmark->getId();
1413 $PAGE->assign('ids', $ids);
1414 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1415 $PAGE->renderPage('thumbnails');
1419 // -------- Single Thumbnail Update
1420 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1421 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1422 http_response_code(400);
1425 $id = (int) $_POST['id'];
1426 if (! $bookmarkService->exists($id)) {
1427 http_response_code(404);
1430 $thumbnailer = new Thumbnailer($conf);
1431 $bookmark = $bookmarkService->get($id);
1432 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1433 $bookmarkService->set($bookmark);
1435 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1436 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1440 // -------- Otherwise, simply display search form and bookmarks:
1441 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1446 * Template for the list of bookmarks (<div id="linklist">)
1447 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1449 * @param pageBuilder $PAGE pageBuilder instance.
1450 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1451 * @param ConfigManager $conf Configuration Manager instance.
1452 * @param PluginManager $pluginManager Plugin Manager instance.
1453 * @param LoginManager $loginManager LoginManager instance
1455 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1457 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1458 $formatter = $factory->getFormatter();
1460 // Used in templates
1461 if (isset($_GET['searchtags'])) {
1462 if (! empty($_GET['searchtags'])) {
1463 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1465 $searchtags = false;
1470 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1473 if (! empty($_SERVER['QUERY_STRING'])
1474 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1476 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1477 } catch (BookmarkNotFoundException
$e) {
1478 $PAGE->render404($e->getMessage());
1482 // Filter bookmarks according search parameters.
1483 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1485 'searchtags' => $searchtags,
1486 'searchterm' => $searchterm,
1488 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1491 // ---- Handle paging.
1493 foreach ($linksToDisplay as $key => $value) {
1497 // Select articles according to paging.
1498 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1499 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1500 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1501 $page = $page < 1 ? 1 : $page;
1502 $page = $page > $pagecount ? $pagecount : $page;
1504 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1505 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1507 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1508 if ($thumbnailsEnabled) {
1509 $thumbnailer = new Thumbnailer($conf);
1512 $linkDisp = array();
1513 while ($i<$end && $i<count($keys)) {
1514 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1516 // Logged in, thumbnails enabled, not a note,
1517 // and (never retrieved yet or no valid cache file)
1518 if ($loginManager->isLoggedIn()
1519 && $thumbnailsEnabled
1520 && !$linksToDisplay[$keys[$i]]->isNote()
1521 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1522 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1524 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1525 $linkDb->set($linksToDisplay[$keys[$i]], false);
1527 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1530 // Check for both signs of a note: starting with ? and 7 chars long.
1531 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1532 // $link['url'] = index_url($_SERVER) . $link['url'];
1535 $linkDisp[$keys[$i]] = $link;
1539 // If we retrieved new thumbnails, we update the database.
1540 if (!empty($updateDB)) {
1544 // Compute paging navigation
1545 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1546 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1547 $previous_page_url = '';
1548 if ($i != count($keys)) {
1549 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1553 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1556 // Fill all template fields.
1558 'previous_page_url' => $previous_page_url,
1559 'next_page_url' => $next_page_url,
1560 'page_current' => $page,
1561 'page_max' => $pagecount,
1562 'result_count' => count($linksToDisplay),
1563 'search_term' => $searchterm,
1564 'search_tags' => $searchtags,
1565 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1566 'links' => $linkDisp,
1569 // If there is only a single link, we change on-the-fly the title of the page.
1570 if (count($linksToDisplay) == 1) {
1571 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1572 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1573 $data['pagetitle'] = t('Search: ');
1574 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1575 $bracketWrap = function ($tag) {
1576 return '['. $tag .']';
1578 $data['pagetitle'] .= ! empty($searchtags)
1579 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1581 $data['pagetitle'] .= '- '. $conf->get('general.title');
1584 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1586 foreach ($data as $key => $value) {
1587 $PAGE->assign($key, $value);
1595 * This function should NEVER be called if the file data/config.php exists.
1597 * @param ConfigManager $conf Configuration Manager instance.
1598 * @param SessionManager $sessionManager SessionManager instance
1599 * @param LoginManager $loginManager LoginManager instance
1601 function install($conf, $sessionManager, $loginManager)
1603 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1604 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1605 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1609 // This part makes sure sessions works correctly.
1610 // (Because on some hosts, session.save_path may not be set correctly,
1611 // or we may not have write access to it.)
1612 if (isset($_GET['test_session'])
1613 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1614 // Step 2: Check if data in session is correct.
1616 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1617 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1618 'and that you have write access to it.<br>'.
1619 'It currently points to %s.<br>'.
1620 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1621 'or any custom hostname without a dot causes cookie storage to fail. '.
1622 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1624 $msg = sprintf($msg, session_save_path());
1626 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1629 if (!isset($_SESSION['session_tested'])) {
1630 // Step 1 : Try to store data in session and reload page.
1631 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1632 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1634 if (isset($_GET['test_session'])) {
1635 // Step 3: Sessions are OK. Remove test parameter from URL.
1636 header('Location: '.index_url($_SERVER));
1640 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1642 if (!empty($_POST['continent']) && !empty($_POST['city'])
1643 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1645 $tz = $_POST['continent'].'/'.$_POST['city'];
1647 $conf->set('general.timezone', $tz);
1648 $login = $_POST['setlogin'];
1649 $conf->set('credentials.login', $login);
1650 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1651 $conf->set('credentials.salt', $salt);
1652 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1653 if (!empty($_POST['title'])) {
1654 $conf->set('general.title', escape($_POST['title']));
1656 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1658 $conf->set('translation.language', escape($_POST['language']));
1659 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1660 $conf->set('api.enabled', !empty($_POST['enableApi']));
1663 generate_api_secret(
1664 $conf->get('credentials.login'),
1665 $conf->get('credentials.salt')
1669 // Everything is ok, let's create config file.
1670 $conf->write($loginManager->isLoggedIn());
1671 } catch (Exception
$e) {
1673 'ERROR while writing config file after installation.' . PHP_EOL
.
1677 // TODO: do not handle exceptions/errors in JS.
1678 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1682 $history = new History($conf->get('resource.history'));
1683 $bookmarkService = new BookmarkFileService($conf, $history, true);
1684 if ($bookmarkService->count() === 0) {
1685 $bookmarkService->initialize();
1688 echo '<script>alert('
1689 .'"Shaarli is now configured. '
1690 .'Please enter your login/password and start shaaring your bookmarks!"'
1691 .');document.location=\'./login\';</script>';
1695 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1696 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1697 $PAGE->assign('continents', $continents);
1698 $PAGE->assign('cities', $cities);
1699 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1700 $PAGE->renderPage('install');
1704 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1705 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1709 $history = new History($conf->get('resource.history'));
1710 } catch (Exception
$e) {
1711 die($e->getMessage());
1714 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1716 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1717 showDailyRSS($linkDb, $conf, $loginManager);
1721 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1722 $container = $containerBuilder->build();
1723 $app = new App($container);
1726 $app->group('/api/v1', function () {
1727 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1728 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1729 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1730 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1731 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1732 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1734 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1735 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1736 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1737 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1739 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1740 })->add('\Shaarli\Api\ApiMiddleware');
1742 $app->group('', function () {
1743 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1744 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1745 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1746 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:cloud')->setName('tagcloud');
1747 $this->get('/tag-list', '\Shaarli\Front\Controller\TagCloudController:list')->setName('taglist');
1748 $this->get('/daily', '\Shaarli\Front\Controller\DailyController:index')->setName('daily');
1750 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1751 })->add('\Shaarli\Front\ShaarliMiddleware');
1753 $response = $app->run(true);
1755 // Hack to make Slim and Shaarli router work together:
1756 // If a Slim route isn't found and NOT API call, we call renderPage().
1757 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1758 // We use UTF-8 for proper international characters handling.
1759 header('Content-Type: text/html; charset=utf-8');
1760 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1762 $response = $response
1763 ->withHeader('Access-Control-Allow-Origin', '*')
1765 'Access-Control-Allow-Headers',
1766 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1768 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1769 $app->respond($response);