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('Content-Type: application/xml; charset=utf-8');
443 $PAGE->assign('serverurl', index_url($_SERVER));
444 $PAGE->renderPage('opensearch');
448 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
449 if (isset($_GET['addtag'])) {
450 header('Location: ./add-tag/'. $_GET['addtag']);
454 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
455 if (isset($_GET['removetag'])) {
456 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
457 if (empty($_SERVER['HTTP_REFERER'])) {
458 header('Location: ?');
462 // In case browser does not send HTTP_REFERER
463 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
465 // Prevent redirection loop
466 if (isset($params['removetag'])) {
467 unset($params['removetag']);
470 if (isset($params['searchtags'])) {
471 $tags = explode(' ', $params['searchtags']);
472 // Remove value from array $tags.
473 $tags = array_diff($tags, array($_GET['removetag']));
474 $params['searchtags'] = implode(' ', $tags);
476 if (empty($params['searchtags'])) {
477 unset($params['searchtags']);
480 // We also remove page (keeping the same page has no sense, since
481 // the results are different)
482 unset($params['page']);
484 header('Location: ?'.http_build_query($params));
488 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
489 if (isset($_GET['linksperpage'])) {
490 if (is_numeric($_GET['linksperpage'])) {
491 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
494 if (! empty($_SERVER['HTTP_REFERER'])) {
495 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
499 header('Location: '. $location);
503 // -------- User wants to see only private bookmarks (toggle)
504 if (isset($_GET['visibility'])) {
505 if ($_GET['visibility'] === 'private') {
506 // Visibility not set or not already private, set private, otherwise reset it
507 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
508 // See only private bookmarks
509 $_SESSION['visibility'] = 'private';
511 unset($_SESSION['visibility']);
513 } elseif ($_GET['visibility'] === 'public') {
514 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
515 // See only public bookmarks
516 $_SESSION['visibility'] = 'public';
518 unset($_SESSION['visibility']);
522 if (! empty($_SERVER['HTTP_REFERER'])) {
523 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
527 header('Location: '. $location);
531 // -------- User wants to see only untagged bookmarks (toggle)
532 if (isset($_GET['untaggedonly'])) {
533 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
535 if (! empty($_SERVER['HTTP_REFERER'])) {
536 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
540 header('Location: '. $location);
544 // -------- Handle other actions allowed for non-logged in users:
545 if (!$loginManager->isLoggedIn()) {
546 // User tries to post new link but is not logged in:
547 // Show login screen, then redirect to ?post=...
548 if (isset($_GET['post'])) {
549 header( // Redirect to login page, then back to post link.
550 'Location: ./login?post='.urlencode($_GET['post']).
551 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
552 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
553 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
554 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
559 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
560 if (isset($_GET['edit_link'])) {
561 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
565 exit; // Never remove this one! All operations below are reserved for logged in user.
568 // -------- All other functions are reserved for the registered user:
570 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
571 if ($targetPage == Router
::$PAGE_TOOLS) {
573 'pageabsaddr' => index_url($_SERVER),
574 'sslenabled' => is_https($_SERVER),
576 $pluginManager->executeHooks('render_tools', $data);
578 foreach ($data as $key => $value) {
579 $PAGE->assign($key, $value);
582 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
583 $PAGE->renderPage('tools');
587 // -------- User wants to change his/her password.
588 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
589 if ($conf->get('security.open_shaarli')) {
590 die(t('You are not supposed to change a password on an Open Shaarli.'));
593 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
594 if (!$sessionManager->checkToken($_POST['token'])) {
595 die(t('Wrong token.')); // Go away!
598 // Make sure old password is correct.
600 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
602 if ($oldhash != $conf->get('credentials.hash')) {
603 echo '<script>alert("'
604 . t('The old password is not correct.')
605 .'");document.location=\'./?do=changepasswd\';</script>';
609 // Salt renders rainbow-tables attacks useless.
610 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
614 $_POST['setpassword']
615 . $conf->get('credentials.login')
616 . $conf->get('credentials.salt')
620 $conf->write($loginManager->isLoggedIn());
621 } catch (Exception
$e) {
623 'ERROR while writing config file after changing password.' . PHP_EOL
.
627 // TODO: do not handle exceptions/errors in JS.
628 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
631 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
634 // show the change password form.
635 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
636 $PAGE->renderPage('changepassword');
641 // -------- User wants to change configuration
642 if ($targetPage == Router
::$PAGE_CONFIGURE) {
643 if (!empty($_POST['title'])) {
644 if (!$sessionManager->checkToken($_POST['token'])) {
645 die(t('Wrong token.')); // Go away!
648 if (!empty($_POST['continent']) && !empty($_POST['city'])
649 && isTimeZoneValid($_POST['continent'], $_POST['city'])
651 $tz = $_POST['continent'] . '/' . $_POST['city'];
653 $conf->set('general.timezone', $tz);
654 $conf->set('general.title', escape($_POST['title']));
655 $conf->set('general.header_link', escape($_POST['titleLink']));
656 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
657 $conf->set('resource.theme', escape($_POST['theme']));
658 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
659 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
660 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
661 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
662 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
663 $conf->set('api.enabled', !empty($_POST['enableApi']));
664 $conf->set('api.secret', escape($_POST['apiSecret']));
665 $conf->set('formatter', escape($_POST['formatter']));
667 if (! empty($_POST['language'])) {
668 $conf->set('translation.language', escape($_POST['language']));
671 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
672 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
673 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
675 $_SESSION['warnings'][] = t(
676 'You have enabled or changed thumbnails mode. '
677 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
680 $conf->set('thumbnails.mode', $thumbnailsMode);
683 $conf->write($loginManager->isLoggedIn());
684 $history->updateSettings();
685 $pageCacheManager->invalidateCaches();
686 } catch (Exception
$e) {
688 'ERROR while writing config file after configuration update.' . PHP_EOL
.
692 // TODO: do not handle exceptions/errors in JS.
693 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
696 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
699 // Show the configuration form.
700 $PAGE->assign('title', $conf->get('general.title'));
701 $PAGE->assign('theme', $conf->get('resource.theme'));
702 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
703 $PAGE->assign('formatter_available', ['default', 'markdown']);
704 list($continents, $cities) = generateTimeZoneData(
705 timezone_identifiers_list(),
706 $conf->get('general.timezone')
708 $PAGE->assign('continents', $continents);
709 $PAGE->assign('cities', $cities);
710 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
711 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
712 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
713 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
714 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
715 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
716 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
717 $PAGE->assign('api_secret', $conf->get('api.secret'));
718 $PAGE->assign('languages', Languages
::getAvailableLanguages());
719 $PAGE->assign('gd_enabled', extension_loaded('gd'));
720 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
721 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
722 $PAGE->renderPage('configure');
727 // -------- User wants to rename a tag or delete it
728 if ($targetPage == Router
::$PAGE_CHANGETAG) {
729 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
730 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
731 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
732 $PAGE->renderPage('changetag');
736 if (!$sessionManager->checkToken($_POST['token'])) {
737 die(t('Wrong token.'));
740 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
741 $fromTag = escape($_POST['fromtag']);
743 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
744 foreach ($bookmarks as $bookmark) {
746 $bookmark->renameTag($fromTag, $toTag);
748 $bookmark->deleteTag($fromTag);
750 $bookmarkService->set($bookmark, false);
751 $history->updateLink($bookmark);
754 $bookmarkService->save();
755 $delete = empty($_POST['totag']);
756 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
758 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
759 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
760 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
764 // -------- User wants to add a link without using the bookmarklet: Show form.
765 if ($targetPage == Router
::$PAGE_ADDLINK) {
766 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
767 $PAGE->renderPage('addlink');
771 // -------- User clicked the "Save" button when editing a link: Save link to database.
772 if (isset($_POST['save_edit'])) {
774 if (! $sessionManager->checkToken($_POST['token'])) {
775 die(t('Wrong token.'));
778 // lf_id should only be present if the link exists.
779 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
780 if ($id && $bookmarkService->exists($id)) {
782 $bookmark = $bookmarkService->get($id);
785 $bookmark = new Bookmark();
788 $bookmark->setTitle($_POST['lf_title']);
789 $bookmark->setDescription($_POST['lf_description']);
790 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
791 $bookmark->setPrivate(isset($_POST['lf_private']));
792 $bookmark->setTagsString($_POST['lf_tags']);
794 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
795 && ! $bookmark->isNote()
797 $thumbnailer = new Thumbnailer($conf);
798 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
800 $bookmarkService->addOrSet($bookmark, false);
802 // To preserve backward compatibility with 3rd parties, plugins still use arrays
803 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
804 $formatter = $factory->getFormatter('raw');
805 $data = $formatter->format($bookmark);
806 $pluginManager->executeHooks('save_link', $data);
808 $bookmark->fromArray($data);
809 $bookmarkService->set($bookmark);
811 // If we are called from the bookmarklet, we must close the popup:
812 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
813 echo '<script>self.close();</script>';
817 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
818 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
819 // Scroll to the link which has been edited.
820 $location .= '#' . $bookmark->getShortUrl();
821 // After saving the link, redirect to the page the user was on.
822 header('Location: '. $location);
826 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
827 if ($targetPage == Router
::$PAGE_DELETELINK) {
828 if (! $sessionManager->checkToken($_GET['token'])) {
829 die(t('Wrong token.'));
832 $ids = trim($_GET['lf_linkdate']);
833 if (strpos($ids, ' ') !== false) {
834 // multiple, space-separated ids provided
835 $ids = array_values(array_filter(
836 preg_split('/\s+/', escape($ids)),
842 // only a single id provided
843 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
846 // assert at least one id is given
848 die('no id provided');
850 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
851 $formatter = $factory->getFormatter('raw');
852 foreach ($ids as $id) {
853 $id = (int) escape($id);
854 $bookmark = $bookmarkService->get($id);
855 $data = $formatter->format($bookmark);
856 $pluginManager->executeHooks('delete_link', $data);
857 $bookmarkService->remove($bookmark, false);
859 $bookmarkService->save();
861 // If we are called from the bookmarklet, we must close the popup:
862 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
863 echo '<script>self.close();</script>';
868 if (isset($_SERVER['HTTP_REFERER'])) {
869 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
870 $location = generateLocation(
871 $_SERVER['HTTP_REFERER'],
872 $_SERVER['HTTP_HOST'],
873 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
877 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
881 // -------- User clicked either "Set public" or "Set private" bulk operation
882 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
883 if (! $sessionManager->checkToken($_GET['token'])) {
884 die(t('Wrong token.'));
887 $ids = trim($_GET['ids']);
888 if (strpos($ids, ' ') !== false) {
889 // multiple, space-separated ids provided
890 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
892 // only a single id provided
896 // assert at least one id is given
898 die('no id provided');
900 // assert that the visibility is valid
901 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
902 die('invalid visibility');
904 $private = $_GET['newVisibility'] === 'private';
906 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
907 $formatter = $factory->getFormatter('raw');
908 foreach ($ids as $id) {
909 $id = (int) escape($id);
910 $bookmark = $bookmarkService->get($id);
911 $bookmark->setPrivate($private);
913 // To preserve backward compatibility with 3rd parties, plugins still use arrays
914 $data = $formatter->format($bookmark);
915 $pluginManager->executeHooks('save_link', $data);
916 $bookmark->fromArray($data);
918 $bookmarkService->set($bookmark);
920 $bookmarkService->save();
923 if (isset($_SERVER['HTTP_REFERER'])) {
924 $location = generateLocation(
925 $_SERVER['HTTP_REFERER'],
926 $_SERVER['HTTP_HOST']
929 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
933 // -------- User clicked the "EDIT" button on a link: Display link edit form.
934 if (isset($_GET['edit_link'])) {
935 $id = (int) escape($_GET['edit_link']);
937 $link = $bookmarkService->get($id); // Read database
938 } catch (BookmarkNotFoundException
$e) {
939 // Link not found in database.
940 header('Location: ?');
944 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
945 $formatter = $factory->getFormatter('raw');
946 $formattedLink = $formatter->format($link);
947 $tags = $bookmarkService->bookmarksCountPerTag();
948 if ($conf->get('formatter') === 'markdown') {
949 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
952 'link' => $formattedLink,
953 'link_is_new' => false,
954 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
957 $pluginManager->executeHooks('render_editlink', $data);
959 foreach ($data as $key => $value) {
960 $PAGE->assign($key, $value);
963 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
964 $PAGE->renderPage('editlink');
968 // -------- User want to post a new link: Display link edit form.
969 if (isset($_GET['post'])) {
970 $url = cleanup_url($_GET['post']);
972 $link_is_new = false;
973 // Check if URL is not already in database (in this case, we will edit the existing link)
974 $bookmark = $bookmarkService->findByUrl($url);
977 // Get title if it was provided in URL (by the bookmarklet).
978 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
979 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
980 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
981 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
982 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
984 // If this is an HTTP(S) link, we try go get the page to extract
985 // the title (otherwise we will to straight to the edit form.)
986 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
987 $retrieveDescription = $conf->get('general.retrieve_description');
988 // Short timeout to keep the application responsive
989 // The callback will fill $charset and $title with data from the downloaded page.
992 $conf->get('general.download_timeout', 30),
993 $conf->get('general.download_max_size', 4194304),
994 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
996 if (! empty($title) && strtolower($charset) != 'utf-8') {
997 $title = mb_convert_encoding($title, 'utf-8', $charset);
1002 $title = $conf->get('general.default_note_title', t('Note: '));
1004 $url = escape($url);
1005 $title = escape($title);
1010 'description' => $description,
1012 'private' => $private,
1015 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1016 $formatter = $factory->getFormatter('raw');
1017 $link = $formatter->format($bookmark);
1020 $tags = $bookmarkService->bookmarksCountPerTag();
1021 if ($conf->get('formatter') === 'markdown') {
1022 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1026 'link_is_new' => $link_is_new,
1027 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1028 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1030 'default_private_links' => $conf->get('privacy.default_private_links', false),
1032 $pluginManager->executeHooks('render_editlink', $data);
1034 foreach ($data as $key => $value) {
1035 $PAGE->assign($key, $value);
1038 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1039 $PAGE->renderPage('editlink');
1043 if ($targetPage == Router
::$PAGE_PINLINK) {
1044 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1045 // FIXME! Use a proper error system.
1046 $msg = t('Invalid link ID provided');
1047 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1050 if (! $sessionManager->checkToken($_GET['token'])) {
1051 die('Wrong token.');
1054 $link = $bookmarkService->get($_GET['id']);
1055 $link->setSticky(! $link->isSticky());
1056 $bookmarkService->set($link);
1057 header('Location: '.index_url($_SERVER));
1061 if ($targetPage == Router
::$PAGE_EXPORT) {
1062 // Export bookmarks as a Netscape Bookmarks file
1064 if (empty($_GET['selection'])) {
1065 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1066 $PAGE->renderPage('export');
1070 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1071 $selection = $_GET['selection'];
1072 if (isset($_GET['prepend_note_url'])) {
1073 $prependNoteUrl = $_GET['prepend_note_url'];
1075 $prependNoteUrl = false;
1079 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1080 $formatter = $factory->getFormatter('raw');
1083 NetscapeBookmarkUtils
::filterAndFormat(
1091 } catch (Exception
$exc) {
1092 header('Content-Type: text/plain; charset=utf-8');
1093 echo $exc->getMessage();
1096 $now = new DateTime();
1097 header('Content-Type: text/html; charset=utf-8');
1099 'Content-disposition: attachment; filename=bookmarks_'
1100 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1102 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1103 $PAGE->assign('eol', PHP_EOL
);
1104 $PAGE->assign('selection', $selection);
1105 $PAGE->renderPage('export.bookmarks');
1109 if ($targetPage == Router
::$PAGE_IMPORT) {
1110 // Upload a Netscape bookmark dump to import its contents
1112 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1113 // Show import dialog
1116 get_max_upload_size(
1117 ini_get('post_max_size'),
1118 ini_get('upload_max_filesize'),
1124 get_max_upload_size(
1125 ini_get('post_max_size'),
1126 ini_get('upload_max_filesize'),
1130 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1131 $PAGE->renderPage('import');
1135 // Import bookmarks from an uploaded file
1136 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1137 // The file is too big or some form field may be missing.
1140 'The file you are trying to upload is probably bigger than what this webserver can accept'
1141 .' (%s). Please upload in smaller chunks.'
1143 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1145 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1148 if (! $sessionManager->checkToken($_POST['token'])) {
1149 die('Wrong token.');
1151 $status = NetscapeBookmarkUtils
::import(
1158 echo '<script>alert("'.$status.'");document.location=\'./?do='
1159 .Router
::$PAGE_IMPORT .'\';</script>';
1163 // Plugin administration page
1164 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1165 $pluginMeta = $pluginManager->getPluginsMeta();
1167 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1168 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1169 return $v['order'] !== false;
1172 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1176 return $a['order'] - $b['order'];
1179 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1180 return $v['order'] === false;
1183 $PAGE->assign('enabledPlugins', $enabledPlugins);
1184 $PAGE->assign('disabledPlugins', $disabledPlugins);
1185 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1186 $PAGE->renderPage('pluginsadmin');
1190 // Plugin administration form action
1191 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1193 if (isset($_POST['parameters_form'])) {
1194 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1195 unset($_POST['parameters_form']);
1196 foreach ($_POST as $param => $value) {
1197 $conf->set('plugins.'. $param, escape($value));
1200 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1202 $conf->write($loginManager->isLoggedIn());
1203 $history->updateSettings();
1204 } catch (Exception
$e) {
1206 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1210 // TODO: do not handle exceptions/errors in JS.
1211 echo '<script>alert("'
1213 .'");document.location=\'./?do='
1214 . Router
::$PAGE_PLUGINSADMIN
1218 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1222 // Get a fresh token
1223 if ($targetPage == Router
::$GET_TOKEN) {
1224 header('Content-Type:text/plain');
1225 echo $sessionManager->generateToken();
1229 // -------- Thumbnails Update
1230 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1232 foreach ($bookmarkService->search() as $bookmark) {
1233 // A note or not HTTP(S)
1234 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1237 $ids[] = $bookmark->getId();
1239 $PAGE->assign('ids', $ids);
1240 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1241 $PAGE->renderPage('thumbnails');
1245 // -------- Single Thumbnail Update
1246 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1247 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1248 http_response_code(400);
1251 $id = (int) $_POST['id'];
1252 if (! $bookmarkService->exists($id)) {
1253 http_response_code(404);
1256 $thumbnailer = new Thumbnailer($conf);
1257 $bookmark = $bookmarkService->get($id);
1258 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1259 $bookmarkService->set($bookmark);
1261 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1262 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1266 // -------- Otherwise, simply display search form and bookmarks:
1267 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1272 * Template for the list of bookmarks (<div id="linklist">)
1273 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1275 * @param pageBuilder $PAGE pageBuilder instance.
1276 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1277 * @param ConfigManager $conf Configuration Manager instance.
1278 * @param PluginManager $pluginManager Plugin Manager instance.
1279 * @param LoginManager $loginManager LoginManager instance
1281 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1283 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1284 $formatter = $factory->getFormatter();
1286 // Used in templates
1287 if (isset($_GET['searchtags'])) {
1288 if (! empty($_GET['searchtags'])) {
1289 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1291 $searchtags = false;
1296 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1299 if (! empty($_SERVER['QUERY_STRING'])
1300 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1302 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1303 } catch (BookmarkNotFoundException
$e) {
1304 $PAGE->render404($e->getMessage());
1308 // Filter bookmarks according search parameters.
1309 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1311 'searchtags' => $searchtags,
1312 'searchterm' => $searchterm,
1314 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1317 // ---- Handle paging.
1319 foreach ($linksToDisplay as $key => $value) {
1323 // Select articles according to paging.
1324 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1325 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1326 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1327 $page = $page < 1 ? 1 : $page;
1328 $page = $page > $pagecount ? $pagecount : $page;
1330 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1331 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1333 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1334 if ($thumbnailsEnabled) {
1335 $thumbnailer = new Thumbnailer($conf);
1338 $linkDisp = array();
1339 while ($i<$end && $i<count($keys)) {
1340 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1342 // Logged in, thumbnails enabled, not a note,
1343 // and (never retrieved yet or no valid cache file)
1344 if ($loginManager->isLoggedIn()
1345 && $thumbnailsEnabled
1346 && !$linksToDisplay[$keys[$i]]->isNote()
1347 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1348 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1350 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1351 $linkDb->set($linksToDisplay[$keys[$i]], false);
1353 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1356 // Check for both signs of a note: starting with ? and 7 chars long.
1357 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1358 // $link['url'] = index_url($_SERVER) . $link['url'];
1361 $linkDisp[$keys[$i]] = $link;
1365 // If we retrieved new thumbnails, we update the database.
1366 if (!empty($updateDB)) {
1370 // Compute paging navigation
1371 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1372 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1373 $previous_page_url = '';
1374 if ($i != count($keys)) {
1375 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1379 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1382 // Fill all template fields.
1384 'previous_page_url' => $previous_page_url,
1385 'next_page_url' => $next_page_url,
1386 'page_current' => $page,
1387 'page_max' => $pagecount,
1388 'result_count' => count($linksToDisplay),
1389 'search_term' => $searchterm,
1390 'search_tags' => $searchtags,
1391 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1392 'links' => $linkDisp,
1395 // If there is only a single link, we change on-the-fly the title of the page.
1396 if (count($linksToDisplay) == 1) {
1397 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1398 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1399 $data['pagetitle'] = t('Search: ');
1400 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1401 $bracketWrap = function ($tag) {
1402 return '['. $tag .']';
1404 $data['pagetitle'] .= ! empty($searchtags)
1405 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1407 $data['pagetitle'] .= '- '. $conf->get('general.title');
1410 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1412 foreach ($data as $key => $value) {
1413 $PAGE->assign($key, $value);
1421 * This function should NEVER be called if the file data/config.php exists.
1423 * @param ConfigManager $conf Configuration Manager instance.
1424 * @param SessionManager $sessionManager SessionManager instance
1425 * @param LoginManager $loginManager LoginManager instance
1427 function install($conf, $sessionManager, $loginManager)
1429 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1430 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1431 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1435 // This part makes sure sessions works correctly.
1436 // (Because on some hosts, session.save_path may not be set correctly,
1437 // or we may not have write access to it.)
1438 if (isset($_GET['test_session'])
1439 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1440 // Step 2: Check if data in session is correct.
1442 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1443 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1444 'and that you have write access to it.<br>'.
1445 'It currently points to %s.<br>'.
1446 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1447 'or any custom hostname without a dot causes cookie storage to fail. '.
1448 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1450 $msg = sprintf($msg, session_save_path());
1452 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1455 if (!isset($_SESSION['session_tested'])) {
1456 // Step 1 : Try to store data in session and reload page.
1457 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1458 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1460 if (isset($_GET['test_session'])) {
1461 // Step 3: Sessions are OK. Remove test parameter from URL.
1462 header('Location: '.index_url($_SERVER));
1466 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1468 if (!empty($_POST['continent']) && !empty($_POST['city'])
1469 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1471 $tz = $_POST['continent'].'/'.$_POST['city'];
1473 $conf->set('general.timezone', $tz);
1474 $login = $_POST['setlogin'];
1475 $conf->set('credentials.login', $login);
1476 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1477 $conf->set('credentials.salt', $salt);
1478 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1479 if (!empty($_POST['title'])) {
1480 $conf->set('general.title', escape($_POST['title']));
1482 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1484 $conf->set('translation.language', escape($_POST['language']));
1485 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1486 $conf->set('api.enabled', !empty($_POST['enableApi']));
1489 generate_api_secret(
1490 $conf->get('credentials.login'),
1491 $conf->get('credentials.salt')
1495 // Everything is ok, let's create config file.
1496 $conf->write($loginManager->isLoggedIn());
1497 } catch (Exception
$e) {
1499 'ERROR while writing config file after installation.' . PHP_EOL
.
1503 // TODO: do not handle exceptions/errors in JS.
1504 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1508 $history = new History($conf->get('resource.history'));
1509 $bookmarkService = new BookmarkFileService($conf, $history, true);
1510 if ($bookmarkService->count() === 0) {
1511 $bookmarkService->initialize();
1514 echo '<script>alert('
1515 .'"Shaarli is now configured. '
1516 .'Please enter your login/password and start shaaring your bookmarks!"'
1517 .');document.location=\'./login\';</script>';
1521 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1522 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1523 $PAGE->assign('continents', $continents);
1524 $PAGE->assign('cities', $cities);
1525 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1526 $PAGE->renderPage('install');
1530 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1531 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1535 $history = new History($conf->get('resource.history'));
1536 } catch (Exception
$e) {
1537 die($e->getMessage());
1540 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1542 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1543 header('Location: ./daily-rss');
1547 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1548 $container = $containerBuilder->build();
1549 $app = new App($container);
1552 $app->group('/api/v1', function () {
1553 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1554 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1555 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1556 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1557 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1558 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1560 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1561 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1562 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1563 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1565 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1566 })->add('\Shaarli\Api\ApiMiddleware');
1568 $app->group('', function () {
1569 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1570 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1571 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1572 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:cloud')->setName('tagcloud');
1573 $this->get('/tag-list', '\Shaarli\Front\Controller\TagCloudController:list')->setName('taglist');
1574 $this->get('/daily', '\Shaarli\Front\Controller\DailyController:index')->setName('daily');
1575 $this->get('/daily-rss', '\Shaarli\Front\Controller\DailyController:rss')->setName('dailyrss');
1576 $this->get('/feed-atom', '\Shaarli\Front\Controller\FeedController:atom')->setName('feedatom');
1577 $this->get('/feed-rss', '\Shaarli\Front\Controller\FeedController:rss')->setName('feedrss');
1579 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1580 })->add('\Shaarli\Front\ShaarliMiddleware');
1582 $response = $app->run(true);
1584 // Hack to make Slim and Shaarli router work together:
1585 // If a Slim route isn't found and NOT API call, we call renderPage().
1586 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1587 // We use UTF-8 for proper international characters handling.
1588 header('Content-Type: text/html; charset=utf-8');
1589 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1591 $response = $response
1592 ->withHeader('Access-Control-Allow-Origin', '*')
1594 'Access-Control-Allow-Headers',
1595 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1597 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1598 $app->respond($response);