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 * Daily RSS feed: 1 RSS entry per day giving all the bookmarks on that day.
305 * Gives the last 7 days (which have bookmarks).
306 * This RSS feed cannot be filtered.
308 * @param BookmarkServiceInterface $bookmarkService
309 * @param ConfigManager $conf Configuration Manager instance
310 * @param LoginManager $loginManager LoginManager instance
312 function showDailyRSS($bookmarkService, $conf, $loginManager)
315 $query = $_SERVER['QUERY_STRING'];
316 $cache = new CachedPage(
317 $conf->get('config.PAGE_CACHE'),
319 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
321 $cached = $cache->cachedVersion();
322 if (!empty($cached)) {
327 /* Some Shaarlies may have very few bookmarks, so we need to look
328 back in time until we have enough days ($nb_of_days).
330 $nb_of_days = 7; // We take 7 days.
331 $today = date('Ymd');
334 foreach ($bookmarkService->search() as $bookmark) {
335 $day = $bookmark->getCreated()->format('Ymd'); // Extract day (without time)
336 if (strcmp($day, $today) < 0) {
337 if (empty($days[$day])) {
338 $days[$day] = array();
340 $days[$day][] = $bookmark;
343 if (count($days) > $nb_of_days) {
344 break; // Have we collected enough days?
348 // Build the RSS feed.
349 header('Content-Type: application/rss+xml; charset=utf-8');
350 $pageaddr = escape(index_url($_SERVER));
351 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
353 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
354 echo '<link>'. $pageaddr .'</link>';
355 echo '<description>Daily shared bookmarks</description>';
356 echo '<language>en-en</language>';
357 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
359 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
360 $formatter = $factory->getFormatter();
361 $formatter->addContextData('index_url', index_url($_SERVER));
363 /** @var Bookmark[] $bookmarks */
364 foreach ($days as $day => $bookmarks) {
365 $formattedBookmarks = [];
366 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
367 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
369 // We pre-format some fields for proper output.
370 foreach ($bookmarks as $key => $bookmark) {
371 $formattedBookmarks[$key] = $formatter->format($bookmark);
372 // This page is a bit specific, we need raw description to calculate the length
373 $formattedBookmarks[$key]['formatedDescription'] = $formattedBookmarks[$key]['description'];
374 $formattedBookmarks[$key]['description'] = $bookmark->getDescription();
376 if ($bookmark->isNote()) {
377 $link['url'] = index_url($_SERVER) . $bookmark->getUrl(); // make permalink URL absolute
381 // Then build the HTML for this day:
382 $tpl = new RainTPL();
383 $tpl->assign('title', $conf->get('general.title'));
384 $tpl->assign('daydate', $dayDate->getTimestamp());
385 $tpl->assign('absurl', $absurl);
386 $tpl->assign('links', $formattedBookmarks);
387 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
388 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
389 $tpl->assign('index_url', $pageaddr);
390 $html = $tpl->draw('dailyrss', true);
392 echo $html . PHP_EOL
;
394 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
396 $cache->cache(ob_get_contents());
402 * Show the 'Daily' page.
404 * @param PageBuilder $pageBuilder Template engine wrapper.
405 * @param BookmarkServiceInterface $bookmarkService instance.
406 * @param ConfigManager $conf Configuration Manager instance.
407 * @param PluginManager $pluginManager Plugin Manager instance.
408 * @param LoginManager $loginManager Login Manager instance
410 function showDaily($pageBuilder, $bookmarkService, $conf, $pluginManager, $loginManager)
412 if (isset($_GET['day'])) {
414 if ($day === date('Ymd', strtotime('now'))) {
415 $pageBuilder->assign('dayDesc', t('Today'));
416 } elseif ($day === date('Ymd', strtotime('-1 days'))) {
417 $pageBuilder->assign('dayDesc', t('Yesterday'));
420 $day = date('Ymd', strtotime('now')); // Today, in format YYYYMMDD.
421 $pageBuilder->assign('dayDesc', t('Today'));
424 $days = $bookmarkService->days();
425 $i = array_search($day, $days);
426 if ($i === false && count($days)) {
427 // no bookmarks for day, but at least one day with bookmarks
428 $i = count($days) - 1;
436 $previousday = $days[$i - 1];
438 if ($i < count($days) - 1) {
439 $nextday = $days[$i +
1];
443 $linksToDisplay = $bookmarkService->filterDay($day);
444 } catch (Exception
$exc) {
446 $linksToDisplay = [];
449 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
450 $formatter = $factory->getFormatter();
451 // We pre-format some fields for proper output.
452 foreach ($linksToDisplay as $key => $bookmark) {
453 $linksToDisplay[$key] = $formatter->format($bookmark);
454 // This page is a bit specific, we need raw description to calculate the length
455 $linksToDisplay[$key]['formatedDescription'] = $linksToDisplay[$key]['description'];
456 $linksToDisplay[$key]['description'] = $bookmark->getDescription();
459 $dayDate = DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, $day.'_000000');
461 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
462 'linksToDisplay' => $linksToDisplay,
463 'day' => $dayDate->getTimestamp(),
464 'dayDate' => $dayDate,
465 'previousday' => $previousday,
466 'nextday' => $nextday,
469 /* Hook is called before column construction so that plugins don't have
470 to deal with columns. */
471 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
473 /* We need to spread the articles on 3 columns.
474 I did not want to use a JavaScript lib like http://masonry.desandro.com/
475 so I manually spread entries with a simple method: I roughly evaluate the
476 height of a div according to title and description length.
478 $columns = array(array(), array(), array()); // Entries to display, for each column.
479 $fill = array(0, 0, 0); // Rough estimate of columns fill.
480 foreach ($data['linksToDisplay'] as $key => $bookmark) {
481 // Roughly estimate length of entry (by counting characters)
482 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
483 // Description: 836 characters gives roughly 342 pixel height.
484 // This is not perfect, but it's usually OK.
485 $length = strlen($bookmark['title']) +
(342 * strlen($bookmark['description'])) / 836;
486 if (! empty($bookmark['thumbnail'])) {
487 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
489 // Then put in column which is the less filled:
490 $smallest = min($fill); // find smallest value in array.
491 $index = array_search($smallest, $fill); // find index of this smallest value.
492 array_push($columns[$index], $bookmark); // Put entry in this column.
493 $fill[$index] +
= $length;
496 $data['cols'] = $columns;
498 foreach ($data as $key => $value) {
499 $pageBuilder->assign($key, $value);
502 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
503 $pageBuilder->renderPage('daily');
508 * Renders the linklist
510 * @param pageBuilder $PAGE pageBuilder instance.
511 * @param BookmarkServiceInterface $linkDb instance.
512 * @param ConfigManager $conf Configuration Manager instance.
513 * @param PluginManager $pluginManager Plugin Manager instance.
515 function showLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
517 buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager);
518 $PAGE->renderPage('linklist');
522 * Render HTML page (according to URL parameters and user rights)
524 * @param ConfigManager $conf Configuration Manager instance.
525 * @param PluginManager $pluginManager Plugin Manager instance,
526 * @param BookmarkServiceInterface $bookmarkService
527 * @param History $history instance
528 * @param SessionManager $sessionManager SessionManager instance
529 * @param LoginManager $loginManager LoginManager instance
531 function renderPage($conf, $pluginManager, $bookmarkService, $history, $sessionManager, $loginManager)
533 $pageCacheManager = new PageCacheManager($conf->get('resource.page_cache'));
534 $updater = new Updater(
535 UpdaterUtils
::read_updates_file($conf->get('resource.updates')),
538 $loginManager->isLoggedIn()
541 $newUpdates = $updater->update();
542 if (! empty($newUpdates)) {
543 UpdaterUtils
::write_updates_file(
544 $conf->get('resource.updates'),
545 $updater->getDoneUpdates()
548 $pageCacheManager->invalidateCaches();
550 } catch (Exception
$e) {
551 die($e->getMessage());
554 $PAGE = new PageBuilder($conf, $_SESSION, $bookmarkService, $sessionManager->generateToken(), $loginManager->isLoggedIn());
555 $PAGE->assign('linkcount', $bookmarkService->count(BookmarkFilter
::$ALL));
556 $PAGE->assign('privateLinkcount', $bookmarkService->count(BookmarkFilter
::$PRIVATE));
557 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
559 // Determine which page will be rendered.
560 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
561 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
563 if (// if the user isn't logged in
564 !$loginManager->isLoggedIn() &&
565 // and Shaarli doesn't have public content...
566 $conf->get('privacy.hide_public_links') &&
567 // and is configured to enforce the login
568 $conf->get('privacy.force_login') &&
569 // and the current page isn't already the login page
570 $targetPage !== Router
::$PAGE_LOGIN &&
571 // and the user is not requesting a feed (which would lead to a different content-type as expected)
572 $targetPage !== Router
::$PAGE_FEED_ATOM &&
573 $targetPage !== Router
::$PAGE_FEED_RSS
575 // force current page to be the login page
576 $targetPage = Router
::$PAGE_LOGIN;
579 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
580 // Then assign generated data to RainTPL.
581 $common_hooks = array(
587 foreach ($common_hooks as $name) {
588 $plugin_data = array();
589 $pluginManager->executeHooks(
593 'target' => $targetPage,
594 'loggedin' => $loginManager->isLoggedIn()
597 $PAGE->assign('plugins_' . $name, $plugin_data);
600 // -------- Display login form.
601 if ($targetPage == Router
::$PAGE_LOGIN) {
602 header('Location: ./login');
605 // -------- User wants to logout.
606 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
607 header('Location: ./logout');
611 // -------- Picture wall
612 if ($targetPage == Router
::$PAGE_PICWALL) {
613 header('Location: ./picture-wall');
617 // -------- Tag cloud
618 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
619 header('Location: ./tag-cloud');
624 if ($targetPage == Router
::$PAGE_TAGLIST) {
625 header('Location: ./tag-list');
630 if ($targetPage == Router
::$PAGE_DAILY) {
631 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
634 // ATOM and RSS feed.
635 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
636 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
637 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
640 $query = $_SERVER['QUERY_STRING'];
641 $cache = new CachedPage(
642 $conf->get('resource.page_cache'),
644 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
646 $cached = $cache->cachedVersion();
647 if (!empty($cached)) {
652 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
654 $feedGenerator = new FeedBuilder(
656 $factory->getFormatter(),
660 $loginManager->isLoggedIn()
662 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
663 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
664 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
665 $data = $feedGenerator->buildData();
667 // Process plugin hook.
668 $pluginManager->executeHooks('render_feed', $data, array(
669 'loggedin' => $loginManager->isLoggedIn(),
670 'target' => $targetPage,
673 // Render the template.
674 $PAGE->assignAll($data);
675 $PAGE->renderPage('feed.'. $feedType);
676 $cache->cache(ob_get_contents());
681 // Display opensearch plugin (XML)
682 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
683 header('Content-Type: application/xml; charset=utf-8');
684 $PAGE->assign('serverurl', index_url($_SERVER));
685 $PAGE->renderPage('opensearch');
689 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
690 if (isset($_GET['addtag'])) {
691 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
692 if (empty($_SERVER['HTTP_REFERER'])) {
693 // In case browser does not send HTTP_REFERER
694 header('Location: ?searchtags='.urlencode($_GET['addtag']));
697 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
699 // Prevent redirection loop
700 if (isset($params['addtag'])) {
701 unset($params['addtag']);
704 // Check if this tag is already in the search query and ignore it if it is.
705 // Each tag is always separated by a space
706 if (isset($params['searchtags'])) {
707 $current_tags = explode(' ', $params['searchtags']);
709 $current_tags = array();
712 foreach ($current_tags as $value) {
713 if ($value === $_GET['addtag']) {
718 // Append the tag if necessary
719 if (empty($params['searchtags'])) {
720 $params['searchtags'] = trim($_GET['addtag']);
722 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
725 // We also remove page (keeping the same page has no sense, since the
726 // results are different)
727 unset($params['page']);
729 header('Location: ?'.http_build_query($params));
733 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
734 if (isset($_GET['removetag'])) {
735 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
736 if (empty($_SERVER['HTTP_REFERER'])) {
737 header('Location: ?');
741 // In case browser does not send HTTP_REFERER
742 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
744 // Prevent redirection loop
745 if (isset($params['removetag'])) {
746 unset($params['removetag']);
749 if (isset($params['searchtags'])) {
750 $tags = explode(' ', $params['searchtags']);
751 // Remove value from array $tags.
752 $tags = array_diff($tags, array($_GET['removetag']));
753 $params['searchtags'] = implode(' ', $tags);
755 if (empty($params['searchtags'])) {
756 unset($params['searchtags']);
759 // We also remove page (keeping the same page has no sense, since
760 // the results are different)
761 unset($params['page']);
763 header('Location: ?'.http_build_query($params));
767 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
768 if (isset($_GET['linksperpage'])) {
769 if (is_numeric($_GET['linksperpage'])) {
770 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
773 if (! empty($_SERVER['HTTP_REFERER'])) {
774 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
778 header('Location: '. $location);
782 // -------- User wants to see only private bookmarks (toggle)
783 if (isset($_GET['visibility'])) {
784 if ($_GET['visibility'] === 'private') {
785 // Visibility not set or not already private, set private, otherwise reset it
786 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
787 // See only private bookmarks
788 $_SESSION['visibility'] = 'private';
790 unset($_SESSION['visibility']);
792 } elseif ($_GET['visibility'] === 'public') {
793 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
794 // See only public bookmarks
795 $_SESSION['visibility'] = 'public';
797 unset($_SESSION['visibility']);
801 if (! empty($_SERVER['HTTP_REFERER'])) {
802 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
806 header('Location: '. $location);
810 // -------- User wants to see only untagged bookmarks (toggle)
811 if (isset($_GET['untaggedonly'])) {
812 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
814 if (! empty($_SERVER['HTTP_REFERER'])) {
815 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
819 header('Location: '. $location);
823 // -------- Handle other actions allowed for non-logged in users:
824 if (!$loginManager->isLoggedIn()) {
825 // User tries to post new link but is not logged in:
826 // Show login screen, then redirect to ?post=...
827 if (isset($_GET['post'])) {
828 header( // Redirect to login page, then back to post link.
829 'Location: ./login?post='.urlencode($_GET['post']).
830 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
831 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
832 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
833 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
838 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
839 if (isset($_GET['edit_link'])) {
840 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
844 exit; // Never remove this one! All operations below are reserved for logged in user.
847 // -------- All other functions are reserved for the registered user:
849 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
850 if ($targetPage == Router
::$PAGE_TOOLS) {
852 'pageabsaddr' => index_url($_SERVER),
853 'sslenabled' => is_https($_SERVER),
855 $pluginManager->executeHooks('render_tools', $data);
857 foreach ($data as $key => $value) {
858 $PAGE->assign($key, $value);
861 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
862 $PAGE->renderPage('tools');
866 // -------- User wants to change his/her password.
867 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
868 if ($conf->get('security.open_shaarli')) {
869 die(t('You are not supposed to change a password on an Open Shaarli.'));
872 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
873 if (!$sessionManager->checkToken($_POST['token'])) {
874 die(t('Wrong token.')); // Go away!
877 // Make sure old password is correct.
879 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
881 if ($oldhash != $conf->get('credentials.hash')) {
882 echo '<script>alert("'
883 . t('The old password is not correct.')
884 .'");document.location=\'./?do=changepasswd\';</script>';
888 // Salt renders rainbow-tables attacks useless.
889 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
893 $_POST['setpassword']
894 . $conf->get('credentials.login')
895 . $conf->get('credentials.salt')
899 $conf->write($loginManager->isLoggedIn());
900 } catch (Exception
$e) {
902 'ERROR while writing config file after changing password.' . PHP_EOL
.
906 // TODO: do not handle exceptions/errors in JS.
907 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
910 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
913 // show the change password form.
914 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
915 $PAGE->renderPage('changepassword');
920 // -------- User wants to change configuration
921 if ($targetPage == Router
::$PAGE_CONFIGURE) {
922 if (!empty($_POST['title'])) {
923 if (!$sessionManager->checkToken($_POST['token'])) {
924 die(t('Wrong token.')); // Go away!
927 if (!empty($_POST['continent']) && !empty($_POST['city'])
928 && isTimeZoneValid($_POST['continent'], $_POST['city'])
930 $tz = $_POST['continent'] . '/' . $_POST['city'];
932 $conf->set('general.timezone', $tz);
933 $conf->set('general.title', escape($_POST['title']));
934 $conf->set('general.header_link', escape($_POST['titleLink']));
935 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
936 $conf->set('resource.theme', escape($_POST['theme']));
937 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
938 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
939 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
940 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
941 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
942 $conf->set('api.enabled', !empty($_POST['enableApi']));
943 $conf->set('api.secret', escape($_POST['apiSecret']));
944 $conf->set('formatter', escape($_POST['formatter']));
946 if (! empty($_POST['language'])) {
947 $conf->set('translation.language', escape($_POST['language']));
950 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
951 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
952 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
954 $_SESSION['warnings'][] = t(
955 'You have enabled or changed thumbnails mode. '
956 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
959 $conf->set('thumbnails.mode', $thumbnailsMode);
962 $conf->write($loginManager->isLoggedIn());
963 $history->updateSettings();
964 $pageCacheManager->invalidateCaches();
965 } catch (Exception
$e) {
967 'ERROR while writing config file after configuration update.' . PHP_EOL
.
971 // TODO: do not handle exceptions/errors in JS.
972 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
975 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
978 // Show the configuration form.
979 $PAGE->assign('title', $conf->get('general.title'));
980 $PAGE->assign('theme', $conf->get('resource.theme'));
981 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
982 $PAGE->assign('formatter_available', ['default', 'markdown']);
983 list($continents, $cities) = generateTimeZoneData(
984 timezone_identifiers_list(),
985 $conf->get('general.timezone')
987 $PAGE->assign('continents', $continents);
988 $PAGE->assign('cities', $cities);
989 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
990 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
991 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
992 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
993 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
994 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
995 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
996 $PAGE->assign('api_secret', $conf->get('api.secret'));
997 $PAGE->assign('languages', Languages
::getAvailableLanguages());
998 $PAGE->assign('gd_enabled', extension_loaded('gd'));
999 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1000 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1001 $PAGE->renderPage('configure');
1006 // -------- User wants to rename a tag or delete it
1007 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1008 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1009 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1010 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1011 $PAGE->renderPage('changetag');
1015 if (!$sessionManager->checkToken($_POST['token'])) {
1016 die(t('Wrong token.'));
1019 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1020 $fromTag = escape($_POST['fromtag']);
1022 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1023 foreach ($bookmarks as $bookmark) {
1025 $bookmark->renameTag($fromTag, $toTag);
1027 $bookmark->deleteTag($fromTag);
1029 $bookmarkService->set($bookmark, false);
1030 $history->updateLink($bookmark);
1033 $bookmarkService->save();
1034 $delete = empty($_POST['totag']);
1035 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1037 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1038 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1039 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1043 // -------- User wants to add a link without using the bookmarklet: Show form.
1044 if ($targetPage == Router
::$PAGE_ADDLINK) {
1045 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1046 $PAGE->renderPage('addlink');
1050 // -------- User clicked the "Save" button when editing a link: Save link to database.
1051 if (isset($_POST['save_edit'])) {
1053 if (! $sessionManager->checkToken($_POST['token'])) {
1054 die(t('Wrong token.'));
1057 // lf_id should only be present if the link exists.
1058 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1059 if ($id && $bookmarkService->exists($id)) {
1061 $bookmark = $bookmarkService->get($id);
1064 $bookmark = new Bookmark();
1067 $bookmark->setTitle($_POST['lf_title']);
1068 $bookmark->setDescription($_POST['lf_description']);
1069 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1070 $bookmark->setPrivate(isset($_POST['lf_private']));
1071 $bookmark->setTagsString($_POST['lf_tags']);
1073 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1074 && ! $bookmark->isNote()
1076 $thumbnailer = new Thumbnailer($conf);
1077 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1079 $bookmarkService->addOrSet($bookmark, false);
1081 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1082 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1083 $formatter = $factory->getFormatter('raw');
1084 $data = $formatter->format($bookmark);
1085 $pluginManager->executeHooks('save_link', $data);
1087 $bookmark->fromArray($data);
1088 $bookmarkService->set($bookmark);
1090 // If we are called from the bookmarklet, we must close the popup:
1091 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1092 echo '<script>self.close();</script>';
1096 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1097 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1098 // Scroll to the link which has been edited.
1099 $location .= '#' . $bookmark->getShortUrl();
1100 // After saving the link, redirect to the page the user was on.
1101 header('Location: '. $location);
1105 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1106 if ($targetPage == Router
::$PAGE_DELETELINK) {
1107 if (! $sessionManager->checkToken($_GET['token'])) {
1108 die(t('Wrong token.'));
1111 $ids = trim($_GET['lf_linkdate']);
1112 if (strpos($ids, ' ') !== false) {
1113 // multiple, space-separated ids provided
1114 $ids = array_values(array_filter(
1115 preg_split('/\s+/', escape($ids)),
1117 return $item !== '';
1121 // only a single id provided
1122 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1125 // assert at least one id is given
1127 die('no id provided');
1129 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1130 $formatter = $factory->getFormatter('raw');
1131 foreach ($ids as $id) {
1132 $id = (int) escape($id);
1133 $bookmark = $bookmarkService->get($id);
1134 $data = $formatter->format($bookmark);
1135 $pluginManager->executeHooks('delete_link', $data);
1136 $bookmarkService->remove($bookmark, false);
1138 $bookmarkService->save();
1140 // If we are called from the bookmarklet, we must close the popup:
1141 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1142 echo '<script>self.close();</script>';
1147 if (isset($_SERVER['HTTP_REFERER'])) {
1148 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1149 $location = generateLocation(
1150 $_SERVER['HTTP_REFERER'],
1151 $_SERVER['HTTP_HOST'],
1152 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1156 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1160 // -------- User clicked either "Set public" or "Set private" bulk operation
1161 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1162 if (! $sessionManager->checkToken($_GET['token'])) {
1163 die(t('Wrong token.'));
1166 $ids = trim($_GET['ids']);
1167 if (strpos($ids, ' ') !== false) {
1168 // multiple, space-separated ids provided
1169 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1171 // only a single id provided
1175 // assert at least one id is given
1177 die('no id provided');
1179 // assert that the visibility is valid
1180 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1181 die('invalid visibility');
1183 $private = $_GET['newVisibility'] === 'private';
1185 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1186 $formatter = $factory->getFormatter('raw');
1187 foreach ($ids as $id) {
1188 $id = (int) escape($id);
1189 $bookmark = $bookmarkService->get($id);
1190 $bookmark->setPrivate($private);
1192 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1193 $data = $formatter->format($bookmark);
1194 $pluginManager->executeHooks('save_link', $data);
1195 $bookmark->fromArray($data);
1197 $bookmarkService->set($bookmark);
1199 $bookmarkService->save();
1202 if (isset($_SERVER['HTTP_REFERER'])) {
1203 $location = generateLocation(
1204 $_SERVER['HTTP_REFERER'],
1205 $_SERVER['HTTP_HOST']
1208 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1212 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1213 if (isset($_GET['edit_link'])) {
1214 $id = (int) escape($_GET['edit_link']);
1216 $link = $bookmarkService->get($id); // Read database
1217 } catch (BookmarkNotFoundException
$e) {
1218 // Link not found in database.
1219 header('Location: ?');
1223 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1224 $formatter = $factory->getFormatter('raw');
1225 $formattedLink = $formatter->format($link);
1226 $tags = $bookmarkService->bookmarksCountPerTag();
1227 if ($conf->get('formatter') === 'markdown') {
1228 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1231 'link' => $formattedLink,
1232 'link_is_new' => false,
1233 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1236 $pluginManager->executeHooks('render_editlink', $data);
1238 foreach ($data as $key => $value) {
1239 $PAGE->assign($key, $value);
1242 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1243 $PAGE->renderPage('editlink');
1247 // -------- User want to post a new link: Display link edit form.
1248 if (isset($_GET['post'])) {
1249 $url = cleanup_url($_GET['post']);
1251 $link_is_new = false;
1252 // Check if URL is not already in database (in this case, we will edit the existing link)
1253 $bookmark = $bookmarkService->findByUrl($url);
1255 $link_is_new = true;
1256 // Get title if it was provided in URL (by the bookmarklet).
1257 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1258 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1259 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1260 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1261 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1263 // If this is an HTTP(S) link, we try go get the page to extract
1264 // the title (otherwise we will to straight to the edit form.)
1265 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1266 $retrieveDescription = $conf->get('general.retrieve_description');
1267 // Short timeout to keep the application responsive
1268 // The callback will fill $charset and $title with data from the downloaded page.
1271 $conf->get('general.download_timeout', 30),
1272 $conf->get('general.download_max_size', 4194304),
1273 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1275 if (! empty($title) && strtolower($charset) != 'utf-8') {
1276 $title = mb_convert_encoding($title, 'utf-8', $charset);
1281 $title = $conf->get('general.default_note_title', t('Note: '));
1283 $url = escape($url);
1284 $title = escape($title);
1289 'description' => $description,
1291 'private' => $private,
1294 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1295 $formatter = $factory->getFormatter('raw');
1296 $link = $formatter->format($bookmark);
1299 $tags = $bookmarkService->bookmarksCountPerTag();
1300 if ($conf->get('formatter') === 'markdown') {
1301 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1305 'link_is_new' => $link_is_new,
1306 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1307 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1309 'default_private_links' => $conf->get('privacy.default_private_links', false),
1311 $pluginManager->executeHooks('render_editlink', $data);
1313 foreach ($data as $key => $value) {
1314 $PAGE->assign($key, $value);
1317 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1318 $PAGE->renderPage('editlink');
1322 if ($targetPage == Router
::$PAGE_PINLINK) {
1323 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1324 // FIXME! Use a proper error system.
1325 $msg = t('Invalid link ID provided');
1326 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1329 if (! $sessionManager->checkToken($_GET['token'])) {
1330 die('Wrong token.');
1333 $link = $bookmarkService->get($_GET['id']);
1334 $link->setSticky(! $link->isSticky());
1335 $bookmarkService->set($link);
1336 header('Location: '.index_url($_SERVER));
1340 if ($targetPage == Router
::$PAGE_EXPORT) {
1341 // Export bookmarks as a Netscape Bookmarks file
1343 if (empty($_GET['selection'])) {
1344 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1345 $PAGE->renderPage('export');
1349 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1350 $selection = $_GET['selection'];
1351 if (isset($_GET['prepend_note_url'])) {
1352 $prependNoteUrl = $_GET['prepend_note_url'];
1354 $prependNoteUrl = false;
1358 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1359 $formatter = $factory->getFormatter('raw');
1362 NetscapeBookmarkUtils
::filterAndFormat(
1370 } catch (Exception
$exc) {
1371 header('Content-Type: text/plain; charset=utf-8');
1372 echo $exc->getMessage();
1375 $now = new DateTime();
1376 header('Content-Type: text/html; charset=utf-8');
1378 'Content-disposition: attachment; filename=bookmarks_'
1379 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1381 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1382 $PAGE->assign('eol', PHP_EOL
);
1383 $PAGE->assign('selection', $selection);
1384 $PAGE->renderPage('export.bookmarks');
1388 if ($targetPage == Router
::$PAGE_IMPORT) {
1389 // Upload a Netscape bookmark dump to import its contents
1391 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1392 // Show import dialog
1395 get_max_upload_size(
1396 ini_get('post_max_size'),
1397 ini_get('upload_max_filesize'),
1403 get_max_upload_size(
1404 ini_get('post_max_size'),
1405 ini_get('upload_max_filesize'),
1409 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1410 $PAGE->renderPage('import');
1414 // Import bookmarks from an uploaded file
1415 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1416 // The file is too big or some form field may be missing.
1419 'The file you are trying to upload is probably bigger than what this webserver can accept'
1420 .' (%s). Please upload in smaller chunks.'
1422 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1424 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1427 if (! $sessionManager->checkToken($_POST['token'])) {
1428 die('Wrong token.');
1430 $status = NetscapeBookmarkUtils
::import(
1437 echo '<script>alert("'.$status.'");document.location=\'./?do='
1438 .Router
::$PAGE_IMPORT .'\';</script>';
1442 // Plugin administration page
1443 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1444 $pluginMeta = $pluginManager->getPluginsMeta();
1446 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1447 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1448 return $v['order'] !== false;
1451 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1455 return $a['order'] - $b['order'];
1458 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1459 return $v['order'] === false;
1462 $PAGE->assign('enabledPlugins', $enabledPlugins);
1463 $PAGE->assign('disabledPlugins', $disabledPlugins);
1464 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1465 $PAGE->renderPage('pluginsadmin');
1469 // Plugin administration form action
1470 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1472 if (isset($_POST['parameters_form'])) {
1473 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1474 unset($_POST['parameters_form']);
1475 foreach ($_POST as $param => $value) {
1476 $conf->set('plugins.'. $param, escape($value));
1479 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1481 $conf->write($loginManager->isLoggedIn());
1482 $history->updateSettings();
1483 } catch (Exception
$e) {
1485 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1489 // TODO: do not handle exceptions/errors in JS.
1490 echo '<script>alert("'
1492 .'");document.location=\'./?do='
1493 . Router
::$PAGE_PLUGINSADMIN
1497 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1501 // Get a fresh token
1502 if ($targetPage == Router
::$GET_TOKEN) {
1503 header('Content-Type:text/plain');
1504 echo $sessionManager->generateToken();
1508 // -------- Thumbnails Update
1509 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1511 foreach ($bookmarkService->search() as $bookmark) {
1512 // A note or not HTTP(S)
1513 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1516 $ids[] = $bookmark->getId();
1518 $PAGE->assign('ids', $ids);
1519 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1520 $PAGE->renderPage('thumbnails');
1524 // -------- Single Thumbnail Update
1525 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1526 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1527 http_response_code(400);
1530 $id = (int) $_POST['id'];
1531 if (! $bookmarkService->exists($id)) {
1532 http_response_code(404);
1535 $thumbnailer = new Thumbnailer($conf);
1536 $bookmark = $bookmarkService->get($id);
1537 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1538 $bookmarkService->set($bookmark);
1540 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1541 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1545 // -------- Otherwise, simply display search form and bookmarks:
1546 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1551 * Template for the list of bookmarks (<div id="linklist">)
1552 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1554 * @param pageBuilder $PAGE pageBuilder instance.
1555 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1556 * @param ConfigManager $conf Configuration Manager instance.
1557 * @param PluginManager $pluginManager Plugin Manager instance.
1558 * @param LoginManager $loginManager LoginManager instance
1560 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1562 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1563 $formatter = $factory->getFormatter();
1565 // Used in templates
1566 if (isset($_GET['searchtags'])) {
1567 if (! empty($_GET['searchtags'])) {
1568 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1570 $searchtags = false;
1575 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1578 if (! empty($_SERVER['QUERY_STRING'])
1579 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1581 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1582 } catch (BookmarkNotFoundException
$e) {
1583 $PAGE->render404($e->getMessage());
1587 // Filter bookmarks according search parameters.
1588 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1590 'searchtags' => $searchtags,
1591 'searchterm' => $searchterm,
1593 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1596 // ---- Handle paging.
1598 foreach ($linksToDisplay as $key => $value) {
1602 // Select articles according to paging.
1603 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1604 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1605 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1606 $page = $page < 1 ? 1 : $page;
1607 $page = $page > $pagecount ? $pagecount : $page;
1609 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1610 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1612 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1613 if ($thumbnailsEnabled) {
1614 $thumbnailer = new Thumbnailer($conf);
1617 $linkDisp = array();
1618 while ($i<$end && $i<count($keys)) {
1619 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1621 // Logged in, thumbnails enabled, not a note,
1622 // and (never retrieved yet or no valid cache file)
1623 if ($loginManager->isLoggedIn()
1624 && $thumbnailsEnabled
1625 && !$linksToDisplay[$keys[$i]]->isNote()
1626 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1627 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1629 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1630 $linkDb->set($linksToDisplay[$keys[$i]], false);
1632 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1635 // Check for both signs of a note: starting with ? and 7 chars long.
1636 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1637 // $link['url'] = index_url($_SERVER) . $link['url'];
1640 $linkDisp[$keys[$i]] = $link;
1644 // If we retrieved new thumbnails, we update the database.
1645 if (!empty($updateDB)) {
1649 // Compute paging navigation
1650 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1651 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1652 $previous_page_url = '';
1653 if ($i != count($keys)) {
1654 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1658 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1661 // Fill all template fields.
1663 'previous_page_url' => $previous_page_url,
1664 'next_page_url' => $next_page_url,
1665 'page_current' => $page,
1666 'page_max' => $pagecount,
1667 'result_count' => count($linksToDisplay),
1668 'search_term' => $searchterm,
1669 'search_tags' => $searchtags,
1670 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1671 'links' => $linkDisp,
1674 // If there is only a single link, we change on-the-fly the title of the page.
1675 if (count($linksToDisplay) == 1) {
1676 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1677 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1678 $data['pagetitle'] = t('Search: ');
1679 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1680 $bracketWrap = function ($tag) {
1681 return '['. $tag .']';
1683 $data['pagetitle'] .= ! empty($searchtags)
1684 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1686 $data['pagetitle'] .= '- '. $conf->get('general.title');
1689 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1691 foreach ($data as $key => $value) {
1692 $PAGE->assign($key, $value);
1700 * This function should NEVER be called if the file data/config.php exists.
1702 * @param ConfigManager $conf Configuration Manager instance.
1703 * @param SessionManager $sessionManager SessionManager instance
1704 * @param LoginManager $loginManager LoginManager instance
1706 function install($conf, $sessionManager, $loginManager)
1708 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1709 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1710 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1714 // This part makes sure sessions works correctly.
1715 // (Because on some hosts, session.save_path may not be set correctly,
1716 // or we may not have write access to it.)
1717 if (isset($_GET['test_session'])
1718 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1719 // Step 2: Check if data in session is correct.
1721 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1722 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1723 'and that you have write access to it.<br>'.
1724 'It currently points to %s.<br>'.
1725 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1726 'or any custom hostname without a dot causes cookie storage to fail. '.
1727 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1729 $msg = sprintf($msg, session_save_path());
1731 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1734 if (!isset($_SESSION['session_tested'])) {
1735 // Step 1 : Try to store data in session and reload page.
1736 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1737 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1739 if (isset($_GET['test_session'])) {
1740 // Step 3: Sessions are OK. Remove test parameter from URL.
1741 header('Location: '.index_url($_SERVER));
1745 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1747 if (!empty($_POST['continent']) && !empty($_POST['city'])
1748 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1750 $tz = $_POST['continent'].'/'.$_POST['city'];
1752 $conf->set('general.timezone', $tz);
1753 $login = $_POST['setlogin'];
1754 $conf->set('credentials.login', $login);
1755 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1756 $conf->set('credentials.salt', $salt);
1757 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1758 if (!empty($_POST['title'])) {
1759 $conf->set('general.title', escape($_POST['title']));
1761 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1763 $conf->set('translation.language', escape($_POST['language']));
1764 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1765 $conf->set('api.enabled', !empty($_POST['enableApi']));
1768 generate_api_secret(
1769 $conf->get('credentials.login'),
1770 $conf->get('credentials.salt')
1774 // Everything is ok, let's create config file.
1775 $conf->write($loginManager->isLoggedIn());
1776 } catch (Exception
$e) {
1778 'ERROR while writing config file after installation.' . PHP_EOL
.
1782 // TODO: do not handle exceptions/errors in JS.
1783 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1787 $history = new History($conf->get('resource.history'));
1788 $bookmarkService = new BookmarkFileService($conf, $history, true);
1789 if ($bookmarkService->count() === 0) {
1790 $bookmarkService->initialize();
1793 echo '<script>alert('
1794 .'"Shaarli is now configured. '
1795 .'Please enter your login/password and start shaaring your bookmarks!"'
1796 .');document.location=\'./login\';</script>';
1800 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1801 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1802 $PAGE->assign('continents', $continents);
1803 $PAGE->assign('cities', $cities);
1804 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1805 $PAGE->renderPage('install');
1809 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1810 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1814 $history = new History($conf->get('resource.history'));
1815 } catch (Exception
$e) {
1816 die($e->getMessage());
1819 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1821 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1822 showDailyRSS($linkDb, $conf, $loginManager);
1826 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1827 $container = $containerBuilder->build();
1828 $app = new App($container);
1831 $app->group('/api/v1', function () {
1832 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1833 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1834 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1835 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1836 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1837 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1839 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1840 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1841 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1842 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1844 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1845 })->add('\Shaarli\Api\ApiMiddleware');
1847 $app->group('', function () {
1848 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1849 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1850 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1851 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:cloud')->setName('tagcloud');
1852 $this->get('/tag-list', '\Shaarli\Front\Controller\TagCloudController:list')->setName('taglist');
1853 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1854 })->add('\Shaarli\Front\ShaarliMiddleware');
1856 $response = $app->run(true);
1858 // Hack to make Slim and Shaarli router work together:
1859 // If a Slim route isn't found and NOT API call, we call renderPage().
1860 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1861 // We use UTF-8 for proper international characters handling.
1862 header('Content-Type: text/html; charset=utf-8');
1863 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1865 $response = $response
1866 ->withHeader('Access-Control-Allow-Origin', '*')
1868 'Access-Control-Allow-Headers',
1869 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1871 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1872 $app->respond($response);