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
17 // Set 'UTC' as the default timezone if it is not defined in php.ini
18 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
19 if (date_default_timezone_get() == '') {
20 date_default_timezone_set('UTC');
27 // http://server.com/x/shaarli --> /shaarli/
28 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+
strrpos($_SERVER['REQUEST_URI'], '/', 0)));
30 // High execution time in case of problematic imports/exports.
31 ini_set('max_input_time', '60');
33 // Try to set max upload file size and read
34 ini_set('memory_limit', '128M');
35 ini_set('post_max_size', '16M');
36 ini_set('upload_max_filesize', '16M');
38 // See all error except warnings
39 error_reporting(E_ALL^E_WARNING
);
40 // See all errors (for debugging only)
41 //error_reporting(-1);
44 // 3rd-party libraries
45 if (! file_exists(__DIR__
. '/vendor/autoload.php')) {
46 header('Content-Type: text/plain; charset=utf-8');
47 echo "Error: missing Composer configuration\n\n"
48 ."If you installed Shaarli through Git or using the development branch,\n"
49 ."please refer to the installation documentation to install PHP"
50 ." dependencies using Composer:\n"
51 ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n"
52 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
55 require_once 'inc/rain.tpl.class.php';
56 require_once __DIR__
. '/vendor/autoload.php';
59 require_once 'application/bookmark/LinkUtils.php';
60 require_once 'application/config/ConfigPlugin.php';
61 require_once 'application/feed/Cache.php';
62 require_once 'application/http/HttpUtils.php';
63 require_once 'application/http/UrlUtils.php';
64 require_once 'application/updater/UpdaterUtils.php';
65 require_once 'application/FileUtils.php';
66 require_once 'application/TimeZone.php';
67 require_once 'application/Utils.php';
69 use \Shaarli\ApplicationUtils
;
70 use \Shaarli\Bookmark\Exception\LinkNotFoundException
;
71 use \Shaarli\Bookmark\LinkDB
;
72 use \Shaarli\Config\ConfigManager
;
73 use \Shaarli\Feed\CachedPage
;
74 use \Shaarli\Feed\FeedBuilder
;
76 use \Shaarli\Languages
;
77 use \Shaarli\Netscape\NetscapeBookmarkUtils
;
78 use \Shaarli\Plugin\PluginManager
;
79 use \Shaarli\Render\PageBuilder
;
80 use \Shaarli\Render\ThemeUtils
;
82 use \Shaarli\Security\LoginManager
;
83 use \Shaarli\Security\SessionManager
;
84 use \Shaarli\Thumbnailer
;
85 use \Shaarli\Updater\Updater
;
87 // Ensure the PHP version is supported
89 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
90 } catch (Exception
$exc) {
91 header('Content-Type: text/plain; charset=utf-8');
92 echo $exc->getMessage();
96 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
98 // Force cookie path (but do not change lifetime)
99 $cookie = session_get_cookie_params();
101 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
102 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
104 // Set default cookie expiration and path.
105 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
106 // Set session parameters on server side.
107 // Use cookies to store session.
108 ini_set('session.use_cookies', 1);
109 // Force cookies for session (phpsessionID forbidden in URL).
110 ini_set('session.use_only_cookies', 1);
111 // Prevent PHP form using sessionID in URL if cookies are disabled.
112 ini_set('session.use_trans_sid', false);
114 session_name('shaarli');
115 // Start session if needed (Some server auto-start sessions).
116 if (session_status() == PHP_SESSION_NONE
) {
120 // Regenerate session ID if invalid or not defined in cookie.
121 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
122 session_regenerate_id(true);
123 $_COOKIE['shaarli'] = session_id();
126 $conf = new ConfigManager();
127 $sessionManager = new SessionManager($_SESSION, $conf);
128 $loginManager = new LoginManager($conf, $sessionManager);
129 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
130 $clientIpId = client_ip_id($_SERVER);
132 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
133 if (! defined('LC_MESSAGES')) {
134 define('LC_MESSAGES', LC_COLLATE
);
137 // Sniff browser language and set date format accordingly.
138 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
139 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
142 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
144 $conf->setEmpty('general.timezone', date_default_timezone_get());
145 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
146 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
147 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
149 $pluginManager = new PluginManager($conf);
150 $pluginManager->load($conf->get('general.enabled_plugins'));
152 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
154 ob_start(); // Output buffering for the page cache.
156 // Prevent caching on client side or proxy: (yes, it's ugly)
157 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
158 header("Cache-Control: no-store, no-cache, must-revalidate");
159 header("Cache-Control: post-check=0, pre-check=0", false);
160 header("Pragma: no-cache");
162 if (! is_file($conf->getConfigFileExt())) {
163 // Ensure Shaarli has proper access to its resources
164 $errors = ApplicationUtils
::checkResourcePermissions($conf);
166 if ($errors != array()) {
167 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
169 foreach ($errors as $error) {
170 $message .= '<li>'.$error.'</li>';
174 header('Content-Type: text/html; charset=utf-8');
179 // Display the installation form if no existing config is found
180 install($conf, $sessionManager, $loginManager);
183 $loginManager->checkLoginState($_COOKIE, $clientIpId);
186 * Adapter function to ensure compatibility with third-party templates
188 * @see https://github.com/shaarli/Shaarli/pull/1086
190 * @return bool true when the user is logged in, false otherwise
192 function isLoggedIn()
194 global $loginManager;
195 return $loginManager->isLoggedIn();
199 // ------------------------------------------------------------------------------------------
200 // Process login form: Check if login/password is correct.
201 if (isset($_POST['login'])) {
202 if (! $loginManager->canLogin($_SERVER)) {
203 die(t('I said: NO. You are banned for the moment. Go away.'));
205 if (isset($_POST['password'])
206 && $sessionManager->checkToken($_POST['token'])
207 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
209 $loginManager->handleSuccessfulLogin($_SERVER);
212 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
213 // Note: Never forget the trailing slash on the cookie path!
214 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
217 if (!empty($_POST['longlastingsession'])) {
218 // Keep the session cookie even after the browser closes
219 $sessionManager->setStaySignedIn(true);
220 $expirationTime = $sessionManager->extendSession();
223 $loginManager::$STAY_SIGNED_IN_COOKIE,
224 $loginManager->getStaySignedInToken(),
229 // Standard session expiration (=when browser closes)
233 // Send cookie with the new expiration date to the browser
234 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
235 session_regenerate_id(true);
237 // Optional redirect after login:
238 if (isset($_GET['post'])) {
239 $uri = '?post='. urlencode($_GET['post']);
240 foreach (array('description', 'source', 'title', 'tags') as $param) {
241 if (!empty($_GET[$param])) {
242 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
245 header('Location: '. $uri);
249 if (isset($_GET['edit_link'])) {
250 header('Location: ?edit_link='. escape($_GET['edit_link']));
254 if (isset($_POST['returnurl'])) {
255 // Prevent loops over login screen.
256 if (strpos($_POST['returnurl'], 'do=login') === false) {
257 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
261 header('Location: ?');
264 $loginManager->handleFailedLogin($_SERVER);
265 $redir = '&username='. urlencode($_POST['login']);
266 if (isset($_GET['post'])) {
267 $redir .= '&post=' . urlencode($_GET['post']);
268 foreach (array('description', 'source', 'title', 'tags') as $param) {
269 if (!empty($_GET[$param])) {
270 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
274 // Redirect to login screen.
275 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
280 // ------------------------------------------------------------------------------------------
281 // Token management for XSRF protection
282 // Token should be used in any form which acts on data (create,update,delete,import...).
283 if (!isset($_SESSION['tokens'])) {
284 $_SESSION['tokens']=array(); // Token are attached to the session.
288 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
289 * Gives the last 7 days (which have links).
290 * This RSS feed cannot be filtered.
292 * @param ConfigManager $conf Configuration Manager instance
293 * @param LoginManager $loginManager LoginManager instance
295 function showDailyRSS($conf, $loginManager)
298 $query = $_SERVER['QUERY_STRING'];
299 $cache = new CachedPage(
300 $conf->get('config.PAGE_CACHE'),
302 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
304 $cached = $cache->cachedVersion();
305 if (!empty($cached)) {
310 // If cached was not found (or not usable), then read the database and build the response:
311 // Read links from database (and filter private links if used it not logged in).
312 $LINKSDB = new LinkDB(
313 $conf->get('resource.datastore'),
314 $loginManager->isLoggedIn(),
315 $conf->get('privacy.hide_public_links')
318 /* Some Shaarlies may have very few links, so we need to look
319 back in time until we have enough days ($nb_of_days).
321 $nb_of_days = 7; // We take 7 days.
322 $today = date('Ymd');
325 foreach ($LINKSDB as $link) {
326 $day = $link['created']->format('Ymd'); // Extract day (without time)
327 if (strcmp($day, $today) < 0) {
328 if (empty($days[$day])) {
329 $days[$day] = array();
331 $days[$day][] = $link;
334 if (count($days) > $nb_of_days) {
335 break; // Have we collected enough days?
339 // Build the RSS feed.
340 header('Content-Type: application/rss+xml; charset=utf-8');
341 $pageaddr = escape(index_url($_SERVER));
342 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
344 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
345 echo '<link>'. $pageaddr .'</link>';
346 echo '<description>Daily shared links</description>';
347 echo '<language>en-en</language>';
348 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
351 foreach ($days as $day => $links) {
352 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
353 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
355 // We pre-format some fields for proper output.
356 foreach ($links as &$link) {
357 $link['formatedDescription'] = format_description($link['description']);
358 $link['timestamp'] = $link['created']->getTimestamp();
359 if (is_note($link['url'])) {
360 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
364 // Then build the HTML for this day:
366 $tpl->assign('title', $conf->get('general.title'));
367 $tpl->assign('daydate', $dayDate->getTimestamp());
368 $tpl->assign('absurl', $absurl);
369 $tpl->assign('links', $links);
370 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
371 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
372 $tpl->assign('index_url', $pageaddr);
373 $html = $tpl->draw('dailyrss', true);
375 echo $html . PHP_EOL
;
377 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
379 $cache->cache(ob_get_contents());
385 * Show the 'Daily' page.
387 * @param PageBuilder $pageBuilder Template engine wrapper.
388 * @param LinkDB $LINKSDB LinkDB instance.
389 * @param ConfigManager $conf Configuration Manager instance.
390 * @param PluginManager $pluginManager Plugin Manager instance.
391 * @param LoginManager $loginManager Login Manager instance
393 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager)
395 if (isset($_GET['day'])) {
397 if ($day === date('Ymd', strtotime('now'))) {
398 $pageBuilder->assign('dayDesc', t('Today'));
399 } elseif ($day === date('Ymd', strtotime('-1 days'))) {
400 $pageBuilder->assign('dayDesc', t('Yesterday'));
403 $day = date('Ymd', strtotime('now')); // Today, in format YYYYMMDD.
404 $pageBuilder->assign('dayDesc', t('Today'));
407 $days = $LINKSDB->days();
408 $i = array_search($day, $days);
409 if ($i === false && count($days)) {
410 // no links for day, but at least one day with links
411 $i = count($days) - 1;
419 $previousday=$days[$i - 1];
421 if ($i < count($days) - 1) {
422 $nextday = $days[$i +
1];
426 $linksToDisplay = $LINKSDB->filterDay($day);
427 } catch (Exception
$exc) {
429 $linksToDisplay = array();
432 // We pre-format some fields for proper output.
433 foreach ($linksToDisplay as $key => $link) {
434 $taglist = explode(' ', $link['tags']);
435 uasort($taglist, 'strcasecmp');
436 $linksToDisplay[$key]['taglist']=$taglist;
437 $linksToDisplay[$key]['formatedDescription'] = format_description($link['description']);
438 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
441 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
443 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
444 'linksToDisplay' => $linksToDisplay,
445 'day' => $dayDate->getTimestamp(),
446 'dayDate' => $dayDate,
447 'previousday' => $previousday,
448 'nextday' => $nextday,
451 /* Hook is called before column construction so that plugins don't have
452 to deal with columns. */
453 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
455 /* We need to spread the articles on 3 columns.
456 I did not want to use a JavaScript lib like http://masonry.desandro.com/
457 so I manually spread entries with a simple method: I roughly evaluate the
458 height of a div according to title and description length.
460 $columns = array(array(), array(), array()); // Entries to display, for each column.
461 $fill = array(0, 0, 0); // Rough estimate of columns fill.
462 foreach ($data['linksToDisplay'] as $key => $link) {
463 // Roughly estimate length of entry (by counting characters)
464 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
465 // Description: 836 characters gives roughly 342 pixel height.
466 // This is not perfect, but it's usually OK.
467 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
468 if (!empty($link['thumbnail'])) {
469 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
471 // Then put in column which is the less filled:
472 $smallest = min($fill); // find smallest value in array.
473 $index = array_search($smallest, $fill); // find index of this smallest value.
474 array_push($columns[$index], $link); // Put entry in this column.
475 $fill[$index] +
= $length;
478 $data['cols'] = $columns;
480 foreach ($data as $key => $value) {
481 $pageBuilder->assign($key, $value);
484 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
485 $pageBuilder->renderPage('daily');
490 * Renders the linklist
492 * @param pageBuilder $PAGE pageBuilder instance.
493 * @param LinkDB $LINKSDB LinkDB instance.
494 * @param ConfigManager $conf Configuration Manager instance.
495 * @param PluginManager $pluginManager Plugin Manager instance.
497 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
499 buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
500 $PAGE->renderPage('linklist');
504 * Render HTML page (according to URL parameters and user rights)
506 * @param ConfigManager $conf Configuration Manager instance.
507 * @param PluginManager $pluginManager Plugin Manager instance,
508 * @param LinkDB $LINKSDB
509 * @param History $history instance
510 * @param SessionManager $sessionManager SessionManager instance
511 * @param LoginManager $loginManager LoginManager instance
513 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
515 $updater = new Updater(
516 read_updates_file($conf->get('resource.updates')),
519 $loginManager->isLoggedIn(),
523 $newUpdates = $updater->update();
524 if (! empty($newUpdates)) {
526 $conf->get('resource.updates'),
527 $updater->getDoneUpdates()
530 } catch (Exception
$e) {
531 die($e->getMessage());
534 $PAGE = new PageBuilder($conf, $_SESSION, $LINKSDB, $sessionManager->generateToken(), $loginManager->isLoggedIn());
535 $PAGE->assign('linkcount', count($LINKSDB));
536 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
537 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
539 // Determine which page will be rendered.
540 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
541 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
543 if (// if the user isn't logged in
544 !$loginManager->isLoggedIn() &&
545 // and Shaarli doesn't have public content...
546 $conf->get('privacy.hide_public_links') &&
547 // and is configured to enforce the login
548 $conf->get('privacy.force_login') &&
549 // and the current page isn't already the login page
550 $targetPage !== Router
::$PAGE_LOGIN &&
551 // and the user is not requesting a feed (which would lead to a different content-type as expected)
552 $targetPage !== Router
::$PAGE_FEED_ATOM &&
553 $targetPage !== Router
::$PAGE_FEED_RSS
555 // force current page to be the login page
556 $targetPage = Router
::$PAGE_LOGIN;
559 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
560 // Then assign generated data to RainTPL.
561 $common_hooks = array(
567 foreach ($common_hooks as $name) {
568 $plugin_data = array();
569 $pluginManager->executeHooks(
573 'target' => $targetPage,
574 'loggedin' => $loginManager->isLoggedIn()
577 $PAGE->assign('plugins_' . $name, $plugin_data);
580 // -------- Display login form.
581 if ($targetPage == Router
::$PAGE_LOGIN) {
582 if ($conf->get('security.open_shaarli')) {
583 header('Location: ?');
585 } // No need to login for open Shaarli
586 if (isset($_GET['username'])) {
587 $PAGE->assign('username', escape($_GET['username']));
589 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
590 // add default state of the 'remember me' checkbox
591 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
592 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
593 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
594 $PAGE->renderPage('loginform');
597 // -------- User wants to logout.
598 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
599 invalidateCaches($conf->get('resource.page_cache'));
600 $sessionManager->logout();
601 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
602 header('Location: ?');
606 // -------- Picture wall
607 if ($targetPage == Router
::$PAGE_PICWALL) {
608 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
609 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
610 $PAGE->assign('linksToDisplay', []);
611 $PAGE->renderPage('picwall');
615 // Optionally filter the results:
616 $links = $LINKSDB->filterSearch($_GET);
617 $linksToDisplay = array();
619 // Get only links which have a thumbnail.
620 // Note: we do not retrieve thumbnails here, the request is too heavy.
621 foreach ($links as $key => $link) {
622 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
623 $linksToDisplay[] = $link; // Add to array.
628 'linksToDisplay' => $linksToDisplay,
630 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
632 foreach ($data as $key => $value) {
633 $PAGE->assign($key, $value);
637 $PAGE->renderPage('picwall');
641 // -------- Tag cloud
642 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
643 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
644 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
645 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
647 // We sort tags alphabetically, then choose a font size according to count.
648 // First, find max value.
650 foreach ($tags as $value) {
651 $maxcount = max($maxcount, $value);
654 alphabetical_sort($tags, false, true);
657 foreach ($tags as $key => $value) {
658 if (in_array($key, $filteringTags)) {
661 // Tag font size scaling:
662 // default 15 and 30 logarithm bases affect scaling,
663 // 22 and 6 are arbitrary font sizes for max and min sizes.
664 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
665 $tagList[$key] = array(
667 'size' => number_format($size, 2, '.', ''),
671 $searchTags = implode(' ', escape($filteringTags));
673 'search_tags' => $searchTags,
676 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
678 foreach ($data as $key => $value) {
679 $PAGE->assign($key, $value);
682 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
683 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
684 $PAGE->renderPage('tag.cloud');
689 if ($targetPage == Router
::$PAGE_TAGLIST) {
690 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
691 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
692 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
693 foreach ($filteringTags as $tag) {
694 if (array_key_exists($tag, $tags)) {
699 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
700 alphabetical_sort($tags, false, true);
703 $searchTags = implode(' ', escape($filteringTags));
705 'search_tags' => $searchTags,
708 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
710 foreach ($data as $key => $value) {
711 $PAGE->assign($key, $value);
714 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
715 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
716 $PAGE->renderPage('tag.list');
721 if ($targetPage == Router
::$PAGE_DAILY) {
722 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
725 // ATOM and RSS feed.
726 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
727 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
728 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
731 $query = $_SERVER['QUERY_STRING'];
732 $cache = new CachedPage(
733 $conf->get('resource.page_cache'),
735 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
737 $cached = $cache->cachedVersion();
738 if (!empty($cached)) {
744 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
745 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
746 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
747 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
748 $data = $feedGenerator->buildData();
750 // Process plugin hook.
751 $pluginManager->executeHooks('render_feed', $data, array(
752 'loggedin' => $loginManager->isLoggedIn(),
753 'target' => $targetPage,
756 // Render the template.
757 $PAGE->assignAll($data);
758 $PAGE->renderPage('feed.'. $feedType);
759 $cache->cache(ob_get_contents());
764 // Display opensearch plugin (XML)
765 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
766 header('Content-Type: application/xml; charset=utf-8');
767 $PAGE->assign('serverurl', index_url($_SERVER));
768 $PAGE->renderPage('opensearch');
772 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
773 if (isset($_GET['addtag'])) {
774 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
775 if (empty($_SERVER['HTTP_REFERER'])) {
776 // In case browser does not send HTTP_REFERER
777 header('Location: ?searchtags='.urlencode($_GET['addtag']));
780 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
782 // Prevent redirection loop
783 if (isset($params['addtag'])) {
784 unset($params['addtag']);
787 // Check if this tag is already in the search query and ignore it if it is.
788 // Each tag is always separated by a space
789 if (isset($params['searchtags'])) {
790 $current_tags = explode(' ', $params['searchtags']);
792 $current_tags = array();
795 foreach ($current_tags as $value) {
796 if ($value === $_GET['addtag']) {
801 // Append the tag if necessary
802 if (empty($params['searchtags'])) {
803 $params['searchtags'] = trim($_GET['addtag']);
805 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
808 // We also remove page (keeping the same page has no sense, since the
809 // results are different)
810 unset($params['page']);
812 header('Location: ?'.http_build_query($params));
816 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
817 if (isset($_GET['removetag'])) {
818 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
819 if (empty($_SERVER['HTTP_REFERER'])) {
820 header('Location: ?');
824 // In case browser does not send HTTP_REFERER
825 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
827 // Prevent redirection loop
828 if (isset($params['removetag'])) {
829 unset($params['removetag']);
832 if (isset($params['searchtags'])) {
833 $tags = explode(' ', $params['searchtags']);
834 // Remove value from array $tags.
835 $tags = array_diff($tags, array($_GET['removetag']));
836 $params['searchtags'] = implode(' ', $tags);
838 if (empty($params['searchtags'])) {
839 unset($params['searchtags']);
842 // We also remove page (keeping the same page has no sense, since
843 // the results are different)
844 unset($params['page']);
846 header('Location: ?'.http_build_query($params));
850 // -------- User wants to change the number of links per page (linksperpage=...)
851 if (isset($_GET['linksperpage'])) {
852 if (is_numeric($_GET['linksperpage'])) {
853 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
856 if (! empty($_SERVER['HTTP_REFERER'])) {
857 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
861 header('Location: '. $location);
865 // -------- User wants to see only private links (toggle)
866 if (isset($_GET['visibility'])) {
867 if ($_GET['visibility'] === 'private') {
868 // Visibility not set or not already private, set private, otherwise reset it
869 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
870 // See only private links
871 $_SESSION['visibility'] = 'private';
873 unset($_SESSION['visibility']);
875 } elseif ($_GET['visibility'] === 'public') {
876 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
877 // See only public links
878 $_SESSION['visibility'] = 'public';
880 unset($_SESSION['visibility']);
884 if (! empty($_SERVER['HTTP_REFERER'])) {
885 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
889 header('Location: '. $location);
893 // -------- User wants to see only untagged links (toggle)
894 if (isset($_GET['untaggedonly'])) {
895 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
897 if (! empty($_SERVER['HTTP_REFERER'])) {
898 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
902 header('Location: '. $location);
906 // -------- Handle other actions allowed for non-logged in users:
907 if (!$loginManager->isLoggedIn()) {
908 // User tries to post new link but is not logged in:
909 // Show login screen, then redirect to ?post=...
910 if (isset($_GET['post'])) {
911 header( // Redirect to login page, then back to post link.
912 'Location: ?do=login&post='.urlencode($_GET['post']).
913 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
914 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
915 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
916 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
921 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
922 if (isset($_GET['edit_link'])) {
923 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
927 exit; // Never remove this one! All operations below are reserved for logged in user.
930 // -------- All other functions are reserved for the registered user:
932 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
933 if ($targetPage == Router
::$PAGE_TOOLS) {
935 'pageabsaddr' => index_url($_SERVER),
936 'sslenabled' => is_https($_SERVER),
938 $pluginManager->executeHooks('render_tools', $data);
940 foreach ($data as $key => $value) {
941 $PAGE->assign($key, $value);
944 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
945 $PAGE->renderPage('tools');
949 // -------- User wants to change his/her password.
950 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
951 if ($conf->get('security.open_shaarli')) {
952 die(t('You are not supposed to change a password on an Open Shaarli.'));
955 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
956 if (!$sessionManager->checkToken($_POST['token'])) {
957 die(t('Wrong token.')); // Go away!
960 // Make sure old password is correct.
962 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
964 if ($oldhash != $conf->get('credentials.hash')) {
965 echo '<script>alert("'
966 . t('The old password is not correct.')
967 .'");document.location=\'?do=changepasswd\';</script>';
971 // Salt renders rainbow-tables attacks useless.
972 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
976 $_POST['setpassword']
977 . $conf->get('credentials.login')
978 . $conf->get('credentials.salt')
982 $conf->write($loginManager->isLoggedIn());
983 } catch (Exception
$e) {
985 'ERROR while writing config file after changing password.' . PHP_EOL
.
989 // TODO: do not handle exceptions/errors in JS.
990 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
993 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
996 // show the change password form.
997 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
998 $PAGE->renderPage('changepassword');
1003 // -------- User wants to change configuration
1004 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1005 if (!empty($_POST['title'])) {
1006 if (!$sessionManager->checkToken($_POST['token'])) {
1007 die(t('Wrong token.')); // Go away!
1010 if (!empty($_POST['continent']) && !empty($_POST['city'])
1011 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1013 $tz = $_POST['continent'] . '/' . $_POST['city'];
1015 $conf->set('general.timezone', $tz);
1016 $conf->set('general.title', escape($_POST['title']));
1017 $conf->set('general.header_link', escape($_POST['titleLink']));
1018 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
1019 $conf->set('resource.theme', escape($_POST['theme']));
1020 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1021 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1022 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1023 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1024 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1025 $conf->set('api.enabled', !empty($_POST['enableApi']));
1026 $conf->set('api.secret', escape($_POST['apiSecret']));
1027 $conf->set('translation.language', escape($_POST['language']));
1029 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1030 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1031 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1033 $_SESSION['warnings'][] = t(
1034 'You have enabled or changed thumbnails mode. '
1035 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1038 $conf->set('thumbnails.mode', $thumbnailsMode);
1041 $conf->write($loginManager->isLoggedIn());
1042 $history->updateSettings();
1043 invalidateCaches($conf->get('resource.page_cache'));
1044 } catch (Exception
$e) {
1046 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1050 // TODO: do not handle exceptions/errors in JS.
1051 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1054 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1057 // Show the configuration form.
1058 $PAGE->assign('title', $conf->get('general.title'));
1059 $PAGE->assign('theme', $conf->get('resource.theme'));
1060 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1061 list($continents, $cities) = generateTimeZoneData(
1062 timezone_identifiers_list(),
1063 $conf->get('general.timezone')
1065 $PAGE->assign('continents', $continents);
1066 $PAGE->assign('cities', $cities);
1067 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1068 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1069 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1070 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1071 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1072 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1073 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1074 $PAGE->assign('api_secret', $conf->get('api.secret'));
1075 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1076 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1077 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1078 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1079 $PAGE->renderPage('configure');
1084 // -------- User wants to rename a tag or delete it
1085 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1086 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1087 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1088 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1089 $PAGE->renderPage('changetag');
1093 if (!$sessionManager->checkToken($_POST['token'])) {
1094 die(t('Wrong token.'));
1097 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1098 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), $toTag);
1099 $LINKSDB->save($conf->get('resource.page_cache'));
1100 foreach ($alteredLinks as $link) {
1101 $history->updateLink($link);
1103 $delete = empty($_POST['totag']);
1104 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1105 $count = count($alteredLinks);
1107 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1108 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1109 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1113 // -------- User wants to add a link without using the bookmarklet: Show form.
1114 if ($targetPage == Router
::$PAGE_ADDLINK) {
1115 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1116 $PAGE->renderPage('addlink');
1120 // -------- User clicked the "Save" button when editing a link: Save link to database.
1121 if (isset($_POST['save_edit'])) {
1123 if (! $sessionManager->checkToken($_POST['token'])) {
1124 die(t('Wrong token.'));
1127 // lf_id should only be present if the link exists.
1128 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1130 // Linkdate is kept here to:
1131 // - use the same permalink for notes as they're displayed when creating them
1132 // - let users hack creation date of their posts
1133 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1134 $linkdate = escape($_POST['lf_linkdate']);
1135 $link['created'] = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1136 if (isset($LINKSDB[$id])) {
1138 $link['updated'] = new DateTime();
1139 $link['shorturl'] = $LINKSDB[$id]['shorturl'];
1140 $link['sticky'] = isset($LINKSDB[$id]['sticky']) ? $LINKSDB[$id]['sticky'] : false;
1144 $link['updated'] = null;
1145 $link['shorturl'] = link_small_hash($link['created'], $id);
1146 $link['sticky'] = false;
1150 // Remove multiple spaces.
1151 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1152 // Remove first '-' char in tags.
1153 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1154 // Remove duplicates.
1155 $tags = implode(' ', array_unique(explode(' ', $tags)));
1157 if (empty(trim($_POST['lf_url
']))) {
1158 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1160 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1162 $link = array_merge($link, [
1163 'title
' => trim($_POST['lf_title
']),
1165 'description
' => $_POST['lf_description
'],
1166 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1167 'tags
' => str_replace(',', ' ', $tags),
1170 // If title is empty, use the URL as title.
1171 if ($link['title
'] == '') {
1172 $link['title
'] = $link['url
'];
1175 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE
1176 && ! is_note($link['url
'])
1178 $thumbnailer = new Thumbnailer($conf);
1179 $link['thumbnail
'] = $thumbnailer->get($url);
1182 $pluginManager->executeHooks('save_link
', $link);
1184 $LINKSDB[$id] = $link;
1185 $LINKSDB->save($conf->get('resource.page_cache
'));
1187 $history->addLink($link);
1189 $history->updateLink($link);
1192 // If we are called from the bookmarklet, we must close the popup:
1193 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1194 echo '<script
>self
.close();</script
>';
1198 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1199 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1200 // Scroll to the link which has been edited.
1201 $location .= '#' . $link['shorturl'];
1202 // After saving the link, redirect to the page the user was on.
1203 header('Location: '. $location);
1207 // -------- User clicked the "Cancel" button when editing a link.
1208 if (isset($_POST['cancel_edit'])) {
1209 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1210 if (! isset($LINKSDB[$id])) {
1211 header('Location: ?');
1213 // If we are called from the bookmarklet, we must close the popup:
1214 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1215 echo '<script>self.close();</script>';
1218 $link = $LINKSDB[$id];
1219 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1220 // Scroll to the link which has been edited.
1221 $returnurl .= '#'. $link['shorturl'];
1222 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1223 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1227 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1228 if ($targetPage == Router
::$PAGE_DELETELINK) {
1229 if (! $sessionManager->checkToken($_GET['token'])) {
1230 die(t('Wrong token.'));
1233 $ids = trim($_GET['lf_linkdate']);
1234 if (strpos($ids, ' ') !== false) {
1235 // multiple, space-separated ids provided
1236 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1238 // only a single id provided
1241 // assert at least one id is given
1243 die('no id provided');
1245 foreach ($ids as $id) {
1246 $id = (int) escape($id);
1247 $link = $LINKSDB[$id];
1248 $pluginManager->executeHooks('delete_link', $link);
1249 $history->deleteLink($link);
1250 unset($LINKSDB[$id]);
1252 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1254 // If we are called from the bookmarklet, we must close the popup:
1255 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1256 echo '<script>self.close();</script>';
1261 if (isset($_SERVER['HTTP_REFERER'])) {
1262 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1263 $location = generateLocation(
1264 $_SERVER['HTTP_REFERER'],
1265 $_SERVER['HTTP_HOST'],
1266 ['delete_link', 'edit_link', $link['shorturl']]
1270 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1274 // -------- User clicked either "Set public" or "Set private" bulk operation
1275 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1276 if (! $sessionManager->checkToken($_GET['token'])) {
1277 die(t('Wrong token.'));
1280 $ids = trim($_GET['ids']);
1281 if (strpos($ids, ' ') !== false) {
1282 // multiple, space-separated ids provided
1283 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1285 // only a single id provided
1289 // assert at least one id is given
1291 die('no id provided');
1293 // assert that the visibility is valid
1294 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1295 die('invalid visibility');
1297 $private = $_GET['newVisibility'] === 'private';
1299 foreach ($ids as $id) {
1300 $id = (int) escape($id);
1301 $link = $LINKSDB[$id];
1302 $link['private'] = $private;
1303 $pluginManager->executeHooks('save_link', $link);
1304 $LINKSDB[$id] = $link;
1306 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1309 if (isset($_SERVER['HTTP_REFERER'])) {
1310 $location = generateLocation(
1311 $_SERVER['HTTP_REFERER'],
1312 $_SERVER['HTTP_HOST']
1315 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1319 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1320 if (isset($_GET['edit_link'])) {
1321 $id = (int) escape($_GET['edit_link']);
1322 $link = $LINKSDB[$id]; // Read database
1324 header('Location: ?');
1326 } // Link not found in database.
1327 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1330 'link_is_new' => false,
1331 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1332 'tags' => $LINKSDB->linksCountPerTag(),
1334 $pluginManager->executeHooks('render_editlink', $data);
1336 foreach ($data as $key => $value) {
1337 $PAGE->assign($key, $value);
1340 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1341 $PAGE->renderPage('editlink');
1345 // -------- User want to post a new link: Display link edit form.
1346 if (isset($_GET['post'])) {
1347 $url = cleanup_url($_GET['post']);
1349 $link_is_new = false;
1350 // Check if URL is not already in database (in this case, we will edit the existing link)
1351 $link = $LINKSDB->getLinkFromUrl($url);
1353 $link_is_new = true;
1354 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1355 // Get title if it was provided in URL (by the bookmarklet).
1356 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1357 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1358 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1359 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1360 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1362 // If this is an HTTP(S) link, we try go get the page to extract
1363 // the title (otherwise we will to straight to the edit form.)
1364 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1365 $retrieveDescription = $conf->get('general.retrieve_description');
1366 // Short timeout to keep the application responsive
1367 // The callback will fill $charset and $title with data from the downloaded page.
1370 $conf->get('general.download_timeout', 30),
1371 $conf->get('general.download_max_size', 4194304),
1372 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1374 if (! empty($title) && strtolower($charset) != 'utf-8') {
1375 $title = mb_convert_encoding($title, 'utf-8', $charset);
1380 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1381 $title = $conf->get('general.default_note_title', t('Note: '));
1383 $url = escape($url);
1384 $title = escape($title);
1387 'linkdate' => $linkdate,
1390 'description' => $description,
1392 'private' => $private,
1395 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1400 'link_is_new' => $link_is_new,
1401 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1402 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1403 'tags' => $LINKSDB->linksCountPerTag(),
1404 'default_private_links' => $conf->get('privacy.default_private_links', false),
1406 $pluginManager->executeHooks('render_editlink', $data);
1408 foreach ($data as $key => $value) {
1409 $PAGE->assign($key, $value);
1412 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1413 $PAGE->renderPage('editlink');
1417 if ($targetPage == Router
::$PAGE_PINLINK) {
1418 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1419 // FIXME! Use a proper error system.
1420 $msg = t('Invalid link ID provided');
1421 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1424 if (! $sessionManager->checkToken($_GET['token'])) {
1425 die('Wrong token.');
1428 $link = $LINKSDB[$_GET['id']];
1429 $link['sticky'] = ! $link['sticky'];
1430 $LINKSDB[(int) $_GET['id']] = $link;
1431 $LINKSDB->save($conf->get('resource.page_cache'));
1432 header('Location: '.index_url($_SERVER));
1436 if ($targetPage == Router
::$PAGE_EXPORT) {
1437 // Export links as a Netscape Bookmarks file
1439 if (empty($_GET['selection'])) {
1440 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1441 $PAGE->renderPage('export');
1445 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1446 $selection = $_GET['selection'];
1447 if (isset($_GET['prepend_note_url'])) {
1448 $prependNoteUrl = $_GET['prepend_note_url'];
1450 $prependNoteUrl = false;
1456 NetscapeBookmarkUtils
::filterAndFormat(
1463 } catch (Exception
$exc) {
1464 header('Content-Type: text/plain; charset=utf-8');
1465 echo $exc->getMessage();
1468 $now = new DateTime();
1469 header('Content-Type: text/html; charset=utf-8');
1471 'Content-disposition: attachment; filename=bookmarks_'
1472 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1474 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1475 $PAGE->assign('eol', PHP_EOL
);
1476 $PAGE->assign('selection', $selection);
1477 $PAGE->renderPage('export.bookmarks');
1481 if ($targetPage == Router
::$PAGE_IMPORT) {
1482 // Upload a Netscape bookmark dump to import its contents
1484 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1485 // Show import dialog
1488 get_max_upload_size(
1489 ini_get('post_max_size'),
1490 ini_get('upload_max_filesize'),
1496 get_max_upload_size(
1497 ini_get('post_max_size'),
1498 ini_get('upload_max_filesize'),
1502 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1503 $PAGE->renderPage('import');
1507 // Import bookmarks from an uploaded file
1508 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1509 // The file is too big or some form field may be missing.
1512 'The file you are trying to upload is probably bigger than what this webserver can accept'
1513 .' (%s). Please upload in smaller chunks.'
1515 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1517 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1520 if (! $sessionManager->checkToken($_POST['token'])) {
1521 die('Wrong token.');
1523 $status = NetscapeBookmarkUtils
::import(
1530 echo '<script>alert("'.$status.'");document.location=\'?do='
1531 .Router
::$PAGE_IMPORT .'\';</script>';
1535 // Plugin administration page
1536 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1537 $pluginMeta = $pluginManager->getPluginsMeta();
1539 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1540 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1541 return $v['order'] !== false;
1544 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1548 return $a['order'] - $b['order'];
1551 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1552 return $v['order'] === false;
1555 $PAGE->assign('enabledPlugins', $enabledPlugins);
1556 $PAGE->assign('disabledPlugins', $disabledPlugins);
1557 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1558 $PAGE->renderPage('pluginsadmin');
1562 // Plugin administration form action
1563 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1565 if (isset($_POST['parameters_form'])) {
1566 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1567 unset($_POST['parameters_form']);
1568 foreach ($_POST as $param => $value) {
1569 $conf->set('plugins.'. $param, escape($value));
1572 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1574 $conf->write($loginManager->isLoggedIn());
1575 $history->updateSettings();
1576 } catch (Exception
$e) {
1578 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1582 // TODO: do not handle exceptions/errors in JS.
1583 echo '<script>alert("'
1585 .'");document.location=\'?do='
1586 . Router
::$PAGE_PLUGINSADMIN
1590 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1594 // Get a fresh token
1595 if ($targetPage == Router
::$GET_TOKEN) {
1596 header('Content-Type:text/plain');
1597 echo $sessionManager->generateToken($conf);
1601 // -------- Thumbnails Update
1602 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1604 foreach ($LINKSDB as $link) {
1605 // A note or not HTTP(S)
1606 if (is_note($link['url']) || ! startsWith(strtolower($link['url']), 'http')) {
1609 $ids[] = $link['id'];
1611 $PAGE->assign('ids', $ids);
1612 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1613 $PAGE->renderPage('thumbnails');
1617 // -------- Single Thumbnail Update
1618 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1619 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1620 http_response_code(400);
1623 $id = (int) $_POST['id'];
1624 if (empty($LINKSDB[$id])) {
1625 http_response_code(404);
1628 $thumbnailer = new Thumbnailer($conf);
1629 $link = $LINKSDB[$id];
1630 $link['thumbnail'] = $thumbnailer->get($link['url']);
1631 $LINKSDB[$id] = $link;
1632 $LINKSDB->save($conf->get('resource.page_cache'));
1634 echo json_encode($link);
1638 // -------- Otherwise, simply display search form and links:
1639 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1644 * Template for the list of links (<div id="linklist">)
1645 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1647 * @param pageBuilder $PAGE pageBuilder instance.
1648 * @param LinkDB $LINKSDB LinkDB instance.
1649 * @param ConfigManager $conf Configuration Manager instance.
1650 * @param PluginManager $pluginManager Plugin Manager instance.
1651 * @param LoginManager $loginManager LoginManager instance
1653 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1655 // Used in templates
1656 if (isset($_GET['searchtags'])) {
1657 if (! empty($_GET['searchtags'])) {
1658 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1660 $searchtags = false;
1665 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1668 if (! empty($_SERVER['QUERY_STRING'])
1669 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1671 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1672 } catch (LinkNotFoundException
$e) {
1673 $PAGE->render404($e->getMessage());
1677 // Filter links according search parameters.
1678 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1680 'searchtags' => $searchtags,
1681 'searchterm' => $searchterm,
1683 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1686 // ---- Handle paging.
1688 foreach ($linksToDisplay as $key => $value) {
1692 // Select articles according to paging.
1693 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1694 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1695 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1696 $page = $page < 1 ? 1 : $page;
1697 $page = $page > $pagecount ? $pagecount : $page;
1699 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1700 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1702 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1703 if ($thumbnailsEnabled) {
1704 $thumbnailer = new Thumbnailer($conf);
1707 $linkDisp = array();
1708 while ($i<$end && $i<count($keys)) {
1709 $link = $linksToDisplay[$keys[$i]];
1710 $link['description'] = format_description($link['description']);
1711 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1712 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1713 $link['timestamp'] = $link['created']->getTimestamp();
1714 if (! empty($link['updated'])) {
1715 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1717 $link['updated_timestamp'] = '';
1719 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1720 uasort($taglist, 'strcasecmp');
1721 $link['taglist'] = $taglist;
1723 // Logged in, thumbnails enabled, not a note,
1724 // and (never retrieved yet or no valid cache file)
1725 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1726 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1728 $elem = $LINKSDB[$keys[$i]];
1729 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1730 $LINKSDB[$keys[$i]] = $elem;
1732 $link['thumbnail'] = $elem['thumbnail'];
1735 // Check for both signs of a note: starting with ? and 7 chars long.
1736 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1737 $link['url'] = index_url($_SERVER) . $link['url'];
1740 $linkDisp[$keys[$i]] = $link;
1744 // If we retrieved new thumbnails, we update the database.
1745 if (!empty($updateDB)) {
1746 $LINKSDB->save($conf->get('resource.page_cache'));
1749 // Compute paging navigation
1750 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1751 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1752 $previous_page_url = '';
1753 if ($i != count($keys)) {
1754 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1758 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1761 // Fill all template fields.
1763 'previous_page_url' => $previous_page_url,
1764 'next_page_url' => $next_page_url,
1765 'page_current' => $page,
1766 'page_max' => $pagecount,
1767 'result_count' => count($linksToDisplay),
1768 'search_term' => $searchterm,
1769 'search_tags' => $searchtags,
1770 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1771 'links' => $linkDisp,
1774 // If there is only a single link, we change on-the-fly the title of the page.
1775 if (count($linksToDisplay) == 1) {
1776 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1777 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1778 $data['pagetitle'] = t('Search: ');
1779 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1780 $bracketWrap = function ($tag) {
1781 return '['. $tag .']';
1783 $data['pagetitle'] .= ! empty($searchtags)
1784 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1786 $data['pagetitle'] .= '- '. $conf->get('general.title');
1789 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1791 foreach ($data as $key => $value) {
1792 $PAGE->assign($key, $value);
1800 * This function should NEVER be called if the file data/config.php exists.
1802 * @param ConfigManager $conf Configuration Manager instance.
1803 * @param SessionManager $sessionManager SessionManager instance
1804 * @param LoginManager $loginManager LoginManager instance
1806 function install($conf, $sessionManager, $loginManager)
1808 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1809 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1810 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1814 // This part makes sure sessions works correctly.
1815 // (Because on some hosts, session.save_path may not be set correctly,
1816 // or we may not have write access to it.)
1817 if (isset($_GET['test_session'])
1818 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1819 // Step 2: Check if data in session is correct.
1821 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1822 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1823 'and that you have write access to it.<br>'.
1824 'It currently points to %s.<br>'.
1825 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1826 'or any custom hostname without a dot causes cookie storage to fail. '.
1827 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1829 $msg = sprintf($msg, session_save_path());
1831 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1834 if (!isset($_SESSION['session_tested'])) {
1835 // Step 1 : Try to store data in session and reload page.
1836 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1837 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1839 if (isset($_GET['test_session'])) {
1840 // Step 3: Sessions are OK. Remove test parameter from URL.
1841 header('Location: '.index_url($_SERVER));
1845 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1847 if (!empty($_POST['continent']) && !empty($_POST['city'])
1848 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1850 $tz = $_POST['continent'].'/'.$_POST['city'];
1852 $conf->set('general.timezone', $tz);
1853 $login = $_POST['setlogin'];
1854 $conf->set('credentials.login', $login);
1855 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1856 $conf->set('credentials.salt', $salt);
1857 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1858 if (!empty($_POST['title'])) {
1859 $conf->set('general.title', escape($_POST['title']));
1861 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1863 $conf->set('translation.language', escape($_POST['language']));
1864 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1865 $conf->set('api.enabled', !empty($_POST['enableApi']));
1868 generate_api_secret(
1869 $conf->get('credentials.login'),
1870 $conf->get('credentials.salt')
1874 // Everything is ok, let's create config file.
1875 $conf->write($loginManager->isLoggedIn());
1876 } catch (Exception
$e) {
1878 'ERROR while writing config file after installation.' . PHP_EOL
.
1882 // TODO: do not handle exceptions/errors in JS.
1883 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1886 echo '<script>alert('
1887 .'"Shaarli is now configured. '
1888 .'Please enter your login/password and start shaaring your links!"'
1889 .');document.location=\'?do=login\';</script>';
1893 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1894 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1895 $PAGE->assign('continents', $continents);
1896 $PAGE->assign('cities', $cities);
1897 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1898 $PAGE->renderPage('install');
1902 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1903 showDailyRSS($conf, $loginManager);
1907 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1908 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1912 $history = new History($conf->get('resource.history'));
1913 } catch (Exception
$e) {
1914 die($e->getMessage());
1917 $linkDb = new LinkDB(
1918 $conf->get('resource.datastore'),
1919 $loginManager->isLoggedIn(),
1920 $conf->get('privacy.hide_public_links')
1923 $container = new \Slim\
Container();
1924 $container['conf'] = $conf;
1925 $container['plugins'] = $pluginManager;
1926 $container['history'] = $history;
1927 $app = new \Slim\
App($container);
1930 $app->group('/api/v1', function () {
1931 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1932 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1933 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1934 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1935 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1936 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1938 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1939 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1940 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1941 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1943 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1944 })->add('\Shaarli\Api\ApiMiddleware');
1946 $response = $app->run(true);
1948 // Hack to make Slim and Shaarli router work together:
1949 // If a Slim route isn't found and NOT API call, we call renderPage().
1950 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1951 // We use UTF-8 for proper international characters handling.
1952 header('Content-Type: text/html; charset=utf-8');
1953 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1955 $response = $response
1956 ->withHeader('Access-Control-Allow-Origin', '*')
1958 'Access-Control-Allow-Headers',
1959 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1961 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1962 $app->respond($response);