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 * Renders the linklist
306 * @param pageBuilder $PAGE pageBuilder instance.
307 * @param BookmarkServiceInterface $linkDb instance.
308 * @param ConfigManager $conf Configuration Manager instance.
309 * @param PluginManager $pluginManager Plugin Manager instance.
311 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
313 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
314 $PAGE->renderPage('linklist');
318 * Render HTML page (according to URL parameters and user rights)
320 * @param ConfigManager $conf Configuration Manager instance.
321 * @param PluginManager $pluginManager Plugin Manager instance,
322 * @param BookmarkServiceInterface $bookmarkService
323 * @param History $history instance
324 * @param SessionManager $sessionManager SessionManager instance
325 * @param LoginManager $loginManager LoginManager instance
327 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
329 $pageCacheManager = new PageCacheManager($conf->get('resource.page_cache'), $loginManager->isLoggedIn());
330 $updater = new Updater(
331 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
334 $loginManager->isLoggedIn()
337 $newUpdates = $updater->update();
338 if (! empty($newUpdates)) {
339 UpdaterUtils
::write_updates_file(
340 $conf->get('resource.updates'),
341 $updater->getDoneUpdates()
344 $pageCacheManager->invalidateCaches();
346 } catch (Exception
$e) {
347 die($e->getMessage());
350 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
351 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
352 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
353 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
355 // Determine which page will be rendered.
356 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
357 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
359 if (// if the user isn't logged in
360 !$loginManager->isLoggedIn() &&
361 // and Shaarli doesn't have public content...
362 $conf->get('privacy.hide_public_links') &&
363 // and is configured to enforce the login
364 $conf->get('privacy.force_login') &&
365 // and the current page isn't already the login page
366 $targetPage !== Router
::$PAGE_LOGIN &&
367 // and the user is not requesting a feed (which would lead to a different content-type as expected)
368 $targetPage !== Router
::$PAGE_FEED_ATOM &&
369 $targetPage !== Router
::$PAGE_FEED_RSS
371 // force current page to be the login page
372 $targetPage = Router
::$PAGE_LOGIN;
375 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
376 // Then assign generated data to RainTPL.
377 $common_hooks = array(
383 foreach ($common_hooks as $name) {
384 $plugin_data = array();
385 $pluginManager->executeHooks(
389 'target' => $targetPage,
390 'loggedin' => $loginManager->isLoggedIn()
393 $PAGE->assign('plugins_' . $name, $plugin_data);
396 // -------- Display login form.
397 if ($targetPage == Router
::$PAGE_LOGIN) {
398 header('Location: ./login');
401 // -------- User wants to logout.
402 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
403 header('Location: ./logout');
407 // -------- Picture wall
408 if ($targetPage == Router
::$PAGE_PICWALL) {
409 header('Location: ./picture-wall');
413 // -------- Tag cloud
414 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
415 header('Location: ./tag-cloud');
420 if ($targetPage == Router
::$PAGE_TAGLIST) {
421 header('Location: ./tag-list');
426 if ($targetPage == Router
::$PAGE_DAILY) {
427 $dayParam = !empty($_GET['day']) ? '?day=' . escape($_GET['day']) : '';
428 header('Location: ./daily'. $dayParam);
432 // ATOM and RSS feed.
433 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
434 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
435 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
438 $query = $_SERVER['QUERY_STRING'];
439 $cache = new CachedPage(
440 $conf->get('resource.page_cache'),
442 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
444 $cached = $cache->cachedVersion();
445 if (!empty($cached)) {
450 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
452 $feedGenerator = new FeedBuilder(
454 $factory->getFormatter(),
456 $loginManager->isLoggedIn()
458 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
459 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
460 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
461 $data = $feedGenerator->buildData($feedType, $_GET);
463 // Process plugin hook.
464 $pluginManager->executeHooks('render_feed', $data, array(
465 'loggedin' => $loginManager->isLoggedIn(),
466 'target' => $targetPage,
469 // Render the template.
470 $PAGE->assignAll($data);
471 $PAGE->renderPage('feed.'. $feedType);
472 $cache->cache(ob_get_contents());
477 // Display opensearch plugin (XML)
478 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
479 header('Content-Type: application/xml; charset=utf-8');
480 $PAGE->assign('serverurl', index_url($_SERVER));
481 $PAGE->renderPage('opensearch');
485 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
486 if (isset($_GET['addtag'])) {
487 header('Location: ./add-tag/'. $_GET['addtag']);
491 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
492 if (isset($_GET['removetag'])) {
493 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
494 if (empty($_SERVER['HTTP_REFERER'])) {
495 header('Location: ?');
499 // In case browser does not send HTTP_REFERER
500 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
502 // Prevent redirection loop
503 if (isset($params['removetag'])) {
504 unset($params['removetag']);
507 if (isset($params['searchtags'])) {
508 $tags = explode(' ', $params['searchtags']);
509 // Remove value from array $tags.
510 $tags = array_diff($tags, array($_GET['removetag']));
511 $params['searchtags'] = implode(' ', $tags);
513 if (empty($params['searchtags'])) {
514 unset($params['searchtags']);
517 // We also remove page (keeping the same page has no sense, since
518 // the results are different)
519 unset($params['page']);
521 header('Location: ?'.http_build_query($params));
525 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
526 if (isset($_GET['linksperpage'])) {
527 if (is_numeric($_GET['linksperpage'])) {
528 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
531 if (! empty($_SERVER['HTTP_REFERER'])) {
532 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
536 header('Location: '. $location);
540 // -------- User wants to see only private bookmarks (toggle)
541 if (isset($_GET['visibility'])) {
542 if ($_GET['visibility'] === 'private') {
543 // Visibility not set or not already private, set private, otherwise reset it
544 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
545 // See only private bookmarks
546 $_SESSION['visibility'] = 'private';
548 unset($_SESSION['visibility']);
550 } elseif ($_GET['visibility'] === 'public') {
551 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
552 // See only public bookmarks
553 $_SESSION['visibility'] = 'public';
555 unset($_SESSION['visibility']);
559 if (! empty($_SERVER['HTTP_REFERER'])) {
560 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
564 header('Location: '. $location);
568 // -------- User wants to see only untagged bookmarks (toggle)
569 if (isset($_GET['untaggedonly'])) {
570 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
572 if (! empty($_SERVER['HTTP_REFERER'])) {
573 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
577 header('Location: '. $location);
581 // -------- Handle other actions allowed for non-logged in users:
582 if (!$loginManager->isLoggedIn()) {
583 // User tries to post new link but is not logged in:
584 // Show login screen, then redirect to ?post=...
585 if (isset($_GET['post'])) {
586 header( // Redirect to login page, then back to post link.
587 'Location: ./login?post='.urlencode($_GET['post']).
588 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
589 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
590 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
591 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
596 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
597 if (isset($_GET['edit_link'])) {
598 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
602 exit; // Never remove this one! All operations below are reserved for logged in user.
605 // -------- All other functions are reserved for the registered user:
607 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
608 if ($targetPage == Router
::$PAGE_TOOLS) {
610 'pageabsaddr' => index_url($_SERVER),
611 'sslenabled' => is_https($_SERVER),
613 $pluginManager->executeHooks('render_tools', $data);
615 foreach ($data as $key => $value) {
616 $PAGE->assign($key, $value);
619 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
620 $PAGE->renderPage('tools');
624 // -------- User wants to change his/her password.
625 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
626 if ($conf->get('security.open_shaarli')) {
627 die(t('You are not supposed to change a password on an Open Shaarli.'));
630 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
631 if (!$sessionManager->checkToken($_POST['token'])) {
632 die(t('Wrong token.')); // Go away!
635 // Make sure old password is correct.
637 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
639 if ($oldhash != $conf->get('credentials.hash')) {
640 echo '<script>alert("'
641 . t('The old password is not correct.')
642 .'");document.location=\'./?do=changepasswd\';</script>';
646 // Salt renders rainbow-tables attacks useless.
647 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
651 $_POST['setpassword']
652 . $conf->get('credentials.login')
653 . $conf->get('credentials.salt')
657 $conf->write($loginManager->isLoggedIn());
658 } catch (Exception
$e) {
660 'ERROR while writing config file after changing password.' . PHP_EOL
.
664 // TODO: do not handle exceptions/errors in JS.
665 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
668 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
671 // show the change password form.
672 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
673 $PAGE->renderPage('changepassword');
678 // -------- User wants to change configuration
679 if ($targetPage == Router
::$PAGE_CONFIGURE) {
680 if (!empty($_POST['title'])) {
681 if (!$sessionManager->checkToken($_POST['token'])) {
682 die(t('Wrong token.')); // Go away!
685 if (!empty($_POST['continent']) && !empty($_POST['city'])
686 && isTimeZoneValid($_POST['continent'], $_POST['city'])
688 $tz = $_POST['continent'] . '/' . $_POST['city'];
690 $conf->set('general.timezone', $tz);
691 $conf->set('general.title', escape($_POST['title']));
692 $conf->set('general.header_link', escape($_POST['titleLink']));
693 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
694 $conf->set('resource.theme', escape($_POST['theme']));
695 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
696 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
697 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
698 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
699 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
700 $conf->set('api.enabled', !empty($_POST['enableApi']));
701 $conf->set('api.secret', escape($_POST['apiSecret']));
702 $conf->set('formatter', escape($_POST['formatter']));
704 if (! empty($_POST['language'])) {
705 $conf->set('translation.language', escape($_POST['language']));
708 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
709 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
710 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
712 $_SESSION['warnings'][] = t(
713 'You have enabled or changed thumbnails mode. '
714 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
717 $conf->set('thumbnails.mode', $thumbnailsMode);
720 $conf->write($loginManager->isLoggedIn());
721 $history->updateSettings();
722 $pageCacheManager->invalidateCaches();
723 } catch (Exception
$e) {
725 'ERROR while writing config file after configuration update.' . PHP_EOL
.
729 // TODO: do not handle exceptions/errors in JS.
730 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
733 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
736 // Show the configuration form.
737 $PAGE->assign('title', $conf->get('general.title'));
738 $PAGE->assign('theme', $conf->get('resource.theme'));
739 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
740 $PAGE->assign('formatter_available', ['default', 'markdown']);
741 list($continents, $cities) = generateTimeZoneData(
742 timezone_identifiers_list(),
743 $conf->get('general.timezone')
745 $PAGE->assign('continents', $continents);
746 $PAGE->assign('cities', $cities);
747 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
748 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
749 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
750 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
751 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
752 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
753 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
754 $PAGE->assign('api_secret', $conf->get('api.secret'));
755 $PAGE->assign('languages', Languages
::getAvailableLanguages());
756 $PAGE->assign('gd_enabled', extension_loaded('gd'));
757 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
758 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
759 $PAGE->renderPage('configure');
764 // -------- User wants to rename a tag or delete it
765 if ($targetPage == Router
::$PAGE_CHANGETAG) {
766 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
767 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
768 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
769 $PAGE->renderPage('changetag');
773 if (!$sessionManager->checkToken($_POST['token'])) {
774 die(t('Wrong token.'));
777 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
778 $fromTag = escape($_POST['fromtag']);
780 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
781 foreach ($bookmarks as $bookmark) {
783 $bookmark->renameTag($fromTag, $toTag);
785 $bookmark->deleteTag($fromTag);
787 $bookmarkService->set($bookmark, false);
788 $history->updateLink($bookmark);
791 $bookmarkService->save();
792 $delete = empty($_POST['totag']);
793 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
795 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
796 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
797 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
801 // -------- User wants to add a link without using the bookmarklet: Show form.
802 if ($targetPage == Router
::$PAGE_ADDLINK) {
803 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
804 $PAGE->renderPage('addlink');
808 // -------- User clicked the "Save" button when editing a link: Save link to database.
809 if (isset($_POST['save_edit'])) {
811 if (! $sessionManager->checkToken($_POST['token'])) {
812 die(t('Wrong token.'));
815 // lf_id should only be present if the link exists.
816 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
817 if ($id && $bookmarkService->exists($id)) {
819 $bookmark = $bookmarkService->get($id);
822 $bookmark = new Bookmark();
825 $bookmark->setTitle($_POST['lf_title']);
826 $bookmark->setDescription($_POST['lf_description']);
827 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
828 $bookmark->setPrivate(isset($_POST['lf_private']));
829 $bookmark->setTagsString($_POST['lf_tags']);
831 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
832 && ! $bookmark->isNote()
834 $thumbnailer = new Thumbnailer($conf);
835 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
837 $bookmarkService->addOrSet($bookmark, false);
839 // To preserve backward compatibility with 3rd parties, plugins still use arrays
840 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
841 $formatter = $factory->getFormatter('raw');
842 $data = $formatter->format($bookmark);
843 $pluginManager->executeHooks('save_link', $data);
845 $bookmark->fromArray($data);
846 $bookmarkService->set($bookmark);
848 // If we are called from the bookmarklet, we must close the popup:
849 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
850 echo '<script>self.close();</script>';
854 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
855 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
856 // Scroll to the link which has been edited.
857 $location .= '#' . $bookmark->getShortUrl();
858 // After saving the link, redirect to the page the user was on.
859 header('Location: '. $location);
863 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
864 if ($targetPage == Router
::$PAGE_DELETELINK) {
865 if (! $sessionManager->checkToken($_GET['token'])) {
866 die(t('Wrong token.'));
869 $ids = trim($_GET['lf_linkdate']);
870 if (strpos($ids, ' ') !== false) {
871 // multiple, space-separated ids provided
872 $ids = array_values(array_filter(
873 preg_split('/\s+/', escape($ids)),
879 // only a single id provided
880 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
883 // assert at least one id is given
885 die('no id provided');
887 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
888 $formatter = $factory->getFormatter('raw');
889 foreach ($ids as $id) {
890 $id = (int) escape($id);
891 $bookmark = $bookmarkService->get($id);
892 $data = $formatter->format($bookmark);
893 $pluginManager->executeHooks('delete_link', $data);
894 $bookmarkService->remove($bookmark, false);
896 $bookmarkService->save();
898 // If we are called from the bookmarklet, we must close the popup:
899 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
900 echo '<script>self.close();</script>';
905 if (isset($_SERVER['HTTP_REFERER'])) {
906 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
907 $location = generateLocation(
908 $_SERVER['HTTP_REFERER'],
909 $_SERVER['HTTP_HOST'],
910 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
914 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
918 // -------- User clicked either "Set public" or "Set private" bulk operation
919 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
920 if (! $sessionManager->checkToken($_GET['token'])) {
921 die(t('Wrong token.'));
924 $ids = trim($_GET['ids']);
925 if (strpos($ids, ' ') !== false) {
926 // multiple, space-separated ids provided
927 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
929 // only a single id provided
933 // assert at least one id is given
935 die('no id provided');
937 // assert that the visibility is valid
938 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
939 die('invalid visibility');
941 $private = $_GET['newVisibility'] === 'private';
943 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
944 $formatter = $factory->getFormatter('raw');
945 foreach ($ids as $id) {
946 $id = (int) escape($id);
947 $bookmark = $bookmarkService->get($id);
948 $bookmark->setPrivate($private);
950 // To preserve backward compatibility with 3rd parties, plugins still use arrays
951 $data = $formatter->format($bookmark);
952 $pluginManager->executeHooks('save_link', $data);
953 $bookmark->fromArray($data);
955 $bookmarkService->set($bookmark);
957 $bookmarkService->save();
960 if (isset($_SERVER['HTTP_REFERER'])) {
961 $location = generateLocation(
962 $_SERVER['HTTP_REFERER'],
963 $_SERVER['HTTP_HOST']
966 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
970 // -------- User clicked the "EDIT" button on a link: Display link edit form.
971 if (isset($_GET['edit_link'])) {
972 $id = (int) escape($_GET['edit_link']);
974 $link = $bookmarkService->get($id); // Read database
975 } catch (BookmarkNotFoundException
$e) {
976 // Link not found in database.
977 header('Location: ?');
981 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
982 $formatter = $factory->getFormatter('raw');
983 $formattedLink = $formatter->format($link);
984 $tags = $bookmarkService->bookmarksCountPerTag();
985 if ($conf->get('formatter') === 'markdown') {
986 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
989 'link' => $formattedLink,
990 'link_is_new' => false,
991 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
994 $pluginManager->executeHooks('render_editlink', $data);
996 foreach ($data as $key => $value) {
997 $PAGE->assign($key, $value);
1000 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1001 $PAGE->renderPage('editlink');
1005 // -------- User want to post a new link: Display link edit form.
1006 if (isset($_GET['post'])) {
1007 $url = cleanup_url($_GET['post']);
1009 $link_is_new = false;
1010 // Check if URL is not already in database (in this case, we will edit the existing link)
1011 $bookmark = $bookmarkService->findByUrl($url);
1013 $link_is_new = true;
1014 // Get title if it was provided in URL (by the bookmarklet).
1015 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1016 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1017 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1018 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1019 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1021 // If this is an HTTP(S) link, we try go get the page to extract
1022 // the title (otherwise we will to straight to the edit form.)
1023 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1024 $retrieveDescription = $conf->get('general.retrieve_description');
1025 // Short timeout to keep the application responsive
1026 // The callback will fill $charset and $title with data from the downloaded page.
1029 $conf->get('general.download_timeout', 30),
1030 $conf->get('general.download_max_size', 4194304),
1031 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1033 if (! empty($title) && strtolower($charset) != 'utf-8') {
1034 $title = mb_convert_encoding($title, 'utf-8', $charset);
1039 $title = $conf->get('general.default_note_title', t('Note: '));
1041 $url = escape($url);
1042 $title = escape($title);
1047 'description' => $description,
1049 'private' => $private,
1052 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1053 $formatter = $factory->getFormatter('raw');
1054 $link = $formatter->format($bookmark);
1057 $tags = $bookmarkService->bookmarksCountPerTag();
1058 if ($conf->get('formatter') === 'markdown') {
1059 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1063 'link_is_new' => $link_is_new,
1064 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1065 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1067 'default_private_links' => $conf->get('privacy.default_private_links', false),
1069 $pluginManager->executeHooks('render_editlink', $data);
1071 foreach ($data as $key => $value) {
1072 $PAGE->assign($key, $value);
1075 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1076 $PAGE->renderPage('editlink');
1080 if ($targetPage == Router
::$PAGE_PINLINK) {
1081 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1082 // FIXME! Use a proper error system.
1083 $msg = t('Invalid link ID provided');
1084 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1087 if (! $sessionManager->checkToken($_GET['token'])) {
1088 die('Wrong token.');
1091 $link = $bookmarkService->get($_GET['id']);
1092 $link->setSticky(! $link->isSticky());
1093 $bookmarkService->set($link);
1094 header('Location: '.index_url($_SERVER));
1098 if ($targetPage == Router
::$PAGE_EXPORT) {
1099 // Export bookmarks as a Netscape Bookmarks file
1101 if (empty($_GET['selection'])) {
1102 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1103 $PAGE->renderPage('export');
1107 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1108 $selection = $_GET['selection'];
1109 if (isset($_GET['prepend_note_url'])) {
1110 $prependNoteUrl = $_GET['prepend_note_url'];
1112 $prependNoteUrl = false;
1116 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1117 $formatter = $factory->getFormatter('raw');
1120 NetscapeBookmarkUtils
::filterAndFormat(
1128 } catch (Exception
$exc) {
1129 header('Content-Type: text/plain; charset=utf-8');
1130 echo $exc->getMessage();
1133 $now = new DateTime();
1134 header('Content-Type: text/html; charset=utf-8');
1136 'Content-disposition: attachment; filename=bookmarks_'
1137 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1139 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1140 $PAGE->assign('eol', PHP_EOL
);
1141 $PAGE->assign('selection', $selection);
1142 $PAGE->renderPage('export.bookmarks');
1146 if ($targetPage == Router
::$PAGE_IMPORT) {
1147 // Upload a Netscape bookmark dump to import its contents
1149 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1150 // Show import dialog
1153 get_max_upload_size(
1154 ini_get('post_max_size'),
1155 ini_get('upload_max_filesize'),
1161 get_max_upload_size(
1162 ini_get('post_max_size'),
1163 ini_get('upload_max_filesize'),
1167 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1168 $PAGE->renderPage('import');
1172 // Import bookmarks from an uploaded file
1173 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1174 // The file is too big or some form field may be missing.
1177 'The file you are trying to upload is probably bigger than what this webserver can accept'
1178 .' (%s). Please upload in smaller chunks.'
1180 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1182 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1185 if (! $sessionManager->checkToken($_POST['token'])) {
1186 die('Wrong token.');
1188 $status = NetscapeBookmarkUtils
::import(
1195 echo '<script>alert("'.$status.'");document.location=\'./?do='
1196 .Router
::$PAGE_IMPORT .'\';</script>';
1200 // Plugin administration page
1201 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1202 $pluginMeta = $pluginManager->getPluginsMeta();
1204 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1205 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1206 return $v['order'] !== false;
1209 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1213 return $a['order'] - $b['order'];
1216 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1217 return $v['order'] === false;
1220 $PAGE->assign('enabledPlugins', $enabledPlugins);
1221 $PAGE->assign('disabledPlugins', $disabledPlugins);
1222 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1223 $PAGE->renderPage('pluginsadmin');
1227 // Plugin administration form action
1228 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1230 if (isset($_POST['parameters_form'])) {
1231 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1232 unset($_POST['parameters_form']);
1233 foreach ($_POST as $param => $value) {
1234 $conf->set('plugins.'. $param, escape($value));
1237 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1239 $conf->write($loginManager->isLoggedIn());
1240 $history->updateSettings();
1241 } catch (Exception
$e) {
1243 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1247 // TODO: do not handle exceptions/errors in JS.
1248 echo '<script>alert("'
1250 .'");document.location=\'./?do='
1251 . Router
::$PAGE_PLUGINSADMIN
1255 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1259 // Get a fresh token
1260 if ($targetPage == Router
::$GET_TOKEN) {
1261 header('Content-Type:text/plain');
1262 echo $sessionManager->generateToken();
1266 // -------- Thumbnails Update
1267 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1269 foreach ($bookmarkService->search() as $bookmark) {
1270 // A note or not HTTP(S)
1271 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1274 $ids[] = $bookmark->getId();
1276 $PAGE->assign('ids', $ids);
1277 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1278 $PAGE->renderPage('thumbnails');
1282 // -------- Single Thumbnail Update
1283 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1284 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1285 http_response_code(400);
1288 $id = (int) $_POST['id'];
1289 if (! $bookmarkService->exists($id)) {
1290 http_response_code(404);
1293 $thumbnailer = new Thumbnailer($conf);
1294 $bookmark = $bookmarkService->get($id);
1295 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1296 $bookmarkService->set($bookmark);
1298 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1299 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1303 // -------- Otherwise, simply display search form and bookmarks:
1304 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1309 * Template for the list of bookmarks (<div id="linklist">)
1310 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1312 * @param pageBuilder $PAGE pageBuilder instance.
1313 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1314 * @param ConfigManager $conf Configuration Manager instance.
1315 * @param PluginManager $pluginManager Plugin Manager instance.
1316 * @param LoginManager $loginManager LoginManager instance
1318 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1320 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1321 $formatter = $factory->getFormatter();
1323 // Used in templates
1324 if (isset($_GET['searchtags'])) {
1325 if (! empty($_GET['searchtags'])) {
1326 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1328 $searchtags = false;
1333 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1336 if (! empty($_SERVER['QUERY_STRING'])
1337 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1339 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1340 } catch (BookmarkNotFoundException
$e) {
1341 $PAGE->render404($e->getMessage());
1345 // Filter bookmarks according search parameters.
1346 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1348 'searchtags' => $searchtags,
1349 'searchterm' => $searchterm,
1351 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1354 // ---- Handle paging.
1356 foreach ($linksToDisplay as $key => $value) {
1360 // Select articles according to paging.
1361 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1362 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1363 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1364 $page = $page < 1 ? 1 : $page;
1365 $page = $page > $pagecount ? $pagecount : $page;
1367 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1368 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1370 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1371 if ($thumbnailsEnabled) {
1372 $thumbnailer = new Thumbnailer($conf);
1375 $linkDisp = array();
1376 while ($i<$end && $i<count($keys)) {
1377 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1379 // Logged in, thumbnails enabled, not a note,
1380 // and (never retrieved yet or no valid cache file)
1381 if ($loginManager->isLoggedIn()
1382 && $thumbnailsEnabled
1383 && !$linksToDisplay[$keys[$i]]->isNote()
1384 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1385 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1387 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1388 $linkDb->set($linksToDisplay[$keys[$i]], false);
1390 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1393 // Check for both signs of a note: starting with ? and 7 chars long.
1394 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1395 // $link['url'] = index_url($_SERVER) . $link['url'];
1398 $linkDisp[$keys[$i]] = $link;
1402 // If we retrieved new thumbnails, we update the database.
1403 if (!empty($updateDB)) {
1407 // Compute paging navigation
1408 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1409 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1410 $previous_page_url = '';
1411 if ($i != count($keys)) {
1412 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1416 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1419 // Fill all template fields.
1421 'previous_page_url' => $previous_page_url,
1422 'next_page_url' => $next_page_url,
1423 'page_current' => $page,
1424 'page_max' => $pagecount,
1425 'result_count' => count($linksToDisplay),
1426 'search_term' => $searchterm,
1427 'search_tags' => $searchtags,
1428 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1429 'links' => $linkDisp,
1432 // If there is only a single link, we change on-the-fly the title of the page.
1433 if (count($linksToDisplay) == 1) {
1434 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1435 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1436 $data['pagetitle'] = t('Search: ');
1437 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1438 $bracketWrap = function ($tag) {
1439 return '['. $tag .']';
1441 $data['pagetitle'] .= ! empty($searchtags)
1442 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1444 $data['pagetitle'] .= '- '. $conf->get('general.title');
1447 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1449 foreach ($data as $key => $value) {
1450 $PAGE->assign($key, $value);
1458 * This function should NEVER be called if the file data/config.php exists.
1460 * @param ConfigManager $conf Configuration Manager instance.
1461 * @param SessionManager $sessionManager SessionManager instance
1462 * @param LoginManager $loginManager LoginManager instance
1464 function install($conf, $sessionManager, $loginManager)
1466 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1467 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1468 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1472 // This part makes sure sessions works correctly.
1473 // (Because on some hosts, session.save_path may not be set correctly,
1474 // or we may not have write access to it.)
1475 if (isset($_GET['test_session'])
1476 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1477 // Step 2: Check if data in session is correct.
1479 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1480 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1481 'and that you have write access to it.<br>'.
1482 'It currently points to %s.<br>'.
1483 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1484 'or any custom hostname without a dot causes cookie storage to fail. '.
1485 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1487 $msg = sprintf($msg, session_save_path());
1489 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1492 if (!isset($_SESSION['session_tested'])) {
1493 // Step 1 : Try to store data in session and reload page.
1494 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1495 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1497 if (isset($_GET['test_session'])) {
1498 // Step 3: Sessions are OK. Remove test parameter from URL.
1499 header('Location: '.index_url($_SERVER));
1503 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1505 if (!empty($_POST['continent']) && !empty($_POST['city'])
1506 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1508 $tz = $_POST['continent'].'/'.$_POST['city'];
1510 $conf->set('general.timezone', $tz);
1511 $login = $_POST['setlogin'];
1512 $conf->set('credentials.login', $login);
1513 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1514 $conf->set('credentials.salt', $salt);
1515 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1516 if (!empty($_POST['title'])) {
1517 $conf->set('general.title', escape($_POST['title']));
1519 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1521 $conf->set('translation.language', escape($_POST['language']));
1522 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1523 $conf->set('api.enabled', !empty($_POST['enableApi']));
1526 generate_api_secret(
1527 $conf->get('credentials.login'),
1528 $conf->get('credentials.salt')
1532 // Everything is ok, let's create config file.
1533 $conf->write($loginManager->isLoggedIn());
1534 } catch (Exception
$e) {
1536 'ERROR while writing config file after installation.' . PHP_EOL
.
1540 // TODO: do not handle exceptions/errors in JS.
1541 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1545 $history = new History($conf->get('resource.history'));
1546 $bookmarkService = new BookmarkFileService($conf, $history, true);
1547 if ($bookmarkService->count() === 0) {
1548 $bookmarkService->initialize();
1551 echo '<script>alert('
1552 .'"Shaarli is now configured. '
1553 .'Please enter your login/password and start shaaring your bookmarks!"'
1554 .');document.location=\'./login\';</script>';
1558 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1559 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1560 $PAGE->assign('continents', $continents);
1561 $PAGE->assign('cities', $cities);
1562 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1563 $PAGE->renderPage('install');
1567 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1568 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1572 $history = new History($conf->get('resource.history'));
1573 } catch (Exception
$e) {
1574 die($e->getMessage());
1577 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1579 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1580 header('Location: ./daily-rss');
1584 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1585 $container = $containerBuilder->build();
1586 $app = new App($container);
1589 $app->group('/api/v1', function () {
1590 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1591 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1592 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1593 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1594 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1595 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1597 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1598 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1599 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1600 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1602 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1603 })->add('\Shaarli\Api\ApiMiddleware');
1605 $app->group('', function () {
1606 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1607 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1608 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1609 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:cloud')->setName('tagcloud');
1610 $this->get('/tag-list', '\Shaarli\Front\Controller\TagCloudController:list')->setName('taglist');
1611 $this->get('/daily', '\Shaarli\Front\Controller\DailyController:index')->setName('daily');
1612 $this->get('/daily-rss', '\Shaarli\Front\Controller\DailyController:rss')->setName('dailyrss');
1614 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1615 })->add('\Shaarli\Front\ShaarliMiddleware');
1617 $response = $app->run(true);
1619 // Hack to make Slim and Shaarli router work together:
1620 // If a Slim route isn't found and NOT API call, we call renderPage().
1621 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1622 // We use UTF-8 for proper international characters handling.
1623 header('Content-Type: text/html; charset=utf-8');
1624 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1626 $response = $response
1627 ->withHeader('Access-Control-Allow-Origin', '*')
1629 'Access-Control-Allow-Headers',
1630 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1632 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1633 $app->respond($response);