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: ./tags/cloud');
420 if ($targetPage == Router
::$PAGE_TAGLIST) {
421 header('Location: ./tags/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 // TODO: Remove legacy admin route redirections. We'll only keep public URL.
504 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
505 if ($targetPage == Router
::$PAGE_TOOLS) {
506 header('Location: ./admin/tools');
510 // -------- User wants to change his/her password.
511 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
512 header('Location: ./admin/password');
516 // -------- User wants to change configuration
517 if ($targetPage == Router
::$PAGE_CONFIGURE) {
518 header('Location: ./admin/configure');
522 // -------- User wants to rename a tag or delete it
523 if ($targetPage == Router
::$PAGE_CHANGETAG) {
524 header('Location: ./admin/tags');
528 // -------- User wants to add a link without using the bookmarklet: Show form.
529 if ($targetPage == Router
::$PAGE_ADDLINK) {
530 header('Location: ./admin/shaare');
534 // -------- User clicked the "Save" button when editing a link: Save link to database.
535 if (isset($_POST['save_edit'])) {
536 // This route is no longer supported in legacy mode
537 header('Location: ./');
541 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
542 if ($targetPage == Router
::$PAGE_DELETELINK) {
543 $ids = $_GET['lf_linkdate'] ?? '';
544 $token = $_GET['token'] ?? '';
546 header('Location: ./admin/shaare/delete?id=' . $ids . '&token=' . $token);
550 // -------- User clicked either "Set public" or "Set private" bulk operation
551 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
552 header('Location: ./admin/shaare/visibility?id=' . $_GET['token']);
556 // -------- User clicked the "EDIT" button on a link: Display link edit form.
557 if (isset($_GET['edit_link'])) {
558 $id = (int) escape($_GET['edit_link']);
559 header('Location: ./admin/shaare/' . $id);
563 // -------- User want to post a new link: Display link edit form.
564 if (isset($_GET['post'])) {
565 header('Location: ./admin/shaare?' . http_build_query($_GET));
569 if ($targetPage == Router
::$PAGE_PINLINK) {
570 // This route is no longer supported in legacy mode
571 header('Location: ./');
575 if ($targetPage == Router
::$PAGE_EXPORT) {
576 header('Location: ./admin/export');
580 if ($targetPage == Router
::$PAGE_IMPORT) {
581 header('Location: ./admin/import');
585 // Plugin administration page
586 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
587 header('Location: ./admin/plugins');
591 // Plugin administration form action
592 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
593 // This route is no longer supported in legacy mode
594 header('Location: ./admin/plugins');
599 if ($targetPage == Router
::$GET_TOKEN) {
600 header('Content-Type:text/plain');
601 echo $sessionManager->generateToken();
605 // -------- Thumbnails Update
606 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
608 foreach ($bookmarkService->search() as $bookmark) {
609 // A note or not HTTP(S)
610 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
613 $ids[] = $bookmark->getId();
615 $PAGE->assign('ids', $ids);
616 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
617 $PAGE->renderPage('thumbnails');
621 // -------- Single Thumbnail Update
622 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
623 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
624 http_response_code(400);
627 $id = (int) $_POST['id'];
628 if (! $bookmarkService->exists($id)) {
629 http_response_code(404);
632 $thumbnailer = new Thumbnailer($conf);
633 $bookmark = $bookmarkService->get($id);
634 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
635 $bookmarkService->set($bookmark);
637 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
638 echo json_encode($factory->getFormatter('raw')->format($bookmark));
642 // -------- Otherwise, simply display search form and bookmarks:
643 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
648 * Template for the list of bookmarks (<div id="linklist">)
649 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
651 * @param pageBuilder $PAGE pageBuilder instance.
652 * @param BookmarkServiceInterface $linkDb LinkDB instance.
653 * @param ConfigManager $conf Configuration Manager instance.
654 * @param PluginManager $pluginManager Plugin Manager instance.
655 * @param LoginManager $loginManager LoginManager instance
657 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
659 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
660 $formatter = $factory->getFormatter();
663 if (isset($_GET['searchtags'])) {
664 if (! empty($_GET['searchtags'])) {
665 $searchtags = escape(normalize_spaces($_GET['searchtags']));
672 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
675 if (! empty($_SERVER['QUERY_STRING'])
676 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
678 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
679 } catch (BookmarkNotFoundException
$e) {
680 $PAGE->render404($e->getMessage());
684 // Filter bookmarks according search parameters.
685 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
687 'searchtags' => $searchtags,
688 'searchterm' => $searchterm,
690 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
693 // ---- Handle paging.
695 foreach ($linksToDisplay as $key => $value) {
699 // Select articles according to paging.
700 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
701 $pagecount = $pagecount == 0 ? 1 : $pagecount;
702 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
703 $page = $page < 1 ? 1 : $page;
704 $page = $page > $pagecount ? $pagecount : $page;
706 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
707 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
709 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
710 if ($thumbnailsEnabled) {
711 $thumbnailer = new Thumbnailer($conf);
715 while ($i<$end && $i<count($keys)) {
716 $link = $formatter->format($linksToDisplay[$keys[$i]]);
718 // Logged in, thumbnails enabled, not a note,
719 // and (never retrieved yet or no valid cache file)
720 if ($loginManager->isLoggedIn()
721 && $thumbnailsEnabled
722 && !$linksToDisplay[$keys[$i]]->isNote()
723 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
724 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
726 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
727 $linkDb->set($linksToDisplay[$keys[$i]], false);
729 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
732 // Check for both signs of a note: starting with ? and 7 chars long.
733 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
734 // $link['url'] = index_url($_SERVER) . $link['url'];
737 $linkDisp[$keys[$i]] = $link;
741 // If we retrieved new thumbnails, we update the database.
742 if (!empty($updateDB)) {
746 // Compute paging navigation
747 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
748 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
749 $previous_page_url = '';
750 if ($i != count($keys)) {
751 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
755 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
758 // Fill all template fields.
760 'previous_page_url' => $previous_page_url,
761 'next_page_url' => $next_page_url,
762 'page_current' => $page,
763 'page_max' => $pagecount,
764 'result_count' => count($linksToDisplay),
765 'search_term' => $searchterm,
766 'search_tags' => $searchtags,
767 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
768 'links' => $linkDisp,
771 // If there is only a single link, we change on-the-fly the title of the page.
772 if (count($linksToDisplay) == 1) {
773 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
774 } elseif (! empty($searchterm) || ! empty($searchtags)) {
775 $data['pagetitle'] = t('Search: ');
776 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
777 $bracketWrap = function ($tag) {
778 return '['. $tag .']';
780 $data['pagetitle'] .= ! empty($searchtags)
781 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
783 $data['pagetitle'] .= '- '. $conf->get('general.title');
786 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
788 foreach ($data as $key => $value) {
789 $PAGE->assign($key, $value);
797 * This function should NEVER be called if the file data/config.php exists.
799 * @param ConfigManager $conf Configuration Manager instance.
800 * @param SessionManager $sessionManager SessionManager instance
801 * @param LoginManager $loginManager LoginManager instance
803 function install($conf, $sessionManager, $loginManager)
805 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
806 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
807 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
811 // This part makes sure sessions works correctly.
812 // (Because on some hosts, session.save_path may not be set correctly,
813 // or we may not have write access to it.)
814 if (isset($_GET['test_session'])
815 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
816 // Step 2: Check if data in session is correct.
818 '<pre>Sessions do not seem to work correctly on your server.<br>'.
819 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
820 'and that you have write access to it.<br>'.
821 'It currently points to %s.<br>'.
822 'On some browsers, accessing your server via a hostname like \'localhost\' '.
823 'or any custom hostname without a dot causes cookie storage to fail. '.
824 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
826 $msg = sprintf($msg, session_save_path());
828 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
831 if (!isset($_SESSION['session_tested'])) {
832 // Step 1 : Try to store data in session and reload page.
833 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
834 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
836 if (isset($_GET['test_session'])) {
837 // Step 3: Sessions are OK. Remove test parameter from URL.
838 header('Location: '.index_url($_SERVER));
842 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
844 if (!empty($_POST['continent']) && !empty($_POST['city'])
845 && isTimeZoneValid($_POST['continent'], $_POST['city'])
847 $tz = $_POST['continent'].'/'.$_POST['city'];
849 $conf->set('general.timezone', $tz);
850 $login = $_POST['setlogin'];
851 $conf->set('credentials.login', $login);
852 $salt = sha1(uniqid('', true) .'_'. mt_rand());
853 $conf->set('credentials.salt', $salt);
854 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
855 if (!empty($_POST['title'])) {
856 $conf->set('general.title', escape($_POST['title']));
858 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
860 $conf->set('translation.language', escape($_POST['language']));
861 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
862 $conf->set('api.enabled', !empty($_POST['enableApi']));
866 $conf->get('credentials.login'),
867 $conf->get('credentials.salt')
871 // Everything is ok, let's create config file.
872 $conf->write($loginManager->isLoggedIn());
873 } catch (Exception
$e) {
875 'ERROR while writing config file after installation.' . PHP_EOL
.
879 // TODO: do not handle exceptions/errors in JS.
880 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
884 $history = new History($conf->get('resource.history'));
885 $bookmarkService = new BookmarkFileService($conf, $history, true);
886 if ($bookmarkService->count() === 0) {
887 $bookmarkService->initialize();
890 echo '<script>alert('
891 .'"Shaarli is now configured. '
892 .'Please enter your login/password and start shaaring your bookmarks!"'
893 .');document.location=\'./login\';</script>';
897 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
898 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
899 $PAGE->assign('continents', $continents);
900 $PAGE->assign('cities', $cities);
901 $PAGE->assign('languages', Languages
::getAvailableLanguages());
902 $PAGE->renderPage('install');
906 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
907 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
911 $history = new History($conf->get('resource.history'));
912 } catch (Exception
$e) {
913 die($e->getMessage());
916 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
918 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
919 header('Location: ./daily-rss');
923 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager);
924 $container = $containerBuilder->build();
925 $app = new App($container);
928 $app->group('/api/v1', function () {
929 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
930 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
931 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
932 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
933 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
934 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
936 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
937 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
938 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
939 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
941 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
942 })->add('\Shaarli\Api\ApiMiddleware');
944 $app->group('', function () {
946 $this->get('/login', '\Shaarli\Front\Controller\Visitor\LoginController:index');
947 $this->get('/picture-wall', '\Shaarli\Front\Controller\Visitor\PictureWallController:index');
948 $this->get('/tags/cloud', '\Shaarli\Front\Controller\Visitor\TagCloudController:cloud');
949 $this->get('/tags/list', '\Shaarli\Front\Controller\Visitor\TagCloudController:list');
950 $this->get('/daily', '\Shaarli\Front\Controller\Visitor\DailyController:index');
951 $this->get('/daily-rss', '\Shaarli\Front\Controller\Visitor\DailyController:rss');
952 $this->get('/feed/atom', '\Shaarli\Front\Controller\Visitor\FeedController:atom');
953 $this->get('/feed/rss', '\Shaarli\Front\Controller\Visitor\FeedController:rss');
954 $this->get('/open-search', '\Shaarli\Front\Controller\Visitor\OpenSearchController:index');
956 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\Visitor\TagController:addTag');
957 $this->get('/remove-tag/{tag}', '\Shaarli\Front\Controller\Visitor\TagController:removeTag');
959 /* -- LOGGED IN -- */
960 $this->get('/logout', '\Shaarli\Front\Controller\Admin\LogoutController:index');
961 $this->get('/admin/tools', '\Shaarli\Front\Controller\Admin\ToolsController:index');
962 $this->get('/admin/password', '\Shaarli\Front\Controller\Admin\PasswordController:index');
963 $this->post('/admin/password', '\Shaarli\Front\Controller\Admin\PasswordController:change');
964 $this->get('/admin/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:index');
965 $this->post('/admin/configure', '\Shaarli\Front\Controller\Admin\ConfigureController:save');
966 $this->get('/admin/tags', '\Shaarli\Front\Controller\Admin\ManageTagController:index');
967 $this->post('/admin/tags', '\Shaarli\Front\Controller\Admin\ManageTagController:save');
968 $this->get('/admin/add-shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:addShaare');
969 $this->get('/admin/shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:displayCreateForm');
970 $this->get('/admin/shaare/{id:[0-9]+}', '\Shaarli\Front\Controller\Admin\ManageShaareController:displayEditForm');
971 $this->post('/admin/shaare', '\Shaarli\Front\Controller\Admin\ManageShaareController:save');
972 $this->get('/admin/shaare/delete', '\Shaarli\Front\Controller\Admin\ManageShaareController:deleteBookmark');
973 $this->get('/admin/shaare/visibility', '\Shaarli\Front\Controller\Admin\ManageShaareController:changeVisibility');
974 $this->get('/admin/shaare/{id:[0-9]+}/pin', '\Shaarli\Front\Controller\Admin\ManageShaareController:pinBookmark');
975 $this->get('/admin/export', '\Shaarli\Front\Controller\Admin\ExportController:index');
976 $this->post('/admin/export', '\Shaarli\Front\Controller\Admin\ExportController:export');
977 $this->get('/admin/import', '\Shaarli\Front\Controller\Admin\ImportController:index');
978 $this->post('/admin/import', '\Shaarli\Front\Controller\Admin\ImportController:import');
979 $this->get('/admin/plugins', '\Shaarli\Front\Controller\Admin\PluginsController:index');
980 $this->post('/admin/plugins', '\Shaarli\Front\Controller\Admin\PluginsController:save');
982 $this->get('/links-per-page', '\Shaarli\Front\Controller\Admin\SessionFilterController:linksPerPage');
983 $this->get('/visibility/{visibility}', '\Shaarli\Front\Controller\Admin\SessionFilterController:visibility');
984 $this->get('/untagged-only', '\Shaarli\Front\Controller\Admin\SessionFilterController:untaggedOnly');
985 })->add('\Shaarli\Front\ShaarliMiddleware');
987 $response = $app->run(true);
989 // Hack to make Slim and Shaarli router work together:
990 // If a Slim route isn't found and NOT API call, we call renderPage().
991 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
992 // We use UTF-8 for proper international characters handling.
993 header('Content-Type: text/html; charset=utf-8');
994 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
996 $response = $response
997 ->withHeader('Access-Control-Allow-Origin', '*')
999 'Access-Control-Allow-Headers',
1000 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1002 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1003 $app->respond($response);