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/ApplicationUtils.php';
60 require_once 'application/Cache.php';
61 require_once 'application/CachedPage.php';
62 require_once 'application/config/ConfigPlugin.php';
63 require_once 'application/FeedBuilder.php';
64 require_once 'application/FileUtils.php';
65 require_once 'application/History.php';
66 require_once 'application/HttpUtils.php';
67 require_once 'application/LinkDB.php';
68 require_once 'application/LinkFilter.php';
69 require_once 'application/LinkUtils.php';
70 require_once 'application/NetscapeBookmarkUtils.php';
71 require_once 'application/PageBuilder.php';
72 require_once 'application/TimeZone.php';
73 require_once 'application/Url.php';
74 require_once 'application/Utils.php';
75 require_once 'application/PluginManager.php';
76 require_once 'application/Router.php';
77 require_once 'application/Updater.php';
78 use \Shaarli\Config\ConfigManager
;
79 use \Shaarli\Languages
;
80 use \Shaarli\Security\LoginManager
;
81 use \Shaarli\Security\SessionManager
;
82 use \Shaarli\ThemeUtils
;
83 use \Shaarli\Thumbnailer
;
85 // Ensure the PHP version is supported
87 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
88 } catch (Exception
$exc) {
89 header('Content-Type: text/plain; charset=utf-8');
90 echo $exc->getMessage();
94 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
96 // Force cookie path (but do not change lifetime)
97 $cookie = session_get_cookie_params();
99 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
100 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
102 // Set default cookie expiration and path.
103 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
104 // Set session parameters on server side.
105 // Use cookies to store session.
106 ini_set('session.use_cookies', 1);
107 // Force cookies for session (phpsessionID forbidden in URL).
108 ini_set('session.use_only_cookies', 1);
109 // Prevent PHP form using sessionID in URL if cookies are disabled.
110 ini_set('session.use_trans_sid', false);
112 session_name('shaarli');
113 // Start session if needed (Some server auto-start sessions).
114 if (session_status() == PHP_SESSION_NONE
) {
118 // Regenerate session ID if invalid or not defined in cookie.
119 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
120 session_regenerate_id(true);
121 $_COOKIE['shaarli'] = session_id();
124 $conf = new ConfigManager();
125 $sessionManager = new SessionManager($_SESSION, $conf);
126 $loginManager = new LoginManager($GLOBALS, $conf, $sessionManager);
127 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
128 $clientIpId = client_ip_id($_SERVER);
130 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
131 if (! defined('LC_MESSAGES')) {
132 define('LC_MESSAGES', LC_COLLATE
);
135 // Sniff browser language and set date format accordingly.
136 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
137 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
140 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
142 $conf->setEmpty('general.timezone', date_default_timezone_get());
143 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
144 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
145 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
147 $pluginManager = new PluginManager($conf);
148 $pluginManager->load($conf->get('general.enabled_plugins'));
150 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
152 ob_start(); // Output buffering for the page cache.
154 // Prevent caching on client side or proxy: (yes, it's ugly)
155 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
156 header("Cache-Control: no-store, no-cache, must-revalidate");
157 header("Cache-Control: post-check=0, pre-check=0", false);
158 header("Pragma: no-cache");
160 if (! is_file($conf->getConfigFileExt())) {
161 // Ensure Shaarli has proper access to its resources
162 $errors = ApplicationUtils
::checkResourcePermissions($conf);
164 if ($errors != array()) {
165 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
167 foreach ($errors as $error) {
168 $message .= '<li>'.$error.'</li>';
172 header('Content-Type: text/html; charset=utf-8');
177 // Display the installation form if no existing config is found
178 install($conf, $sessionManager, $loginManager);
181 $loginManager->checkLoginState($_COOKIE, $clientIpId);
184 * Adapter function to ensure compatibility with third-party templates
186 * @see https://github.com/shaarli/Shaarli/pull/1086
188 * @return bool true when the user is logged in, false otherwise
190 function isLoggedIn()
192 global $loginManager;
193 return $loginManager->isLoggedIn();
197 // ------------------------------------------------------------------------------------------
198 // Process login form: Check if login/password is correct.
199 if (isset($_POST['login'])) {
200 if (! $loginManager->canLogin($_SERVER)) {
201 die(t('I said: NO. You are banned for the moment. Go away.'));
203 if (isset($_POST['password'])
204 && $sessionManager->checkToken($_POST['token'])
205 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
207 $loginManager->handleSuccessfulLogin($_SERVER);
210 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
211 // Note: Never forget the trailing slash on the cookie path!
212 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
215 if (!empty($_POST['longlastingsession'])) {
216 // Keep the session cookie even after the browser closes
217 $sessionManager->setStaySignedIn(true);
218 $expirationTime = $sessionManager->extendSession();
221 $loginManager::$STAY_SIGNED_IN_COOKIE,
222 $loginManager->getStaySignedInToken(),
227 // Standard session expiration (=when browser closes)
231 // Send cookie with the new expiration date to the browser
232 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
233 session_regenerate_id(true);
235 // Optional redirect after login:
236 if (isset($_GET['post'])) {
237 $uri = '?post='. urlencode($_GET['post']);
238 foreach (array('description', 'source', 'title', 'tags') as $param) {
239 if (!empty($_GET[$param])) {
240 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
243 header('Location: '. $uri);
247 if (isset($_GET['edit_link'])) {
248 header('Location: ?edit_link='. escape($_GET['edit_link']));
252 if (isset($_POST['returnurl'])) {
253 // Prevent loops over login screen.
254 if (strpos($_POST['returnurl'], 'do=login') === false) {
255 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
259 header('Location: ?');
262 $loginManager->handleFailedLogin($_SERVER);
263 $redir = '&username='. urlencode($_POST['login']);
264 if (isset($_GET['post'])) {
265 $redir .= '&post=' . urlencode($_GET['post']);
266 foreach (array('description', 'source', 'title', 'tags') as $param) {
267 if (!empty($_GET[$param])) {
268 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
272 // Redirect to login screen.
273 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
278 // ------------------------------------------------------------------------------------------
279 // Token management for XSRF protection
280 // Token should be used in any form which acts on data (create,update,delete,import...).
281 if (!isset($_SESSION['tokens'])) {
282 $_SESSION['tokens']=array(); // Token are attached to the session.
286 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
287 * Gives the last 7 days (which have links).
288 * This RSS feed cannot be filtered.
290 * @param ConfigManager $conf Configuration Manager instance
291 * @param LoginManager $loginManager LoginManager instance
293 function showDailyRSS($conf, $loginManager)
296 $query = $_SERVER['QUERY_STRING'];
297 $cache = new CachedPage(
298 $conf->get('config.PAGE_CACHE'),
300 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
302 $cached = $cache->cachedVersion();
303 if (!empty($cached)) {
308 // If cached was not found (or not usable), then read the database and build the response:
309 // Read links from database (and filter private links if used it not logged in).
310 $LINKSDB = new LinkDB(
311 $conf->get('resource.datastore'),
312 $loginManager->isLoggedIn(),
313 $conf->get('privacy.hide_public_links'),
314 $conf->get('redirector.url'),
315 $conf->get('redirector.encode_url')
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(
358 $link['description'],
359 $conf->get('redirector.url'),
360 $conf->get('redirector.encode_url')
362 $link['timestamp'] = $link['created']->getTimestamp();
363 if (startsWith($link['url'], '?')) {
364 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
368 // Then build the HTML for this day:
370 $tpl->assign('title', $conf->get('general.title'));
371 $tpl->assign('daydate', $dayDate->getTimestamp());
372 $tpl->assign('absurl', $absurl);
373 $tpl->assign('links', $links);
374 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
375 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
376 $tpl->assign('index_url', $pageaddr);
377 $html = $tpl->draw('dailyrss', true);
379 echo $html . PHP_EOL
;
381 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
383 $cache->cache(ob_get_contents());
389 * Show the 'Daily' page.
391 * @param PageBuilder $pageBuilder Template engine wrapper.
392 * @param LinkDB $LINKSDB LinkDB instance.
393 * @param ConfigManager $conf Configuration Manager instance.
394 * @param PluginManager $pluginManager Plugin Manager instance.
395 * @param LoginManager $loginManager Login Manager instance
397 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager)
399 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
400 if (isset($_GET['day'])) {
404 $days = $LINKSDB->days();
405 $i = array_search($day, $days);
406 if ($i === false && count($days)) {
407 // no links for day, but at least one day with links
408 $i = count($days) - 1;
416 $previousday=$days[$i - 1];
418 if ($i < count($days) - 1) {
419 $nextday = $days[$i +
1];
423 $linksToDisplay = $LINKSDB->filterDay($day);
424 } catch (Exception
$exc) {
426 $linksToDisplay = array();
429 // We pre-format some fields for proper output.
430 foreach ($linksToDisplay as $key => $link) {
431 $taglist = explode(' ', $link['tags']);
432 uasort($taglist, 'strcasecmp');
433 $linksToDisplay[$key]['taglist']=$taglist;
434 $linksToDisplay[$key]['formatedDescription'] = format_description(
435 $link['description'],
436 $conf->get('redirector.url'),
437 $conf->get('redirector.encode_url')
439 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
442 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
444 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
445 'linksToDisplay' => $linksToDisplay,
446 'day' => $dayDate->getTimestamp(),
447 'dayDate' => $dayDate,
448 'previousday' => $previousday,
449 'nextday' => $nextday,
452 /* Hook is called before column construction so that plugins don't have
453 to deal with columns. */
454 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
456 /* We need to spread the articles on 3 columns.
457 I did not want to use a JavaScript lib like http://masonry.desandro.com/
458 so I manually spread entries with a simple method: I roughly evaluate the
459 height of a div according to title and description length.
461 $columns = array(array(), array(), array()); // Entries to display, for each column.
462 $fill = array(0, 0, 0); // Rough estimate of columns fill.
463 foreach ($data['linksToDisplay'] as $key => $link) {
464 // Roughly estimate length of entry (by counting characters)
465 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
466 // Description: 836 characters gives roughly 342 pixel height.
467 // This is not perfect, but it's usually OK.
468 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
469 if ($link['thumbnail']) {
470 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
472 // Then put in column which is the less filled:
473 $smallest = min($fill); // find smallest value in array.
474 $index = array_search($smallest, $fill); // find index of this smallest value.
475 array_push($columns[$index], $link); // Put entry in this column.
476 $fill[$index] +
= $length;
479 $data['cols'] = $columns;
481 foreach ($data as $key => $value) {
482 $pageBuilder->assign($key, $value);
485 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
486 $pageBuilder->renderPage('daily');
491 * Renders the linklist
493 * @param pageBuilder $PAGE pageBuilder instance.
494 * @param LinkDB $LINKSDB LinkDB instance.
495 * @param ConfigManager $conf Configuration Manager instance.
496 * @param PluginManager $pluginManager Plugin Manager instance.
498 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
500 buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
501 $PAGE->renderPage('linklist');
505 * Render HTML page (according to URL parameters and user rights)
507 * @param ConfigManager $conf Configuration Manager instance.
508 * @param PluginManager $pluginManager Plugin Manager instance,
509 * @param LinkDB $LINKSDB
510 * @param History $history instance
511 * @param SessionManager $sessionManager SessionManager instance
512 * @param LoginManager $loginManager LoginManager instance
514 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
516 $updater = new Updater(
517 read_updates_file($conf->get('resource.updates')),
520 $loginManager->isLoggedIn(),
524 $newUpdates = $updater->update();
525 if (! empty($newUpdates)) {
527 $conf->get('resource.updates'),
528 $updater->getDoneUpdates()
531 } catch (Exception
$e) {
532 die($e->getMessage());
535 $PAGE = new PageBuilder($conf, $_SESSION, $LINKSDB, $sessionManager->generateToken(), $loginManager->isLoggedIn());
536 $PAGE->assign('linkcount', count($LINKSDB));
537 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
538 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
540 // Determine which page will be rendered.
541 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
542 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
544 if (// if the user isn't logged in
545 !$loginManager->isLoggedIn() &&
546 // and Shaarli doesn't have public content...
547 $conf->get('privacy.hide_public_links') &&
548 // and is configured to enforce the login
549 $conf->get('privacy.force_login') &&
550 // and the current page isn't already the login page
551 $targetPage !== Router
::$PAGE_LOGIN &&
552 // and the user is not requesting a feed (which would lead to a different content-type as expected)
553 $targetPage !== Router
::$PAGE_FEED_ATOM &&
554 $targetPage !== Router
::$PAGE_FEED_RSS
556 // force current page to be the login page
557 $targetPage = Router
::$PAGE_LOGIN;
560 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
561 // Then assign generated data to RainTPL.
562 $common_hooks = array(
568 foreach ($common_hooks as $name) {
569 $plugin_data = array();
570 $pluginManager->executeHooks(
574 'target' => $targetPage,
575 'loggedin' => $loginManager->isLoggedIn()
578 $PAGE->assign('plugins_' . $name, $plugin_data);
581 // -------- Display login form.
582 if ($targetPage == Router
::$PAGE_LOGIN) {
583 if ($conf->get('security.open_shaarli')) {
584 header('Location: ?');
586 } // No need to login for open Shaarli
587 if (isset($_GET['username'])) {
588 $PAGE->assign('username', escape($_GET['username']));
590 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
591 // add default state of the 'remember me' checkbox
592 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
593 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
594 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
595 $PAGE->renderPage('loginform');
598 // -------- User wants to logout.
599 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
600 invalidateCaches($conf->get('resource.page_cache'));
601 $sessionManager->logout();
602 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
603 header('Location: ?');
607 // -------- Picture wall
608 if ($targetPage == Router
::$PAGE_PICWALL) {
609 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
610 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
611 $PAGE->assign('linksToDisplay', []);
612 $PAGE->renderPage('picwall');
616 // Optionally filter the results:
617 $links = $LINKSDB->filterSearch($_GET);
618 $linksToDisplay = array();
620 // Get only links which have a thumbnail.
621 // Note: we do not retrieve thumbnails here, the request is too heavy.
622 foreach ($links as $key => $link) {
623 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
624 $linksToDisplay[] = $link; // Add to array.
629 'linksToDisplay' => $linksToDisplay,
631 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
633 foreach ($data as $key => $value) {
634 $PAGE->assign($key, $value);
638 $PAGE->renderPage('picwall');
642 // -------- Tag cloud
643 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
644 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
645 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
646 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
648 // We sort tags alphabetically, then choose a font size according to count.
649 // First, find max value.
651 foreach ($tags as $value) {
652 $maxcount = max($maxcount, $value);
655 alphabetical_sort($tags, false, true);
658 foreach ($tags as $key => $value) {
659 if (in_array($key, $filteringTags)) {
662 // Tag font size scaling:
663 // default 15 and 30 logarithm bases affect scaling,
664 // 22 and 6 are arbitrary font sizes for max and min sizes.
665 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
666 $tagList[$key] = array(
668 'size' => number_format($size, 2, '.', ''),
672 $searchTags = implode(' ', escape($filteringTags));
674 'search_tags' => $searchTags,
677 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
679 foreach ($data as $key => $value) {
680 $PAGE->assign($key, $value);
683 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
684 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
685 $PAGE->renderPage('tag.cloud');
690 if ($targetPage == Router
::$PAGE_TAGLIST) {
691 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
692 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
693 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
694 foreach ($filteringTags as $tag) {
695 if (array_key_exists($tag, $tags)) {
700 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
701 alphabetical_sort($tags, false, true);
704 $searchTags = implode(' ', escape($filteringTags));
706 'search_tags' => $searchTags,
709 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
711 foreach ($data as $key => $value) {
712 $PAGE->assign($key, $value);
715 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
716 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
717 $PAGE->renderPage('tag.list');
722 if ($targetPage == Router
::$PAGE_DAILY) {
723 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
726 // ATOM and RSS feed.
727 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
728 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
729 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
732 $query = $_SERVER['QUERY_STRING'];
733 $cache = new CachedPage(
734 $conf->get('resource.page_cache'),
736 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
738 $cached = $cache->cachedVersion();
739 if (!empty($cached)) {
745 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
746 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
747 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
748 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
749 $data = $feedGenerator->buildData();
751 // Process plugin hook.
752 $pluginManager->executeHooks('render_feed', $data, array(
753 'loggedin' => $loginManager->isLoggedIn(),
754 'target' => $targetPage,
757 // Render the template.
758 $PAGE->assignAll($data);
759 $PAGE->renderPage('feed.'. $feedType);
760 $cache->cache(ob_get_contents());
765 // Display opensearch plugin (XML)
766 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
767 header('Content-Type: application/xml; charset=utf-8');
768 $PAGE->assign('serverurl', index_url($_SERVER));
769 $PAGE->renderPage('opensearch');
773 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
774 if (isset($_GET['addtag'])) {
775 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
776 if (empty($_SERVER['HTTP_REFERER'])) {
777 // In case browser does not send HTTP_REFERER
778 header('Location: ?searchtags='.urlencode($_GET['addtag']));
781 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
783 // Prevent redirection loop
784 if (isset($params['addtag'])) {
785 unset($params['addtag']);
788 // Check if this tag is already in the search query and ignore it if it is.
789 // Each tag is always separated by a space
790 if (isset($params['searchtags'])) {
791 $current_tags = explode(' ', $params['searchtags']);
793 $current_tags = array();
796 foreach ($current_tags as $value) {
797 if ($value === $_GET['addtag']) {
802 // Append the tag if necessary
803 if (empty($params['searchtags'])) {
804 $params['searchtags'] = trim($_GET['addtag']);
806 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
809 // We also remove page (keeping the same page has no sense, since the
810 // results are different)
811 unset($params['page']);
813 header('Location: ?'.http_build_query($params));
817 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
818 if (isset($_GET['removetag'])) {
819 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
820 if (empty($_SERVER['HTTP_REFERER'])) {
821 header('Location: ?');
825 // In case browser does not send HTTP_REFERER
826 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
828 // Prevent redirection loop
829 if (isset($params['removetag'])) {
830 unset($params['removetag']);
833 if (isset($params['searchtags'])) {
834 $tags = explode(' ', $params['searchtags']);
835 // Remove value from array $tags.
836 $tags = array_diff($tags, array($_GET['removetag']));
837 $params['searchtags'] = implode(' ', $tags);
839 if (empty($params['searchtags'])) {
840 unset($params['searchtags']);
843 // We also remove page (keeping the same page has no sense, since
844 // the results are different)
845 unset($params['page']);
847 header('Location: ?'.http_build_query($params));
851 // -------- User wants to change the number of links per page (linksperpage=...)
852 if (isset($_GET['linksperpage'])) {
853 if (is_numeric($_GET['linksperpage'])) {
854 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
857 if (! empty($_SERVER['HTTP_REFERER'])) {
858 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
862 header('Location: '. $location);
866 // -------- User wants to see only private links (toggle)
867 if (isset($_GET['visibility'])) {
868 if ($_GET['visibility'] === 'private') {
869 // Visibility not set or not already private, set private, otherwise reset it
870 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
871 // See only private links
872 $_SESSION['visibility'] = 'private';
874 unset($_SESSION['visibility']);
876 } elseif ($_GET['visibility'] === 'public') {
877 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
878 // See only public links
879 $_SESSION['visibility'] = 'public';
881 unset($_SESSION['visibility']);
885 if (! empty($_SERVER['HTTP_REFERER'])) {
886 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
890 header('Location: '. $location);
894 // -------- User wants to see only untagged links (toggle)
895 if (isset($_GET['untaggedonly'])) {
896 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
898 if (! empty($_SERVER['HTTP_REFERER'])) {
899 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
903 header('Location: '. $location);
907 // -------- Handle other actions allowed for non-logged in users:
908 if (!$loginManager->isLoggedIn()) {
909 // User tries to post new link but is not logged in:
910 // Show login screen, then redirect to ?post=...
911 if (isset($_GET['post'])) {
912 header( // Redirect to login page, then back to post link.
913 'Location: ?do=login&post='.urlencode($_GET['post']).
914 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
915 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
916 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
917 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
922 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
923 if (isset($_GET['edit_link'])) {
924 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
928 exit; // Never remove this one! All operations below are reserved for logged in user.
931 // -------- All other functions are reserved for the registered user:
933 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
934 if ($targetPage == Router
::$PAGE_TOOLS) {
936 'pageabsaddr' => index_url($_SERVER),
937 'sslenabled' => is_https($_SERVER),
939 $pluginManager->executeHooks('render_tools', $data);
941 foreach ($data as $key => $value) {
942 $PAGE->assign($key, $value);
945 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
946 $PAGE->renderPage('tools');
950 // -------- User wants to change his/her password.
951 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
952 if ($conf->get('security.open_shaarli')) {
953 die(t('You are not supposed to change a password on an Open Shaarli.'));
956 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
957 if (!$sessionManager->checkToken($_POST['token'])) {
958 die(t('Wrong token.')); // Go away!
961 // Make sure old password is correct.
963 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
965 if ($oldhash != $conf->get('credentials.hash')) {
966 echo '<script>alert("'
967 . t('The old password is not correct.')
968 .'");document.location=\'?do=changepasswd\';</script>';
972 // Salt renders rainbow-tables attacks useless.
973 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
977 $_POST['setpassword']
978 . $conf->get('credentials.login')
979 . $conf->get('credentials.salt')
983 $conf->write($loginManager->isLoggedIn());
984 } catch (Exception
$e) {
986 'ERROR while writing config file after changing password.' . PHP_EOL
.
990 // TODO: do not handle exceptions/errors in JS.
991 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
994 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
997 // show the change password form.
998 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
999 $PAGE->renderPage('changepassword');
1004 // -------- User wants to change configuration
1005 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1006 if (!empty($_POST['title'])) {
1007 if (!$sessionManager->checkToken($_POST['token'])) {
1008 die(t('Wrong token.')); // Go away!
1011 if (!empty($_POST['continent']) && !empty($_POST['city'])
1012 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1014 $tz = $_POST['continent'] . '/' . $_POST['city'];
1016 $conf->set('general.timezone', $tz);
1017 $conf->set('general.title', escape($_POST['title']));
1018 $conf->set('general.header_link', escape($_POST['titleLink']));
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('private_links_default', $conf->get('privacy.default_private_links', false));
1068 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1069 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1070 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1071 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1072 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1073 $PAGE->assign('api_secret', $conf->get('api.secret'));
1074 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1075 $PAGE->assign('language', $conf->get('translation.language'));
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();
1129 // Linkdate is kept here to:
1130 // - use the same permalink for notes as they're displayed when creating them
1131 // - let users hack creation date of their posts
1132 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1133 $linkdate = escape($_POST['lf_linkdate']);
1134 if (isset($LINKSDB[$id])) {
1136 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1137 $updated = new DateTime();
1138 $shortUrl = $LINKSDB[$id]['shorturl'];
1142 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1144 $shortUrl = link_small_hash($created, $id);
1148 // Remove multiple spaces.
1149 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1150 // Remove first '-' char in tags.
1151 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1152 // Remove duplicates.
1153 $tags = implode(' ', array_unique(explode(' ', $tags)));
1155 if (empty(trim($_POST['lf_url
']))) {
1156 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1158 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1162 'title
' => trim($_POST['lf_title
']),
1164 'description
' => $_POST['lf_description
'],
1165 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1166 'created
' => $created,
1167 'updated
' => $updated,
1168 'tags
' => str_replace(',', ' ', $tags),
1169 'shorturl
' => $shortUrl,
1172 // If title is empty, use the URL as title.
1173 if ($link['title
'] == '') {
1174 $link['title
'] = $link['url
'];
1177 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE) {
1178 $thumbnailer = new Thumbnailer($conf);
1179 $link['thumbnail
'] = $thumbnailer->get($url);
1182 $link['sticky
'] = isset($link['sticky
']) ? $link['sticky
'] : false;
1184 $pluginManager->executeHooks('save_link
', $link);
1186 $LINKSDB[$id] = $link;
1187 $LINKSDB->save($conf->get('resource.page_cache
'));
1189 $history->addLink($link);
1191 $history->updateLink($link);
1194 // If we are called from the bookmarklet, we must close the popup:
1195 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1196 echo '<script
>self
.close();</script
>';
1200 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1201 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1202 // Scroll to the link which has been edited.
1203 $location .= '#' . $link['shorturl'];
1204 // After saving the link, redirect to the page the user was on.
1205 header('Location: '. $location);
1209 // -------- User clicked the "Cancel" button when editing a link.
1210 if (isset($_POST['cancel_edit'])) {
1211 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1212 if (! isset($LINKSDB[$id])) {
1213 header('Location: ?');
1215 // If we are called from the bookmarklet, we must close the popup:
1216 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1217 echo '<script>self.close();</script>';
1220 $link = $LINKSDB[$id];
1221 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1222 // Scroll to the link which has been edited.
1223 $returnurl .= '#'. $link['shorturl'];
1224 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1225 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1229 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1230 if ($targetPage == Router
::$PAGE_DELETELINK) {
1231 if (! $sessionManager->checkToken($_GET['token'])) {
1232 die(t('Wrong token.'));
1235 $ids = trim($_GET['lf_linkdate']);
1236 if (strpos($ids, ' ') !== false) {
1237 // multiple, space-separated ids provided
1238 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1240 // only a single id provided
1243 // assert at least one id is given
1245 die('no id provided');
1247 foreach ($ids as $id) {
1248 $id = (int) escape($id);
1249 $link = $LINKSDB[$id];
1250 $pluginManager->executeHooks('delete_link', $link);
1251 $history->deleteLink($link);
1252 unset($LINKSDB[$id]);
1254 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1256 // If we are called from the bookmarklet, we must close the popup:
1257 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1258 echo '<script>self.close();</script>';
1263 if (isset($_SERVER['HTTP_REFERER'])) {
1264 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1265 $location = generateLocation(
1266 $_SERVER['HTTP_REFERER'],
1267 $_SERVER['HTTP_HOST'],
1268 ['delete_link', 'edit_link', $link['shorturl']]
1272 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1276 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1277 if (isset($_GET['edit_link'])) {
1278 $id = (int) escape($_GET['edit_link']);
1279 $link = $LINKSDB[$id]; // Read database
1281 header('Location: ?');
1283 } // Link not found in database.
1284 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1287 'link_is_new' => false,
1288 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1289 'tags' => $LINKSDB->linksCountPerTag(),
1291 $pluginManager->executeHooks('render_editlink', $data);
1293 foreach ($data as $key => $value) {
1294 $PAGE->assign($key, $value);
1297 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1298 $PAGE->renderPage('editlink');
1302 // -------- User want to post a new link: Display link edit form.
1303 if (isset($_GET['post'])) {
1304 $url = cleanup_url($_GET['post']);
1306 $link_is_new = false;
1307 // Check if URL is not already in database (in this case, we will edit the existing link)
1308 $link = $LINKSDB->getLinkFromUrl($url);
1310 $link_is_new = true;
1311 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1312 // Get title if it was provided in URL (by the bookmarklet).
1313 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1314 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1315 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1316 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1317 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1319 // If this is an HTTP(S) link, we try go get the page to extract
1320 // the title (otherwise we will to straight to the edit form.)
1321 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1322 // Short timeout to keep the application responsive
1323 // The callback will fill $charset and $title with data from the downloaded page.
1326 $conf->get('general.download_timeout', 30),
1327 $conf->get('general.download_max_size', 4194304),
1328 get_curl_download_callback($charset, $title)
1330 if (! empty($title) && strtolower($charset) != 'utf-8') {
1331 $title = mb_convert_encoding($title, 'utf-8', $charset);
1336 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1337 $title = $conf->get('general.default_note_title', t('Note: '));
1339 $url = escape($url);
1340 $title = escape($title);
1343 'linkdate' => $linkdate,
1346 'description' => $description,
1348 'private' => $private,
1351 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1356 'link_is_new' => $link_is_new,
1357 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1358 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1359 'tags' => $LINKSDB->linksCountPerTag(),
1360 'default_private_links' => $conf->get('privacy.default_private_links', false),
1362 $pluginManager->executeHooks('render_editlink', $data);
1364 foreach ($data as $key => $value) {
1365 $PAGE->assign($key, $value);
1368 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1369 $PAGE->renderPage('editlink');
1373 if ($targetPage == Router
::$PAGE_PINLINK) {
1374 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1375 // FIXME! Use a proper error system.
1376 $msg = t('Invalid link ID provided');
1377 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1380 if (! $sessionManager->checkToken($_GET['token'])) {
1381 die('Wrong token.');
1384 $link = $LINKSDB[$_GET['id']];
1385 $link['sticky'] = ! $link['sticky'];
1386 $LINKSDB[(int) $_GET['id']] = $link;
1387 $LINKSDB->save($conf->get('resource.page_cache'));
1388 header('Location: '.index_url($_SERVER));
1392 if ($targetPage == Router
::$PAGE_EXPORT) {
1393 // Export links as a Netscape Bookmarks file
1395 if (empty($_GET['selection'])) {
1396 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1397 $PAGE->renderPage('export');
1401 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1402 $selection = $_GET['selection'];
1403 if (isset($_GET['prepend_note_url'])) {
1404 $prependNoteUrl = $_GET['prepend_note_url'];
1406 $prependNoteUrl = false;
1412 NetscapeBookmarkUtils
::filterAndFormat(
1419 } catch (Exception
$exc) {
1420 header('Content-Type: text/plain; charset=utf-8');
1421 echo $exc->getMessage();
1424 $now = new DateTime();
1425 header('Content-Type: text/html; charset=utf-8');
1427 'Content-disposition: attachment; filename=bookmarks_'
1428 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1430 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1431 $PAGE->assign('eol', PHP_EOL
);
1432 $PAGE->assign('selection', $selection);
1433 $PAGE->renderPage('export.bookmarks');
1437 if ($targetPage == Router
::$PAGE_IMPORT) {
1438 // Upload a Netscape bookmark dump to import its contents
1440 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1441 // Show import dialog
1444 get_max_upload_size(
1445 ini_get('post_max_size'),
1446 ini_get('upload_max_filesize'),
1452 get_max_upload_size(
1453 ini_get('post_max_size'),
1454 ini_get('upload_max_filesize'),
1458 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1459 $PAGE->renderPage('import');
1463 // Import bookmarks from an uploaded file
1464 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1465 // The file is too big or some form field may be missing.
1468 'The file you are trying to upload is probably bigger than what this webserver can accept'
1469 .' (%s). Please upload in smaller chunks.'
1471 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1473 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1476 if (! $sessionManager->checkToken($_POST['token'])) {
1477 die('Wrong token.');
1479 $status = NetscapeBookmarkUtils
::import(
1486 echo '<script>alert("'.$status.'");document.location=\'?do='
1487 .Router
::$PAGE_IMPORT .'\';</script>';
1491 // Plugin administration page
1492 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1493 $pluginMeta = $pluginManager->getPluginsMeta();
1495 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1496 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1497 return $v['order'] !== false;
1500 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1504 return $a['order'] - $b['order'];
1507 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1508 return $v['order'] === false;
1511 $PAGE->assign('enabledPlugins', $enabledPlugins);
1512 $PAGE->assign('disabledPlugins', $disabledPlugins);
1513 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1514 $PAGE->renderPage('pluginsadmin');
1518 // Plugin administration form action
1519 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1521 if (isset($_POST['parameters_form'])) {
1522 unset($_POST['parameters_form']);
1523 foreach ($_POST as $param => $value) {
1524 $conf->set('plugins.'. $param, escape($value));
1527 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1529 $conf->write($loginManager->isLoggedIn());
1530 $history->updateSettings();
1531 } catch (Exception
$e) {
1533 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1537 // TODO: do not handle exceptions/errors in JS.
1538 echo '<script>alert("'
1540 .'");document.location=\'?do='
1541 . Router
::$PAGE_PLUGINSADMIN
1545 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1549 // Get a fresh token
1550 if ($targetPage == Router
::$GET_TOKEN) {
1551 header('Content-Type:text/plain');
1552 echo $sessionManager->generateToken($conf);
1556 // -------- Thumbnails Update
1557 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1559 foreach ($LINKSDB as $link) {
1560 // A note or not HTTP(S)
1561 if ($link['url'][0] === '?' || ! startsWith(strtolower($link['url']), 'http')) {
1564 $ids[] = $link['id'];
1566 $PAGE->assign('ids', $ids);
1567 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1568 $PAGE->renderPage('thumbnails');
1572 // -------- Single Thumbnail Update
1573 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1574 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1575 http_response_code(400);
1578 $id = (int) $_POST['id'];
1579 if (empty($LINKSDB[$id])) {
1580 http_response_code(404);
1583 $thumbnailer = new Thumbnailer($conf);
1584 $link = $LINKSDB[$id];
1585 $link['thumbnail'] = $thumbnailer->get($link['url']);
1586 $LINKSDB[$id] = $link;
1587 $LINKSDB->save($conf->get('resource.page_cache'));
1589 echo json_encode($link);
1593 // -------- Otherwise, simply display search form and links:
1594 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1599 * Template for the list of links (<div id="linklist">)
1600 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1602 * @param pageBuilder $PAGE pageBuilder instance.
1603 * @param LinkDB $LINKSDB LinkDB instance.
1604 * @param ConfigManager $conf Configuration Manager instance.
1605 * @param PluginManager $pluginManager Plugin Manager instance.
1606 * @param LoginManager $loginManager LoginManager instance
1608 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1610 // Used in templates
1611 if (isset($_GET['searchtags'])) {
1612 if (! empty($_GET['searchtags'])) {
1613 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1615 $searchtags = false;
1620 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1623 if (! empty($_SERVER['QUERY_STRING'])
1624 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1626 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1627 } catch (LinkNotFoundException
$e) {
1628 $PAGE->render404($e->getMessage());
1632 // Filter links according search parameters.
1633 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1635 'searchtags' => $searchtags,
1636 'searchterm' => $searchterm,
1638 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1641 // ---- Handle paging.
1643 foreach ($linksToDisplay as $key => $value) {
1647 // Select articles according to paging.
1648 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1649 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1650 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1651 $page = $page < 1 ? 1 : $page;
1652 $page = $page > $pagecount ? $pagecount : $page;
1654 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1655 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1657 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1658 if ($thumbnailsEnabled) {
1659 $thumbnailer = new Thumbnailer($conf);
1662 $linkDisp = array();
1663 while ($i<$end && $i<count($keys)) {
1664 $link = $linksToDisplay[$keys[$i]];
1665 $link['description'] = format_description(
1666 $link['description'],
1667 $conf->get('redirector.url'),
1668 $conf->get('redirector.encode_url')
1670 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1671 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1672 $link['timestamp'] = $link['created']->getTimestamp();
1673 if (! empty($link['updated'])) {
1674 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1676 $link['updated_timestamp'] = '';
1678 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1679 uasort($taglist, 'strcasecmp');
1680 $link['taglist'] = $taglist;
1682 // Logged in, thumbnails enabled, not a note,
1683 // and (never retrieved yet or no valid cache file)
1684 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1685 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1687 $elem = $LINKSDB[$keys[$i]];
1688 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1689 $LINKSDB[$keys[$i]] = $elem;
1691 $link['thumbnail'] = $elem['thumbnail'];
1694 // Check for both signs of a note: starting with ? and 7 chars long.
1695 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1696 $link['url'] = index_url($_SERVER) . $link['url'];
1699 $linkDisp[$keys[$i]] = $link;
1703 // If we retrieved new thumbnails, we update the database.
1704 if (!empty($updateDB)) {
1705 $LINKSDB->save($conf->get('resource.page_cache'));
1708 // Compute paging navigation
1709 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1710 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1711 $previous_page_url = '';
1712 if ($i != count($keys)) {
1713 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1717 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1720 // Fill all template fields.
1722 'previous_page_url' => $previous_page_url,
1723 'next_page_url' => $next_page_url,
1724 'page_current' => $page,
1725 'page_max' => $pagecount,
1726 'result_count' => count($linksToDisplay),
1727 'search_term' => $searchterm,
1728 'search_tags' => $searchtags,
1729 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1730 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1731 'links' => $linkDisp,
1734 // If there is only a single link, we change on-the-fly the title of the page.
1735 if (count($linksToDisplay) == 1) {
1736 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1737 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1738 $data['pagetitle'] = t('Search: ');
1739 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1740 $bracketWrap = function ($tag) {
1741 return '['. $tag .']';
1743 $data['pagetitle'] .= ! empty($searchtags)
1744 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1746 $data['pagetitle'] .= '- '. $conf->get('general.title');
1749 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1751 foreach ($data as $key => $value) {
1752 $PAGE->assign($key, $value);
1760 * This function should NEVER be called if the file data/config.php exists.
1762 * @param ConfigManager $conf Configuration Manager instance.
1763 * @param SessionManager $sessionManager SessionManager instance
1764 * @param LoginManager $loginManager LoginManager instance
1766 function install($conf, $sessionManager, $loginManager)
1768 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1769 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1770 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1774 // This part makes sure sessions works correctly.
1775 // (Because on some hosts, session.save_path may not be set correctly,
1776 // or we may not have write access to it.)
1777 if (isset($_GET['test_session'])
1778 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1779 // Step 2: Check if data in session is correct.
1781 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1782 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1783 'and that you have write access to it.<br>'.
1784 'It currently points to %s.<br>'.
1785 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1786 'or any custom hostname without a dot causes cookie storage to fail. '.
1787 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1789 $msg = sprintf($msg, session_save_path());
1791 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1794 if (!isset($_SESSION['session_tested'])) {
1795 // Step 1 : Try to store data in session and reload page.
1796 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1797 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1799 if (isset($_GET['test_session'])) {
1800 // Step 3: Sessions are OK. Remove test parameter from URL.
1801 header('Location: '.index_url($_SERVER));
1805 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1807 if (!empty($_POST['continent']) && !empty($_POST['city'])
1808 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1810 $tz = $_POST['continent'].'/'.$_POST['city'];
1812 $conf->set('general.timezone', $tz);
1813 $login = $_POST['setlogin'];
1814 $conf->set('credentials.login', $login);
1815 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1816 $conf->set('credentials.salt', $salt);
1817 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1818 if (!empty($_POST['title'])) {
1819 $conf->set('general.title', escape($_POST['title']));
1821 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1823 $conf->set('translation.language', escape($_POST['language']));
1824 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1825 $conf->set('api.enabled', !empty($_POST['enableApi']));
1828 generate_api_secret(
1829 $conf->get('credentials.login'),
1830 $conf->get('credentials.salt')
1834 // Everything is ok, let's create config file.
1835 $conf->write($loginManager->isLoggedIn());
1836 } catch (Exception
$e) {
1838 'ERROR while writing config file after installation.' . PHP_EOL
.
1842 // TODO: do not handle exceptions/errors in JS.
1843 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1846 echo '<script>alert('
1847 .'"Shaarli is now configured. '
1848 .'Please enter your login/password and start shaaring your links!"'
1849 .');document.location=\'?do=login\';</script>';
1853 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1854 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1855 $PAGE->assign('continents', $continents);
1856 $PAGE->assign('cities', $cities);
1857 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1858 $PAGE->renderPage('install');
1862 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1863 showDailyRSS($conf, $loginManager);
1867 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1868 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1872 $history = new History($conf->get('resource.history'));
1873 } catch (Exception
$e) {
1874 die($e->getMessage());
1877 $linkDb = new LinkDB(
1878 $conf->get('resource.datastore'),
1879 $loginManager->isLoggedIn(),
1880 $conf->get('privacy.hide_public_links'),
1881 $conf->get('redirector.url'),
1882 $conf->get('redirector.encode_url')
1885 $container = new \Slim\
Container();
1886 $container['conf'] = $conf;
1887 $container['plugins'] = $pluginManager;
1888 $container['history'] = $history;
1889 $app = new \Slim\
App($container);
1892 $app->group('/api/v1', function () {
1893 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1894 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1895 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1896 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1897 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1898 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1900 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1901 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1902 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1903 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1905 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1906 })->add('\Shaarli\Api\ApiMiddleware');
1908 $response = $app->run(true);
1910 // Hack to make Slim and Shaarli router work together:
1911 // If a Slim route isn't found and NOT API call, we call renderPage().
1912 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1913 // We use UTF-8 for proper international characters handling.
1914 header('Content-Type: text/html; charset=utf-8');
1915 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1917 $response = $response
1918 ->withHeader('Access-Control-Allow-Origin', '*')
1920 'Access-Control-Allow-Headers',
1921 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1923 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1924 $app->respond($response);