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(),
458 $loginManager->isLoggedIn()
460 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
461 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
462 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
463 $data = $feedGenerator->buildData();
465 // Process plugin hook.
466 $pluginManager->executeHooks('render_feed', $data, array(
467 'loggedin' => $loginManager->isLoggedIn(),
468 'target' => $targetPage,
471 // Render the template.
472 $PAGE->assignAll($data);
473 $PAGE->renderPage('feed.'. $feedType);
474 $cache->cache(ob_get_contents());
479 // Display opensearch plugin (XML)
480 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
481 header('Content-Type: application/xml; charset=utf-8');
482 $PAGE->assign('serverurl', index_url($_SERVER));
483 $PAGE->renderPage('opensearch');
487 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
488 if (isset($_GET['addtag'])) {
489 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
490 if (empty($_SERVER['HTTP_REFERER'])) {
491 // In case browser does not send HTTP_REFERER
492 header('Location: ?searchtags='.urlencode($_GET['addtag']));
495 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
497 // Prevent redirection loop
498 if (isset($params['addtag'])) {
499 unset($params['addtag']);
502 // Check if this tag is already in the search query and ignore it if it is.
503 // Each tag is always separated by a space
504 if (isset($params['searchtags'])) {
505 $current_tags = explode(' ', $params['searchtags']);
507 $current_tags = array();
510 foreach ($current_tags as $value) {
511 if ($value === $_GET['addtag']) {
516 // Append the tag if necessary
517 if (empty($params['searchtags'])) {
518 $params['searchtags'] = trim($_GET['addtag']);
520 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
523 // We also remove page (keeping the same page has no sense, since the
524 // results are different)
525 unset($params['page']);
527 header('Location: ?'.http_build_query($params));
531 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
532 if (isset($_GET['removetag'])) {
533 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
534 if (empty($_SERVER['HTTP_REFERER'])) {
535 header('Location: ?');
539 // In case browser does not send HTTP_REFERER
540 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
542 // Prevent redirection loop
543 if (isset($params['removetag'])) {
544 unset($params['removetag']);
547 if (isset($params['searchtags'])) {
548 $tags = explode(' ', $params['searchtags']);
549 // Remove value from array $tags.
550 $tags = array_diff($tags, array($_GET['removetag']));
551 $params['searchtags'] = implode(' ', $tags);
553 if (empty($params['searchtags'])) {
554 unset($params['searchtags']);
557 // We also remove page (keeping the same page has no sense, since
558 // the results are different)
559 unset($params['page']);
561 header('Location: ?'.http_build_query($params));
565 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
566 if (isset($_GET['linksperpage'])) {
567 if (is_numeric($_GET['linksperpage'])) {
568 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
571 if (! empty($_SERVER['HTTP_REFERER'])) {
572 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
576 header('Location: '. $location);
580 // -------- User wants to see only private bookmarks (toggle)
581 if (isset($_GET['visibility'])) {
582 if ($_GET['visibility'] === 'private') {
583 // Visibility not set or not already private, set private, otherwise reset it
584 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
585 // See only private bookmarks
586 $_SESSION['visibility'] = 'private';
588 unset($_SESSION['visibility']);
590 } elseif ($_GET['visibility'] === 'public') {
591 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
592 // See only public bookmarks
593 $_SESSION['visibility'] = 'public';
595 unset($_SESSION['visibility']);
599 if (! empty($_SERVER['HTTP_REFERER'])) {
600 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
604 header('Location: '. $location);
608 // -------- User wants to see only untagged bookmarks (toggle)
609 if (isset($_GET['untaggedonly'])) {
610 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
612 if (! empty($_SERVER['HTTP_REFERER'])) {
613 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
617 header('Location: '. $location);
621 // -------- Handle other actions allowed for non-logged in users:
622 if (!$loginManager->isLoggedIn()) {
623 // User tries to post new link but is not logged in:
624 // Show login screen, then redirect to ?post=...
625 if (isset($_GET['post'])) {
626 header( // Redirect to login page, then back to post link.
627 'Location: ./login?post='.urlencode($_GET['post']).
628 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
629 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
630 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
631 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
636 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
637 if (isset($_GET['edit_link'])) {
638 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
642 exit; // Never remove this one! All operations below are reserved for logged in user.
645 // -------- All other functions are reserved for the registered user:
647 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
648 if ($targetPage == Router
::$PAGE_TOOLS) {
650 'pageabsaddr' => index_url($_SERVER),
651 'sslenabled' => is_https($_SERVER),
653 $pluginManager->executeHooks('render_tools', $data);
655 foreach ($data as $key => $value) {
656 $PAGE->assign($key, $value);
659 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
660 $PAGE->renderPage('tools');
664 // -------- User wants to change his/her password.
665 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
666 if ($conf->get('security.open_shaarli')) {
667 die(t('You are not supposed to change a password on an Open Shaarli.'));
670 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
671 if (!$sessionManager->checkToken($_POST['token'])) {
672 die(t('Wrong token.')); // Go away!
675 // Make sure old password is correct.
677 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
679 if ($oldhash != $conf->get('credentials.hash')) {
680 echo '<script>alert("'
681 . t('The old password is not correct.')
682 .'");document.location=\'./?do=changepasswd\';</script>';
686 // Salt renders rainbow-tables attacks useless.
687 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
691 $_POST['setpassword']
692 . $conf->get('credentials.login')
693 . $conf->get('credentials.salt')
697 $conf->write($loginManager->isLoggedIn());
698 } catch (Exception
$e) {
700 'ERROR while writing config file after changing password.' . PHP_EOL
.
704 // TODO: do not handle exceptions/errors in JS.
705 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
708 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
711 // show the change password form.
712 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
713 $PAGE->renderPage('changepassword');
718 // -------- User wants to change configuration
719 if ($targetPage == Router
::$PAGE_CONFIGURE) {
720 if (!empty($_POST['title'])) {
721 if (!$sessionManager->checkToken($_POST['token'])) {
722 die(t('Wrong token.')); // Go away!
725 if (!empty($_POST['continent']) && !empty($_POST['city'])
726 && isTimeZoneValid($_POST['continent'], $_POST['city'])
728 $tz = $_POST['continent'] . '/' . $_POST['city'];
730 $conf->set('general.timezone', $tz);
731 $conf->set('general.title', escape($_POST['title']));
732 $conf->set('general.header_link', escape($_POST['titleLink']));
733 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
734 $conf->set('resource.theme', escape($_POST['theme']));
735 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
736 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
737 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
738 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
739 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
740 $conf->set('api.enabled', !empty($_POST['enableApi']));
741 $conf->set('api.secret', escape($_POST['apiSecret']));
742 $conf->set('formatter', escape($_POST['formatter']));
744 if (! empty($_POST['language'])) {
745 $conf->set('translation.language', escape($_POST['language']));
748 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
749 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
750 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
752 $_SESSION['warnings'][] = t(
753 'You have enabled or changed thumbnails mode. '
754 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
757 $conf->set('thumbnails.mode', $thumbnailsMode);
760 $conf->write($loginManager->isLoggedIn());
761 $history->updateSettings();
762 $pageCacheManager->invalidateCaches();
763 } catch (Exception
$e) {
765 'ERROR while writing config file after configuration update.' . PHP_EOL
.
769 // TODO: do not handle exceptions/errors in JS.
770 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
773 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
776 // Show the configuration form.
777 $PAGE->assign('title', $conf->get('general.title'));
778 $PAGE->assign('theme', $conf->get('resource.theme'));
779 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
780 $PAGE->assign('formatter_available', ['default', 'markdown']);
781 list($continents, $cities) = generateTimeZoneData(
782 timezone_identifiers_list(),
783 $conf->get('general.timezone')
785 $PAGE->assign('continents', $continents);
786 $PAGE->assign('cities', $cities);
787 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
788 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
789 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
790 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
791 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
792 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
793 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
794 $PAGE->assign('api_secret', $conf->get('api.secret'));
795 $PAGE->assign('languages', Languages
::getAvailableLanguages());
796 $PAGE->assign('gd_enabled', extension_loaded('gd'));
797 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
798 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
799 $PAGE->renderPage('configure');
804 // -------- User wants to rename a tag or delete it
805 if ($targetPage == Router
::$PAGE_CHANGETAG) {
806 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
807 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
808 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
809 $PAGE->renderPage('changetag');
813 if (!$sessionManager->checkToken($_POST['token'])) {
814 die(t('Wrong token.'));
817 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
818 $fromTag = escape($_POST['fromtag']);
820 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
821 foreach ($bookmarks as $bookmark) {
823 $bookmark->renameTag($fromTag, $toTag);
825 $bookmark->deleteTag($fromTag);
827 $bookmarkService->set($bookmark, false);
828 $history->updateLink($bookmark);
831 $bookmarkService->save();
832 $delete = empty($_POST['totag']);
833 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
835 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
836 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
837 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
841 // -------- User wants to add a link without using the bookmarklet: Show form.
842 if ($targetPage == Router
::$PAGE_ADDLINK) {
843 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
844 $PAGE->renderPage('addlink');
848 // -------- User clicked the "Save" button when editing a link: Save link to database.
849 if (isset($_POST['save_edit'])) {
851 if (! $sessionManager->checkToken($_POST['token'])) {
852 die(t('Wrong token.'));
855 // lf_id should only be present if the link exists.
856 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
857 if ($id && $bookmarkService->exists($id)) {
859 $bookmark = $bookmarkService->get($id);
862 $bookmark = new Bookmark();
865 $bookmark->setTitle($_POST['lf_title']);
866 $bookmark->setDescription($_POST['lf_description']);
867 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
868 $bookmark->setPrivate(isset($_POST['lf_private']));
869 $bookmark->setTagsString($_POST['lf_tags']);
871 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
872 && ! $bookmark->isNote()
874 $thumbnailer = new Thumbnailer($conf);
875 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
877 $bookmarkService->addOrSet($bookmark, false);
879 // To preserve backward compatibility with 3rd parties, plugins still use arrays
880 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
881 $formatter = $factory->getFormatter('raw');
882 $data = $formatter->format($bookmark);
883 $pluginManager->executeHooks('save_link', $data);
885 $bookmark->fromArray($data);
886 $bookmarkService->set($bookmark);
888 // If we are called from the bookmarklet, we must close the popup:
889 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
890 echo '<script>self.close();</script>';
894 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
895 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
896 // Scroll to the link which has been edited.
897 $location .= '#' . $bookmark->getShortUrl();
898 // After saving the link, redirect to the page the user was on.
899 header('Location: '. $location);
903 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
904 if ($targetPage == Router
::$PAGE_DELETELINK) {
905 if (! $sessionManager->checkToken($_GET['token'])) {
906 die(t('Wrong token.'));
909 $ids = trim($_GET['lf_linkdate']);
910 if (strpos($ids, ' ') !== false) {
911 // multiple, space-separated ids provided
912 $ids = array_values(array_filter(
913 preg_split('/\s+/', escape($ids)),
919 // only a single id provided
920 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
923 // assert at least one id is given
925 die('no id provided');
927 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
928 $formatter = $factory->getFormatter('raw');
929 foreach ($ids as $id) {
930 $id = (int) escape($id);
931 $bookmark = $bookmarkService->get($id);
932 $data = $formatter->format($bookmark);
933 $pluginManager->executeHooks('delete_link', $data);
934 $bookmarkService->remove($bookmark, false);
936 $bookmarkService->save();
938 // If we are called from the bookmarklet, we must close the popup:
939 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
940 echo '<script>self.close();</script>';
945 if (isset($_SERVER['HTTP_REFERER'])) {
946 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
947 $location = generateLocation(
948 $_SERVER['HTTP_REFERER'],
949 $_SERVER['HTTP_HOST'],
950 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
954 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
958 // -------- User clicked either "Set public" or "Set private" bulk operation
959 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
960 if (! $sessionManager->checkToken($_GET['token'])) {
961 die(t('Wrong token.'));
964 $ids = trim($_GET['ids']);
965 if (strpos($ids, ' ') !== false) {
966 // multiple, space-separated ids provided
967 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
969 // only a single id provided
973 // assert at least one id is given
975 die('no id provided');
977 // assert that the visibility is valid
978 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
979 die('invalid visibility');
981 $private = $_GET['newVisibility'] === 'private';
983 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
984 $formatter = $factory->getFormatter('raw');
985 foreach ($ids as $id) {
986 $id = (int) escape($id);
987 $bookmark = $bookmarkService->get($id);
988 $bookmark->setPrivate($private);
990 // To preserve backward compatibility with 3rd parties, plugins still use arrays
991 $data = $formatter->format($bookmark);
992 $pluginManager->executeHooks('save_link', $data);
993 $bookmark->fromArray($data);
995 $bookmarkService->set($bookmark);
997 $bookmarkService->save();
1000 if (isset($_SERVER['HTTP_REFERER'])) {
1001 $location = generateLocation(
1002 $_SERVER['HTTP_REFERER'],
1003 $_SERVER['HTTP_HOST']
1006 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1010 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1011 if (isset($_GET['edit_link'])) {
1012 $id = (int) escape($_GET['edit_link']);
1014 $link = $bookmarkService->get($id); // Read database
1015 } catch (BookmarkNotFoundException
$e) {
1016 // Link not found in database.
1017 header('Location: ?');
1021 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1022 $formatter = $factory->getFormatter('raw');
1023 $formattedLink = $formatter->format($link);
1024 $tags = $bookmarkService->bookmarksCountPerTag();
1025 if ($conf->get('formatter') === 'markdown') {
1026 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1029 'link' => $formattedLink,
1030 'link_is_new' => false,
1031 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1034 $pluginManager->executeHooks('render_editlink', $data);
1036 foreach ($data as $key => $value) {
1037 $PAGE->assign($key, $value);
1040 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1041 $PAGE->renderPage('editlink');
1045 // -------- User want to post a new link: Display link edit form.
1046 if (isset($_GET['post'])) {
1047 $url = cleanup_url($_GET['post']);
1049 $link_is_new = false;
1050 // Check if URL is not already in database (in this case, we will edit the existing link)
1051 $bookmark = $bookmarkService->findByUrl($url);
1053 $link_is_new = true;
1054 // Get title if it was provided in URL (by the bookmarklet).
1055 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1056 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1057 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1058 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1059 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1061 // If this is an HTTP(S) link, we try go get the page to extract
1062 // the title (otherwise we will to straight to the edit form.)
1063 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1064 $retrieveDescription = $conf->get('general.retrieve_description');
1065 // Short timeout to keep the application responsive
1066 // The callback will fill $charset and $title with data from the downloaded page.
1069 $conf->get('general.download_timeout', 30),
1070 $conf->get('general.download_max_size', 4194304),
1071 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1073 if (! empty($title) && strtolower($charset) != 'utf-8') {
1074 $title = mb_convert_encoding($title, 'utf-8', $charset);
1079 $title = $conf->get('general.default_note_title', t('Note: '));
1081 $url = escape($url);
1082 $title = escape($title);
1087 'description' => $description,
1089 'private' => $private,
1092 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1093 $formatter = $factory->getFormatter('raw');
1094 $link = $formatter->format($bookmark);
1097 $tags = $bookmarkService->bookmarksCountPerTag();
1098 if ($conf->get('formatter') === 'markdown') {
1099 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1103 'link_is_new' => $link_is_new,
1104 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1105 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1107 'default_private_links' => $conf->get('privacy.default_private_links', false),
1109 $pluginManager->executeHooks('render_editlink', $data);
1111 foreach ($data as $key => $value) {
1112 $PAGE->assign($key, $value);
1115 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1116 $PAGE->renderPage('editlink');
1120 if ($targetPage == Router
::$PAGE_PINLINK) {
1121 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1122 // FIXME! Use a proper error system.
1123 $msg = t('Invalid link ID provided');
1124 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1127 if (! $sessionManager->checkToken($_GET['token'])) {
1128 die('Wrong token.');
1131 $link = $bookmarkService->get($_GET['id']);
1132 $link->setSticky(! $link->isSticky());
1133 $bookmarkService->set($link);
1134 header('Location: '.index_url($_SERVER));
1138 if ($targetPage == Router
::$PAGE_EXPORT) {
1139 // Export bookmarks as a Netscape Bookmarks file
1141 if (empty($_GET['selection'])) {
1142 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1143 $PAGE->renderPage('export');
1147 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1148 $selection = $_GET['selection'];
1149 if (isset($_GET['prepend_note_url'])) {
1150 $prependNoteUrl = $_GET['prepend_note_url'];
1152 $prependNoteUrl = false;
1156 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1157 $formatter = $factory->getFormatter('raw');
1160 NetscapeBookmarkUtils
::filterAndFormat(
1168 } catch (Exception
$exc) {
1169 header('Content-Type: text/plain; charset=utf-8');
1170 echo $exc->getMessage();
1173 $now = new DateTime();
1174 header('Content-Type: text/html; charset=utf-8');
1176 'Content-disposition: attachment; filename=bookmarks_'
1177 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1179 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1180 $PAGE->assign('eol', PHP_EOL
);
1181 $PAGE->assign('selection', $selection);
1182 $PAGE->renderPage('export.bookmarks');
1186 if ($targetPage == Router
::$PAGE_IMPORT) {
1187 // Upload a Netscape bookmark dump to import its contents
1189 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1190 // Show import dialog
1193 get_max_upload_size(
1194 ini_get('post_max_size'),
1195 ini_get('upload_max_filesize'),
1201 get_max_upload_size(
1202 ini_get('post_max_size'),
1203 ini_get('upload_max_filesize'),
1207 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1208 $PAGE->renderPage('import');
1212 // Import bookmarks from an uploaded file
1213 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1214 // The file is too big or some form field may be missing.
1217 'The file you are trying to upload is probably bigger than what this webserver can accept'
1218 .' (%s). Please upload in smaller chunks.'
1220 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1222 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1225 if (! $sessionManager->checkToken($_POST['token'])) {
1226 die('Wrong token.');
1228 $status = NetscapeBookmarkUtils
::import(
1235 echo '<script>alert("'.$status.'");document.location=\'./?do='
1236 .Router
::$PAGE_IMPORT .'\';</script>';
1240 // Plugin administration page
1241 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1242 $pluginMeta = $pluginManager->getPluginsMeta();
1244 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1245 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1246 return $v['order'] !== false;
1249 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1253 return $a['order'] - $b['order'];
1256 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1257 return $v['order'] === false;
1260 $PAGE->assign('enabledPlugins', $enabledPlugins);
1261 $PAGE->assign('disabledPlugins', $disabledPlugins);
1262 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1263 $PAGE->renderPage('pluginsadmin');
1267 // Plugin administration form action
1268 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1270 if (isset($_POST['parameters_form'])) {
1271 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1272 unset($_POST['parameters_form']);
1273 foreach ($_POST as $param => $value) {
1274 $conf->set('plugins.'. $param, escape($value));
1277 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1279 $conf->write($loginManager->isLoggedIn());
1280 $history->updateSettings();
1281 } catch (Exception
$e) {
1283 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1287 // TODO: do not handle exceptions/errors in JS.
1288 echo '<script>alert("'
1290 .'");document.location=\'./?do='
1291 . Router
::$PAGE_PLUGINSADMIN
1295 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1299 // Get a fresh token
1300 if ($targetPage == Router
::$GET_TOKEN) {
1301 header('Content-Type:text/plain');
1302 echo $sessionManager->generateToken();
1306 // -------- Thumbnails Update
1307 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1309 foreach ($bookmarkService->search() as $bookmark) {
1310 // A note or not HTTP(S)
1311 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1314 $ids[] = $bookmark->getId();
1316 $PAGE->assign('ids', $ids);
1317 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1318 $PAGE->renderPage('thumbnails');
1322 // -------- Single Thumbnail Update
1323 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1324 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1325 http_response_code(400);
1328 $id = (int) $_POST['id'];
1329 if (! $bookmarkService->exists($id)) {
1330 http_response_code(404);
1333 $thumbnailer = new Thumbnailer($conf);
1334 $bookmark = $bookmarkService->get($id);
1335 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1336 $bookmarkService->set($bookmark);
1338 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1339 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1343 // -------- Otherwise, simply display search form and bookmarks:
1344 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1349 * Template for the list of bookmarks (<div id="linklist">)
1350 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1352 * @param pageBuilder $PAGE pageBuilder instance.
1353 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1354 * @param ConfigManager $conf Configuration Manager instance.
1355 * @param PluginManager $pluginManager Plugin Manager instance.
1356 * @param LoginManager $loginManager LoginManager instance
1358 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1360 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1361 $formatter = $factory->getFormatter();
1363 // Used in templates
1364 if (isset($_GET['searchtags'])) {
1365 if (! empty($_GET['searchtags'])) {
1366 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1368 $searchtags = false;
1373 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1376 if (! empty($_SERVER['QUERY_STRING'])
1377 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1379 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1380 } catch (BookmarkNotFoundException
$e) {
1381 $PAGE->render404($e->getMessage());
1385 // Filter bookmarks according search parameters.
1386 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1388 'searchtags' => $searchtags,
1389 'searchterm' => $searchterm,
1391 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1394 // ---- Handle paging.
1396 foreach ($linksToDisplay as $key => $value) {
1400 // Select articles according to paging.
1401 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1402 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1403 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1404 $page = $page < 1 ? 1 : $page;
1405 $page = $page > $pagecount ? $pagecount : $page;
1407 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1408 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1410 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1411 if ($thumbnailsEnabled) {
1412 $thumbnailer = new Thumbnailer($conf);
1415 $linkDisp = array();
1416 while ($i<$end && $i<count($keys)) {
1417 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1419 // Logged in, thumbnails enabled, not a note,
1420 // and (never retrieved yet or no valid cache file)
1421 if ($loginManager->isLoggedIn()
1422 && $thumbnailsEnabled
1423 && !$linksToDisplay[$keys[$i]]->isNote()
1424 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1425 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1427 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1428 $linkDb->set($linksToDisplay[$keys[$i]], false);
1430 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1433 // Check for both signs of a note: starting with ? and 7 chars long.
1434 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1435 // $link['url'] = index_url($_SERVER) . $link['url'];
1438 $linkDisp[$keys[$i]] = $link;
1442 // If we retrieved new thumbnails, we update the database.
1443 if (!empty($updateDB)) {
1447 // Compute paging navigation
1448 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1449 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1450 $previous_page_url = '';
1451 if ($i != count($keys)) {
1452 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1456 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1459 // Fill all template fields.
1461 'previous_page_url' => $previous_page_url,
1462 'next_page_url' => $next_page_url,
1463 'page_current' => $page,
1464 'page_max' => $pagecount,
1465 'result_count' => count($linksToDisplay),
1466 'search_term' => $searchterm,
1467 'search_tags' => $searchtags,
1468 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1469 'links' => $linkDisp,
1472 // If there is only a single link, we change on-the-fly the title of the page.
1473 if (count($linksToDisplay) == 1) {
1474 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1475 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1476 $data['pagetitle'] = t('Search: ');
1477 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1478 $bracketWrap = function ($tag) {
1479 return '['. $tag .']';
1481 $data['pagetitle'] .= ! empty($searchtags)
1482 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1484 $data['pagetitle'] .= '- '. $conf->get('general.title');
1487 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1489 foreach ($data as $key => $value) {
1490 $PAGE->assign($key, $value);
1498 * This function should NEVER be called if the file data/config.php exists.
1500 * @param ConfigManager $conf Configuration Manager instance.
1501 * @param SessionManager $sessionManager SessionManager instance
1502 * @param LoginManager $loginManager LoginManager instance
1504 function install($conf, $sessionManager, $loginManager)
1506 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1507 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1508 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1512 // This part makes sure sessions works correctly.
1513 // (Because on some hosts, session.save_path may not be set correctly,
1514 // or we may not have write access to it.)
1515 if (isset($_GET['test_session'])
1516 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1517 // Step 2: Check if data in session is correct.
1519 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1520 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1521 'and that you have write access to it.<br>'.
1522 'It currently points to %s.<br>'.
1523 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1524 'or any custom hostname without a dot causes cookie storage to fail. '.
1525 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1527 $msg = sprintf($msg, session_save_path());
1529 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1532 if (!isset($_SESSION['session_tested'])) {
1533 // Step 1 : Try to store data in session and reload page.
1534 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1535 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1537 if (isset($_GET['test_session'])) {
1538 // Step 3: Sessions are OK. Remove test parameter from URL.
1539 header('Location: '.index_url($_SERVER));
1543 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1545 if (!empty($_POST['continent']) && !empty($_POST['city'])
1546 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1548 $tz = $_POST['continent'].'/'.$_POST['city'];
1550 $conf->set('general.timezone', $tz);
1551 $login = $_POST['setlogin'];
1552 $conf->set('credentials.login', $login);
1553 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1554 $conf->set('credentials.salt', $salt);
1555 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1556 if (!empty($_POST['title'])) {
1557 $conf->set('general.title', escape($_POST['title']));
1559 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1561 $conf->set('translation.language', escape($_POST['language']));
1562 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1563 $conf->set('api.enabled', !empty($_POST['enableApi']));
1566 generate_api_secret(
1567 $conf->get('credentials.login'),
1568 $conf->get('credentials.salt')
1572 // Everything is ok, let's create config file.
1573 $conf->write($loginManager->isLoggedIn());
1574 } catch (Exception
$e) {
1576 'ERROR while writing config file after installation.' . PHP_EOL
.
1580 // TODO: do not handle exceptions/errors in JS.
1581 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1585 $history = new History($conf->get('resource.history'));
1586 $bookmarkService = new BookmarkFileService($conf, $history, true);
1587 if ($bookmarkService->count() === 0) {
1588 $bookmarkService->initialize();
1591 echo '<script>alert('
1592 .'"Shaarli is now configured. '
1593 .'Please enter your login/password and start shaaring your bookmarks!"'
1594 .');document.location=\'./login\';</script>';
1598 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1599 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1600 $PAGE->assign('continents', $continents);
1601 $PAGE->assign('cities', $cities);
1602 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1603 $PAGE->renderPage('install');
1607 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1608 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1612 $history = new History($conf->get('resource.history'));
1613 } catch (Exception
$e) {
1614 die($e->getMessage());
1617 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1619 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1620 header('Location: ./daily-rss');
1624 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1625 $container = $containerBuilder->build();
1626 $app = new App($container);
1629 $app->group('/api/v1', function () {
1630 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1631 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1632 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1633 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1634 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1635 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1637 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1638 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1639 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1640 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1642 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1643 })->add('\Shaarli\Api\ApiMiddleware');
1645 $app->group('', function () {
1646 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1647 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1648 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1649 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:cloud')->setName('tagcloud');
1650 $this->get('/tag-list', '\Shaarli\Front\Controller\TagCloudController:list')->setName('taglist');
1651 $this->get('/daily', '\Shaarli\Front\Controller\DailyController:index')->setName('daily');
1652 $this->get('/daily-rss', '\Shaarli\Front\Controller\DailyController:rss')->setName('dailyrss');
1654 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1655 })->add('\Shaarli\Front\ShaarliMiddleware');
1657 $response = $app->run(true);
1659 // Hack to make Slim and Shaarli router work together:
1660 // If a Slim route isn't found and NOT API call, we call renderPage().
1661 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1662 // We use UTF-8 for proper international characters handling.
1663 header('Content-Type: text/html; charset=utf-8');
1664 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1666 $response = $response
1667 ->withHeader('Access-Control-Allow-Origin', '*')
1669 'Access-Control-Allow-Headers',
1670 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1672 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1673 $app->respond($response);