3 * Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
5 * Friendly fork by the Shaarli community:
6 * - https://github.com/shaarli/Shaarli
8 * Original project by sebsauvage.net:
9 * - http://sebsauvage.net/wiki/doku.php?id=php:shaarli
10 * - https://github.com/sebsauvage/Shaarli
12 * Licence: http://www.opensource.org/licenses/zlib-license.php
15 // Set 'UTC' as the default timezone if it is not defined in php.ini
16 // See http://php.net/manual/en/datetime.configuration.php#ini.date.timezone
17 if (date_default_timezone_get() == '') {
18 date_default_timezone_set('UTC');
25 // http://server.com/x/shaarli --> /shaarli/
26 define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+
strrpos($_SERVER['REQUEST_URI'], '/', 0)));
28 // High execution time in case of problematic imports/exports.
29 ini_set('max_input_time', '60');
31 // Try to set max upload file size and read
32 ini_set('memory_limit', '128M');
33 ini_set('post_max_size', '16M');
34 ini_set('upload_max_filesize', '16M');
36 // See all error except warnings
37 error_reporting(E_ALL^E_WARNING
);
38 // See all errors (for debugging only)
39 //error_reporting(-1);
42 // 3rd-party libraries
43 if (! file_exists(__DIR__
. '/vendor/autoload.php')) {
44 header('Content-Type: text/plain; charset=utf-8');
45 echo "Error: missing Composer configuration\n\n"
46 ."If you installed Shaarli through Git or using the development branch,\n"
47 ."please refer to the installation documentation to install PHP"
48 ." dependencies using Composer:\n"
49 ."- https://shaarli.readthedocs.io/en/master/Server-configuration/\n"
50 ."- https://shaarli.readthedocs.io/en/master/Download-and-Installation/";
53 require_once 'inc/rain.tpl.class.php';
54 require_once __DIR__
. '/vendor/autoload.php';
57 require_once 'application/bookmark/LinkUtils.php';
58 require_once 'application/config/ConfigPlugin.php';
59 require_once 'application/feed/Cache.php';
60 require_once 'application/http/HttpUtils.php';
61 require_once 'application/http/UrlUtils.php';
62 require_once 'application/updater/UpdaterUtils.php';
63 require_once 'application/FileUtils.php';
64 require_once 'application/TimeZone.php';
65 require_once 'application/Utils.php';
67 use \Shaarli\ApplicationUtils
;
68 use \Shaarli\Bookmark\Exception\LinkNotFoundException
;
69 use \Shaarli\Bookmark\LinkDB
;
70 use \Shaarli\Config\ConfigManager
;
71 use \Shaarli\Feed\CachedPage
;
72 use \Shaarli\Feed\FeedBuilder
;
74 use \Shaarli\Languages
;
75 use \Shaarli\Netscape\NetscapeBookmarkUtils
;
76 use \Shaarli\Plugin\PluginManager
;
77 use \Shaarli\Render\PageBuilder
;
78 use \Shaarli\Render\ThemeUtils
;
80 use \Shaarli\Security\LoginManager
;
81 use \Shaarli\Security\SessionManager
;
82 use \Shaarli\Thumbnailer
;
83 use \Shaarli\Updater\Updater
;
85 // Ensure the PHP version is supported
87 ApplicationUtils
::checkPHPVersion('7.1', 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($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')
316 /* Some Shaarlies may have very few links, so we need to look
317 back in time until we have enough days ($nb_of_days).
319 $nb_of_days = 7; // We take 7 days.
320 $today = date('Ymd');
323 foreach ($LINKSDB as $link) {
324 $day = $link['created']->format('Ymd'); // Extract day (without time)
325 if (strcmp($day, $today) < 0) {
326 if (empty($days[$day])) {
327 $days[$day] = array();
329 $days[$day][] = $link;
332 if (count($days) > $nb_of_days) {
333 break; // Have we collected enough days?
337 // Build the RSS feed.
338 header('Content-Type: application/rss+xml; charset=utf-8');
339 $pageaddr = escape(index_url($_SERVER));
340 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
342 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
343 echo '<link>'. $pageaddr .'</link>';
344 echo '<description>Daily shared links</description>';
345 echo '<language>en-en</language>';
346 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
349 foreach ($days as $day => $links) {
350 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
351 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
353 // We pre-format some fields for proper output.
354 foreach ($links as &$link) {
355 $link['formatedDescription'] = format_description($link['description']);
356 $link['timestamp'] = $link['created']->getTimestamp();
357 if (is_note($link['url'])) {
358 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
362 // Then build the HTML for this day:
364 $tpl->assign('title', $conf->get('general.title'));
365 $tpl->assign('daydate', $dayDate->getTimestamp());
366 $tpl->assign('absurl', $absurl);
367 $tpl->assign('links', $links);
368 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
369 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
370 $tpl->assign('index_url', $pageaddr);
371 $html = $tpl->draw('dailyrss', true);
373 echo $html . PHP_EOL
;
375 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
377 $cache->cache(ob_get_contents());
383 * Show the 'Daily' page.
385 * @param PageBuilder $pageBuilder Template engine wrapper.
386 * @param LinkDB $LINKSDB LinkDB instance.
387 * @param ConfigManager $conf Configuration Manager instance.
388 * @param PluginManager $pluginManager Plugin Manager instance.
389 * @param LoginManager $loginManager Login Manager instance
391 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager)
393 if (isset($_GET['day'])) {
395 if ($day === date('Ymd', strtotime('now'))) {
396 $pageBuilder->assign('dayDesc', t('Today'));
397 } elseif ($day === date('Ymd', strtotime('-1 days'))) {
398 $pageBuilder->assign('dayDesc', t('Yesterday'));
401 $day = date('Ymd', strtotime('now')); // Today, in format YYYYMMDD.
402 $pageBuilder->assign('dayDesc', t('Today'));
405 $days = $LINKSDB->days();
406 $i = array_search($day, $days);
407 if ($i === false && count($days)) {
408 // no links for day, but at least one day with links
409 $i = count($days) - 1;
417 $previousday=$days[$i - 1];
419 if ($i < count($days) - 1) {
420 $nextday = $days[$i +
1];
424 $linksToDisplay = $LINKSDB->filterDay($day);
425 } catch (Exception
$exc) {
427 $linksToDisplay = array();
430 // We pre-format some fields for proper output.
431 foreach ($linksToDisplay as $key => $link) {
432 $taglist = explode(' ', $link['tags']);
433 uasort($taglist, 'strcasecmp');
434 $linksToDisplay[$key]['taglist']=$taglist;
435 $linksToDisplay[$key]['formatedDescription'] = format_description($link['description']);
436 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
439 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
441 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
442 'linksToDisplay' => $linksToDisplay,
443 'day' => $dayDate->getTimestamp(),
444 'dayDate' => $dayDate,
445 'previousday' => $previousday,
446 'nextday' => $nextday,
449 /* Hook is called before column construction so that plugins don't have
450 to deal with columns. */
451 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
453 /* We need to spread the articles on 3 columns.
454 I did not want to use a JavaScript lib like http://masonry.desandro.com/
455 so I manually spread entries with a simple method: I roughly evaluate the
456 height of a div according to title and description length.
458 $columns = array(array(), array(), array()); // Entries to display, for each column.
459 $fill = array(0, 0, 0); // Rough estimate of columns fill.
460 foreach ($data['linksToDisplay'] as $key => $link) {
461 // Roughly estimate length of entry (by counting characters)
462 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
463 // Description: 836 characters gives roughly 342 pixel height.
464 // This is not perfect, but it's usually OK.
465 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
466 if (! empty($link['thumbnail'])) {
467 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
469 // Then put in column which is the less filled:
470 $smallest = min($fill); // find smallest value in array.
471 $index = array_search($smallest, $fill); // find index of this smallest value.
472 array_push($columns[$index], $link); // Put entry in this column.
473 $fill[$index] +
= $length;
476 $data['cols'] = $columns;
478 foreach ($data as $key => $value) {
479 $pageBuilder->assign($key, $value);
482 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
483 $pageBuilder->renderPage('daily');
488 * Renders the linklist
490 * @param pageBuilder $PAGE pageBuilder instance.
491 * @param LinkDB $LINKSDB LinkDB instance.
492 * @param ConfigManager $conf Configuration Manager instance.
493 * @param PluginManager $pluginManager Plugin Manager instance.
495 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
497 buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
498 $PAGE->renderPage('linklist');
502 * Render HTML page (according to URL parameters and user rights)
504 * @param ConfigManager $conf Configuration Manager instance.
505 * @param PluginManager $pluginManager Plugin Manager instance,
506 * @param LinkDB $LINKSDB
507 * @param History $history instance
508 * @param SessionManager $sessionManager SessionManager instance
509 * @param LoginManager $loginManager LoginManager instance
511 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
513 $updater = new Updater(
514 read_updates_file($conf->get('resource.updates')),
517 $loginManager->isLoggedIn(),
521 $newUpdates = $updater->update();
522 if (! empty($newUpdates)) {
524 $conf->get('resource.updates'),
525 $updater->getDoneUpdates()
528 } catch (Exception
$e) {
529 die($e->getMessage());
532 $PAGE = new PageBuilder($conf, $_SESSION, $LINKSDB, $sessionManager->generateToken(), $loginManager->isLoggedIn());
533 $PAGE->assign('linkcount', count($LINKSDB));
534 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
535 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
537 // Determine which page will be rendered.
538 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
539 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
541 if (// if the user isn't logged in
542 !$loginManager->isLoggedIn() &&
543 // and Shaarli doesn't have public content...
544 $conf->get('privacy.hide_public_links') &&
545 // and is configured to enforce the login
546 $conf->get('privacy.force_login') &&
547 // and the current page isn't already the login page
548 $targetPage !== Router
::$PAGE_LOGIN &&
549 // and the user is not requesting a feed (which would lead to a different content-type as expected)
550 $targetPage !== Router
::$PAGE_FEED_ATOM &&
551 $targetPage !== Router
::$PAGE_FEED_RSS
553 // force current page to be the login page
554 $targetPage = Router
::$PAGE_LOGIN;
557 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
558 // Then assign generated data to RainTPL.
559 $common_hooks = array(
565 foreach ($common_hooks as $name) {
566 $plugin_data = array();
567 $pluginManager->executeHooks(
571 'target' => $targetPage,
572 'loggedin' => $loginManager->isLoggedIn()
575 $PAGE->assign('plugins_' . $name, $plugin_data);
578 // -------- Display login form.
579 if ($targetPage == Router
::$PAGE_LOGIN) {
580 if ($conf->get('security.open_shaarli')) {
581 header('Location: ?');
583 } // No need to login for open Shaarli
584 if (isset($_GET['username'])) {
585 $PAGE->assign('username', escape($_GET['username']));
587 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
588 // add default state of the 'remember me' checkbox
589 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
590 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
591 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
592 $PAGE->renderPage('loginform');
595 // -------- User wants to logout.
596 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
597 invalidateCaches($conf->get('resource.page_cache'));
598 $sessionManager->logout();
599 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
600 header('Location: ?');
604 // -------- Picture wall
605 if ($targetPage == Router
::$PAGE_PICWALL) {
606 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
607 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
608 $PAGE->assign('linksToDisplay', []);
609 $PAGE->renderPage('picwall');
613 // Optionally filter the results:
614 $links = $LINKSDB->filterSearch($_GET);
615 $linksToDisplay = array();
617 // Get only links which have a thumbnail.
618 // Note: we do not retrieve thumbnails here, the request is too heavy.
619 foreach ($links as $key => $link) {
620 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
621 $linksToDisplay[] = $link; // Add to array.
626 'linksToDisplay' => $linksToDisplay,
628 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
630 foreach ($data as $key => $value) {
631 $PAGE->assign($key, $value);
635 $PAGE->renderPage('picwall');
639 // -------- Tag cloud
640 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
641 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
642 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
643 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
645 // We sort tags alphabetically, then choose a font size according to count.
646 // First, find max value.
648 foreach ($tags as $value) {
649 $maxcount = max($maxcount, $value);
652 alphabetical_sort($tags, false, true);
655 foreach ($tags as $key => $value) {
656 if (in_array($key, $filteringTags)) {
659 // Tag font size scaling:
660 // default 15 and 30 logarithm bases affect scaling,
661 // 22 and 6 are arbitrary font sizes for max and min sizes.
662 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
663 $tagList[$key] = array(
665 'size' => number_format($size, 2, '.', ''),
669 $searchTags = implode(' ', escape($filteringTags));
671 'search_tags' => $searchTags,
674 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
676 foreach ($data as $key => $value) {
677 $PAGE->assign($key, $value);
680 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
681 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
682 $PAGE->renderPage('tag.cloud');
687 if ($targetPage == Router
::$PAGE_TAGLIST) {
688 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
689 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
690 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
691 foreach ($filteringTags as $tag) {
692 if (array_key_exists($tag, $tags)) {
697 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
698 alphabetical_sort($tags, false, true);
701 $searchTags = implode(' ', escape($filteringTags));
703 'search_tags' => $searchTags,
706 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
708 foreach ($data as $key => $value) {
709 $PAGE->assign($key, $value);
712 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
713 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
714 $PAGE->renderPage('tag.list');
719 if ($targetPage == Router
::$PAGE_DAILY) {
720 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
723 // ATOM and RSS feed.
724 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
725 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
726 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
729 $query = $_SERVER['QUERY_STRING'];
730 $cache = new CachedPage(
731 $conf->get('resource.page_cache'),
733 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
735 $cached = $cache->cachedVersion();
736 if (!empty($cached)) {
742 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
743 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
744 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
745 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
746 $data = $feedGenerator->buildData();
748 // Process plugin hook.
749 $pluginManager->executeHooks('render_feed', $data, array(
750 'loggedin' => $loginManager->isLoggedIn(),
751 'target' => $targetPage,
754 // Render the template.
755 $PAGE->assignAll($data);
756 $PAGE->renderPage('feed.'. $feedType);
757 $cache->cache(ob_get_contents());
762 // Display opensearch plugin (XML)
763 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
764 header('Content-Type: application/xml; charset=utf-8');
765 $PAGE->assign('serverurl', index_url($_SERVER));
766 $PAGE->renderPage('opensearch');
770 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
771 if (isset($_GET['addtag'])) {
772 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
773 if (empty($_SERVER['HTTP_REFERER'])) {
774 // In case browser does not send HTTP_REFERER
775 header('Location: ?searchtags='.urlencode($_GET['addtag']));
778 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
780 // Prevent redirection loop
781 if (isset($params['addtag'])) {
782 unset($params['addtag']);
785 // Check if this tag is already in the search query and ignore it if it is.
786 // Each tag is always separated by a space
787 if (isset($params['searchtags'])) {
788 $current_tags = explode(' ', $params['searchtags']);
790 $current_tags = array();
793 foreach ($current_tags as $value) {
794 if ($value === $_GET['addtag']) {
799 // Append the tag if necessary
800 if (empty($params['searchtags'])) {
801 $params['searchtags'] = trim($_GET['addtag']);
803 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
806 // We also remove page (keeping the same page has no sense, since the
807 // results are different)
808 unset($params['page']);
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 // We also remove page (keeping the same page has no sense, since
841 // the results are different)
842 unset($params['page']);
844 header('Location: ?'.http_build_query($params));
848 // -------- User wants to change the number of links per page (linksperpage=...)
849 if (isset($_GET['linksperpage'])) {
850 if (is_numeric($_GET['linksperpage'])) {
851 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
854 if (! empty($_SERVER['HTTP_REFERER'])) {
855 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
859 header('Location: '. $location);
863 // -------- User wants to see only private links (toggle)
864 if (isset($_GET['visibility'])) {
865 if ($_GET['visibility'] === 'private') {
866 // Visibility not set or not already private, set private, otherwise reset it
867 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
868 // See only private links
869 $_SESSION['visibility'] = 'private';
871 unset($_SESSION['visibility']);
873 } elseif ($_GET['visibility'] === 'public') {
874 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
875 // See only public links
876 $_SESSION['visibility'] = 'public';
878 unset($_SESSION['visibility']);
882 if (! empty($_SERVER['HTTP_REFERER'])) {
883 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
887 header('Location: '. $location);
891 // -------- User wants to see only untagged links (toggle)
892 if (isset($_GET['untaggedonly'])) {
893 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
895 if (! empty($_SERVER['HTTP_REFERER'])) {
896 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
900 header('Location: '. $location);
904 // -------- Handle other actions allowed for non-logged in users:
905 if (!$loginManager->isLoggedIn()) {
906 // User tries to post new link but is not logged in:
907 // Show login screen, then redirect to ?post=...
908 if (isset($_GET['post'])) {
909 header( // Redirect to login page, then back to post link.
910 'Location: ?do=login&post='.urlencode($_GET['post']).
911 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
912 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
913 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
914 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
919 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
920 if (isset($_GET['edit_link'])) {
921 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
925 exit; // Never remove this one! All operations below are reserved for logged in user.
928 // -------- All other functions are reserved for the registered user:
930 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
931 if ($targetPage == Router
::$PAGE_TOOLS) {
933 'pageabsaddr' => index_url($_SERVER),
934 'sslenabled' => is_https($_SERVER),
936 $pluginManager->executeHooks('render_tools', $data);
938 foreach ($data as $key => $value) {
939 $PAGE->assign($key, $value);
942 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
943 $PAGE->renderPage('tools');
947 // -------- User wants to change his/her password.
948 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
949 if ($conf->get('security.open_shaarli')) {
950 die(t('You are not supposed to change a password on an Open Shaarli.'));
953 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
954 if (!$sessionManager->checkToken($_POST['token'])) {
955 die(t('Wrong token.')); // Go away!
958 // Make sure old password is correct.
960 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
962 if ($oldhash != $conf->get('credentials.hash')) {
963 echo '<script>alert("'
964 . t('The old password is not correct.')
965 .'");document.location=\'?do=changepasswd\';</script>';
969 // Salt renders rainbow-tables attacks useless.
970 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
974 $_POST['setpassword']
975 . $conf->get('credentials.login')
976 . $conf->get('credentials.salt')
980 $conf->write($loginManager->isLoggedIn());
981 } catch (Exception
$e) {
983 'ERROR while writing config file after changing password.' . PHP_EOL
.
987 // TODO: do not handle exceptions/errors in JS.
988 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
991 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
994 // show the change password form.
995 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
996 $PAGE->renderPage('changepassword');
1001 // -------- User wants to change configuration
1002 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1003 if (!empty($_POST['title'])) {
1004 if (!$sessionManager->checkToken($_POST['token'])) {
1005 die(t('Wrong token.')); // Go away!
1008 if (!empty($_POST['continent']) && !empty($_POST['city'])
1009 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1011 $tz = $_POST['continent'] . '/' . $_POST['city'];
1013 $conf->set('general.timezone', $tz);
1014 $conf->set('general.title', escape($_POST['title']));
1015 $conf->set('general.header_link', escape($_POST['titleLink']));
1016 $conf->set('general.retrieve_description', !empty($_POST['retrieveDescription']));
1017 $conf->set('resource.theme', escape($_POST['theme']));
1018 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1019 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1020 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1021 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1022 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1023 $conf->set('api.enabled', !empty($_POST['enableApi']));
1024 $conf->set('api.secret', escape($_POST['apiSecret']));
1025 $conf->set('translation.language', escape($_POST['language']));
1027 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1028 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1029 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1031 $_SESSION['warnings'][] = t(
1032 'You have enabled or changed thumbnails mode. '
1033 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1036 $conf->set('thumbnails.mode', $thumbnailsMode);
1039 $conf->write($loginManager->isLoggedIn());
1040 $history->updateSettings();
1041 invalidateCaches($conf->get('resource.page_cache'));
1042 } catch (Exception
$e) {
1044 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1048 // TODO: do not handle exceptions/errors in JS.
1049 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1052 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1055 // Show the configuration form.
1056 $PAGE->assign('title', $conf->get('general.title'));
1057 $PAGE->assign('theme', $conf->get('resource.theme'));
1058 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1059 list($continents, $cities) = generateTimeZoneData(
1060 timezone_identifiers_list(),
1061 $conf->get('general.timezone')
1063 $PAGE->assign('continents', $continents);
1064 $PAGE->assign('cities', $cities);
1065 $PAGE->assign('retrieve_description', $conf->get('general.retrieve_description'));
1066 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1067 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1068 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1069 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1070 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1071 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1072 $PAGE->assign('api_secret', $conf->get('api.secret'));
1073 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1074 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1075 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1076 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1077 $PAGE->renderPage('configure');
1082 // -------- User wants to rename a tag or delete it
1083 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1084 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1085 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1086 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1087 $PAGE->renderPage('changetag');
1091 if (!$sessionManager->checkToken($_POST['token'])) {
1092 die(t('Wrong token.'));
1095 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1096 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), $toTag);
1097 $LINKSDB->save($conf->get('resource.page_cache'));
1098 foreach ($alteredLinks as $link) {
1099 $history->updateLink($link);
1101 $delete = empty($_POST['totag']);
1102 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1103 $count = count($alteredLinks);
1105 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1106 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1107 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1111 // -------- User wants to add a link without using the bookmarklet: Show form.
1112 if ($targetPage == Router
::$PAGE_ADDLINK) {
1113 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1114 $PAGE->renderPage('addlink');
1118 // -------- User clicked the "Save" button when editing a link: Save link to database.
1119 if (isset($_POST['save_edit'])) {
1121 if (! $sessionManager->checkToken($_POST['token'])) {
1122 die(t('Wrong token.'));
1125 // lf_id should only be present if the link exists.
1126 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1128 // Linkdate is kept here to:
1129 // - use the same permalink for notes as they're displayed when creating them
1130 // - let users hack creation date of their posts
1131 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1132 $linkdate = escape($_POST['lf_linkdate']);
1133 $link['created'] = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1134 if (isset($LINKSDB[$id])) {
1136 $link['updated'] = new DateTime();
1137 $link['shorturl'] = $LINKSDB[$id]['shorturl'];
1138 $link['sticky'] = isset($LINKSDB[$id]['sticky']) ? $LINKSDB[$id]['sticky'] : false;
1142 $link['updated'] = null;
1143 $link['shorturl'] = link_small_hash($link['created'], $id);
1144 $link['sticky'] = false;
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
'));
1160 $link = array_merge($link, [
1161 'title
' => trim($_POST['lf_title
']),
1163 'description
' => $_POST['lf_description
'],
1164 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1165 'tags
' => str_replace(',', ' ', $tags),
1168 // If title is empty, use the URL as title.
1169 if ($link['title
'] == '') {
1170 $link['title
'] = $link['url
'];
1173 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE
1174 && ! is_note($link['url
'])
1176 $thumbnailer = new Thumbnailer($conf);
1177 $link['thumbnail
'] = $thumbnailer->get($url);
1180 $pluginManager->executeHooks('save_link
', $link);
1182 $LINKSDB[$id] = $link;
1183 $LINKSDB->save($conf->get('resource.page_cache
'));
1185 $history->addLink($link);
1187 $history->updateLink($link);
1190 // If we are called from the bookmarklet, we must close the popup:
1191 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1192 echo '<script
>self
.close();</script
>';
1196 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1197 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1198 // Scroll to the link which has been edited.
1199 $location .= '#' . $link['shorturl'];
1200 // After saving the link, redirect to the page the user was on.
1201 header('Location: '. $location);
1205 // -------- User clicked the "Cancel" button when editing a link.
1206 if (isset($_POST['cancel_edit'])) {
1207 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1208 if (! isset($LINKSDB[$id])) {
1209 header('Location: ?');
1211 // If we are called from the bookmarklet, we must close the popup:
1212 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1213 echo '<script>self.close();</script>';
1216 $link = $LINKSDB[$id];
1217 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1218 // Scroll to the link which has been edited.
1219 $returnurl .= '#'. $link['shorturl'];
1220 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1221 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1225 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1226 if ($targetPage == Router
::$PAGE_DELETELINK) {
1227 if (! $sessionManager->checkToken($_GET['token'])) {
1228 die(t('Wrong token.'));
1231 $ids = trim($_GET['lf_linkdate']);
1232 if (strpos($ids, ' ') !== false) {
1233 // multiple, space-separated ids provided
1234 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1236 // only a single id provided
1239 // assert at least one id is given
1241 die('no id provided');
1243 foreach ($ids as $id) {
1244 $id = (int) escape($id);
1245 $link = $LINKSDB[$id];
1246 $pluginManager->executeHooks('delete_link', $link);
1247 $history->deleteLink($link);
1248 unset($LINKSDB[$id]);
1250 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1252 // If we are called from the bookmarklet, we must close the popup:
1253 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1254 echo '<script>self.close();</script>';
1259 if (isset($_SERVER['HTTP_REFERER'])) {
1260 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1261 $location = generateLocation(
1262 $_SERVER['HTTP_REFERER'],
1263 $_SERVER['HTTP_HOST'],
1264 ['delete_link', 'edit_link', $link['shorturl']]
1268 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1272 // -------- User clicked either "Set public" or "Set private" bulk operation
1273 if ($targetPage == Router
::$PAGE_CHANGE_VISIBILITY) {
1274 if (! $sessionManager->checkToken($_GET['token'])) {
1275 die(t('Wrong token.'));
1278 $ids = trim($_GET['ids']);
1279 if (strpos($ids, ' ') !== false) {
1280 // multiple, space-separated ids provided
1281 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1283 // only a single id provided
1287 // assert at least one id is given
1289 die('no id provided');
1291 // assert that the visibility is valid
1292 if (!isset($_GET['newVisibility']) || !in_array($_GET['newVisibility'], ['public', 'private'])) {
1293 die('invalid visibility');
1295 $private = $_GET['newVisibility'] === 'private';
1297 foreach ($ids as $id) {
1298 $id = (int) escape($id);
1299 $link = $LINKSDB[$id];
1300 $link['private'] = $private;
1301 $pluginManager->executeHooks('save_link', $link);
1302 $LINKSDB[$id] = $link;
1304 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1307 if (isset($_SERVER['HTTP_REFERER'])) {
1308 $location = generateLocation(
1309 $_SERVER['HTTP_REFERER'],
1310 $_SERVER['HTTP_HOST']
1313 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1317 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1318 if (isset($_GET['edit_link'])) {
1319 $id = (int) escape($_GET['edit_link']);
1320 $link = $LINKSDB[$id]; // Read database
1322 header('Location: ?');
1324 } // Link not found in database.
1325 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1328 'link_is_new' => false,
1329 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1330 'tags' => $LINKSDB->linksCountPerTag(),
1332 $pluginManager->executeHooks('render_editlink', $data);
1334 foreach ($data as $key => $value) {
1335 $PAGE->assign($key, $value);
1338 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1339 $PAGE->renderPage('editlink');
1343 // -------- User want to post a new link: Display link edit form.
1344 if (isset($_GET['post'])) {
1345 $url = cleanup_url($_GET['post']);
1347 $link_is_new = false;
1348 // Check if URL is not already in database (in this case, we will edit the existing link)
1349 $link = $LINKSDB->getLinkFromUrl($url);
1351 $link_is_new = true;
1352 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1353 // Get title if it was provided in URL (by the bookmarklet).
1354 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1355 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1356 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1357 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1358 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1360 // If this is an HTTP(S) link, we try go get the page to extract
1361 // the title (otherwise we will to straight to the edit form.)
1362 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1363 $retrieveDescription = $conf->get('general.retrieve_description');
1364 // Short timeout to keep the application responsive
1365 // The callback will fill $charset and $title with data from the downloaded page.
1368 $conf->get('general.download_timeout', 30),
1369 $conf->get('general.download_max_size', 4194304),
1370 get_curl_download_callback($charset, $title, $description, $tags, $retrieveDescription)
1372 if (! empty($title) && strtolower($charset) != 'utf-8') {
1373 $title = mb_convert_encoding($title, 'utf-8', $charset);
1378 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1379 $title = $conf->get('general.default_note_title', t('Note: '));
1381 $url = escape($url);
1382 $title = escape($title);
1385 'linkdate' => $linkdate,
1388 'description' => $description,
1390 'private' => $private,
1393 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1398 'link_is_new' => $link_is_new,
1399 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1400 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1401 'tags' => $LINKSDB->linksCountPerTag(),
1402 'default_private_links' => $conf->get('privacy.default_private_links', false),
1404 $pluginManager->executeHooks('render_editlink', $data);
1406 foreach ($data as $key => $value) {
1407 $PAGE->assign($key, $value);
1410 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1411 $PAGE->renderPage('editlink');
1415 if ($targetPage == Router
::$PAGE_PINLINK) {
1416 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1417 // FIXME! Use a proper error system.
1418 $msg = t('Invalid link ID provided');
1419 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1422 if (! $sessionManager->checkToken($_GET['token'])) {
1423 die('Wrong token.');
1426 $link = $LINKSDB[$_GET['id']];
1427 $link['sticky'] = ! $link['sticky'];
1428 $LINKSDB[(int) $_GET['id']] = $link;
1429 $LINKSDB->save($conf->get('resource.page_cache'));
1430 header('Location: '.index_url($_SERVER));
1434 if ($targetPage == Router
::$PAGE_EXPORT) {
1435 // Export links as a Netscape Bookmarks file
1437 if (empty($_GET['selection'])) {
1438 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1439 $PAGE->renderPage('export');
1443 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1444 $selection = $_GET['selection'];
1445 if (isset($_GET['prepend_note_url'])) {
1446 $prependNoteUrl = $_GET['prepend_note_url'];
1448 $prependNoteUrl = false;
1454 NetscapeBookmarkUtils
::filterAndFormat(
1461 } catch (Exception
$exc) {
1462 header('Content-Type: text/plain; charset=utf-8');
1463 echo $exc->getMessage();
1466 $now = new DateTime();
1467 header('Content-Type: text/html; charset=utf-8');
1469 'Content-disposition: attachment; filename=bookmarks_'
1470 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1472 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1473 $PAGE->assign('eol', PHP_EOL
);
1474 $PAGE->assign('selection', $selection);
1475 $PAGE->renderPage('export.bookmarks');
1479 if ($targetPage == Router
::$PAGE_IMPORT) {
1480 // Upload a Netscape bookmark dump to import its contents
1482 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1483 // Show import dialog
1486 get_max_upload_size(
1487 ini_get('post_max_size'),
1488 ini_get('upload_max_filesize'),
1494 get_max_upload_size(
1495 ini_get('post_max_size'),
1496 ini_get('upload_max_filesize'),
1500 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1501 $PAGE->renderPage('import');
1505 // Import bookmarks from an uploaded file
1506 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1507 // The file is too big or some form field may be missing.
1510 'The file you are trying to upload is probably bigger than what this webserver can accept'
1511 .' (%s). Please upload in smaller chunks.'
1513 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1515 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1518 if (! $sessionManager->checkToken($_POST['token'])) {
1519 die('Wrong token.');
1521 $status = NetscapeBookmarkUtils
::import(
1528 echo '<script>alert("'.$status.'");document.location=\'?do='
1529 .Router
::$PAGE_IMPORT .'\';</script>';
1533 // Plugin administration page
1534 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1535 $pluginMeta = $pluginManager->getPluginsMeta();
1537 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1538 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1539 return $v['order'] !== false;
1542 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1546 return $a['order'] - $b['order'];
1549 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1550 return $v['order'] === false;
1553 $PAGE->assign('enabledPlugins', $enabledPlugins);
1554 $PAGE->assign('disabledPlugins', $disabledPlugins);
1555 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1556 $PAGE->renderPage('pluginsadmin');
1560 // Plugin administration form action
1561 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1563 if (isset($_POST['parameters_form'])) {
1564 $pluginManager->executeHooks('save_plugin_parameters', $_POST);
1565 unset($_POST['parameters_form']);
1566 foreach ($_POST as $param => $value) {
1567 $conf->set('plugins.'. $param, escape($value));
1570 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1572 $conf->write($loginManager->isLoggedIn());
1573 $history->updateSettings();
1574 } catch (Exception
$e) {
1576 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1580 // TODO: do not handle exceptions/errors in JS.
1581 echo '<script>alert("'
1583 .'");document.location=\'?do='
1584 . Router
::$PAGE_PLUGINSADMIN
1588 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1592 // Get a fresh token
1593 if ($targetPage == Router
::$GET_TOKEN) {
1594 header('Content-Type:text/plain');
1595 echo $sessionManager->generateToken($conf);
1599 // -------- Thumbnails Update
1600 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1602 foreach ($LINKSDB as $link) {
1603 // A note or not HTTP(S)
1604 if (is_note($link['url']) || ! startsWith(strtolower($link['url']), 'http')) {
1607 $ids[] = $link['id'];
1609 $PAGE->assign('ids', $ids);
1610 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1611 $PAGE->renderPage('thumbnails');
1615 // -------- Single Thumbnail Update
1616 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1617 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1618 http_response_code(400);
1621 $id = (int) $_POST['id'];
1622 if (empty($LINKSDB[$id])) {
1623 http_response_code(404);
1626 $thumbnailer = new Thumbnailer($conf);
1627 $link = $LINKSDB[$id];
1628 $link['thumbnail'] = $thumbnailer->get($link['url']);
1629 $LINKSDB[$id] = $link;
1630 $LINKSDB->save($conf->get('resource.page_cache'));
1632 echo json_encode($link);
1636 // -------- Otherwise, simply display search form and links:
1637 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1642 * Template for the list of links (<div id="linklist">)
1643 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1645 * @param pageBuilder $PAGE pageBuilder instance.
1646 * @param LinkDB $LINKSDB LinkDB instance.
1647 * @param ConfigManager $conf Configuration Manager instance.
1648 * @param PluginManager $pluginManager Plugin Manager instance.
1649 * @param LoginManager $loginManager LoginManager instance
1651 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1653 // Used in templates
1654 if (isset($_GET['searchtags'])) {
1655 if (! empty($_GET['searchtags'])) {
1656 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1658 $searchtags = false;
1663 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1666 if (! empty($_SERVER['QUERY_STRING'])
1667 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1669 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1670 } catch (LinkNotFoundException
$e) {
1671 $PAGE->render404($e->getMessage());
1675 // Filter links according search parameters.
1676 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1678 'searchtags' => $searchtags,
1679 'searchterm' => $searchterm,
1681 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1684 // ---- Handle paging.
1686 foreach ($linksToDisplay as $key => $value) {
1690 // Select articles according to paging.
1691 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1692 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1693 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1694 $page = $page < 1 ? 1 : $page;
1695 $page = $page > $pagecount ? $pagecount : $page;
1697 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1698 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1700 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1701 if ($thumbnailsEnabled) {
1702 $thumbnailer = new Thumbnailer($conf);
1705 $linkDisp = array();
1706 while ($i<$end && $i<count($keys)) {
1707 $link = $linksToDisplay[$keys[$i]];
1708 $link['description'] = format_description($link['description']);
1709 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1710 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1711 $link['timestamp'] = $link['created']->getTimestamp();
1712 if (! empty($link['updated'])) {
1713 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1715 $link['updated_timestamp'] = '';
1717 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1718 uasort($taglist, 'strcasecmp');
1719 $link['taglist'] = $taglist;
1721 // Logged in, thumbnails enabled, not a note,
1722 // and (never retrieved yet or no valid cache file)
1723 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1724 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1726 $elem = $LINKSDB[$keys[$i]];
1727 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1728 $LINKSDB[$keys[$i]] = $elem;
1730 $link['thumbnail'] = $elem['thumbnail'];
1733 // Check for both signs of a note: starting with ? and 7 chars long.
1734 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1735 $link['url'] = index_url($_SERVER) . $link['url'];
1738 $linkDisp[$keys[$i]] = $link;
1742 // If we retrieved new thumbnails, we update the database.
1743 if (!empty($updateDB)) {
1744 $LINKSDB->save($conf->get('resource.page_cache'));
1747 // Compute paging navigation
1748 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1749 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1750 $previous_page_url = '';
1751 if ($i != count($keys)) {
1752 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1756 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1759 // Fill all template fields.
1761 'previous_page_url' => $previous_page_url,
1762 'next_page_url' => $next_page_url,
1763 'page_current' => $page,
1764 'page_max' => $pagecount,
1765 'result_count' => count($linksToDisplay),
1766 'search_term' => $searchterm,
1767 'search_tags' => $searchtags,
1768 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1769 'links' => $linkDisp,
1772 // If there is only a single link, we change on-the-fly the title of the page.
1773 if (count($linksToDisplay) == 1) {
1774 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1775 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1776 $data['pagetitle'] = t('Search: ');
1777 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1778 $bracketWrap = function ($tag) {
1779 return '['. $tag .']';
1781 $data['pagetitle'] .= ! empty($searchtags)
1782 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1784 $data['pagetitle'] .= '- '. $conf->get('general.title');
1787 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1789 foreach ($data as $key => $value) {
1790 $PAGE->assign($key, $value);
1798 * This function should NEVER be called if the file data/config.php exists.
1800 * @param ConfigManager $conf Configuration Manager instance.
1801 * @param SessionManager $sessionManager SessionManager instance
1802 * @param LoginManager $loginManager LoginManager instance
1804 function install($conf, $sessionManager, $loginManager)
1806 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1807 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1808 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1812 // This part makes sure sessions works correctly.
1813 // (Because on some hosts, session.save_path may not be set correctly,
1814 // or we may not have write access to it.)
1815 if (isset($_GET['test_session'])
1816 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1817 // Step 2: Check if data in session is correct.
1819 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1820 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1821 'and that you have write access to it.<br>'.
1822 'It currently points to %s.<br>'.
1823 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1824 'or any custom hostname without a dot causes cookie storage to fail. '.
1825 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1827 $msg = sprintf($msg, session_save_path());
1829 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1832 if (!isset($_SESSION['session_tested'])) {
1833 // Step 1 : Try to store data in session and reload page.
1834 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1835 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1837 if (isset($_GET['test_session'])) {
1838 // Step 3: Sessions are OK. Remove test parameter from URL.
1839 header('Location: '.index_url($_SERVER));
1843 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1845 if (!empty($_POST['continent']) && !empty($_POST['city'])
1846 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1848 $tz = $_POST['continent'].'/'.$_POST['city'];
1850 $conf->set('general.timezone', $tz);
1851 $login = $_POST['setlogin'];
1852 $conf->set('credentials.login', $login);
1853 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1854 $conf->set('credentials.salt', $salt);
1855 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1856 if (!empty($_POST['title'])) {
1857 $conf->set('general.title', escape($_POST['title']));
1859 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1861 $conf->set('translation.language', escape($_POST['language']));
1862 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1863 $conf->set('api.enabled', !empty($_POST['enableApi']));
1866 generate_api_secret(
1867 $conf->get('credentials.login'),
1868 $conf->get('credentials.salt')
1872 // Everything is ok, let's create config file.
1873 $conf->write($loginManager->isLoggedIn());
1874 } catch (Exception
$e) {
1876 'ERROR while writing config file after installation.' . PHP_EOL
.
1880 // TODO: do not handle exceptions/errors in JS.
1881 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1884 echo '<script>alert('
1885 .'"Shaarli is now configured. '
1886 .'Please enter your login/password and start shaaring your links!"'
1887 .');document.location=\'?do=login\';</script>';
1891 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1892 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1893 $PAGE->assign('continents', $continents);
1894 $PAGE->assign('cities', $cities);
1895 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1896 $PAGE->renderPage('install');
1900 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1901 showDailyRSS($conf, $loginManager);
1905 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1906 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1910 $history = new History($conf->get('resource.history'));
1911 } catch (Exception
$e) {
1912 die($e->getMessage());
1915 $linkDb = new LinkDB(
1916 $conf->get('resource.datastore'),
1917 $loginManager->isLoggedIn(),
1918 $conf->get('privacy.hide_public_links')
1921 $container = new \Slim\
Container();
1922 $container['conf'] = $conf;
1923 $container['plugins'] = $pluginManager;
1924 $container['history'] = $history;
1925 $app = new \Slim\
App($container);
1928 $app->group('/api/v1', function () {
1929 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1930 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1931 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1932 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1933 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1934 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1936 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1937 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1938 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1939 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1941 $this->get('/history', '\Shaarli\Api\Controllers\HistoryController:getHistory')->setName('getHistory');
1942 })->add('\Shaarli\Api\ApiMiddleware');
1944 $response = $app->run(true);
1946 // Hack to make Slim and Shaarli router work together:
1947 // If a Slim route isn't found and NOT API call, we call renderPage().
1948 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1949 // We use UTF-8 for proper international characters handling.
1950 header('Content-Type: text/html; charset=utf-8');
1951 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1953 $response = $response
1954 ->withHeader('Access-Control-Allow-Origin', '*')
1956 'Access-Control-Allow-Headers',
1957 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1959 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1960 $app->respond($response);