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 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
626 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
627 $tags = $bookmarkService->bookmarksCountPerTag($filteringTags, $visibility);
629 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
630 alphabetical_sort($tags, false, true);
633 $searchTags = implode(' ', escape($filteringTags));
635 'search_tags' => $searchTags,
638 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
640 foreach ($data as $key => $value) {
641 $PAGE->assign($key, $value);
644 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
645 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
646 $PAGE->renderPage('tag.list');
651 if ($targetPage == Router
::$PAGE_DAILY) {
652 showDaily($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
655 // ATOM and RSS feed.
656 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
657 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
658 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
661 $query = $_SERVER['QUERY_STRING'];
662 $cache = new CachedPage(
663 $conf->get('resource.page_cache'),
665 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
667 $cached = $cache->cachedVersion();
668 if (!empty($cached)) {
673 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
675 $feedGenerator = new FeedBuilder(
677 $factory->getFormatter(),
681 $loginManager->isLoggedIn()
683 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
684 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
685 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
686 $data = $feedGenerator->buildData();
688 // Process plugin hook.
689 $pluginManager->executeHooks('render_feed', $data, array(
690 'loggedin' => $loginManager->isLoggedIn(),
691 'target' => $targetPage,
694 // Render the template.
695 $PAGE->assignAll($data);
696 $PAGE->renderPage('feed.'. $feedType);
697 $cache->cache(ob_get_contents());
702 // Display opensearch plugin (XML)
703 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
704 header('Content-Type: application/xml; charset=utf-8');
705 $PAGE->assign('serverurl', index_url($_SERVER));
706 $PAGE->renderPage('opensearch');
710 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
711 if (isset($_GET['addtag'])) {
712 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
713 if (empty($_SERVER['HTTP_REFERER'])) {
714 // In case browser does not send HTTP_REFERER
715 header('Location: ?searchtags='.urlencode($_GET['addtag']));
718 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
720 // Prevent redirection loop
721 if (isset($params['addtag'])) {
722 unset($params['addtag']);
725 // Check if this tag is already in the search query and ignore it if it is.
726 // Each tag is always separated by a space
727 if (isset($params['searchtags'])) {
728 $current_tags = explode(' ', $params['searchtags']);
730 $current_tags = array();
733 foreach ($current_tags as $value) {
734 if ($value === $_GET['addtag']) {
739 // Append the tag if necessary
740 if (empty($params['searchtags'])) {
741 $params['searchtags'] = trim($_GET['addtag']);
743 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
746 // We also remove page (keeping the same page has no sense, since the
747 // results are different)
748 unset($params['page']);
750 header('Location: ?'.http_build_query($params));
754 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
755 if (isset($_GET['removetag'])) {
756 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
757 if (empty($_SERVER['HTTP_REFERER'])) {
758 header('Location: ?');
762 // In case browser does not send HTTP_REFERER
763 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
765 // Prevent redirection loop
766 if (isset($params['removetag'])) {
767 unset($params['removetag']);
770 if (isset($params['searchtags'])) {
771 $tags = explode(' ', $params['searchtags']);
772 // Remove value from array $tags.
773 $tags = array_diff($tags, array($_GET['removetag']));
774 $params['searchtags'] = implode(' ', $tags);
776 if (empty($params['searchtags'])) {
777 unset($params['searchtags']);
780 // We also remove page (keeping the same page has no sense, since
781 // the results are different)
782 unset($params['page']);
784 header('Location: ?'.http_build_query($params));
788 // -------- User wants to change the number of bookmarks per page (linksperpage=...)
789 if (isset($_GET['linksperpage'])) {
790 if (is_numeric($_GET['linksperpage'])) {
791 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
794 if (! empty($_SERVER['HTTP_REFERER'])) {
795 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
799 header('Location: '. $location);
803 // -------- User wants to see only private bookmarks (toggle)
804 if (isset($_GET['visibility'])) {
805 if ($_GET['visibility'] === 'private') {
806 // Visibility not set or not already private, set private, otherwise reset it
807 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
808 // See only private bookmarks
809 $_SESSION['visibility'] = 'private';
811 unset($_SESSION['visibility']);
813 } elseif ($_GET['visibility'] === 'public') {
814 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
815 // See only public bookmarks
816 $_SESSION['visibility'] = 'public';
818 unset($_SESSION['visibility']);
822 if (! empty($_SERVER['HTTP_REFERER'])) {
823 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
827 header('Location: '. $location);
831 // -------- User wants to see only untagged bookmarks (toggle)
832 if (isset($_GET['untaggedonly'])) {
833 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
835 if (! empty($_SERVER['HTTP_REFERER'])) {
836 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
840 header('Location: '. $location);
844 // -------- Handle other actions allowed for non-logged in users:
845 if (!$loginManager->isLoggedIn()) {
846 // User tries to post new link but is not logged in:
847 // Show login screen, then redirect to ?post=...
848 if (isset($_GET['post'])) {
849 header( // Redirect to login page, then back to post link.
850 'Location: ./login?post='.urlencode($_GET['post']).
851 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
852 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
853 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
854 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
859 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
860 if (isset($_GET['edit_link'])) {
861 header('Location: ./login?edit_link='. escape($_GET['edit_link']));
865 exit; // Never remove this one! All operations below are reserved for logged in user.
868 // -------- All other functions are reserved for the registered user:
870 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
871 if ($targetPage == Router
::$PAGE_TOOLS) {
873 'pageabsaddr' => index_url($_SERVER),
874 'sslenabled' => is_https($_SERVER),
876 $pluginManager->executeHooks('render_tools', $data);
878 foreach ($data as $key => $value) {
879 $PAGE->assign($key, $value);
882 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
883 $PAGE->renderPage('tools');
887 // -------- User wants to change his/her password.
888 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
889 if ($conf->get('security.open_shaarli')) {
890 die(t('You are not supposed to change a password on an Open Shaarli.'));
893 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
894 if (!$sessionManager->checkToken($_POST['token'])) {
895 die(t('Wrong token.')); // Go away!
898 // Make sure old password is correct.
900 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
902 if ($oldhash != $conf->get('credentials.hash')) {
903 echo '<script>alert("'
904 . t('The old password is not correct.')
905 .'");document.location=\'./?do=changepasswd\';</script>';
909 // Salt renders rainbow-tables attacks useless.
910 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
914 $_POST['setpassword']
915 . $conf->get('credentials.login')
916 . $conf->get('credentials.salt')
920 $conf->write($loginManager->isLoggedIn());
921 } catch (Exception
$e) {
923 'ERROR while writing config file after changing password.' . PHP_EOL
.
927 // TODO: do not handle exceptions/errors in JS.
928 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=tools\';</script>';
931 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'./?do=tools\';</script>';
934 // show the change password form.
935 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
936 $PAGE->renderPage('changepassword');
941 // -------- User wants to change configuration
942 if ($targetPage == Router
::$PAGE_CONFIGURE) {
943 if (!empty($_POST['title'])) {
944 if (!$sessionManager->checkToken($_POST['token'])) {
945 die(t('Wrong token.')); // Go away!
948 if (!empty($_POST['continent']) && !empty($_POST['city'])
949 && isTimeZoneValid($_POST['continent'], $_POST['city'])
951 $tz = $_POST['continent'] . '/' . $_POST['city'];
953 $conf->set('general.timezone', $tz);
954 $conf->set('general.title', escape($_POST['title']));
955 $conf->set('general.header_link', escape($_POST['titleLink']));
956 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
957 $conf->set('resource.theme', escape($_POST['theme']));
958 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
959 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
960 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
961 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
962 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
963 $conf->set('api.enabled', !empty($_POST['enableApi']));
964 $conf->set('api.secret', escape($_POST['apiSecret']));
965 $conf->set('formatter', escape($_POST['formatter']));
967 if (! empty($_POST['language'])) {
968 $conf->set('translation.language', escape($_POST['language']));
971 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
972 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
973 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
975 $_SESSION['warnings'][] = t(
976 'You have enabled or changed thumbnails mode. '
977 .'<a href="./?do=thumbs_update">Please synchronize them</a>.'
980 $conf->set('thumbnails.mode', $thumbnailsMode);
983 $conf->write($loginManager->isLoggedIn());
984 $history->updateSettings();
985 $pageCacheManager->invalidateCaches();
986 } catch (Exception
$e) {
988 'ERROR while writing config file after configuration update.' . PHP_EOL
.
992 // TODO: do not handle exceptions/errors in JS.
993 echo '<script>alert("'. $e->getMessage() .'");document.location=\'./?do=configure\';</script>';
996 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'./?do=configure\';</script>';
999 // Show the configuration form.
1000 $PAGE->assign('title', $conf->get('general.title'));
1001 $PAGE->assign('theme', $conf->get('resource.theme'));
1002 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1003 $PAGE->assign('formatter_available', ['default', 'markdown']);
1004 list($continents, $cities) = generateTimeZoneData(
1005 timezone_identifiers_list(),
1006 $conf->get('general.timezone')
1008 $PAGE->assign('continents', $continents);
1009 $PAGE->assign('cities', $cities);
1010 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1011 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1012 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1013 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1014 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1015 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1016 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1017 $PAGE->assign('api_secret', $conf->get('api.secret'));
1018 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1019 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1020 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1021 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1022 $PAGE->renderPage('configure');
1027 // -------- User wants to rename a tag or delete it
1028 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1029 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1030 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1031 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1032 $PAGE->renderPage('changetag');
1036 if (!$sessionManager->checkToken($_POST['token'])) {
1037 die(t('Wrong token.'));
1040 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1041 $fromTag = escape($_POST['fromtag']);
1043 $bookmarks = $bookmarkService->search(['searchtags' => $fromTag], BookmarkFilter
::$ALL, true);
1044 foreach ($bookmarks as $bookmark) {
1046 $bookmark->renameTag($fromTag, $toTag);
1048 $bookmark->deleteTag($fromTag);
1050 $bookmarkService->set($bookmark, false);
1051 $history->updateLink($bookmark);
1054 $bookmarkService->save();
1055 $delete = empty($_POST['totag']);
1056 $redirect = $delete ? './do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1058 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d bookmarks.', $count), $count)
1059 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d bookmarks.', $count), $count);
1060 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1064 // -------- User wants to add a link without using the bookmarklet: Show form.
1065 if ($targetPage == Router
::$PAGE_ADDLINK) {
1066 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1067 $PAGE->renderPage('addlink');
1071 // -------- User clicked the "Save" button when editing a link: Save link to database.
1072 if (isset($_POST['save_edit'])) {
1074 if (! $sessionManager->checkToken($_POST['token'])) {
1075 die(t('Wrong token.'));
1078 // lf_id should only be present if the link exists.
1079 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : null;
1080 if ($id && $bookmarkService->exists($id)) {
1082 $bookmark = $bookmarkService->get($id);
1085 $bookmark = new Bookmark();
1088 $bookmark->setTitle($_POST['lf_title']);
1089 $bookmark->setDescription($_POST['lf_description']);
1090 $bookmark->setUrl($_POST['lf_url'], $conf->get('security.allowed_protocols'));
1091 $bookmark->setPrivate(isset($_POST['lf_private']));
1092 $bookmark->setTagsString($_POST['lf_tags']);
1094 if ($conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
1095 && ! $bookmark->isNote()
1097 $thumbnailer = new Thumbnailer($conf);
1098 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1100 $bookmarkService->addOrSet($bookmark, false);
1102 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1103 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1104 $formatter = $factory->getFormatter('raw');
1105 $data = $formatter->format($bookmark);
1106 $pluginManager->executeHooks('save_link', $data);
1108 $bookmark->fromArray($data);
1109 $bookmarkService->set($bookmark);
1111 // If we are called from the bookmarklet, we must close the popup:
1112 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1113 echo '<script>self.close();</script>';
1117 $returnurl = !empty($_POST['returnurl']) ? $_POST['returnurl'] : '?';
1118 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1119 // Scroll to the link which has been edited.
1120 $location .= '#' . $bookmark->getShortUrl();
1121 // After saving the link, redirect to the page the user was on.
1122 header('Location: '. $location);
1126 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1127 if ($targetPage == Router
::$PAGE_DELETELINK) {
1128 if (! $sessionManager->checkToken($_GET['token'])) {
1129 die(t('Wrong token.'));
1132 $ids = trim($_GET['lf_linkdate']);
1133 if (strpos($ids, ' ') !== false) {
1134 // multiple, space-separated ids provided
1135 $ids = array_values(array_filter(
1136 preg_split('/\s+/', escape($ids)),
1138 return $item !== '';
1142 // only a single id provided
1143 $shortUrl = $bookmarkService->get($ids)->getShortUrl();
1146 // assert at least one id is given
1148 die('no id provided');
1150 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1151 $formatter = $factory->getFormatter('raw');
1152 foreach ($ids as $id) {
1153 $id = (int) escape($id);
1154 $bookmark = $bookmarkService->get($id);
1155 $data = $formatter->format($bookmark);
1156 $pluginManager->executeHooks('delete_link', $data);
1157 $bookmarkService->remove($bookmark, false);
1159 $bookmarkService->save();
1161 // If we are called from the bookmarklet, we must close the popup:
1162 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1163 echo '<script>self.close();</script>';
1168 if (isset($_SERVER['HTTP_REFERER'])) {
1169 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1170 $location = generateLocation(
1171 $_SERVER['HTTP_REFERER'],
1172 $_SERVER['HTTP_HOST'],
1173 ['delete_link', 'edit_link', ! empty($shortUrl) ? $shortUrl : null]
1177 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1181 // -------- User clicked either "Set public" or "Set private" bulk operation
1182 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1183 if (! $sessionManager->checkToken($_GET['token'])) {
1184 die(t('Wrong token.'));
1187 $ids = trim($_GET['ids']);
1188 if (strpos($ids, ' ') !== false) {
1189 // multiple, space-separated ids provided
1190 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1192 // only a single id provided
1196 // assert at least one id is given
1198 die('no id provided');
1200 // assert that the visibility is valid
1201 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1202 die('invalid visibility');
1204 $private = $_GET['newVisibility'] === 'private';
1206 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1207 $formatter = $factory->getFormatter('raw');
1208 foreach ($ids as $id) {
1209 $id = (int) escape($id);
1210 $bookmark = $bookmarkService->get($id);
1211 $bookmark->setPrivate($private);
1213 // To preserve backward compatibility with 3rd parties, plugins still use arrays
1214 $data = $formatter->format($bookmark);
1215 $pluginManager->executeHooks('save_link', $data);
1216 $bookmark->fromArray($data);
1218 $bookmarkService->set($bookmark);
1220 $bookmarkService->save();
1223 if (isset($_SERVER['HTTP_REFERER'])) {
1224 $location = generateLocation(
1225 $_SERVER['HTTP_REFERER'],
1226 $_SERVER['HTTP_HOST']
1229 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1233 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1234 if (isset($_GET['edit_link'])) {
1235 $id = (int) escape($_GET['edit_link']);
1237 $link = $bookmarkService->get($id); // Read database
1238 } catch (BookmarkNotFoundException
$e) {
1239 // Link not found in database.
1240 header('Location: ?');
1244 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1245 $formatter = $factory->getFormatter('raw');
1246 $formattedLink = $formatter->format($link);
1247 $tags = $bookmarkService->bookmarksCountPerTag();
1248 if ($conf->get('formatter') === 'markdown') {
1249 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1252 'link' => $formattedLink,
1253 'link_is_new' => false,
1254 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1257 $pluginManager->executeHooks('render_editlink', $data);
1259 foreach ($data as $key => $value) {
1260 $PAGE->assign($key, $value);
1263 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1264 $PAGE->renderPage('editlink');
1268 // -------- User want to post a new link: Display link edit form.
1269 if (isset($_GET['post'])) {
1270 $url = cleanup_url($_GET['post']);
1272 $link_is_new = false;
1273 // Check if URL is not already in database (in this case, we will edit the existing link)
1274 $bookmark = $bookmarkService->findByUrl($url);
1276 $link_is_new = true;
1277 // Get title if it was provided in URL (by the bookmarklet).
1278 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1279 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1280 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1281 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1282 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1284 // If this is an HTTP(S) link, we try go get the page to extract
1285 // the title (otherwise we will to straight to the edit form.)
1286 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1287 $retrieveDescription = $conf->get('general.retrieve_description');
1288 // Short timeout to keep the application responsive
1289 // The callback will fill $charset and $title with data from the downloaded page.
1292 $conf->get('general.download_timeout', 30),
1293 $conf->get('general.download_max_size', 4194304),
1294 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1296 if (! empty($title) && strtolower($charset) != 'utf-8') {
1297 $title = mb_convert_encoding($title, 'utf-8', $charset);
1302 $title = $conf->get('general.default_note_title', t('Note: '));
1304 $url = escape($url);
1305 $title = escape($title);
1310 'description' => $description,
1312 'private' => $private,
1315 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1316 $formatter = $factory->getFormatter('raw');
1317 $link = $formatter->format($bookmark);
1320 $tags = $bookmarkService->bookmarksCountPerTag();
1321 if ($conf->get('formatter') === 'markdown') {
1322 $tags[BookmarkMarkdownFormatter
::NO_MD_TAG
] = 1;
1326 'link_is_new' => $link_is_new,
1327 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1328 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1330 'default_private_links' => $conf->get('privacy.default_private_links', false),
1332 $pluginManager->executeHooks('render_editlink', $data);
1334 foreach ($data as $key => $value) {
1335 $PAGE->assign($key, $value);
1338 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1339 $PAGE->renderPage('editlink');
1343 if ($targetPage == Router
::$PAGE_PINLINK) {
1344 if (! isset($_GET['id']) || !$bookmarkService->exists($_GET['id'])) {
1345 // FIXME! Use a proper error system.
1346 $msg = t('Invalid link ID provided');
1347 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1350 if (! $sessionManager->checkToken($_GET['token'])) {
1351 die('Wrong token.');
1354 $link = $bookmarkService->get($_GET['id']);
1355 $link->setSticky(! $link->isSticky());
1356 $bookmarkService->set($link);
1357 header('Location: '.index_url($_SERVER));
1361 if ($targetPage == Router
::$PAGE_EXPORT) {
1362 // Export bookmarks as a Netscape Bookmarks file
1364 if (empty($_GET['selection'])) {
1365 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1366 $PAGE->renderPage('export');
1370 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1371 $selection = $_GET['selection'];
1372 if (isset($_GET['prepend_note_url'])) {
1373 $prependNoteUrl = $_GET['prepend_note_url'];
1375 $prependNoteUrl = false;
1379 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1380 $formatter = $factory->getFormatter('raw');
1383 NetscapeBookmarkUtils
::filterAndFormat(
1391 } catch (Exception
$exc) {
1392 header('Content-Type: text/plain; charset=utf-8');
1393 echo $exc->getMessage();
1396 $now = new DateTime();
1397 header('Content-Type: text/html; charset=utf-8');
1399 'Content-disposition: attachment; filename=bookmarks_'
1400 .$selection.'_'.$now->format(Bookmark
::LINK_DATE_FORMAT
).'.html'
1402 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1403 $PAGE->assign('eol', PHP_EOL
);
1404 $PAGE->assign('selection', $selection);
1405 $PAGE->renderPage('export.bookmarks');
1409 if ($targetPage == Router
::$PAGE_IMPORT) {
1410 // Upload a Netscape bookmark dump to import its contents
1412 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1413 // Show import dialog
1416 get_max_upload_size(
1417 ini_get('post_max_size'),
1418 ini_get('upload_max_filesize'),
1424 get_max_upload_size(
1425 ini_get('post_max_size'),
1426 ini_get('upload_max_filesize'),
1430 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1431 $PAGE->renderPage('import');
1435 // Import bookmarks from an uploaded file
1436 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1437 // The file is too big or some form field may be missing.
1440 'The file you are trying to upload is probably bigger than what this webserver can accept'
1441 .' (%s). Please upload in smaller chunks.'
1443 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1445 echo '<script>alert("'. $msg .'");document.location=\'./?do='.Router
::$PAGE_IMPORT .'\';</script>';
1448 if (! $sessionManager->checkToken($_POST['token'])) {
1449 die('Wrong token.');
1451 $status = NetscapeBookmarkUtils
::import(
1458 echo '<script>alert("'.$status.'");document.location=\'./?do='
1459 .Router
::$PAGE_IMPORT .'\';</script>';
1463 // Plugin administration page
1464 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1465 $pluginMeta = $pluginManager->getPluginsMeta();
1467 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1468 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1469 return $v['order'] !== false;
1472 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1476 return $a['order'] - $b['order'];
1479 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1480 return $v['order'] === false;
1483 $PAGE->assign('enabledPlugins', $enabledPlugins);
1484 $PAGE->assign('disabledPlugins', $disabledPlugins);
1485 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1486 $PAGE->renderPage('pluginsadmin');
1490 // Plugin administration form action
1491 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1493 if (isset($_POST['parameters_form'])) {
1494 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1495 unset($_POST['parameters_form']);
1496 foreach ($_POST as $param => $value) {
1497 $conf->set('plugins.'. $param, escape($value));
1500 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1502 $conf->write($loginManager->isLoggedIn());
1503 $history->updateSettings();
1504 } catch (Exception
$e) {
1506 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1510 // TODO: do not handle exceptions/errors in JS.
1511 echo '<script>alert("'
1513 .'");document.location=\'./?do='
1514 . Router
::$PAGE_PLUGINSADMIN
1518 header('Location: ./?do='. Router
::$PAGE_PLUGINSADMIN);
1522 // Get a fresh token
1523 if ($targetPage == Router
::$GET_TOKEN) {
1524 header('Content-Type:text/plain');
1525 echo $sessionManager->generateToken();
1529 // -------- Thumbnails Update
1530 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1532 foreach ($bookmarkService->search() as $bookmark) {
1533 // A note or not HTTP(S)
1534 if ($bookmark->isNote() || ! startsWith(strtolower($bookmark->getUrl()), 'http')) {
1537 $ids[] = $bookmark->getId();
1539 $PAGE->assign('ids', $ids);
1540 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1541 $PAGE->renderPage('thumbnails');
1545 // -------- Single Thumbnail Update
1546 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1547 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1548 http_response_code(400);
1551 $id = (int) $_POST['id'];
1552 if (! $bookmarkService->exists($id)) {
1553 http_response_code(404);
1556 $thumbnailer = new Thumbnailer($conf);
1557 $bookmark = $bookmarkService->get($id);
1558 $bookmark->setThumbnail($thumbnailer->get($bookmark->getUrl()));
1559 $bookmarkService->set($bookmark);
1561 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1562 echo json_encode($factory->getFormatter('raw')->format($bookmark));
1566 // -------- Otherwise, simply display search form and bookmarks:
1567 showLinkList($PAGE, $bookmarkService, $conf, $pluginManager, $loginManager);
1572 * Template for the list of bookmarks (<div id="linklist">)
1573 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1575 * @param pageBuilder $PAGE pageBuilder instance.
1576 * @param BookmarkServiceInterface $linkDb LinkDB instance.
1577 * @param ConfigManager $conf Configuration Manager instance.
1578 * @param PluginManager $pluginManager Plugin Manager instance.
1579 * @param LoginManager $loginManager LoginManager instance
1581 function buildLinkList($PAGE, $linkDb, $conf, $pluginManager, $loginManager)
1583 $factory = new FormatterFactory($conf, $loginManager->isLoggedIn());
1584 $formatter = $factory->getFormatter();
1586 // Used in templates
1587 if (isset($_GET['searchtags'])) {
1588 if (! empty($_GET['searchtags'])) {
1589 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1591 $searchtags = false;
1596 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1599 if (! empty($_SERVER['QUERY_STRING'])
1600 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1602 $linksToDisplay = $linkDb->findByHash($_SERVER['QUERY_STRING']);
1603 } catch (BookmarkNotFoundException
$e) {
1604 $PAGE->render404($e->getMessage());
1608 // Filter bookmarks according search parameters.
1609 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : null;
1611 'searchtags' => $searchtags,
1612 'searchterm' => $searchterm,
1614 $linksToDisplay = $linkDb->search($request, $visibility, false, !empty($_SESSION['untaggedonly']));
1617 // ---- Handle paging.
1619 foreach ($linksToDisplay as $key => $value) {
1623 // Select articles according to paging.
1624 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1625 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1626 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1627 $page = $page < 1 ? 1 : $page;
1628 $page = $page > $pagecount ? $pagecount : $page;
1630 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1631 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1633 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1634 if ($thumbnailsEnabled) {
1635 $thumbnailer = new Thumbnailer($conf);
1638 $linkDisp = array();
1639 while ($i<$end && $i<count($keys)) {
1640 $link = $formatter->format($linksToDisplay[$keys[$i]]);
1642 // Logged in, thumbnails enabled, not a note,
1643 // and (never retrieved yet or no valid cache file)
1644 if ($loginManager->isLoggedIn()
1645 && $thumbnailsEnabled
1646 && !$linksToDisplay[$keys[$i]]->isNote()
1647 && $linksToDisplay[$keys[$i]]->getThumbnail() !== false
1648 && ! is_file($linksToDisplay[$keys[$i]]->getThumbnail())
1650 $linksToDisplay[$keys[$i]]->setThumbnail($thumbnailer->get($link['url']));
1651 $linkDb->set($linksToDisplay[$keys[$i]], false);
1653 $link['thumbnail'] = $linksToDisplay[$keys[$i]]->getThumbnail();
1656 // Check for both signs of a note: starting with ? and 7 chars long.
1657 // if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1658 // $link['url'] = index_url($_SERVER) . $link['url'];
1661 $linkDisp[$keys[$i]] = $link;
1665 // If we retrieved new thumbnails, we update the database.
1666 if (!empty($updateDB)) {
1670 // Compute paging navigation
1671 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1672 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1673 $previous_page_url = '';
1674 if ($i != count($keys)) {
1675 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1679 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1682 // Fill all template fields.
1684 'previous_page_url' => $previous_page_url,
1685 'next_page_url' => $next_page_url,
1686 'page_current' => $page,
1687 'page_max' => $pagecount,
1688 'result_count' => count($linksToDisplay),
1689 'search_term' => $searchterm,
1690 'search_tags' => $searchtags,
1691 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1692 'links' => $linkDisp,
1695 // If there is only a single link, we change on-the-fly the title of the page.
1696 if (count($linksToDisplay) == 1) {
1697 $data['pagetitle'] = $linksToDisplay[$keys[0]]->getTitle() .' - '. $conf->get('general.title');
1698 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1699 $data['pagetitle'] = t('Search: ');
1700 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1701 $bracketWrap = function ($tag) {
1702 return '['. $tag .']';
1704 $data['pagetitle'] .= ! empty($searchtags)
1705 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1707 $data['pagetitle'] .= '- '. $conf->get('general.title');
1710 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1712 foreach ($data as $key => $value) {
1713 $PAGE->assign($key, $value);
1721 * This function should NEVER be called if the file data/config.php exists.
1723 * @param ConfigManager $conf Configuration Manager instance.
1724 * @param SessionManager $sessionManager SessionManager instance
1725 * @param LoginManager $loginManager LoginManager instance
1727 function install($conf, $sessionManager, $loginManager)
1729 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1730 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1731 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1735 // This part makes sure sessions works correctly.
1736 // (Because on some hosts, session.save_path may not be set correctly,
1737 // or we may not have write access to it.)
1738 if (isset($_GET['test_session'])
1739 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1740 // Step 2: Check if data in session is correct.
1742 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1743 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1744 'and that you have write access to it.<br>'.
1745 'It currently points to %s.<br>'.
1746 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1747 'or any custom hostname without a dot causes cookie storage to fail. '.
1748 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1750 $msg = sprintf($msg, session_save_path());
1752 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1755 if (!isset($_SESSION['session_tested'])) {
1756 // Step 1 : Try to store data in session and reload page.
1757 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1758 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1760 if (isset($_GET['test_session'])) {
1761 // Step 3: Sessions are OK. Remove test parameter from URL.
1762 header('Location: '.index_url($_SERVER));
1766 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1768 if (!empty($_POST['continent']) && !empty($_POST['city'])
1769 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1771 $tz = $_POST['continent'].'/'.$_POST['city'];
1773 $conf->set('general.timezone', $tz);
1774 $login = $_POST['setlogin'];
1775 $conf->set('credentials.login', $login);
1776 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1777 $conf->set('credentials.salt', $salt);
1778 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1779 if (!empty($_POST['title'])) {
1780 $conf->set('general.title', escape($_POST['title']));
1782 $conf->set('general.title', 'Shared bookmarks on '.escape(index_url($_SERVER)));
1784 $conf->set('translation.language', escape($_POST['language']));
1785 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1786 $conf->set('api.enabled', !empty($_POST['enableApi']));
1789 generate_api_secret(
1790 $conf->get('credentials.login'),
1791 $conf->get('credentials.salt')
1795 // Everything is ok, let's create config file.
1796 $conf->write($loginManager->isLoggedIn());
1797 } catch (Exception
$e) {
1799 'ERROR while writing config file after installation.' . PHP_EOL
.
1803 // TODO: do not handle exceptions/errors in JS.
1804 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1808 $history = new History($conf->get('resource.history'));
1809 $bookmarkService = new BookmarkFileService($conf, $history, true);
1810 if ($bookmarkService->count() === 0) {
1811 $bookmarkService->initialize();
1814 echo '<script>alert('
1815 .'"Shaarli is now configured. '
1816 .'Please enter your login/password and start shaaring your bookmarks!"'
1817 .');document.location=\'./login\';</script>';
1821 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1822 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1823 $PAGE->assign('continents', $continents);
1824 $PAGE->assign('cities', $cities);
1825 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1826 $PAGE->renderPage('install');
1830 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1831 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1835 $history = new History($conf->get('resource.history'));
1836 } catch (Exception
$e) {
1837 die($e->getMessage());
1840 $linkDb = new BookmarkFileService($conf, $history, $loginManager->isLoggedIn());
1842 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1843 showDailyRSS($linkDb, $conf, $loginManager);
1847 $containerBuilder = new ContainerBuilder($conf, $sessionManager, $loginManager, WEB_PATH
);
1848 $container = $containerBuilder->build();
1849 $app = new App($container);
1852 $app->group('/api/v1', function () {
1853 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1854 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1855 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1856 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1857 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1858 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1860 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1861 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1862 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1863 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1865 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1866 })->add('\Shaarli\Api\ApiMiddleware');
1868 $app->group('', function () {
1869 $this->get('/login', '\Shaarli\Front\Controller\LoginController:index')->setName('login');
1870 $this->get('/logout', '\Shaarli\Front\Controller\LogoutController:index')->setName('logout');
1871 $this->get('/picture-wall', '\Shaarli\Front\Controller\PictureWallController:index')->setName('picwall');
1872 $this->get('/tag-cloud', '\Shaarli\Front\Controller\TagCloudController:cloud')->setName('tagcloud');
1873 $this->get('/add-tag/{newTag}', '\Shaarli\Front\Controller\TagController:addTag')->setName('add-tag');
1874 })->add('\Shaarli\Front\ShaarliMiddleware');
1876 $response = $app->run(true);
1878 // Hack to make Slim and Shaarli router work together:
1879 // If a Slim route isn't found and NOT API call, we call renderPage().
1880 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1881 // We use UTF-8 for proper international characters handling.
1882 header('Content-Type: text/html; charset=utf-8');
1883 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1885 $response = $response
1886 ->withHeader('Access-Control-Allow-Origin', '*')
1888 'Access-Control-Allow-Headers',
1889 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1891 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1892 $app->respond($response);