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
;
80 use \Shaarli\Languages
;
81 use \Shaarli\Security\LoginManager
;
82 use \Shaarli\Security\SessionManager
;
83 use \Shaarli\ThemeUtils
;
84 use \Shaarli\Thumbnailer
;
86 // Ensure the PHP version is supported
88 ApplicationUtils
::checkPHPVersion('5.5', PHP_VERSION
);
89 } catch (Exception
$exc) {
90 header('Content-Type: text/plain; charset=utf-8');
91 echo $exc->getMessage();
95 define('SHAARLI_VERSION', ApplicationUtils
::getVersion(__DIR__
.'/'. ApplicationUtils
::$VERSION_FILE));
97 // Force cookie path (but do not change lifetime)
98 $cookie = session_get_cookie_params();
100 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
101 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]).'/';
103 // Set default cookie expiration and path.
104 session_set_cookie_params($cookie['lifetime'], $cookiedir, $_SERVER['SERVER_NAME']);
105 // Set session parameters on server side.
106 // Use cookies to store session.
107 ini_set('session.use_cookies', 1);
108 // Force cookies for session (phpsessionID forbidden in URL).
109 ini_set('session.use_only_cookies', 1);
110 // Prevent PHP form using sessionID in URL if cookies are disabled.
111 ini_set('session.use_trans_sid', false);
113 session_name('shaarli');
114 // Start session if needed (Some server auto-start sessions).
115 if (session_status() == PHP_SESSION_NONE
) {
119 // Regenerate session ID if invalid or not defined in cookie.
120 if (isset($_COOKIE['shaarli']) && !SessionManager
::checkId($_COOKIE['shaarli'])) {
121 session_regenerate_id(true);
122 $_COOKIE['shaarli'] = session_id();
125 $conf = new ConfigManager();
126 $sessionManager = new SessionManager($_SESSION, $conf);
127 $loginManager = new LoginManager($GLOBALS, $conf, $sessionManager);
128 $loginManager->generateStaySignedInToken($_SERVER['REMOTE_ADDR']);
129 $clientIpId = client_ip_id($_SERVER);
131 // LC_MESSAGES isn't defined without php-intl, in this case use LC_COLLATE locale instead.
132 if (! defined('LC_MESSAGES')) {
133 define('LC_MESSAGES', LC_COLLATE
);
136 // Sniff browser language and set date format accordingly.
137 if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
138 autoLocale($_SERVER['HTTP_ACCEPT_LANGUAGE']);
141 new Languages(setlocale(LC_MESSAGES
, 0), $conf);
143 $conf->setEmpty('general.timezone', date_default_timezone_get());
144 $conf->setEmpty('general.title', t('Shared links on '). escape(index_url($_SERVER)));
145 RainTPL
::$tpl_dir = $conf->get('resource.raintpl_tpl').'/'.$conf->get('resource.theme').'/'; // template directory
146 RainTPL
::$cache_dir = $conf->get('resource.raintpl_tmp'); // cache directory
148 $pluginManager = new PluginManager($conf);
149 $pluginManager->load($conf->get('general.enabled_plugins'));
151 date_default_timezone_set($conf->get('general.timezone', 'UTC'));
153 ob_start(); // Output buffering for the page cache.
155 // Prevent caching on client side or proxy: (yes, it's ugly)
156 header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
157 header("Cache-Control: no-store, no-cache, must-revalidate");
158 header("Cache-Control: post-check=0, pre-check=0", false);
159 header("Pragma: no-cache");
161 if (! is_file($conf->getConfigFileExt())) {
162 // Ensure Shaarli has proper access to its resources
163 $errors = ApplicationUtils
::checkResourcePermissions($conf);
165 if ($errors != array()) {
166 $message = '<p>'. t('Insufficient permissions:') .'</p><ul>';
168 foreach ($errors as $error) {
169 $message .= '<li>'.$error.'</li>';
173 header('Content-Type: text/html; charset=utf-8');
178 // Display the installation form if no existing config is found
179 install($conf, $sessionManager, $loginManager);
182 $loginManager->checkLoginState($_COOKIE, $clientIpId);
185 * Adapter function to ensure compatibility with third-party templates
187 * @see https://github.com/shaarli/Shaarli/pull/1086
189 * @return bool true when the user is logged in, false otherwise
191 function isLoggedIn()
193 global $loginManager;
194 return $loginManager->isLoggedIn();
198 // ------------------------------------------------------------------------------------------
199 // Process login form: Check if login/password is correct.
200 if (isset($_POST['login'])) {
201 if (! $loginManager->canLogin($_SERVER)) {
202 die(t('I said: NO. You are banned for the moment. Go away.'));
204 if (isset($_POST['password'])
205 && $sessionManager->checkToken($_POST['token'])
206 && $loginManager->checkCredentials($_SERVER['REMOTE_ADDR'], $clientIpId, $_POST['login'], $_POST['password'])
208 $loginManager->handleSuccessfulLogin($_SERVER);
211 if (dirname($_SERVER['SCRIPT_NAME']) != '/') {
212 // Note: Never forget the trailing slash on the cookie path!
213 $cookiedir = dirname($_SERVER["SCRIPT_NAME"]) . '/';
216 if (!empty($_POST['longlastingsession'])) {
217 // Keep the session cookie even after the browser closes
218 $sessionManager->setStaySignedIn(true);
219 $expirationTime = $sessionManager->extendSession();
222 $loginManager::$STAY_SIGNED_IN_COOKIE,
223 $loginManager->getStaySignedInToken(),
228 // Standard session expiration (=when browser closes)
232 // Send cookie with the new expiration date to the browser
233 session_set_cookie_params($expirationTime, $cookiedir, $_SERVER['SERVER_NAME']);
234 session_regenerate_id(true);
236 // Optional redirect after login:
237 if (isset($_GET['post'])) {
238 $uri = '?post='. urlencode($_GET['post']);
239 foreach (array('description', 'source', 'title', 'tags') as $param) {
240 if (!empty($_GET[$param])) {
241 $uri .= '&'.$param.'='.urlencode($_GET[$param]);
244 header('Location: '. $uri);
248 if (isset($_GET['edit_link'])) {
249 header('Location: ?edit_link='. escape($_GET['edit_link']));
253 if (isset($_POST['returnurl'])) {
254 // Prevent loops over login screen.
255 if (strpos($_POST['returnurl'], 'do=login') === false) {
256 header('Location: '. generateLocation($_POST['returnurl'], $_SERVER['HTTP_HOST']));
260 header('Location: ?');
263 $loginManager->handleFailedLogin($_SERVER);
264 $redir = '&username='. urlencode($_POST['login']);
265 if (isset($_GET['post'])) {
266 $redir .= '&post=' . urlencode($_GET['post']);
267 foreach (array('description', 'source', 'title', 'tags') as $param) {
268 if (!empty($_GET[$param])) {
269 $redir .= '&' . $param . '=' . urlencode($_GET[$param]);
273 // Redirect to login screen.
274 echo '<script>alert("'. t("Wrong login/password.") .'");document.location=\'?do=login'.$redir.'\';</script>';
279 // ------------------------------------------------------------------------------------------
280 // Token management for XSRF protection
281 // Token should be used in any form which acts on data (create,update,delete,import...).
282 if (!isset($_SESSION['tokens'])) {
283 $_SESSION['tokens']=array(); // Token are attached to the session.
287 * Daily RSS feed: 1 RSS entry per day giving all the links on that day.
288 * Gives the last 7 days (which have links).
289 * This RSS feed cannot be filtered.
291 * @param ConfigManager $conf Configuration Manager instance
292 * @param LoginManager $loginManager LoginManager instance
294 function showDailyRSS($conf, $loginManager)
297 $query = $_SERVER['QUERY_STRING'];
298 $cache = new CachedPage(
299 $conf->get('config.PAGE_CACHE'),
301 startsWith($query, 'do=dailyrss') && !$loginManager->isLoggedIn()
303 $cached = $cache->cachedVersion();
304 if (!empty($cached)) {
309 // If cached was not found (or not usable), then read the database and build the response:
310 // Read links from database (and filter private links if used it not logged in).
311 $LINKSDB = new LinkDB(
312 $conf->get('resource.datastore'),
313 $loginManager->isLoggedIn(),
314 $conf->get('privacy.hide_public_links'),
315 $conf->get('redirector.url'),
316 $conf->get('redirector.encode_url')
319 /* Some Shaarlies may have very few links, so we need to look
320 back in time until we have enough days ($nb_of_days).
322 $nb_of_days = 7; // We take 7 days.
323 $today = date('Ymd');
326 foreach ($LINKSDB as $link) {
327 $day = $link['created']->format('Ymd'); // Extract day (without time)
328 if (strcmp($day, $today) < 0) {
329 if (empty($days[$day])) {
330 $days[$day] = array();
332 $days[$day][] = $link;
335 if (count($days) > $nb_of_days) {
336 break; // Have we collected enough days?
340 // Build the RSS feed.
341 header('Content-Type: application/rss+xml; charset=utf-8');
342 $pageaddr = escape(index_url($_SERVER));
343 echo '<?xml version="1.0" encoding="UTF-8"?><rss version="2.0">';
345 echo '<title>Daily - '. $conf->get('general.title') . '</title>';
346 echo '<link>'. $pageaddr .'</link>';
347 echo '<description>Daily shared links</description>';
348 echo '<language>en-en</language>';
349 echo '<copyright>'. $pageaddr .'</copyright>'. PHP_EOL
;
352 foreach ($days as $day => $links) {
353 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
354 $absurl = escape(index_url($_SERVER).'?do=daily&day='.$day); // Absolute URL of the corresponding "Daily" page.
356 // We pre-format some fields for proper output.
357 foreach ($links as &$link) {
358 $link['formatedDescription'] = format_description(
359 $link['description'],
360 $conf->get('redirector.url'),
361 $conf->get('redirector.encode_url')
363 $link['timestamp'] = $link['created']->getTimestamp();
364 if (startsWith($link['url'], '?')) {
365 $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute
369 // Then build the HTML for this day:
371 $tpl->assign('title', $conf->get('general.title'));
372 $tpl->assign('daydate', $dayDate->getTimestamp());
373 $tpl->assign('absurl', $absurl);
374 $tpl->assign('links', $links);
375 $tpl->assign('rssdate', escape($dayDate->format(DateTime
::RSS
)));
376 $tpl->assign('hide_timestamps', $conf->get('privacy.hide_timestamps', false));
377 $tpl->assign('index_url', $pageaddr);
378 $html = $tpl->draw('dailyrss', true);
380 echo $html . PHP_EOL
;
382 echo '</channel></rss><!-- Cached version of '. escape(page_url($_SERVER)) .' -->';
384 $cache->cache(ob_get_contents());
390 * Show the 'Daily' page.
392 * @param PageBuilder $pageBuilder Template engine wrapper.
393 * @param LinkDB $LINKSDB LinkDB instance.
394 * @param ConfigManager $conf Configuration Manager instance.
395 * @param PluginManager $pluginManager Plugin Manager instance.
396 * @param LoginManager $loginManager Login Manager instance
398 function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager)
400 $day = date('Ymd', strtotime('-1 day')); // Yesterday, in format YYYYMMDD.
401 if (isset($_GET['day'])) {
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(
436 $link['description'],
437 $conf->get('redirector.url'),
438 $conf->get('redirector.encode_url')
440 $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp();
443 $dayDate = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $day.'_000000');
445 'pagetitle' => $conf->get('general.title') .' - '. format_date($dayDate, false),
446 'linksToDisplay' => $linksToDisplay,
447 'day' => $dayDate->getTimestamp(),
448 'dayDate' => $dayDate,
449 'previousday' => $previousday,
450 'nextday' => $nextday,
453 /* Hook is called before column construction so that plugins don't have
454 to deal with columns. */
455 $pluginManager->executeHooks('render_daily', $data, array('loggedin' => $loginManager->isLoggedIn()));
457 /* We need to spread the articles on 3 columns.
458 I did not want to use a JavaScript lib like http://masonry.desandro.com/
459 so I manually spread entries with a simple method: I roughly evaluate the
460 height of a div according to title and description length.
462 $columns = array(array(), array(), array()); // Entries to display, for each column.
463 $fill = array(0, 0, 0); // Rough estimate of columns fill.
464 foreach ($data['linksToDisplay'] as $key => $link) {
465 // Roughly estimate length of entry (by counting characters)
466 // Title: 30 chars = 1 line. 1 line is 30 pixels height.
467 // Description: 836 characters gives roughly 342 pixel height.
468 // This is not perfect, but it's usually OK.
469 $length = strlen($link['title']) +
(342 * strlen($link['description'])) / 836;
470 if ($link['thumbnail']) {
471 $length +
= 100; // 1 thumbnails roughly takes 100 pixels height.
473 // Then put in column which is the less filled:
474 $smallest = min($fill); // find smallest value in array.
475 $index = array_search($smallest, $fill); // find index of this smallest value.
476 array_push($columns[$index], $link); // Put entry in this column.
477 $fill[$index] +
= $length;
480 $data['cols'] = $columns;
482 foreach ($data as $key => $value) {
483 $pageBuilder->assign($key, $value);
486 $pageBuilder->assign('pagetitle', t('Daily') .' - '. $conf->get('general.title', 'Shaarli'));
487 $pageBuilder->renderPage('daily');
492 * Renders the linklist
494 * @param pageBuilder $PAGE pageBuilder instance.
495 * @param LinkDB $LINKSDB LinkDB instance.
496 * @param ConfigManager $conf Configuration Manager instance.
497 * @param PluginManager $pluginManager Plugin Manager instance.
499 function showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
501 buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
502 $PAGE->renderPage('linklist');
506 * Render HTML page (according to URL parameters and user rights)
508 * @param ConfigManager $conf Configuration Manager instance.
509 * @param PluginManager $pluginManager Plugin Manager instance,
510 * @param LinkDB $LINKSDB
511 * @param History $history instance
512 * @param SessionManager $sessionManager SessionManager instance
513 * @param LoginManager $loginManager LoginManager instance
515 function renderPage($conf, $pluginManager, $LINKSDB, $history, $sessionManager, $loginManager)
517 $updater = new Updater(
518 read_updates_file($conf->get('resource.updates')),
521 $loginManager->isLoggedIn(),
525 $newUpdates = $updater->update();
526 if (! empty($newUpdates)) {
528 $conf->get('resource.updates'),
529 $updater->getDoneUpdates()
532 } catch (Exception
$e) {
533 die($e->getMessage());
536 $PAGE = new PageBuilder($conf, $_SESSION, $LINKSDB, $sessionManager->generateToken(), $loginManager->isLoggedIn());
537 $PAGE->assign('linkcount', count($LINKSDB));
538 $PAGE->assign('privateLinkcount', count_private($LINKSDB));
539 $PAGE->assign('plugin_errors', $pluginManager->getErrors());
541 // Determine which page will be rendered.
542 $query = (isset($_SERVER['QUERY_STRING'])) ? $_SERVER['QUERY_STRING'] : '';
543 $targetPage = Router
::findPage($query, $_GET, $loginManager->isLoggedIn());
545 if (// if the user isn't logged in
546 !$loginManager->isLoggedIn() &&
547 // and Shaarli doesn't have public content...
548 $conf->get('privacy.hide_public_links') &&
549 // and is configured to enforce the login
550 $conf->get('privacy.force_login') &&
551 // and the current page isn't already the login page
552 $targetPage !== Router
::$PAGE_LOGIN &&
553 // and the user is not requesting a feed (which would lead to a different content-type as expected)
554 $targetPage !== Router
::$PAGE_FEED_ATOM &&
555 $targetPage !== Router
::$PAGE_FEED_RSS
557 // force current page to be the login page
558 $targetPage = Router
::$PAGE_LOGIN;
561 // Call plugin hooks for header, footer and includes, specifying which page will be rendered.
562 // Then assign generated data to RainTPL.
563 $common_hooks = array(
569 foreach ($common_hooks as $name) {
570 $plugin_data = array();
571 $pluginManager->executeHooks(
575 'target' => $targetPage,
576 'loggedin' => $loginManager->isLoggedIn()
579 $PAGE->assign('plugins_' . $name, $plugin_data);
582 // -------- Display login form.
583 if ($targetPage == Router
::$PAGE_LOGIN) {
584 if ($conf->get('security.open_shaarli')) {
585 header('Location: ?');
587 } // No need to login for open Shaarli
588 if (isset($_GET['username'])) {
589 $PAGE->assign('username', escape($_GET['username']));
591 $PAGE->assign('returnurl', (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']):''));
592 // add default state of the 'remember me' checkbox
593 $PAGE->assign('remember_user_default', $conf->get('privacy.remember_user_default'));
594 $PAGE->assign('user_can_login', $loginManager->canLogin($_SERVER));
595 $PAGE->assign('pagetitle', t('Login') .' - '. $conf->get('general.title', 'Shaarli'));
596 $PAGE->renderPage('loginform');
599 // -------- User wants to logout.
600 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=logout')) {
601 invalidateCaches($conf->get('resource.page_cache'));
602 $sessionManager->logout();
603 setcookie(LoginManager
::$STAY_SIGNED_IN_COOKIE, 'false', 0, WEB_PATH
);
604 header('Location: ?');
608 // -------- Picture wall
609 if ($targetPage == Router
::$PAGE_PICWALL) {
610 $PAGE->assign('pagetitle', t('Picture wall') .' - '. $conf->get('general.title', 'Shaarli'));
611 if (! $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) === Thumbnailer
::MODE_NONE
) {
612 $PAGE->assign('linksToDisplay', []);
613 $PAGE->renderPage('picwall');
617 // Optionally filter the results:
618 $links = $LINKSDB->filterSearch($_GET);
619 $linksToDisplay = array();
621 // Get only links which have a thumbnail.
622 // Note: we do not retrieve thumbnails here, the request is too heavy.
623 foreach ($links as $key => $link) {
624 if (isset($link['thumbnail']) && $link['thumbnail'] !== false) {
625 $linksToDisplay[] = $link; // Add to array.
630 'linksToDisplay' => $linksToDisplay,
632 $pluginManager->executeHooks('render_picwall', $data, array('loggedin' => $loginManager->isLoggedIn()));
634 foreach ($data as $key => $value) {
635 $PAGE->assign($key, $value);
639 $PAGE->renderPage('picwall');
643 // -------- Tag cloud
644 if ($targetPage == Router
::$PAGE_TAGCLOUD) {
645 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
646 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
647 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
649 // We sort tags alphabetically, then choose a font size according to count.
650 // First, find max value.
652 foreach ($tags as $value) {
653 $maxcount = max($maxcount, $value);
656 alphabetical_sort($tags, false, true);
659 foreach ($tags as $key => $value) {
660 if (in_array($key, $filteringTags)) {
663 // Tag font size scaling:
664 // default 15 and 30 logarithm bases affect scaling,
665 // 22 and 6 are arbitrary font sizes for max and min sizes.
666 $size = log($value, 15) / log($maxcount, 30) * 2.2 +
0.8;
667 $tagList[$key] = array(
669 'size' => number_format($size, 2, '.', ''),
673 $searchTags = implode(' ', escape($filteringTags));
675 'search_tags' => $searchTags,
678 $pluginManager->executeHooks('render_tagcloud', $data, array('loggedin' => $loginManager->isLoggedIn()));
680 foreach ($data as $key => $value) {
681 $PAGE->assign($key, $value);
684 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
685 $PAGE->assign('pagetitle', $searchTags. t('Tag cloud') .' - '. $conf->get('general.title', 'Shaarli'));
686 $PAGE->renderPage('tag.cloud');
691 if ($targetPage == Router
::$PAGE_TAGLIST) {
692 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
693 $filteringTags = isset($_GET['searchtags']) ? explode(' ', $_GET['searchtags']) : [];
694 $tags = $LINKSDB->linksCountPerTag($filteringTags, $visibility);
695 foreach ($filteringTags as $tag) {
696 if (array_key_exists($tag, $tags)) {
701 if (! empty($_GET['sort']) && $_GET['sort'] === 'alpha') {
702 alphabetical_sort($tags, false, true);
705 $searchTags = implode(' ', escape($filteringTags));
707 'search_tags' => $searchTags,
710 $pluginManager->executeHooks('render_taglist', $data, ['loggedin' => $loginManager->isLoggedIn()]);
712 foreach ($data as $key => $value) {
713 $PAGE->assign($key, $value);
716 $searchTags = ! empty($searchTags) ? $searchTags .' - ' : '';
717 $PAGE->assign('pagetitle', $searchTags . t('Tag list') .' - '. $conf->get('general.title', 'Shaarli'));
718 $PAGE->renderPage('tag.list');
723 if ($targetPage == Router
::$PAGE_DAILY) {
724 showDaily($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
727 // ATOM and RSS feed.
728 if ($targetPage == Router
::$PAGE_FEED_ATOM || $targetPage == Router
::$PAGE_FEED_RSS) {
729 $feedType = $targetPage == Router
::$PAGE_FEED_RSS ? FeedBuilder
::$FEED_RSS : FeedBuilder
::$FEED_ATOM;
730 header('Content-Type: application/'. $feedType .'+xml; charset=utf-8');
733 $query = $_SERVER['QUERY_STRING'];
734 $cache = new CachedPage(
735 $conf->get('resource.page_cache'),
737 startsWith($query, 'do='. $targetPage) && !$loginManager->isLoggedIn()
739 $cached = $cache->cachedVersion();
740 if (!empty($cached)) {
746 $feedGenerator = new FeedBuilder($LINKSDB, $feedType, $_SERVER, $_GET, $loginManager->isLoggedIn());
747 $feedGenerator->setLocale(strtolower(setlocale(LC_COLLATE
, 0)));
748 $feedGenerator->setHideDates($conf->get('privacy.hide_timestamps') && !$loginManager->isLoggedIn());
749 $feedGenerator->setUsePermalinks(isset($_GET['permalinks']) || !$conf->get('feed.rss_permalinks'));
750 $data = $feedGenerator->buildData();
752 // Process plugin hook.
753 $pluginManager->executeHooks('render_feed', $data, array(
754 'loggedin' => $loginManager->isLoggedIn(),
755 'target' => $targetPage,
758 // Render the template.
759 $PAGE->assignAll($data);
760 $PAGE->renderPage('feed.'. $feedType);
761 $cache->cache(ob_get_contents());
766 // Display opensearch plugin (XML)
767 if ($targetPage == Router
::$PAGE_OPENSEARCH) {
768 header('Content-Type: application/xml; charset=utf-8');
769 $PAGE->assign('serverurl', index_url($_SERVER));
770 $PAGE->renderPage('opensearch');
774 // -------- User clicks on a tag in a link: The tag is added to the list of searched tags (searchtags=...)
775 if (isset($_GET['addtag'])) {
776 // Get previous URL (http_referer) and add the tag to the searchtags parameters in query.
777 if (empty($_SERVER['HTTP_REFERER'])) {
778 // In case browser does not send HTTP_REFERER
779 header('Location: ?searchtags='.urlencode($_GET['addtag']));
782 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
784 // Prevent redirection loop
785 if (isset($params['addtag'])) {
786 unset($params['addtag']);
789 // Check if this tag is already in the search query and ignore it if it is.
790 // Each tag is always separated by a space
791 if (isset($params['searchtags'])) {
792 $current_tags = explode(' ', $params['searchtags']);
794 $current_tags = array();
797 foreach ($current_tags as $value) {
798 if ($value === $_GET['addtag']) {
803 // Append the tag if necessary
804 if (empty($params['searchtags'])) {
805 $params['searchtags'] = trim($_GET['addtag']);
807 $params['searchtags'] = trim($params['searchtags']).' '.trim($_GET['addtag']);
810 // We also remove page (keeping the same page has no sense, since the
811 // results are different)
812 unset($params['page']);
814 header('Location: ?'.http_build_query($params));
818 // -------- User clicks on a tag in result count: Remove the tag from the list of searched tags (searchtags=...)
819 if (isset($_GET['removetag'])) {
820 // Get previous URL (http_referer) and remove the tag from the searchtags parameters in query.
821 if (empty($_SERVER['HTTP_REFERER'])) {
822 header('Location: ?');
826 // In case browser does not send HTTP_REFERER
827 parse_str(parse_url($_SERVER['HTTP_REFERER'], PHP_URL_QUERY
), $params);
829 // Prevent redirection loop
830 if (isset($params['removetag'])) {
831 unset($params['removetag']);
834 if (isset($params['searchtags'])) {
835 $tags = explode(' ', $params['searchtags']);
836 // Remove value from array $tags.
837 $tags = array_diff($tags, array($_GET['removetag']));
838 $params['searchtags'] = implode(' ', $tags);
840 if (empty($params['searchtags'])) {
841 unset($params['searchtags']);
844 // We also remove page (keeping the same page has no sense, since
845 // the results are different)
846 unset($params['page']);
848 header('Location: ?'.http_build_query($params));
852 // -------- User wants to change the number of links per page (linksperpage=...)
853 if (isset($_GET['linksperpage'])) {
854 if (is_numeric($_GET['linksperpage'])) {
855 $_SESSION['LINKS_PER_PAGE']=abs(intval($_GET['linksperpage']));
858 if (! empty($_SERVER['HTTP_REFERER'])) {
859 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('linksperpage'));
863 header('Location: '. $location);
867 // -------- User wants to see only private links (toggle)
868 if (isset($_GET['visibility'])) {
869 if ($_GET['visibility'] === 'private') {
870 // Visibility not set or not already private, set private, otherwise reset it
871 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'private') {
872 // See only private links
873 $_SESSION['visibility'] = 'private';
875 unset($_SESSION['visibility']);
877 } elseif ($_GET['visibility'] === 'public') {
878 if (empty($_SESSION['visibility']) || $_SESSION['visibility'] !== 'public') {
879 // See only public links
880 $_SESSION['visibility'] = 'public';
882 unset($_SESSION['visibility']);
886 if (! empty($_SERVER['HTTP_REFERER'])) {
887 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('visibility'));
891 header('Location: '. $location);
895 // -------- User wants to see only untagged links (toggle)
896 if (isset($_GET['untaggedonly'])) {
897 $_SESSION['untaggedonly'] = empty($_SESSION['untaggedonly']);
899 if (! empty($_SERVER['HTTP_REFERER'])) {
900 $location = generateLocation($_SERVER['HTTP_REFERER'], $_SERVER['HTTP_HOST'], array('untaggedonly'));
904 header('Location: '. $location);
908 // -------- Handle other actions allowed for non-logged in users:
909 if (!$loginManager->isLoggedIn()) {
910 // User tries to post new link but is not logged in:
911 // Show login screen, then redirect to ?post=...
912 if (isset($_GET['post'])) {
913 header( // Redirect to login page, then back to post link.
914 'Location: ?do=login&post='.urlencode($_GET['post']).
915 (!empty($_GET['title'])?'&title='.urlencode($_GET['title']):'').
916 (!empty($_GET['description'])?'&description='.urlencode($_GET['description']):'').
917 (!empty($_GET['tags'])?'&tags='.urlencode($_GET['tags']):'').
918 (!empty($_GET['source'])?'&source='.urlencode($_GET['source']):'')
923 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
924 if (isset($_GET['edit_link'])) {
925 header('Location: ?do=login&edit_link='. escape($_GET['edit_link']));
929 exit; // Never remove this one! All operations below are reserved for logged in user.
932 // -------- All other functions are reserved for the registered user:
934 // -------- Display the Tools menu if requested (import/export/bookmarklet...)
935 if ($targetPage == Router
::$PAGE_TOOLS) {
937 'pageabsaddr' => index_url($_SERVER),
938 'sslenabled' => is_https($_SERVER),
940 $pluginManager->executeHooks('render_tools', $data);
942 foreach ($data as $key => $value) {
943 $PAGE->assign($key, $value);
946 $PAGE->assign('pagetitle', t('Tools') .' - '. $conf->get('general.title', 'Shaarli'));
947 $PAGE->renderPage('tools');
951 // -------- User wants to change his/her password.
952 if ($targetPage == Router
::$PAGE_CHANGEPASSWORD) {
953 if ($conf->get('security.open_shaarli')) {
954 die(t('You are not supposed to change a password on an Open Shaarli.'));
957 if (!empty($_POST['setpassword']) && !empty($_POST['oldpassword'])) {
958 if (!$sessionManager->checkToken($_POST['token'])) {
959 die(t('Wrong token.')); // Go away!
962 // Make sure old password is correct.
964 $_POST['oldpassword'].$conf->get('credentials.login').$conf->get('credentials.salt')
966 if ($oldhash != $conf->get('credentials.hash')) {
967 echo '<script>alert("'
968 . t('The old password is not correct.')
969 .'");document.location=\'?do=changepasswd\';</script>';
973 // Salt renders rainbow-tables attacks useless.
974 $conf->set('credentials.salt', sha1(uniqid('', true) .'_'. mt_rand()));
978 $_POST['setpassword']
979 . $conf->get('credentials.login')
980 . $conf->get('credentials.salt')
984 $conf->write($loginManager->isLoggedIn());
985 } catch (Exception
$e) {
987 'ERROR while writing config file after changing password.' . PHP_EOL
.
991 // TODO: do not handle exceptions/errors in JS.
992 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=tools\';</script>';
995 echo '<script>alert("'. t('Your password has been changed') .'");document.location=\'?do=tools\';</script>';
998 // show the change password form.
999 $PAGE->assign('pagetitle', t('Change password') .' - '. $conf->get('general.title', 'Shaarli'));
1000 $PAGE->renderPage('changepassword');
1005 // -------- User wants to change configuration
1006 if ($targetPage == Router
::$PAGE_CONFIGURE) {
1007 if (!empty($_POST['title'])) {
1008 if (!$sessionManager->checkToken($_POST['token'])) {
1009 die(t('Wrong token.')); // Go away!
1012 if (!empty($_POST['continent']) && !empty($_POST['city'])
1013 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1015 $tz = $_POST['continent'] . '/' . $_POST['city'];
1017 $conf->set('general.timezone', $tz);
1018 $conf->set('general.title', escape($_POST['title']));
1019 $conf->set('general.header_link', escape($_POST['titleLink']));
1020 $conf->set('resource.theme', escape($_POST['theme']));
1021 $conf->set('security.session_protection_disabled', !empty($_POST['disablesessionprotection']));
1022 $conf->set('privacy.default_private_links', !empty($_POST['privateLinkByDefault']));
1023 $conf->set('feed.rss_permalinks', !empty($_POST['enableRssPermalinks']));
1024 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1025 $conf->set('privacy.hide_public_links', !empty($_POST['hidePublicLinks']));
1026 $conf->set('api.enabled', !empty($_POST['enableApi']));
1027 $conf->set('api.secret', escape($_POST['apiSecret']));
1028 $conf->set('translation.language', escape($_POST['language']));
1030 $thumbnailsMode = extension_loaded('gd') ? $_POST['enableThumbnails'] : Thumbnailer
::MODE_NONE
;
1031 if ($thumbnailsMode !== Thumbnailer
::MODE_NONE
1032 && $thumbnailsMode !== $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
)
1034 $_SESSION['warnings'][] = t(
1035 'You have enabled or changed thumbnails mode. '
1036 .'<a href="?do=thumbs_update">Please synchronize them</a>.'
1039 $conf->set('thumbnails.mode', $thumbnailsMode);
1042 $conf->write($loginManager->isLoggedIn());
1043 $history->updateSettings();
1044 invalidateCaches($conf->get('resource.page_cache'));
1045 } catch (Exception
$e) {
1047 'ERROR while writing config file after configuration update.' . PHP_EOL
.
1051 // TODO: do not handle exceptions/errors in JS.
1052 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?do=configure\';</script>';
1055 echo '<script>alert("'. t('Configuration was saved.') .'");document.location=\'?do=configure\';</script>';
1058 // Show the configuration form.
1059 $PAGE->assign('title', $conf->get('general.title'));
1060 $PAGE->assign('theme', $conf->get('resource.theme'));
1061 $PAGE->assign('theme_available', ThemeUtils
::getThemes($conf->get('resource.raintpl_tpl')));
1062 list($continents, $cities) = generateTimeZoneData(
1063 timezone_identifiers_list(),
1064 $conf->get('general.timezone')
1066 $PAGE->assign('continents', $continents);
1067 $PAGE->assign('cities', $cities);
1068 $PAGE->assign('private_links_default', $conf->get('privacy.default_private_links', false));
1069 $PAGE->assign('session_protection_disabled', $conf->get('security.session_protection_disabled', false));
1070 $PAGE->assign('enable_rss_permalinks', $conf->get('feed.rss_permalinks', false));
1071 $PAGE->assign('enable_update_check', $conf->get('updates.check_updates', true));
1072 $PAGE->assign('hide_public_links', $conf->get('privacy.hide_public_links', false));
1073 $PAGE->assign('api_enabled', $conf->get('api.enabled', true));
1074 $PAGE->assign('api_secret', $conf->get('api.secret'));
1075 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1076 $PAGE->assign('language', $conf->get('translation.language'));
1077 $PAGE->assign('gd_enabled', extension_loaded('gd'));
1078 $PAGE->assign('thumbnails_mode', $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
));
1079 $PAGE->assign('pagetitle', t('Configure') .' - '. $conf->get('general.title', 'Shaarli'));
1080 $PAGE->renderPage('configure');
1085 // -------- User wants to rename a tag or delete it
1086 if ($targetPage == Router
::$PAGE_CHANGETAG) {
1087 if (empty($_POST['fromtag']) || (empty($_POST['totag']) && isset($_POST['renametag']))) {
1088 $PAGE->assign('fromtag', ! empty($_GET['fromtag']) ? escape($_GET['fromtag']) : '');
1089 $PAGE->assign('pagetitle', t('Manage tags') .' - '. $conf->get('general.title', 'Shaarli'));
1090 $PAGE->renderPage('changetag');
1094 if (!$sessionManager->checkToken($_POST['token'])) {
1095 die(t('Wrong token.'));
1098 $toTag = isset($_POST['totag']) ? escape($_POST['totag']) : null;
1099 $alteredLinks = $LINKSDB->renameTag(escape($_POST['fromtag']), $toTag);
1100 $LINKSDB->save($conf->get('resource.page_cache'));
1101 foreach ($alteredLinks as $link) {
1102 $history->updateLink($link);
1104 $delete = empty($_POST['totag']);
1105 $redirect = $delete ? 'do=changetag' : 'searchtags='. urlencode(escape($_POST['totag']));
1106 $count = count($alteredLinks);
1108 ? sprintf(t('The tag was removed from %d link.', 'The tag was removed from %d links.', $count), $count)
1109 : sprintf(t('The tag was renamed in %d link.', 'The tag was renamed in %d links.', $count), $count);
1110 echo '<script>alert("'. $alert .'");document.location=\'?'. $redirect .'\';</script>';
1114 // -------- User wants to add a link without using the bookmarklet: Show form.
1115 if ($targetPage == Router
::$PAGE_ADDLINK) {
1116 $PAGE->assign('pagetitle', t('Shaare a new link') .' - '. $conf->get('general.title', 'Shaarli'));
1117 $PAGE->renderPage('addlink');
1121 // -------- User clicked the "Save" button when editing a link: Save link to database.
1122 if (isset($_POST['save_edit'])) {
1124 if (! $sessionManager->checkToken($_POST['token'])) {
1125 die(t('Wrong token.'));
1128 // lf_id should only be present if the link exists.
1129 $id = isset($_POST['lf_id']) ? intval(escape($_POST['lf_id'])) : $LINKSDB->getNextId();
1130 // Linkdate is kept here to:
1131 // - use the same permalink for notes as they're displayed when creating them
1132 // - let users hack creation date of their posts
1133 // See: https://shaarli.readthedocs.io/en/master/guides/various-hacks/#changing-the-timestamp-for-a-shaare
1134 $linkdate = escape($_POST['lf_linkdate']);
1135 if (isset($LINKSDB[$id])) {
1137 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1138 $updated = new DateTime();
1139 $shortUrl = $LINKSDB[$id]['shorturl'];
1143 $created = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $linkdate);
1145 $shortUrl = link_small_hash($created, $id);
1149 // Remove multiple spaces.
1150 $tags = trim(preg_replace('/\s\s+/', ' ', $_POST['lf_tags']));
1151 // Remove first '-' char in tags.
1152 $tags = preg_replace('/(^| )\-/', '$1', $tags);
1153 // Remove duplicates.
1154 $tags = implode(' ', array_unique(explode(' ', $tags)));
1156 if (empty(trim($_POST['lf_url
']))) {
1157 $_POST['lf_url
'] = '?' . smallHash($linkdate . $id);
1159 $url = whitelist_protocols(trim($_POST['lf_url
']), $conf->get('security
.allowed_protocols
'));
1163 'title
' => trim($_POST['lf_title
']),
1165 'description
' => $_POST['lf_description
'],
1166 'private' => (isset($_POST['lf_private
']) ? 1 : 0),
1167 'created
' => $created,
1168 'updated
' => $updated,
1169 'tags
' => str_replace(',', ' ', $tags),
1170 'shorturl
' => $shortUrl,
1173 // If title is empty, use the URL as title.
1174 if ($link['title
'] == '') {
1175 $link['title
'] = $link['url
'];
1178 if ($conf->get('thumbnails
.mode
', Thumbnailer::MODE_NONE) !== Thumbnailer::MODE_NONE) {
1179 $thumbnailer = new Thumbnailer($conf);
1180 $link['thumbnail
'] = $thumbnailer->get($url);
1183 $pluginManager->executeHooks('save_link
', $link);
1185 $LINKSDB[$id] = $link;
1186 $LINKSDB->save($conf->get('resource.page_cache
'));
1188 $history->addLink($link);
1190 $history->updateLink($link);
1193 // If we are called from the bookmarklet, we must close the popup:
1194 if (isset($_GET['source
']) && ($_GET['source
']=='bookmarklet
' || $_GET['source
']=='firefoxsocialapi
')) {
1195 echo '<script
>self
.close();</script
>';
1199 $returnurl = !empty($_POST['returnurl
']) ? $_POST['returnurl
'] : '?';
1200 $location = generateLocation($returnurl, $_SERVER['HTTP_HOST
'], array('addlink
', 'post
', 'edit_link
'));
1201 // Scroll to the link which has been edited.
1202 $location .= '#' . $link['shorturl'];
1203 // After saving the link, redirect to the page the user was on.
1204 header('Location: '. $location);
1208 // -------- User clicked the "Cancel" button when editing a link.
1209 if (isset($_POST['cancel_edit'])) {
1210 $id = isset($_POST['lf_id']) ? (int) escape($_POST['lf_id']) : false;
1211 if (! isset($LINKSDB[$id])) {
1212 header('Location: ?');
1214 // If we are called from the bookmarklet, we must close the popup:
1215 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1216 echo '<script>self.close();</script>';
1219 $link = $LINKSDB[$id];
1220 $returnurl = ( isset($_POST['returnurl']) ? $_POST['returnurl'] : '?' );
1221 // Scroll to the link which has been edited.
1222 $returnurl .= '#'. $link['shorturl'];
1223 $returnurl = generateLocation($returnurl, $_SERVER['HTTP_HOST'], array('addlink', 'post', 'edit_link'));
1224 header('Location: '.$returnurl); // After canceling, redirect to the page the user was on.
1228 // -------- User clicked the "Delete" button when editing a link: Delete link from database.
1229 if ($targetPage == Router
::$PAGE_DELETELINK) {
1230 if (! $sessionManager->checkToken($_GET['token'])) {
1231 die(t('Wrong token.'));
1234 $ids = trim($_GET['lf_linkdate']);
1235 if (strpos($ids, ' ') !== false) {
1236 // multiple, space-separated ids provided
1237 $ids = array_values(array_filter(preg_split('/\s+/', escape($ids))));
1239 // only a single id provided
1242 // assert at least one id is given
1244 die('no id provided');
1246 foreach ($ids as $id) {
1247 $id = (int) escape($id);
1248 $link = $LINKSDB[$id];
1249 $pluginManager->executeHooks('delete_link', $link);
1250 $history->deleteLink($link);
1251 unset($LINKSDB[$id]);
1253 $LINKSDB->save($conf->get('resource.page_cache')); // save to disk
1255 // If we are called from the bookmarklet, we must close the popup:
1256 if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) {
1257 echo '<script>self.close();</script>';
1262 if (isset($_SERVER['HTTP_REFERER'])) {
1263 // Don't redirect to where we were previously if it was a permalink or an edit_link, because it would 404.
1264 $location = generateLocation(
1265 $_SERVER['HTTP_REFERER'],
1266 $_SERVER['HTTP_HOST'],
1267 ['delete_link', 'edit_link', $link['shorturl']]
1271 header('Location: ' . $location); // After deleting the link, redirect to appropriate location
1275 // -------- User clicked the "EDIT" button on a link: Display link edit form.
1276 if (isset($_GET['edit_link'])) {
1277 $id = (int) escape($_GET['edit_link']);
1278 $link = $LINKSDB[$id]; // Read database
1280 header('Location: ?');
1282 } // Link not found in database.
1283 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1286 'link_is_new' => false,
1287 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1288 'tags' => $LINKSDB->linksCountPerTag(),
1290 $pluginManager->executeHooks('render_editlink', $data);
1292 foreach ($data as $key => $value) {
1293 $PAGE->assign($key, $value);
1296 $PAGE->assign('pagetitle', t('Edit') .' '. t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1297 $PAGE->renderPage('editlink');
1301 // -------- User want to post a new link: Display link edit form.
1302 if (isset($_GET['post'])) {
1303 $url = cleanup_url($_GET['post']);
1305 $link_is_new = false;
1306 // Check if URL is not already in database (in this case, we will edit the existing link)
1307 $link = $LINKSDB->getLinkFromUrl($url);
1309 $link_is_new = true;
1310 $linkdate = strval(date(LinkDB
::LINK_DATE_FORMAT
));
1311 // Get title if it was provided in URL (by the bookmarklet).
1312 $title = empty($_GET['title']) ? '' : escape($_GET['title']);
1313 // Get description if it was provided in URL (by the bookmarklet). [Bronco added that]
1314 $description = empty($_GET['description']) ? '' : escape($_GET['description']);
1315 $tags = empty($_GET['tags']) ? '' : escape($_GET['tags']);
1316 $private = !empty($_GET['private']) && $_GET['private'] === "1" ? 1 : 0;
1318 // If this is an HTTP(S) link, we try go get the page to extract
1319 // the title (otherwise we will to straight to the edit form.)
1320 if (empty($title) && strpos(get_url_scheme($url), 'http') !== false) {
1321 // Short timeout to keep the application responsive
1322 // The callback will fill $charset and $title with data from the downloaded page.
1325 $conf->get('general.download_timeout', 30),
1326 $conf->get('general.download_max_size', 4194304),
1327 get_curl_download_callback($charset, $title)
1329 if (! empty($title) && strtolower($charset) != 'utf-8') {
1330 $title = mb_convert_encoding($title, 'utf-8', $charset);
1335 $url = '?' . smallHash($linkdate . $LINKSDB->getNextId());
1336 $title = $conf->get('general.default_note_title', t('Note: '));
1338 $url = escape($url);
1339 $title = escape($title);
1342 'linkdate' => $linkdate,
1345 'description' => $description,
1347 'private' => $private,
1350 $link['linkdate'] = $link['created']->format(LinkDB
::LINK_DATE_FORMAT
);
1355 'link_is_new' => $link_is_new,
1356 'http_referer' => (isset($_SERVER['HTTP_REFERER']) ? escape($_SERVER['HTTP_REFERER']) : ''),
1357 'source' => (isset($_GET['source']) ? $_GET['source'] : ''),
1358 'tags' => $LINKSDB->linksCountPerTag(),
1359 'default_private_links' => $conf->get('privacy.default_private_links', false),
1361 $pluginManager->executeHooks('render_editlink', $data);
1363 foreach ($data as $key => $value) {
1364 $PAGE->assign($key, $value);
1367 $PAGE->assign('pagetitle', t('Shaare') .' - '. $conf->get('general.title', 'Shaarli'));
1368 $PAGE->renderPage('editlink');
1372 if ($targetPage == Router
::$PAGE_PINLINK) {
1373 if (! isset($_GET['id']) || empty($LINKSDB[$_GET['id']])) {
1374 // FIXME! Use a proper error system.
1375 $msg = t('Invalid link ID provided');
1376 echo '<script>alert("'. $msg .'");document.location=\''. index_url($_SERVER) .'\';</script>';
1379 if (! $sessionManager->checkToken($_GET['token'])) {
1380 die('Wrong token.');
1383 $link = $LINKSDB[$_GET['id']];
1384 $link['sticky'] = ! $link['sticky'];
1385 $LINKSDB[(int) $_GET['id']] = $link;
1386 $LINKSDB->save($conf->get('resource.page_cache'));
1387 header('Location: '.index_url($_SERVER));
1391 if ($targetPage == Router
::$PAGE_EXPORT) {
1392 // Export links as a Netscape Bookmarks file
1394 if (empty($_GET['selection'])) {
1395 $PAGE->assign('pagetitle', t('Export') .' - '. $conf->get('general.title', 'Shaarli'));
1396 $PAGE->renderPage('export');
1400 // export as bookmarks_(all|private|public)_YYYYmmdd_HHMMSS.html
1401 $selection = $_GET['selection'];
1402 if (isset($_GET['prepend_note_url'])) {
1403 $prependNoteUrl = $_GET['prepend_note_url'];
1405 $prependNoteUrl = false;
1411 NetscapeBookmarkUtils
::filterAndFormat(
1418 } catch (Exception
$exc) {
1419 header('Content-Type: text/plain; charset=utf-8');
1420 echo $exc->getMessage();
1423 $now = new DateTime();
1424 header('Content-Type: text/html; charset=utf-8');
1426 'Content-disposition: attachment; filename=bookmarks_'
1427 .$selection.'_'.$now->format(LinkDB
::LINK_DATE_FORMAT
).'.html'
1429 $PAGE->assign('date', $now->format(DateTime
::RFC822
));
1430 $PAGE->assign('eol', PHP_EOL
);
1431 $PAGE->assign('selection', $selection);
1432 $PAGE->renderPage('export.bookmarks');
1436 if ($targetPage == Router
::$PAGE_IMPORT) {
1437 // Upload a Netscape bookmark dump to import its contents
1439 if (! isset($_POST['token']) || ! isset($_FILES['filetoupload'])) {
1440 // Show import dialog
1443 get_max_upload_size(
1444 ini_get('post_max_size'),
1445 ini_get('upload_max_filesize'),
1451 get_max_upload_size(
1452 ini_get('post_max_size'),
1453 ini_get('upload_max_filesize'),
1457 $PAGE->assign('pagetitle', t('Import') .' - '. $conf->get('general.title', 'Shaarli'));
1458 $PAGE->renderPage('import');
1462 // Import bookmarks from an uploaded file
1463 if (isset($_FILES['filetoupload']['size']) && $_FILES['filetoupload']['size'] == 0) {
1464 // The file is too big or some form field may be missing.
1467 'The file you are trying to upload is probably bigger than what this webserver can accept'
1468 .' (%s). Please upload in smaller chunks.'
1470 get_max_upload_size(ini_get('post_max_size'), ini_get('upload_max_filesize'))
1472 echo '<script>alert("'. $msg .'");document.location=\'?do='.Router
::$PAGE_IMPORT .'\';</script>';
1475 if (! $sessionManager->checkToken($_POST['token'])) {
1476 die('Wrong token.');
1478 $status = NetscapeBookmarkUtils
::import(
1485 echo '<script>alert("'.$status.'");document.location=\'?do='
1486 .Router
::$PAGE_IMPORT .'\';</script>';
1490 // Plugin administration page
1491 if ($targetPage == Router
::$PAGE_PLUGINSADMIN) {
1492 $pluginMeta = $pluginManager->getPluginsMeta();
1494 // Split plugins into 2 arrays: ordered enabled plugins and disabled.
1495 $enabledPlugins = array_filter($pluginMeta, function ($v) {
1496 return $v['order'] !== false;
1499 $enabledPlugins = load_plugin_parameter_values($enabledPlugins, $conf->get('plugins', array()));
1503 return $a['order'] - $b['order'];
1506 $disabledPlugins = array_filter($pluginMeta, function ($v) {
1507 return $v['order'] === false;
1510 $PAGE->assign('enabledPlugins', $enabledPlugins);
1511 $PAGE->assign('disabledPlugins', $disabledPlugins);
1512 $PAGE->assign('pagetitle', t('Plugin administration') .' - '. $conf->get('general.title', 'Shaarli'));
1513 $PAGE->renderPage('pluginsadmin');
1517 // Plugin administration form action
1518 if ($targetPage == Router
::$PAGE_SAVE_PLUGINSADMIN) {
1520 if (isset($_POST['parameters_form'])) {
1521 unset($_POST['parameters_form']);
1522 foreach ($_POST as $param => $value) {
1523 $conf->set('plugins.'. $param, escape($value));
1526 $conf->set('general.enabled_plugins', save_plugin_config($_POST));
1528 $conf->write($loginManager->isLoggedIn());
1529 $history->updateSettings();
1530 } catch (Exception
$e) {
1532 'ERROR while saving plugin configuration:.' . PHP_EOL
.
1536 // TODO: do not handle exceptions/errors in JS.
1537 echo '<script>alert("'
1539 .'");document.location=\'?do='
1540 . Router
::$PAGE_PLUGINSADMIN
1544 header('Location: ?do='. Router
::$PAGE_PLUGINSADMIN);
1548 // Get a fresh token
1549 if ($targetPage == Router
::$GET_TOKEN) {
1550 header('Content-Type:text/plain');
1551 echo $sessionManager->generateToken($conf);
1555 // -------- Thumbnails Update
1556 if ($targetPage == Router
::$PAGE_THUMBS_UPDATE) {
1558 foreach ($LINKSDB as $link) {
1559 // A note or not HTTP(S)
1560 if ($link['url'][0] === '?' || ! startsWith(strtolower($link['url']), 'http')) {
1563 $ids[] = $link['id'];
1565 $PAGE->assign('ids', $ids);
1566 $PAGE->assign('pagetitle', t('Thumbnails update') .' - '. $conf->get('general.title', 'Shaarli'));
1567 $PAGE->renderPage('thumbnails');
1571 // -------- Single Thumbnail Update
1572 if ($targetPage == Router
::$AJAX_THUMB_UPDATE) {
1573 if (! isset($_POST['id']) || ! ctype_digit($_POST['id'])) {
1574 http_response_code(400);
1577 $id = (int) $_POST['id'];
1578 if (empty($LINKSDB[$id])) {
1579 http_response_code(404);
1582 $thumbnailer = new Thumbnailer($conf);
1583 $link = $LINKSDB[$id];
1584 $link['thumbnail'] = $thumbnailer->get($link['url']);
1585 $LINKSDB[$id] = $link;
1586 $LINKSDB->save($conf->get('resource.page_cache'));
1588 echo json_encode($link);
1592 // -------- Otherwise, simply display search form and links:
1593 showLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager);
1598 * Template for the list of links (<div id="linklist">)
1599 * This function fills all the necessary fields in the $PAGE for the template 'linklist.html'
1601 * @param pageBuilder $PAGE pageBuilder instance.
1602 * @param LinkDB $LINKSDB LinkDB instance.
1603 * @param ConfigManager $conf Configuration Manager instance.
1604 * @param PluginManager $pluginManager Plugin Manager instance.
1605 * @param LoginManager $loginManager LoginManager instance
1607 function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager)
1609 // Used in templates
1610 if (isset($_GET['searchtags'])) {
1611 if (! empty($_GET['searchtags'])) {
1612 $searchtags = escape(normalize_spaces($_GET['searchtags']));
1614 $searchtags = false;
1619 $searchterm = !empty($_GET['searchterm']) ? escape(normalize_spaces($_GET['searchterm'])) : '';
1622 if (! empty($_SERVER['QUERY_STRING'])
1623 && preg_match('/^[a-zA-Z0-9-_@]{6}($|&|#)/', $_SERVER['QUERY_STRING'])) {
1625 $linksToDisplay = $LINKSDB->filterHash($_SERVER['QUERY_STRING']);
1626 } catch (LinkNotFoundException
$e) {
1627 $PAGE->render404($e->getMessage());
1631 // Filter links according search parameters.
1632 $visibility = ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '';
1634 'searchtags' => $searchtags,
1635 'searchterm' => $searchterm,
1637 $linksToDisplay = $LINKSDB->filterSearch($request, false, $visibility, !empty($_SESSION['untaggedonly']));
1640 // ---- Handle paging.
1642 foreach ($linksToDisplay as $key => $value) {
1646 // Select articles according to paging.
1647 $pagecount = ceil(count($keys) / $_SESSION['LINKS_PER_PAGE']);
1648 $pagecount = $pagecount == 0 ? 1 : $pagecount;
1649 $page= empty($_GET['page']) ? 1 : intval($_GET['page']);
1650 $page = $page < 1 ? 1 : $page;
1651 $page = $page > $pagecount ? $pagecount : $page;
1653 $i = ($page-1) * $_SESSION['LINKS_PER_PAGE'];
1654 $end = $i +
$_SESSION['LINKS_PER_PAGE'];
1656 $thumbnailsEnabled = $conf->get('thumbnails.mode', Thumbnailer
::MODE_NONE
) !== Thumbnailer
::MODE_NONE
;
1657 if ($thumbnailsEnabled) {
1658 $thumbnailer = new Thumbnailer($conf);
1661 $linkDisp = array();
1662 while ($i<$end && $i<count($keys)) {
1663 $link = $linksToDisplay[$keys[$i]];
1664 $link['description'] = format_description(
1665 $link['description'],
1666 $conf->get('redirector.url'),
1667 $conf->get('redirector.encode_url')
1669 $classLi = ($i %
2) != 0 ? '' : 'publicLinkHightLight';
1670 $link['class'] = $link['private'] == 0 ? $classLi : 'private';
1671 $link['timestamp'] = $link['created']->getTimestamp();
1672 if (! empty($link['updated'])) {
1673 $link['updated_timestamp'] = $link['updated']->getTimestamp();
1675 $link['updated_timestamp'] = '';
1677 $taglist = preg_split('/\s+/', $link['tags'], -1, PREG_SPLIT_NO_EMPTY
);
1678 uasort($taglist, 'strcasecmp');
1679 $link['taglist'] = $taglist;
1681 // Logged in, thumbnails enabled, not a note,
1682 // and (never retrieved yet or no valid cache file)
1683 if ($loginManager->isLoggedIn() && $thumbnailsEnabled && $link['url'][0] != '?'
1684 && (! isset($link['thumbnail']) || ($link['thumbnail'] !== false && ! is_file($link['thumbnail'])))
1686 $elem = $LINKSDB[$keys[$i]];
1687 $elem['thumbnail'] = $thumbnailer->get($link['url']);
1688 $LINKSDB[$keys[$i]] = $elem;
1690 $link['thumbnail'] = $elem['thumbnail'];
1693 // Check for both signs of a note: starting with ? and 7 chars long.
1694 if ($link['url'][0] === '?' && strlen($link['url']) === 7) {
1695 $link['url'] = index_url($_SERVER) . $link['url'];
1698 $linkDisp[$keys[$i]] = $link;
1702 // If we retrieved new thumbnails, we update the database.
1703 if (!empty($updateDB)) {
1704 $LINKSDB->save($conf->get('resource.page_cache'));
1707 // Compute paging navigation
1708 $searchtagsUrl = $searchtags === '' ? '' : '&searchtags=' . urlencode($searchtags);
1709 $searchtermUrl = empty($searchterm) ? '' : '&searchterm=' . urlencode($searchterm);
1710 $previous_page_url = '';
1711 if ($i != count($keys)) {
1712 $previous_page_url = '?page=' . ($page+
1) . $searchtermUrl . $searchtagsUrl;
1716 $next_page_url = '?page=' . ($page-1) . $searchtermUrl . $searchtagsUrl;
1719 // Fill all template fields.
1721 'previous_page_url' => $previous_page_url,
1722 'next_page_url' => $next_page_url,
1723 'page_current' => $page,
1724 'page_max' => $pagecount,
1725 'result_count' => count($linksToDisplay),
1726 'search_term' => $searchterm,
1727 'search_tags' => $searchtags,
1728 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '',
1729 'redirector' => $conf->get('redirector.url'), // Optional redirector URL.
1730 'links' => $linkDisp,
1733 // If there is only a single link, we change on-the-fly the title of the page.
1734 if (count($linksToDisplay) == 1) {
1735 $data['pagetitle'] = $linksToDisplay[$keys[0]]['title'] .' - '. $conf->get('general.title');
1736 } elseif (! empty($searchterm) || ! empty($searchtags)) {
1737 $data['pagetitle'] = t('Search: ');
1738 $data['pagetitle'] .= ! empty($searchterm) ? $searchterm .' ' : '';
1739 $bracketWrap = function ($tag) {
1740 return '['. $tag .']';
1742 $data['pagetitle'] .= ! empty($searchtags)
1743 ? implode(' ', array_map($bracketWrap, preg_split('/\s+/', $searchtags))).' '
1745 $data['pagetitle'] .= '- '. $conf->get('general.title');
1748 $pluginManager->executeHooks('render_linklist', $data, array('loggedin' => $loginManager->isLoggedIn()));
1750 foreach ($data as $key => $value) {
1751 $PAGE->assign($key, $value);
1759 * This function should NEVER be called if the file data/config.php exists.
1761 * @param ConfigManager $conf Configuration Manager instance.
1762 * @param SessionManager $sessionManager SessionManager instance
1763 * @param LoginManager $loginManager LoginManager instance
1765 function install($conf, $sessionManager, $loginManager)
1767 // On free.fr host, make sure the /sessions directory exists, otherwise login will not work.
1768 if (endsWith($_SERVER['HTTP_HOST'], '.free.fr') && !is_dir($_SERVER['DOCUMENT_ROOT'].'/sessions')) {
1769 mkdir($_SERVER['DOCUMENT_ROOT'].'/sessions', 0705);
1773 // This part makes sure sessions works correctly.
1774 // (Because on some hosts, session.save_path may not be set correctly,
1775 // or we may not have write access to it.)
1776 if (isset($_GET['test_session'])
1777 && ( !isset($_SESSION) || !isset($_SESSION['session_tested']) || $_SESSION['session_tested']!='Working')) {
1778 // Step 2: Check if data in session is correct.
1780 '<pre>Sessions do not seem to work correctly on your server.<br>'.
1781 'Make sure the variable "session.save_path" is set correctly in your PHP config, '.
1782 'and that you have write access to it.<br>'.
1783 'It currently points to %s.<br>'.
1784 'On some browsers, accessing your server via a hostname like \'localhost\' '.
1785 'or any custom hostname without a dot causes cookie storage to fail. '.
1786 'We recommend accessing your server via it\'s IP address or Fully Qualified Domain Name.<br>'
1788 $msg = sprintf($msg, session_save_path());
1790 echo '<br><a href="?">'. t('Click to try again.') .'</a></pre>';
1793 if (!isset($_SESSION['session_tested'])) {
1794 // Step 1 : Try to store data in session and reload page.
1795 $_SESSION['session_tested'] = 'Working'; // Try to set a variable in session.
1796 header('Location: '.index_url($_SERVER).'?test_session'); // Redirect to check stored data.
1798 if (isset($_GET['test_session'])) {
1799 // Step 3: Sessions are OK. Remove test parameter from URL.
1800 header('Location: '.index_url($_SERVER));
1804 if (!empty($_POST['setlogin']) && !empty($_POST['setpassword'])) {
1806 if (!empty($_POST['continent']) && !empty($_POST['city'])
1807 && isTimeZoneValid($_POST['continent'], $_POST['city'])
1809 $tz = $_POST['continent'].'/'.$_POST['city'];
1811 $conf->set('general.timezone', $tz);
1812 $login = $_POST['setlogin'];
1813 $conf->set('credentials.login', $login);
1814 $salt = sha1(uniqid('', true) .'_'. mt_rand());
1815 $conf->set('credentials.salt', $salt);
1816 $conf->set('credentials.hash', sha1($_POST['setpassword'] . $login . $salt));
1817 if (!empty($_POST['title'])) {
1818 $conf->set('general.title', escape($_POST['title']));
1820 $conf->set('general.title', 'Shared links on '.escape(index_url($_SERVER)));
1822 $conf->set('translation.language', escape($_POST['language']));
1823 $conf->set('updates.check_updates', !empty($_POST['updateCheck']));
1824 $conf->set('api.enabled', !empty($_POST['enableApi']));
1827 generate_api_secret(
1828 $conf->get('credentials.login'),
1829 $conf->get('credentials.salt')
1833 // Everything is ok, let's create config file.
1834 $conf->write($loginManager->isLoggedIn());
1835 } catch (Exception
$e) {
1837 'ERROR while writing config file after installation.' . PHP_EOL
.
1841 // TODO: do not handle exceptions/errors in JS.
1842 echo '<script>alert("'. $e->getMessage() .'");document.location=\'?\';</script>';
1845 echo '<script>alert('
1846 .'"Shaarli is now configured. '
1847 .'Please enter your login/password and start shaaring your links!"'
1848 .');document.location=\'?do=login\';</script>';
1852 $PAGE = new PageBuilder($conf, $_SESSION, null, $sessionManager->generateToken());
1853 list($continents, $cities) = generateTimeZoneData(timezone_identifiers_list(), date_default_timezone_get());
1854 $PAGE->assign('continents', $continents);
1855 $PAGE->assign('cities', $cities);
1856 $PAGE->assign('languages', Languages
::getAvailableLanguages());
1857 $PAGE->renderPage('install');
1861 if (isset($_SERVER['QUERY_STRING']) && startsWith($_SERVER['QUERY_STRING'], 'do=dailyrss')) {
1862 showDailyRSS($conf, $loginManager);
1866 if (!isset($_SESSION['LINKS_PER_PAGE'])) {
1867 $_SESSION['LINKS_PER_PAGE'] = $conf->get('general.links_per_page', 20);
1871 $history = new History($conf->get('resource.history'));
1872 } catch (Exception
$e) {
1873 die($e->getMessage());
1876 $linkDb = new LinkDB(
1877 $conf->get('resource.datastore'),
1878 $loginManager->isLoggedIn(),
1879 $conf->get('privacy.hide_public_links'),
1880 $conf->get('redirector.url'),
1881 $conf->get('redirector.encode_url')
1884 $container = new \Slim\
Container();
1885 $container['conf'] = $conf;
1886 $container['plugins'] = $pluginManager;
1887 $container['history'] = $history;
1888 $app = new \Slim\
App($container);
1891 $app->group('/api/v1', function () {
1892 $this->get('/info', '\Shaarli\Api\Controllers\Info:getInfo')->setName('getInfo');
1893 $this->get('/links', '\Shaarli\Api\Controllers\Links:getLinks')->setName('getLinks');
1894 $this->get('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:getLink')->setName('getLink');
1895 $this->post('/links', '\Shaarli\Api\Controllers\Links:postLink')->setName('postLink');
1896 $this->put('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:putLink')->setName('putLink');
1897 $this->delete('/links/{id:[\d]+}', '\Shaarli\Api\Controllers\Links:deleteLink')->setName('deleteLink');
1899 $this->get('/tags', '\Shaarli\Api\Controllers\Tags:getTags')->setName('getTags');
1900 $this->get('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:getTag')->setName('getTag');
1901 $this->put('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:putTag')->setName('putTag');
1902 $this->delete('/tags/{tagName:[\w]+}', '\Shaarli\Api\Controllers\Tags:deleteTag')->setName('deleteTag');
1904 $this->get('/history', '\Shaarli\Api\Controllers\History:getHistory')->setName('getHistory');
1905 })->add('\Shaarli\Api\ApiMiddleware');
1907 $response = $app->run(true);
1909 // Hack to make Slim and Shaarli router work together:
1910 // If a Slim route isn't found and NOT API call, we call renderPage().
1911 if ($response->getStatusCode() == 404 && strpos($_SERVER['REQUEST_URI'], '/api/v1') === false) {
1912 // We use UTF-8 for proper international characters handling.
1913 header('Content-Type: text/html; charset=utf-8');
1914 renderPage($conf, $pluginManager, $linkDb, $history, $sessionManager, $loginManager);
1916 $response = $response
1917 ->withHeader('Access-Control-Allow-Origin', '*')
1919 'Access-Control-Allow-Headers',
1920 'X-Requested-With, Content-Type, Accept, Origin, Authorization'
1922 ->withHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
1923 $app->respond($response);