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;
436 header('Location: ./feed-'. $feedType .'?'. http_build_query($_GET));
440 // Display opensearch plugin (XML)
441 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
442 header('Location: ./open-search');
446 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
447 if (isset($_GET['addtag'])) {
448 header('Location: ./add-tag/'. $_GET['addtag']);
452 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
453 if (isset($_GET['removetag'])) {
454 header('Location: ./remove-tag/'. $_GET['removetag']);
458 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
459 if (isset($_GET['linksperpage'])) {
460 if (is_numeric($_GET['linksperpage'])) {
461 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
464 if (! empty($_SERVER['HTTP_REFERER'])) {
465 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
469 header('Location: '. $location);
473 // -------- User wants to see only private bookmarks (toggle)
474 if (isset($_GET['visibility'])) {
475 if ($_GET['visibility'] === 'private') {
476 // Visibility not set or not already private, set private, otherwise reset it
477 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
478 // See only private bookmarks
479 $_SESSION['visibility'] = 'private';
481 unset($_SESSION['visibility']);
483 } elseif ($_GET['visibility'] === 'public') {
484 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
485 // See only public bookmarks
486 $_SESSION['visibility'] = 'public';
488 unset($_SESSION['visibility']);
492 if (! empty($_SERVER['HTTP_REFERER'])) {
493 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
497 header('Location: '. $location);
501 // -------- User wants to see only untagged bookmarks (toggle)
502 if (isset($_GET['untaggedonly'])) {
503 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
505 if (! empty($_SERVER['HTTP_REFERER'])) {
506 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
510 header('Location: '. $location);
514 // -------- Handle other actions allowed for non-logged in users:
515 if (!$loginManager->isLoggedIn()) {
516 // User tries to post new link but is not logged in:
517 // Show login screen, then redirect to ?post=...
518 if (isset($_GET['post'])) {
519 header( // Redirect to login page, then back to post link.
520 'Location: ./login?post='.urlencode($_GET['post']).
521 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
522 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
523 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
524 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
529 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
530 if (isset($_GET['edit_link'])) {
531 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
535 exit; // Never remove this one! All operations below are reserved for logged in user.
538 // -------- All other functions are reserved for the registered user:
540 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
541 if ($targetPage == Router
::$PAGE_TOOLS) {
543 'pageabsaddr' => index_url($_SERVER),
544 'sslenabled' => is_https($_SERVER),
546 $pluginManager->executeHooks('render_tools', $data);
548 foreach ($data as $key => $value) {
549 $PAGE->assign($key, $value);
552 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
553 $PAGE->renderPage('tools');
557 // -------- User wants to change his/her password.
558 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
559 if ($conf->get('security.open_shaarli')) {
560 die(t('You are not supposed to change a password on an Open Shaarli.'));
563 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
564 if (!$sessionManager->checkToken($_POST['token'])) {
565 die(t('Wrong token.')); // Go away!
568 // Make sure old password is correct.
570 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
572 if ($oldhash != $conf->get('credentials.hash')) {
573 echo '<script>alert("'
574 . t('The old password is not correct.')
575 .'");document.location=\'./?do=changepasswd\';</script>';
579 // Salt renders rainbow-tables attacks useless.
580 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
584 $_POST['setpassword']
585 . $conf->get('credentials.login')
586 . $conf->get('credentials.salt')
590 $conf->write($loginManager->isLoggedIn());
591 } catch (Exception
$e) {
593 'ERROR while writing config file after changing password.' . PHP_EOL
.
597 // TODO: do not handle exceptions/errors in JS.
598 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
601 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
604 // show the change password form.
605 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
606 $PAGE->renderPage('changepassword');
611 // -------- User wants to change configuration
612 if ($targetPage == Router
::$PAGE_CONFIGURE) {
613 if (!empty($_POST['title'])) {
614 if (!$sessionManager->checkToken($_POST['token'])) {
615 die(t('Wrong token.')); // Go away!
618 if (!empty($_POST['continent']) && !empty($_POST['city'])
619 && isTimeZoneValid($_POST['continent'], $_POST['city'])
621 $tz = $_POST['continent'] . '/' . $_POST['city'];
623 $conf->set('general.timezone', $tz);
624 $conf->set('general.title', escape($_POST['title']));
625 $conf->set('general.header_link', escape($_POST['titleLink']));
626 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
627 $conf->set('resource.theme', escape($_POST['theme']));
628 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
629 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
630 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
631 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
632 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
633 $conf->set('api.enabled', !empty($_POST['enableApi']));
634 $conf->set('api.secret', escape($_POST['apiSecret']));
635 $conf->set('formatter', escape($_POST['formatter']));
637 if (! empty($_POST['language'])) {
638 $conf->set('translation.language', escape($_POST['language']));
641 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
642 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
643 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
645 $_SESSION['warnings'][] = t(
646 'You have enabled or changed thumbnails mode. '
647 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
650 $conf->set('thumbnails.mode', $thumbnailsMode);
653 $conf->write($loginManager->isLoggedIn());
654 $history->updateSettings();
655 $pageCacheManager->invalidateCaches();
656 } catch (Exception
$e) {
658 'ERROR while writing config file after configuration update.' . PHP_EOL
.
662 // TODO: do not handle exceptions/errors in JS.
663 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
666 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
669 // Show the configuration form.
670 $PAGE->assign('title', $conf->get('general.title'));
671 $PAGE->assign('theme', $conf->get('resource.theme'));
672 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
673 $PAGE->assign('formatter_available', ['default', 'markdown']);
674 list($continents, $cities) = generateTimeZoneData(
675 timezone_identifiers_list(),
676 $conf->get('general.timezone')
678 $PAGE->assign('continents', $continents);
679 $PAGE->assign('cities', $cities);
680 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
681 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
682 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
683 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
684 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
685 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
686 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
687 $PAGE->assign('api_secret', $conf->get('api.secret'));
688 $PAGE->assign('languages', Languages
::getAvailableLanguages());
689 $PAGE->assign('gd_enabled', extension_loaded('gd'));
690 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
691 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
692 $PAGE->renderPage('configure');
697 // -------- User wants to rename a tag or delete it
698 if ($targetPage == Router
::$PAGE_CHANGETAG) {
699 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
700 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
701 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
702 $PAGE->renderPage('changetag');
706 if (!$sessionManager->checkToken($_POST['token'])) {
707 die(t('Wrong token.'));
710 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
711 $fromTag = escape($_POST['fromtag']);
713 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
714 foreach ($bookmarks as $bookmark) {
716 $bookmark->renameTag($fromTag, $toTag);
718 $bookmark->deleteTag($fromTag);
720 $bookmarkService->set($bookmark, false);
721 $history->updateLink($bookmark);
724 $bookmarkService->save();
725 $delete = empty($_POST['totag']);
726 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
728 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
729 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
730 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
734 // -------- User wants to add a link without using the bookmarklet: Show form.
735 if ($targetPage == Router
::$PAGE_ADDLINK) {
736 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
737 $PAGE->renderPage('addlink');
741 // -------- User clicked the "Save" button when editing a link: Save link to database.
742 if (isset($_POST['save_edit'])) {
744 if (! $sessionManager->checkToken($_POST['token'])) {
745 die(t('Wrong token.'));
748 // lf_id should only be present if the link exists.
749 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
750 if ($id && $bookmarkService->exists($id)) {
752 $bookmark = $bookmarkService->get($id);
755 $bookmark = new Bookmark();
758 $bookmark->setTitle($_POST['lf_title']);
759 $bookmark->setDescription($_POST['lf_description']);
760 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
761 $bookmark->setPrivate(isset($_POST['lf_private']));
762 $bookmark->setTagsString($_POST['lf_tags']);
764 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
765 && ! $bookmark->isNote()
767 $thumbnailer = new Thumbnailer($conf);
768 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
770 $bookmarkService->addOrSet($bookmark, false);
772 // To preserve backward compatibility with 3rd parties, plugins still use arrays
773 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
774 $formatter = $factory->getFormatter('raw');
775 $data = $formatter->format($bookmark);
776 $pluginManager->executeHooks('save_link', $data);
778 $bookmark->fromArray($data);
779 $bookmarkService->set($bookmark);
781 // If we are called from the bookmarklet, we must close the popup:
782 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
783 echo '<script>self.close();</script>';
787 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
788 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
789 // Scroll to the link which has been edited.
790 $location .= '#' . $bookmark->getShortUrl();
791 // After saving the link, redirect to the page the user was on.
792 header('Location: '. $location);
796 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
797 if ($targetPage == Router
::$PAGE_DELETELINK) {
798 if (! $sessionManager->checkToken($_GET['token'])) {
799 die(t('Wrong token.'));
802 $ids = trim($_GET['lf_linkdate']);
803 if (strpos($ids, ' ') !== false) {
804 // multiple, space-separated ids provided
805 $ids = array_values(array_filter(
806 preg_split('/\s+/', escape($ids)),
812 // only a single id provided
813 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
816 // assert at least one id is given
818 die('no id provided');
820 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
821 $formatter = $factory->getFormatter('raw');
822 foreach ($ids as $id) {
823 $id = (int) escape($id);
824 $bookmark = $bookmarkService->get($id);
825 $data = $formatter->format($bookmark);
826 $pluginManager->executeHooks('delete_link', $data);
827 $bookmarkService->remove($bookmark, false);
829 $bookmarkService->save();
831 // If we are called from the bookmarklet, we must close the popup:
832 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
833 echo '<script>self.close();</script>';
838 if (isset($_SERVER['HTTP_REFERER'])) {
839 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
840 $location = generateLocation(
841 $_SERVER['HTTP_REFERER'],
842 $_SERVER['HTTP_HOST'],
843 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
847 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
851 // -------- User clicked either "Set public" or "Set private" bulk operation
852 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
853 if (! $sessionManager->checkToken($_GET['token'])) {
854 die(t('Wrong token.'));
857 $ids = trim($_GET['ids']);
858 if (strpos($ids, ' ') !== false) {
859 // multiple, space-separated ids provided
860 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
862 // only a single id provided
866 // assert at least one id is given
868 die('no id provided');
870 // assert that the visibility is valid
871 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
872 die('invalid visibility');
874 $private = $_GET['newVisibility'] === 'private';
876 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
877 $formatter = $factory->getFormatter('raw');
878 foreach ($ids as $id) {
879 $id = (int) escape($id);
880 $bookmark = $bookmarkService->get($id);
881 $bookmark->setPrivate($private);
883 // To preserve backward compatibility with 3rd parties, plugins still use arrays
884 $data = $formatter->format($bookmark);
885 $pluginManager->executeHooks('save_link', $data);
886 $bookmark->fromArray($data);
888 $bookmarkService->set($bookmark);
890 $bookmarkService->save();
893 if (isset($_SERVER['HTTP_REFERER'])) {
894 $location = generateLocation(
895 $_SERVER['HTTP_REFERER'],
896 $_SERVER['HTTP_HOST']
899 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
903 // -------- User clicked the "EDIT" button on a link: Display link edit form.
904 if (isset($_GET['edit_link'])) {
905 $id = (int) escape($_GET['edit_link']);
907 $link = $bookmarkService->get($id); // Read database
908 } catch (BookmarkNotFoundException
$e) {
909 // Link not found in database.
910 header('Location: ?');
914 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
915 $formatter = $factory->getFormatter('raw');
916 $formattedLink = $formatter->format($link);
917 $tags = $bookmarkService->bookmarksCountPerTag();
918 if ($conf->get('formatter') === 'markdown') {
919 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
922 'link' => $formattedLink,
923 'link_is_new' => false,
924 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
927 $pluginManager->executeHooks('render_editlink', $data);
929 foreach ($data as $key => $value) {
930 $PAGE->assign($key, $value);
933 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
934 $PAGE->renderPage('editlink');
938 // -------- User want to post a new link: Display link edit form.
939 if (isset($_GET['post'])) {
940 $url = cleanup_url($_GET['post']);
942 $link_is_new = false;
943 // Check if URL is not already in database (in this case, we will edit the existing link)
944 $bookmark = $bookmarkService->findByUrl($url);
947 // Get title if it was provided in URL (by the bookmarklet).
948 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
949 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
950 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
951 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
952 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
954 // If this is an HTTP(S) link, we try go get the page to extract
955 // the title (otherwise we will to straight to the edit form.)
956 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
957 $retrieveDescription = $conf->get('general.retrieve_description');
958 // Short timeout to keep the application responsive
959 // The callback will fill $charset and $title with data from the downloaded page.
962 $conf->get('general.download_timeout', 30),
963 $conf->get('general.download_max_size', 4194304),
964 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
966 if (! empty($title) && strtolower($charset) != 'utf-8') {
967 $title = mb_convert_encoding($title, 'utf-8', $charset);
972 $title = $conf->get('general.default_note_title', t('Note: '));
975 $title = escape($title);
980 'description' => $description,
982 'private' => $private,
985 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
986 $formatter = $factory->getFormatter('raw');
987 $link = $formatter->format($bookmark);
990 $tags = $bookmarkService->bookmarksCountPerTag();
991 if ($conf->get('formatter') === 'markdown') {
992 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
996 'link_is_new' => $link_is_new,
997 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
998 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1000 'default_private_links' => $conf->get('privacy.default_private_links', false),
1002 $pluginManager->executeHooks('render_editlink', $data);
1004 foreach ($data as $key => $value) {
1005 $PAGE->assign($key, $value);
1008 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1009 $PAGE->renderPage('editlink');
1013 if ($targetPage == Router
::$PAGE_PINLINK) {
1014 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1015 // FIXME! Use a proper error system.
1016 $msg = t('Invalid link ID provided');
1017 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1020 if (! $sessionManager->checkToken($_GET['token'])) {
1021 die('Wrong token.');
1024 $link = $bookmarkService->get($_GET['id']);
1025 $link->setSticky(! $link->isSticky());
1026 $bookmarkService->set($link);
1027 header('Location: '.index_url($_SERVER));
1031 if ($targetPage == Router
::$PAGE_EXPORT) {
1032 // Export bookmarks as a Netscape Bookmarks file
1034 if (empty($_GET['selection'])) {
1035 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1036 $PAGE->renderPage('export');
1040 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1041 $selection = $_GET['selection'];
1042 if (isset($_GET['prepend_note_url'])) {
1043 $prependNoteUrl = $_GET['prepend_note_url'];
1045 $prependNoteUrl = false;
1049 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1050 $formatter = $factory->getFormatter('raw');
1053 NetscapeBookmarkUtils
::filterAndFormat(
1061 } catch (Exception
$exc) {
1062 header('Content-Type: text/plain; charset=utf-8');
1063 echo $exc->getMessage();
1066 $now = new DateTime();
1067 header('Content-Type: text/html; charset=utf-8');
1069 'Content-disposition: attachment; filename=bookmarks_'
1070 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1072 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1073 $PAGE->assign('eol', PHP_EOL
);
1074 $PAGE->assign('selection', $selection);
1075 $PAGE->renderPage('export.bookmarks');
1079 if ($targetPage == Router
::$PAGE_IMPORT) {
1080 // Upload a Netscape bookmark dump to import its contents
1082 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1083 // Show import dialog
1086 get_max_upload_size(
1087 ini_get('post_max_size'),
1088 ini_get('upload_max_filesize'),
1094 get_max_upload_size(
1095 ini_get('post_max_size'),
1096 ini_get('upload_max_filesize'),
1100 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1101 $PAGE->renderPage('import');
1105 // Import bookmarks from an uploaded file
1106 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1107 // The file is too big or some form field may be missing.
1110 'The file you are trying to upload is probably bigger than what this webserver can accept'
1111 .' (%s). Please upload in smaller chunks.'
1113 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1115 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1118 if (! $sessionManager->checkToken($_POST['token'])) {
1119 die('Wrong token.');
1121 $status = NetscapeBookmarkUtils
::import(
1128 echo '<script>alert("'.$status.'");document.location=\'./?do='
1129 .Router
::$PAGE_IMPORT .'\';</script>';
1133 // Plugin administration page
1134 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1135 $pluginMeta = $pluginManager->getPluginsMeta();
1137 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1138 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1139 return $v['order'] !== false;
1142 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1146 return $a['order'] - $b['order'];
1149 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1150 return $v['order'] === false;
1153 $PAGE->assign('enabledPlugins', $enabledPlugins);
1154 $PAGE->assign('disabledPlugins', $disabledPlugins);
1155 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1156 $PAGE->renderPage('pluginsadmin');
1160 // Plugin administration form action
1161 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1163 if (isset($_POST['parameters_form'])) {
1164 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1165 unset($_POST['parameters_form']);
1166 foreach ($_POST as $param => $value) {
1167 $conf->set('plugins.'. $param, escape($value));
1170 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1172 $conf->write($loginManager->isLoggedIn());
1173 $history->updateSettings();
1174 } catch (Exception
$e) {
1176 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1180 // TODO: do not handle exceptions/errors in JS.
1181 echo '<script>alert("'
1183 .'");document.location=\'./?do='
1184 . Router
::$PAGE_PLUGINSADMIN
1188 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1192 // Get a fresh token
1193 if ($targetPage == Router
::$GET_TOKEN) {
1194 header('Content-Type:text/plain');
1195 echo $sessionManager->generateToken();
1199 // -------- Thumbnails Update
1200 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1202 foreach ($bookmarkService->search() as $bookmark) {
1203 // A note or not HTTP(S)
1204 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1207 $ids[] = $bookmark->getId();
1209 $PAGE->assign('ids', $ids);
1210 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1211 $PAGE->renderPage('thumbnails');
1215 // -------- Single Thumbnail Update
1216 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1217 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1218 http_response_code(400);
1221 $id = (int) $_POST['id'];
1222 if (! $bookmarkService->exists($id)) {
1223 http_response_code(404);
1226 $thumbnailer = new Thumbnailer($conf);
1227 $bookmark = $bookmarkService->get($id);
1228 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1229 $bookmarkService->set($bookmark);
1231 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1232 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1236 // -------- Otherwise, simply display search form and bookmarks:
1237 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1242 * Template for the list of bookmarks (<div id="linklist">)
1243 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1245 * @param pageBuilder $PAGE pageBuilder instance.
1246 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1247 * @param ConfigManager $conf Configuration Manager instance.
1248 * @param PluginManager $pluginManager Plugin Manager instance.
1249 * @param LoginManager $loginManager LoginManager instance
1251 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1253 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1254 $formatter = $factory->getFormatter();
1256 // Used in templates
1257 if (isset($_GET['searchtags'])) {
1258 if (! empty($_GET['searchtags'])) {
1259 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1261 $searchtags = false;
1266 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1269 if (! empty($_SERVER['QUERY_STRING'])
1270 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1272 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1273 } catch (BookmarkNotFoundException
$e) {
1274 $PAGE->render404($e->getMessage());
1278 // Filter bookmarks according search parameters.
1279 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1281 'searchtags' => $searchtags,
1282 'searchterm' => $searchterm,
1284 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1287 // ---- Handle paging.
1289 foreach ($linksToDisplay as $key => $value) {
1293 // Select articles according to paging.
1294 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1295 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1296 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1297 $page = $page < 1 ? 1 : $page;
1298 $page = $page > $pagecount ? $pagecount : $page;
1300 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1301 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1303 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1304 if ($thumbnailsEnabled) {
1305 $thumbnailer = new Thumbnailer($conf);
1308 $linkDisp = array();
1309 while ($i<$end && $i<count($keys)) {
1310 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1312 // Logged in, thumbnails enabled, not a note,
1313 // and (never retrieved yet or no valid cache file)
1314 if ($loginManager->isLoggedIn()
1315 && $thumbnailsEnabled
1316 && !$linksToDisplay[$keys[$i]]->isNote()
1317 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1318 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1320 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1321 $linkDb->set($linksToDisplay[$keys[$i]], false);
1323 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1326 // Check for both signs of a note: starting with ? and 7 chars long.
1327 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1328 // $link['url'] = index_url($_SERVER) . $link['url'];
1331 $linkDisp[$keys[$i]] = $link;
1335 // If we retrieved new thumbnails, we update the database.
1336 if (!empty($updateDB)) {
1340 // Compute paging navigation
1341 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1342 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1343 $previous_page_url = '';
1344 if ($i != count($keys)) {
1345 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1349 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1352 // Fill all template fields.
1354 'previous_page_url' => $previous_page_url,
1355 'next_page_url' => $next_page_url,
1356 'page_current' => $page,
1357 'page_max' => $pagecount,
1358 'result_count' => count($linksToDisplay),
1359 'search_term' => $searchterm,
1360 'search_tags' => $searchtags,
1361 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1362 'links' => $linkDisp,
1365 // If there is only a single link, we change on-the-fly the title of the page.
1366 if (count($linksToDisplay) == 1) {
1367 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1368 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1369 $data['pagetitle'] = t('Search: ');
1370 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1371 $bracketWrap = function ($tag) {
1372 return '['. $tag .']';
1374 $data['pagetitle'] .= ! empty($searchtags)
1375 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1377 $data['pagetitle'] .= '- '. $conf->get('general.title');
1380 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1382 foreach ($data as $key => $value) {
1383 $PAGE->assign($key, $value);
1391 * This function should NEVER be called if the file data/config.php exists.
1393 * @param ConfigManager $conf Configuration Manager instance.
1394 * @param SessionManager $sessionManager SessionManager instance
1395 * @param LoginManager $loginManager LoginManager instance
1397 function install($conf, $sessionManager, $loginManager)
1399 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1400 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1401 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1405 // This part makes sure sessions works correctly.
1406 // (Because on some hosts, session.save_path may not be set correctly,
1407 // or we may not have write access to it.)
1408 if (isset($_GET['test_session'])
1409 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1410 // Step 2: Check if data in session is correct.
1412 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1413 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1414 'and that you have write access to it.<br>'.
1415 'It currently points to %s.<br>'.
1416 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1417 'or any custom hostname without a dot causes cookie storage to fail. '.
1418 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1420 $msg = sprintf($msg, session_save_path());
1422 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1425 if (!isset($_SESSION['session_tested'])) {
1426 // Step 1 : Try to store data in session and reload page.
1427 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1428 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1430 if (isset($_GET['test_session'])) {
1431 // Step 3: Sessions are OK. Remove test parameter from URL.
1432 header('Location: '.index_url($_SERVER));
1436 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1438 if (!empty($_POST['continent']) && !empty($_POST['city'])
1439 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1441 $tz = $_POST['continent'].'/'.$_POST['city'];
1443 $conf->set('general.timezone', $tz);
1444 $login = $_POST['setlogin'];
1445 $conf->set('credentials.login', $login);
1446 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1447 $conf->set('credentials.salt', $salt);
1448 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1449 if (!empty($_POST['title'])) {
1450 $conf->set('general.title', escape($_POST['title']));
1452 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1454 $conf->set('translation.language', escape($_POST['language']));
1455 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1456 $conf->set('api.enabled', !empty($_POST['enableApi']));
1459 generate_api_secret(
1460 $conf->get('credentials.login'),
1461 $conf->get('credentials.salt')
1465 // Everything is ok, let's create config file.
1466 $conf->write($loginManager->isLoggedIn());
1467 } catch (Exception
$e) {
1469 'ERROR while writing config file after installation.' . PHP_EOL
.
1473 // TODO: do not handle exceptions/errors in JS.
1474 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1478 $history = new History($conf->get('resource.history'));
1479 $bookmarkService = new BookmarkFileService($conf, $history, true);
1480 if ($bookmarkService->count() === 0) {
1481 $bookmarkService->initialize();
1484 echo '<script>alert('
1485 .'"Shaarli is now configured. '
1486 .'Please enter your login/password and start shaaring your bookmarks!"'
1487 .');document.location=\'./login\';</script>';
1491 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1492 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1493 $PAGE->assign('continents', $continents);
1494 $PAGE->assign('cities', $cities);
1495 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1496 $PAGE->renderPage('install');
1500 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1501 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1505 $history = new History($conf->get('resource.history'));
1506 } catch (Exception
$e) {
1507 die($e->getMessage());
1510 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1512 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1513 header('Location: ./daily-rss');
1517 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1518 $container = $containerBuilder->build();
1519 $app = new App($container);
1522 $app->group('/api/v1', function () {
1523 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1524 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1525 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1526 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1527 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1528 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1530 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1531 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1532 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1533 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1535 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1536 })->add('\Shaarli\Api\ApiMiddleware');
1538 $app->group('', function () {
1539 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1540 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1541 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1542 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:cloud')->setName('tagcloud');
1543 $this->get('/tag-list', '\Shaarli\Front\Controller\TagCloudController:list')->setName('taglist');
1544 $this->get('/daily', '\Shaarli\Front\Controller\DailyController:index')->setName('daily');
1545 $this->get('/daily-rss', '\Shaarli\Front\Controller\DailyController:rss')->setName('dailyrss');
1546 $this->get('/feed-atom', '\Shaarli\Front\Controller\FeedController:atom')->setName('feedatom');
1547 $this->get('/feed-rss', '\Shaarli\Front\Controller\FeedController:rss')->setName('feedrss');
1548 $this->get('/open-search', '\Shaarli\Front\Controller\OpenSearchController:index')->setName('opensearch');
1550 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1551 $this->get('/remove-tag/{tag}', '\Shaarli\Front\Controller\TagController:removeTag')->setName('remove-tag');
1552 })->add('\Shaarli\Front\ShaarliMiddleware');
1554 $response = $app->run(true);
1556 // Hack to make Slim and Shaarli router work together:
1557 // If a Slim route isn't found and NOT API call, we call renderPage().
1558 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1559 // We use UTF-8 for proper international characters handling.
1560 header('Content-Type: text/html; charset=utf-8');
1561 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1563 $response = $response
1564 ->withHeader('Access-Control-Allow-Origin', '*')
1566 'Access-Control-Allow-Headers',
1567 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1569 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1570 $app->respond($response);