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 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
810 header('Location: ?'.http_build_query($params));
814 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
815 if (isset($_GET['removetag'])) {
816 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
817 if (empty($_SERVER['HTTP_REFERER'])) {
818 header('Location: ?');
822 // In case browser does not send HTTP_REFERER
823 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
825 // Prevent redirection loop
826 if (isset($params['removetag'])) {
827 unset($params['removetag']);
830 if (isset($params['searchtags'])) {
831 $tags = explode(' ', $params['searchtags']);
832 // Remove value from array $tags.
833 $tags = array_diff($tags, array($_GET['removetag']));
834 $params['searchtags'] = implode(' ', $tags);
836 if (empty($params['searchtags'])) {
837 unset($params['searchtags']);
840 unset($params['page']); // We also remove page (keeping the same page has no sense, since the results are different)
842 header('Location: ?'.http_build_query($params));
846 // -------- User wants to change the number of links per page (linksperpage=...)
847 if (isset($_GET['linksperpage'])) {
848 if (is_numeric($_GET['linksperpage'])) {
849 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
852 if (! empty($_SERVER['HTTP_REFERER'])) {
853 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
857 header('Location: '. $location);
861 // -------- User wants to see only private links (toggle)
862 if (isset($_GET['visibility'])) {
863 if ($_GET['visibility'] === 'private') {
864 // Visibility not set or not already private, set private, otherwise reset it
865 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
866 // See only private links
867 $_SESSION['visibility'] = 'private';
869 unset($_SESSION['visibility']);
871 } elseif ($_GET['visibility'] === 'public') {
872 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
873 // See only public links
874 $_SESSION['visibility'] = 'public';
876 unset($_SESSION['visibility']);
880 if (! empty($_SERVER['HTTP_REFERER'])) {
881 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
885 header('Location: '. $location);
889 // -------- User wants to see only untagged links (toggle)
890 if (isset($_GET['untaggedonly'])) {
891 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
893 if (! empty($_SERVER['HTTP_REFERER'])) {
894 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
898 header('Location: '. $location);
902 // -------- Handle other actions allowed for non-logged in users:
903 if (!$loginManager->isLoggedIn()) {
904 // User tries to post new link but is not logged in:
905 // Show login screen, then redirect to ?post=...
906 if (isset($_GET['post'])) {
907 header( // Redirect to login page, then back to post link.
908 'Location: ?do=login&post='.urlencode($_GET['post']).
909 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
910 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
911 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
912 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
917 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
918 if (isset($_GET['edit_link'])) {
919 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
923 exit; // Never remove this one! All operations below are reserved for logged in user.
926 // -------- All other functions are reserved for the registered user:
928 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
929 if ($targetPage == Router
::$PAGE_TOOLS) {
931 'pageabsaddr' => index_url($_SERVER),
932 'sslenabled' => is_https($_SERVER),
934 $pluginManager->executeHooks('render_tools', $data);
936 foreach ($data as $key => $value) {
937 $PAGE->assign($key, $value);
940 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
941 $PAGE->renderPage('tools');
945 // -------- User wants to change his/her password.
946 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
947 if ($conf->get('security.open_shaarli')) {
948 die(t('You are not supposed to change a password on an Open Shaarli.'));
951 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
952 if (!$sessionManager->checkToken($_POST['token'])) {
953 die(t('Wrong token.')); // Go away!
956 // Make sure old password is correct.
957 $oldhash = sha1($_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt'));
958 if ($oldhash!= $conf->get('credentials.hash')) {
959 echo '<script>alert("'. t('The old password is not correct.') .'");document.location=\'?do=changepasswd\';</script>';
963 // Salt renders rainbow-tables attacks useless.
964 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
965 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $conf->get('credentials.login') . $conf->get('credentials.salt')));
967 $conf->write($loginManager->isLoggedIn());
968 } catch (Exception
$e) {
970 'ERROR while writing config file after changing password.' . PHP_EOL
.
974 // TODO: do not handle exceptions/errors in JS.
975 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
978 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
981 // show the change password form.
982 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
983 $PAGE->renderPage('changepassword');
988 // -------- User wants to change configuration
989 if ($targetPage == Router
::$PAGE_CONFIGURE) {
990 if (!empty($_POST['title'])) {
991 if (!$sessionManager->checkToken($_POST['token'])) {
992 die(t('Wrong token.')); // Go away!
995 if (!empty($_POST['continent']) && !empty($_POST['city'])
996 && isTimeZoneValid($_POST['continent'], $_POST['city'])
998 $tz = $_POST['continent'] . '/' . $_POST['city'];
1000 $conf->set('general.timezone', $tz);
1001 $conf->set('general.title', escape($_POST['title']));
1002 $conf->set('general.header_link', escape($_POST['titleLink']));
1003 $conf->set('resource.theme', escape($_POST['theme']));
1004 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1005 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1006 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1007 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1008 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1009 $conf->set('api.enabled', !empty($_POST['enableApi']));
1010 $conf->set('api.secret', escape($_POST['apiSecret']));
1011 $conf->set('translation.language', escape($_POST['language']));
1013 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1014 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1015 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1017 $_SESSION['warnings'][] = t(
1018 'You have enabled or changed thumbnails mode. <a href="?do=thumbs_update">Please synchronize them</a>.'
1021 $conf->set('thumbnails.mode', $thumbnailsMode);
1024 $conf->write($loginManager->isLoggedIn());
1025 $history->updateSettings();
1026 invalidateCaches($conf->get('resource.page_cache'));
1027 } catch (Exception
$e) {
1029 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1033 // TODO: do not handle exceptions/errors in JS.
1034 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1037 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1040 // Show the configuration form.
1041 $PAGE->assign('title', $conf->get('general.title'));
1042 $PAGE->assign('theme', $conf->get('resource.theme'));
1043 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1044 list($continents, $cities) = generateTimeZoneData(
1045 timezone_identifiers_list(),
1046 $conf->get('general.timezone')
1048 $PAGE->assign('continents', $continents);
1049 $PAGE->assign('cities', $cities);
1050 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1051 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1052 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1053 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1054 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1055 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1056 $PAGE->assign('api_secret', $conf->get('api.secret'));
1057 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1058 $PAGE->assign('language', $conf->get('translation.language'));
1059 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1060 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1061 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1062 $PAGE->renderPage('configure');
1067 // -------- User wants to rename a tag or delete it
1068 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1069 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1070 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1071 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1072 $PAGE->renderPage('changetag');
1076 if (!$sessionManager->checkToken($_POST['token'])) {
1077 die(t('Wrong token.'));
1080 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1081 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), $toTag);
1082 $LINKSDB->save($conf->get('resource.page_cache'));
1083 foreach ($alteredLinks as $link) {
1084 $history->updateLink($link);
1086 $delete = empty($_POST['totag']);
1087 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1088 $count = count($alteredLinks);
1090 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1091 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1092 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1096 // -------- User wants to add a link without using the bookmarklet: Show form.
1097 if ($targetPage == Router
::$PAGE_ADDLINK) {
1098 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1099 $PAGE->renderPage('addlink');
1103 // -------- User clicked the "Save" button when editing a link: Save link to database.
1104 if (isset($_POST['save_edit'])) {
1106 if (! $sessionManager->checkToken($_POST['token'])) {
1107 die(t('Wrong token.'));
1110 // lf_id should only be present if the link exists.
1111 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1112 // Linkdate is kept here to:
1113 // - use the same permalink for notes as they're displayed when creating them
1114 // - let users hack creation date of their posts
1115 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1116 $linkdate = escape($_POST['lf_linkdate']);
1117 if (isset($LINKSDB[$id])) {
1119 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1120 $updated = new DateTime();
1121 $shortUrl = $LINKSDB[$id]['shorturl'];
1125 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1127 $shortUrl = link_small_hash($created, $id);
1131 // Remove multiple spaces.
1132 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1133 // Remove first '-' char in tags.
1134 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1135 // Remove duplicates.
1136 $tags = implode(' ', array_unique(explode(' ', $tags)));
1138 if (empty(trim($_POST['lf_url
']))) {
1139 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1141 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1145 'title
' => trim($_POST['lf_title
']),
1147 'description
' => $_POST['lf_description
'],
1148 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1149 'created
' => $created,
1150 'updated
' => $updated,
1151 'tags
' => str_replace(',', ' ', $tags),
1152 'shorturl
' => $shortUrl,
1155 // If title is empty, use the URL as title.
1156 if ($link['title
'] == '') {
1157 $link['title
'] = $link['url
'];
1160 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE) {
1161 $thumbnailer = new Thumbnailer($conf);
1162 $link['thumbnail
'] = $thumbnailer->get($url);
1165 $pluginManager->executeHooks('save_link
', $link);
1167 $LINKSDB[$id] = $link;
1168 $LINKSDB->save($conf->get('resource.page_cache
'));
1170 $history->addLink($link);
1172 $history->updateLink($link);
1175 // If we are called from the bookmarklet, we must close the popup:
1176 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1177 echo '<script
>self
.close();</script
>';
1181 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1182 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1183 // Scroll to the link which has been edited.
1184 $location .= '#' . $link['shorturl'];
1185 // After saving the link, redirect to the page the user was on.
1186 header('Location: '. $location);
1190 // -------- User clicked the "Cancel" button when editing a link.
1191 if (isset($_POST['cancel_edit'])) {
1192 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1193 if (! isset($LINKSDB[$id])) {
1194 header('Location: ?');
1196 // If we are called from the bookmarklet, we must close the popup:
1197 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1198 echo '<script>self.close();</script>';
1201 $link = $LINKSDB[$id];
1202 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1203 // Scroll to the link which has been edited.
1204 $returnurl .= '#'. $link['shorturl'];
1205 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1206 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1210 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1211 if ($targetPage == Router
::$PAGE_DELETELINK) {
1212 if (! $sessionManager->checkToken($_GET['token'])) {
1213 die(t('Wrong token.'));
1216 $ids = trim($_GET['lf_linkdate']);
1217 if (strpos($ids, ' ') !== false) {
1218 // multiple, space-separated ids provided
1219 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1221 // only a single id provided
1224 // assert at least one id is given
1226 die('no id provided');
1228 foreach ($ids as $id) {
1229 $id = (int) escape($id);
1230 $link = $LINKSDB[$id];
1231 $pluginManager->executeHooks('delete_link', $link);
1232 $history->deleteLink($link);
1233 unset($LINKSDB[$id]);
1235 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1237 // If we are called from the bookmarklet, we must close the popup:
1238 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1239 echo '<script>self.close();</script>';
1244 if (isset($_SERVER['HTTP_REFERER'])) {
1245 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1246 $location = generateLocation(
1247 $_SERVER['HTTP_REFERER'],
1248 $_SERVER['HTTP_HOST'],
1249 ['delete_link', 'edit_link', $link['shorturl']]
1253 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1257 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1258 if (isset($_GET['edit_link'])) {
1259 $id = (int) escape($_GET['edit_link']);
1260 $link = $LINKSDB[$id]; // Read database
1262 header('Location: ?');
1264 } // Link not found in database.
1265 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1268 'link_is_new' => false,
1269 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1270 'tags' => $LINKSDB->linksCountPerTag(),
1272 $pluginManager->executeHooks('render_editlink', $data);
1274 foreach ($data as $key => $value) {
1275 $PAGE->assign($key, $value);
1278 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1279 $PAGE->renderPage('editlink');
1283 // -------- User want to post a new link: Display link edit form.
1284 if (isset($_GET['post'])) {
1285 $url = cleanup_url($_GET['post']);
1287 $link_is_new = false;
1288 // Check if URL is not already in database (in this case, we will edit the existing link)
1289 $link = $LINKSDB->getLinkFromUrl($url);
1291 $link_is_new = true;
1292 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1293 // Get title if it was provided in URL (by the bookmarklet).
1294 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1295 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1296 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1297 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1298 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1299 // If this is an HTTP(S) link, we try go get the page to extract the title (otherwise we will to straight to the edit form.)
1300 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1301 // Short timeout to keep the application responsive
1302 // The callback will fill $charset and $title with data from the downloaded page.
1305 $conf->get('general.download_timeout', 30),
1306 $conf->get('general.download_max_size', 4194304),
1307 get_curl_download_callback($charset, $title)
1309 if (! empty($title) && strtolower($charset) != 'utf-8') {
1310 $title = mb_convert_encoding($title, 'utf-8', $charset);
1315 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1316 $title = $conf->get('general.default_note_title', t('Note: '));
1318 $url = escape($url);
1319 $title = escape($title);
1322 'linkdate' => $linkdate,
1325 'description' => $description,
1327 'private' => $private,
1330 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1335 'link_is_new' => $link_is_new,
1336 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1337 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1338 'tags' => $LINKSDB->linksCountPerTag(),
1339 'default_private_links' => $conf->get('privacy.default_private_links', false),
1341 $pluginManager->executeHooks('render_editlink', $data);
1343 foreach ($data as $key => $value) {
1344 $PAGE->assign($key, $value);
1347 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1348 $PAGE->renderPage('editlink');
1352 if ($targetPage == Router
::$PAGE_PINLINK) {
1353 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1354 // FIXME! Use a proper error system.
1355 $msg = t('Invalid link ID provided');
1356 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1359 if (! $sessionManager->checkToken($_GET['token'])) {
1360 die('Wrong token.');
1363 $link = $LINKSDB[$_GET['id']];
1364 $link['sticky'] = ! $link['sticky'];
1365 $LINKSDB[(int) $_GET['id']] = $link;
1366 $LINKSDB->save($conf->get('resource.page_cache'));
1367 header('Location: '.index_url($_SERVER));
1371 if ($targetPage == Router
::$PAGE_EXPORT) {
1372 // Export links as a Netscape Bookmarks file
1374 if (empty($_GET['selection'])) {
1375 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1376 $PAGE->renderPage('export');
1380 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1381 $selection = $_GET['selection'];
1382 if (isset($_GET['prepend_note_url'])) {
1383 $prependNoteUrl = $_GET['prepend_note_url'];
1385 $prependNoteUrl = false;
1391 NetscapeBookmarkUtils
::filterAndFormat(
1398 } catch (Exception
$exc) {
1399 header('Content-Type: text/plain; charset=utf-8');
1400 echo $exc->getMessage();
1403 $now = new DateTime();
1404 header('Content-Type: text/html; charset=utf-8');
1406 'Content-disposition: attachment; filename=bookmarks_'
1407 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1409 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1410 $PAGE->assign('eol', PHP_EOL
);
1411 $PAGE->assign('selection', $selection);
1412 $PAGE->renderPage('export.bookmarks');
1416 if ($targetPage == Router
::$PAGE_IMPORT) {
1417 // Upload a Netscape bookmark dump to import its contents
1419 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1420 // Show import dialog
1423 get_max_upload_size(
1424 ini_get('post_max_size'),
1425 ini_get('upload_max_filesize'),
1431 get_max_upload_size(
1432 ini_get('post_max_size'),
1433 ini_get('upload_max_filesize'),
1437 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1438 $PAGE->renderPage('import');
1442 // Import bookmarks from an uploaded file
1443 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1444 // The file is too big or some form field may be missing.
1447 'The file you are trying to upload is probably bigger than what this webserver can accept'
1448 .' (%s). Please upload in smaller chunks.'
1450 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1452 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1455 if (! $sessionManager->checkToken($_POST['token'])) {
1456 die('Wrong token.');
1458 $status = NetscapeBookmarkUtils
::import(
1465 echo '<script>alert("'.$status.'");document.location=\'?do='
1466 .Router
::$PAGE_IMPORT .'\';</script>';
1470 // Plugin administration page
1471 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1472 $pluginMeta = $pluginManager->getPluginsMeta();
1474 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1475 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1476 return $v['order'] !== false;
1479 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1483 return $a['order'] - $b['order'];
1486 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1487 return $v['order'] === false;
1490 $PAGE->assign('enabledPlugins', $enabledPlugins);
1491 $PAGE->assign('disabledPlugins', $disabledPlugins);
1492 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1493 $PAGE->renderPage('pluginsadmin');
1497 // Plugin administration form action
1498 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1500 if (isset($_POST['parameters_form'])) {
1501 unset($_POST['parameters_form']);
1502 foreach ($_POST as $param => $value) {
1503 $conf->set('plugins.'. $param, escape($value));
1506 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1508 $conf->write($loginManager->isLoggedIn());
1509 $history->updateSettings();
1510 } catch (Exception
$e) {
1512 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1516 // TODO: do not handle exceptions/errors in JS.
1517 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do='. Router
::$PAGE_PLUGINSADMIN .'\';</script>';
1520 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1524 // Get a fresh token
1525 if ($targetPage == Router
::$GET_TOKEN) {
1526 header('Content-Type:text/plain');
1527 echo $sessionManager->generateToken($conf);
1531 // -------- Thumbnails Update
1532 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1534 foreach ($LINKSDB as $link) {
1535 // A note or not HTTP(S)
1536 if ($link['url'][0] === '?' || ! startsWith(strtolower($link['url']), 'http')) {
1539 $ids[] = $link['id'];
1541 $PAGE->assign('ids', $ids);
1542 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1543 $PAGE->renderPage('thumbnails');
1547 // -------- Single Thumbnail Update
1548 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1549 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1550 http_response_code(400);
1553 $id = (int) $_POST['id'];
1554 if (empty($LINKSDB[$id])) {
1555 http_response_code(404);
1558 $thumbnailer = new Thumbnailer($conf);
1559 $link = $LINKSDB[$id];
1560 $link['thumbnail'] = $thumbnailer->get($link['url']);
1561 $LINKSDB[$id] = $link;
1562 $LINKSDB->save($conf->get('resource.page_cache'));
1564 echo json_encode($link);
1568 // -------- Otherwise, simply display search form and links:
1569 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1574 * Template for the list of links (<div id="linklist">)
1575 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1577 * @param pageBuilder $PAGE pageBuilder instance.
1578 * @param LinkDB $LINKSDB LinkDB instance.
1579 * @param ConfigManager $conf Configuration Manager instance.
1580 * @param PluginManager $pluginManager Plugin Manager instance.
1581 * @param LoginManager $loginManager LoginManager instance
1583 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1585 // Used in templates
1586 if (isset($_GET['searchtags'])) {
1587 if (! empty($_GET['searchtags'])) {
1588 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1590 $searchtags = false;
1595 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1598 if (! empty($_SERVER['QUERY_STRING'])
1599 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1601 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1602 } catch (LinkNotFoundException
$e) {
1603 $PAGE->render404($e->getMessage());
1607 // Filter links according search parameters.
1608 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1610 'searchtags' => $searchtags,
1611 'searchterm' => $searchterm,
1613 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1616 // ---- Handle paging.
1618 foreach ($linksToDisplay as $key => $value) {
1622 // Select articles according to paging.
1623 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1624 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1625 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1626 $page = $page < 1 ? 1 : $page;
1627 $page = $page > $pagecount ? $pagecount : $page;
1629 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1630 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1632 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1633 if ($thumbnailsEnabled) {
1634 $thumbnailer = new Thumbnailer($conf);
1637 $linkDisp = array();
1638 while ($i<$end && $i<count($keys)) {
1639 $link = $linksToDisplay[$keys[$i]];
1640 $link['description'] = format_description(
1641 $link['description'],
1642 $conf->get('redirector.url'),
1643 $conf->get('redirector.encode_url')
1645 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1646 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1647 $link['timestamp'] = $link['created']->getTimestamp();
1648 if (! empty($link['updated'])) {
1649 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1651 $link['updated_timestamp'] = '';
1653 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1654 uasort($taglist, 'strcasecmp');
1655 $link['taglist'] = $taglist;
1657 // Logged in, thumbnails enabled, not a note,
1658 // and (never retrieved yet or no valid cache file)
1659 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1660 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1662 $elem = $LINKSDB[$keys[$i]];
1663 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1664 $LINKSDB[$keys[$i]] = $elem;
1666 $link['thumbnail'] = $elem['thumbnail'];
1669 // Check for both signs of a note: starting with ? and 7 chars long.
1670 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1671 $link['url'] = index_url($_SERVER) . $link['url'];
1674 $linkDisp[$keys[$i]] = $link;
1678 // If we retrieved new thumbnails, we update the database.
1679 if (!empty($updateDB)) {
1680 $LINKSDB->save($conf->get('resource.page_cache'));
1683 // Compute paging navigation
1684 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1685 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1686 $previous_page_url = '';
1687 if ($i != count($keys)) {
1688 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1692 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1695 // Fill all template fields.
1697 'previous_page_url' => $previous_page_url,
1698 'next_page_url' => $next_page_url,
1699 'page_current' => $page,
1700 'page_max' => $pagecount,
1701 'result_count' => count($linksToDisplay),
1702 'search_term' => $searchterm,
1703 'search_tags' => $searchtags,
1704 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1705 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1706 'links' => $linkDisp,
1709 // If there is only a single link, we change on-the-fly the title of the page.
1710 if (count($linksToDisplay) == 1) {
1711 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1712 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1713 $data['pagetitle'] = t('Search: ');
1714 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1715 $bracketWrap = function ($tag) {
1716 return '['. $tag .']';
1718 $data['pagetitle'] .= ! empty($searchtags)
1719 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1721 $data['pagetitle'] .= '- '. $conf->get('general.title');
1724 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1726 foreach ($data as $key => $value) {
1727 $PAGE->assign($key, $value);
1735 * This function should NEVER be called if the file data/config.php exists.
1737 * @param ConfigManager $conf Configuration Manager instance.
1738 * @param SessionManager $sessionManager SessionManager instance
1739 * @param LoginManager $loginManager LoginManager instance
1741 function install($conf, $sessionManager, $loginManager)
1743 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1744 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1745 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1749 // This part makes sure sessions works correctly.
1750 // (Because on some hosts, session.save_path may not be set correctly,
1751 // or we may not have write access to it.)
1752 if (isset($_GET['test_session']) && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1753 // Step 2: Check if data in session is correct.
1755 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1756 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1757 'and that you have write access to it.<br>'.
1758 'It currently points to %s.<br>'.
1759 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1760 'or any custom hostname without a dot causes cookie storage to fail. '.
1761 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1763 $msg = sprintf($msg, session_save_path());
1765 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1768 if (!isset($_SESSION['session_tested'])) {
1769 // Step 1 : Try to store data in session and reload page.
1770 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1771 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1773 if (isset($_GET['test_session'])) {
1774 // Step 3: Sessions are OK. Remove test parameter from URL.
1775 header('Location: '.index_url($_SERVER));
1779 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1781 if (!empty($_POST['continent']) && !empty($_POST['city'])
1782 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1784 $tz = $_POST['continent'].'/'.$_POST['city'];
1786 $conf->set('general.timezone', $tz);
1787 $login = $_POST['setlogin'];
1788 $conf->set('credentials.login', $login);
1789 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1790 $conf->set('credentials.salt', $salt);
1791 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1792 if (!empty($_POST['title'])) {
1793 $conf->set('general.title', escape($_POST['title']));
1795 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1797 $conf->set('translation.language', escape($_POST['language']));
1798 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1799 $conf->set('api.enabled', !empty($_POST['enableApi']));
1802 generate_api_secret(
1803 $conf->get('credentials.login'),
1804 $conf->get('credentials.salt')
1808 // Everything is ok, let's create config file.
1809 $conf->write($loginManager->isLoggedIn());
1810 } catch (Exception
$e) {
1812 'ERROR while writing config file after installation.' . PHP_EOL
.
1816 // TODO: do not handle exceptions/errors in JS.
1817 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1820 echo '<script>alert("Shaarli is now configured. Please enter your login/password and start shaaring your links!");document.location=\'?do=login\';</script>';
1824 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1825 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1826 $PAGE->assign('continents', $continents);
1827 $PAGE->assign('cities', $cities);
1828 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1829 $PAGE->renderPage('install');
1833 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1834 showDailyRSS($conf, $loginManager);
1838 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1839 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1843 $history = new History($conf->get('resource.history'));
1844 } catch (Exception
$e) {
1845 die($e->getMessage());
1848 $linkDb = new LinkDB(
1849 $conf->get('resource.datastore'),
1850 $loginManager->isLoggedIn(),
1851 $conf->get('privacy.hide_public_links'),
1852 $conf->get('redirector.url'),
1853 $conf->get('redirector.encode_url')
1856 $container = new \Slim\
Container();
1857 $container['conf'] = $conf;
1858 $container['plugins'] = $pluginManager;
1859 $container['history'] = $history;
1860 $app = new \Slim\
App($container);
1863 $app->group('/api/v1', function () {
1864 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1865 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1866 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1867 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1868 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1869 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1871 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1872 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1873 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1874 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1876 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1877 })->add('\Shaarli\Api\ApiMiddleware');
1879 $response = $app->run(true);
1881 // Hack to make Slim and Shaarli router work together:
1882 // If a Slim route isn't found and NOT API call, we call renderPage().
1883 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1884 // We use UTF-8 for proper international characters handling.
1885 header('Content-Type: text/html; charset=utf-8');
1886 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1888 $response = $response
1889 ->withHeader('Access-Control-Allow-Origin', '*')
1891 'Access-Control-Allow-Headers',
1892 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1894 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1895 $app->respond($response);