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 header('Location: ./links-per-page?nb='. $_GET['linksperpage']);
464 // -------- User wants to see only private bookmarks (toggle)
465 if (isset($_GET['visibility'])) {
466 header('Location: ./visibility/'. $_GET['visibility']);
470 // -------- User wants to see only untagged bookmarks (toggle)
471 if (isset($_GET['untaggedonly'])) {
472 header('Location: ./untagged-only');
476 // -------- Handle other actions allowed for non-logged in users:
477 if (!$loginManager->isLoggedIn()) {
478 // User tries to post new link but is not logged in:
479 // Show login screen, then redirect to ?post=...
480 if (isset($_GET['post'])) {
481 header( // Redirect to login page, then back to post link.
482 'Location: ./login?post='.urlencode($_GET['post']).
483 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
484 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
485 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
486 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
491 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
492 if (isset($_GET['edit_link'])) {
493 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
497 exit; // Never remove this one! All operations below are reserved for logged in user.
500 // -------- All other functions are reserved for the registered user:
502 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
503 if ($targetPage == Router
::$PAGE_TOOLS) {
504 header('Location: ./tools');
508 // -------- User wants to change his/her password.
509 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
510 header('Location: ./password');
514 // -------- User wants to change configuration
515 if ($targetPage == Router
::$PAGE_CONFIGURE) {
516 header('Location: ./configure');
520 // -------- User wants to rename a tag or delete it
521 if ($targetPage == Router
::$PAGE_CHANGETAG) {
522 header('Location: ./manage-tags');
526 // -------- User wants to add a link without using the bookmarklet: Show form.
527 if ($targetPage == Router
::$PAGE_ADDLINK) {
528 header('Location: ./shaare');
532 // -------- User clicked the "Save" button when editing a link: Save link to database.
533 if (isset($_POST['save_edit'])) {
534 // This route is no longer supported in legacy mode
535 header('Location: ./');
539 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
540 if ($targetPage == Router
::$PAGE_DELETELINK) {
541 if (! $sessionManager->checkToken($_GET['token'])) {
542 die(t('Wrong token.'));
545 $ids = trim($_GET['lf_linkdate']);
546 if (strpos($ids, ' ') !== false) {
547 // multiple, space-separated ids provided
548 $ids = array_values(array_filter(
549 preg_split('/\s+/', escape($ids)),
555 // only a single id provided
556 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
559 // assert at least one id is given
561 die('no id provided');
563 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
564 $formatter = $factory->getFormatter('raw');
565 foreach ($ids as $id) {
566 $id = (int) escape($id);
567 $bookmark = $bookmarkService->get($id);
568 $data = $formatter->format($bookmark);
569 $pluginManager->executeHooks('delete_link', $data);
570 $bookmarkService->remove($bookmark, false);
572 $bookmarkService->save();
574 // If we are called from the bookmarklet, we must close the popup:
575 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
576 echo '<script>self.close();</script>';
581 if (isset($_SERVER['HTTP_REFERER'])) {
582 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
583 $location = generateLocation(
584 $_SERVER['HTTP_REFERER'],
585 $_SERVER['HTTP_HOST'],
586 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
590 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
594 // -------- User clicked either "Set public" or "Set private" bulk operation
595 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
596 if (! $sessionManager->checkToken($_GET['token'])) {
597 die(t('Wrong token.'));
600 $ids = trim($_GET['ids']);
601 if (strpos($ids, ' ') !== false) {
602 // multiple, space-separated ids provided
603 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
605 // only a single id provided
609 // assert at least one id is given
611 die('no id provided');
613 // assert that the visibility is valid
614 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
615 die('invalid visibility');
617 $private = $_GET['newVisibility'] === 'private';
619 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
620 $formatter = $factory->getFormatter('raw');
621 foreach ($ids as $id) {
622 $id = (int) escape($id);
623 $bookmark = $bookmarkService->get($id);
624 $bookmark->setPrivate($private);
626 // To preserve backward compatibility with 3rd parties, plugins still use arrays
627 $data = $formatter->format($bookmark);
628 $pluginManager->executeHooks('save_link', $data);
629 $bookmark->fromArray($data);
631 $bookmarkService->set($bookmark);
633 $bookmarkService->save();
636 if (isset($_SERVER['HTTP_REFERER'])) {
637 $location = generateLocation(
638 $_SERVER['HTTP_REFERER'],
639 $_SERVER['HTTP_HOST']
642 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
646 // -------- User clicked the "EDIT" button on a link: Display link edit form.
647 if (isset($_GET['edit_link'])) {
648 $id = (int) escape($_GET['edit_link']);
649 header('Location: ./shaare-' . $id);
653 // -------- User want to post a new link: Display link edit form.
654 if (isset($_GET['post'])) {
655 header('Location: ./shaare?' . http_build_query($_GET));
659 if ($targetPage == Router
::$PAGE_PINLINK) {
660 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
661 // FIXME! Use a proper error system.
662 $msg = t('Invalid link ID provided');
663 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
666 if (! $sessionManager->checkToken($_GET['token'])) {
670 $link = $bookmarkService->get($_GET['id']);
671 $link->setSticky(! $link->isSticky());
672 $bookmarkService->set($link);
673 header('Location: '.index_url($_SERVER));
677 if ($targetPage == Router
::$PAGE_EXPORT) {
678 // Export bookmarks as a Netscape Bookmarks file
680 if (empty($_GET['selection'])) {
681 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
682 $PAGE->renderPage('export');
686 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
687 $selection = $_GET['selection'];
688 if (isset($_GET['prepend_note_url'])) {
689 $prependNoteUrl = $_GET['prepend_note_url'];
691 $prependNoteUrl = false;
695 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
696 $formatter = $factory->getFormatter('raw');
699 NetscapeBookmarkUtils
::filterAndFormat(
707 } catch (Exception
$exc) {
708 header('Content-Type: text/plain; charset=utf-8');
709 echo $exc->getMessage();
712 $now = new DateTime();
713 header('Content-Type: text/html; charset=utf-8');
715 'Content-disposition: attachment; filename=bookmarks_'
716 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
718 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
719 $PAGE->assign('eol', PHP_EOL
);
720 $PAGE->assign('selection', $selection);
721 $PAGE->renderPage('export.bookmarks');
725 if ($targetPage == Router
::$PAGE_IMPORT) {
726 // Upload a Netscape bookmark dump to import its contents
728 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
729 // Show import dialog
733 ini_get('post_max_size'),
734 ini_get('upload_max_filesize'),
741 ini_get('post_max_size'),
742 ini_get('upload_max_filesize'),
746 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
747 $PAGE->renderPage('import');
751 // Import bookmarks from an uploaded file
752 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
753 // The file is too big or some form field may be missing.
756 'The file you are trying to upload is probably bigger than what this webserver can accept'
757 .' (%s). Please upload in smaller chunks.'
759 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
761 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
764 if (! $sessionManager->checkToken($_POST['token'])) {
767 $status = NetscapeBookmarkUtils
::import(
774 echo '<script>alert("'.$status.'");document.location=\'./?do='
775 .Router
::$PAGE_IMPORT .'\';</script>';
779 // Plugin administration page
780 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
781 $pluginMeta = $pluginManager->getPluginsMeta();
783 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
784 $enabledPlugins = array_filter($pluginMeta, function ($v) {
785 return $v['order'] !== false;
788 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
792 return $a['order'] - $b['order'];
795 $disabledPlugins = array_filter($pluginMeta, function ($v) {
796 return $v['order'] === false;
799 $PAGE->assign('enabledPlugins', $enabledPlugins);
800 $PAGE->assign('disabledPlugins', $disabledPlugins);
801 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
802 $PAGE->renderPage('pluginsadmin');
806 // Plugin administration form action
807 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
809 if (isset($_POST['parameters_form'])) {
810 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
811 unset($_POST['parameters_form']);
812 foreach ($_POST as $param => $value) {
813 $conf->set('plugins.'. $param, escape($value));
816 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
818 $conf->write($loginManager->isLoggedIn());
819 $history->updateSettings();
820 } catch (Exception
$e) {
822 'ERROR while saving plugin configuration:.' . PHP_EOL
.
826 // TODO: do not handle exceptions/errors in JS.
827 echo '<script>alert("'
829 .'");document.location=\'./?do='
830 . Router
::$PAGE_PLUGINSADMIN
834 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
839 if ($targetPage == Router
::$GET_TOKEN) {
840 header('Content-Type:text/plain');
841 echo $sessionManager->generateToken();
845 // -------- Thumbnails Update
846 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
848 foreach ($bookmarkService->search() as $bookmark) {
849 // A note or not HTTP(S)
850 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
853 $ids[] = $bookmark->getId();
855 $PAGE->assign('ids', $ids);
856 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
857 $PAGE->renderPage('thumbnails');
861 // -------- Single Thumbnail Update
862 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
863 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
864 http_response_code(400);
867 $id = (int) $_POST['id'];
868 if (! $bookmarkService->exists($id)) {
869 http_response_code(404);
872 $thumbnailer = new Thumbnailer($conf);
873 $bookmark = $bookmarkService->get($id);
874 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
875 $bookmarkService->set($bookmark);
877 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
878 echo json_encode($factory->getFormatter('raw')->format($bookmark));
882 // -------- Otherwise, simply display search form and bookmarks:
883 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
888 * Template for the list of bookmarks (<div id="linklist">)
889 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
891 * @param pageBuilder $PAGE pageBuilder instance.
892 * @param BookmarkServiceInterface $linkDb LinkDB instance.
893 * @param ConfigManager $conf Configuration Manager instance.
894 * @param PluginManager $pluginManager Plugin Manager instance.
895 * @param LoginManager $loginManager LoginManager instance
897 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
899 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
900 $formatter = $factory->getFormatter();
903 if (isset($_GET['searchtags'])) {
904 if (! empty($_GET['searchtags'])) {
905 $searchtags = escape(normalize_spaces($_GET['searchtags']));
912 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
915 if (! empty($_SERVER['QUERY_STRING'])
916 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
918 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
919 } catch (BookmarkNotFoundException
$e) {
920 $PAGE->render404($e->getMessage());
924 // Filter bookmarks according search parameters.
925 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
927 'searchtags' => $searchtags,
928 'searchterm' => $searchterm,
930 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
933 // ---- Handle paging.
935 foreach ($linksToDisplay as $key => $value) {
939 // Select articles according to paging.
940 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
941 $pagecount = $pagecount == 0 ? 1 : $pagecount;
942 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
943 $page = $page < 1 ? 1 : $page;
944 $page = $page > $pagecount ? $pagecount : $page;
946 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
947 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
949 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
950 if ($thumbnailsEnabled) {
951 $thumbnailer = new Thumbnailer($conf);
955 while ($i<$end && $i<count($keys)) {
956 $link = $formatter->format($linksToDisplay[$keys[$i]]);
958 // Logged in, thumbnails enabled, not a note,
959 // and (never retrieved yet or no valid cache file)
960 if ($loginManager->isLoggedIn()
961 && $thumbnailsEnabled
962 && !$linksToDisplay[$keys[$i]]->isNote()
963 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
964 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
966 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
967 $linkDb->set($linksToDisplay[$keys[$i]], false);
969 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
972 // Check for both signs of a note: starting with ? and 7 chars long.
973 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
974 // $link['url'] = index_url($_SERVER) . $link['url'];
977 $linkDisp[$keys[$i]] = $link;
981 // If we retrieved new thumbnails, we update the database.
982 if (!empty($updateDB)) {
986 // Compute paging navigation
987 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
988 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
989 $previous_page_url = '';
990 if ($i != count($keys)) {
991 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
995 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
998 // Fill all template fields.
1000 'previous_page_url' => $previous_page_url,
1001 'next_page_url' => $next_page_url,
1002 'page_current' => $page,
1003 'page_max' => $pagecount,
1004 'result_count' => count($linksToDisplay),
1005 'search_term' => $searchterm,
1006 'search_tags' => $searchtags,
1007 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1008 'links' => $linkDisp,
1011 // If there is only a single link, we change on-the-fly the title of the page.
1012 if (count($linksToDisplay) == 1) {
1013 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1014 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1015 $data['pagetitle'] = t('Search: ');
1016 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1017 $bracketWrap = function ($tag) {
1018 return '['. $tag .']';
1020 $data['pagetitle'] .= ! empty($searchtags)
1021 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1023 $data['pagetitle'] .= '- '. $conf->get('general.title');
1026 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1028 foreach ($data as $key => $value) {
1029 $PAGE->assign($key, $value);
1037 * This function should NEVER be called if the file data/config.php exists.
1039 * @param ConfigManager $conf Configuration Manager instance.
1040 * @param SessionManager $sessionManager SessionManager instance
1041 * @param LoginManager $loginManager LoginManager instance
1043 function install($conf, $sessionManager, $loginManager)
1045 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1046 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1047 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1051 // This part makes sure sessions works correctly.
1052 // (Because on some hosts, session.save_path may not be set correctly,
1053 // or we may not have write access to it.)
1054 if (isset($_GET['test_session'])
1055 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1056 // Step 2: Check if data in session is correct.
1058 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1059 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1060 'and that you have write access to it.<br>'.
1061 'It currently points to %s.<br>'.
1062 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1063 'or any custom hostname without a dot causes cookie storage to fail. '.
1064 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1066 $msg = sprintf($msg, session_save_path());
1068 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1071 if (!isset($_SESSION['session_tested'])) {
1072 // Step 1 : Try to store data in session and reload page.
1073 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1074 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1076 if (isset($_GET['test_session'])) {
1077 // Step 3: Sessions are OK. Remove test parameter from URL.
1078 header('Location: '.index_url($_SERVER));
1082 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1084 if (!empty($_POST['continent']) && !empty($_POST['city'])
1085 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1087 $tz = $_POST['continent'].'/'.$_POST['city'];
1089 $conf->set('general.timezone', $tz);
1090 $login = $_POST['setlogin'];
1091 $conf->set('credentials.login', $login);
1092 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1093 $conf->set('credentials.salt', $salt);
1094 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1095 if (!empty($_POST['title'])) {
1096 $conf->set('general.title', escape($_POST['title']));
1098 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1100 $conf->set('translation.language', escape($_POST['language']));
1101 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1102 $conf->set('api.enabled', !empty($_POST['enableApi']));
1105 generate_api_secret(
1106 $conf->get('credentials.login'),
1107 $conf->get('credentials.salt')
1111 // Everything is ok, let's create config file.
1112 $conf->write($loginManager->isLoggedIn());
1113 } catch (Exception
$e) {
1115 'ERROR while writing config file after installation.' . PHP_EOL
.
1119 // TODO: do not handle exceptions/errors in JS.
1120 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1124 $history = new History($conf->get('resource.history'));
1125 $bookmarkService = new BookmarkFileService($conf, $history, true);
1126 if ($bookmarkService->count() === 0) {
1127 $bookmarkService->initialize();
1130 echo '<script>alert('
1131 .'"Shaarli is now configured. '
1132 .'Please enter your login/password and start shaaring your bookmarks!"'
1133 .');document.location=\'./login\';</script>';
1137 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1138 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1139 $PAGE->assign('continents', $continents);
1140 $PAGE->assign('cities', $cities);
1141 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1142 $PAGE->renderPage('install');
1146 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1147 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1151 $history = new History($conf->get('resource.history'));
1152 } catch (Exception
$e) {
1153 die($e->getMessage());
1156 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1158 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1159 header('Location: ./daily-rss');
1163 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1164 $container = $containerBuilder->build();
1165 $app = new App($container);
1168 $app->group('/api/v1', function () {
1169 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1170 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1171 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1172 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1173 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1174 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1176 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1177 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1178 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1179 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1181 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1182 })->add('\Shaarli\Api\ApiMiddleware');
1184 $app->group('', function () {
1186 $this->get('/login', '\Shaarli\Front\Controller\Visitor\LoginController:index')->setName('login');
1187 $this->get('/picture-wall', '\Shaarli\Front\Controller\Visitor\PictureWallController:index')->setName('picwall');
1188 $this->get('/tag-cloud', '\Shaarli\Front\Controller\Visitor\TagCloudController:cloud')->setName('tagcloud');
1189 $this->get('/tag-list', '\Shaarli\Front\Controller\Visitor\TagCloudController:list')->setName('taglist');
1190 $this->get('/daily', '\Shaarli\Front\Controller\Visitor\DailyController:index')->setName('daily');
1191 $this->get('/daily-rss', '\Shaarli\Front\Controller\Visitor\DailyController:rss')->setName('dailyrss');
1192 $this->get('/feed-atom', '\Shaarli\Front\Controller\Visitor\FeedController:atom')->setName('feedatom');
1193 $this->get('/feed-rss', '\Shaarli\Front\Controller\Visitor\FeedController:rss')->setName('feedrss');
1194 $this->get('/open-search', '\Shaarli\Front\Controller\Visitor\OpenSearchController:index')->setName('opensearch');
1196 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\Visitor\TagController:addTag')->setName('add-tag');
1197 $this->get('/remove-tag/{tag}', '\Shaarli\Front\Controller\Visitor\TagController:removeTag')->setName('remove-tag');
1199 /* -- LOGGED IN -- */
1200 $this->get('/logout', '\Shaarli\Front\Controller\Admin\LogoutController:index')->setName('logout');
1201 $this->get('/tools', '\Shaarli\Front\Controller\Admin\ToolsController:index')->setName('tools');
1202 $this->get('/password', '\Shaarli\Front\Controller\Admin\PasswordController:index')->setName('password');
1203 $this->post('/password', '\Shaarli\Front\Controller\Admin\PasswordController:change')->setName('changePassword');
1204 $this->get('/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:index')->setName('configure');
1205 $this->post('/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:save')->setName('saveConfigure');
1206 $this->get('/manage-tags', '\Shaarli\Front\Controller\Admin\ManageTagController:index')->setName('manageTag');
1207 $this->post('/manage-tags', '\Shaarli\Front\Controller\Admin\ManageTagController:save')->setName('saveManageTag');
1208 $this->get('/add-shaare', '\Shaarli\Front\Controller\Admin\PostBookmarkController:addShaare')->setName('addShaare');
1210 ->get('/shaare', '\Shaarli\Front\Controller\Admin\PostBookmarkController:displayCreateForm')
1211 ->setName('newShaare');
1213 ->get('/shaare-{id}', '\Shaarli\Front\Controller\Admin\PostBookmarkController:displayEditForm')
1214 ->setName('editShaare');
1216 ->post('/shaare', '\Shaarli\Front\Controller\Admin\PostBookmarkController:save')
1217 ->setName('saveShaare');
1219 ->get('/delete-shaare', '\Shaarli\Front\Controller\Admin\PostBookmarkController:deleteBookmark')
1220 ->setName('deleteShaare');
1223 ->get('/links-per-page', '\Shaarli\Front\Controller\Admin\SessionFilterController:linksPerPage')
1224 ->setName('filter-links-per-page');
1226 ->get('/visibility/{visibility}', '\Shaarli\Front\Controller\Admin\SessionFilterController:visibility')
1227 ->setName('visibility');
1229 ->get('/untagged-only', '\Shaarli\Front\Controller\Admin\SessionFilterController:untaggedOnly')
1230 ->setName('untagged-only');
1231 })->add('\Shaarli\Front\ShaarliMiddleware');
1233 $response = $app->run(true);
1235 // Hack to make Slim and Shaarli router work together:
1236 // If a Slim route isn't found and NOT API call, we call renderPage().
1237 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1238 // We use UTF-8 for proper international characters handling.
1239 header('Content-Type: text/html; charset=utf-8');
1240 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1242 $response = $response
1243 ->withHeader('Access-Control-Allow-Origin', '*')
1245 'Access-Control-Allow-Headers',
1246 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1248 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1249 $app->respond($response);